Fix computation of zoomed window frame
[MacVim.git] / src / eval.c
blob06246f0607cb12d7382bdbb3d8c59243c4cf1a8b
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 * When "convert" is TRUE convert a List into a sequence of lines and convert
1260 * a Float to a String.
1261 * Return pointer to allocated memory, or NULL for failure.
1263 char_u *
1264 eval_to_string(arg, nextcmd, convert)
1265 char_u *arg;
1266 char_u **nextcmd;
1267 int convert;
1269 typval_T tv;
1270 char_u *retval;
1271 garray_T ga;
1272 char_u numbuf[NUMBUFLEN];
1274 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1275 retval = NULL;
1276 else
1278 if (convert && tv.v_type == VAR_LIST)
1280 ga_init2(&ga, (int)sizeof(char), 80);
1281 if (tv.vval.v_list != NULL)
1282 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1283 ga_append(&ga, NUL);
1284 retval = (char_u *)ga.ga_data;
1286 #ifdef FEAT_FLOAT
1287 else if (convert && tv.v_type == VAR_FLOAT)
1289 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1290 retval = vim_strsave(numbuf);
1292 #endif
1293 else
1294 retval = vim_strsave(get_tv_string(&tv));
1295 clear_tv(&tv);
1298 return retval;
1302 * Call eval_to_string() without using current local variables and using
1303 * textlock. When "use_sandbox" is TRUE use the sandbox.
1305 char_u *
1306 eval_to_string_safe(arg, nextcmd, use_sandbox)
1307 char_u *arg;
1308 char_u **nextcmd;
1309 int use_sandbox;
1311 char_u *retval;
1312 void *save_funccalp;
1314 save_funccalp = save_funccal();
1315 if (use_sandbox)
1316 ++sandbox;
1317 ++textlock;
1318 retval = eval_to_string(arg, nextcmd, FALSE);
1319 if (use_sandbox)
1320 --sandbox;
1321 --textlock;
1322 restore_funccal(save_funccalp);
1323 return retval;
1327 * Top level evaluation function, returning a number.
1328 * Evaluates "expr" silently.
1329 * Returns -1 for an error.
1332 eval_to_number(expr)
1333 char_u *expr;
1335 typval_T rettv;
1336 int retval;
1337 char_u *p = skipwhite(expr);
1339 ++emsg_off;
1341 if (eval1(&p, &rettv, TRUE) == FAIL)
1342 retval = -1;
1343 else
1345 retval = get_tv_number_chk(&rettv, NULL);
1346 clear_tv(&rettv);
1348 --emsg_off;
1350 return retval;
1354 * Prepare v: variable "idx" to be used.
1355 * Save the current typeval in "save_tv".
1356 * When not used yet add the variable to the v: hashtable.
1358 static void
1359 prepare_vimvar(idx, save_tv)
1360 int idx;
1361 typval_T *save_tv;
1363 *save_tv = vimvars[idx].vv_tv;
1364 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1365 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1369 * Restore v: variable "idx" to typeval "save_tv".
1370 * When no longer defined, remove the variable from the v: hashtable.
1372 static void
1373 restore_vimvar(idx, save_tv)
1374 int idx;
1375 typval_T *save_tv;
1377 hashitem_T *hi;
1379 vimvars[idx].vv_tv = *save_tv;
1380 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1382 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1383 if (HASHITEM_EMPTY(hi))
1384 EMSG2(_(e_intern2), "restore_vimvar()");
1385 else
1386 hash_remove(&vimvarht, hi);
1390 #if defined(FEAT_SPELL) || defined(PROTO)
1392 * Evaluate an expression to a list with suggestions.
1393 * For the "expr:" part of 'spellsuggest'.
1394 * Returns NULL when there is an error.
1396 list_T *
1397 eval_spell_expr(badword, expr)
1398 char_u *badword;
1399 char_u *expr;
1401 typval_T save_val;
1402 typval_T rettv;
1403 list_T *list = NULL;
1404 char_u *p = skipwhite(expr);
1406 /* Set "v:val" to the bad word. */
1407 prepare_vimvar(VV_VAL, &save_val);
1408 vimvars[VV_VAL].vv_type = VAR_STRING;
1409 vimvars[VV_VAL].vv_str = badword;
1410 if (p_verbose == 0)
1411 ++emsg_off;
1413 if (eval1(&p, &rettv, TRUE) == OK)
1415 if (rettv.v_type != VAR_LIST)
1416 clear_tv(&rettv);
1417 else
1418 list = rettv.vval.v_list;
1421 if (p_verbose == 0)
1422 --emsg_off;
1423 restore_vimvar(VV_VAL, &save_val);
1425 return list;
1429 * "list" is supposed to contain two items: a word and a number. Return the
1430 * word in "pp" and the number as the return value.
1431 * Return -1 if anything isn't right.
1432 * Used to get the good word and score from the eval_spell_expr() result.
1435 get_spellword(list, pp)
1436 list_T *list;
1437 char_u **pp;
1439 listitem_T *li;
1441 li = list->lv_first;
1442 if (li == NULL)
1443 return -1;
1444 *pp = get_tv_string(&li->li_tv);
1446 li = li->li_next;
1447 if (li == NULL)
1448 return -1;
1449 return get_tv_number(&li->li_tv);
1451 #endif
1454 * Top level evaluation function.
1455 * Returns an allocated typval_T with the result.
1456 * Returns NULL when there is an error.
1458 typval_T *
1459 eval_expr(arg, nextcmd)
1460 char_u *arg;
1461 char_u **nextcmd;
1463 typval_T *tv;
1465 tv = (typval_T *)alloc(sizeof(typval_T));
1466 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1468 vim_free(tv);
1469 tv = NULL;
1472 return tv;
1476 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1477 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1479 * Call some vimL function and return the result in "*rettv".
1480 * Uses argv[argc] for the function arguments. Only Number and String
1481 * arguments are currently supported.
1482 * Returns OK or FAIL.
1484 static int
1485 call_vim_function(func, argc, argv, safe, rettv)
1486 char_u *func;
1487 int argc;
1488 char_u **argv;
1489 int safe; /* use the sandbox */
1490 typval_T *rettv;
1492 typval_T *argvars;
1493 long n;
1494 int len;
1495 int i;
1496 int doesrange;
1497 void *save_funccalp = NULL;
1498 int ret;
1500 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1501 if (argvars == NULL)
1502 return FAIL;
1504 for (i = 0; i < argc; i++)
1506 /* Pass a NULL or empty argument as an empty string */
1507 if (argv[i] == NULL || *argv[i] == NUL)
1509 argvars[i].v_type = VAR_STRING;
1510 argvars[i].vval.v_string = (char_u *)"";
1511 continue;
1514 /* Recognize a number argument, the others must be strings. */
1515 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1516 if (len != 0 && len == (int)STRLEN(argv[i]))
1518 argvars[i].v_type = VAR_NUMBER;
1519 argvars[i].vval.v_number = n;
1521 else
1523 argvars[i].v_type = VAR_STRING;
1524 argvars[i].vval.v_string = argv[i];
1528 if (safe)
1530 save_funccalp = save_funccal();
1531 ++sandbox;
1534 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1535 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1536 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1537 &doesrange, TRUE, NULL);
1538 if (safe)
1540 --sandbox;
1541 restore_funccal(save_funccalp);
1543 vim_free(argvars);
1545 if (ret == FAIL)
1546 clear_tv(rettv);
1548 return ret;
1551 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1553 * Call vimL function "func" and return the result as a string.
1554 * Returns NULL when calling the function fails.
1555 * Uses argv[argc] for the function arguments.
1557 void *
1558 call_func_retstr(func, argc, argv, safe)
1559 char_u *func;
1560 int argc;
1561 char_u **argv;
1562 int safe; /* use the sandbox */
1564 typval_T rettv;
1565 char_u *retval;
1567 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1568 return NULL;
1570 retval = vim_strsave(get_tv_string(&rettv));
1571 clear_tv(&rettv);
1572 return retval;
1574 # endif
1576 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1578 * Call vimL function "func" and return the result as a number.
1579 * Returns -1 when calling the function fails.
1580 * Uses argv[argc] for the function arguments.
1582 long
1583 call_func_retnr(func, argc, argv, safe)
1584 char_u *func;
1585 int argc;
1586 char_u **argv;
1587 int safe; /* use the sandbox */
1589 typval_T rettv;
1590 long retval;
1592 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1593 return -1;
1595 retval = get_tv_number_chk(&rettv, NULL);
1596 clear_tv(&rettv);
1597 return retval;
1599 # endif
1602 * Call vimL function "func" and return the result as a List.
1603 * Uses argv[argc] for the function arguments.
1604 * Returns NULL when there is something wrong.
1606 void *
1607 call_func_retlist(func, argc, argv, safe)
1608 char_u *func;
1609 int argc;
1610 char_u **argv;
1611 int safe; /* use the sandbox */
1613 typval_T rettv;
1615 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1616 return NULL;
1618 if (rettv.v_type != VAR_LIST)
1620 clear_tv(&rettv);
1621 return NULL;
1624 return rettv.vval.v_list;
1626 #endif
1630 * Save the current function call pointer, and set it to NULL.
1631 * Used when executing autocommands and for ":source".
1633 void *
1634 save_funccal()
1636 funccall_T *fc = current_funccal;
1638 current_funccal = NULL;
1639 return (void *)fc;
1642 void
1643 restore_funccal(vfc)
1644 void *vfc;
1646 funccall_T *fc = (funccall_T *)vfc;
1648 current_funccal = fc;
1651 #if defined(FEAT_PROFILE) || defined(PROTO)
1653 * Prepare profiling for entering a child or something else that is not
1654 * counted for the script/function itself.
1655 * Should always be called in pair with prof_child_exit().
1657 void
1658 prof_child_enter(tm)
1659 proftime_T *tm; /* place to store waittime */
1661 funccall_T *fc = current_funccal;
1663 if (fc != NULL && fc->func->uf_profiling)
1664 profile_start(&fc->prof_child);
1665 script_prof_save(tm);
1669 * Take care of time spent in a child.
1670 * Should always be called after prof_child_enter().
1672 void
1673 prof_child_exit(tm)
1674 proftime_T *tm; /* where waittime was stored */
1676 funccall_T *fc = current_funccal;
1678 if (fc != NULL && fc->func->uf_profiling)
1680 profile_end(&fc->prof_child);
1681 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1682 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1683 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1685 script_prof_restore(tm);
1687 #endif
1690 #ifdef FEAT_FOLDING
1692 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1693 * it in "*cp". Doesn't give error messages.
1696 eval_foldexpr(arg, cp)
1697 char_u *arg;
1698 int *cp;
1700 typval_T tv;
1701 int retval;
1702 char_u *s;
1703 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1704 OPT_LOCAL);
1706 ++emsg_off;
1707 if (use_sandbox)
1708 ++sandbox;
1709 ++textlock;
1710 *cp = NUL;
1711 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1712 retval = 0;
1713 else
1715 /* If the result is a number, just return the number. */
1716 if (tv.v_type == VAR_NUMBER)
1717 retval = tv.vval.v_number;
1718 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1719 retval = 0;
1720 else
1722 /* If the result is a string, check if there is a non-digit before
1723 * the number. */
1724 s = tv.vval.v_string;
1725 if (!VIM_ISDIGIT(*s) && *s != '-')
1726 *cp = *s++;
1727 retval = atol((char *)s);
1729 clear_tv(&tv);
1731 --emsg_off;
1732 if (use_sandbox)
1733 --sandbox;
1734 --textlock;
1736 return retval;
1738 #endif
1741 * ":let" list all variable values
1742 * ":let var1 var2" list variable values
1743 * ":let var = expr" assignment command.
1744 * ":let var += expr" assignment command.
1745 * ":let var -= expr" assignment command.
1746 * ":let var .= expr" assignment command.
1747 * ":let [var1, var2] = expr" unpack list.
1749 void
1750 ex_let(eap)
1751 exarg_T *eap;
1753 char_u *arg = eap->arg;
1754 char_u *expr = NULL;
1755 typval_T rettv;
1756 int i;
1757 int var_count = 0;
1758 int semicolon = 0;
1759 char_u op[2];
1760 char_u *argend;
1761 int first = TRUE;
1763 argend = skip_var_list(arg, &var_count, &semicolon);
1764 if (argend == NULL)
1765 return;
1766 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1767 --argend;
1768 expr = vim_strchr(argend, '=');
1769 if (expr == NULL)
1772 * ":let" without "=": list variables
1774 if (*arg == '[')
1775 EMSG(_(e_invarg));
1776 else if (!ends_excmd(*arg))
1777 /* ":let var1 var2" */
1778 arg = list_arg_vars(eap, arg, &first);
1779 else if (!eap->skip)
1781 /* ":let" */
1782 list_glob_vars(&first);
1783 list_buf_vars(&first);
1784 list_win_vars(&first);
1785 #ifdef FEAT_WINDOWS
1786 list_tab_vars(&first);
1787 #endif
1788 list_script_vars(&first);
1789 list_func_vars(&first);
1790 list_vim_vars(&first);
1792 eap->nextcmd = check_nextcmd(arg);
1794 else
1796 op[0] = '=';
1797 op[1] = NUL;
1798 if (expr > argend)
1800 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1801 op[0] = expr[-1]; /* +=, -= or .= */
1803 expr = skipwhite(expr + 1);
1805 if (eap->skip)
1806 ++emsg_skip;
1807 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1808 if (eap->skip)
1810 if (i != FAIL)
1811 clear_tv(&rettv);
1812 --emsg_skip;
1814 else if (i != FAIL)
1816 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1817 op);
1818 clear_tv(&rettv);
1824 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1825 * Handles both "var" with any type and "[var, var; var]" with a list type.
1826 * When "nextchars" is not NULL it points to a string with characters that
1827 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1828 * or concatenate.
1829 * Returns OK or FAIL;
1831 static int
1832 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1833 char_u *arg_start;
1834 typval_T *tv;
1835 int copy; /* copy values from "tv", don't move */
1836 int semicolon; /* from skip_var_list() */
1837 int var_count; /* from skip_var_list() */
1838 char_u *nextchars;
1840 char_u *arg = arg_start;
1841 list_T *l;
1842 int i;
1843 listitem_T *item;
1844 typval_T ltv;
1846 if (*arg != '[')
1849 * ":let var = expr" or ":for var in list"
1851 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1852 return FAIL;
1853 return OK;
1857 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1859 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1861 EMSG(_(e_listreq));
1862 return FAIL;
1865 i = list_len(l);
1866 if (semicolon == 0 && var_count < i)
1868 EMSG(_("E687: Less targets than List items"));
1869 return FAIL;
1871 if (var_count - semicolon > i)
1873 EMSG(_("E688: More targets than List items"));
1874 return FAIL;
1877 item = l->lv_first;
1878 while (*arg != ']')
1880 arg = skipwhite(arg + 1);
1881 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1882 item = item->li_next;
1883 if (arg == NULL)
1884 return FAIL;
1886 arg = skipwhite(arg);
1887 if (*arg == ';')
1889 /* Put the rest of the list (may be empty) in the var after ';'.
1890 * Create a new list for this. */
1891 l = list_alloc();
1892 if (l == NULL)
1893 return FAIL;
1894 while (item != NULL)
1896 list_append_tv(l, &item->li_tv);
1897 item = item->li_next;
1900 ltv.v_type = VAR_LIST;
1901 ltv.v_lock = 0;
1902 ltv.vval.v_list = l;
1903 l->lv_refcount = 1;
1905 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1906 (char_u *)"]", nextchars);
1907 clear_tv(&ltv);
1908 if (arg == NULL)
1909 return FAIL;
1910 break;
1912 else if (*arg != ',' && *arg != ']')
1914 EMSG2(_(e_intern2), "ex_let_vars()");
1915 return FAIL;
1919 return OK;
1923 * Skip over assignable variable "var" or list of variables "[var, var]".
1924 * Used for ":let varvar = expr" and ":for varvar in expr".
1925 * For "[var, var]" increment "*var_count" for each variable.
1926 * for "[var, var; var]" set "semicolon".
1927 * Return NULL for an error.
1929 static char_u *
1930 skip_var_list(arg, var_count, semicolon)
1931 char_u *arg;
1932 int *var_count;
1933 int *semicolon;
1935 char_u *p, *s;
1937 if (*arg == '[')
1939 /* "[var, var]": find the matching ']'. */
1940 p = arg;
1941 for (;;)
1943 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1944 s = skip_var_one(p);
1945 if (s == p)
1947 EMSG2(_(e_invarg2), p);
1948 return NULL;
1950 ++*var_count;
1952 p = skipwhite(s);
1953 if (*p == ']')
1954 break;
1955 else if (*p == ';')
1957 if (*semicolon == 1)
1959 EMSG(_("Double ; in list of variables"));
1960 return NULL;
1962 *semicolon = 1;
1964 else if (*p != ',')
1966 EMSG2(_(e_invarg2), p);
1967 return NULL;
1970 return p + 1;
1972 else
1973 return skip_var_one(arg);
1977 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1978 * l[idx].
1980 static char_u *
1981 skip_var_one(arg)
1982 char_u *arg;
1984 if (*arg == '@' && arg[1] != NUL)
1985 return arg + 2;
1986 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
1987 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1991 * List variables for hashtab "ht" with prefix "prefix".
1992 * If "empty" is TRUE also list NULL strings as empty strings.
1994 static void
1995 list_hashtable_vars(ht, prefix, empty, first)
1996 hashtab_T *ht;
1997 char_u *prefix;
1998 int empty;
1999 int *first;
2001 hashitem_T *hi;
2002 dictitem_T *di;
2003 int todo;
2005 todo = (int)ht->ht_used;
2006 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2008 if (!HASHITEM_EMPTY(hi))
2010 --todo;
2011 di = HI2DI(hi);
2012 if (empty || di->di_tv.v_type != VAR_STRING
2013 || di->di_tv.vval.v_string != NULL)
2014 list_one_var(di, prefix, first);
2020 * List global variables.
2022 static void
2023 list_glob_vars(first)
2024 int *first;
2026 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2030 * List buffer variables.
2032 static void
2033 list_buf_vars(first)
2034 int *first;
2036 char_u numbuf[NUMBUFLEN];
2038 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2039 TRUE, first);
2041 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2042 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2043 numbuf, first);
2047 * List window variables.
2049 static void
2050 list_win_vars(first)
2051 int *first;
2053 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2054 (char_u *)"w:", TRUE, first);
2057 #ifdef FEAT_WINDOWS
2059 * List tab page variables.
2061 static void
2062 list_tab_vars(first)
2063 int *first;
2065 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2066 (char_u *)"t:", TRUE, first);
2068 #endif
2071 * List Vim variables.
2073 static void
2074 list_vim_vars(first)
2075 int *first;
2077 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2081 * List script-local variables, if there is a script.
2083 static void
2084 list_script_vars(first)
2085 int *first;
2087 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2088 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2089 (char_u *)"s:", FALSE, first);
2093 * List function variables, if there is a function.
2095 static void
2096 list_func_vars(first)
2097 int *first;
2099 if (current_funccal != NULL)
2100 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2101 (char_u *)"l:", FALSE, first);
2105 * List variables in "arg".
2107 static char_u *
2108 list_arg_vars(eap, arg, first)
2109 exarg_T *eap;
2110 char_u *arg;
2111 int *first;
2113 int error = FALSE;
2114 int len;
2115 char_u *name;
2116 char_u *name_start;
2117 char_u *arg_subsc;
2118 char_u *tofree;
2119 typval_T tv;
2121 while (!ends_excmd(*arg) && !got_int)
2123 if (error || eap->skip)
2125 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2126 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2128 emsg_severe = TRUE;
2129 EMSG(_(e_trailing));
2130 break;
2133 else
2135 /* get_name_len() takes care of expanding curly braces */
2136 name_start = name = arg;
2137 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2138 if (len <= 0)
2140 /* This is mainly to keep test 49 working: when expanding
2141 * curly braces fails overrule the exception error message. */
2142 if (len < 0 && !aborting())
2144 emsg_severe = TRUE;
2145 EMSG2(_(e_invarg2), arg);
2146 break;
2148 error = TRUE;
2150 else
2152 if (tofree != NULL)
2153 name = tofree;
2154 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2155 error = TRUE;
2156 else
2158 /* handle d.key, l[idx], f(expr) */
2159 arg_subsc = arg;
2160 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2161 error = TRUE;
2162 else
2164 if (arg == arg_subsc && len == 2 && name[1] == ':')
2166 switch (*name)
2168 case 'g': list_glob_vars(first); break;
2169 case 'b': list_buf_vars(first); break;
2170 case 'w': list_win_vars(first); break;
2171 #ifdef FEAT_WINDOWS
2172 case 't': list_tab_vars(first); break;
2173 #endif
2174 case 'v': list_vim_vars(first); break;
2175 case 's': list_script_vars(first); break;
2176 case 'l': list_func_vars(first); break;
2177 default:
2178 EMSG2(_("E738: Can't list variables for %s"), name);
2181 else
2183 char_u numbuf[NUMBUFLEN];
2184 char_u *tf;
2185 int c;
2186 char_u *s;
2188 s = echo_string(&tv, &tf, numbuf, 0);
2189 c = *arg;
2190 *arg = NUL;
2191 list_one_var_a((char_u *)"",
2192 arg == arg_subsc ? name : name_start,
2193 tv.v_type,
2194 s == NULL ? (char_u *)"" : s,
2195 first);
2196 *arg = c;
2197 vim_free(tf);
2199 clear_tv(&tv);
2204 vim_free(tofree);
2207 arg = skipwhite(arg);
2210 return arg;
2214 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2215 * Returns a pointer to the char just after the var name.
2216 * Returns NULL if there is an error.
2218 static char_u *
2219 ex_let_one(arg, tv, copy, endchars, op)
2220 char_u *arg; /* points to variable name */
2221 typval_T *tv; /* value to assign to variable */
2222 int copy; /* copy value from "tv" */
2223 char_u *endchars; /* valid chars after variable name or NULL */
2224 char_u *op; /* "+", "-", "." or NULL*/
2226 int c1;
2227 char_u *name;
2228 char_u *p;
2229 char_u *arg_end = NULL;
2230 int len;
2231 int opt_flags;
2232 char_u *tofree = NULL;
2235 * ":let $VAR = expr": Set environment variable.
2237 if (*arg == '$')
2239 /* Find the end of the name. */
2240 ++arg;
2241 name = arg;
2242 len = get_env_len(&arg);
2243 if (len == 0)
2244 EMSG2(_(e_invarg2), name - 1);
2245 else
2247 if (op != NULL && (*op == '+' || *op == '-'))
2248 EMSG2(_(e_letwrong), op);
2249 else if (endchars != NULL
2250 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2251 EMSG(_(e_letunexp));
2252 else
2254 c1 = name[len];
2255 name[len] = NUL;
2256 p = get_tv_string_chk(tv);
2257 if (p != NULL && op != NULL && *op == '.')
2259 int mustfree = FALSE;
2260 char_u *s = vim_getenv(name, &mustfree);
2262 if (s != NULL)
2264 p = tofree = concat_str(s, p);
2265 if (mustfree)
2266 vim_free(s);
2269 if (p != NULL)
2271 vim_setenv(name, p);
2272 if (STRICMP(name, "HOME") == 0)
2273 init_homedir();
2274 else if (didset_vim && STRICMP(name, "VIM") == 0)
2275 didset_vim = FALSE;
2276 else if (didset_vimruntime
2277 && STRICMP(name, "VIMRUNTIME") == 0)
2278 didset_vimruntime = FALSE;
2279 arg_end = arg;
2281 name[len] = c1;
2282 vim_free(tofree);
2288 * ":let &option = expr": Set option value.
2289 * ":let &l:option = expr": Set local option value.
2290 * ":let &g:option = expr": Set global option value.
2292 else if (*arg == '&')
2294 /* Find the end of the name. */
2295 p = find_option_end(&arg, &opt_flags);
2296 if (p == NULL || (endchars != NULL
2297 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2298 EMSG(_(e_letunexp));
2299 else
2301 long n;
2302 int opt_type;
2303 long numval;
2304 char_u *stringval = NULL;
2305 char_u *s;
2307 c1 = *p;
2308 *p = NUL;
2310 n = get_tv_number(tv);
2311 s = get_tv_string_chk(tv); /* != NULL if number or string */
2312 if (s != NULL && op != NULL && *op != '=')
2314 opt_type = get_option_value(arg, &numval,
2315 &stringval, opt_flags);
2316 if ((opt_type == 1 && *op == '.')
2317 || (opt_type == 0 && *op != '.'))
2318 EMSG2(_(e_letwrong), op);
2319 else
2321 if (opt_type == 1) /* number */
2323 if (*op == '+')
2324 n = numval + n;
2325 else
2326 n = numval - n;
2328 else if (opt_type == 0 && stringval != NULL) /* string */
2330 s = concat_str(stringval, s);
2331 vim_free(stringval);
2332 stringval = s;
2336 if (s != NULL)
2338 set_option_value(arg, n, s, opt_flags);
2339 arg_end = p;
2341 *p = c1;
2342 vim_free(stringval);
2347 * ":let @r = expr": Set register contents.
2349 else if (*arg == '@')
2351 ++arg;
2352 if (op != NULL && (*op == '+' || *op == '-'))
2353 EMSG2(_(e_letwrong), op);
2354 else if (endchars != NULL
2355 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2356 EMSG(_(e_letunexp));
2357 else
2359 char_u *ptofree = NULL;
2360 char_u *s;
2362 p = get_tv_string_chk(tv);
2363 if (p != NULL && op != NULL && *op == '.')
2365 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2366 if (s != NULL)
2368 p = ptofree = concat_str(s, p);
2369 vim_free(s);
2372 if (p != NULL)
2374 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2375 arg_end = arg + 1;
2377 vim_free(ptofree);
2382 * ":let var = expr": Set internal variable.
2383 * ":let {expr} = expr": Idem, name made with curly braces
2385 else if (eval_isnamec1(*arg) || *arg == '{')
2387 lval_T lv;
2389 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2390 if (p != NULL && lv.ll_name != NULL)
2392 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2393 EMSG(_(e_letunexp));
2394 else
2396 set_var_lval(&lv, p, tv, copy, op);
2397 arg_end = p;
2400 clear_lval(&lv);
2403 else
2404 EMSG2(_(e_invarg2), arg);
2406 return arg_end;
2410 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2412 static int
2413 check_changedtick(arg)
2414 char_u *arg;
2416 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2418 EMSG2(_(e_readonlyvar), arg);
2419 return TRUE;
2421 return FALSE;
2425 * Get an lval: variable, Dict item or List item that can be assigned a value
2426 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2427 * "name.key", "name.key[expr]" etc.
2428 * Indexing only works if "name" is an existing List or Dictionary.
2429 * "name" points to the start of the name.
2430 * If "rettv" is not NULL it points to the value to be assigned.
2431 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2432 * wrong; must end in space or cmd separator.
2434 * Returns a pointer to just after the name, including indexes.
2435 * When an evaluation error occurs "lp->ll_name" is NULL;
2436 * Returns NULL for a parsing error. Still need to free items in "lp"!
2438 static char_u *
2439 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2440 char_u *name;
2441 typval_T *rettv;
2442 lval_T *lp;
2443 int unlet;
2444 int skip;
2445 int quiet; /* don't give error messages */
2446 int fne_flags; /* flags for find_name_end() */
2448 char_u *p;
2449 char_u *expr_start, *expr_end;
2450 int cc;
2451 dictitem_T *v;
2452 typval_T var1;
2453 typval_T var2;
2454 int empty1 = FALSE;
2455 listitem_T *ni;
2456 char_u *key = NULL;
2457 int len;
2458 hashtab_T *ht;
2460 /* Clear everything in "lp". */
2461 vim_memset(lp, 0, sizeof(lval_T));
2463 if (skip)
2465 /* When skipping just find the end of the name. */
2466 lp->ll_name = name;
2467 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2470 /* Find the end of the name. */
2471 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2472 if (expr_start != NULL)
2474 /* Don't expand the name when we already know there is an error. */
2475 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2476 && *p != '[' && *p != '.')
2478 EMSG(_(e_trailing));
2479 return NULL;
2482 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2483 if (lp->ll_exp_name == NULL)
2485 /* Report an invalid expression in braces, unless the
2486 * expression evaluation has been cancelled due to an
2487 * aborting error, an interrupt, or an exception. */
2488 if (!aborting() && !quiet)
2490 emsg_severe = TRUE;
2491 EMSG2(_(e_invarg2), name);
2492 return NULL;
2495 lp->ll_name = lp->ll_exp_name;
2497 else
2498 lp->ll_name = name;
2500 /* Without [idx] or .key we are done. */
2501 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2502 return p;
2504 cc = *p;
2505 *p = NUL;
2506 v = find_var(lp->ll_name, &ht);
2507 if (v == NULL && !quiet)
2508 EMSG2(_(e_undefvar), lp->ll_name);
2509 *p = cc;
2510 if (v == NULL)
2511 return NULL;
2514 * Loop until no more [idx] or .key is following.
2516 lp->ll_tv = &v->di_tv;
2517 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2519 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2520 && !(lp->ll_tv->v_type == VAR_DICT
2521 && lp->ll_tv->vval.v_dict != NULL))
2523 if (!quiet)
2524 EMSG(_("E689: Can only index a List or Dictionary"));
2525 return NULL;
2527 if (lp->ll_range)
2529 if (!quiet)
2530 EMSG(_("E708: [:] must come last"));
2531 return NULL;
2534 len = -1;
2535 if (*p == '.')
2537 key = p + 1;
2538 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2540 if (len == 0)
2542 if (!quiet)
2543 EMSG(_(e_emptykey));
2544 return NULL;
2546 p = key + len;
2548 else
2550 /* Get the index [expr] or the first index [expr: ]. */
2551 p = skipwhite(p + 1);
2552 if (*p == ':')
2553 empty1 = TRUE;
2554 else
2556 empty1 = FALSE;
2557 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2558 return NULL;
2559 if (get_tv_string_chk(&var1) == NULL)
2561 /* not a number or string */
2562 clear_tv(&var1);
2563 return NULL;
2567 /* Optionally get the second index [ :expr]. */
2568 if (*p == ':')
2570 if (lp->ll_tv->v_type == VAR_DICT)
2572 if (!quiet)
2573 EMSG(_(e_dictrange));
2574 if (!empty1)
2575 clear_tv(&var1);
2576 return NULL;
2578 if (rettv != NULL && (rettv->v_type != VAR_LIST
2579 || rettv->vval.v_list == NULL))
2581 if (!quiet)
2582 EMSG(_("E709: [:] requires a List value"));
2583 if (!empty1)
2584 clear_tv(&var1);
2585 return NULL;
2587 p = skipwhite(p + 1);
2588 if (*p == ']')
2589 lp->ll_empty2 = TRUE;
2590 else
2592 lp->ll_empty2 = FALSE;
2593 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2595 if (!empty1)
2596 clear_tv(&var1);
2597 return NULL;
2599 if (get_tv_string_chk(&var2) == NULL)
2601 /* not a number or string */
2602 if (!empty1)
2603 clear_tv(&var1);
2604 clear_tv(&var2);
2605 return NULL;
2608 lp->ll_range = TRUE;
2610 else
2611 lp->ll_range = FALSE;
2613 if (*p != ']')
2615 if (!quiet)
2616 EMSG(_(e_missbrac));
2617 if (!empty1)
2618 clear_tv(&var1);
2619 if (lp->ll_range && !lp->ll_empty2)
2620 clear_tv(&var2);
2621 return NULL;
2624 /* Skip to past ']'. */
2625 ++p;
2628 if (lp->ll_tv->v_type == VAR_DICT)
2630 if (len == -1)
2632 /* "[key]": get key from "var1" */
2633 key = get_tv_string(&var1); /* is number or string */
2634 if (*key == NUL)
2636 if (!quiet)
2637 EMSG(_(e_emptykey));
2638 clear_tv(&var1);
2639 return NULL;
2642 lp->ll_list = NULL;
2643 lp->ll_dict = lp->ll_tv->vval.v_dict;
2644 lp->ll_di = dict_find(lp->ll_dict, key, len);
2645 if (lp->ll_di == NULL)
2647 /* Key does not exist in dict: may need to add it. */
2648 if (*p == '[' || *p == '.' || unlet)
2650 if (!quiet)
2651 EMSG2(_(e_dictkey), key);
2652 if (len == -1)
2653 clear_tv(&var1);
2654 return NULL;
2656 if (len == -1)
2657 lp->ll_newkey = vim_strsave(key);
2658 else
2659 lp->ll_newkey = vim_strnsave(key, len);
2660 if (len == -1)
2661 clear_tv(&var1);
2662 if (lp->ll_newkey == NULL)
2663 p = NULL;
2664 break;
2666 if (len == -1)
2667 clear_tv(&var1);
2668 lp->ll_tv = &lp->ll_di->di_tv;
2670 else
2673 * Get the number and item for the only or first index of the List.
2675 if (empty1)
2676 lp->ll_n1 = 0;
2677 else
2679 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2680 clear_tv(&var1);
2682 lp->ll_dict = NULL;
2683 lp->ll_list = lp->ll_tv->vval.v_list;
2684 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2685 if (lp->ll_li == NULL)
2687 if (lp->ll_n1 < 0)
2689 lp->ll_n1 = 0;
2690 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2693 if (lp->ll_li == NULL)
2695 if (lp->ll_range && !lp->ll_empty2)
2696 clear_tv(&var2);
2697 return NULL;
2701 * May need to find the item or absolute index for the second
2702 * index of a range.
2703 * When no index given: "lp->ll_empty2" is TRUE.
2704 * Otherwise "lp->ll_n2" is set to the second index.
2706 if (lp->ll_range && !lp->ll_empty2)
2708 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2709 clear_tv(&var2);
2710 if (lp->ll_n2 < 0)
2712 ni = list_find(lp->ll_list, lp->ll_n2);
2713 if (ni == NULL)
2714 return NULL;
2715 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2718 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2719 if (lp->ll_n1 < 0)
2720 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2721 if (lp->ll_n2 < lp->ll_n1)
2722 return NULL;
2725 lp->ll_tv = &lp->ll_li->li_tv;
2729 return p;
2733 * Clear lval "lp" that was filled by get_lval().
2735 static void
2736 clear_lval(lp)
2737 lval_T *lp;
2739 vim_free(lp->ll_exp_name);
2740 vim_free(lp->ll_newkey);
2744 * Set a variable that was parsed by get_lval() to "rettv".
2745 * "endp" points to just after the parsed name.
2746 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2748 static void
2749 set_var_lval(lp, endp, rettv, copy, op)
2750 lval_T *lp;
2751 char_u *endp;
2752 typval_T *rettv;
2753 int copy;
2754 char_u *op;
2756 int cc;
2757 listitem_T *ri;
2758 dictitem_T *di;
2760 if (lp->ll_tv == NULL)
2762 if (!check_changedtick(lp->ll_name))
2764 cc = *endp;
2765 *endp = NUL;
2766 if (op != NULL && *op != '=')
2768 typval_T tv;
2770 /* handle +=, -= and .= */
2771 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2772 &tv, TRUE) == OK)
2774 if (tv_op(&tv, rettv, op) == OK)
2775 set_var(lp->ll_name, &tv, FALSE);
2776 clear_tv(&tv);
2779 else
2780 set_var(lp->ll_name, rettv, copy);
2781 *endp = cc;
2784 else if (tv_check_lock(lp->ll_newkey == NULL
2785 ? lp->ll_tv->v_lock
2786 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2788 else if (lp->ll_range)
2791 * Assign the List values to the list items.
2793 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2795 if (op != NULL && *op != '=')
2796 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2797 else
2799 clear_tv(&lp->ll_li->li_tv);
2800 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2802 ri = ri->li_next;
2803 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2804 break;
2805 if (lp->ll_li->li_next == NULL)
2807 /* Need to add an empty item. */
2808 if (list_append_number(lp->ll_list, 0) == FAIL)
2810 ri = NULL;
2811 break;
2814 lp->ll_li = lp->ll_li->li_next;
2815 ++lp->ll_n1;
2817 if (ri != NULL)
2818 EMSG(_("E710: List value has more items than target"));
2819 else if (lp->ll_empty2
2820 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2821 : lp->ll_n1 != lp->ll_n2)
2822 EMSG(_("E711: List value has not enough items"));
2824 else
2827 * Assign to a List or Dictionary item.
2829 if (lp->ll_newkey != NULL)
2831 if (op != NULL && *op != '=')
2833 EMSG2(_(e_letwrong), op);
2834 return;
2837 /* Need to add an item to the Dictionary. */
2838 di = dictitem_alloc(lp->ll_newkey);
2839 if (di == NULL)
2840 return;
2841 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2843 vim_free(di);
2844 return;
2846 lp->ll_tv = &di->di_tv;
2848 else if (op != NULL && *op != '=')
2850 tv_op(lp->ll_tv, rettv, op);
2851 return;
2853 else
2854 clear_tv(lp->ll_tv);
2857 * Assign the value to the variable or list item.
2859 if (copy)
2860 copy_tv(rettv, lp->ll_tv);
2861 else
2863 *lp->ll_tv = *rettv;
2864 lp->ll_tv->v_lock = 0;
2865 init_tv(rettv);
2871 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2872 * Returns OK or FAIL.
2874 static int
2875 tv_op(tv1, tv2, op)
2876 typval_T *tv1;
2877 typval_T *tv2;
2878 char_u *op;
2880 long n;
2881 char_u numbuf[NUMBUFLEN];
2882 char_u *s;
2884 /* Can't do anything with a Funcref or a Dict on the right. */
2885 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2887 switch (tv1->v_type)
2889 case VAR_DICT:
2890 case VAR_FUNC:
2891 break;
2893 case VAR_LIST:
2894 if (*op != '+' || tv2->v_type != VAR_LIST)
2895 break;
2896 /* List += List */
2897 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2898 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2899 return OK;
2901 case VAR_NUMBER:
2902 case VAR_STRING:
2903 if (tv2->v_type == VAR_LIST)
2904 break;
2905 if (*op == '+' || *op == '-')
2907 /* nr += nr or nr -= nr*/
2908 n = get_tv_number(tv1);
2909 #ifdef FEAT_FLOAT
2910 if (tv2->v_type == VAR_FLOAT)
2912 float_T f = n;
2914 if (*op == '+')
2915 f += tv2->vval.v_float;
2916 else
2917 f -= tv2->vval.v_float;
2918 clear_tv(tv1);
2919 tv1->v_type = VAR_FLOAT;
2920 tv1->vval.v_float = f;
2922 else
2923 #endif
2925 if (*op == '+')
2926 n += get_tv_number(tv2);
2927 else
2928 n -= get_tv_number(tv2);
2929 clear_tv(tv1);
2930 tv1->v_type = VAR_NUMBER;
2931 tv1->vval.v_number = n;
2934 else
2936 if (tv2->v_type == VAR_FLOAT)
2937 break;
2939 /* str .= str */
2940 s = get_tv_string(tv1);
2941 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2942 clear_tv(tv1);
2943 tv1->v_type = VAR_STRING;
2944 tv1->vval.v_string = s;
2946 return OK;
2948 #ifdef FEAT_FLOAT
2949 case VAR_FLOAT:
2951 float_T f;
2953 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2954 && tv2->v_type != VAR_NUMBER
2955 && tv2->v_type != VAR_STRING))
2956 break;
2957 if (tv2->v_type == VAR_FLOAT)
2958 f = tv2->vval.v_float;
2959 else
2960 f = get_tv_number(tv2);
2961 if (*op == '+')
2962 tv1->vval.v_float += f;
2963 else
2964 tv1->vval.v_float -= f;
2966 return OK;
2967 #endif
2971 EMSG2(_(e_letwrong), op);
2972 return FAIL;
2976 * Add a watcher to a list.
2978 static void
2979 list_add_watch(l, lw)
2980 list_T *l;
2981 listwatch_T *lw;
2983 lw->lw_next = l->lv_watch;
2984 l->lv_watch = lw;
2988 * Remove a watcher from a list.
2989 * No warning when it isn't found...
2991 static void
2992 list_rem_watch(l, lwrem)
2993 list_T *l;
2994 listwatch_T *lwrem;
2996 listwatch_T *lw, **lwp;
2998 lwp = &l->lv_watch;
2999 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3001 if (lw == lwrem)
3003 *lwp = lw->lw_next;
3004 break;
3006 lwp = &lw->lw_next;
3011 * Just before removing an item from a list: advance watchers to the next
3012 * item.
3014 static void
3015 list_fix_watch(l, item)
3016 list_T *l;
3017 listitem_T *item;
3019 listwatch_T *lw;
3021 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3022 if (lw->lw_item == item)
3023 lw->lw_item = item->li_next;
3027 * Evaluate the expression used in a ":for var in expr" command.
3028 * "arg" points to "var".
3029 * Set "*errp" to TRUE for an error, FALSE otherwise;
3030 * Return a pointer that holds the info. Null when there is an error.
3032 void *
3033 eval_for_line(arg, errp, nextcmdp, skip)
3034 char_u *arg;
3035 int *errp;
3036 char_u **nextcmdp;
3037 int skip;
3039 forinfo_T *fi;
3040 char_u *expr;
3041 typval_T tv;
3042 list_T *l;
3044 *errp = TRUE; /* default: there is an error */
3046 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3047 if (fi == NULL)
3048 return NULL;
3050 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3051 if (expr == NULL)
3052 return fi;
3054 expr = skipwhite(expr);
3055 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3057 EMSG(_("E690: Missing \"in\" after :for"));
3058 return fi;
3061 if (skip)
3062 ++emsg_skip;
3063 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3065 *errp = FALSE;
3066 if (!skip)
3068 l = tv.vval.v_list;
3069 if (tv.v_type != VAR_LIST || l == NULL)
3071 EMSG(_(e_listreq));
3072 clear_tv(&tv);
3074 else
3076 /* No need to increment the refcount, it's already set for the
3077 * list being used in "tv". */
3078 fi->fi_list = l;
3079 list_add_watch(l, &fi->fi_lw);
3080 fi->fi_lw.lw_item = l->lv_first;
3084 if (skip)
3085 --emsg_skip;
3087 return fi;
3091 * Use the first item in a ":for" list. Advance to the next.
3092 * Assign the values to the variable (list). "arg" points to the first one.
3093 * Return TRUE when a valid item was found, FALSE when at end of list or
3094 * something wrong.
3097 next_for_item(fi_void, arg)
3098 void *fi_void;
3099 char_u *arg;
3101 forinfo_T *fi = (forinfo_T *)fi_void;
3102 int result;
3103 listitem_T *item;
3105 item = fi->fi_lw.lw_item;
3106 if (item == NULL)
3107 result = FALSE;
3108 else
3110 fi->fi_lw.lw_item = item->li_next;
3111 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3112 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3114 return result;
3118 * Free the structure used to store info used by ":for".
3120 void
3121 free_for_info(fi_void)
3122 void *fi_void;
3124 forinfo_T *fi = (forinfo_T *)fi_void;
3126 if (fi != NULL && fi->fi_list != NULL)
3128 list_rem_watch(fi->fi_list, &fi->fi_lw);
3129 list_unref(fi->fi_list);
3131 vim_free(fi);
3134 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3136 void
3137 set_context_for_expression(xp, arg, cmdidx)
3138 expand_T *xp;
3139 char_u *arg;
3140 cmdidx_T cmdidx;
3142 int got_eq = FALSE;
3143 int c;
3144 char_u *p;
3146 if (cmdidx == CMD_let)
3148 xp->xp_context = EXPAND_USER_VARS;
3149 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3151 /* ":let var1 var2 ...": find last space. */
3152 for (p = arg + STRLEN(arg); p >= arg; )
3154 xp->xp_pattern = p;
3155 mb_ptr_back(arg, p);
3156 if (vim_iswhite(*p))
3157 break;
3159 return;
3162 else
3163 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3164 : EXPAND_EXPRESSION;
3165 while ((xp->xp_pattern = vim_strpbrk(arg,
3166 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3168 c = *xp->xp_pattern;
3169 if (c == '&')
3171 c = xp->xp_pattern[1];
3172 if (c == '&')
3174 ++xp->xp_pattern;
3175 xp->xp_context = cmdidx != CMD_let || got_eq
3176 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3178 else if (c != ' ')
3180 xp->xp_context = EXPAND_SETTINGS;
3181 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3182 xp->xp_pattern += 2;
3186 else if (c == '$')
3188 /* environment variable */
3189 xp->xp_context = EXPAND_ENV_VARS;
3191 else if (c == '=')
3193 got_eq = TRUE;
3194 xp->xp_context = EXPAND_EXPRESSION;
3196 else if (c == '<'
3197 && xp->xp_context == EXPAND_FUNCTIONS
3198 && vim_strchr(xp->xp_pattern, '(') == NULL)
3200 /* Function name can start with "<SNR>" */
3201 break;
3203 else if (cmdidx != CMD_let || got_eq)
3205 if (c == '"') /* string */
3207 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3208 if (c == '\\' && xp->xp_pattern[1] != NUL)
3209 ++xp->xp_pattern;
3210 xp->xp_context = EXPAND_NOTHING;
3212 else if (c == '\'') /* literal string */
3214 /* Trick: '' is like stopping and starting a literal string. */
3215 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3216 /* skip */ ;
3217 xp->xp_context = EXPAND_NOTHING;
3219 else if (c == '|')
3221 if (xp->xp_pattern[1] == '|')
3223 ++xp->xp_pattern;
3224 xp->xp_context = EXPAND_EXPRESSION;
3226 else
3227 xp->xp_context = EXPAND_COMMANDS;
3229 else
3230 xp->xp_context = EXPAND_EXPRESSION;
3232 else
3233 /* Doesn't look like something valid, expand as an expression
3234 * anyway. */
3235 xp->xp_context = EXPAND_EXPRESSION;
3236 arg = xp->xp_pattern;
3237 if (*arg != NUL)
3238 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3239 /* skip */ ;
3241 xp->xp_pattern = arg;
3244 #endif /* FEAT_CMDL_COMPL */
3247 * ":1,25call func(arg1, arg2)" function call.
3249 void
3250 ex_call(eap)
3251 exarg_T *eap;
3253 char_u *arg = eap->arg;
3254 char_u *startarg;
3255 char_u *name;
3256 char_u *tofree;
3257 int len;
3258 typval_T rettv;
3259 linenr_T lnum;
3260 int doesrange;
3261 int failed = FALSE;
3262 funcdict_T fudi;
3264 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3265 if (fudi.fd_newkey != NULL)
3267 /* Still need to give an error message for missing key. */
3268 EMSG2(_(e_dictkey), fudi.fd_newkey);
3269 vim_free(fudi.fd_newkey);
3271 if (tofree == NULL)
3272 return;
3274 /* Increase refcount on dictionary, it could get deleted when evaluating
3275 * the arguments. */
3276 if (fudi.fd_dict != NULL)
3277 ++fudi.fd_dict->dv_refcount;
3279 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3280 len = (int)STRLEN(tofree);
3281 name = deref_func_name(tofree, &len);
3283 /* Skip white space to allow ":call func ()". Not good, but required for
3284 * backward compatibility. */
3285 startarg = skipwhite(arg);
3286 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3288 if (*startarg != '(')
3290 EMSG2(_("E107: Missing braces: %s"), eap->arg);
3291 goto end;
3295 * When skipping, evaluate the function once, to find the end of the
3296 * arguments.
3297 * When the function takes a range, this is discovered after the first
3298 * call, and the loop is broken.
3300 if (eap->skip)
3302 ++emsg_skip;
3303 lnum = eap->line2; /* do it once, also with an invalid range */
3305 else
3306 lnum = eap->line1;
3307 for ( ; lnum <= eap->line2; ++lnum)
3309 if (!eap->skip && eap->addr_count > 0)
3311 curwin->w_cursor.lnum = lnum;
3312 curwin->w_cursor.col = 0;
3314 arg = startarg;
3315 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3316 eap->line1, eap->line2, &doesrange,
3317 !eap->skip, fudi.fd_dict) == FAIL)
3319 failed = TRUE;
3320 break;
3323 /* Handle a function returning a Funcref, Dictionary or List. */
3324 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3326 failed = TRUE;
3327 break;
3330 clear_tv(&rettv);
3331 if (doesrange || eap->skip)
3332 break;
3334 /* Stop when immediately aborting on error, or when an interrupt
3335 * occurred or an exception was thrown but not caught.
3336 * get_func_tv() returned OK, so that the check for trailing
3337 * characters below is executed. */
3338 if (aborting())
3339 break;
3341 if (eap->skip)
3342 --emsg_skip;
3344 if (!failed)
3346 /* Check for trailing illegal characters and a following command. */
3347 if (!ends_excmd(*arg))
3349 emsg_severe = TRUE;
3350 EMSG(_(e_trailing));
3352 else
3353 eap->nextcmd = check_nextcmd(arg);
3356 end:
3357 dict_unref(fudi.fd_dict);
3358 vim_free(tofree);
3362 * ":unlet[!] var1 ... " command.
3364 void
3365 ex_unlet(eap)
3366 exarg_T *eap;
3368 ex_unletlock(eap, eap->arg, 0);
3372 * ":lockvar" and ":unlockvar" commands
3374 void
3375 ex_lockvar(eap)
3376 exarg_T *eap;
3378 char_u *arg = eap->arg;
3379 int deep = 2;
3381 if (eap->forceit)
3382 deep = -1;
3383 else if (vim_isdigit(*arg))
3385 deep = getdigits(&arg);
3386 arg = skipwhite(arg);
3389 ex_unletlock(eap, arg, deep);
3393 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3395 static void
3396 ex_unletlock(eap, argstart, deep)
3397 exarg_T *eap;
3398 char_u *argstart;
3399 int deep;
3401 char_u *arg = argstart;
3402 char_u *name_end;
3403 int error = FALSE;
3404 lval_T lv;
3408 /* Parse the name and find the end. */
3409 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3410 FNE_CHECK_START);
3411 if (lv.ll_name == NULL)
3412 error = TRUE; /* error but continue parsing */
3413 if (name_end == NULL || (!vim_iswhite(*name_end)
3414 && !ends_excmd(*name_end)))
3416 if (name_end != NULL)
3418 emsg_severe = TRUE;
3419 EMSG(_(e_trailing));
3421 if (!(eap->skip || error))
3422 clear_lval(&lv);
3423 break;
3426 if (!error && !eap->skip)
3428 if (eap->cmdidx == CMD_unlet)
3430 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3431 error = TRUE;
3433 else
3435 if (do_lock_var(&lv, name_end, deep,
3436 eap->cmdidx == CMD_lockvar) == FAIL)
3437 error = TRUE;
3441 if (!eap->skip)
3442 clear_lval(&lv);
3444 arg = skipwhite(name_end);
3445 } while (!ends_excmd(*arg));
3447 eap->nextcmd = check_nextcmd(arg);
3450 static int
3451 do_unlet_var(lp, name_end, forceit)
3452 lval_T *lp;
3453 char_u *name_end;
3454 int forceit;
3456 int ret = OK;
3457 int cc;
3459 if (lp->ll_tv == NULL)
3461 cc = *name_end;
3462 *name_end = NUL;
3464 /* Normal name or expanded name. */
3465 if (check_changedtick(lp->ll_name))
3466 ret = FAIL;
3467 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3468 ret = FAIL;
3469 *name_end = cc;
3471 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3472 return FAIL;
3473 else if (lp->ll_range)
3475 listitem_T *li;
3477 /* Delete a range of List items. */
3478 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3480 li = lp->ll_li->li_next;
3481 listitem_remove(lp->ll_list, lp->ll_li);
3482 lp->ll_li = li;
3483 ++lp->ll_n1;
3486 else
3488 if (lp->ll_list != NULL)
3489 /* unlet a List item. */
3490 listitem_remove(lp->ll_list, lp->ll_li);
3491 else
3492 /* unlet a Dictionary item. */
3493 dictitem_remove(lp->ll_dict, lp->ll_di);
3496 return ret;
3500 * "unlet" a variable. Return OK if it existed, FAIL if not.
3501 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3504 do_unlet(name, forceit)
3505 char_u *name;
3506 int forceit;
3508 hashtab_T *ht;
3509 hashitem_T *hi;
3510 char_u *varname;
3511 dictitem_T *di;
3513 ht = find_var_ht(name, &varname);
3514 if (ht != NULL && *varname != NUL)
3516 hi = hash_find(ht, varname);
3517 if (!HASHITEM_EMPTY(hi))
3519 di = HI2DI(hi);
3520 if (var_check_fixed(di->di_flags, name)
3521 || var_check_ro(di->di_flags, name))
3522 return FAIL;
3523 delete_var(ht, hi);
3524 return OK;
3527 if (forceit)
3528 return OK;
3529 EMSG2(_("E108: No such variable: \"%s\""), name);
3530 return FAIL;
3534 * Lock or unlock variable indicated by "lp".
3535 * "deep" is the levels to go (-1 for unlimited);
3536 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3538 static int
3539 do_lock_var(lp, name_end, deep, lock)
3540 lval_T *lp;
3541 char_u *name_end;
3542 int deep;
3543 int lock;
3545 int ret = OK;
3546 int cc;
3547 dictitem_T *di;
3549 if (deep == 0) /* nothing to do */
3550 return OK;
3552 if (lp->ll_tv == NULL)
3554 cc = *name_end;
3555 *name_end = NUL;
3557 /* Normal name or expanded name. */
3558 if (check_changedtick(lp->ll_name))
3559 ret = FAIL;
3560 else
3562 di = find_var(lp->ll_name, NULL);
3563 if (di == NULL)
3564 ret = FAIL;
3565 else
3567 if (lock)
3568 di->di_flags |= DI_FLAGS_LOCK;
3569 else
3570 di->di_flags &= ~DI_FLAGS_LOCK;
3571 item_lock(&di->di_tv, deep, lock);
3574 *name_end = cc;
3576 else if (lp->ll_range)
3578 listitem_T *li = lp->ll_li;
3580 /* (un)lock a range of List items. */
3581 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3583 item_lock(&li->li_tv, deep, lock);
3584 li = li->li_next;
3585 ++lp->ll_n1;
3588 else if (lp->ll_list != NULL)
3589 /* (un)lock a List item. */
3590 item_lock(&lp->ll_li->li_tv, deep, lock);
3591 else
3592 /* un(lock) a Dictionary item. */
3593 item_lock(&lp->ll_di->di_tv, deep, lock);
3595 return ret;
3599 * Lock or unlock an item. "deep" is nr of levels to go.
3601 static void
3602 item_lock(tv, deep, lock)
3603 typval_T *tv;
3604 int deep;
3605 int lock;
3607 static int recurse = 0;
3608 list_T *l;
3609 listitem_T *li;
3610 dict_T *d;
3611 hashitem_T *hi;
3612 int todo;
3614 if (recurse >= DICT_MAXNEST)
3616 EMSG(_("E743: variable nested too deep for (un)lock"));
3617 return;
3619 if (deep == 0)
3620 return;
3621 ++recurse;
3623 /* lock/unlock the item itself */
3624 if (lock)
3625 tv->v_lock |= VAR_LOCKED;
3626 else
3627 tv->v_lock &= ~VAR_LOCKED;
3629 switch (tv->v_type)
3631 case VAR_LIST:
3632 if ((l = tv->vval.v_list) != NULL)
3634 if (lock)
3635 l->lv_lock |= VAR_LOCKED;
3636 else
3637 l->lv_lock &= ~VAR_LOCKED;
3638 if (deep < 0 || deep > 1)
3639 /* recursive: lock/unlock the items the List contains */
3640 for (li = l->lv_first; li != NULL; li = li->li_next)
3641 item_lock(&li->li_tv, deep - 1, lock);
3643 break;
3644 case VAR_DICT:
3645 if ((d = tv->vval.v_dict) != NULL)
3647 if (lock)
3648 d->dv_lock |= VAR_LOCKED;
3649 else
3650 d->dv_lock &= ~VAR_LOCKED;
3651 if (deep < 0 || deep > 1)
3653 /* recursive: lock/unlock the items the List contains */
3654 todo = (int)d->dv_hashtab.ht_used;
3655 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3657 if (!HASHITEM_EMPTY(hi))
3659 --todo;
3660 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3666 --recurse;
3670 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3671 * or it refers to a List or Dictionary that is locked.
3673 static int
3674 tv_islocked(tv)
3675 typval_T *tv;
3677 return (tv->v_lock & VAR_LOCKED)
3678 || (tv->v_type == VAR_LIST
3679 && tv->vval.v_list != NULL
3680 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3681 || (tv->v_type == VAR_DICT
3682 && tv->vval.v_dict != NULL
3683 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3686 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3688 * Delete all "menutrans_" variables.
3690 void
3691 del_menutrans_vars()
3693 hashitem_T *hi;
3694 int todo;
3696 hash_lock(&globvarht);
3697 todo = (int)globvarht.ht_used;
3698 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3700 if (!HASHITEM_EMPTY(hi))
3702 --todo;
3703 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3704 delete_var(&globvarht, hi);
3707 hash_unlock(&globvarht);
3709 #endif
3711 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3714 * Local string buffer for the next two functions to store a variable name
3715 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3716 * get_user_var_name().
3719 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3721 static char_u *varnamebuf = NULL;
3722 static int varnamebuflen = 0;
3725 * Function to concatenate a prefix and a variable name.
3727 static char_u *
3728 cat_prefix_varname(prefix, name)
3729 int prefix;
3730 char_u *name;
3732 int len;
3734 len = (int)STRLEN(name) + 3;
3735 if (len > varnamebuflen)
3737 vim_free(varnamebuf);
3738 len += 10; /* some additional space */
3739 varnamebuf = alloc(len);
3740 if (varnamebuf == NULL)
3742 varnamebuflen = 0;
3743 return NULL;
3745 varnamebuflen = len;
3747 *varnamebuf = prefix;
3748 varnamebuf[1] = ':';
3749 STRCPY(varnamebuf + 2, name);
3750 return varnamebuf;
3754 * Function given to ExpandGeneric() to obtain the list of user defined
3755 * (global/buffer/window/built-in) variable names.
3757 /*ARGSUSED*/
3758 char_u *
3759 get_user_var_name(xp, idx)
3760 expand_T *xp;
3761 int idx;
3763 static long_u gdone;
3764 static long_u bdone;
3765 static long_u wdone;
3766 #ifdef FEAT_WINDOWS
3767 static long_u tdone;
3768 #endif
3769 static int vidx;
3770 static hashitem_T *hi;
3771 hashtab_T *ht;
3773 if (idx == 0)
3775 gdone = bdone = wdone = vidx = 0;
3776 #ifdef FEAT_WINDOWS
3777 tdone = 0;
3778 #endif
3781 /* Global variables */
3782 if (gdone < globvarht.ht_used)
3784 if (gdone++ == 0)
3785 hi = globvarht.ht_array;
3786 else
3787 ++hi;
3788 while (HASHITEM_EMPTY(hi))
3789 ++hi;
3790 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3791 return cat_prefix_varname('g', hi->hi_key);
3792 return hi->hi_key;
3795 /* b: variables */
3796 ht = &curbuf->b_vars.dv_hashtab;
3797 if (bdone < ht->ht_used)
3799 if (bdone++ == 0)
3800 hi = ht->ht_array;
3801 else
3802 ++hi;
3803 while (HASHITEM_EMPTY(hi))
3804 ++hi;
3805 return cat_prefix_varname('b', hi->hi_key);
3807 if (bdone == ht->ht_used)
3809 ++bdone;
3810 return (char_u *)"b:changedtick";
3813 /* w: variables */
3814 ht = &curwin->w_vars.dv_hashtab;
3815 if (wdone < ht->ht_used)
3817 if (wdone++ == 0)
3818 hi = ht->ht_array;
3819 else
3820 ++hi;
3821 while (HASHITEM_EMPTY(hi))
3822 ++hi;
3823 return cat_prefix_varname('w', hi->hi_key);
3826 #ifdef FEAT_WINDOWS
3827 /* t: variables */
3828 ht = &curtab->tp_vars.dv_hashtab;
3829 if (tdone < ht->ht_used)
3831 if (tdone++ == 0)
3832 hi = ht->ht_array;
3833 else
3834 ++hi;
3835 while (HASHITEM_EMPTY(hi))
3836 ++hi;
3837 return cat_prefix_varname('t', hi->hi_key);
3839 #endif
3841 /* v: variables */
3842 if (vidx < VV_LEN)
3843 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3845 vim_free(varnamebuf);
3846 varnamebuf = NULL;
3847 varnamebuflen = 0;
3848 return NULL;
3851 #endif /* FEAT_CMDL_COMPL */
3854 * types for expressions.
3856 typedef enum
3858 TYPE_UNKNOWN = 0
3859 , TYPE_EQUAL /* == */
3860 , TYPE_NEQUAL /* != */
3861 , TYPE_GREATER /* > */
3862 , TYPE_GEQUAL /* >= */
3863 , TYPE_SMALLER /* < */
3864 , TYPE_SEQUAL /* <= */
3865 , TYPE_MATCH /* =~ */
3866 , TYPE_NOMATCH /* !~ */
3867 } exptype_T;
3870 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3871 * executed. The function may return OK, but the rettv will be of type
3872 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3876 * Handle zero level expression.
3877 * This calls eval1() and handles error message and nextcmd.
3878 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3879 * Note: "rettv.v_lock" is not set.
3880 * Return OK or FAIL.
3882 static int
3883 eval0(arg, rettv, nextcmd, evaluate)
3884 char_u *arg;
3885 typval_T *rettv;
3886 char_u **nextcmd;
3887 int evaluate;
3889 int ret;
3890 char_u *p;
3892 p = skipwhite(arg);
3893 ret = eval1(&p, rettv, evaluate);
3894 if (ret == FAIL || !ends_excmd(*p))
3896 if (ret != FAIL)
3897 clear_tv(rettv);
3899 * Report the invalid expression unless the expression evaluation has
3900 * been cancelled due to an aborting error, an interrupt, or an
3901 * exception.
3903 if (!aborting())
3904 EMSG2(_(e_invexpr2), arg);
3905 ret = FAIL;
3907 if (nextcmd != NULL)
3908 *nextcmd = check_nextcmd(p);
3910 return ret;
3914 * Handle top level expression:
3915 * expr1 ? expr0 : expr0
3917 * "arg" must point to the first non-white of the expression.
3918 * "arg" is advanced to the next non-white after the recognized expression.
3920 * Note: "rettv.v_lock" is not set.
3922 * Return OK or FAIL.
3924 static int
3925 eval1(arg, rettv, evaluate)
3926 char_u **arg;
3927 typval_T *rettv;
3928 int evaluate;
3930 int result;
3931 typval_T var2;
3934 * Get the first variable.
3936 if (eval2(arg, rettv, evaluate) == FAIL)
3937 return FAIL;
3939 if ((*arg)[0] == '?')
3941 result = FALSE;
3942 if (evaluate)
3944 int error = FALSE;
3946 if (get_tv_number_chk(rettv, &error) != 0)
3947 result = TRUE;
3948 clear_tv(rettv);
3949 if (error)
3950 return FAIL;
3954 * Get the second variable.
3956 *arg = skipwhite(*arg + 1);
3957 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3958 return FAIL;
3961 * Check for the ":".
3963 if ((*arg)[0] != ':')
3965 EMSG(_("E109: Missing ':' after '?'"));
3966 if (evaluate && result)
3967 clear_tv(rettv);
3968 return FAIL;
3972 * Get the third variable.
3974 *arg = skipwhite(*arg + 1);
3975 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3977 if (evaluate && result)
3978 clear_tv(rettv);
3979 return FAIL;
3981 if (evaluate && !result)
3982 *rettv = var2;
3985 return OK;
3989 * Handle first level expression:
3990 * expr2 || expr2 || expr2 logical OR
3992 * "arg" must point to the first non-white of the expression.
3993 * "arg" is advanced to the next non-white after the recognized expression.
3995 * Return OK or FAIL.
3997 static int
3998 eval2(arg, rettv, evaluate)
3999 char_u **arg;
4000 typval_T *rettv;
4001 int evaluate;
4003 typval_T var2;
4004 long result;
4005 int first;
4006 int error = FALSE;
4009 * Get the first variable.
4011 if (eval3(arg, rettv, evaluate) == FAIL)
4012 return FAIL;
4015 * Repeat until there is no following "||".
4017 first = TRUE;
4018 result = FALSE;
4019 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4021 if (evaluate && first)
4023 if (get_tv_number_chk(rettv, &error) != 0)
4024 result = TRUE;
4025 clear_tv(rettv);
4026 if (error)
4027 return FAIL;
4028 first = FALSE;
4032 * Get the second variable.
4034 *arg = skipwhite(*arg + 2);
4035 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4036 return FAIL;
4039 * Compute the result.
4041 if (evaluate && !result)
4043 if (get_tv_number_chk(&var2, &error) != 0)
4044 result = TRUE;
4045 clear_tv(&var2);
4046 if (error)
4047 return FAIL;
4049 if (evaluate)
4051 rettv->v_type = VAR_NUMBER;
4052 rettv->vval.v_number = result;
4056 return OK;
4060 * Handle second level expression:
4061 * expr3 && expr3 && expr3 logical AND
4063 * "arg" must point to the first non-white of the expression.
4064 * "arg" is advanced to the next non-white after the recognized expression.
4066 * Return OK or FAIL.
4068 static int
4069 eval3(arg, rettv, evaluate)
4070 char_u **arg;
4071 typval_T *rettv;
4072 int evaluate;
4074 typval_T var2;
4075 long result;
4076 int first;
4077 int error = FALSE;
4080 * Get the first variable.
4082 if (eval4(arg, rettv, evaluate) == FAIL)
4083 return FAIL;
4086 * Repeat until there is no following "&&".
4088 first = TRUE;
4089 result = TRUE;
4090 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4092 if (evaluate && first)
4094 if (get_tv_number_chk(rettv, &error) == 0)
4095 result = FALSE;
4096 clear_tv(rettv);
4097 if (error)
4098 return FAIL;
4099 first = FALSE;
4103 * Get the second variable.
4105 *arg = skipwhite(*arg + 2);
4106 if (eval4(arg, &var2, evaluate && result) == FAIL)
4107 return FAIL;
4110 * Compute the result.
4112 if (evaluate && result)
4114 if (get_tv_number_chk(&var2, &error) == 0)
4115 result = FALSE;
4116 clear_tv(&var2);
4117 if (error)
4118 return FAIL;
4120 if (evaluate)
4122 rettv->v_type = VAR_NUMBER;
4123 rettv->vval.v_number = result;
4127 return OK;
4131 * Handle third level expression:
4132 * var1 == var2
4133 * var1 =~ var2
4134 * var1 != var2
4135 * var1 !~ var2
4136 * var1 > var2
4137 * var1 >= var2
4138 * var1 < var2
4139 * var1 <= var2
4140 * var1 is var2
4141 * var1 isnot var2
4143 * "arg" must point to the first non-white of the expression.
4144 * "arg" is advanced to the next non-white after the recognized expression.
4146 * Return OK or FAIL.
4148 static int
4149 eval4(arg, rettv, evaluate)
4150 char_u **arg;
4151 typval_T *rettv;
4152 int evaluate;
4154 typval_T var2;
4155 char_u *p;
4156 int i;
4157 exptype_T type = TYPE_UNKNOWN;
4158 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4159 int len = 2;
4160 long n1, n2;
4161 char_u *s1, *s2;
4162 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4163 regmatch_T regmatch;
4164 int ic;
4165 char_u *save_cpo;
4168 * Get the first variable.
4170 if (eval5(arg, rettv, evaluate) == FAIL)
4171 return FAIL;
4173 p = *arg;
4174 switch (p[0])
4176 case '=': if (p[1] == '=')
4177 type = TYPE_EQUAL;
4178 else if (p[1] == '~')
4179 type = TYPE_MATCH;
4180 break;
4181 case '!': if (p[1] == '=')
4182 type = TYPE_NEQUAL;
4183 else if (p[1] == '~')
4184 type = TYPE_NOMATCH;
4185 break;
4186 case '>': if (p[1] != '=')
4188 type = TYPE_GREATER;
4189 len = 1;
4191 else
4192 type = TYPE_GEQUAL;
4193 break;
4194 case '<': if (p[1] != '=')
4196 type = TYPE_SMALLER;
4197 len = 1;
4199 else
4200 type = TYPE_SEQUAL;
4201 break;
4202 case 'i': if (p[1] == 's')
4204 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4205 len = 5;
4206 if (!vim_isIDc(p[len]))
4208 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4209 type_is = TRUE;
4212 break;
4216 * If there is a comparative operator, use it.
4218 if (type != TYPE_UNKNOWN)
4220 /* extra question mark appended: ignore case */
4221 if (p[len] == '?')
4223 ic = TRUE;
4224 ++len;
4226 /* extra '#' appended: match case */
4227 else if (p[len] == '#')
4229 ic = FALSE;
4230 ++len;
4232 /* nothing appended: use 'ignorecase' */
4233 else
4234 ic = p_ic;
4237 * Get the second variable.
4239 *arg = skipwhite(p + len);
4240 if (eval5(arg, &var2, evaluate) == FAIL)
4242 clear_tv(rettv);
4243 return FAIL;
4246 if (evaluate)
4248 if (type_is && rettv->v_type != var2.v_type)
4250 /* For "is" a different type always means FALSE, for "notis"
4251 * it means TRUE. */
4252 n1 = (type == TYPE_NEQUAL);
4254 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4256 if (type_is)
4258 n1 = (rettv->v_type == var2.v_type
4259 && rettv->vval.v_list == var2.vval.v_list);
4260 if (type == TYPE_NEQUAL)
4261 n1 = !n1;
4263 else if (rettv->v_type != var2.v_type
4264 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4266 if (rettv->v_type != var2.v_type)
4267 EMSG(_("E691: Can only compare List with List"));
4268 else
4269 EMSG(_("E692: Invalid operation for Lists"));
4270 clear_tv(rettv);
4271 clear_tv(&var2);
4272 return FAIL;
4274 else
4276 /* Compare two Lists for being equal or unequal. */
4277 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4278 if (type == TYPE_NEQUAL)
4279 n1 = !n1;
4283 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4285 if (type_is)
4287 n1 = (rettv->v_type == var2.v_type
4288 && rettv->vval.v_dict == var2.vval.v_dict);
4289 if (type == TYPE_NEQUAL)
4290 n1 = !n1;
4292 else if (rettv->v_type != var2.v_type
4293 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4295 if (rettv->v_type != var2.v_type)
4296 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4297 else
4298 EMSG(_("E736: Invalid operation for Dictionary"));
4299 clear_tv(rettv);
4300 clear_tv(&var2);
4301 return FAIL;
4303 else
4305 /* Compare two Dictionaries for being equal or unequal. */
4306 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4307 if (type == TYPE_NEQUAL)
4308 n1 = !n1;
4312 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4314 if (rettv->v_type != var2.v_type
4315 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4317 if (rettv->v_type != var2.v_type)
4318 EMSG(_("E693: Can only compare Funcref with Funcref"));
4319 else
4320 EMSG(_("E694: Invalid operation for Funcrefs"));
4321 clear_tv(rettv);
4322 clear_tv(&var2);
4323 return FAIL;
4325 else
4327 /* Compare two Funcrefs for being equal or unequal. */
4328 if (rettv->vval.v_string == NULL
4329 || var2.vval.v_string == NULL)
4330 n1 = FALSE;
4331 else
4332 n1 = STRCMP(rettv->vval.v_string,
4333 var2.vval.v_string) == 0;
4334 if (type == TYPE_NEQUAL)
4335 n1 = !n1;
4339 #ifdef FEAT_FLOAT
4341 * If one of the two variables is a float, compare as a float.
4342 * When using "=~" or "!~", always compare as string.
4344 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4345 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4347 float_T f1, f2;
4349 if (rettv->v_type == VAR_FLOAT)
4350 f1 = rettv->vval.v_float;
4351 else
4352 f1 = get_tv_number(rettv);
4353 if (var2.v_type == VAR_FLOAT)
4354 f2 = var2.vval.v_float;
4355 else
4356 f2 = get_tv_number(&var2);
4357 n1 = FALSE;
4358 switch (type)
4360 case TYPE_EQUAL: n1 = (f1 == f2); break;
4361 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4362 case TYPE_GREATER: n1 = (f1 > f2); break;
4363 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4364 case TYPE_SMALLER: n1 = (f1 < f2); break;
4365 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4366 case TYPE_UNKNOWN:
4367 case TYPE_MATCH:
4368 case TYPE_NOMATCH: break; /* avoid gcc warning */
4371 #endif
4374 * If one of the two variables is a number, compare as a number.
4375 * When using "=~" or "!~", always compare as string.
4377 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4378 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4380 n1 = get_tv_number(rettv);
4381 n2 = get_tv_number(&var2);
4382 switch (type)
4384 case TYPE_EQUAL: n1 = (n1 == n2); break;
4385 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4386 case TYPE_GREATER: n1 = (n1 > n2); break;
4387 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4388 case TYPE_SMALLER: n1 = (n1 < n2); break;
4389 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4390 case TYPE_UNKNOWN:
4391 case TYPE_MATCH:
4392 case TYPE_NOMATCH: break; /* avoid gcc warning */
4395 else
4397 s1 = get_tv_string_buf(rettv, buf1);
4398 s2 = get_tv_string_buf(&var2, buf2);
4399 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4400 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4401 else
4402 i = 0;
4403 n1 = FALSE;
4404 switch (type)
4406 case TYPE_EQUAL: n1 = (i == 0); break;
4407 case TYPE_NEQUAL: n1 = (i != 0); break;
4408 case TYPE_GREATER: n1 = (i > 0); break;
4409 case TYPE_GEQUAL: n1 = (i >= 0); break;
4410 case TYPE_SMALLER: n1 = (i < 0); break;
4411 case TYPE_SEQUAL: n1 = (i <= 0); break;
4413 case TYPE_MATCH:
4414 case TYPE_NOMATCH:
4415 /* avoid 'l' flag in 'cpoptions' */
4416 save_cpo = p_cpo;
4417 p_cpo = (char_u *)"";
4418 regmatch.regprog = vim_regcomp(s2,
4419 RE_MAGIC + RE_STRING);
4420 regmatch.rm_ic = ic;
4421 if (regmatch.regprog != NULL)
4423 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4424 vim_free(regmatch.regprog);
4425 if (type == TYPE_NOMATCH)
4426 n1 = !n1;
4428 p_cpo = save_cpo;
4429 break;
4431 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4434 clear_tv(rettv);
4435 clear_tv(&var2);
4436 rettv->v_type = VAR_NUMBER;
4437 rettv->vval.v_number = n1;
4441 return OK;
4445 * Handle fourth level expression:
4446 * + number addition
4447 * - number subtraction
4448 * . string concatenation
4450 * "arg" must point to the first non-white of the expression.
4451 * "arg" is advanced to the next non-white after the recognized expression.
4453 * Return OK or FAIL.
4455 static int
4456 eval5(arg, rettv, evaluate)
4457 char_u **arg;
4458 typval_T *rettv;
4459 int evaluate;
4461 typval_T var2;
4462 typval_T var3;
4463 int op;
4464 long n1, n2;
4465 #ifdef FEAT_FLOAT
4466 float_T f1 = 0, f2 = 0;
4467 #endif
4468 char_u *s1, *s2;
4469 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4470 char_u *p;
4473 * Get the first variable.
4475 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4476 return FAIL;
4479 * Repeat computing, until no '+', '-' or '.' is following.
4481 for (;;)
4483 op = **arg;
4484 if (op != '+' && op != '-' && op != '.')
4485 break;
4487 if ((op != '+' || rettv->v_type != VAR_LIST)
4488 #ifdef FEAT_FLOAT
4489 && (op == '.' || rettv->v_type != VAR_FLOAT)
4490 #endif
4493 /* For "list + ...", an illegal use of the first operand as
4494 * a number cannot be determined before evaluating the 2nd
4495 * operand: if this is also a list, all is ok.
4496 * For "something . ...", "something - ..." or "non-list + ...",
4497 * we know that the first operand needs to be a string or number
4498 * without evaluating the 2nd operand. So check before to avoid
4499 * side effects after an error. */
4500 if (evaluate && get_tv_string_chk(rettv) == NULL)
4502 clear_tv(rettv);
4503 return FAIL;
4508 * Get the second variable.
4510 *arg = skipwhite(*arg + 1);
4511 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4513 clear_tv(rettv);
4514 return FAIL;
4517 if (evaluate)
4520 * Compute the result.
4522 if (op == '.')
4524 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4525 s2 = get_tv_string_buf_chk(&var2, buf2);
4526 if (s2 == NULL) /* type error ? */
4528 clear_tv(rettv);
4529 clear_tv(&var2);
4530 return FAIL;
4532 p = concat_str(s1, s2);
4533 clear_tv(rettv);
4534 rettv->v_type = VAR_STRING;
4535 rettv->vval.v_string = p;
4537 else if (op == '+' && rettv->v_type == VAR_LIST
4538 && var2.v_type == VAR_LIST)
4540 /* concatenate Lists */
4541 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4542 &var3) == FAIL)
4544 clear_tv(rettv);
4545 clear_tv(&var2);
4546 return FAIL;
4548 clear_tv(rettv);
4549 *rettv = var3;
4551 else
4553 int error = FALSE;
4555 #ifdef FEAT_FLOAT
4556 if (rettv->v_type == VAR_FLOAT)
4558 f1 = rettv->vval.v_float;
4559 n1 = 0;
4561 else
4562 #endif
4564 n1 = get_tv_number_chk(rettv, &error);
4565 if (error)
4567 /* This can only happen for "list + non-list". For
4568 * "non-list + ..." or "something - ...", we returned
4569 * before evaluating the 2nd operand. */
4570 clear_tv(rettv);
4571 return FAIL;
4573 #ifdef FEAT_FLOAT
4574 if (var2.v_type == VAR_FLOAT)
4575 f1 = n1;
4576 #endif
4578 #ifdef FEAT_FLOAT
4579 if (var2.v_type == VAR_FLOAT)
4581 f2 = var2.vval.v_float;
4582 n2 = 0;
4584 else
4585 #endif
4587 n2 = get_tv_number_chk(&var2, &error);
4588 if (error)
4590 clear_tv(rettv);
4591 clear_tv(&var2);
4592 return FAIL;
4594 #ifdef FEAT_FLOAT
4595 if (rettv->v_type == VAR_FLOAT)
4596 f2 = n2;
4597 #endif
4599 clear_tv(rettv);
4601 #ifdef FEAT_FLOAT
4602 /* If there is a float on either side the result is a float. */
4603 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4605 if (op == '+')
4606 f1 = f1 + f2;
4607 else
4608 f1 = f1 - f2;
4609 rettv->v_type = VAR_FLOAT;
4610 rettv->vval.v_float = f1;
4612 else
4613 #endif
4615 if (op == '+')
4616 n1 = n1 + n2;
4617 else
4618 n1 = n1 - n2;
4619 rettv->v_type = VAR_NUMBER;
4620 rettv->vval.v_number = n1;
4623 clear_tv(&var2);
4626 return OK;
4630 * Handle fifth level expression:
4631 * * number multiplication
4632 * / number division
4633 * % number modulo
4635 * "arg" must point to the first non-white of the expression.
4636 * "arg" is advanced to the next non-white after the recognized expression.
4638 * Return OK or FAIL.
4640 static int
4641 eval6(arg, rettv, evaluate, want_string)
4642 char_u **arg;
4643 typval_T *rettv;
4644 int evaluate;
4645 int want_string; /* after "." operator */
4647 typval_T var2;
4648 int op;
4649 long n1, n2;
4650 #ifdef FEAT_FLOAT
4651 int use_float = FALSE;
4652 float_T f1 = 0, f2;
4653 #endif
4654 int error = FALSE;
4657 * Get the first variable.
4659 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4660 return FAIL;
4663 * Repeat computing, until no '*', '/' or '%' is following.
4665 for (;;)
4667 op = **arg;
4668 if (op != '*' && op != '/' && op != '%')
4669 break;
4671 if (evaluate)
4673 #ifdef FEAT_FLOAT
4674 if (rettv->v_type == VAR_FLOAT)
4676 f1 = rettv->vval.v_float;
4677 use_float = TRUE;
4678 n1 = 0;
4680 else
4681 #endif
4682 n1 = get_tv_number_chk(rettv, &error);
4683 clear_tv(rettv);
4684 if (error)
4685 return FAIL;
4687 else
4688 n1 = 0;
4691 * Get the second variable.
4693 *arg = skipwhite(*arg + 1);
4694 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4695 return FAIL;
4697 if (evaluate)
4699 #ifdef FEAT_FLOAT
4700 if (var2.v_type == VAR_FLOAT)
4702 if (!use_float)
4704 f1 = n1;
4705 use_float = TRUE;
4707 f2 = var2.vval.v_float;
4708 n2 = 0;
4710 else
4711 #endif
4713 n2 = get_tv_number_chk(&var2, &error);
4714 clear_tv(&var2);
4715 if (error)
4716 return FAIL;
4717 #ifdef FEAT_FLOAT
4718 if (use_float)
4719 f2 = n2;
4720 #endif
4724 * Compute the result.
4725 * When either side is a float the result is a float.
4727 #ifdef FEAT_FLOAT
4728 if (use_float)
4730 if (op == '*')
4731 f1 = f1 * f2;
4732 else if (op == '/')
4734 /* We rely on the floating point library to handle divide
4735 * by zero to result in "inf" and not a crash. */
4736 f1 = f1 / f2;
4738 else
4740 EMSG(_("E804: Cannot use '%' with Float"));
4741 return FAIL;
4743 rettv->v_type = VAR_FLOAT;
4744 rettv->vval.v_float = f1;
4746 else
4747 #endif
4749 if (op == '*')
4750 n1 = n1 * n2;
4751 else if (op == '/')
4753 if (n2 == 0) /* give an error message? */
4755 if (n1 == 0)
4756 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4757 else if (n1 < 0)
4758 n1 = -0x7fffffffL;
4759 else
4760 n1 = 0x7fffffffL;
4762 else
4763 n1 = n1 / n2;
4765 else
4767 if (n2 == 0) /* give an error message? */
4768 n1 = 0;
4769 else
4770 n1 = n1 % n2;
4772 rettv->v_type = VAR_NUMBER;
4773 rettv->vval.v_number = n1;
4778 return OK;
4782 * Handle sixth level expression:
4783 * number number constant
4784 * "string" string constant
4785 * 'string' literal string constant
4786 * &option-name option value
4787 * @r register contents
4788 * identifier variable value
4789 * function() function call
4790 * $VAR environment variable
4791 * (expression) nested expression
4792 * [expr, expr] List
4793 * {key: val, key: val} Dictionary
4795 * Also handle:
4796 * ! in front logical NOT
4797 * - in front unary minus
4798 * + in front unary plus (ignored)
4799 * trailing [] subscript in String or List
4800 * trailing .name entry in Dictionary
4802 * "arg" must point to the first non-white of the expression.
4803 * "arg" is advanced to the next non-white after the recognized expression.
4805 * Return OK or FAIL.
4807 static int
4808 eval7(arg, rettv, evaluate, want_string)
4809 char_u **arg;
4810 typval_T *rettv;
4811 int evaluate;
4812 int want_string; /* after "." operator */
4814 long n;
4815 int len;
4816 char_u *s;
4817 char_u *start_leader, *end_leader;
4818 int ret = OK;
4819 char_u *alias;
4822 * Initialise variable so that clear_tv() can't mistake this for a
4823 * string and free a string that isn't there.
4825 rettv->v_type = VAR_UNKNOWN;
4828 * Skip '!' and '-' characters. They are handled later.
4830 start_leader = *arg;
4831 while (**arg == '!' || **arg == '-' || **arg == '+')
4832 *arg = skipwhite(*arg + 1);
4833 end_leader = *arg;
4835 switch (**arg)
4838 * Number constant.
4840 case '0':
4841 case '1':
4842 case '2':
4843 case '3':
4844 case '4':
4845 case '5':
4846 case '6':
4847 case '7':
4848 case '8':
4849 case '9':
4851 #ifdef FEAT_FLOAT
4852 char_u *p = skipdigits(*arg + 1);
4853 int get_float = FALSE;
4855 /* We accept a float when the format matches
4856 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4857 * strict to avoid backwards compatibility problems.
4858 * Don't look for a float after the "." operator, so that
4859 * ":let vers = 1.2.3" doesn't fail. */
4860 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4862 get_float = TRUE;
4863 p = skipdigits(p + 2);
4864 if (*p == 'e' || *p == 'E')
4866 ++p;
4867 if (*p == '-' || *p == '+')
4868 ++p;
4869 if (!vim_isdigit(*p))
4870 get_float = FALSE;
4871 else
4872 p = skipdigits(p + 1);
4874 if (ASCII_ISALPHA(*p) || *p == '.')
4875 get_float = FALSE;
4877 if (get_float)
4879 float_T f;
4881 *arg += string2float(*arg, &f);
4882 if (evaluate)
4884 rettv->v_type = VAR_FLOAT;
4885 rettv->vval.v_float = f;
4888 else
4889 #endif
4891 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4892 *arg += len;
4893 if (evaluate)
4895 rettv->v_type = VAR_NUMBER;
4896 rettv->vval.v_number = n;
4899 break;
4903 * String constant: "string".
4905 case '"': ret = get_string_tv(arg, rettv, evaluate);
4906 break;
4909 * Literal string constant: 'str''ing'.
4911 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4912 break;
4915 * List: [expr, expr]
4917 case '[': ret = get_list_tv(arg, rettv, evaluate);
4918 break;
4921 * Dictionary: {key: val, key: val}
4923 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4924 break;
4927 * Option value: &name
4929 case '&': ret = get_option_tv(arg, rettv, evaluate);
4930 break;
4933 * Environment variable: $VAR.
4935 case '$': ret = get_env_tv(arg, rettv, evaluate);
4936 break;
4939 * Register contents: @r.
4941 case '@': ++*arg;
4942 if (evaluate)
4944 rettv->v_type = VAR_STRING;
4945 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4947 if (**arg != NUL)
4948 ++*arg;
4949 break;
4952 * nested expression: (expression).
4954 case '(': *arg = skipwhite(*arg + 1);
4955 ret = eval1(arg, rettv, evaluate); /* recursive! */
4956 if (**arg == ')')
4957 ++*arg;
4958 else if (ret == OK)
4960 EMSG(_("E110: Missing ')'"));
4961 clear_tv(rettv);
4962 ret = FAIL;
4964 break;
4966 default: ret = NOTDONE;
4967 break;
4970 if (ret == NOTDONE)
4973 * Must be a variable or function name.
4974 * Can also be a curly-braces kind of name: {expr}.
4976 s = *arg;
4977 len = get_name_len(arg, &alias, evaluate, TRUE);
4978 if (alias != NULL)
4979 s = alias;
4981 if (len <= 0)
4982 ret = FAIL;
4983 else
4985 if (**arg == '(') /* recursive! */
4987 /* If "s" is the name of a variable of type VAR_FUNC
4988 * use its contents. */
4989 s = deref_func_name(s, &len);
4991 /* Invoke the function. */
4992 ret = get_func_tv(s, len, rettv, arg,
4993 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
4994 &len, evaluate, NULL);
4995 /* Stop the expression evaluation when immediately
4996 * aborting on error, or when an interrupt occurred or
4997 * an exception was thrown but not caught. */
4998 if (aborting())
5000 if (ret == OK)
5001 clear_tv(rettv);
5002 ret = FAIL;
5005 else if (evaluate)
5006 ret = get_var_tv(s, len, rettv, TRUE);
5007 else
5008 ret = OK;
5011 if (alias != NULL)
5012 vim_free(alias);
5015 *arg = skipwhite(*arg);
5017 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5018 * expr(expr). */
5019 if (ret == OK)
5020 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5023 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5025 if (ret == OK && evaluate && end_leader > start_leader)
5027 int error = FALSE;
5028 int val = 0;
5029 #ifdef FEAT_FLOAT
5030 float_T f = 0.0;
5032 if (rettv->v_type == VAR_FLOAT)
5033 f = rettv->vval.v_float;
5034 else
5035 #endif
5036 val = get_tv_number_chk(rettv, &error);
5037 if (error)
5039 clear_tv(rettv);
5040 ret = FAIL;
5042 else
5044 while (end_leader > start_leader)
5046 --end_leader;
5047 if (*end_leader == '!')
5049 #ifdef FEAT_FLOAT
5050 if (rettv->v_type == VAR_FLOAT)
5051 f = !f;
5052 else
5053 #endif
5054 val = !val;
5056 else if (*end_leader == '-')
5058 #ifdef FEAT_FLOAT
5059 if (rettv->v_type == VAR_FLOAT)
5060 f = -f;
5061 else
5062 #endif
5063 val = -val;
5066 #ifdef FEAT_FLOAT
5067 if (rettv->v_type == VAR_FLOAT)
5069 clear_tv(rettv);
5070 rettv->vval.v_float = f;
5072 else
5073 #endif
5075 clear_tv(rettv);
5076 rettv->v_type = VAR_NUMBER;
5077 rettv->vval.v_number = val;
5082 return ret;
5086 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5087 * "*arg" points to the '[' or '.'.
5088 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5090 static int
5091 eval_index(arg, rettv, evaluate, verbose)
5092 char_u **arg;
5093 typval_T *rettv;
5094 int evaluate;
5095 int verbose; /* give error messages */
5097 int empty1 = FALSE, empty2 = FALSE;
5098 typval_T var1, var2;
5099 long n1, n2 = 0;
5100 long len = -1;
5101 int range = FALSE;
5102 char_u *s;
5103 char_u *key = NULL;
5105 if (rettv->v_type == VAR_FUNC
5106 #ifdef FEAT_FLOAT
5107 || rettv->v_type == VAR_FLOAT
5108 #endif
5111 if (verbose)
5112 EMSG(_("E695: Cannot index a Funcref"));
5113 return FAIL;
5116 if (**arg == '.')
5119 * dict.name
5121 key = *arg + 1;
5122 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5124 if (len == 0)
5125 return FAIL;
5126 *arg = skipwhite(key + len);
5128 else
5131 * something[idx]
5133 * Get the (first) variable from inside the [].
5135 *arg = skipwhite(*arg + 1);
5136 if (**arg == ':')
5137 empty1 = TRUE;
5138 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5139 return FAIL;
5140 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5142 /* not a number or string */
5143 clear_tv(&var1);
5144 return FAIL;
5148 * Get the second variable from inside the [:].
5150 if (**arg == ':')
5152 range = TRUE;
5153 *arg = skipwhite(*arg + 1);
5154 if (**arg == ']')
5155 empty2 = TRUE;
5156 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5158 if (!empty1)
5159 clear_tv(&var1);
5160 return FAIL;
5162 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5164 /* not a number or string */
5165 if (!empty1)
5166 clear_tv(&var1);
5167 clear_tv(&var2);
5168 return FAIL;
5172 /* Check for the ']'. */
5173 if (**arg != ']')
5175 if (verbose)
5176 EMSG(_(e_missbrac));
5177 clear_tv(&var1);
5178 if (range)
5179 clear_tv(&var2);
5180 return FAIL;
5182 *arg = skipwhite(*arg + 1); /* skip the ']' */
5185 if (evaluate)
5187 n1 = 0;
5188 if (!empty1 && rettv->v_type != VAR_DICT)
5190 n1 = get_tv_number(&var1);
5191 clear_tv(&var1);
5193 if (range)
5195 if (empty2)
5196 n2 = -1;
5197 else
5199 n2 = get_tv_number(&var2);
5200 clear_tv(&var2);
5204 switch (rettv->v_type)
5206 case VAR_NUMBER:
5207 case VAR_STRING:
5208 s = get_tv_string(rettv);
5209 len = (long)STRLEN(s);
5210 if (range)
5212 /* The resulting variable is a substring. If the indexes
5213 * are out of range the result is empty. */
5214 if (n1 < 0)
5216 n1 = len + n1;
5217 if (n1 < 0)
5218 n1 = 0;
5220 if (n2 < 0)
5221 n2 = len + n2;
5222 else if (n2 >= len)
5223 n2 = len;
5224 if (n1 >= len || n2 < 0 || n1 > n2)
5225 s = NULL;
5226 else
5227 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5229 else
5231 /* The resulting variable is a string of a single
5232 * character. If the index is too big or negative the
5233 * result is empty. */
5234 if (n1 >= len || n1 < 0)
5235 s = NULL;
5236 else
5237 s = vim_strnsave(s + n1, 1);
5239 clear_tv(rettv);
5240 rettv->v_type = VAR_STRING;
5241 rettv->vval.v_string = s;
5242 break;
5244 case VAR_LIST:
5245 len = list_len(rettv->vval.v_list);
5246 if (n1 < 0)
5247 n1 = len + n1;
5248 if (!empty1 && (n1 < 0 || n1 >= len))
5250 /* For a range we allow invalid values and return an empty
5251 * list. A list index out of range is an error. */
5252 if (!range)
5254 if (verbose)
5255 EMSGN(_(e_listidx), n1);
5256 return FAIL;
5258 n1 = len;
5260 if (range)
5262 list_T *l;
5263 listitem_T *item;
5265 if (n2 < 0)
5266 n2 = len + n2;
5267 else if (n2 >= len)
5268 n2 = len - 1;
5269 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5270 n2 = -1;
5271 l = list_alloc();
5272 if (l == NULL)
5273 return FAIL;
5274 for (item = list_find(rettv->vval.v_list, n1);
5275 n1 <= n2; ++n1)
5277 if (list_append_tv(l, &item->li_tv) == FAIL)
5279 list_free(l, TRUE);
5280 return FAIL;
5282 item = item->li_next;
5284 clear_tv(rettv);
5285 rettv->v_type = VAR_LIST;
5286 rettv->vval.v_list = l;
5287 ++l->lv_refcount;
5289 else
5291 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5292 clear_tv(rettv);
5293 *rettv = var1;
5295 break;
5297 case VAR_DICT:
5298 if (range)
5300 if (verbose)
5301 EMSG(_(e_dictrange));
5302 if (len == -1)
5303 clear_tv(&var1);
5304 return FAIL;
5307 dictitem_T *item;
5309 if (len == -1)
5311 key = get_tv_string(&var1);
5312 if (*key == NUL)
5314 if (verbose)
5315 EMSG(_(e_emptykey));
5316 clear_tv(&var1);
5317 return FAIL;
5321 item = dict_find(rettv->vval.v_dict, key, (int)len);
5323 if (item == NULL && verbose)
5324 EMSG2(_(e_dictkey), key);
5325 if (len == -1)
5326 clear_tv(&var1);
5327 if (item == NULL)
5328 return FAIL;
5330 copy_tv(&item->di_tv, &var1);
5331 clear_tv(rettv);
5332 *rettv = var1;
5334 break;
5338 return OK;
5342 * Get an option value.
5343 * "arg" points to the '&' or '+' before the option name.
5344 * "arg" is advanced to character after the option name.
5345 * Return OK or FAIL.
5347 static int
5348 get_option_tv(arg, rettv, evaluate)
5349 char_u **arg;
5350 typval_T *rettv; /* when NULL, only check if option exists */
5351 int evaluate;
5353 char_u *option_end;
5354 long numval;
5355 char_u *stringval;
5356 int opt_type;
5357 int c;
5358 int working = (**arg == '+'); /* has("+option") */
5359 int ret = OK;
5360 int opt_flags;
5363 * Isolate the option name and find its value.
5365 option_end = find_option_end(arg, &opt_flags);
5366 if (option_end == NULL)
5368 if (rettv != NULL)
5369 EMSG2(_("E112: Option name missing: %s"), *arg);
5370 return FAIL;
5373 if (!evaluate)
5375 *arg = option_end;
5376 return OK;
5379 c = *option_end;
5380 *option_end = NUL;
5381 opt_type = get_option_value(*arg, &numval,
5382 rettv == NULL ? NULL : &stringval, opt_flags);
5384 if (opt_type == -3) /* invalid name */
5386 if (rettv != NULL)
5387 EMSG2(_("E113: Unknown option: %s"), *arg);
5388 ret = FAIL;
5390 else if (rettv != NULL)
5392 if (opt_type == -2) /* hidden string option */
5394 rettv->v_type = VAR_STRING;
5395 rettv->vval.v_string = NULL;
5397 else if (opt_type == -1) /* hidden number option */
5399 rettv->v_type = VAR_NUMBER;
5400 rettv->vval.v_number = 0;
5402 else if (opt_type == 1) /* number option */
5404 rettv->v_type = VAR_NUMBER;
5405 rettv->vval.v_number = numval;
5407 else /* string option */
5409 rettv->v_type = VAR_STRING;
5410 rettv->vval.v_string = stringval;
5413 else if (working && (opt_type == -2 || opt_type == -1))
5414 ret = FAIL;
5416 *option_end = c; /* put back for error messages */
5417 *arg = option_end;
5419 return ret;
5423 * Allocate a variable for a string constant.
5424 * Return OK or FAIL.
5426 static int
5427 get_string_tv(arg, rettv, evaluate)
5428 char_u **arg;
5429 typval_T *rettv;
5430 int evaluate;
5432 char_u *p;
5433 char_u *name;
5434 int extra = 0;
5437 * Find the end of the string, skipping backslashed characters.
5439 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5441 if (*p == '\\' && p[1] != NUL)
5443 ++p;
5444 /* A "\<x>" form occupies at least 4 characters, and produces up
5445 * to 6 characters: reserve space for 2 extra */
5446 if (*p == '<')
5447 extra += 2;
5451 if (*p != '"')
5453 EMSG2(_("E114: Missing quote: %s"), *arg);
5454 return FAIL;
5457 /* If only parsing, set *arg and return here */
5458 if (!evaluate)
5460 *arg = p + 1;
5461 return OK;
5465 * Copy the string into allocated memory, handling backslashed
5466 * characters.
5468 name = alloc((unsigned)(p - *arg + extra));
5469 if (name == NULL)
5470 return FAIL;
5471 rettv->v_type = VAR_STRING;
5472 rettv->vval.v_string = name;
5474 for (p = *arg + 1; *p != NUL && *p != '"'; )
5476 if (*p == '\\')
5478 switch (*++p)
5480 case 'b': *name++ = BS; ++p; break;
5481 case 'e': *name++ = ESC; ++p; break;
5482 case 'f': *name++ = FF; ++p; break;
5483 case 'n': *name++ = NL; ++p; break;
5484 case 'r': *name++ = CAR; ++p; break;
5485 case 't': *name++ = TAB; ++p; break;
5487 case 'X': /* hex: "\x1", "\x12" */
5488 case 'x':
5489 case 'u': /* Unicode: "\u0023" */
5490 case 'U':
5491 if (vim_isxdigit(p[1]))
5493 int n, nr;
5494 int c = toupper(*p);
5496 if (c == 'X')
5497 n = 2;
5498 else
5499 n = 4;
5500 nr = 0;
5501 while (--n >= 0 && vim_isxdigit(p[1]))
5503 ++p;
5504 nr = (nr << 4) + hex2nr(*p);
5506 ++p;
5507 #ifdef FEAT_MBYTE
5508 /* For "\u" store the number according to
5509 * 'encoding'. */
5510 if (c != 'X')
5511 name += (*mb_char2bytes)(nr, name);
5512 else
5513 #endif
5514 *name++ = nr;
5516 break;
5518 /* octal: "\1", "\12", "\123" */
5519 case '0':
5520 case '1':
5521 case '2':
5522 case '3':
5523 case '4':
5524 case '5':
5525 case '6':
5526 case '7': *name = *p++ - '0';
5527 if (*p >= '0' && *p <= '7')
5529 *name = (*name << 3) + *p++ - '0';
5530 if (*p >= '0' && *p <= '7')
5531 *name = (*name << 3) + *p++ - '0';
5533 ++name;
5534 break;
5536 /* Special key, e.g.: "\<C-W>" */
5537 case '<': extra = trans_special(&p, name, TRUE);
5538 if (extra != 0)
5540 name += extra;
5541 break;
5543 /* FALLTHROUGH */
5545 default: MB_COPY_CHAR(p, name);
5546 break;
5549 else
5550 MB_COPY_CHAR(p, name);
5553 *name = NUL;
5554 *arg = p + 1;
5556 return OK;
5560 * Allocate a variable for a 'str''ing' constant.
5561 * Return OK or FAIL.
5563 static int
5564 get_lit_string_tv(arg, rettv, evaluate)
5565 char_u **arg;
5566 typval_T *rettv;
5567 int evaluate;
5569 char_u *p;
5570 char_u *str;
5571 int reduce = 0;
5574 * Find the end of the string, skipping ''.
5576 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5578 if (*p == '\'')
5580 if (p[1] != '\'')
5581 break;
5582 ++reduce;
5583 ++p;
5587 if (*p != '\'')
5589 EMSG2(_("E115: Missing quote: %s"), *arg);
5590 return FAIL;
5593 /* If only parsing return after setting "*arg" */
5594 if (!evaluate)
5596 *arg = p + 1;
5597 return OK;
5601 * Copy the string into allocated memory, handling '' to ' reduction.
5603 str = alloc((unsigned)((p - *arg) - reduce));
5604 if (str == NULL)
5605 return FAIL;
5606 rettv->v_type = VAR_STRING;
5607 rettv->vval.v_string = str;
5609 for (p = *arg + 1; *p != NUL; )
5611 if (*p == '\'')
5613 if (p[1] != '\'')
5614 break;
5615 ++p;
5617 MB_COPY_CHAR(p, str);
5619 *str = NUL;
5620 *arg = p + 1;
5622 return OK;
5626 * Allocate a variable for a List and fill it from "*arg".
5627 * Return OK or FAIL.
5629 static int
5630 get_list_tv(arg, rettv, evaluate)
5631 char_u **arg;
5632 typval_T *rettv;
5633 int evaluate;
5635 list_T *l = NULL;
5636 typval_T tv;
5637 listitem_T *item;
5639 if (evaluate)
5641 l = list_alloc();
5642 if (l == NULL)
5643 return FAIL;
5646 *arg = skipwhite(*arg + 1);
5647 while (**arg != ']' && **arg != NUL)
5649 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5650 goto failret;
5651 if (evaluate)
5653 item = listitem_alloc();
5654 if (item != NULL)
5656 item->li_tv = tv;
5657 item->li_tv.v_lock = 0;
5658 list_append(l, item);
5660 else
5661 clear_tv(&tv);
5664 if (**arg == ']')
5665 break;
5666 if (**arg != ',')
5668 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5669 goto failret;
5671 *arg = skipwhite(*arg + 1);
5674 if (**arg != ']')
5676 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5677 failret:
5678 if (evaluate)
5679 list_free(l, TRUE);
5680 return FAIL;
5683 *arg = skipwhite(*arg + 1);
5684 if (evaluate)
5686 rettv->v_type = VAR_LIST;
5687 rettv->vval.v_list = l;
5688 ++l->lv_refcount;
5691 return OK;
5695 * Allocate an empty header for a list.
5696 * Caller should take care of the reference count.
5698 list_T *
5699 list_alloc()
5701 list_T *l;
5703 l = (list_T *)alloc_clear(sizeof(list_T));
5704 if (l != NULL)
5706 /* Prepend the list to the list of lists for garbage collection. */
5707 if (first_list != NULL)
5708 first_list->lv_used_prev = l;
5709 l->lv_used_prev = NULL;
5710 l->lv_used_next = first_list;
5711 first_list = l;
5713 return l;
5717 * Allocate an empty list for a return value.
5718 * Returns OK or FAIL.
5720 static int
5721 rettv_list_alloc(rettv)
5722 typval_T *rettv;
5724 list_T *l = list_alloc();
5726 if (l == NULL)
5727 return FAIL;
5729 rettv->vval.v_list = l;
5730 rettv->v_type = VAR_LIST;
5731 ++l->lv_refcount;
5732 return OK;
5736 * Unreference a list: decrement the reference count and free it when it
5737 * becomes zero.
5739 void
5740 list_unref(l)
5741 list_T *l;
5743 if (l != NULL && --l->lv_refcount <= 0)
5744 list_free(l, TRUE);
5748 * Free a list, including all items it points to.
5749 * Ignores the reference count.
5751 void
5752 list_free(l, recurse)
5753 list_T *l;
5754 int recurse; /* Free Lists and Dictionaries recursively. */
5756 listitem_T *item;
5758 /* Remove the list from the list of lists for garbage collection. */
5759 if (l->lv_used_prev == NULL)
5760 first_list = l->lv_used_next;
5761 else
5762 l->lv_used_prev->lv_used_next = l->lv_used_next;
5763 if (l->lv_used_next != NULL)
5764 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5766 for (item = l->lv_first; item != NULL; item = l->lv_first)
5768 /* Remove the item before deleting it. */
5769 l->lv_first = item->li_next;
5770 if (recurse || (item->li_tv.v_type != VAR_LIST
5771 && item->li_tv.v_type != VAR_DICT))
5772 clear_tv(&item->li_tv);
5773 vim_free(item);
5775 vim_free(l);
5779 * Allocate a list item.
5781 static listitem_T *
5782 listitem_alloc()
5784 return (listitem_T *)alloc(sizeof(listitem_T));
5788 * Free a list item. Also clears the value. Does not notify watchers.
5790 static void
5791 listitem_free(item)
5792 listitem_T *item;
5794 clear_tv(&item->li_tv);
5795 vim_free(item);
5799 * Remove a list item from a List and free it. Also clears the value.
5801 static void
5802 listitem_remove(l, item)
5803 list_T *l;
5804 listitem_T *item;
5806 list_remove(l, item, item);
5807 listitem_free(item);
5811 * Get the number of items in a list.
5813 static long
5814 list_len(l)
5815 list_T *l;
5817 if (l == NULL)
5818 return 0L;
5819 return l->lv_len;
5823 * Return TRUE when two lists have exactly the same values.
5825 static int
5826 list_equal(l1, l2, ic)
5827 list_T *l1;
5828 list_T *l2;
5829 int ic; /* ignore case for strings */
5831 listitem_T *item1, *item2;
5833 if (l1 == NULL || l2 == NULL)
5834 return FALSE;
5835 if (l1 == l2)
5836 return TRUE;
5837 if (list_len(l1) != list_len(l2))
5838 return FALSE;
5840 for (item1 = l1->lv_first, item2 = l2->lv_first;
5841 item1 != NULL && item2 != NULL;
5842 item1 = item1->li_next, item2 = item2->li_next)
5843 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5844 return FALSE;
5845 return item1 == NULL && item2 == NULL;
5848 #if defined(FEAT_PYTHON) || defined(PROTO) || defined(FEAT_GUI_MACVIM)
5850 * Return the dictitem that an entry in a hashtable points to.
5852 dictitem_T *
5853 dict_lookup(hi)
5854 hashitem_T *hi;
5856 return HI2DI(hi);
5858 #endif
5861 * Return TRUE when two dictionaries have exactly the same key/values.
5863 static int
5864 dict_equal(d1, d2, ic)
5865 dict_T *d1;
5866 dict_T *d2;
5867 int ic; /* ignore case for strings */
5869 hashitem_T *hi;
5870 dictitem_T *item2;
5871 int todo;
5873 if (d1 == NULL || d2 == NULL)
5874 return FALSE;
5875 if (d1 == d2)
5876 return TRUE;
5877 if (dict_len(d1) != dict_len(d2))
5878 return FALSE;
5880 todo = (int)d1->dv_hashtab.ht_used;
5881 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5883 if (!HASHITEM_EMPTY(hi))
5885 item2 = dict_find(d2, hi->hi_key, -1);
5886 if (item2 == NULL)
5887 return FALSE;
5888 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5889 return FALSE;
5890 --todo;
5893 return TRUE;
5897 * Return TRUE if "tv1" and "tv2" have the same value.
5898 * Compares the items just like "==" would compare them, but strings and
5899 * numbers are different. Floats and numbers are also different.
5901 static int
5902 tv_equal(tv1, tv2, ic)
5903 typval_T *tv1;
5904 typval_T *tv2;
5905 int ic; /* ignore case */
5907 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5908 char_u *s1, *s2;
5909 static int recursive = 0; /* cach recursive loops */
5910 int r;
5912 if (tv1->v_type != tv2->v_type)
5913 return FALSE;
5914 /* Catch lists and dicts that have an endless loop by limiting
5915 * recursiveness to 1000. We guess they are equal then. */
5916 if (recursive >= 1000)
5917 return TRUE;
5919 switch (tv1->v_type)
5921 case VAR_LIST:
5922 ++recursive;
5923 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5924 --recursive;
5925 return r;
5927 case VAR_DICT:
5928 ++recursive;
5929 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5930 --recursive;
5931 return r;
5933 case VAR_FUNC:
5934 return (tv1->vval.v_string != NULL
5935 && tv2->vval.v_string != NULL
5936 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5938 case VAR_NUMBER:
5939 return tv1->vval.v_number == tv2->vval.v_number;
5941 #ifdef FEAT_FLOAT
5942 case VAR_FLOAT:
5943 return tv1->vval.v_float == tv2->vval.v_float;
5944 #endif
5946 case VAR_STRING:
5947 s1 = get_tv_string_buf(tv1, buf1);
5948 s2 = get_tv_string_buf(tv2, buf2);
5949 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5952 EMSG2(_(e_intern2), "tv_equal()");
5953 return TRUE;
5957 * Locate item with index "n" in list "l" and return it.
5958 * A negative index is counted from the end; -1 is the last item.
5959 * Returns NULL when "n" is out of range.
5961 static listitem_T *
5962 list_find(l, n)
5963 list_T *l;
5964 long n;
5966 listitem_T *item;
5967 long idx;
5969 if (l == NULL)
5970 return NULL;
5972 /* Negative index is relative to the end. */
5973 if (n < 0)
5974 n = l->lv_len + n;
5976 /* Check for index out of range. */
5977 if (n < 0 || n >= l->lv_len)
5978 return NULL;
5980 /* When there is a cached index may start search from there. */
5981 if (l->lv_idx_item != NULL)
5983 if (n < l->lv_idx / 2)
5985 /* closest to the start of the list */
5986 item = l->lv_first;
5987 idx = 0;
5989 else if (n > (l->lv_idx + l->lv_len) / 2)
5991 /* closest to the end of the list */
5992 item = l->lv_last;
5993 idx = l->lv_len - 1;
5995 else
5997 /* closest to the cached index */
5998 item = l->lv_idx_item;
5999 idx = l->lv_idx;
6002 else
6004 if (n < l->lv_len / 2)
6006 /* closest to the start of the list */
6007 item = l->lv_first;
6008 idx = 0;
6010 else
6012 /* closest to the end of the list */
6013 item = l->lv_last;
6014 idx = l->lv_len - 1;
6018 while (n > idx)
6020 /* search forward */
6021 item = item->li_next;
6022 ++idx;
6024 while (n < idx)
6026 /* search backward */
6027 item = item->li_prev;
6028 --idx;
6031 /* cache the used index */
6032 l->lv_idx = idx;
6033 l->lv_idx_item = item;
6035 return item;
6039 * Get list item "l[idx]" as a number.
6041 static long
6042 list_find_nr(l, idx, errorp)
6043 list_T *l;
6044 long idx;
6045 int *errorp; /* set to TRUE when something wrong */
6047 listitem_T *li;
6049 li = list_find(l, idx);
6050 if (li == NULL)
6052 if (errorp != NULL)
6053 *errorp = TRUE;
6054 return -1L;
6056 return get_tv_number_chk(&li->li_tv, errorp);
6060 * Locate "item" list "l" and return its index.
6061 * Returns -1 when "item" is not in the list.
6063 static long
6064 list_idx_of_item(l, item)
6065 list_T *l;
6066 listitem_T *item;
6068 long idx = 0;
6069 listitem_T *li;
6071 if (l == NULL)
6072 return -1;
6073 idx = 0;
6074 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6075 ++idx;
6076 if (li == NULL)
6077 return -1;
6078 return idx;
6082 * Append item "item" to the end of list "l".
6084 static void
6085 list_append(l, item)
6086 list_T *l;
6087 listitem_T *item;
6089 if (l->lv_last == NULL)
6091 /* empty list */
6092 l->lv_first = item;
6093 l->lv_last = item;
6094 item->li_prev = NULL;
6096 else
6098 l->lv_last->li_next = item;
6099 item->li_prev = l->lv_last;
6100 l->lv_last = item;
6102 ++l->lv_len;
6103 item->li_next = NULL;
6107 * Append typval_T "tv" to the end of list "l".
6108 * Return FAIL when out of memory.
6110 static int
6111 list_append_tv(l, tv)
6112 list_T *l;
6113 typval_T *tv;
6115 listitem_T *li = listitem_alloc();
6117 if (li == NULL)
6118 return FAIL;
6119 copy_tv(tv, &li->li_tv);
6120 list_append(l, li);
6121 return OK;
6125 * Add a dictionary to a list. Used by getqflist().
6126 * Return FAIL when out of memory.
6129 list_append_dict(list, dict)
6130 list_T *list;
6131 dict_T *dict;
6133 listitem_T *li = listitem_alloc();
6135 if (li == NULL)
6136 return FAIL;
6137 li->li_tv.v_type = VAR_DICT;
6138 li->li_tv.v_lock = 0;
6139 li->li_tv.vval.v_dict = dict;
6140 list_append(list, li);
6141 ++dict->dv_refcount;
6142 return OK;
6146 * Make a copy of "str" and append it as an item to list "l".
6147 * When "len" >= 0 use "str[len]".
6148 * Returns FAIL when out of memory.
6150 static int
6151 list_append_string(l, str, len)
6152 list_T *l;
6153 char_u *str;
6154 int len;
6156 listitem_T *li = listitem_alloc();
6158 if (li == NULL)
6159 return FAIL;
6160 list_append(l, li);
6161 li->li_tv.v_type = VAR_STRING;
6162 li->li_tv.v_lock = 0;
6163 if (str == NULL)
6164 li->li_tv.vval.v_string = NULL;
6165 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6166 : vim_strsave(str))) == NULL)
6167 return FAIL;
6168 return OK;
6172 * Append "n" to list "l".
6173 * Returns FAIL when out of memory.
6175 static int
6176 list_append_number(l, n)
6177 list_T *l;
6178 varnumber_T n;
6180 listitem_T *li;
6182 li = listitem_alloc();
6183 if (li == NULL)
6184 return FAIL;
6185 li->li_tv.v_type = VAR_NUMBER;
6186 li->li_tv.v_lock = 0;
6187 li->li_tv.vval.v_number = n;
6188 list_append(l, li);
6189 return OK;
6193 * Insert typval_T "tv" in list "l" before "item".
6194 * If "item" is NULL append at the end.
6195 * Return FAIL when out of memory.
6197 static int
6198 list_insert_tv(l, tv, item)
6199 list_T *l;
6200 typval_T *tv;
6201 listitem_T *item;
6203 listitem_T *ni = listitem_alloc();
6205 if (ni == NULL)
6206 return FAIL;
6207 copy_tv(tv, &ni->li_tv);
6208 if (item == NULL)
6209 /* Append new item at end of list. */
6210 list_append(l, ni);
6211 else
6213 /* Insert new item before existing item. */
6214 ni->li_prev = item->li_prev;
6215 ni->li_next = item;
6216 if (item->li_prev == NULL)
6218 l->lv_first = ni;
6219 ++l->lv_idx;
6221 else
6223 item->li_prev->li_next = ni;
6224 l->lv_idx_item = NULL;
6226 item->li_prev = ni;
6227 ++l->lv_len;
6229 return OK;
6233 * Extend "l1" with "l2".
6234 * If "bef" is NULL append at the end, otherwise insert before this item.
6235 * Returns FAIL when out of memory.
6237 static int
6238 list_extend(l1, l2, bef)
6239 list_T *l1;
6240 list_T *l2;
6241 listitem_T *bef;
6243 listitem_T *item;
6244 int todo = l2->lv_len;
6246 /* We also quit the loop when we have inserted the original item count of
6247 * the list, avoid a hang when we extend a list with itself. */
6248 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6249 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6250 return FAIL;
6251 return OK;
6255 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6256 * Return FAIL when out of memory.
6258 static int
6259 list_concat(l1, l2, tv)
6260 list_T *l1;
6261 list_T *l2;
6262 typval_T *tv;
6264 list_T *l;
6266 if (l1 == NULL || l2 == NULL)
6267 return FAIL;
6269 /* make a copy of the first list. */
6270 l = list_copy(l1, FALSE, 0);
6271 if (l == NULL)
6272 return FAIL;
6273 tv->v_type = VAR_LIST;
6274 tv->vval.v_list = l;
6276 /* append all items from the second list */
6277 return list_extend(l, l2, NULL);
6281 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6282 * The refcount of the new list is set to 1.
6283 * See item_copy() for "copyID".
6284 * Returns NULL when out of memory.
6286 static list_T *
6287 list_copy(orig, deep, copyID)
6288 list_T *orig;
6289 int deep;
6290 int copyID;
6292 list_T *copy;
6293 listitem_T *item;
6294 listitem_T *ni;
6296 if (orig == NULL)
6297 return NULL;
6299 copy = list_alloc();
6300 if (copy != NULL)
6302 if (copyID != 0)
6304 /* Do this before adding the items, because one of the items may
6305 * refer back to this list. */
6306 orig->lv_copyID = copyID;
6307 orig->lv_copylist = copy;
6309 for (item = orig->lv_first; item != NULL && !got_int;
6310 item = item->li_next)
6312 ni = listitem_alloc();
6313 if (ni == NULL)
6314 break;
6315 if (deep)
6317 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6319 vim_free(ni);
6320 break;
6323 else
6324 copy_tv(&item->li_tv, &ni->li_tv);
6325 list_append(copy, ni);
6327 ++copy->lv_refcount;
6328 if (item != NULL)
6330 list_unref(copy);
6331 copy = NULL;
6335 return copy;
6339 * Remove items "item" to "item2" from list "l".
6340 * Does not free the listitem or the value!
6342 static void
6343 list_remove(l, item, item2)
6344 list_T *l;
6345 listitem_T *item;
6346 listitem_T *item2;
6348 listitem_T *ip;
6350 /* notify watchers */
6351 for (ip = item; ip != NULL; ip = ip->li_next)
6353 --l->lv_len;
6354 list_fix_watch(l, ip);
6355 if (ip == item2)
6356 break;
6359 if (item2->li_next == NULL)
6360 l->lv_last = item->li_prev;
6361 else
6362 item2->li_next->li_prev = item->li_prev;
6363 if (item->li_prev == NULL)
6364 l->lv_first = item2->li_next;
6365 else
6366 item->li_prev->li_next = item2->li_next;
6367 l->lv_idx_item = NULL;
6371 * Return an allocated string with the string representation of a list.
6372 * May return NULL.
6374 static char_u *
6375 list2string(tv, copyID)
6376 typval_T *tv;
6377 int copyID;
6379 garray_T ga;
6381 if (tv->vval.v_list == NULL)
6382 return NULL;
6383 ga_init2(&ga, (int)sizeof(char), 80);
6384 ga_append(&ga, '[');
6385 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6387 vim_free(ga.ga_data);
6388 return NULL;
6390 ga_append(&ga, ']');
6391 ga_append(&ga, NUL);
6392 return (char_u *)ga.ga_data;
6396 * Join list "l" into a string in "*gap", using separator "sep".
6397 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6398 * Return FAIL or OK.
6400 static int
6401 list_join(gap, l, sep, echo, copyID)
6402 garray_T *gap;
6403 list_T *l;
6404 char_u *sep;
6405 int echo;
6406 int copyID;
6408 int first = TRUE;
6409 char_u *tofree;
6410 char_u numbuf[NUMBUFLEN];
6411 listitem_T *item;
6412 char_u *s;
6414 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6416 if (first)
6417 first = FALSE;
6418 else
6419 ga_concat(gap, sep);
6421 if (echo)
6422 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6423 else
6424 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6425 if (s != NULL)
6426 ga_concat(gap, s);
6427 vim_free(tofree);
6428 if (s == NULL)
6429 return FAIL;
6431 return OK;
6435 * Garbage collection for lists and dictionaries.
6437 * We use reference counts to be able to free most items right away when they
6438 * are no longer used. But for composite items it's possible that it becomes
6439 * unused while the reference count is > 0: When there is a recursive
6440 * reference. Example:
6441 * :let l = [1, 2, 3]
6442 * :let d = {9: l}
6443 * :let l[1] = d
6445 * Since this is quite unusual we handle this with garbage collection: every
6446 * once in a while find out which lists and dicts are not referenced from any
6447 * variable.
6449 * Here is a good reference text about garbage collection (refers to Python
6450 * but it applies to all reference-counting mechanisms):
6451 * http://python.ca/nas/python/gc/
6455 * Do garbage collection for lists and dicts.
6456 * Return TRUE if some memory was freed.
6459 garbage_collect()
6461 dict_T *dd;
6462 list_T *ll;
6463 int copyID = ++current_copyID;
6464 buf_T *buf;
6465 win_T *wp;
6466 int i;
6467 funccall_T *fc;
6468 int did_free = FALSE;
6469 #ifdef FEAT_WINDOWS
6470 tabpage_T *tp;
6471 #endif
6473 /* Only do this once. */
6474 want_garbage_collect = FALSE;
6475 may_garbage_collect = FALSE;
6476 garbage_collect_at_exit = FALSE;
6479 * 1. Go through all accessible variables and mark all lists and dicts
6480 * with copyID.
6482 /* script-local variables */
6483 for (i = 1; i <= ga_scripts.ga_len; ++i)
6484 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6486 /* buffer-local variables */
6487 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6488 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6490 /* window-local variables */
6491 FOR_ALL_TAB_WINDOWS(tp, wp)
6492 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6494 #ifdef FEAT_WINDOWS
6495 /* tabpage-local variables */
6496 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6497 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6498 #endif
6500 /* global variables */
6501 set_ref_in_ht(&globvarht, copyID);
6503 /* function-local variables */
6504 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6506 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6507 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6511 * 2. Go through the list of dicts and free items without the copyID.
6513 for (dd = first_dict; dd != NULL; )
6514 if (dd->dv_copyID != copyID)
6516 /* Free the Dictionary and ordinary items it contains, but don't
6517 * recurse into Lists and Dictionaries, they will be in the list
6518 * of dicts or list of lists. */
6519 dict_free(dd, FALSE);
6520 did_free = TRUE;
6522 /* restart, next dict may also have been freed */
6523 dd = first_dict;
6525 else
6526 dd = dd->dv_used_next;
6529 * 3. Go through the list of lists and free items without the copyID.
6530 * But don't free a list that has a watcher (used in a for loop), these
6531 * are not referenced anywhere.
6533 for (ll = first_list; ll != NULL; )
6534 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6536 /* Free the List and ordinary items it contains, but don't recurse
6537 * into Lists and Dictionaries, they will be in the list of dicts
6538 * or list of lists. */
6539 list_free(ll, FALSE);
6540 did_free = TRUE;
6542 /* restart, next list may also have been freed */
6543 ll = first_list;
6545 else
6546 ll = ll->lv_used_next;
6548 return did_free;
6552 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6554 static void
6555 set_ref_in_ht(ht, copyID)
6556 hashtab_T *ht;
6557 int copyID;
6559 int todo;
6560 hashitem_T *hi;
6562 todo = (int)ht->ht_used;
6563 for (hi = ht->ht_array; todo > 0; ++hi)
6564 if (!HASHITEM_EMPTY(hi))
6566 --todo;
6567 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6572 * Mark all lists and dicts referenced through list "l" with "copyID".
6574 static void
6575 set_ref_in_list(l, copyID)
6576 list_T *l;
6577 int copyID;
6579 listitem_T *li;
6581 for (li = l->lv_first; li != NULL; li = li->li_next)
6582 set_ref_in_item(&li->li_tv, copyID);
6586 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6588 static void
6589 set_ref_in_item(tv, copyID)
6590 typval_T *tv;
6591 int copyID;
6593 dict_T *dd;
6594 list_T *ll;
6596 switch (tv->v_type)
6598 case VAR_DICT:
6599 dd = tv->vval.v_dict;
6600 if (dd->dv_copyID != copyID)
6602 /* Didn't see this dict yet. */
6603 dd->dv_copyID = copyID;
6604 set_ref_in_ht(&dd->dv_hashtab, copyID);
6606 break;
6608 case VAR_LIST:
6609 ll = tv->vval.v_list;
6610 if (ll->lv_copyID != copyID)
6612 /* Didn't see this list yet. */
6613 ll->lv_copyID = copyID;
6614 set_ref_in_list(ll, copyID);
6616 break;
6618 return;
6622 * Allocate an empty header for a dictionary.
6624 dict_T *
6625 dict_alloc()
6627 dict_T *d;
6629 d = (dict_T *)alloc(sizeof(dict_T));
6630 if (d != NULL)
6632 /* Add the list to the list of dicts for garbage collection. */
6633 if (first_dict != NULL)
6634 first_dict->dv_used_prev = d;
6635 d->dv_used_next = first_dict;
6636 d->dv_used_prev = NULL;
6637 first_dict = d;
6639 hash_init(&d->dv_hashtab);
6640 d->dv_lock = 0;
6641 d->dv_refcount = 0;
6642 d->dv_copyID = 0;
6644 return d;
6648 * Unreference a Dictionary: decrement the reference count and free it when it
6649 * becomes zero.
6651 static void
6652 dict_unref(d)
6653 dict_T *d;
6655 if (d != NULL && --d->dv_refcount <= 0)
6656 dict_free(d, TRUE);
6660 * Free a Dictionary, including all items it contains.
6661 * Ignores the reference count.
6663 static void
6664 dict_free(d, recurse)
6665 dict_T *d;
6666 int recurse; /* Free Lists and Dictionaries recursively. */
6668 int todo;
6669 hashitem_T *hi;
6670 dictitem_T *di;
6672 /* Remove the dict from the list of dicts for garbage collection. */
6673 if (d->dv_used_prev == NULL)
6674 first_dict = d->dv_used_next;
6675 else
6676 d->dv_used_prev->dv_used_next = d->dv_used_next;
6677 if (d->dv_used_next != NULL)
6678 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6680 /* Lock the hashtab, we don't want it to resize while freeing items. */
6681 hash_lock(&d->dv_hashtab);
6682 todo = (int)d->dv_hashtab.ht_used;
6683 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6685 if (!HASHITEM_EMPTY(hi))
6687 /* Remove the item before deleting it, just in case there is
6688 * something recursive causing trouble. */
6689 di = HI2DI(hi);
6690 hash_remove(&d->dv_hashtab, hi);
6691 if (recurse || (di->di_tv.v_type != VAR_LIST
6692 && di->di_tv.v_type != VAR_DICT))
6693 clear_tv(&di->di_tv);
6694 vim_free(di);
6695 --todo;
6698 hash_clear(&d->dv_hashtab);
6699 vim_free(d);
6703 * Allocate a Dictionary item.
6704 * The "key" is copied to the new item.
6705 * Note that the value of the item "di_tv" still needs to be initialized!
6706 * Returns NULL when out of memory.
6708 static dictitem_T *
6709 dictitem_alloc(key)
6710 char_u *key;
6712 dictitem_T *di;
6714 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6715 if (di != NULL)
6717 STRCPY(di->di_key, key);
6718 di->di_flags = 0;
6720 return di;
6724 * Make a copy of a Dictionary item.
6726 static dictitem_T *
6727 dictitem_copy(org)
6728 dictitem_T *org;
6730 dictitem_T *di;
6732 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6733 + STRLEN(org->di_key)));
6734 if (di != NULL)
6736 STRCPY(di->di_key, org->di_key);
6737 di->di_flags = 0;
6738 copy_tv(&org->di_tv, &di->di_tv);
6740 return di;
6744 * Remove item "item" from Dictionary "dict" and free it.
6746 static void
6747 dictitem_remove(dict, item)
6748 dict_T *dict;
6749 dictitem_T *item;
6751 hashitem_T *hi;
6753 hi = hash_find(&dict->dv_hashtab, item->di_key);
6754 if (HASHITEM_EMPTY(hi))
6755 EMSG2(_(e_intern2), "dictitem_remove()");
6756 else
6757 hash_remove(&dict->dv_hashtab, hi);
6758 dictitem_free(item);
6762 * Free a dict item. Also clears the value.
6764 static void
6765 dictitem_free(item)
6766 dictitem_T *item;
6768 clear_tv(&item->di_tv);
6769 vim_free(item);
6773 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6774 * The refcount of the new dict is set to 1.
6775 * See item_copy() for "copyID".
6776 * Returns NULL when out of memory.
6778 static dict_T *
6779 dict_copy(orig, deep, copyID)
6780 dict_T *orig;
6781 int deep;
6782 int copyID;
6784 dict_T *copy;
6785 dictitem_T *di;
6786 int todo;
6787 hashitem_T *hi;
6789 if (orig == NULL)
6790 return NULL;
6792 copy = dict_alloc();
6793 if (copy != NULL)
6795 if (copyID != 0)
6797 orig->dv_copyID = copyID;
6798 orig->dv_copydict = copy;
6800 todo = (int)orig->dv_hashtab.ht_used;
6801 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6803 if (!HASHITEM_EMPTY(hi))
6805 --todo;
6807 di = dictitem_alloc(hi->hi_key);
6808 if (di == NULL)
6809 break;
6810 if (deep)
6812 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6813 copyID) == FAIL)
6815 vim_free(di);
6816 break;
6819 else
6820 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6821 if (dict_add(copy, di) == FAIL)
6823 dictitem_free(di);
6824 break;
6829 ++copy->dv_refcount;
6830 if (todo > 0)
6832 dict_unref(copy);
6833 copy = NULL;
6837 return copy;
6841 * Add item "item" to Dictionary "d".
6842 * Returns FAIL when out of memory and when key already existed.
6844 static int
6845 dict_add(d, item)
6846 dict_T *d;
6847 dictitem_T *item;
6849 return hash_add(&d->dv_hashtab, item->di_key);
6853 * Add a number or string entry to dictionary "d".
6854 * When "str" is NULL use number "nr", otherwise use "str".
6855 * Returns FAIL when out of memory and when key already exists.
6858 dict_add_nr_str(d, key, nr, str)
6859 dict_T *d;
6860 char *key;
6861 long nr;
6862 char_u *str;
6864 dictitem_T *item;
6866 item = dictitem_alloc((char_u *)key);
6867 if (item == NULL)
6868 return FAIL;
6869 item->di_tv.v_lock = 0;
6870 if (str == NULL)
6872 item->di_tv.v_type = VAR_NUMBER;
6873 item->di_tv.vval.v_number = nr;
6875 else
6877 item->di_tv.v_type = VAR_STRING;
6878 item->di_tv.vval.v_string = vim_strsave(str);
6880 if (dict_add(d, item) == FAIL)
6882 dictitem_free(item);
6883 return FAIL;
6885 return OK;
6889 * Get the number of items in a Dictionary.
6891 static long
6892 dict_len(d)
6893 dict_T *d;
6895 if (d == NULL)
6896 return 0L;
6897 return (long)d->dv_hashtab.ht_used;
6901 * Find item "key[len]" in Dictionary "d".
6902 * If "len" is negative use strlen(key).
6903 * Returns NULL when not found.
6905 static dictitem_T *
6906 dict_find(d, key, len)
6907 dict_T *d;
6908 char_u *key;
6909 int len;
6911 #define AKEYLEN 200
6912 char_u buf[AKEYLEN];
6913 char_u *akey;
6914 char_u *tofree = NULL;
6915 hashitem_T *hi;
6917 if (len < 0)
6918 akey = key;
6919 else if (len >= AKEYLEN)
6921 tofree = akey = vim_strnsave(key, len);
6922 if (akey == NULL)
6923 return NULL;
6925 else
6927 /* Avoid a malloc/free by using buf[]. */
6928 vim_strncpy(buf, key, len);
6929 akey = buf;
6932 hi = hash_find(&d->dv_hashtab, akey);
6933 vim_free(tofree);
6934 if (HASHITEM_EMPTY(hi))
6935 return NULL;
6936 return HI2DI(hi);
6940 * Get a string item from a dictionary.
6941 * When "save" is TRUE allocate memory for it.
6942 * Returns NULL if the entry doesn't exist or out of memory.
6944 char_u *
6945 get_dict_string(d, key, save)
6946 dict_T *d;
6947 char_u *key;
6948 int save;
6950 dictitem_T *di;
6951 char_u *s;
6953 di = dict_find(d, key, -1);
6954 if (di == NULL)
6955 return NULL;
6956 s = get_tv_string(&di->di_tv);
6957 if (save && s != NULL)
6958 s = vim_strsave(s);
6959 return s;
6963 * Get a number item from a dictionary.
6964 * Returns 0 if the entry doesn't exist or out of memory.
6966 long
6967 get_dict_number(d, key)
6968 dict_T *d;
6969 char_u *key;
6971 dictitem_T *di;
6973 di = dict_find(d, key, -1);
6974 if (di == NULL)
6975 return 0;
6976 return get_tv_number(&di->di_tv);
6980 * Return an allocated string with the string representation of a Dictionary.
6981 * May return NULL.
6983 static char_u *
6984 dict2string(tv, copyID)
6985 typval_T *tv;
6986 int copyID;
6988 garray_T ga;
6989 int first = TRUE;
6990 char_u *tofree;
6991 char_u numbuf[NUMBUFLEN];
6992 hashitem_T *hi;
6993 char_u *s;
6994 dict_T *d;
6995 int todo;
6997 if ((d = tv->vval.v_dict) == NULL)
6998 return NULL;
6999 ga_init2(&ga, (int)sizeof(char), 80);
7000 ga_append(&ga, '{');
7002 todo = (int)d->dv_hashtab.ht_used;
7003 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7005 if (!HASHITEM_EMPTY(hi))
7007 --todo;
7009 if (first)
7010 first = FALSE;
7011 else
7012 ga_concat(&ga, (char_u *)", ");
7014 tofree = string_quote(hi->hi_key, FALSE);
7015 if (tofree != NULL)
7017 ga_concat(&ga, tofree);
7018 vim_free(tofree);
7020 ga_concat(&ga, (char_u *)": ");
7021 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7022 if (s != NULL)
7023 ga_concat(&ga, s);
7024 vim_free(tofree);
7025 if (s == NULL)
7026 break;
7029 if (todo > 0)
7031 vim_free(ga.ga_data);
7032 return NULL;
7035 ga_append(&ga, '}');
7036 ga_append(&ga, NUL);
7037 return (char_u *)ga.ga_data;
7041 * Allocate a variable for a Dictionary and fill it from "*arg".
7042 * Return OK or FAIL. Returns NOTDONE for {expr}.
7044 static int
7045 get_dict_tv(arg, rettv, evaluate)
7046 char_u **arg;
7047 typval_T *rettv;
7048 int evaluate;
7050 dict_T *d = NULL;
7051 typval_T tvkey;
7052 typval_T tv;
7053 char_u *key = NULL;
7054 dictitem_T *item;
7055 char_u *start = skipwhite(*arg + 1);
7056 char_u buf[NUMBUFLEN];
7059 * First check if it's not a curly-braces thing: {expr}.
7060 * Must do this without evaluating, otherwise a function may be called
7061 * twice. Unfortunately this means we need to call eval1() twice for the
7062 * first item.
7063 * But {} is an empty Dictionary.
7065 if (*start != '}')
7067 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7068 return FAIL;
7069 if (*start == '}')
7070 return NOTDONE;
7073 if (evaluate)
7075 d = dict_alloc();
7076 if (d == NULL)
7077 return FAIL;
7079 tvkey.v_type = VAR_UNKNOWN;
7080 tv.v_type = VAR_UNKNOWN;
7082 *arg = skipwhite(*arg + 1);
7083 while (**arg != '}' && **arg != NUL)
7085 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7086 goto failret;
7087 if (**arg != ':')
7089 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7090 clear_tv(&tvkey);
7091 goto failret;
7093 if (evaluate)
7095 key = get_tv_string_buf_chk(&tvkey, buf);
7096 if (key == NULL || *key == NUL)
7098 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7099 if (key != NULL)
7100 EMSG(_(e_emptykey));
7101 clear_tv(&tvkey);
7102 goto failret;
7106 *arg = skipwhite(*arg + 1);
7107 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7109 if (evaluate)
7110 clear_tv(&tvkey);
7111 goto failret;
7113 if (evaluate)
7115 item = dict_find(d, key, -1);
7116 if (item != NULL)
7118 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7119 clear_tv(&tvkey);
7120 clear_tv(&tv);
7121 goto failret;
7123 item = dictitem_alloc(key);
7124 clear_tv(&tvkey);
7125 if (item != NULL)
7127 item->di_tv = tv;
7128 item->di_tv.v_lock = 0;
7129 if (dict_add(d, item) == FAIL)
7130 dictitem_free(item);
7134 if (**arg == '}')
7135 break;
7136 if (**arg != ',')
7138 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7139 goto failret;
7141 *arg = skipwhite(*arg + 1);
7144 if (**arg != '}')
7146 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7147 failret:
7148 if (evaluate)
7149 dict_free(d, TRUE);
7150 return FAIL;
7153 *arg = skipwhite(*arg + 1);
7154 if (evaluate)
7156 rettv->v_type = VAR_DICT;
7157 rettv->vval.v_dict = d;
7158 ++d->dv_refcount;
7161 return OK;
7165 * Return a string with the string representation of a variable.
7166 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7167 * "numbuf" is used for a number.
7168 * Does not put quotes around strings, as ":echo" displays values.
7169 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7170 * May return NULL.
7172 static char_u *
7173 echo_string(tv, tofree, numbuf, copyID)
7174 typval_T *tv;
7175 char_u **tofree;
7176 char_u *numbuf;
7177 int copyID;
7179 static int recurse = 0;
7180 char_u *r = NULL;
7182 if (recurse >= DICT_MAXNEST)
7184 EMSG(_("E724: variable nested too deep for displaying"));
7185 *tofree = NULL;
7186 return NULL;
7188 ++recurse;
7190 switch (tv->v_type)
7192 case VAR_FUNC:
7193 *tofree = NULL;
7194 r = tv->vval.v_string;
7195 break;
7197 case VAR_LIST:
7198 if (tv->vval.v_list == NULL)
7200 *tofree = NULL;
7201 r = NULL;
7203 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7205 *tofree = NULL;
7206 r = (char_u *)"[...]";
7208 else
7210 tv->vval.v_list->lv_copyID = copyID;
7211 *tofree = list2string(tv, copyID);
7212 r = *tofree;
7214 break;
7216 case VAR_DICT:
7217 if (tv->vval.v_dict == NULL)
7219 *tofree = NULL;
7220 r = NULL;
7222 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7224 *tofree = NULL;
7225 r = (char_u *)"{...}";
7227 else
7229 tv->vval.v_dict->dv_copyID = copyID;
7230 *tofree = dict2string(tv, copyID);
7231 r = *tofree;
7233 break;
7235 case VAR_STRING:
7236 case VAR_NUMBER:
7237 *tofree = NULL;
7238 r = get_tv_string_buf(tv, numbuf);
7239 break;
7241 #ifdef FEAT_FLOAT
7242 case VAR_FLOAT:
7243 *tofree = NULL;
7244 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7245 r = numbuf;
7246 break;
7247 #endif
7249 default:
7250 EMSG2(_(e_intern2), "echo_string()");
7251 *tofree = NULL;
7254 --recurse;
7255 return r;
7259 * Return a string with the string representation of a variable.
7260 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7261 * "numbuf" is used for a number.
7262 * Puts quotes around strings, so that they can be parsed back by eval().
7263 * May return NULL.
7265 static char_u *
7266 tv2string(tv, tofree, numbuf, copyID)
7267 typval_T *tv;
7268 char_u **tofree;
7269 char_u *numbuf;
7270 int copyID;
7272 switch (tv->v_type)
7274 case VAR_FUNC:
7275 *tofree = string_quote(tv->vval.v_string, TRUE);
7276 return *tofree;
7277 case VAR_STRING:
7278 *tofree = string_quote(tv->vval.v_string, FALSE);
7279 return *tofree;
7280 #ifdef FEAT_FLOAT
7281 case VAR_FLOAT:
7282 *tofree = NULL;
7283 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7284 return numbuf;
7285 #endif
7286 case VAR_NUMBER:
7287 case VAR_LIST:
7288 case VAR_DICT:
7289 break;
7290 default:
7291 EMSG2(_(e_intern2), "tv2string()");
7293 return echo_string(tv, tofree, numbuf, copyID);
7297 * Return string "str" in ' quotes, doubling ' characters.
7298 * If "str" is NULL an empty string is assumed.
7299 * If "function" is TRUE make it function('string').
7301 static char_u *
7302 string_quote(str, function)
7303 char_u *str;
7304 int function;
7306 unsigned len;
7307 char_u *p, *r, *s;
7309 len = (function ? 13 : 3);
7310 if (str != NULL)
7312 len += (unsigned)STRLEN(str);
7313 for (p = str; *p != NUL; mb_ptr_adv(p))
7314 if (*p == '\'')
7315 ++len;
7317 s = r = alloc(len);
7318 if (r != NULL)
7320 if (function)
7322 STRCPY(r, "function('");
7323 r += 10;
7325 else
7326 *r++ = '\'';
7327 if (str != NULL)
7328 for (p = str; *p != NUL; )
7330 if (*p == '\'')
7331 *r++ = '\'';
7332 MB_COPY_CHAR(p, r);
7334 *r++ = '\'';
7335 if (function)
7336 *r++ = ')';
7337 *r++ = NUL;
7339 return s;
7342 #ifdef FEAT_FLOAT
7344 * Convert the string "text" to a floating point number.
7345 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7346 * this always uses a decimal point.
7347 * Returns the length of the text that was consumed.
7349 static int
7350 string2float(text, value)
7351 char_u *text;
7352 float_T *value; /* result stored here */
7354 char *s = (char *)text;
7355 float_T f;
7357 f = strtod(s, &s);
7358 *value = f;
7359 return (int)((char_u *)s - text);
7361 #endif
7364 * Get the value of an environment variable.
7365 * "arg" is pointing to the '$'. It is advanced to after the name.
7366 * If the environment variable was not set, silently assume it is empty.
7367 * Always return OK.
7369 static int
7370 get_env_tv(arg, rettv, evaluate)
7371 char_u **arg;
7372 typval_T *rettv;
7373 int evaluate;
7375 char_u *string = NULL;
7376 int len;
7377 int cc;
7378 char_u *name;
7379 int mustfree = FALSE;
7381 ++*arg;
7382 name = *arg;
7383 len = get_env_len(arg);
7384 if (evaluate)
7386 if (len != 0)
7388 cc = name[len];
7389 name[len] = NUL;
7390 /* first try vim_getenv(), fast for normal environment vars */
7391 string = vim_getenv(name, &mustfree);
7392 if (string != NULL && *string != NUL)
7394 if (!mustfree)
7395 string = vim_strsave(string);
7397 else
7399 if (mustfree)
7400 vim_free(string);
7402 /* next try expanding things like $VIM and ${HOME} */
7403 string = expand_env_save(name - 1);
7404 if (string != NULL && *string == '$')
7406 vim_free(string);
7407 string = NULL;
7410 name[len] = cc;
7412 rettv->v_type = VAR_STRING;
7413 rettv->vval.v_string = string;
7416 return OK;
7420 * Array with names and number of arguments of all internal functions
7421 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7423 static struct fst
7425 char *f_name; /* function name */
7426 char f_min_argc; /* minimal number of arguments */
7427 char f_max_argc; /* maximal number of arguments */
7428 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7429 /* implementation of function */
7430 } functions[] =
7432 #ifdef FEAT_FLOAT
7433 {"abs", 1, 1, f_abs},
7434 #endif
7435 {"add", 2, 2, f_add},
7436 {"append", 2, 2, f_append},
7437 {"argc", 0, 0, f_argc},
7438 {"argidx", 0, 0, f_argidx},
7439 {"argv", 0, 1, f_argv},
7440 #ifdef FEAT_FLOAT
7441 {"atan", 1, 1, f_atan},
7442 #endif
7443 {"browse", 4, 4, f_browse},
7444 {"browsedir", 2, 2, f_browsedir},
7445 {"bufexists", 1, 1, f_bufexists},
7446 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7447 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7448 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7449 {"buflisted", 1, 1, f_buflisted},
7450 {"bufloaded", 1, 1, f_bufloaded},
7451 {"bufname", 1, 1, f_bufname},
7452 {"bufnr", 1, 2, f_bufnr},
7453 {"bufwinnr", 1, 1, f_bufwinnr},
7454 {"byte2line", 1, 1, f_byte2line},
7455 {"byteidx", 2, 2, f_byteidx},
7456 {"call", 2, 3, f_call},
7457 #ifdef FEAT_FLOAT
7458 {"ceil", 1, 1, f_ceil},
7459 #endif
7460 {"changenr", 0, 0, f_changenr},
7461 {"char2nr", 1, 1, f_char2nr},
7462 {"cindent", 1, 1, f_cindent},
7463 {"clearmatches", 0, 0, f_clearmatches},
7464 {"col", 1, 1, f_col},
7465 #if defined(FEAT_INS_EXPAND)
7466 {"complete", 2, 2, f_complete},
7467 {"complete_add", 1, 1, f_complete_add},
7468 {"complete_check", 0, 0, f_complete_check},
7469 #endif
7470 {"confirm", 1, 4, f_confirm},
7471 {"copy", 1, 1, f_copy},
7472 #ifdef FEAT_FLOAT
7473 {"cos", 1, 1, f_cos},
7474 #endif
7475 {"count", 2, 4, f_count},
7476 {"cscope_connection",0,3, f_cscope_connection},
7477 {"cursor", 1, 3, f_cursor},
7478 {"deepcopy", 1, 2, f_deepcopy},
7479 {"delete", 1, 1, f_delete},
7480 {"did_filetype", 0, 0, f_did_filetype},
7481 {"diff_filler", 1, 1, f_diff_filler},
7482 {"diff_hlID", 2, 2, f_diff_hlID},
7483 {"empty", 1, 1, f_empty},
7484 {"escape", 2, 2, f_escape},
7485 {"eval", 1, 1, f_eval},
7486 {"eventhandler", 0, 0, f_eventhandler},
7487 {"executable", 1, 1, f_executable},
7488 {"exists", 1, 1, f_exists},
7489 {"expand", 1, 2, f_expand},
7490 {"extend", 2, 3, f_extend},
7491 {"feedkeys", 1, 2, f_feedkeys},
7492 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7493 {"filereadable", 1, 1, f_filereadable},
7494 {"filewritable", 1, 1, f_filewritable},
7495 {"filter", 2, 2, f_filter},
7496 {"finddir", 1, 3, f_finddir},
7497 {"findfile", 1, 3, f_findfile},
7498 #ifdef FEAT_FLOAT
7499 {"float2nr", 1, 1, f_float2nr},
7500 {"floor", 1, 1, f_floor},
7501 #endif
7502 {"fnameescape", 1, 1, f_fnameescape},
7503 {"fnamemodify", 2, 2, f_fnamemodify},
7504 {"foldclosed", 1, 1, f_foldclosed},
7505 {"foldclosedend", 1, 1, f_foldclosedend},
7506 {"foldlevel", 1, 1, f_foldlevel},
7507 {"foldtext", 0, 0, f_foldtext},
7508 {"foldtextresult", 1, 1, f_foldtextresult},
7509 {"foreground", 0, 0, f_foreground},
7510 {"function", 1, 1, f_function},
7511 {"garbagecollect", 0, 1, f_garbagecollect},
7512 {"get", 2, 3, f_get},
7513 {"getbufline", 2, 3, f_getbufline},
7514 {"getbufvar", 2, 2, f_getbufvar},
7515 {"getchar", 0, 1, f_getchar},
7516 {"getcharmod", 0, 0, f_getcharmod},
7517 {"getcmdline", 0, 0, f_getcmdline},
7518 {"getcmdpos", 0, 0, f_getcmdpos},
7519 {"getcmdtype", 0, 0, f_getcmdtype},
7520 {"getcwd", 0, 0, f_getcwd},
7521 {"getfontname", 0, 1, f_getfontname},
7522 {"getfperm", 1, 1, f_getfperm},
7523 {"getfsize", 1, 1, f_getfsize},
7524 {"getftime", 1, 1, f_getftime},
7525 {"getftype", 1, 1, f_getftype},
7526 {"getline", 1, 2, f_getline},
7527 {"getloclist", 1, 1, f_getqflist},
7528 {"getmatches", 0, 0, f_getmatches},
7529 {"getpid", 0, 0, f_getpid},
7530 {"getpos", 1, 1, f_getpos},
7531 {"getqflist", 0, 0, f_getqflist},
7532 {"getreg", 0, 2, f_getreg},
7533 {"getregtype", 0, 1, f_getregtype},
7534 {"gettabwinvar", 3, 3, f_gettabwinvar},
7535 {"getwinposx", 0, 0, f_getwinposx},
7536 {"getwinposy", 0, 0, f_getwinposy},
7537 {"getwinvar", 2, 2, f_getwinvar},
7538 {"glob", 1, 1, f_glob},
7539 {"globpath", 2, 2, f_globpath},
7540 {"has", 1, 1, f_has},
7541 {"has_key", 2, 2, f_has_key},
7542 {"haslocaldir", 0, 0, f_haslocaldir},
7543 {"hasmapto", 1, 3, f_hasmapto},
7544 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7545 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7546 {"histadd", 2, 2, f_histadd},
7547 {"histdel", 1, 2, f_histdel},
7548 {"histget", 1, 2, f_histget},
7549 {"histnr", 1, 1, f_histnr},
7550 {"hlID", 1, 1, f_hlID},
7551 {"hlexists", 1, 1, f_hlexists},
7552 {"hostname", 0, 0, f_hostname},
7553 {"iconv", 3, 3, f_iconv},
7554 {"indent", 1, 1, f_indent},
7555 {"index", 2, 4, f_index},
7556 {"input", 1, 3, f_input},
7557 {"inputdialog", 1, 3, f_inputdialog},
7558 {"inputlist", 1, 1, f_inputlist},
7559 {"inputrestore", 0, 0, f_inputrestore},
7560 {"inputsave", 0, 0, f_inputsave},
7561 {"inputsecret", 1, 2, f_inputsecret},
7562 {"insert", 2, 3, f_insert},
7563 {"isdirectory", 1, 1, f_isdirectory},
7564 {"islocked", 1, 1, f_islocked},
7565 {"items", 1, 1, f_items},
7566 {"join", 1, 2, f_join},
7567 {"keys", 1, 1, f_keys},
7568 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7569 {"len", 1, 1, f_len},
7570 {"libcall", 3, 3, f_libcall},
7571 {"libcallnr", 3, 3, f_libcallnr},
7572 {"line", 1, 1, f_line},
7573 {"line2byte", 1, 1, f_line2byte},
7574 {"lispindent", 1, 1, f_lispindent},
7575 {"localtime", 0, 0, f_localtime},
7576 #ifdef FEAT_FLOAT
7577 {"log10", 1, 1, f_log10},
7578 #endif
7579 {"map", 2, 2, f_map},
7580 {"maparg", 1, 3, f_maparg},
7581 {"mapcheck", 1, 3, f_mapcheck},
7582 {"match", 2, 4, f_match},
7583 {"matchadd", 2, 4, f_matchadd},
7584 {"matcharg", 1, 1, f_matcharg},
7585 {"matchdelete", 1, 1, f_matchdelete},
7586 {"matchend", 2, 4, f_matchend},
7587 {"matchlist", 2, 4, f_matchlist},
7588 {"matchstr", 2, 4, f_matchstr},
7589 {"max", 1, 1, f_max},
7590 {"min", 1, 1, f_min},
7591 #ifdef vim_mkdir
7592 {"mkdir", 1, 3, f_mkdir},
7593 #endif
7594 {"mode", 0, 1, f_mode},
7595 {"nextnonblank", 1, 1, f_nextnonblank},
7596 {"nr2char", 1, 1, f_nr2char},
7597 {"pathshorten", 1, 1, f_pathshorten},
7598 #ifdef FEAT_FLOAT
7599 {"pow", 2, 2, f_pow},
7600 #endif
7601 {"prevnonblank", 1, 1, f_prevnonblank},
7602 {"printf", 2, 19, f_printf},
7603 {"pumvisible", 0, 0, f_pumvisible},
7604 {"range", 1, 3, f_range},
7605 {"readfile", 1, 3, f_readfile},
7606 {"reltime", 0, 2, f_reltime},
7607 {"reltimestr", 1, 1, f_reltimestr},
7608 {"remote_expr", 2, 3, f_remote_expr},
7609 {"remote_foreground", 1, 1, f_remote_foreground},
7610 {"remote_peek", 1, 2, f_remote_peek},
7611 {"remote_read", 1, 1, f_remote_read},
7612 {"remote_send", 2, 3, f_remote_send},
7613 {"remove", 2, 3, f_remove},
7614 {"rename", 2, 2, f_rename},
7615 {"repeat", 2, 2, f_repeat},
7616 {"resolve", 1, 1, f_resolve},
7617 {"reverse", 1, 1, f_reverse},
7618 #ifdef FEAT_FLOAT
7619 {"round", 1, 1, f_round},
7620 #endif
7621 {"search", 1, 4, f_search},
7622 {"searchdecl", 1, 3, f_searchdecl},
7623 {"searchpair", 3, 7, f_searchpair},
7624 {"searchpairpos", 3, 7, f_searchpairpos},
7625 {"searchpos", 1, 4, f_searchpos},
7626 {"server2client", 2, 2, f_server2client},
7627 {"serverlist", 0, 0, f_serverlist},
7628 {"setbufvar", 3, 3, f_setbufvar},
7629 {"setcmdpos", 1, 1, f_setcmdpos},
7630 {"setline", 2, 2, f_setline},
7631 {"setloclist", 2, 3, f_setloclist},
7632 {"setmatches", 1, 1, f_setmatches},
7633 {"setpos", 2, 2, f_setpos},
7634 {"setqflist", 1, 2, f_setqflist},
7635 {"setreg", 2, 3, f_setreg},
7636 {"settabwinvar", 4, 4, f_settabwinvar},
7637 {"setwinvar", 3, 3, f_setwinvar},
7638 {"shellescape", 1, 2, f_shellescape},
7639 {"simplify", 1, 1, f_simplify},
7640 #ifdef FEAT_FLOAT
7641 {"sin", 1, 1, f_sin},
7642 #endif
7643 {"sort", 1, 2, f_sort},
7644 {"soundfold", 1, 1, f_soundfold},
7645 {"spellbadword", 0, 1, f_spellbadword},
7646 {"spellsuggest", 1, 3, f_spellsuggest},
7647 {"split", 1, 3, f_split},
7648 #ifdef FEAT_FLOAT
7649 {"sqrt", 1, 1, f_sqrt},
7650 {"str2float", 1, 1, f_str2float},
7651 #endif
7652 {"str2nr", 1, 2, f_str2nr},
7653 #ifdef HAVE_STRFTIME
7654 {"strftime", 1, 2, f_strftime},
7655 #endif
7656 {"stridx", 2, 3, f_stridx},
7657 {"string", 1, 1, f_string},
7658 {"strlen", 1, 1, f_strlen},
7659 {"strpart", 2, 3, f_strpart},
7660 {"strridx", 2, 3, f_strridx},
7661 {"strtrans", 1, 1, f_strtrans},
7662 {"submatch", 1, 1, f_submatch},
7663 {"substitute", 4, 4, f_substitute},
7664 {"synID", 3, 3, f_synID},
7665 {"synIDattr", 2, 3, f_synIDattr},
7666 {"synIDtrans", 1, 1, f_synIDtrans},
7667 {"synstack", 2, 2, f_synstack},
7668 {"system", 1, 2, f_system},
7669 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7670 {"tabpagenr", 0, 1, f_tabpagenr},
7671 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7672 {"tagfiles", 0, 0, f_tagfiles},
7673 {"taglist", 1, 1, f_taglist},
7674 {"tempname", 0, 0, f_tempname},
7675 {"test", 1, 1, f_test},
7676 {"tolower", 1, 1, f_tolower},
7677 {"toupper", 1, 1, f_toupper},
7678 {"tr", 3, 3, f_tr},
7679 #ifdef FEAT_FLOAT
7680 {"trunc", 1, 1, f_trunc},
7681 #endif
7682 {"type", 1, 1, f_type},
7683 {"values", 1, 1, f_values},
7684 {"virtcol", 1, 1, f_virtcol},
7685 {"visualmode", 0, 1, f_visualmode},
7686 {"winbufnr", 1, 1, f_winbufnr},
7687 {"wincol", 0, 0, f_wincol},
7688 {"winheight", 1, 1, f_winheight},
7689 {"winline", 0, 0, f_winline},
7690 {"winnr", 0, 1, f_winnr},
7691 {"winrestcmd", 0, 0, f_winrestcmd},
7692 {"winrestview", 1, 1, f_winrestview},
7693 {"winsaveview", 0, 0, f_winsaveview},
7694 {"winwidth", 1, 1, f_winwidth},
7695 {"writefile", 2, 3, f_writefile},
7698 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7701 * Function given to ExpandGeneric() to obtain the list of internal
7702 * or user defined function names.
7704 char_u *
7705 get_function_name(xp, idx)
7706 expand_T *xp;
7707 int idx;
7709 static int intidx = -1;
7710 char_u *name;
7712 if (idx == 0)
7713 intidx = -1;
7714 if (intidx < 0)
7716 name = get_user_func_name(xp, idx);
7717 if (name != NULL)
7718 return name;
7720 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7722 STRCPY(IObuff, functions[intidx].f_name);
7723 STRCAT(IObuff, "(");
7724 if (functions[intidx].f_max_argc == 0)
7725 STRCAT(IObuff, ")");
7726 return IObuff;
7729 return NULL;
7733 * Function given to ExpandGeneric() to obtain the list of internal or
7734 * user defined variable or function names.
7736 /*ARGSUSED*/
7737 char_u *
7738 get_expr_name(xp, idx)
7739 expand_T *xp;
7740 int idx;
7742 static int intidx = -1;
7743 char_u *name;
7745 if (idx == 0)
7746 intidx = -1;
7747 if (intidx < 0)
7749 name = get_function_name(xp, idx);
7750 if (name != NULL)
7751 return name;
7753 return get_user_var_name(xp, ++intidx);
7756 #endif /* FEAT_CMDL_COMPL */
7759 * Find internal function in table above.
7760 * Return index, or -1 if not found
7762 static int
7763 find_internal_func(name)
7764 char_u *name; /* name of the function */
7766 int first = 0;
7767 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7768 int cmp;
7769 int x;
7772 * Find the function name in the table. Binary search.
7774 while (first <= last)
7776 x = first + ((unsigned)(last - first) >> 1);
7777 cmp = STRCMP(name, functions[x].f_name);
7778 if (cmp < 0)
7779 last = x - 1;
7780 else if (cmp > 0)
7781 first = x + 1;
7782 else
7783 return x;
7785 return -1;
7789 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7790 * name it contains, otherwise return "name".
7792 static char_u *
7793 deref_func_name(name, lenp)
7794 char_u *name;
7795 int *lenp;
7797 dictitem_T *v;
7798 int cc;
7800 cc = name[*lenp];
7801 name[*lenp] = NUL;
7802 v = find_var(name, NULL);
7803 name[*lenp] = cc;
7804 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7806 if (v->di_tv.vval.v_string == NULL)
7808 *lenp = 0;
7809 return (char_u *)""; /* just in case */
7811 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7812 return v->di_tv.vval.v_string;
7815 return name;
7819 * Allocate a variable for the result of a function.
7820 * Return OK or FAIL.
7822 static int
7823 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7824 evaluate, selfdict)
7825 char_u *name; /* name of the function */
7826 int len; /* length of "name" */
7827 typval_T *rettv;
7828 char_u **arg; /* argument, pointing to the '(' */
7829 linenr_T firstline; /* first line of range */
7830 linenr_T lastline; /* last line of range */
7831 int *doesrange; /* return: function handled range */
7832 int evaluate;
7833 dict_T *selfdict; /* Dictionary for "self" */
7835 char_u *argp;
7836 int ret = OK;
7837 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7838 int argcount = 0; /* number of arguments found */
7841 * Get the arguments.
7843 argp = *arg;
7844 while (argcount < MAX_FUNC_ARGS)
7846 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7847 if (*argp == ')' || *argp == ',' || *argp == NUL)
7848 break;
7849 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7851 ret = FAIL;
7852 break;
7854 ++argcount;
7855 if (*argp != ',')
7856 break;
7858 if (*argp == ')')
7859 ++argp;
7860 else
7861 ret = FAIL;
7863 if (ret == OK)
7864 ret = call_func(name, len, rettv, argcount, argvars,
7865 firstline, lastline, doesrange, evaluate, selfdict);
7866 else if (!aborting())
7868 if (argcount == MAX_FUNC_ARGS)
7869 emsg_funcname("E740: Too many arguments for function %s", name);
7870 else
7871 emsg_funcname("E116: Invalid arguments for function %s", name);
7874 while (--argcount >= 0)
7875 clear_tv(&argvars[argcount]);
7877 *arg = skipwhite(argp);
7878 return ret;
7883 * Call a function with its resolved parameters
7884 * Return OK when the function can't be called, FAIL otherwise.
7885 * Also returns OK when an error was encountered while executing the function.
7887 static int
7888 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7889 doesrange, evaluate, selfdict)
7890 char_u *name; /* name of the function */
7891 int len; /* length of "name" */
7892 typval_T *rettv; /* return value goes here */
7893 int argcount; /* number of "argvars" */
7894 typval_T *argvars; /* vars for arguments, must have "argcount"
7895 PLUS ONE elements! */
7896 linenr_T firstline; /* first line of range */
7897 linenr_T lastline; /* last line of range */
7898 int *doesrange; /* return: function handled range */
7899 int evaluate;
7900 dict_T *selfdict; /* Dictionary for "self" */
7902 int ret = FAIL;
7903 #define ERROR_UNKNOWN 0
7904 #define ERROR_TOOMANY 1
7905 #define ERROR_TOOFEW 2
7906 #define ERROR_SCRIPT 3
7907 #define ERROR_DICT 4
7908 #define ERROR_NONE 5
7909 #define ERROR_OTHER 6
7910 int error = ERROR_NONE;
7911 int i;
7912 int llen;
7913 ufunc_T *fp;
7914 int cc;
7915 #define FLEN_FIXED 40
7916 char_u fname_buf[FLEN_FIXED + 1];
7917 char_u *fname;
7920 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7921 * Change <SNR>123_name() to K_SNR 123_name().
7922 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7924 cc = name[len];
7925 name[len] = NUL;
7926 llen = eval_fname_script(name);
7927 if (llen > 0)
7929 fname_buf[0] = K_SPECIAL;
7930 fname_buf[1] = KS_EXTRA;
7931 fname_buf[2] = (int)KE_SNR;
7932 i = 3;
7933 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7935 if (current_SID <= 0)
7936 error = ERROR_SCRIPT;
7937 else
7939 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7940 i = (int)STRLEN(fname_buf);
7943 if (i + STRLEN(name + llen) < FLEN_FIXED)
7945 STRCPY(fname_buf + i, name + llen);
7946 fname = fname_buf;
7948 else
7950 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
7951 if (fname == NULL)
7952 error = ERROR_OTHER;
7953 else
7955 mch_memmove(fname, fname_buf, (size_t)i);
7956 STRCPY(fname + i, name + llen);
7960 else
7961 fname = name;
7963 *doesrange = FALSE;
7966 /* execute the function if no errors detected and executing */
7967 if (evaluate && error == ERROR_NONE)
7969 rettv->v_type = VAR_NUMBER; /* default is number rettv */
7970 error = ERROR_UNKNOWN;
7972 if (!builtin_function(fname))
7975 * User defined function.
7977 fp = find_func(fname);
7979 #ifdef FEAT_AUTOCMD
7980 /* Trigger FuncUndefined event, may load the function. */
7981 if (fp == NULL
7982 && apply_autocmds(EVENT_FUNCUNDEFINED,
7983 fname, fname, TRUE, NULL)
7984 && !aborting())
7986 /* executed an autocommand, search for the function again */
7987 fp = find_func(fname);
7989 #endif
7990 /* Try loading a package. */
7991 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
7993 /* loaded a package, search for the function again */
7994 fp = find_func(fname);
7997 if (fp != NULL)
7999 if (fp->uf_flags & FC_RANGE)
8000 *doesrange = TRUE;
8001 if (argcount < fp->uf_args.ga_len)
8002 error = ERROR_TOOFEW;
8003 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8004 error = ERROR_TOOMANY;
8005 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8006 error = ERROR_DICT;
8007 else
8010 * Call the user function.
8011 * Save and restore search patterns, script variables and
8012 * redo buffer.
8014 save_search_patterns();
8015 saveRedobuff();
8016 ++fp->uf_calls;
8017 call_user_func(fp, argcount, argvars, rettv,
8018 firstline, lastline,
8019 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8020 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8021 && fp->uf_refcount <= 0)
8022 /* Function was unreferenced while being used, free it
8023 * now. */
8024 func_free(fp);
8025 restoreRedobuff();
8026 restore_search_patterns();
8027 error = ERROR_NONE;
8031 else
8034 * Find the function name in the table, call its implementation.
8036 i = find_internal_func(fname);
8037 if (i >= 0)
8039 if (argcount < functions[i].f_min_argc)
8040 error = ERROR_TOOFEW;
8041 else if (argcount > functions[i].f_max_argc)
8042 error = ERROR_TOOMANY;
8043 else
8045 argvars[argcount].v_type = VAR_UNKNOWN;
8046 functions[i].f_func(argvars, rettv);
8047 error = ERROR_NONE;
8052 * The function call (or "FuncUndefined" autocommand sequence) might
8053 * have been aborted by an error, an interrupt, or an explicitly thrown
8054 * exception that has not been caught so far. This situation can be
8055 * tested for by calling aborting(). For an error in an internal
8056 * function or for the "E132" error in call_user_func(), however, the
8057 * throw point at which the "force_abort" flag (temporarily reset by
8058 * emsg()) is normally updated has not been reached yet. We need to
8059 * update that flag first to make aborting() reliable.
8061 update_force_abort();
8063 if (error == ERROR_NONE)
8064 ret = OK;
8067 * Report an error unless the argument evaluation or function call has been
8068 * cancelled due to an aborting error, an interrupt, or an exception.
8070 if (!aborting())
8072 switch (error)
8074 case ERROR_UNKNOWN:
8075 emsg_funcname(N_("E117: Unknown function: %s"), name);
8076 break;
8077 case ERROR_TOOMANY:
8078 emsg_funcname(e_toomanyarg, name);
8079 break;
8080 case ERROR_TOOFEW:
8081 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8082 name);
8083 break;
8084 case ERROR_SCRIPT:
8085 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8086 name);
8087 break;
8088 case ERROR_DICT:
8089 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8090 name);
8091 break;
8095 name[len] = cc;
8096 if (fname != name && fname != fname_buf)
8097 vim_free(fname);
8099 return ret;
8103 * Give an error message with a function name. Handle <SNR> things.
8105 static void
8106 emsg_funcname(ermsg, name)
8107 char *ermsg;
8108 char_u *name;
8110 char_u *p;
8112 if (*name == K_SPECIAL)
8113 p = concat_str((char_u *)"<SNR>", name + 3);
8114 else
8115 p = name;
8116 EMSG2(_(ermsg), p);
8117 if (p != name)
8118 vim_free(p);
8122 * Return TRUE for a non-zero Number and a non-empty String.
8124 static int
8125 non_zero_arg(argvars)
8126 typval_T *argvars;
8128 return ((argvars[0].v_type == VAR_NUMBER
8129 && argvars[0].vval.v_number != 0)
8130 || (argvars[0].v_type == VAR_STRING
8131 && argvars[0].vval.v_string != NULL
8132 && *argvars[0].vval.v_string != NUL));
8135 /*********************************************
8136 * Implementation of the built-in functions
8139 #ifdef FEAT_FLOAT
8141 * "abs(expr)" function
8143 static void
8144 f_abs(argvars, rettv)
8145 typval_T *argvars;
8146 typval_T *rettv;
8148 if (argvars[0].v_type == VAR_FLOAT)
8150 rettv->v_type = VAR_FLOAT;
8151 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8153 else
8155 varnumber_T n;
8156 int error = FALSE;
8158 n = get_tv_number_chk(&argvars[0], &error);
8159 if (error)
8160 rettv->vval.v_number = -1;
8161 else if (n > 0)
8162 rettv->vval.v_number = n;
8163 else
8164 rettv->vval.v_number = -n;
8167 #endif
8170 * "add(list, item)" function
8172 static void
8173 f_add(argvars, rettv)
8174 typval_T *argvars;
8175 typval_T *rettv;
8177 list_T *l;
8179 rettv->vval.v_number = 1; /* Default: Failed */
8180 if (argvars[0].v_type == VAR_LIST)
8182 if ((l = argvars[0].vval.v_list) != NULL
8183 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8184 && list_append_tv(l, &argvars[1]) == OK)
8185 copy_tv(&argvars[0], rettv);
8187 else
8188 EMSG(_(e_listreq));
8192 * "append(lnum, string/list)" function
8194 static void
8195 f_append(argvars, rettv)
8196 typval_T *argvars;
8197 typval_T *rettv;
8199 long lnum;
8200 char_u *line;
8201 list_T *l = NULL;
8202 listitem_T *li = NULL;
8203 typval_T *tv;
8204 long added = 0;
8206 lnum = get_tv_lnum(argvars);
8207 if (lnum >= 0
8208 && lnum <= curbuf->b_ml.ml_line_count
8209 && u_save(lnum, lnum + 1) == OK)
8211 if (argvars[1].v_type == VAR_LIST)
8213 l = argvars[1].vval.v_list;
8214 if (l == NULL)
8215 return;
8216 li = l->lv_first;
8218 rettv->vval.v_number = 0; /* Default: Success */
8219 for (;;)
8221 if (l == NULL)
8222 tv = &argvars[1]; /* append a string */
8223 else if (li == NULL)
8224 break; /* end of list */
8225 else
8226 tv = &li->li_tv; /* append item from list */
8227 line = get_tv_string_chk(tv);
8228 if (line == NULL) /* type error */
8230 rettv->vval.v_number = 1; /* Failed */
8231 break;
8233 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8234 ++added;
8235 if (l == NULL)
8236 break;
8237 li = li->li_next;
8240 appended_lines_mark(lnum, added);
8241 if (curwin->w_cursor.lnum > lnum)
8242 curwin->w_cursor.lnum += added;
8244 else
8245 rettv->vval.v_number = 1; /* Failed */
8249 * "argc()" function
8251 /* ARGSUSED */
8252 static void
8253 f_argc(argvars, rettv)
8254 typval_T *argvars;
8255 typval_T *rettv;
8257 rettv->vval.v_number = ARGCOUNT;
8261 * "argidx()" function
8263 /* ARGSUSED */
8264 static void
8265 f_argidx(argvars, rettv)
8266 typval_T *argvars;
8267 typval_T *rettv;
8269 rettv->vval.v_number = curwin->w_arg_idx;
8273 * "argv(nr)" function
8275 static void
8276 f_argv(argvars, rettv)
8277 typval_T *argvars;
8278 typval_T *rettv;
8280 int idx;
8282 if (argvars[0].v_type != VAR_UNKNOWN)
8284 idx = get_tv_number_chk(&argvars[0], NULL);
8285 if (idx >= 0 && idx < ARGCOUNT)
8286 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8287 else
8288 rettv->vval.v_string = NULL;
8289 rettv->v_type = VAR_STRING;
8291 else if (rettv_list_alloc(rettv) == OK)
8292 for (idx = 0; idx < ARGCOUNT; ++idx)
8293 list_append_string(rettv->vval.v_list,
8294 alist_name(&ARGLIST[idx]), -1);
8297 #ifdef FEAT_FLOAT
8298 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8301 * Get the float value of "argvars[0]" into "f".
8302 * Returns FAIL when the argument is not a Number or Float.
8304 static int
8305 get_float_arg(argvars, f)
8306 typval_T *argvars;
8307 float_T *f;
8309 if (argvars[0].v_type == VAR_FLOAT)
8311 *f = argvars[0].vval.v_float;
8312 return OK;
8314 if (argvars[0].v_type == VAR_NUMBER)
8316 *f = (float_T)argvars[0].vval.v_number;
8317 return OK;
8319 EMSG(_("E808: Number or Float required"));
8320 return FAIL;
8324 * "atan()" function
8326 static void
8327 f_atan(argvars, rettv)
8328 typval_T *argvars;
8329 typval_T *rettv;
8331 float_T f;
8333 rettv->v_type = VAR_FLOAT;
8334 if (get_float_arg(argvars, &f) == OK)
8335 rettv->vval.v_float = atan(f);
8336 else
8337 rettv->vval.v_float = 0.0;
8339 #endif
8342 * "browse(save, title, initdir, default)" function
8344 /* ARGSUSED */
8345 static void
8346 f_browse(argvars, rettv)
8347 typval_T *argvars;
8348 typval_T *rettv;
8350 #ifdef FEAT_BROWSE
8351 int save;
8352 char_u *title;
8353 char_u *initdir;
8354 char_u *defname;
8355 char_u buf[NUMBUFLEN];
8356 char_u buf2[NUMBUFLEN];
8357 int error = FALSE;
8359 save = get_tv_number_chk(&argvars[0], &error);
8360 title = get_tv_string_chk(&argvars[1]);
8361 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8362 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8364 if (error || title == NULL || initdir == NULL || defname == NULL)
8365 rettv->vval.v_string = NULL;
8366 else
8367 rettv->vval.v_string =
8368 do_browse(save ? BROWSE_SAVE : 0,
8369 title, defname, NULL, initdir, NULL, curbuf);
8370 #else
8371 rettv->vval.v_string = NULL;
8372 #endif
8373 rettv->v_type = VAR_STRING;
8377 * "browsedir(title, initdir)" function
8379 /* ARGSUSED */
8380 static void
8381 f_browsedir(argvars, rettv)
8382 typval_T *argvars;
8383 typval_T *rettv;
8385 #ifdef FEAT_BROWSE
8386 char_u *title;
8387 char_u *initdir;
8388 char_u buf[NUMBUFLEN];
8390 title = get_tv_string_chk(&argvars[0]);
8391 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8393 if (title == NULL || initdir == NULL)
8394 rettv->vval.v_string = NULL;
8395 else
8396 rettv->vval.v_string = do_browse(BROWSE_DIR,
8397 title, NULL, NULL, initdir, NULL, curbuf);
8398 #else
8399 rettv->vval.v_string = NULL;
8400 #endif
8401 rettv->v_type = VAR_STRING;
8404 static buf_T *find_buffer __ARGS((typval_T *avar));
8407 * Find a buffer by number or exact name.
8409 static buf_T *
8410 find_buffer(avar)
8411 typval_T *avar;
8413 buf_T *buf = NULL;
8415 if (avar->v_type == VAR_NUMBER)
8416 buf = buflist_findnr((int)avar->vval.v_number);
8417 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8419 buf = buflist_findname_exp(avar->vval.v_string);
8420 if (buf == NULL)
8422 /* No full path name match, try a match with a URL or a "nofile"
8423 * buffer, these don't use the full path. */
8424 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8425 if (buf->b_fname != NULL
8426 && (path_with_url(buf->b_fname)
8427 #ifdef FEAT_QUICKFIX
8428 || bt_nofile(buf)
8429 #endif
8431 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8432 break;
8435 return buf;
8439 * "bufexists(expr)" function
8441 static void
8442 f_bufexists(argvars, rettv)
8443 typval_T *argvars;
8444 typval_T *rettv;
8446 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8450 * "buflisted(expr)" function
8452 static void
8453 f_buflisted(argvars, rettv)
8454 typval_T *argvars;
8455 typval_T *rettv;
8457 buf_T *buf;
8459 buf = find_buffer(&argvars[0]);
8460 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8464 * "bufloaded(expr)" function
8466 static void
8467 f_bufloaded(argvars, rettv)
8468 typval_T *argvars;
8469 typval_T *rettv;
8471 buf_T *buf;
8473 buf = find_buffer(&argvars[0]);
8474 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8477 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8480 * Get buffer by number or pattern.
8482 static buf_T *
8483 get_buf_tv(tv)
8484 typval_T *tv;
8486 char_u *name = tv->vval.v_string;
8487 int save_magic;
8488 char_u *save_cpo;
8489 buf_T *buf;
8491 if (tv->v_type == VAR_NUMBER)
8492 return buflist_findnr((int)tv->vval.v_number);
8493 if (tv->v_type != VAR_STRING)
8494 return NULL;
8495 if (name == NULL || *name == NUL)
8496 return curbuf;
8497 if (name[0] == '$' && name[1] == NUL)
8498 return lastbuf;
8500 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8501 save_magic = p_magic;
8502 p_magic = TRUE;
8503 save_cpo = p_cpo;
8504 p_cpo = (char_u *)"";
8506 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8507 TRUE, FALSE));
8509 p_magic = save_magic;
8510 p_cpo = save_cpo;
8512 /* If not found, try expanding the name, like done for bufexists(). */
8513 if (buf == NULL)
8514 buf = find_buffer(tv);
8516 return buf;
8520 * "bufname(expr)" function
8522 static void
8523 f_bufname(argvars, rettv)
8524 typval_T *argvars;
8525 typval_T *rettv;
8527 buf_T *buf;
8529 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8530 ++emsg_off;
8531 buf = get_buf_tv(&argvars[0]);
8532 rettv->v_type = VAR_STRING;
8533 if (buf != NULL && buf->b_fname != NULL)
8534 rettv->vval.v_string = vim_strsave(buf->b_fname);
8535 else
8536 rettv->vval.v_string = NULL;
8537 --emsg_off;
8541 * "bufnr(expr)" function
8543 static void
8544 f_bufnr(argvars, rettv)
8545 typval_T *argvars;
8546 typval_T *rettv;
8548 buf_T *buf;
8549 int error = FALSE;
8550 char_u *name;
8552 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8553 ++emsg_off;
8554 buf = get_buf_tv(&argvars[0]);
8555 --emsg_off;
8557 /* If the buffer isn't found and the second argument is not zero create a
8558 * new buffer. */
8559 if (buf == NULL
8560 && argvars[1].v_type != VAR_UNKNOWN
8561 && get_tv_number_chk(&argvars[1], &error) != 0
8562 && !error
8563 && (name = get_tv_string_chk(&argvars[0])) != NULL
8564 && !error)
8565 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8567 if (buf != NULL)
8568 rettv->vval.v_number = buf->b_fnum;
8569 else
8570 rettv->vval.v_number = -1;
8574 * "bufwinnr(nr)" function
8576 static void
8577 f_bufwinnr(argvars, rettv)
8578 typval_T *argvars;
8579 typval_T *rettv;
8581 #ifdef FEAT_WINDOWS
8582 win_T *wp;
8583 int winnr = 0;
8584 #endif
8585 buf_T *buf;
8587 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8588 ++emsg_off;
8589 buf = get_buf_tv(&argvars[0]);
8590 #ifdef FEAT_WINDOWS
8591 for (wp = firstwin; wp; wp = wp->w_next)
8593 ++winnr;
8594 if (wp->w_buffer == buf)
8595 break;
8597 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8598 #else
8599 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8600 #endif
8601 --emsg_off;
8605 * "byte2line(byte)" function
8607 /*ARGSUSED*/
8608 static void
8609 f_byte2line(argvars, rettv)
8610 typval_T *argvars;
8611 typval_T *rettv;
8613 #ifndef FEAT_BYTEOFF
8614 rettv->vval.v_number = -1;
8615 #else
8616 long boff = 0;
8618 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8619 if (boff < 0)
8620 rettv->vval.v_number = -1;
8621 else
8622 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8623 (linenr_T)0, &boff);
8624 #endif
8628 * "byteidx()" function
8630 /*ARGSUSED*/
8631 static void
8632 f_byteidx(argvars, rettv)
8633 typval_T *argvars;
8634 typval_T *rettv;
8636 #ifdef FEAT_MBYTE
8637 char_u *t;
8638 #endif
8639 char_u *str;
8640 long idx;
8642 str = get_tv_string_chk(&argvars[0]);
8643 idx = get_tv_number_chk(&argvars[1], NULL);
8644 rettv->vval.v_number = -1;
8645 if (str == NULL || idx < 0)
8646 return;
8648 #ifdef FEAT_MBYTE
8649 t = str;
8650 for ( ; idx > 0; idx--)
8652 if (*t == NUL) /* EOL reached */
8653 return;
8654 t += (*mb_ptr2len)(t);
8656 rettv->vval.v_number = (varnumber_T)(t - str);
8657 #else
8658 if ((size_t)idx <= STRLEN(str))
8659 rettv->vval.v_number = idx;
8660 #endif
8664 * "call(func, arglist)" function
8666 static void
8667 f_call(argvars, rettv)
8668 typval_T *argvars;
8669 typval_T *rettv;
8671 char_u *func;
8672 typval_T argv[MAX_FUNC_ARGS + 1];
8673 int argc = 0;
8674 listitem_T *item;
8675 int dummy;
8676 dict_T *selfdict = NULL;
8678 rettv->vval.v_number = 0;
8679 if (argvars[1].v_type != VAR_LIST)
8681 EMSG(_(e_listreq));
8682 return;
8684 if (argvars[1].vval.v_list == NULL)
8685 return;
8687 if (argvars[0].v_type == VAR_FUNC)
8688 func = argvars[0].vval.v_string;
8689 else
8690 func = get_tv_string(&argvars[0]);
8691 if (*func == NUL)
8692 return; /* type error or empty name */
8694 if (argvars[2].v_type != VAR_UNKNOWN)
8696 if (argvars[2].v_type != VAR_DICT)
8698 EMSG(_(e_dictreq));
8699 return;
8701 selfdict = argvars[2].vval.v_dict;
8704 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8705 item = item->li_next)
8707 if (argc == MAX_FUNC_ARGS)
8709 EMSG(_("E699: Too many arguments"));
8710 break;
8712 /* Make a copy of each argument. This is needed to be able to set
8713 * v_lock to VAR_FIXED in the copy without changing the original list.
8715 copy_tv(&item->li_tv, &argv[argc++]);
8718 if (item == NULL)
8719 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8720 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8721 &dummy, TRUE, selfdict);
8723 /* Free the arguments. */
8724 while (argc > 0)
8725 clear_tv(&argv[--argc]);
8728 #ifdef FEAT_FLOAT
8730 * "ceil({float})" function
8732 static void
8733 f_ceil(argvars, rettv)
8734 typval_T *argvars;
8735 typval_T *rettv;
8737 float_T f;
8739 rettv->v_type = VAR_FLOAT;
8740 if (get_float_arg(argvars, &f) == OK)
8741 rettv->vval.v_float = ceil(f);
8742 else
8743 rettv->vval.v_float = 0.0;
8745 #endif
8748 * "changenr()" function
8750 /*ARGSUSED*/
8751 static void
8752 f_changenr(argvars, rettv)
8753 typval_T *argvars;
8754 typval_T *rettv;
8756 rettv->vval.v_number = curbuf->b_u_seq_cur;
8760 * "char2nr(string)" function
8762 static void
8763 f_char2nr(argvars, rettv)
8764 typval_T *argvars;
8765 typval_T *rettv;
8767 #ifdef FEAT_MBYTE
8768 if (has_mbyte)
8769 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8770 else
8771 #endif
8772 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8776 * "cindent(lnum)" function
8778 static void
8779 f_cindent(argvars, rettv)
8780 typval_T *argvars;
8781 typval_T *rettv;
8783 #ifdef FEAT_CINDENT
8784 pos_T pos;
8785 linenr_T lnum;
8787 pos = curwin->w_cursor;
8788 lnum = get_tv_lnum(argvars);
8789 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8791 curwin->w_cursor.lnum = lnum;
8792 rettv->vval.v_number = get_c_indent();
8793 curwin->w_cursor = pos;
8795 else
8796 #endif
8797 rettv->vval.v_number = -1;
8801 * "clearmatches()" function
8803 /*ARGSUSED*/
8804 static void
8805 f_clearmatches(argvars, rettv)
8806 typval_T *argvars;
8807 typval_T *rettv;
8809 #ifdef FEAT_SEARCH_EXTRA
8810 clear_matches(curwin);
8811 #endif
8815 * "col(string)" function
8817 static void
8818 f_col(argvars, rettv)
8819 typval_T *argvars;
8820 typval_T *rettv;
8822 colnr_T col = 0;
8823 pos_T *fp;
8824 int fnum = curbuf->b_fnum;
8826 fp = var2fpos(&argvars[0], FALSE, &fnum);
8827 if (fp != NULL && fnum == curbuf->b_fnum)
8829 if (fp->col == MAXCOL)
8831 /* '> can be MAXCOL, get the length of the line then */
8832 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8833 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8834 else
8835 col = MAXCOL;
8837 else
8839 col = fp->col + 1;
8840 #ifdef FEAT_VIRTUALEDIT
8841 /* col(".") when the cursor is on the NUL at the end of the line
8842 * because of "coladd" can be seen as an extra column. */
8843 if (virtual_active() && fp == &curwin->w_cursor)
8845 char_u *p = ml_get_cursor();
8847 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8848 curwin->w_virtcol - curwin->w_cursor.coladd))
8850 # ifdef FEAT_MBYTE
8851 int l;
8853 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8854 col += l;
8855 # else
8856 if (*p != NUL && p[1] == NUL)
8857 ++col;
8858 # endif
8861 #endif
8864 rettv->vval.v_number = col;
8867 #if defined(FEAT_INS_EXPAND)
8869 * "complete()" function
8871 /*ARGSUSED*/
8872 static void
8873 f_complete(argvars, rettv)
8874 typval_T *argvars;
8875 typval_T *rettv;
8877 int startcol;
8879 if ((State & INSERT) == 0)
8881 EMSG(_("E785: complete() can only be used in Insert mode"));
8882 return;
8885 /* Check for undo allowed here, because if something was already inserted
8886 * the line was already saved for undo and this check isn't done. */
8887 if (!undo_allowed())
8888 return;
8890 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8892 EMSG(_(e_invarg));
8893 return;
8896 startcol = get_tv_number_chk(&argvars[0], NULL);
8897 if (startcol <= 0)
8898 return;
8900 set_completion(startcol - 1, argvars[1].vval.v_list);
8904 * "complete_add()" function
8906 /*ARGSUSED*/
8907 static void
8908 f_complete_add(argvars, rettv)
8909 typval_T *argvars;
8910 typval_T *rettv;
8912 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8916 * "complete_check()" function
8918 /*ARGSUSED*/
8919 static void
8920 f_complete_check(argvars, rettv)
8921 typval_T *argvars;
8922 typval_T *rettv;
8924 int saved = RedrawingDisabled;
8926 RedrawingDisabled = 0;
8927 ins_compl_check_keys(0);
8928 rettv->vval.v_number = compl_interrupted;
8929 RedrawingDisabled = saved;
8931 #endif
8934 * "confirm(message, buttons[, default [, type]])" function
8936 /*ARGSUSED*/
8937 static void
8938 f_confirm(argvars, rettv)
8939 typval_T *argvars;
8940 typval_T *rettv;
8942 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
8943 char_u *message;
8944 char_u *buttons = NULL;
8945 char_u buf[NUMBUFLEN];
8946 char_u buf2[NUMBUFLEN];
8947 int def = 1;
8948 int type = VIM_GENERIC;
8949 char_u *typestr;
8950 int error = FALSE;
8952 message = get_tv_string_chk(&argvars[0]);
8953 if (message == NULL)
8954 error = TRUE;
8955 if (argvars[1].v_type != VAR_UNKNOWN)
8957 buttons = get_tv_string_buf_chk(&argvars[1], buf);
8958 if (buttons == NULL)
8959 error = TRUE;
8960 if (argvars[2].v_type != VAR_UNKNOWN)
8962 def = get_tv_number_chk(&argvars[2], &error);
8963 if (argvars[3].v_type != VAR_UNKNOWN)
8965 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
8966 if (typestr == NULL)
8967 error = TRUE;
8968 else
8970 switch (TOUPPER_ASC(*typestr))
8972 case 'E': type = VIM_ERROR; break;
8973 case 'Q': type = VIM_QUESTION; break;
8974 case 'I': type = VIM_INFO; break;
8975 case 'W': type = VIM_WARNING; break;
8976 case 'G': type = VIM_GENERIC; break;
8983 if (buttons == NULL || *buttons == NUL)
8984 buttons = (char_u *)_("&Ok");
8986 if (error)
8987 rettv->vval.v_number = 0;
8988 else
8989 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
8990 def, NULL);
8991 #else
8992 rettv->vval.v_number = 0;
8993 #endif
8997 * "copy()" function
8999 static void
9000 f_copy(argvars, rettv)
9001 typval_T *argvars;
9002 typval_T *rettv;
9004 item_copy(&argvars[0], rettv, FALSE, 0);
9007 #ifdef FEAT_FLOAT
9009 * "cos()" function
9011 static void
9012 f_cos(argvars, rettv)
9013 typval_T *argvars;
9014 typval_T *rettv;
9016 float_T f;
9018 rettv->v_type = VAR_FLOAT;
9019 if (get_float_arg(argvars, &f) == OK)
9020 rettv->vval.v_float = cos(f);
9021 else
9022 rettv->vval.v_float = 0.0;
9024 #endif
9027 * "count()" function
9029 static void
9030 f_count(argvars, rettv)
9031 typval_T *argvars;
9032 typval_T *rettv;
9034 long n = 0;
9035 int ic = FALSE;
9037 if (argvars[0].v_type == VAR_LIST)
9039 listitem_T *li;
9040 list_T *l;
9041 long idx;
9043 if ((l = argvars[0].vval.v_list) != NULL)
9045 li = l->lv_first;
9046 if (argvars[2].v_type != VAR_UNKNOWN)
9048 int error = FALSE;
9050 ic = get_tv_number_chk(&argvars[2], &error);
9051 if (argvars[3].v_type != VAR_UNKNOWN)
9053 idx = get_tv_number_chk(&argvars[3], &error);
9054 if (!error)
9056 li = list_find(l, idx);
9057 if (li == NULL)
9058 EMSGN(_(e_listidx), idx);
9061 if (error)
9062 li = NULL;
9065 for ( ; li != NULL; li = li->li_next)
9066 if (tv_equal(&li->li_tv, &argvars[1], ic))
9067 ++n;
9070 else if (argvars[0].v_type == VAR_DICT)
9072 int todo;
9073 dict_T *d;
9074 hashitem_T *hi;
9076 if ((d = argvars[0].vval.v_dict) != NULL)
9078 int error = FALSE;
9080 if (argvars[2].v_type != VAR_UNKNOWN)
9082 ic = get_tv_number_chk(&argvars[2], &error);
9083 if (argvars[3].v_type != VAR_UNKNOWN)
9084 EMSG(_(e_invarg));
9087 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9088 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9090 if (!HASHITEM_EMPTY(hi))
9092 --todo;
9093 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9094 ++n;
9099 else
9100 EMSG2(_(e_listdictarg), "count()");
9101 rettv->vval.v_number = n;
9105 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9107 * Checks the existence of a cscope connection.
9109 /*ARGSUSED*/
9110 static void
9111 f_cscope_connection(argvars, rettv)
9112 typval_T *argvars;
9113 typval_T *rettv;
9115 #ifdef FEAT_CSCOPE
9116 int num = 0;
9117 char_u *dbpath = NULL;
9118 char_u *prepend = NULL;
9119 char_u buf[NUMBUFLEN];
9121 if (argvars[0].v_type != VAR_UNKNOWN
9122 && argvars[1].v_type != VAR_UNKNOWN)
9124 num = (int)get_tv_number(&argvars[0]);
9125 dbpath = get_tv_string(&argvars[1]);
9126 if (argvars[2].v_type != VAR_UNKNOWN)
9127 prepend = get_tv_string_buf(&argvars[2], buf);
9130 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9131 #else
9132 rettv->vval.v_number = 0;
9133 #endif
9137 * "cursor(lnum, col)" function
9139 * Moves the cursor to the specified line and column
9141 /*ARGSUSED*/
9142 static void
9143 f_cursor(argvars, rettv)
9144 typval_T *argvars;
9145 typval_T *rettv;
9147 long line, col;
9148 #ifdef FEAT_VIRTUALEDIT
9149 long coladd = 0;
9150 #endif
9152 if (argvars[1].v_type == VAR_UNKNOWN)
9154 pos_T pos;
9156 if (list2fpos(argvars, &pos, NULL) == FAIL)
9157 return;
9158 line = pos.lnum;
9159 col = pos.col;
9160 #ifdef FEAT_VIRTUALEDIT
9161 coladd = pos.coladd;
9162 #endif
9164 else
9166 line = get_tv_lnum(argvars);
9167 col = get_tv_number_chk(&argvars[1], NULL);
9168 #ifdef FEAT_VIRTUALEDIT
9169 if (argvars[2].v_type != VAR_UNKNOWN)
9170 coladd = get_tv_number_chk(&argvars[2], NULL);
9171 #endif
9173 if (line < 0 || col < 0
9174 #ifdef FEAT_VIRTUALEDIT
9175 || coladd < 0
9176 #endif
9178 return; /* type error; errmsg already given */
9179 if (line > 0)
9180 curwin->w_cursor.lnum = line;
9181 if (col > 0)
9182 curwin->w_cursor.col = col - 1;
9183 #ifdef FEAT_VIRTUALEDIT
9184 curwin->w_cursor.coladd = coladd;
9185 #endif
9187 /* Make sure the cursor is in a valid position. */
9188 check_cursor();
9189 #ifdef FEAT_MBYTE
9190 /* Correct cursor for multi-byte character. */
9191 if (has_mbyte)
9192 mb_adjust_cursor();
9193 #endif
9195 curwin->w_set_curswant = TRUE;
9199 * "deepcopy()" function
9201 static void
9202 f_deepcopy(argvars, rettv)
9203 typval_T *argvars;
9204 typval_T *rettv;
9206 int noref = 0;
9208 if (argvars[1].v_type != VAR_UNKNOWN)
9209 noref = get_tv_number_chk(&argvars[1], NULL);
9210 if (noref < 0 || noref > 1)
9211 EMSG(_(e_invarg));
9212 else
9213 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9217 * "delete()" function
9219 static void
9220 f_delete(argvars, rettv)
9221 typval_T *argvars;
9222 typval_T *rettv;
9224 if (check_restricted() || check_secure())
9225 rettv->vval.v_number = -1;
9226 else
9227 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9231 * "did_filetype()" function
9233 /*ARGSUSED*/
9234 static void
9235 f_did_filetype(argvars, rettv)
9236 typval_T *argvars;
9237 typval_T *rettv;
9239 #ifdef FEAT_AUTOCMD
9240 rettv->vval.v_number = did_filetype;
9241 #else
9242 rettv->vval.v_number = 0;
9243 #endif
9247 * "diff_filler()" function
9249 /*ARGSUSED*/
9250 static void
9251 f_diff_filler(argvars, rettv)
9252 typval_T *argvars;
9253 typval_T *rettv;
9255 #ifdef FEAT_DIFF
9256 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9257 #endif
9261 * "diff_hlID()" function
9263 /*ARGSUSED*/
9264 static void
9265 f_diff_hlID(argvars, rettv)
9266 typval_T *argvars;
9267 typval_T *rettv;
9269 #ifdef FEAT_DIFF
9270 linenr_T lnum = get_tv_lnum(argvars);
9271 static linenr_T prev_lnum = 0;
9272 static int changedtick = 0;
9273 static int fnum = 0;
9274 static int change_start = 0;
9275 static int change_end = 0;
9276 static hlf_T hlID = (hlf_T)0;
9277 int filler_lines;
9278 int col;
9280 if (lnum < 0) /* ignore type error in {lnum} arg */
9281 lnum = 0;
9282 if (lnum != prev_lnum
9283 || changedtick != curbuf->b_changedtick
9284 || fnum != curbuf->b_fnum)
9286 /* New line, buffer, change: need to get the values. */
9287 filler_lines = diff_check(curwin, lnum);
9288 if (filler_lines < 0)
9290 if (filler_lines == -1)
9292 change_start = MAXCOL;
9293 change_end = -1;
9294 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9295 hlID = HLF_ADD; /* added line */
9296 else
9297 hlID = HLF_CHD; /* changed line */
9299 else
9300 hlID = HLF_ADD; /* added line */
9302 else
9303 hlID = (hlf_T)0;
9304 prev_lnum = lnum;
9305 changedtick = curbuf->b_changedtick;
9306 fnum = curbuf->b_fnum;
9309 if (hlID == HLF_CHD || hlID == HLF_TXD)
9311 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9312 if (col >= change_start && col <= change_end)
9313 hlID = HLF_TXD; /* changed text */
9314 else
9315 hlID = HLF_CHD; /* changed line */
9317 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9318 #endif
9322 * "empty({expr})" function
9324 static void
9325 f_empty(argvars, rettv)
9326 typval_T *argvars;
9327 typval_T *rettv;
9329 int n;
9331 switch (argvars[0].v_type)
9333 case VAR_STRING:
9334 case VAR_FUNC:
9335 n = argvars[0].vval.v_string == NULL
9336 || *argvars[0].vval.v_string == NUL;
9337 break;
9338 case VAR_NUMBER:
9339 n = argvars[0].vval.v_number == 0;
9340 break;
9341 #ifdef FEAT_FLOAT
9342 case VAR_FLOAT:
9343 n = argvars[0].vval.v_float == 0.0;
9344 break;
9345 #endif
9346 case VAR_LIST:
9347 n = argvars[0].vval.v_list == NULL
9348 || argvars[0].vval.v_list->lv_first == NULL;
9349 break;
9350 case VAR_DICT:
9351 n = argvars[0].vval.v_dict == NULL
9352 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9353 break;
9354 default:
9355 EMSG2(_(e_intern2), "f_empty()");
9356 n = 0;
9359 rettv->vval.v_number = n;
9363 * "escape({string}, {chars})" function
9365 static void
9366 f_escape(argvars, rettv)
9367 typval_T *argvars;
9368 typval_T *rettv;
9370 char_u buf[NUMBUFLEN];
9372 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9373 get_tv_string_buf(&argvars[1], buf));
9374 rettv->v_type = VAR_STRING;
9378 * "eval()" function
9380 /*ARGSUSED*/
9381 static void
9382 f_eval(argvars, rettv)
9383 typval_T *argvars;
9384 typval_T *rettv;
9386 char_u *s;
9388 s = get_tv_string_chk(&argvars[0]);
9389 if (s != NULL)
9390 s = skipwhite(s);
9392 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9394 rettv->v_type = VAR_NUMBER;
9395 rettv->vval.v_number = 0;
9397 else if (*s != NUL)
9398 EMSG(_(e_trailing));
9402 * "eventhandler()" function
9404 /*ARGSUSED*/
9405 static void
9406 f_eventhandler(argvars, rettv)
9407 typval_T *argvars;
9408 typval_T *rettv;
9410 rettv->vval.v_number = vgetc_busy;
9414 * "executable()" function
9416 static void
9417 f_executable(argvars, rettv)
9418 typval_T *argvars;
9419 typval_T *rettv;
9421 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9425 * "exists()" function
9427 static void
9428 f_exists(argvars, rettv)
9429 typval_T *argvars;
9430 typval_T *rettv;
9432 char_u *p;
9433 char_u *name;
9434 int n = FALSE;
9435 int len = 0;
9437 p = get_tv_string(&argvars[0]);
9438 if (*p == '$') /* environment variable */
9440 /* first try "normal" environment variables (fast) */
9441 if (mch_getenv(p + 1) != NULL)
9442 n = TRUE;
9443 else
9445 /* try expanding things like $VIM and ${HOME} */
9446 p = expand_env_save(p);
9447 if (p != NULL && *p != '$')
9448 n = TRUE;
9449 vim_free(p);
9452 else if (*p == '&' || *p == '+') /* option */
9454 n = (get_option_tv(&p, NULL, TRUE) == OK);
9455 if (*skipwhite(p) != NUL)
9456 n = FALSE; /* trailing garbage */
9458 else if (*p == '*') /* internal or user defined function */
9460 n = function_exists(p + 1);
9462 else if (*p == ':')
9464 n = cmd_exists(p + 1);
9466 else if (*p == '#')
9468 #ifdef FEAT_AUTOCMD
9469 if (p[1] == '#')
9470 n = autocmd_supported(p + 2);
9471 else
9472 n = au_exists(p + 1);
9473 #endif
9475 else /* internal variable */
9477 char_u *tofree;
9478 typval_T tv;
9480 /* get_name_len() takes care of expanding curly braces */
9481 name = p;
9482 len = get_name_len(&p, &tofree, TRUE, FALSE);
9483 if (len > 0)
9485 if (tofree != NULL)
9486 name = tofree;
9487 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9488 if (n)
9490 /* handle d.key, l[idx], f(expr) */
9491 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9492 if (n)
9493 clear_tv(&tv);
9496 if (*p != NUL)
9497 n = FALSE;
9499 vim_free(tofree);
9502 rettv->vval.v_number = n;
9506 * "expand()" function
9508 static void
9509 f_expand(argvars, rettv)
9510 typval_T *argvars;
9511 typval_T *rettv;
9513 char_u *s;
9514 int len;
9515 char_u *errormsg;
9516 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9517 expand_T xpc;
9518 int error = FALSE;
9520 rettv->v_type = VAR_STRING;
9521 s = get_tv_string(&argvars[0]);
9522 if (*s == '%' || *s == '#' || *s == '<')
9524 ++emsg_off;
9525 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9526 --emsg_off;
9528 else
9530 /* When the optional second argument is non-zero, don't remove matches
9531 * for 'suffixes' and 'wildignore' */
9532 if (argvars[1].v_type != VAR_UNKNOWN
9533 && get_tv_number_chk(&argvars[1], &error))
9534 flags |= WILD_KEEP_ALL;
9535 if (!error)
9537 ExpandInit(&xpc);
9538 xpc.xp_context = EXPAND_FILES;
9539 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9541 else
9542 rettv->vval.v_string = NULL;
9547 * "extend(list, list [, idx])" function
9548 * "extend(dict, dict [, action])" function
9550 static void
9551 f_extend(argvars, rettv)
9552 typval_T *argvars;
9553 typval_T *rettv;
9555 rettv->vval.v_number = 0;
9556 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9558 list_T *l1, *l2;
9559 listitem_T *item;
9560 long before;
9561 int error = FALSE;
9563 l1 = argvars[0].vval.v_list;
9564 l2 = argvars[1].vval.v_list;
9565 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9566 && l2 != NULL)
9568 if (argvars[2].v_type != VAR_UNKNOWN)
9570 before = get_tv_number_chk(&argvars[2], &error);
9571 if (error)
9572 return; /* type error; errmsg already given */
9574 if (before == l1->lv_len)
9575 item = NULL;
9576 else
9578 item = list_find(l1, before);
9579 if (item == NULL)
9581 EMSGN(_(e_listidx), before);
9582 return;
9586 else
9587 item = NULL;
9588 list_extend(l1, l2, item);
9590 copy_tv(&argvars[0], rettv);
9593 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9595 dict_T *d1, *d2;
9596 dictitem_T *di1;
9597 char_u *action;
9598 int i;
9599 hashitem_T *hi2;
9600 int todo;
9602 d1 = argvars[0].vval.v_dict;
9603 d2 = argvars[1].vval.v_dict;
9604 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9605 && d2 != NULL)
9607 /* Check the third argument. */
9608 if (argvars[2].v_type != VAR_UNKNOWN)
9610 static char *(av[]) = {"keep", "force", "error"};
9612 action = get_tv_string_chk(&argvars[2]);
9613 if (action == NULL)
9614 return; /* type error; errmsg already given */
9615 for (i = 0; i < 3; ++i)
9616 if (STRCMP(action, av[i]) == 0)
9617 break;
9618 if (i == 3)
9620 EMSG2(_(e_invarg2), action);
9621 return;
9624 else
9625 action = (char_u *)"force";
9627 /* Go over all entries in the second dict and add them to the
9628 * first dict. */
9629 todo = (int)d2->dv_hashtab.ht_used;
9630 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9632 if (!HASHITEM_EMPTY(hi2))
9634 --todo;
9635 di1 = dict_find(d1, hi2->hi_key, -1);
9636 if (di1 == NULL)
9638 di1 = dictitem_copy(HI2DI(hi2));
9639 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9640 dictitem_free(di1);
9642 else if (*action == 'e')
9644 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9645 break;
9647 else if (*action == 'f')
9649 clear_tv(&di1->di_tv);
9650 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9655 copy_tv(&argvars[0], rettv);
9658 else
9659 EMSG2(_(e_listdictarg), "extend()");
9663 * "feedkeys()" function
9665 /*ARGSUSED*/
9666 static void
9667 f_feedkeys(argvars, rettv)
9668 typval_T *argvars;
9669 typval_T *rettv;
9671 int remap = TRUE;
9672 char_u *keys, *flags;
9673 char_u nbuf[NUMBUFLEN];
9674 int typed = FALSE;
9675 char_u *keys_esc;
9677 /* This is not allowed in the sandbox. If the commands would still be
9678 * executed in the sandbox it would be OK, but it probably happens later,
9679 * when "sandbox" is no longer set. */
9680 if (check_secure())
9681 return;
9683 rettv->vval.v_number = 0;
9684 keys = get_tv_string(&argvars[0]);
9685 if (*keys != NUL)
9687 if (argvars[1].v_type != VAR_UNKNOWN)
9689 flags = get_tv_string_buf(&argvars[1], nbuf);
9690 for ( ; *flags != NUL; ++flags)
9692 switch (*flags)
9694 case 'n': remap = FALSE; break;
9695 case 'm': remap = TRUE; break;
9696 case 't': typed = TRUE; break;
9701 /* Need to escape K_SPECIAL and CSI before putting the string in the
9702 * typeahead buffer. */
9703 keys_esc = vim_strsave_escape_csi(keys);
9704 if (keys_esc != NULL)
9706 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9707 typebuf.tb_len, !typed, FALSE);
9708 vim_free(keys_esc);
9709 if (vgetc_busy)
9710 typebuf_was_filled = TRUE;
9716 * "filereadable()" function
9718 static void
9719 f_filereadable(argvars, rettv)
9720 typval_T *argvars;
9721 typval_T *rettv;
9723 int fd;
9724 char_u *p;
9725 int n;
9727 #ifndef O_NONBLOCK
9728 # define O_NONBLOCK 0
9729 #endif
9730 p = get_tv_string(&argvars[0]);
9731 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9732 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9734 n = TRUE;
9735 close(fd);
9737 else
9738 n = FALSE;
9740 rettv->vval.v_number = n;
9744 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9745 * rights to write into.
9747 static void
9748 f_filewritable(argvars, rettv)
9749 typval_T *argvars;
9750 typval_T *rettv;
9752 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9755 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9757 static void
9758 findfilendir(argvars, rettv, find_what)
9759 typval_T *argvars;
9760 typval_T *rettv;
9761 int find_what;
9763 #ifdef FEAT_SEARCHPATH
9764 char_u *fname;
9765 char_u *fresult = NULL;
9766 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9767 char_u *p;
9768 char_u pathbuf[NUMBUFLEN];
9769 int count = 1;
9770 int first = TRUE;
9771 int error = FALSE;
9772 #endif
9774 rettv->vval.v_string = NULL;
9775 rettv->v_type = VAR_STRING;
9777 #ifdef FEAT_SEARCHPATH
9778 fname = get_tv_string(&argvars[0]);
9780 if (argvars[1].v_type != VAR_UNKNOWN)
9782 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9783 if (p == NULL)
9784 error = TRUE;
9785 else
9787 if (*p != NUL)
9788 path = p;
9790 if (argvars[2].v_type != VAR_UNKNOWN)
9791 count = get_tv_number_chk(&argvars[2], &error);
9795 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9796 error = TRUE;
9798 if (*fname != NUL && !error)
9802 if (rettv->v_type == VAR_STRING)
9803 vim_free(fresult);
9804 fresult = find_file_in_path_option(first ? fname : NULL,
9805 first ? (int)STRLEN(fname) : 0,
9806 0, first, path,
9807 find_what,
9808 curbuf->b_ffname,
9809 find_what == FINDFILE_DIR
9810 ? (char_u *)"" : curbuf->b_p_sua);
9811 first = FALSE;
9813 if (fresult != NULL && rettv->v_type == VAR_LIST)
9814 list_append_string(rettv->vval.v_list, fresult, -1);
9816 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9819 if (rettv->v_type == VAR_STRING)
9820 rettv->vval.v_string = fresult;
9821 #endif
9824 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9825 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9828 * Implementation of map() and filter().
9830 static void
9831 filter_map(argvars, rettv, map)
9832 typval_T *argvars;
9833 typval_T *rettv;
9834 int map;
9836 char_u buf[NUMBUFLEN];
9837 char_u *expr;
9838 listitem_T *li, *nli;
9839 list_T *l = NULL;
9840 dictitem_T *di;
9841 hashtab_T *ht;
9842 hashitem_T *hi;
9843 dict_T *d = NULL;
9844 typval_T save_val;
9845 typval_T save_key;
9846 int rem;
9847 int todo;
9848 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9849 int save_did_emsg;
9851 rettv->vval.v_number = 0;
9852 if (argvars[0].v_type == VAR_LIST)
9854 if ((l = argvars[0].vval.v_list) == NULL
9855 || (map && tv_check_lock(l->lv_lock, ermsg)))
9856 return;
9858 else if (argvars[0].v_type == VAR_DICT)
9860 if ((d = argvars[0].vval.v_dict) == NULL
9861 || (map && tv_check_lock(d->dv_lock, ermsg)))
9862 return;
9864 else
9866 EMSG2(_(e_listdictarg), ermsg);
9867 return;
9870 expr = get_tv_string_buf_chk(&argvars[1], buf);
9871 /* On type errors, the preceding call has already displayed an error
9872 * message. Avoid a misleading error message for an empty string that
9873 * was not passed as argument. */
9874 if (expr != NULL)
9876 prepare_vimvar(VV_VAL, &save_val);
9877 expr = skipwhite(expr);
9879 /* We reset "did_emsg" to be able to detect whether an error
9880 * occurred during evaluation of the expression. */
9881 save_did_emsg = did_emsg;
9882 did_emsg = FALSE;
9884 if (argvars[0].v_type == VAR_DICT)
9886 prepare_vimvar(VV_KEY, &save_key);
9887 vimvars[VV_KEY].vv_type = VAR_STRING;
9889 ht = &d->dv_hashtab;
9890 hash_lock(ht);
9891 todo = (int)ht->ht_used;
9892 for (hi = ht->ht_array; todo > 0; ++hi)
9894 if (!HASHITEM_EMPTY(hi))
9896 --todo;
9897 di = HI2DI(hi);
9898 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9899 break;
9900 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9901 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9902 || did_emsg)
9903 break;
9904 if (!map && rem)
9905 dictitem_remove(d, di);
9906 clear_tv(&vimvars[VV_KEY].vv_tv);
9909 hash_unlock(ht);
9911 restore_vimvar(VV_KEY, &save_key);
9913 else
9915 for (li = l->lv_first; li != NULL; li = nli)
9917 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9918 break;
9919 nli = li->li_next;
9920 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9921 || did_emsg)
9922 break;
9923 if (!map && rem)
9924 listitem_remove(l, li);
9928 restore_vimvar(VV_VAL, &save_val);
9930 did_emsg |= save_did_emsg;
9933 copy_tv(&argvars[0], rettv);
9936 static int
9937 filter_map_one(tv, expr, map, remp)
9938 typval_T *tv;
9939 char_u *expr;
9940 int map;
9941 int *remp;
9943 typval_T rettv;
9944 char_u *s;
9945 int retval = FAIL;
9947 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
9948 s = expr;
9949 if (eval1(&s, &rettv, TRUE) == FAIL)
9950 goto theend;
9951 if (*s != NUL) /* check for trailing chars after expr */
9953 EMSG2(_(e_invexpr2), s);
9954 goto theend;
9956 if (map)
9958 /* map(): replace the list item value */
9959 clear_tv(tv);
9960 rettv.v_lock = 0;
9961 *tv = rettv;
9963 else
9965 int error = FALSE;
9967 /* filter(): when expr is zero remove the item */
9968 *remp = (get_tv_number_chk(&rettv, &error) == 0);
9969 clear_tv(&rettv);
9970 /* On type error, nothing has been removed; return FAIL to stop the
9971 * loop. The error message was given by get_tv_number_chk(). */
9972 if (error)
9973 goto theend;
9975 retval = OK;
9976 theend:
9977 clear_tv(&vimvars[VV_VAL].vv_tv);
9978 return retval;
9982 * "filter()" function
9984 static void
9985 f_filter(argvars, rettv)
9986 typval_T *argvars;
9987 typval_T *rettv;
9989 filter_map(argvars, rettv, FALSE);
9993 * "finddir({fname}[, {path}[, {count}]])" function
9995 static void
9996 f_finddir(argvars, rettv)
9997 typval_T *argvars;
9998 typval_T *rettv;
10000 findfilendir(argvars, rettv, FINDFILE_DIR);
10004 * "findfile({fname}[, {path}[, {count}]])" function
10006 static void
10007 f_findfile(argvars, rettv)
10008 typval_T *argvars;
10009 typval_T *rettv;
10011 findfilendir(argvars, rettv, FINDFILE_FILE);
10014 #ifdef FEAT_FLOAT
10016 * "float2nr({float})" function
10018 static void
10019 f_float2nr(argvars, rettv)
10020 typval_T *argvars;
10021 typval_T *rettv;
10023 float_T f;
10025 if (get_float_arg(argvars, &f) == OK)
10027 if (f < -0x7fffffff)
10028 rettv->vval.v_number = -0x7fffffff;
10029 else if (f > 0x7fffffff)
10030 rettv->vval.v_number = 0x7fffffff;
10031 else
10032 rettv->vval.v_number = (varnumber_T)f;
10034 else
10035 rettv->vval.v_number = 0;
10039 * "floor({float})" function
10041 static void
10042 f_floor(argvars, rettv)
10043 typval_T *argvars;
10044 typval_T *rettv;
10046 float_T f;
10048 rettv->v_type = VAR_FLOAT;
10049 if (get_float_arg(argvars, &f) == OK)
10050 rettv->vval.v_float = floor(f);
10051 else
10052 rettv->vval.v_float = 0.0;
10054 #endif
10057 * "fnameescape({string})" function
10059 static void
10060 f_fnameescape(argvars, rettv)
10061 typval_T *argvars;
10062 typval_T *rettv;
10064 rettv->vval.v_string = vim_strsave_fnameescape(
10065 get_tv_string(&argvars[0]), FALSE);
10066 rettv->v_type = VAR_STRING;
10070 * "fnamemodify({fname}, {mods})" function
10072 static void
10073 f_fnamemodify(argvars, rettv)
10074 typval_T *argvars;
10075 typval_T *rettv;
10077 char_u *fname;
10078 char_u *mods;
10079 int usedlen = 0;
10080 int len;
10081 char_u *fbuf = NULL;
10082 char_u buf[NUMBUFLEN];
10084 fname = get_tv_string_chk(&argvars[0]);
10085 mods = get_tv_string_buf_chk(&argvars[1], buf);
10086 if (fname == NULL || mods == NULL)
10087 fname = NULL;
10088 else
10090 len = (int)STRLEN(fname);
10091 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10094 rettv->v_type = VAR_STRING;
10095 if (fname == NULL)
10096 rettv->vval.v_string = NULL;
10097 else
10098 rettv->vval.v_string = vim_strnsave(fname, len);
10099 vim_free(fbuf);
10102 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10105 * "foldclosed()" function
10107 static void
10108 foldclosed_both(argvars, rettv, end)
10109 typval_T *argvars;
10110 typval_T *rettv;
10111 int end;
10113 #ifdef FEAT_FOLDING
10114 linenr_T lnum;
10115 linenr_T first, last;
10117 lnum = get_tv_lnum(argvars);
10118 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10120 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10122 if (end)
10123 rettv->vval.v_number = (varnumber_T)last;
10124 else
10125 rettv->vval.v_number = (varnumber_T)first;
10126 return;
10129 #endif
10130 rettv->vval.v_number = -1;
10134 * "foldclosed()" function
10136 static void
10137 f_foldclosed(argvars, rettv)
10138 typval_T *argvars;
10139 typval_T *rettv;
10141 foldclosed_both(argvars, rettv, FALSE);
10145 * "foldclosedend()" function
10147 static void
10148 f_foldclosedend(argvars, rettv)
10149 typval_T *argvars;
10150 typval_T *rettv;
10152 foldclosed_both(argvars, rettv, TRUE);
10156 * "foldlevel()" function
10158 static void
10159 f_foldlevel(argvars, rettv)
10160 typval_T *argvars;
10161 typval_T *rettv;
10163 #ifdef FEAT_FOLDING
10164 linenr_T lnum;
10166 lnum = get_tv_lnum(argvars);
10167 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10168 rettv->vval.v_number = foldLevel(lnum);
10169 else
10170 #endif
10171 rettv->vval.v_number = 0;
10175 * "foldtext()" function
10177 /*ARGSUSED*/
10178 static void
10179 f_foldtext(argvars, rettv)
10180 typval_T *argvars;
10181 typval_T *rettv;
10183 #ifdef FEAT_FOLDING
10184 linenr_T lnum;
10185 char_u *s;
10186 char_u *r;
10187 int len;
10188 char *txt;
10189 #endif
10191 rettv->v_type = VAR_STRING;
10192 rettv->vval.v_string = NULL;
10193 #ifdef FEAT_FOLDING
10194 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10195 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10196 <= curbuf->b_ml.ml_line_count
10197 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10199 /* Find first non-empty line in the fold. */
10200 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10201 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10203 if (!linewhite(lnum))
10204 break;
10205 ++lnum;
10208 /* Find interesting text in this line. */
10209 s = skipwhite(ml_get(lnum));
10210 /* skip C comment-start */
10211 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10213 s = skipwhite(s + 2);
10214 if (*skipwhite(s) == NUL
10215 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10217 s = skipwhite(ml_get(lnum + 1));
10218 if (*s == '*')
10219 s = skipwhite(s + 1);
10222 txt = _("+-%s%3ld lines: ");
10223 r = alloc((unsigned)(STRLEN(txt)
10224 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10225 + 20 /* for %3ld */
10226 + STRLEN(s))); /* concatenated */
10227 if (r != NULL)
10229 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10230 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10231 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10232 len = (int)STRLEN(r);
10233 STRCAT(r, s);
10234 /* remove 'foldmarker' and 'commentstring' */
10235 foldtext_cleanup(r + len);
10236 rettv->vval.v_string = r;
10239 #endif
10243 * "foldtextresult(lnum)" function
10245 /*ARGSUSED*/
10246 static void
10247 f_foldtextresult(argvars, rettv)
10248 typval_T *argvars;
10249 typval_T *rettv;
10251 #ifdef FEAT_FOLDING
10252 linenr_T lnum;
10253 char_u *text;
10254 char_u buf[51];
10255 foldinfo_T foldinfo;
10256 int fold_count;
10257 #endif
10259 rettv->v_type = VAR_STRING;
10260 rettv->vval.v_string = NULL;
10261 #ifdef FEAT_FOLDING
10262 lnum = get_tv_lnum(argvars);
10263 /* treat illegal types and illegal string values for {lnum} the same */
10264 if (lnum < 0)
10265 lnum = 0;
10266 fold_count = foldedCount(curwin, lnum, &foldinfo);
10267 if (fold_count > 0)
10269 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10270 &foldinfo, buf);
10271 if (text == buf)
10272 text = vim_strsave(text);
10273 rettv->vval.v_string = text;
10275 #endif
10279 * "foreground()" function
10281 /*ARGSUSED*/
10282 static void
10283 f_foreground(argvars, rettv)
10284 typval_T *argvars;
10285 typval_T *rettv;
10287 rettv->vval.v_number = 0;
10288 #ifdef FEAT_GUI
10289 if (gui.in_use)
10290 gui_mch_set_foreground();
10291 #else
10292 # ifdef WIN32
10293 win32_set_foreground();
10294 # endif
10295 #endif
10299 * "function()" function
10301 /*ARGSUSED*/
10302 static void
10303 f_function(argvars, rettv)
10304 typval_T *argvars;
10305 typval_T *rettv;
10307 char_u *s;
10309 rettv->vval.v_number = 0;
10310 s = get_tv_string(&argvars[0]);
10311 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10312 EMSG2(_(e_invarg2), s);
10313 else if (!function_exists(s))
10314 EMSG2(_("E700: Unknown function: %s"), s);
10315 else
10317 rettv->vval.v_string = vim_strsave(s);
10318 rettv->v_type = VAR_FUNC;
10323 * "garbagecollect()" function
10325 /*ARGSUSED*/
10326 static void
10327 f_garbagecollect(argvars, rettv)
10328 typval_T *argvars;
10329 typval_T *rettv;
10331 /* This is postponed until we are back at the toplevel, because we may be
10332 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10333 want_garbage_collect = TRUE;
10335 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10336 garbage_collect_at_exit = TRUE;
10340 * "get()" function
10342 static void
10343 f_get(argvars, rettv)
10344 typval_T *argvars;
10345 typval_T *rettv;
10347 listitem_T *li;
10348 list_T *l;
10349 dictitem_T *di;
10350 dict_T *d;
10351 typval_T *tv = NULL;
10353 if (argvars[0].v_type == VAR_LIST)
10355 if ((l = argvars[0].vval.v_list) != NULL)
10357 int error = FALSE;
10359 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10360 if (!error && li != NULL)
10361 tv = &li->li_tv;
10364 else if (argvars[0].v_type == VAR_DICT)
10366 if ((d = argvars[0].vval.v_dict) != NULL)
10368 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10369 if (di != NULL)
10370 tv = &di->di_tv;
10373 else
10374 EMSG2(_(e_listdictarg), "get()");
10376 if (tv == NULL)
10378 if (argvars[2].v_type == VAR_UNKNOWN)
10379 rettv->vval.v_number = 0;
10380 else
10381 copy_tv(&argvars[2], rettv);
10383 else
10384 copy_tv(tv, rettv);
10387 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10390 * Get line or list of lines from buffer "buf" into "rettv".
10391 * Return a range (from start to end) of lines in rettv from the specified
10392 * buffer.
10393 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10395 static void
10396 get_buffer_lines(buf, start, end, retlist, rettv)
10397 buf_T *buf;
10398 linenr_T start;
10399 linenr_T end;
10400 int retlist;
10401 typval_T *rettv;
10403 char_u *p;
10405 if (retlist)
10407 if (rettv_list_alloc(rettv) == FAIL)
10408 return;
10410 else
10411 rettv->vval.v_number = 0;
10413 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10414 return;
10416 if (!retlist)
10418 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10419 p = ml_get_buf(buf, start, FALSE);
10420 else
10421 p = (char_u *)"";
10423 rettv->v_type = VAR_STRING;
10424 rettv->vval.v_string = vim_strsave(p);
10426 else
10428 if (end < start)
10429 return;
10431 if (start < 1)
10432 start = 1;
10433 if (end > buf->b_ml.ml_line_count)
10434 end = buf->b_ml.ml_line_count;
10435 while (start <= end)
10436 if (list_append_string(rettv->vval.v_list,
10437 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10438 break;
10443 * "getbufline()" function
10445 static void
10446 f_getbufline(argvars, rettv)
10447 typval_T *argvars;
10448 typval_T *rettv;
10450 linenr_T lnum;
10451 linenr_T end;
10452 buf_T *buf;
10454 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10455 ++emsg_off;
10456 buf = get_buf_tv(&argvars[0]);
10457 --emsg_off;
10459 lnum = get_tv_lnum_buf(&argvars[1], buf);
10460 if (argvars[2].v_type == VAR_UNKNOWN)
10461 end = lnum;
10462 else
10463 end = get_tv_lnum_buf(&argvars[2], buf);
10465 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10469 * "getbufvar()" function
10471 static void
10472 f_getbufvar(argvars, rettv)
10473 typval_T *argvars;
10474 typval_T *rettv;
10476 buf_T *buf;
10477 buf_T *save_curbuf;
10478 char_u *varname;
10479 dictitem_T *v;
10481 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10482 varname = get_tv_string_chk(&argvars[1]);
10483 ++emsg_off;
10484 buf = get_buf_tv(&argvars[0]);
10486 rettv->v_type = VAR_STRING;
10487 rettv->vval.v_string = NULL;
10489 if (buf != NULL && varname != NULL)
10491 /* set curbuf to be our buf, temporarily */
10492 save_curbuf = curbuf;
10493 curbuf = buf;
10495 if (*varname == '&') /* buffer-local-option */
10496 get_option_tv(&varname, rettv, TRUE);
10497 else
10499 if (*varname == NUL)
10500 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10501 * scope prefix before the NUL byte is required by
10502 * find_var_in_ht(). */
10503 varname = (char_u *)"b:" + 2;
10504 /* look up the variable */
10505 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10506 if (v != NULL)
10507 copy_tv(&v->di_tv, rettv);
10510 /* restore previous notion of curbuf */
10511 curbuf = save_curbuf;
10514 --emsg_off;
10518 * "getchar()" function
10520 static void
10521 f_getchar(argvars, rettv)
10522 typval_T *argvars;
10523 typval_T *rettv;
10525 varnumber_T n;
10526 int error = FALSE;
10528 /* Position the cursor. Needed after a message that ends in a space. */
10529 windgoto(msg_row, msg_col);
10531 ++no_mapping;
10532 ++allow_keys;
10533 for (;;)
10535 if (argvars[0].v_type == VAR_UNKNOWN)
10536 /* getchar(): blocking wait. */
10537 n = safe_vgetc();
10538 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10539 /* getchar(1): only check if char avail */
10540 n = vpeekc();
10541 else if (error || vpeekc() == NUL)
10542 /* illegal argument or getchar(0) and no char avail: return zero */
10543 n = 0;
10544 else
10545 /* getchar(0) and char avail: return char */
10546 n = safe_vgetc();
10547 if (n == K_IGNORE)
10548 continue;
10549 break;
10551 --no_mapping;
10552 --allow_keys;
10554 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10555 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10556 vimvars[VV_MOUSE_COL].vv_nr = 0;
10558 rettv->vval.v_number = n;
10559 if (IS_SPECIAL(n) || mod_mask != 0)
10561 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10562 int i = 0;
10564 /* Turn a special key into three bytes, plus modifier. */
10565 if (mod_mask != 0)
10567 temp[i++] = K_SPECIAL;
10568 temp[i++] = KS_MODIFIER;
10569 temp[i++] = mod_mask;
10571 if (IS_SPECIAL(n))
10573 temp[i++] = K_SPECIAL;
10574 temp[i++] = K_SECOND(n);
10575 temp[i++] = K_THIRD(n);
10577 #ifdef FEAT_MBYTE
10578 else if (has_mbyte)
10579 i += (*mb_char2bytes)(n, temp + i);
10580 #endif
10581 else
10582 temp[i++] = n;
10583 temp[i++] = NUL;
10584 rettv->v_type = VAR_STRING;
10585 rettv->vval.v_string = vim_strsave(temp);
10587 #ifdef FEAT_MOUSE
10588 if (n == K_LEFTMOUSE
10589 || n == K_LEFTMOUSE_NM
10590 || n == K_LEFTDRAG
10591 || n == K_LEFTRELEASE
10592 || n == K_LEFTRELEASE_NM
10593 || n == K_MIDDLEMOUSE
10594 || n == K_MIDDLEDRAG
10595 || n == K_MIDDLERELEASE
10596 || n == K_RIGHTMOUSE
10597 || n == K_RIGHTDRAG
10598 || n == K_RIGHTRELEASE
10599 || n == K_X1MOUSE
10600 || n == K_X1DRAG
10601 || n == K_X1RELEASE
10602 || n == K_X2MOUSE
10603 || n == K_X2DRAG
10604 || n == K_X2RELEASE
10605 || n == K_MOUSEDOWN
10606 || n == K_MOUSEUP)
10608 int row = mouse_row;
10609 int col = mouse_col;
10610 win_T *win;
10611 linenr_T lnum;
10612 # ifdef FEAT_WINDOWS
10613 win_T *wp;
10614 # endif
10615 int n = 1;
10617 if (row >= 0 && col >= 0)
10619 /* Find the window at the mouse coordinates and compute the
10620 * text position. */
10621 win = mouse_find_win(&row, &col);
10622 (void)mouse_comp_pos(win, &row, &col, &lnum);
10623 # ifdef FEAT_WINDOWS
10624 for (wp = firstwin; wp != win; wp = wp->w_next)
10625 ++n;
10626 # endif
10627 vimvars[VV_MOUSE_WIN].vv_nr = n;
10628 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10629 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10632 #endif
10637 * "getcharmod()" function
10639 /*ARGSUSED*/
10640 static void
10641 f_getcharmod(argvars, rettv)
10642 typval_T *argvars;
10643 typval_T *rettv;
10645 rettv->vval.v_number = mod_mask;
10649 * "getcmdline()" function
10651 /*ARGSUSED*/
10652 static void
10653 f_getcmdline(argvars, rettv)
10654 typval_T *argvars;
10655 typval_T *rettv;
10657 rettv->v_type = VAR_STRING;
10658 rettv->vval.v_string = get_cmdline_str();
10662 * "getcmdpos()" function
10664 /*ARGSUSED*/
10665 static void
10666 f_getcmdpos(argvars, rettv)
10667 typval_T *argvars;
10668 typval_T *rettv;
10670 rettv->vval.v_number = get_cmdline_pos() + 1;
10674 * "getcmdtype()" function
10676 /*ARGSUSED*/
10677 static void
10678 f_getcmdtype(argvars, rettv)
10679 typval_T *argvars;
10680 typval_T *rettv;
10682 rettv->v_type = VAR_STRING;
10683 rettv->vval.v_string = alloc(2);
10684 if (rettv->vval.v_string != NULL)
10686 rettv->vval.v_string[0] = get_cmdline_type();
10687 rettv->vval.v_string[1] = NUL;
10692 * "getcwd()" function
10694 /*ARGSUSED*/
10695 static void
10696 f_getcwd(argvars, rettv)
10697 typval_T *argvars;
10698 typval_T *rettv;
10700 char_u cwd[MAXPATHL];
10702 rettv->v_type = VAR_STRING;
10703 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10704 rettv->vval.v_string = NULL;
10705 else
10707 rettv->vval.v_string = vim_strsave(cwd);
10708 #ifdef BACKSLASH_IN_FILENAME
10709 if (rettv->vval.v_string != NULL)
10710 slash_adjust(rettv->vval.v_string);
10711 #endif
10716 * "getfontname()" function
10718 /*ARGSUSED*/
10719 static void
10720 f_getfontname(argvars, rettv)
10721 typval_T *argvars;
10722 typval_T *rettv;
10724 rettv->v_type = VAR_STRING;
10725 rettv->vval.v_string = NULL;
10726 #ifdef FEAT_GUI
10727 if (gui.in_use)
10729 GuiFont font;
10730 char_u *name = NULL;
10732 if (argvars[0].v_type == VAR_UNKNOWN)
10734 /* Get the "Normal" font. Either the name saved by
10735 * hl_set_font_name() or from the font ID. */
10736 font = gui.norm_font;
10737 name = hl_get_font_name();
10739 else
10741 name = get_tv_string(&argvars[0]);
10742 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10743 return;
10744 font = gui_mch_get_font(name, FALSE);
10745 if (font == NOFONT)
10746 return; /* Invalid font name, return empty string. */
10748 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10749 if (argvars[0].v_type != VAR_UNKNOWN)
10750 gui_mch_free_font(font);
10752 #endif
10756 * "getfperm({fname})" function
10758 static void
10759 f_getfperm(argvars, rettv)
10760 typval_T *argvars;
10761 typval_T *rettv;
10763 char_u *fname;
10764 struct stat st;
10765 char_u *perm = NULL;
10766 char_u flags[] = "rwx";
10767 int i;
10769 fname = get_tv_string(&argvars[0]);
10771 rettv->v_type = VAR_STRING;
10772 if (mch_stat((char *)fname, &st) >= 0)
10774 perm = vim_strsave((char_u *)"---------");
10775 if (perm != NULL)
10777 for (i = 0; i < 9; i++)
10779 if (st.st_mode & (1 << (8 - i)))
10780 perm[i] = flags[i % 3];
10784 rettv->vval.v_string = perm;
10788 * "getfsize({fname})" function
10790 static void
10791 f_getfsize(argvars, rettv)
10792 typval_T *argvars;
10793 typval_T *rettv;
10795 char_u *fname;
10796 struct stat st;
10798 fname = get_tv_string(&argvars[0]);
10800 rettv->v_type = VAR_NUMBER;
10802 if (mch_stat((char *)fname, &st) >= 0)
10804 if (mch_isdir(fname))
10805 rettv->vval.v_number = 0;
10806 else
10808 rettv->vval.v_number = (varnumber_T)st.st_size;
10810 /* non-perfect check for overflow */
10811 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10812 rettv->vval.v_number = -2;
10815 else
10816 rettv->vval.v_number = -1;
10820 * "getftime({fname})" function
10822 static void
10823 f_getftime(argvars, rettv)
10824 typval_T *argvars;
10825 typval_T *rettv;
10827 char_u *fname;
10828 struct stat st;
10830 fname = get_tv_string(&argvars[0]);
10832 if (mch_stat((char *)fname, &st) >= 0)
10833 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10834 else
10835 rettv->vval.v_number = -1;
10839 * "getftype({fname})" function
10841 static void
10842 f_getftype(argvars, rettv)
10843 typval_T *argvars;
10844 typval_T *rettv;
10846 char_u *fname;
10847 struct stat st;
10848 char_u *type = NULL;
10849 char *t;
10851 fname = get_tv_string(&argvars[0]);
10853 rettv->v_type = VAR_STRING;
10854 if (mch_lstat((char *)fname, &st) >= 0)
10856 #ifdef S_ISREG
10857 if (S_ISREG(st.st_mode))
10858 t = "file";
10859 else if (S_ISDIR(st.st_mode))
10860 t = "dir";
10861 # ifdef S_ISLNK
10862 else if (S_ISLNK(st.st_mode))
10863 t = "link";
10864 # endif
10865 # ifdef S_ISBLK
10866 else if (S_ISBLK(st.st_mode))
10867 t = "bdev";
10868 # endif
10869 # ifdef S_ISCHR
10870 else if (S_ISCHR(st.st_mode))
10871 t = "cdev";
10872 # endif
10873 # ifdef S_ISFIFO
10874 else if (S_ISFIFO(st.st_mode))
10875 t = "fifo";
10876 # endif
10877 # ifdef S_ISSOCK
10878 else if (S_ISSOCK(st.st_mode))
10879 t = "fifo";
10880 # endif
10881 else
10882 t = "other";
10883 #else
10884 # ifdef S_IFMT
10885 switch (st.st_mode & S_IFMT)
10887 case S_IFREG: t = "file"; break;
10888 case S_IFDIR: t = "dir"; break;
10889 # ifdef S_IFLNK
10890 case S_IFLNK: t = "link"; break;
10891 # endif
10892 # ifdef S_IFBLK
10893 case S_IFBLK: t = "bdev"; break;
10894 # endif
10895 # ifdef S_IFCHR
10896 case S_IFCHR: t = "cdev"; break;
10897 # endif
10898 # ifdef S_IFIFO
10899 case S_IFIFO: t = "fifo"; break;
10900 # endif
10901 # ifdef S_IFSOCK
10902 case S_IFSOCK: t = "socket"; break;
10903 # endif
10904 default: t = "other";
10906 # else
10907 if (mch_isdir(fname))
10908 t = "dir";
10909 else
10910 t = "file";
10911 # endif
10912 #endif
10913 type = vim_strsave((char_u *)t);
10915 rettv->vval.v_string = type;
10919 * "getline(lnum, [end])" function
10921 static void
10922 f_getline(argvars, rettv)
10923 typval_T *argvars;
10924 typval_T *rettv;
10926 linenr_T lnum;
10927 linenr_T end;
10928 int retlist;
10930 lnum = get_tv_lnum(argvars);
10931 if (argvars[1].v_type == VAR_UNKNOWN)
10933 end = 0;
10934 retlist = FALSE;
10936 else
10938 end = get_tv_lnum(&argvars[1]);
10939 retlist = TRUE;
10942 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10946 * "getmatches()" function
10948 /*ARGSUSED*/
10949 static void
10950 f_getmatches(argvars, rettv)
10951 typval_T *argvars;
10952 typval_T *rettv;
10954 #ifdef FEAT_SEARCH_EXTRA
10955 dict_T *dict;
10956 matchitem_T *cur = curwin->w_match_head;
10958 rettv->vval.v_number = 0;
10960 if (rettv_list_alloc(rettv) == OK)
10962 while (cur != NULL)
10964 dict = dict_alloc();
10965 if (dict == NULL)
10966 return;
10967 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
10968 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
10969 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
10970 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
10971 list_append_dict(rettv->vval.v_list, dict);
10972 cur = cur->next;
10975 #endif
10979 * "getpid()" function
10981 /*ARGSUSED*/
10982 static void
10983 f_getpid(argvars, rettv)
10984 typval_T *argvars;
10985 typval_T *rettv;
10987 rettv->vval.v_number = mch_get_pid();
10991 * "getpos(string)" function
10993 static void
10994 f_getpos(argvars, rettv)
10995 typval_T *argvars;
10996 typval_T *rettv;
10998 pos_T *fp;
10999 list_T *l;
11000 int fnum = -1;
11002 if (rettv_list_alloc(rettv) == OK)
11004 l = rettv->vval.v_list;
11005 fp = var2fpos(&argvars[0], TRUE, &fnum);
11006 if (fnum != -1)
11007 list_append_number(l, (varnumber_T)fnum);
11008 else
11009 list_append_number(l, (varnumber_T)0);
11010 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11011 : (varnumber_T)0);
11012 list_append_number(l, (fp != NULL)
11013 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11014 : (varnumber_T)0);
11015 list_append_number(l,
11016 #ifdef FEAT_VIRTUALEDIT
11017 (fp != NULL) ? (varnumber_T)fp->coladd :
11018 #endif
11019 (varnumber_T)0);
11021 else
11022 rettv->vval.v_number = FALSE;
11026 * "getqflist()" and "getloclist()" functions
11028 /*ARGSUSED*/
11029 static void
11030 f_getqflist(argvars, rettv)
11031 typval_T *argvars;
11032 typval_T *rettv;
11034 #ifdef FEAT_QUICKFIX
11035 win_T *wp;
11036 #endif
11038 rettv->vval.v_number = 0;
11039 #ifdef FEAT_QUICKFIX
11040 if (rettv_list_alloc(rettv) == OK)
11042 wp = NULL;
11043 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11045 wp = find_win_by_nr(&argvars[0], NULL);
11046 if (wp == NULL)
11047 return;
11050 (void)get_errorlist(wp, rettv->vval.v_list);
11052 #endif
11056 * "getreg()" function
11058 static void
11059 f_getreg(argvars, rettv)
11060 typval_T *argvars;
11061 typval_T *rettv;
11063 char_u *strregname;
11064 int regname;
11065 int arg2 = FALSE;
11066 int error = FALSE;
11068 if (argvars[0].v_type != VAR_UNKNOWN)
11070 strregname = get_tv_string_chk(&argvars[0]);
11071 error = strregname == NULL;
11072 if (argvars[1].v_type != VAR_UNKNOWN)
11073 arg2 = get_tv_number_chk(&argvars[1], &error);
11075 else
11076 strregname = vimvars[VV_REG].vv_str;
11077 regname = (strregname == NULL ? '"' : *strregname);
11078 if (regname == 0)
11079 regname = '"';
11081 rettv->v_type = VAR_STRING;
11082 rettv->vval.v_string = error ? NULL :
11083 get_reg_contents(regname, TRUE, arg2);
11087 * "getregtype()" function
11089 static void
11090 f_getregtype(argvars, rettv)
11091 typval_T *argvars;
11092 typval_T *rettv;
11094 char_u *strregname;
11095 int regname;
11096 char_u buf[NUMBUFLEN + 2];
11097 long reglen = 0;
11099 if (argvars[0].v_type != VAR_UNKNOWN)
11101 strregname = get_tv_string_chk(&argvars[0]);
11102 if (strregname == NULL) /* type error; errmsg already given */
11104 rettv->v_type = VAR_STRING;
11105 rettv->vval.v_string = NULL;
11106 return;
11109 else
11110 /* Default to v:register */
11111 strregname = vimvars[VV_REG].vv_str;
11113 regname = (strregname == NULL ? '"' : *strregname);
11114 if (regname == 0)
11115 regname = '"';
11117 buf[0] = NUL;
11118 buf[1] = NUL;
11119 switch (get_reg_type(regname, &reglen))
11121 case MLINE: buf[0] = 'V'; break;
11122 case MCHAR: buf[0] = 'v'; break;
11123 #ifdef FEAT_VISUAL
11124 case MBLOCK:
11125 buf[0] = Ctrl_V;
11126 sprintf((char *)buf + 1, "%ld", reglen + 1);
11127 break;
11128 #endif
11130 rettv->v_type = VAR_STRING;
11131 rettv->vval.v_string = vim_strsave(buf);
11135 * "gettabwinvar()" function
11137 static void
11138 f_gettabwinvar(argvars, rettv)
11139 typval_T *argvars;
11140 typval_T *rettv;
11142 getwinvar(argvars, rettv, 1);
11146 * "getwinposx()" function
11148 /*ARGSUSED*/
11149 static void
11150 f_getwinposx(argvars, rettv)
11151 typval_T *argvars;
11152 typval_T *rettv;
11154 rettv->vval.v_number = -1;
11155 #ifdef FEAT_GUI
11156 if (gui.in_use)
11158 int x, y;
11160 if (gui_mch_get_winpos(&x, &y) == OK)
11161 rettv->vval.v_number = x;
11163 #endif
11167 * "getwinposy()" function
11169 /*ARGSUSED*/
11170 static void
11171 f_getwinposy(argvars, rettv)
11172 typval_T *argvars;
11173 typval_T *rettv;
11175 rettv->vval.v_number = -1;
11176 #ifdef FEAT_GUI
11177 if (gui.in_use)
11179 int x, y;
11181 if (gui_mch_get_winpos(&x, &y) == OK)
11182 rettv->vval.v_number = y;
11184 #endif
11188 * Find window specified by "vp" in tabpage "tp".
11190 static win_T *
11191 find_win_by_nr(vp, tp)
11192 typval_T *vp;
11193 tabpage_T *tp; /* NULL for current tab page */
11195 #ifdef FEAT_WINDOWS
11196 win_T *wp;
11197 #endif
11198 int nr;
11200 nr = get_tv_number_chk(vp, NULL);
11202 #ifdef FEAT_WINDOWS
11203 if (nr < 0)
11204 return NULL;
11205 if (nr == 0)
11206 return curwin;
11208 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11209 wp != NULL; wp = wp->w_next)
11210 if (--nr <= 0)
11211 break;
11212 return wp;
11213 #else
11214 if (nr == 0 || nr == 1)
11215 return curwin;
11216 return NULL;
11217 #endif
11221 * "getwinvar()" function
11223 static void
11224 f_getwinvar(argvars, rettv)
11225 typval_T *argvars;
11226 typval_T *rettv;
11228 getwinvar(argvars, rettv, 0);
11232 * getwinvar() and gettabwinvar()
11234 static void
11235 getwinvar(argvars, rettv, off)
11236 typval_T *argvars;
11237 typval_T *rettv;
11238 int off; /* 1 for gettabwinvar() */
11240 win_T *win, *oldcurwin;
11241 char_u *varname;
11242 dictitem_T *v;
11243 tabpage_T *tp;
11245 #ifdef FEAT_WINDOWS
11246 if (off == 1)
11247 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11248 else
11249 tp = curtab;
11250 #endif
11251 win = find_win_by_nr(&argvars[off], tp);
11252 varname = get_tv_string_chk(&argvars[off + 1]);
11253 ++emsg_off;
11255 rettv->v_type = VAR_STRING;
11256 rettv->vval.v_string = NULL;
11258 if (win != NULL && varname != NULL)
11260 /* Set curwin to be our win, temporarily. Also set curbuf, so
11261 * that we can get buffer-local options. */
11262 oldcurwin = curwin;
11263 curwin = win;
11264 curbuf = win->w_buffer;
11266 if (*varname == '&') /* window-local-option */
11267 get_option_tv(&varname, rettv, 1);
11268 else
11270 if (*varname == NUL)
11271 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11272 * scope prefix before the NUL byte is required by
11273 * find_var_in_ht(). */
11274 varname = (char_u *)"w:" + 2;
11275 /* look up the variable */
11276 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11277 if (v != NULL)
11278 copy_tv(&v->di_tv, rettv);
11281 /* restore previous notion of curwin */
11282 curwin = oldcurwin;
11283 curbuf = curwin->w_buffer;
11286 --emsg_off;
11290 * "glob()" function
11292 static void
11293 f_glob(argvars, rettv)
11294 typval_T *argvars;
11295 typval_T *rettv;
11297 expand_T xpc;
11299 ExpandInit(&xpc);
11300 xpc.xp_context = EXPAND_FILES;
11301 rettv->v_type = VAR_STRING;
11302 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11303 NULL, WILD_USE_NL|WILD_SILENT, WILD_ALL);
11307 * "globpath()" function
11309 static void
11310 f_globpath(argvars, rettv)
11311 typval_T *argvars;
11312 typval_T *rettv;
11314 char_u buf1[NUMBUFLEN];
11315 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11317 rettv->v_type = VAR_STRING;
11318 if (file == NULL)
11319 rettv->vval.v_string = NULL;
11320 else
11321 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file);
11325 * "has()" function
11327 static void
11328 f_has(argvars, rettv)
11329 typval_T *argvars;
11330 typval_T *rettv;
11332 int i;
11333 char_u *name;
11334 int n = FALSE;
11335 static char *(has_list[]) =
11337 #ifdef AMIGA
11338 "amiga",
11339 # ifdef FEAT_ARP
11340 "arp",
11341 # endif
11342 #endif
11343 #ifdef __BEOS__
11344 "beos",
11345 #endif
11346 #ifdef MSDOS
11347 # ifdef DJGPP
11348 "dos32",
11349 # else
11350 "dos16",
11351 # endif
11352 #endif
11353 #ifdef MACOS
11354 "mac",
11355 #endif
11356 #if defined(MACOS_X_UNIX)
11357 "macunix",
11358 #endif
11359 #ifdef OS2
11360 "os2",
11361 #endif
11362 #ifdef __QNX__
11363 "qnx",
11364 #endif
11365 #ifdef RISCOS
11366 "riscos",
11367 #endif
11368 #ifdef UNIX
11369 "unix",
11370 #endif
11371 #ifdef VMS
11372 "vms",
11373 #endif
11374 #ifdef WIN16
11375 "win16",
11376 #endif
11377 #ifdef WIN32
11378 "win32",
11379 #endif
11380 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11381 "win32unix",
11382 #endif
11383 #ifdef WIN64
11384 "win64",
11385 #endif
11386 #ifdef EBCDIC
11387 "ebcdic",
11388 #endif
11389 #ifndef CASE_INSENSITIVE_FILENAME
11390 "fname_case",
11391 #endif
11392 #ifdef FEAT_ARABIC
11393 "arabic",
11394 #endif
11395 #ifdef FEAT_AUTOCMD
11396 "autocmd",
11397 #endif
11398 #ifdef FEAT_BEVAL
11399 "balloon_eval",
11400 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11401 "balloon_multiline",
11402 # endif
11403 #endif
11404 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11405 "builtin_terms",
11406 # ifdef ALL_BUILTIN_TCAPS
11407 "all_builtin_terms",
11408 # endif
11409 #endif
11410 #ifdef FEAT_BYTEOFF
11411 "byte_offset",
11412 #endif
11413 #ifdef FEAT_CINDENT
11414 "cindent",
11415 #endif
11416 #ifdef FEAT_CLIENTSERVER
11417 "clientserver",
11418 #endif
11419 #ifdef FEAT_CLIPBOARD
11420 "clipboard",
11421 #endif
11422 #ifdef FEAT_CMDL_COMPL
11423 "cmdline_compl",
11424 #endif
11425 #ifdef FEAT_CMDHIST
11426 "cmdline_hist",
11427 #endif
11428 #ifdef FEAT_COMMENTS
11429 "comments",
11430 #endif
11431 #ifdef FEAT_CRYPT
11432 "cryptv",
11433 #endif
11434 #ifdef FEAT_CSCOPE
11435 "cscope",
11436 #endif
11437 #ifdef CURSOR_SHAPE
11438 "cursorshape",
11439 #endif
11440 #ifdef DEBUG
11441 "debug",
11442 #endif
11443 #ifdef FEAT_CON_DIALOG
11444 "dialog_con",
11445 #endif
11446 #ifdef FEAT_GUI_DIALOG
11447 "dialog_gui",
11448 #endif
11449 #ifdef FEAT_DIFF
11450 "diff",
11451 #endif
11452 #ifdef FEAT_DIGRAPHS
11453 "digraphs",
11454 #endif
11455 #ifdef FEAT_DND
11456 "dnd",
11457 #endif
11458 #ifdef FEAT_EMACS_TAGS
11459 "emacs_tags",
11460 #endif
11461 "eval", /* always present, of course! */
11462 #ifdef FEAT_EX_EXTRA
11463 "ex_extra",
11464 #endif
11465 #ifdef FEAT_SEARCH_EXTRA
11466 "extra_search",
11467 #endif
11468 #ifdef FEAT_FKMAP
11469 "farsi",
11470 #endif
11471 #ifdef FEAT_SEARCHPATH
11472 "file_in_path",
11473 #endif
11474 #if defined(UNIX) && !defined(USE_SYSTEM)
11475 "filterpipe",
11476 #endif
11477 #ifdef FEAT_FIND_ID
11478 "find_in_path",
11479 #endif
11480 #ifdef FEAT_FLOAT
11481 "float",
11482 #endif
11483 #ifdef FEAT_FOLDING
11484 "folding",
11485 #endif
11486 #ifdef FEAT_FOOTER
11487 "footer",
11488 #endif
11489 #if !defined(USE_SYSTEM) && defined(UNIX)
11490 "fork",
11491 #endif
11492 #ifdef FEAT_FULLSCREEN
11493 "fullscreen",
11494 #endif
11495 #ifdef FEAT_GETTEXT
11496 "gettext",
11497 #endif
11498 #ifdef FEAT_GUI
11499 "gui",
11500 #endif
11501 #ifdef FEAT_GUI_ATHENA
11502 # ifdef FEAT_GUI_NEXTAW
11503 "gui_neXtaw",
11504 # else
11505 "gui_athena",
11506 # endif
11507 #endif
11508 #ifdef FEAT_GUI_GTK
11509 "gui_gtk",
11510 # ifdef HAVE_GTK2
11511 "gui_gtk2",
11512 # endif
11513 #endif
11514 #ifdef FEAT_GUI_GNOME
11515 "gui_gnome",
11516 #endif
11517 #ifdef FEAT_GUI_MAC
11518 "gui_mac",
11519 #endif
11520 #ifdef FEAT_GUI_MACVIM
11521 "gui_macvim",
11522 #endif
11523 #ifdef FEAT_GUI_MOTIF
11524 "gui_motif",
11525 #endif
11526 #ifdef FEAT_GUI_PHOTON
11527 "gui_photon",
11528 #endif
11529 #ifdef FEAT_GUI_W16
11530 "gui_win16",
11531 #endif
11532 #ifdef FEAT_GUI_W32
11533 "gui_win32",
11534 #endif
11535 #ifdef FEAT_HANGULIN
11536 "hangul_input",
11537 #endif
11538 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11539 "iconv",
11540 #endif
11541 #ifdef FEAT_INS_EXPAND
11542 "insert_expand",
11543 #endif
11544 #ifdef FEAT_JUMPLIST
11545 "jumplist",
11546 #endif
11547 #ifdef FEAT_KEYMAP
11548 "keymap",
11549 #endif
11550 #ifdef FEAT_LANGMAP
11551 "langmap",
11552 #endif
11553 #ifdef FEAT_LIBCALL
11554 "libcall",
11555 #endif
11556 #ifdef FEAT_LINEBREAK
11557 "linebreak",
11558 #endif
11559 #ifdef FEAT_LISP
11560 "lispindent",
11561 #endif
11562 #ifdef FEAT_LISTCMDS
11563 "listcmds",
11564 #endif
11565 #ifdef FEAT_LOCALMAP
11566 "localmap",
11567 #endif
11568 #ifdef FEAT_MENU
11569 "menu",
11570 #endif
11571 #ifdef FEAT_SESSION
11572 "mksession",
11573 #endif
11574 #ifdef FEAT_MODIFY_FNAME
11575 "modify_fname",
11576 #endif
11577 #ifdef FEAT_MOUSE
11578 "mouse",
11579 #endif
11580 #ifdef FEAT_MOUSESHAPE
11581 "mouseshape",
11582 #endif
11583 #if defined(UNIX) || defined(VMS)
11584 # ifdef FEAT_MOUSE_DEC
11585 "mouse_dec",
11586 # endif
11587 # ifdef FEAT_MOUSE_GPM
11588 "mouse_gpm",
11589 # endif
11590 # ifdef FEAT_MOUSE_JSB
11591 "mouse_jsbterm",
11592 # endif
11593 # ifdef FEAT_MOUSE_NET
11594 "mouse_netterm",
11595 # endif
11596 # ifdef FEAT_MOUSE_PTERM
11597 "mouse_pterm",
11598 # endif
11599 # ifdef FEAT_SYSMOUSE
11600 "mouse_sysmouse",
11601 # endif
11602 # ifdef FEAT_MOUSE_XTERM
11603 "mouse_xterm",
11604 # endif
11605 #endif
11606 #ifdef FEAT_MBYTE
11607 "multi_byte",
11608 #endif
11609 #ifdef FEAT_MBYTE_IME
11610 "multi_byte_ime",
11611 #endif
11612 #ifdef FEAT_MULTI_LANG
11613 "multi_lang",
11614 #endif
11615 #ifdef FEAT_MZSCHEME
11616 #ifndef DYNAMIC_MZSCHEME
11617 "mzscheme",
11618 #endif
11619 #endif
11620 #ifdef FEAT_OLE
11621 "ole",
11622 #endif
11623 #ifdef FEAT_OSFILETYPE
11624 "osfiletype",
11625 #endif
11626 #ifdef FEAT_PATH_EXTRA
11627 "path_extra",
11628 #endif
11629 #ifdef FEAT_PERL
11630 #ifndef DYNAMIC_PERL
11631 "perl",
11632 #endif
11633 #endif
11634 #ifdef FEAT_PYTHON
11635 #ifndef DYNAMIC_PYTHON
11636 "python",
11637 #endif
11638 #endif
11639 #ifdef FEAT_POSTSCRIPT
11640 "postscript",
11641 #endif
11642 #ifdef FEAT_PRINTER
11643 "printer",
11644 #endif
11645 #ifdef FEAT_PROFILE
11646 "profile",
11647 #endif
11648 #ifdef FEAT_RELTIME
11649 "reltime",
11650 #endif
11651 #ifdef FEAT_QUICKFIX
11652 "quickfix",
11653 #endif
11654 #ifdef FEAT_RIGHTLEFT
11655 "rightleft",
11656 #endif
11657 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11658 "ruby",
11659 #endif
11660 #ifdef FEAT_SCROLLBIND
11661 "scrollbind",
11662 #endif
11663 #ifdef FEAT_CMDL_INFO
11664 "showcmd",
11665 "cmdline_info",
11666 #endif
11667 #ifdef FEAT_SIGNS
11668 "signs",
11669 #endif
11670 #ifdef FEAT_SMARTINDENT
11671 "smartindent",
11672 #endif
11673 #ifdef FEAT_SNIFF
11674 "sniff",
11675 #endif
11676 #ifdef FEAT_STL_OPT
11677 "statusline",
11678 #endif
11679 #ifdef FEAT_SUN_WORKSHOP
11680 "sun_workshop",
11681 #endif
11682 #ifdef FEAT_NETBEANS_INTG
11683 "netbeans_intg",
11684 #endif
11685 #ifdef FEAT_ODB_EDITOR
11686 "odbeditor",
11687 #endif
11688 #ifdef FEAT_SPELL
11689 "spell",
11690 #endif
11691 #ifdef FEAT_SYN_HL
11692 "syntax",
11693 #endif
11694 #if defined(USE_SYSTEM) || !defined(UNIX)
11695 "system",
11696 #endif
11697 #ifdef FEAT_TAG_BINS
11698 "tag_binary",
11699 #endif
11700 #ifdef FEAT_TAG_OLDSTATIC
11701 "tag_old_static",
11702 #endif
11703 #ifdef FEAT_TAG_ANYWHITE
11704 "tag_any_white",
11705 #endif
11706 #ifdef FEAT_TCL
11707 # ifndef DYNAMIC_TCL
11708 "tcl",
11709 # endif
11710 #endif
11711 #ifdef TERMINFO
11712 "terminfo",
11713 #endif
11714 #ifdef FEAT_TERMRESPONSE
11715 "termresponse",
11716 #endif
11717 #ifdef FEAT_TEXTOBJ
11718 "textobjects",
11719 #endif
11720 #ifdef HAVE_TGETENT
11721 "tgetent",
11722 #endif
11723 #ifdef FEAT_TITLE
11724 "title",
11725 #endif
11726 #ifdef FEAT_TOOLBAR
11727 "toolbar",
11728 #endif
11729 #ifdef FEAT_TRANSPARENCY
11730 "transparency",
11731 #endif
11732 #ifdef FEAT_USR_CMDS
11733 "user-commands", /* was accidentally included in 5.4 */
11734 "user_commands",
11735 #endif
11736 #ifdef FEAT_VIMINFO
11737 "viminfo",
11738 #endif
11739 #ifdef FEAT_VERTSPLIT
11740 "vertsplit",
11741 #endif
11742 #ifdef FEAT_VIRTUALEDIT
11743 "virtualedit",
11744 #endif
11745 #ifdef FEAT_VISUAL
11746 "visual",
11747 #endif
11748 #ifdef FEAT_VISUALEXTRA
11749 "visualextra",
11750 #endif
11751 #ifdef FEAT_VREPLACE
11752 "vreplace",
11753 #endif
11754 #ifdef FEAT_WILDIGN
11755 "wildignore",
11756 #endif
11757 #ifdef FEAT_WILDMENU
11758 "wildmenu",
11759 #endif
11760 #ifdef FEAT_WINDOWS
11761 "windows",
11762 #endif
11763 #ifdef FEAT_WAK
11764 "winaltkeys",
11765 #endif
11766 #ifdef FEAT_WRITEBACKUP
11767 "writebackup",
11768 #endif
11769 #ifdef FEAT_XIM
11770 "xim",
11771 #endif
11772 #ifdef FEAT_XFONTSET
11773 "xfontset",
11774 #endif
11775 #ifdef USE_XSMP
11776 "xsmp",
11777 #endif
11778 #ifdef USE_XSMP_INTERACT
11779 "xsmp_interact",
11780 #endif
11781 #ifdef FEAT_XCLIPBOARD
11782 "xterm_clipboard",
11783 #endif
11784 #ifdef FEAT_XTERM_SAVE
11785 "xterm_save",
11786 #endif
11787 #if defined(UNIX) && defined(FEAT_X11)
11788 "X11",
11789 #endif
11790 NULL
11793 name = get_tv_string(&argvars[0]);
11794 for (i = 0; has_list[i] != NULL; ++i)
11795 if (STRICMP(name, has_list[i]) == 0)
11797 n = TRUE;
11798 break;
11801 if (n == FALSE)
11803 if (STRNICMP(name, "patch", 5) == 0)
11804 n = has_patch(atoi((char *)name + 5));
11805 else if (STRICMP(name, "vim_starting") == 0)
11806 n = (starting != 0);
11807 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11808 else if (STRICMP(name, "balloon_multiline") == 0)
11809 n = multiline_balloon_available();
11810 #endif
11811 #ifdef DYNAMIC_TCL
11812 else if (STRICMP(name, "tcl") == 0)
11813 n = tcl_enabled(FALSE);
11814 #endif
11815 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11816 else if (STRICMP(name, "iconv") == 0)
11817 n = iconv_enabled(FALSE);
11818 #endif
11819 #ifdef DYNAMIC_MZSCHEME
11820 else if (STRICMP(name, "mzscheme") == 0)
11821 n = mzscheme_enabled(FALSE);
11822 #endif
11823 #ifdef DYNAMIC_RUBY
11824 else if (STRICMP(name, "ruby") == 0)
11825 n = ruby_enabled(FALSE);
11826 #endif
11827 #ifdef DYNAMIC_PYTHON
11828 else if (STRICMP(name, "python") == 0)
11829 n = python_enabled(FALSE);
11830 #endif
11831 #ifdef DYNAMIC_PERL
11832 else if (STRICMP(name, "perl") == 0)
11833 n = perl_enabled(FALSE);
11834 #endif
11835 #ifdef FEAT_GUI
11836 else if (STRICMP(name, "gui_running") == 0)
11837 n = (gui.in_use || gui.starting);
11838 # ifdef FEAT_GUI_W32
11839 else if (STRICMP(name, "gui_win32s") == 0)
11840 n = gui_is_win32s();
11841 # endif
11842 # ifdef FEAT_BROWSE
11843 else if (STRICMP(name, "browse") == 0)
11844 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11845 # endif
11846 #endif
11847 #ifdef FEAT_SYN_HL
11848 else if (STRICMP(name, "syntax_items") == 0)
11849 n = syntax_present(curbuf);
11850 #endif
11851 #if defined(WIN3264)
11852 else if (STRICMP(name, "win95") == 0)
11853 n = mch_windows95();
11854 #endif
11855 #ifdef FEAT_NETBEANS_INTG
11856 else if (STRICMP(name, "netbeans_enabled") == 0)
11857 n = usingNetbeans;
11858 #endif
11861 rettv->vval.v_number = n;
11865 * "has_key()" function
11867 static void
11868 f_has_key(argvars, rettv)
11869 typval_T *argvars;
11870 typval_T *rettv;
11872 rettv->vval.v_number = 0;
11873 if (argvars[0].v_type != VAR_DICT)
11875 EMSG(_(e_dictreq));
11876 return;
11878 if (argvars[0].vval.v_dict == NULL)
11879 return;
11881 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11882 get_tv_string(&argvars[1]), -1) != NULL;
11886 * "haslocaldir()" function
11888 /*ARGSUSED*/
11889 static void
11890 f_haslocaldir(argvars, rettv)
11891 typval_T *argvars;
11892 typval_T *rettv;
11894 rettv->vval.v_number = (curwin->w_localdir != NULL);
11898 * "hasmapto()" function
11900 static void
11901 f_hasmapto(argvars, rettv)
11902 typval_T *argvars;
11903 typval_T *rettv;
11905 char_u *name;
11906 char_u *mode;
11907 char_u buf[NUMBUFLEN];
11908 int abbr = FALSE;
11910 name = get_tv_string(&argvars[0]);
11911 if (argvars[1].v_type == VAR_UNKNOWN)
11912 mode = (char_u *)"nvo";
11913 else
11915 mode = get_tv_string_buf(&argvars[1], buf);
11916 if (argvars[2].v_type != VAR_UNKNOWN)
11917 abbr = get_tv_number(&argvars[2]);
11920 if (map_to_exists(name, mode, abbr))
11921 rettv->vval.v_number = TRUE;
11922 else
11923 rettv->vval.v_number = FALSE;
11927 * "histadd()" function
11929 /*ARGSUSED*/
11930 static void
11931 f_histadd(argvars, rettv)
11932 typval_T *argvars;
11933 typval_T *rettv;
11935 #ifdef FEAT_CMDHIST
11936 int histype;
11937 char_u *str;
11938 char_u buf[NUMBUFLEN];
11939 #endif
11941 rettv->vval.v_number = FALSE;
11942 if (check_restricted() || check_secure())
11943 return;
11944 #ifdef FEAT_CMDHIST
11945 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11946 histype = str != NULL ? get_histtype(str) : -1;
11947 if (histype >= 0)
11949 str = get_tv_string_buf(&argvars[1], buf);
11950 if (*str != NUL)
11952 add_to_history(histype, str, FALSE, NUL);
11953 rettv->vval.v_number = TRUE;
11954 return;
11957 #endif
11961 * "histdel()" function
11963 /*ARGSUSED*/
11964 static void
11965 f_histdel(argvars, rettv)
11966 typval_T *argvars;
11967 typval_T *rettv;
11969 #ifdef FEAT_CMDHIST
11970 int n;
11971 char_u buf[NUMBUFLEN];
11972 char_u *str;
11974 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11975 if (str == NULL)
11976 n = 0;
11977 else if (argvars[1].v_type == VAR_UNKNOWN)
11978 /* only one argument: clear entire history */
11979 n = clr_history(get_histtype(str));
11980 else if (argvars[1].v_type == VAR_NUMBER)
11981 /* index given: remove that entry */
11982 n = del_history_idx(get_histtype(str),
11983 (int)get_tv_number(&argvars[1]));
11984 else
11985 /* string given: remove all matching entries */
11986 n = del_history_entry(get_histtype(str),
11987 get_tv_string_buf(&argvars[1], buf));
11988 rettv->vval.v_number = n;
11989 #else
11990 rettv->vval.v_number = 0;
11991 #endif
11995 * "histget()" function
11997 /*ARGSUSED*/
11998 static void
11999 f_histget(argvars, rettv)
12000 typval_T *argvars;
12001 typval_T *rettv;
12003 #ifdef FEAT_CMDHIST
12004 int type;
12005 int idx;
12006 char_u *str;
12008 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12009 if (str == NULL)
12010 rettv->vval.v_string = NULL;
12011 else
12013 type = get_histtype(str);
12014 if (argvars[1].v_type == VAR_UNKNOWN)
12015 idx = get_history_idx(type);
12016 else
12017 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12018 /* -1 on type error */
12019 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12021 #else
12022 rettv->vval.v_string = NULL;
12023 #endif
12024 rettv->v_type = VAR_STRING;
12028 * "histnr()" function
12030 /*ARGSUSED*/
12031 static void
12032 f_histnr(argvars, rettv)
12033 typval_T *argvars;
12034 typval_T *rettv;
12036 int i;
12038 #ifdef FEAT_CMDHIST
12039 char_u *history = get_tv_string_chk(&argvars[0]);
12041 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12042 if (i >= HIST_CMD && i < HIST_COUNT)
12043 i = get_history_idx(i);
12044 else
12045 #endif
12046 i = -1;
12047 rettv->vval.v_number = i;
12051 * "highlightID(name)" function
12053 static void
12054 f_hlID(argvars, rettv)
12055 typval_T *argvars;
12056 typval_T *rettv;
12058 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12062 * "highlight_exists()" function
12064 static void
12065 f_hlexists(argvars, rettv)
12066 typval_T *argvars;
12067 typval_T *rettv;
12069 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12073 * "hostname()" function
12075 /*ARGSUSED*/
12076 static void
12077 f_hostname(argvars, rettv)
12078 typval_T *argvars;
12079 typval_T *rettv;
12081 char_u hostname[256];
12083 mch_get_host_name(hostname, 256);
12084 rettv->v_type = VAR_STRING;
12085 rettv->vval.v_string = vim_strsave(hostname);
12089 * iconv() function
12091 /*ARGSUSED*/
12092 static void
12093 f_iconv(argvars, rettv)
12094 typval_T *argvars;
12095 typval_T *rettv;
12097 #ifdef FEAT_MBYTE
12098 char_u buf1[NUMBUFLEN];
12099 char_u buf2[NUMBUFLEN];
12100 char_u *from, *to, *str;
12101 vimconv_T vimconv;
12102 #endif
12104 rettv->v_type = VAR_STRING;
12105 rettv->vval.v_string = NULL;
12107 #ifdef FEAT_MBYTE
12108 str = get_tv_string(&argvars[0]);
12109 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12110 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12111 vimconv.vc_type = CONV_NONE;
12112 convert_setup(&vimconv, from, to);
12114 /* If the encodings are equal, no conversion needed. */
12115 if (vimconv.vc_type == CONV_NONE)
12116 rettv->vval.v_string = vim_strsave(str);
12117 else
12118 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12120 convert_setup(&vimconv, NULL, NULL);
12121 vim_free(from);
12122 vim_free(to);
12123 #endif
12127 * "indent()" function
12129 static void
12130 f_indent(argvars, rettv)
12131 typval_T *argvars;
12132 typval_T *rettv;
12134 linenr_T lnum;
12136 lnum = get_tv_lnum(argvars);
12137 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12138 rettv->vval.v_number = get_indent_lnum(lnum);
12139 else
12140 rettv->vval.v_number = -1;
12144 * "index()" function
12146 static void
12147 f_index(argvars, rettv)
12148 typval_T *argvars;
12149 typval_T *rettv;
12151 list_T *l;
12152 listitem_T *item;
12153 long idx = 0;
12154 int ic = FALSE;
12156 rettv->vval.v_number = -1;
12157 if (argvars[0].v_type != VAR_LIST)
12159 EMSG(_(e_listreq));
12160 return;
12162 l = argvars[0].vval.v_list;
12163 if (l != NULL)
12165 item = l->lv_first;
12166 if (argvars[2].v_type != VAR_UNKNOWN)
12168 int error = FALSE;
12170 /* Start at specified item. Use the cached index that list_find()
12171 * sets, so that a negative number also works. */
12172 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12173 idx = l->lv_idx;
12174 if (argvars[3].v_type != VAR_UNKNOWN)
12175 ic = get_tv_number_chk(&argvars[3], &error);
12176 if (error)
12177 item = NULL;
12180 for ( ; item != NULL; item = item->li_next, ++idx)
12181 if (tv_equal(&item->li_tv, &argvars[1], ic))
12183 rettv->vval.v_number = idx;
12184 break;
12189 static int inputsecret_flag = 0;
12191 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12194 * This function is used by f_input() and f_inputdialog() functions. The third
12195 * argument to f_input() specifies the type of completion to use at the
12196 * prompt. The third argument to f_inputdialog() specifies the value to return
12197 * when the user cancels the prompt.
12199 static void
12200 get_user_input(argvars, rettv, inputdialog)
12201 typval_T *argvars;
12202 typval_T *rettv;
12203 int inputdialog;
12205 char_u *prompt = get_tv_string_chk(&argvars[0]);
12206 char_u *p = NULL;
12207 int c;
12208 char_u buf[NUMBUFLEN];
12209 int cmd_silent_save = cmd_silent;
12210 char_u *defstr = (char_u *)"";
12211 int xp_type = EXPAND_NOTHING;
12212 char_u *xp_arg = NULL;
12214 rettv->v_type = VAR_STRING;
12215 rettv->vval.v_string = NULL;
12217 #ifdef NO_CONSOLE_INPUT
12218 /* While starting up, there is no place to enter text. */
12219 if (no_console_input())
12220 return;
12221 #endif
12223 cmd_silent = FALSE; /* Want to see the prompt. */
12224 if (prompt != NULL)
12226 /* Only the part of the message after the last NL is considered as
12227 * prompt for the command line */
12228 p = vim_strrchr(prompt, '\n');
12229 if (p == NULL)
12230 p = prompt;
12231 else
12233 ++p;
12234 c = *p;
12235 *p = NUL;
12236 msg_start();
12237 msg_clr_eos();
12238 msg_puts_attr(prompt, echo_attr);
12239 msg_didout = FALSE;
12240 msg_starthere();
12241 *p = c;
12243 cmdline_row = msg_row;
12245 if (argvars[1].v_type != VAR_UNKNOWN)
12247 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12248 if (defstr != NULL)
12249 stuffReadbuffSpec(defstr);
12251 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12253 char_u *xp_name;
12254 int xp_namelen;
12255 long argt;
12257 rettv->vval.v_string = NULL;
12259 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12260 if (xp_name == NULL)
12261 return;
12263 xp_namelen = (int)STRLEN(xp_name);
12265 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12266 &xp_arg) == FAIL)
12267 return;
12271 if (defstr != NULL)
12272 rettv->vval.v_string =
12273 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12274 xp_type, xp_arg);
12276 vim_free(xp_arg);
12278 /* since the user typed this, no need to wait for return */
12279 need_wait_return = FALSE;
12280 msg_didout = FALSE;
12282 cmd_silent = cmd_silent_save;
12286 * "input()" function
12287 * Also handles inputsecret() when inputsecret is set.
12289 static void
12290 f_input(argvars, rettv)
12291 typval_T *argvars;
12292 typval_T *rettv;
12294 get_user_input(argvars, rettv, FALSE);
12298 * "inputdialog()" function
12300 static void
12301 f_inputdialog(argvars, rettv)
12302 typval_T *argvars;
12303 typval_T *rettv;
12305 #if defined(FEAT_GUI_TEXTDIALOG)
12306 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12307 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12309 char_u *message;
12310 char_u buf[NUMBUFLEN];
12311 char_u *defstr = (char_u *)"";
12313 message = get_tv_string_chk(&argvars[0]);
12314 if (argvars[1].v_type != VAR_UNKNOWN
12315 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12316 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12317 else
12318 IObuff[0] = NUL;
12319 if (message != NULL && defstr != NULL
12320 && do_dialog(VIM_QUESTION, NULL, message,
12321 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12322 rettv->vval.v_string = vim_strsave(IObuff);
12323 else
12325 if (message != NULL && defstr != NULL
12326 && argvars[1].v_type != VAR_UNKNOWN
12327 && argvars[2].v_type != VAR_UNKNOWN)
12328 rettv->vval.v_string = vim_strsave(
12329 get_tv_string_buf(&argvars[2], buf));
12330 else
12331 rettv->vval.v_string = NULL;
12333 rettv->v_type = VAR_STRING;
12335 else
12336 #endif
12337 get_user_input(argvars, rettv, TRUE);
12341 * "inputlist()" function
12343 static void
12344 f_inputlist(argvars, rettv)
12345 typval_T *argvars;
12346 typval_T *rettv;
12348 listitem_T *li;
12349 int selected;
12350 int mouse_used;
12352 rettv->vval.v_number = 0;
12353 #ifdef NO_CONSOLE_INPUT
12354 /* While starting up, there is no place to enter text. */
12355 if (no_console_input())
12356 return;
12357 #endif
12358 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12360 EMSG2(_(e_listarg), "inputlist()");
12361 return;
12364 msg_start();
12365 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12366 lines_left = Rows; /* avoid more prompt */
12367 msg_scroll = TRUE;
12368 msg_clr_eos();
12370 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12372 msg_puts(get_tv_string(&li->li_tv));
12373 msg_putchar('\n');
12376 /* Ask for choice. */
12377 selected = prompt_for_number(&mouse_used);
12378 if (mouse_used)
12379 selected -= lines_left;
12381 rettv->vval.v_number = selected;
12385 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12388 * "inputrestore()" function
12390 /*ARGSUSED*/
12391 static void
12392 f_inputrestore(argvars, rettv)
12393 typval_T *argvars;
12394 typval_T *rettv;
12396 if (ga_userinput.ga_len > 0)
12398 --ga_userinput.ga_len;
12399 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12400 + ga_userinput.ga_len);
12401 rettv->vval.v_number = 0; /* OK */
12403 else if (p_verbose > 1)
12405 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12406 rettv->vval.v_number = 1; /* Failed */
12411 * "inputsave()" function
12413 /*ARGSUSED*/
12414 static void
12415 f_inputsave(argvars, rettv)
12416 typval_T *argvars;
12417 typval_T *rettv;
12419 /* Add an entry to the stack of typeahead storage. */
12420 if (ga_grow(&ga_userinput, 1) == OK)
12422 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12423 + ga_userinput.ga_len);
12424 ++ga_userinput.ga_len;
12425 rettv->vval.v_number = 0; /* OK */
12427 else
12428 rettv->vval.v_number = 1; /* Failed */
12432 * "inputsecret()" function
12434 static void
12435 f_inputsecret(argvars, rettv)
12436 typval_T *argvars;
12437 typval_T *rettv;
12439 ++cmdline_star;
12440 ++inputsecret_flag;
12441 f_input(argvars, rettv);
12442 --cmdline_star;
12443 --inputsecret_flag;
12447 * "insert()" function
12449 static void
12450 f_insert(argvars, rettv)
12451 typval_T *argvars;
12452 typval_T *rettv;
12454 long before = 0;
12455 listitem_T *item;
12456 list_T *l;
12457 int error = FALSE;
12459 rettv->vval.v_number = 0;
12460 if (argvars[0].v_type != VAR_LIST)
12461 EMSG2(_(e_listarg), "insert()");
12462 else if ((l = argvars[0].vval.v_list) != NULL
12463 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12465 if (argvars[2].v_type != VAR_UNKNOWN)
12466 before = get_tv_number_chk(&argvars[2], &error);
12467 if (error)
12468 return; /* type error; errmsg already given */
12470 if (before == l->lv_len)
12471 item = NULL;
12472 else
12474 item = list_find(l, before);
12475 if (item == NULL)
12477 EMSGN(_(e_listidx), before);
12478 l = NULL;
12481 if (l != NULL)
12483 list_insert_tv(l, &argvars[1], item);
12484 copy_tv(&argvars[0], rettv);
12490 * "isdirectory()" function
12492 static void
12493 f_isdirectory(argvars, rettv)
12494 typval_T *argvars;
12495 typval_T *rettv;
12497 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12501 * "islocked()" function
12503 static void
12504 f_islocked(argvars, rettv)
12505 typval_T *argvars;
12506 typval_T *rettv;
12508 lval_T lv;
12509 char_u *end;
12510 dictitem_T *di;
12512 rettv->vval.v_number = -1;
12513 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12514 FNE_CHECK_START);
12515 if (end != NULL && lv.ll_name != NULL)
12517 if (*end != NUL)
12518 EMSG(_(e_trailing));
12519 else
12521 if (lv.ll_tv == NULL)
12523 if (check_changedtick(lv.ll_name))
12524 rettv->vval.v_number = 1; /* always locked */
12525 else
12527 di = find_var(lv.ll_name, NULL);
12528 if (di != NULL)
12530 /* Consider a variable locked when:
12531 * 1. the variable itself is locked
12532 * 2. the value of the variable is locked.
12533 * 3. the List or Dict value is locked.
12535 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12536 || tv_islocked(&di->di_tv));
12540 else if (lv.ll_range)
12541 EMSG(_("E786: Range not allowed"));
12542 else if (lv.ll_newkey != NULL)
12543 EMSG2(_(e_dictkey), lv.ll_newkey);
12544 else if (lv.ll_list != NULL)
12545 /* List item. */
12546 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12547 else
12548 /* Dictionary item. */
12549 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12553 clear_lval(&lv);
12556 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12559 * Turn a dict into a list:
12560 * "what" == 0: list of keys
12561 * "what" == 1: list of values
12562 * "what" == 2: list of items
12564 static void
12565 dict_list(argvars, rettv, what)
12566 typval_T *argvars;
12567 typval_T *rettv;
12568 int what;
12570 list_T *l2;
12571 dictitem_T *di;
12572 hashitem_T *hi;
12573 listitem_T *li;
12574 listitem_T *li2;
12575 dict_T *d;
12576 int todo;
12578 rettv->vval.v_number = 0;
12579 if (argvars[0].v_type != VAR_DICT)
12581 EMSG(_(e_dictreq));
12582 return;
12584 if ((d = argvars[0].vval.v_dict) == NULL)
12585 return;
12587 if (rettv_list_alloc(rettv) == FAIL)
12588 return;
12590 todo = (int)d->dv_hashtab.ht_used;
12591 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12593 if (!HASHITEM_EMPTY(hi))
12595 --todo;
12596 di = HI2DI(hi);
12598 li = listitem_alloc();
12599 if (li == NULL)
12600 break;
12601 list_append(rettv->vval.v_list, li);
12603 if (what == 0)
12605 /* keys() */
12606 li->li_tv.v_type = VAR_STRING;
12607 li->li_tv.v_lock = 0;
12608 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12610 else if (what == 1)
12612 /* values() */
12613 copy_tv(&di->di_tv, &li->li_tv);
12615 else
12617 /* items() */
12618 l2 = list_alloc();
12619 li->li_tv.v_type = VAR_LIST;
12620 li->li_tv.v_lock = 0;
12621 li->li_tv.vval.v_list = l2;
12622 if (l2 == NULL)
12623 break;
12624 ++l2->lv_refcount;
12626 li2 = listitem_alloc();
12627 if (li2 == NULL)
12628 break;
12629 list_append(l2, li2);
12630 li2->li_tv.v_type = VAR_STRING;
12631 li2->li_tv.v_lock = 0;
12632 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12634 li2 = listitem_alloc();
12635 if (li2 == NULL)
12636 break;
12637 list_append(l2, li2);
12638 copy_tv(&di->di_tv, &li2->li_tv);
12645 * "items(dict)" function
12647 static void
12648 f_items(argvars, rettv)
12649 typval_T *argvars;
12650 typval_T *rettv;
12652 dict_list(argvars, rettv, 2);
12656 * "join()" function
12658 static void
12659 f_join(argvars, rettv)
12660 typval_T *argvars;
12661 typval_T *rettv;
12663 garray_T ga;
12664 char_u *sep;
12666 rettv->vval.v_number = 0;
12667 if (argvars[0].v_type != VAR_LIST)
12669 EMSG(_(e_listreq));
12670 return;
12672 if (argvars[0].vval.v_list == NULL)
12673 return;
12674 if (argvars[1].v_type == VAR_UNKNOWN)
12675 sep = (char_u *)" ";
12676 else
12677 sep = get_tv_string_chk(&argvars[1]);
12679 rettv->v_type = VAR_STRING;
12681 if (sep != NULL)
12683 ga_init2(&ga, (int)sizeof(char), 80);
12684 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12685 ga_append(&ga, NUL);
12686 rettv->vval.v_string = (char_u *)ga.ga_data;
12688 else
12689 rettv->vval.v_string = NULL;
12693 * "keys()" function
12695 static void
12696 f_keys(argvars, rettv)
12697 typval_T *argvars;
12698 typval_T *rettv;
12700 dict_list(argvars, rettv, 0);
12704 * "last_buffer_nr()" function.
12706 /*ARGSUSED*/
12707 static void
12708 f_last_buffer_nr(argvars, rettv)
12709 typval_T *argvars;
12710 typval_T *rettv;
12712 int n = 0;
12713 buf_T *buf;
12715 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12716 if (n < buf->b_fnum)
12717 n = buf->b_fnum;
12719 rettv->vval.v_number = n;
12723 * "len()" function
12725 static void
12726 f_len(argvars, rettv)
12727 typval_T *argvars;
12728 typval_T *rettv;
12730 switch (argvars[0].v_type)
12732 case VAR_STRING:
12733 case VAR_NUMBER:
12734 rettv->vval.v_number = (varnumber_T)STRLEN(
12735 get_tv_string(&argvars[0]));
12736 break;
12737 case VAR_LIST:
12738 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12739 break;
12740 case VAR_DICT:
12741 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12742 break;
12743 default:
12744 EMSG(_("E701: Invalid type for len()"));
12745 break;
12749 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12751 static void
12752 libcall_common(argvars, rettv, type)
12753 typval_T *argvars;
12754 typval_T *rettv;
12755 int type;
12757 #ifdef FEAT_LIBCALL
12758 char_u *string_in;
12759 char_u **string_result;
12760 int nr_result;
12761 #endif
12763 rettv->v_type = type;
12764 if (type == VAR_NUMBER)
12765 rettv->vval.v_number = 0;
12766 else
12767 rettv->vval.v_string = NULL;
12769 if (check_restricted() || check_secure())
12770 return;
12772 #ifdef FEAT_LIBCALL
12773 /* The first two args must be strings, otherwise its meaningless */
12774 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12776 string_in = NULL;
12777 if (argvars[2].v_type == VAR_STRING)
12778 string_in = argvars[2].vval.v_string;
12779 if (type == VAR_NUMBER)
12780 string_result = NULL;
12781 else
12782 string_result = &rettv->vval.v_string;
12783 if (mch_libcall(argvars[0].vval.v_string,
12784 argvars[1].vval.v_string,
12785 string_in,
12786 argvars[2].vval.v_number,
12787 string_result,
12788 &nr_result) == OK
12789 && type == VAR_NUMBER)
12790 rettv->vval.v_number = nr_result;
12792 #endif
12796 * "libcall()" function
12798 static void
12799 f_libcall(argvars, rettv)
12800 typval_T *argvars;
12801 typval_T *rettv;
12803 libcall_common(argvars, rettv, VAR_STRING);
12807 * "libcallnr()" function
12809 static void
12810 f_libcallnr(argvars, rettv)
12811 typval_T *argvars;
12812 typval_T *rettv;
12814 libcall_common(argvars, rettv, VAR_NUMBER);
12818 * "line(string)" function
12820 static void
12821 f_line(argvars, rettv)
12822 typval_T *argvars;
12823 typval_T *rettv;
12825 linenr_T lnum = 0;
12826 pos_T *fp;
12827 int fnum;
12829 fp = var2fpos(&argvars[0], TRUE, &fnum);
12830 if (fp != NULL)
12831 lnum = fp->lnum;
12832 rettv->vval.v_number = lnum;
12836 * "line2byte(lnum)" function
12838 /*ARGSUSED*/
12839 static void
12840 f_line2byte(argvars, rettv)
12841 typval_T *argvars;
12842 typval_T *rettv;
12844 #ifndef FEAT_BYTEOFF
12845 rettv->vval.v_number = -1;
12846 #else
12847 linenr_T lnum;
12849 lnum = get_tv_lnum(argvars);
12850 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12851 rettv->vval.v_number = -1;
12852 else
12853 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12854 if (rettv->vval.v_number >= 0)
12855 ++rettv->vval.v_number;
12856 #endif
12860 * "lispindent(lnum)" function
12862 static void
12863 f_lispindent(argvars, rettv)
12864 typval_T *argvars;
12865 typval_T *rettv;
12867 #ifdef FEAT_LISP
12868 pos_T pos;
12869 linenr_T lnum;
12871 pos = curwin->w_cursor;
12872 lnum = get_tv_lnum(argvars);
12873 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12875 curwin->w_cursor.lnum = lnum;
12876 rettv->vval.v_number = get_lisp_indent();
12877 curwin->w_cursor = pos;
12879 else
12880 #endif
12881 rettv->vval.v_number = -1;
12885 * "localtime()" function
12887 /*ARGSUSED*/
12888 static void
12889 f_localtime(argvars, rettv)
12890 typval_T *argvars;
12891 typval_T *rettv;
12893 rettv->vval.v_number = (varnumber_T)time(NULL);
12896 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12898 static void
12899 get_maparg(argvars, rettv, exact)
12900 typval_T *argvars;
12901 typval_T *rettv;
12902 int exact;
12904 char_u *keys;
12905 char_u *which;
12906 char_u buf[NUMBUFLEN];
12907 char_u *keys_buf = NULL;
12908 char_u *rhs;
12909 int mode;
12910 garray_T ga;
12911 int abbr = FALSE;
12913 /* return empty string for failure */
12914 rettv->v_type = VAR_STRING;
12915 rettv->vval.v_string = NULL;
12917 keys = get_tv_string(&argvars[0]);
12918 if (*keys == NUL)
12919 return;
12921 if (argvars[1].v_type != VAR_UNKNOWN)
12923 which = get_tv_string_buf_chk(&argvars[1], buf);
12924 if (argvars[2].v_type != VAR_UNKNOWN)
12925 abbr = get_tv_number(&argvars[2]);
12927 else
12928 which = (char_u *)"";
12929 if (which == NULL)
12930 return;
12932 mode = get_map_mode(&which, 0);
12934 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12935 rhs = check_map(keys, mode, exact, FALSE, abbr);
12936 vim_free(keys_buf);
12937 if (rhs != NULL)
12939 ga_init(&ga);
12940 ga.ga_itemsize = 1;
12941 ga.ga_growsize = 40;
12943 while (*rhs != NUL)
12944 ga_concat(&ga, str2special(&rhs, FALSE));
12946 ga_append(&ga, NUL);
12947 rettv->vval.v_string = (char_u *)ga.ga_data;
12951 #ifdef FEAT_FLOAT
12953 * "log10()" function
12955 static void
12956 f_log10(argvars, rettv)
12957 typval_T *argvars;
12958 typval_T *rettv;
12960 float_T f;
12962 rettv->v_type = VAR_FLOAT;
12963 if (get_float_arg(argvars, &f) == OK)
12964 rettv->vval.v_float = log10(f);
12965 else
12966 rettv->vval.v_float = 0.0;
12968 #endif
12971 * "map()" function
12973 static void
12974 f_map(argvars, rettv)
12975 typval_T *argvars;
12976 typval_T *rettv;
12978 filter_map(argvars, rettv, TRUE);
12982 * "maparg()" function
12984 static void
12985 f_maparg(argvars, rettv)
12986 typval_T *argvars;
12987 typval_T *rettv;
12989 get_maparg(argvars, rettv, TRUE);
12993 * "mapcheck()" function
12995 static void
12996 f_mapcheck(argvars, rettv)
12997 typval_T *argvars;
12998 typval_T *rettv;
13000 get_maparg(argvars, rettv, FALSE);
13003 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13005 static void
13006 find_some_match(argvars, rettv, type)
13007 typval_T *argvars;
13008 typval_T *rettv;
13009 int type;
13011 char_u *str = NULL;
13012 char_u *expr = NULL;
13013 char_u *pat;
13014 regmatch_T regmatch;
13015 char_u patbuf[NUMBUFLEN];
13016 char_u strbuf[NUMBUFLEN];
13017 char_u *save_cpo;
13018 long start = 0;
13019 long nth = 1;
13020 colnr_T startcol = 0;
13021 int match = 0;
13022 list_T *l = NULL;
13023 listitem_T *li = NULL;
13024 long idx = 0;
13025 char_u *tofree = NULL;
13027 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13028 save_cpo = p_cpo;
13029 p_cpo = (char_u *)"";
13031 rettv->vval.v_number = -1;
13032 if (type == 3)
13034 /* return empty list when there are no matches */
13035 if (rettv_list_alloc(rettv) == FAIL)
13036 goto theend;
13038 else if (type == 2)
13040 rettv->v_type = VAR_STRING;
13041 rettv->vval.v_string = NULL;
13044 if (argvars[0].v_type == VAR_LIST)
13046 if ((l = argvars[0].vval.v_list) == NULL)
13047 goto theend;
13048 li = l->lv_first;
13050 else
13051 expr = str = get_tv_string(&argvars[0]);
13053 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13054 if (pat == NULL)
13055 goto theend;
13057 if (argvars[2].v_type != VAR_UNKNOWN)
13059 int error = FALSE;
13061 start = get_tv_number_chk(&argvars[2], &error);
13062 if (error)
13063 goto theend;
13064 if (l != NULL)
13066 li = list_find(l, start);
13067 if (li == NULL)
13068 goto theend;
13069 idx = l->lv_idx; /* use the cached index */
13071 else
13073 if (start < 0)
13074 start = 0;
13075 if (start > (long)STRLEN(str))
13076 goto theend;
13077 /* When "count" argument is there ignore matches before "start",
13078 * otherwise skip part of the string. Differs when pattern is "^"
13079 * or "\<". */
13080 if (argvars[3].v_type != VAR_UNKNOWN)
13081 startcol = start;
13082 else
13083 str += start;
13086 if (argvars[3].v_type != VAR_UNKNOWN)
13087 nth = get_tv_number_chk(&argvars[3], &error);
13088 if (error)
13089 goto theend;
13092 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13093 if (regmatch.regprog != NULL)
13095 regmatch.rm_ic = p_ic;
13097 for (;;)
13099 if (l != NULL)
13101 if (li == NULL)
13103 match = FALSE;
13104 break;
13106 vim_free(tofree);
13107 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13108 if (str == NULL)
13109 break;
13112 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13114 if (match && --nth <= 0)
13115 break;
13116 if (l == NULL && !match)
13117 break;
13119 /* Advance to just after the match. */
13120 if (l != NULL)
13122 li = li->li_next;
13123 ++idx;
13125 else
13127 #ifdef FEAT_MBYTE
13128 startcol = (colnr_T)(regmatch.startp[0]
13129 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13130 #else
13131 startcol = regmatch.startp[0] + 1 - str;
13132 #endif
13136 if (match)
13138 if (type == 3)
13140 int i;
13142 /* return list with matched string and submatches */
13143 for (i = 0; i < NSUBEXP; ++i)
13145 if (regmatch.endp[i] == NULL)
13147 if (list_append_string(rettv->vval.v_list,
13148 (char_u *)"", 0) == FAIL)
13149 break;
13151 else if (list_append_string(rettv->vval.v_list,
13152 regmatch.startp[i],
13153 (int)(regmatch.endp[i] - regmatch.startp[i]))
13154 == FAIL)
13155 break;
13158 else if (type == 2)
13160 /* return matched string */
13161 if (l != NULL)
13162 copy_tv(&li->li_tv, rettv);
13163 else
13164 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13165 (int)(regmatch.endp[0] - regmatch.startp[0]));
13167 else if (l != NULL)
13168 rettv->vval.v_number = idx;
13169 else
13171 if (type != 0)
13172 rettv->vval.v_number =
13173 (varnumber_T)(regmatch.startp[0] - str);
13174 else
13175 rettv->vval.v_number =
13176 (varnumber_T)(regmatch.endp[0] - str);
13177 rettv->vval.v_number += (varnumber_T)(str - expr);
13180 vim_free(regmatch.regprog);
13183 theend:
13184 vim_free(tofree);
13185 p_cpo = save_cpo;
13189 * "match()" function
13191 static void
13192 f_match(argvars, rettv)
13193 typval_T *argvars;
13194 typval_T *rettv;
13196 find_some_match(argvars, rettv, 1);
13200 * "matchadd()" function
13202 static void
13203 f_matchadd(argvars, rettv)
13204 typval_T *argvars;
13205 typval_T *rettv;
13207 #ifdef FEAT_SEARCH_EXTRA
13208 char_u buf[NUMBUFLEN];
13209 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13210 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13211 int prio = 10; /* default priority */
13212 int id = -1;
13213 int error = FALSE;
13215 rettv->vval.v_number = -1;
13217 if (grp == NULL || pat == NULL)
13218 return;
13219 if (argvars[2].v_type != VAR_UNKNOWN)
13221 prio = get_tv_number_chk(&argvars[2], &error);
13222 if (argvars[3].v_type != VAR_UNKNOWN)
13223 id = get_tv_number_chk(&argvars[3], &error);
13225 if (error == TRUE)
13226 return;
13227 if (id >= 1 && id <= 3)
13229 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13230 return;
13233 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13234 #endif
13238 * "matcharg()" function
13240 static void
13241 f_matcharg(argvars, rettv)
13242 typval_T *argvars;
13243 typval_T *rettv;
13245 if (rettv_list_alloc(rettv) == OK)
13247 #ifdef FEAT_SEARCH_EXTRA
13248 int id = get_tv_number(&argvars[0]);
13249 matchitem_T *m;
13251 if (id >= 1 && id <= 3)
13253 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13255 list_append_string(rettv->vval.v_list,
13256 syn_id2name(m->hlg_id), -1);
13257 list_append_string(rettv->vval.v_list, m->pattern, -1);
13259 else
13261 list_append_string(rettv->vval.v_list, NUL, -1);
13262 list_append_string(rettv->vval.v_list, NUL, -1);
13265 #endif
13270 * "matchdelete()" function
13272 static void
13273 f_matchdelete(argvars, rettv)
13274 typval_T *argvars;
13275 typval_T *rettv;
13277 #ifdef FEAT_SEARCH_EXTRA
13278 rettv->vval.v_number = match_delete(curwin,
13279 (int)get_tv_number(&argvars[0]), TRUE);
13280 #endif
13284 * "matchend()" function
13286 static void
13287 f_matchend(argvars, rettv)
13288 typval_T *argvars;
13289 typval_T *rettv;
13291 find_some_match(argvars, rettv, 0);
13295 * "matchlist()" function
13297 static void
13298 f_matchlist(argvars, rettv)
13299 typval_T *argvars;
13300 typval_T *rettv;
13302 find_some_match(argvars, rettv, 3);
13306 * "matchstr()" function
13308 static void
13309 f_matchstr(argvars, rettv)
13310 typval_T *argvars;
13311 typval_T *rettv;
13313 find_some_match(argvars, rettv, 2);
13316 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13318 static void
13319 max_min(argvars, rettv, domax)
13320 typval_T *argvars;
13321 typval_T *rettv;
13322 int domax;
13324 long n = 0;
13325 long i;
13326 int error = FALSE;
13328 if (argvars[0].v_type == VAR_LIST)
13330 list_T *l;
13331 listitem_T *li;
13333 l = argvars[0].vval.v_list;
13334 if (l != NULL)
13336 li = l->lv_first;
13337 if (li != NULL)
13339 n = get_tv_number_chk(&li->li_tv, &error);
13340 for (;;)
13342 li = li->li_next;
13343 if (li == NULL)
13344 break;
13345 i = get_tv_number_chk(&li->li_tv, &error);
13346 if (domax ? i > n : i < n)
13347 n = i;
13352 else if (argvars[0].v_type == VAR_DICT)
13354 dict_T *d;
13355 int first = TRUE;
13356 hashitem_T *hi;
13357 int todo;
13359 d = argvars[0].vval.v_dict;
13360 if (d != NULL)
13362 todo = (int)d->dv_hashtab.ht_used;
13363 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13365 if (!HASHITEM_EMPTY(hi))
13367 --todo;
13368 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13369 if (first)
13371 n = i;
13372 first = FALSE;
13374 else if (domax ? i > n : i < n)
13375 n = i;
13380 else
13381 EMSG(_(e_listdictarg));
13382 rettv->vval.v_number = error ? 0 : n;
13386 * "max()" function
13388 static void
13389 f_max(argvars, rettv)
13390 typval_T *argvars;
13391 typval_T *rettv;
13393 max_min(argvars, rettv, TRUE);
13397 * "min()" function
13399 static void
13400 f_min(argvars, rettv)
13401 typval_T *argvars;
13402 typval_T *rettv;
13404 max_min(argvars, rettv, FALSE);
13407 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13410 * Create the directory in which "dir" is located, and higher levels when
13411 * needed.
13413 static int
13414 mkdir_recurse(dir, prot)
13415 char_u *dir;
13416 int prot;
13418 char_u *p;
13419 char_u *updir;
13420 int r = FAIL;
13422 /* Get end of directory name in "dir".
13423 * We're done when it's "/" or "c:/". */
13424 p = gettail_sep(dir);
13425 if (p <= get_past_head(dir))
13426 return OK;
13428 /* If the directory exists we're done. Otherwise: create it.*/
13429 updir = vim_strnsave(dir, (int)(p - dir));
13430 if (updir == NULL)
13431 return FAIL;
13432 if (mch_isdir(updir))
13433 r = OK;
13434 else if (mkdir_recurse(updir, prot) == OK)
13435 r = vim_mkdir_emsg(updir, prot);
13436 vim_free(updir);
13437 return r;
13440 #ifdef vim_mkdir
13442 * "mkdir()" function
13444 static void
13445 f_mkdir(argvars, rettv)
13446 typval_T *argvars;
13447 typval_T *rettv;
13449 char_u *dir;
13450 char_u buf[NUMBUFLEN];
13451 int prot = 0755;
13453 rettv->vval.v_number = FAIL;
13454 if (check_restricted() || check_secure())
13455 return;
13457 dir = get_tv_string_buf(&argvars[0], buf);
13458 if (argvars[1].v_type != VAR_UNKNOWN)
13460 if (argvars[2].v_type != VAR_UNKNOWN)
13461 prot = get_tv_number_chk(&argvars[2], NULL);
13462 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13463 mkdir_recurse(dir, prot);
13465 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13467 #endif
13470 * "mode()" function
13472 /*ARGSUSED*/
13473 static void
13474 f_mode(argvars, rettv)
13475 typval_T *argvars;
13476 typval_T *rettv;
13478 char_u buf[3];
13480 buf[1] = NUL;
13481 buf[2] = NUL;
13483 #ifdef FEAT_VISUAL
13484 if (VIsual_active)
13486 if (VIsual_select)
13487 buf[0] = VIsual_mode + 's' - 'v';
13488 else
13489 buf[0] = VIsual_mode;
13491 else
13492 #endif
13493 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13494 || State == CONFIRM)
13496 buf[0] = 'r';
13497 if (State == ASKMORE)
13498 buf[1] = 'm';
13499 else if (State == CONFIRM)
13500 buf[1] = '?';
13502 else if (State == EXTERNCMD)
13503 buf[0] = '!';
13504 else if (State & INSERT)
13506 #ifdef FEAT_VREPLACE
13507 if (State & VREPLACE_FLAG)
13509 buf[0] = 'R';
13510 buf[1] = 'v';
13512 else
13513 #endif
13514 if (State & REPLACE_FLAG)
13515 buf[0] = 'R';
13516 else
13517 buf[0] = 'i';
13519 else if (State & CMDLINE)
13521 buf[0] = 'c';
13522 if (exmode_active)
13523 buf[1] = 'v';
13525 else if (exmode_active)
13527 buf[0] = 'c';
13528 buf[1] = 'e';
13530 else
13532 buf[0] = 'n';
13533 if (finish_op)
13534 buf[1] = 'o';
13537 /* Clear out the minor mode when the argument is not a non-zero number or
13538 * non-empty string. */
13539 if (!non_zero_arg(&argvars[0]))
13540 buf[1] = NUL;
13542 rettv->vval.v_string = vim_strsave(buf);
13543 rettv->v_type = VAR_STRING;
13547 * "nextnonblank()" function
13549 static void
13550 f_nextnonblank(argvars, rettv)
13551 typval_T *argvars;
13552 typval_T *rettv;
13554 linenr_T lnum;
13556 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13558 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13560 lnum = 0;
13561 break;
13563 if (*skipwhite(ml_get(lnum)) != NUL)
13564 break;
13566 rettv->vval.v_number = lnum;
13570 * "nr2char()" function
13572 static void
13573 f_nr2char(argvars, rettv)
13574 typval_T *argvars;
13575 typval_T *rettv;
13577 char_u buf[NUMBUFLEN];
13579 #ifdef FEAT_MBYTE
13580 if (has_mbyte)
13581 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13582 else
13583 #endif
13585 buf[0] = (char_u)get_tv_number(&argvars[0]);
13586 buf[1] = NUL;
13588 rettv->v_type = VAR_STRING;
13589 rettv->vval.v_string = vim_strsave(buf);
13593 * "pathshorten()" function
13595 static void
13596 f_pathshorten(argvars, rettv)
13597 typval_T *argvars;
13598 typval_T *rettv;
13600 char_u *p;
13602 rettv->v_type = VAR_STRING;
13603 p = get_tv_string_chk(&argvars[0]);
13604 if (p == NULL)
13605 rettv->vval.v_string = NULL;
13606 else
13608 p = vim_strsave(p);
13609 rettv->vval.v_string = p;
13610 if (p != NULL)
13611 shorten_dir(p);
13615 #ifdef FEAT_FLOAT
13617 * "pow()" function
13619 static void
13620 f_pow(argvars, rettv)
13621 typval_T *argvars;
13622 typval_T *rettv;
13624 float_T fx, fy;
13626 rettv->v_type = VAR_FLOAT;
13627 if (get_float_arg(argvars, &fx) == OK
13628 && get_float_arg(&argvars[1], &fy) == OK)
13629 rettv->vval.v_float = pow(fx, fy);
13630 else
13631 rettv->vval.v_float = 0.0;
13633 #endif
13636 * "prevnonblank()" function
13638 static void
13639 f_prevnonblank(argvars, rettv)
13640 typval_T *argvars;
13641 typval_T *rettv;
13643 linenr_T lnum;
13645 lnum = get_tv_lnum(argvars);
13646 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13647 lnum = 0;
13648 else
13649 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13650 --lnum;
13651 rettv->vval.v_number = lnum;
13654 #ifdef HAVE_STDARG_H
13655 /* This dummy va_list is here because:
13656 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13657 * - locally in the function results in a "used before set" warning
13658 * - using va_start() to initialize it gives "function with fixed args" error */
13659 static va_list ap;
13660 #endif
13663 * "printf()" function
13665 static void
13666 f_printf(argvars, rettv)
13667 typval_T *argvars;
13668 typval_T *rettv;
13670 rettv->v_type = VAR_STRING;
13671 rettv->vval.v_string = NULL;
13672 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13674 char_u buf[NUMBUFLEN];
13675 int len;
13676 char_u *s;
13677 int saved_did_emsg = did_emsg;
13678 char *fmt;
13680 /* Get the required length, allocate the buffer and do it for real. */
13681 did_emsg = FALSE;
13682 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13683 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13684 if (!did_emsg)
13686 s = alloc(len + 1);
13687 if (s != NULL)
13689 rettv->vval.v_string = s;
13690 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13693 did_emsg |= saved_did_emsg;
13695 #endif
13699 * "pumvisible()" function
13701 /*ARGSUSED*/
13702 static void
13703 f_pumvisible(argvars, rettv)
13704 typval_T *argvars;
13705 typval_T *rettv;
13707 rettv->vval.v_number = 0;
13708 #ifdef FEAT_INS_EXPAND
13709 if (pum_visible())
13710 rettv->vval.v_number = 1;
13711 #endif
13715 * "range()" function
13717 static void
13718 f_range(argvars, rettv)
13719 typval_T *argvars;
13720 typval_T *rettv;
13722 long start;
13723 long end;
13724 long stride = 1;
13725 long i;
13726 int error = FALSE;
13728 start = get_tv_number_chk(&argvars[0], &error);
13729 if (argvars[1].v_type == VAR_UNKNOWN)
13731 end = start - 1;
13732 start = 0;
13734 else
13736 end = get_tv_number_chk(&argvars[1], &error);
13737 if (argvars[2].v_type != VAR_UNKNOWN)
13738 stride = get_tv_number_chk(&argvars[2], &error);
13741 rettv->vval.v_number = 0;
13742 if (error)
13743 return; /* type error; errmsg already given */
13744 if (stride == 0)
13745 EMSG(_("E726: Stride is zero"));
13746 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13747 EMSG(_("E727: Start past end"));
13748 else
13750 if (rettv_list_alloc(rettv) == OK)
13751 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13752 if (list_append_number(rettv->vval.v_list,
13753 (varnumber_T)i) == FAIL)
13754 break;
13759 * "readfile()" function
13761 static void
13762 f_readfile(argvars, rettv)
13763 typval_T *argvars;
13764 typval_T *rettv;
13766 int binary = FALSE;
13767 char_u *fname;
13768 FILE *fd;
13769 listitem_T *li;
13770 #define FREAD_SIZE 200 /* optimized for text lines */
13771 char_u buf[FREAD_SIZE];
13772 int readlen; /* size of last fread() */
13773 int buflen; /* nr of valid chars in buf[] */
13774 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13775 int tolist; /* first byte in buf[] still to be put in list */
13776 int chop; /* how many CR to chop off */
13777 char_u *prev = NULL; /* previously read bytes, if any */
13778 int prevlen = 0; /* length of "prev" if not NULL */
13779 char_u *s;
13780 int len;
13781 long maxline = MAXLNUM;
13782 long cnt = 0;
13784 if (argvars[1].v_type != VAR_UNKNOWN)
13786 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13787 binary = TRUE;
13788 if (argvars[2].v_type != VAR_UNKNOWN)
13789 maxline = get_tv_number(&argvars[2]);
13792 if (rettv_list_alloc(rettv) == FAIL)
13793 return;
13795 /* Always open the file in binary mode, library functions have a mind of
13796 * their own about CR-LF conversion. */
13797 fname = get_tv_string(&argvars[0]);
13798 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13800 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13801 return;
13804 filtd = 0;
13805 while (cnt < maxline || maxline < 0)
13807 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13808 buflen = filtd + readlen;
13809 tolist = 0;
13810 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13812 if (buf[filtd] == '\n' || readlen <= 0)
13814 /* Only when in binary mode add an empty list item when the
13815 * last line ends in a '\n'. */
13816 if (!binary && readlen == 0 && filtd == 0)
13817 break;
13819 /* Found end-of-line or end-of-file: add a text line to the
13820 * list. */
13821 chop = 0;
13822 if (!binary)
13823 while (filtd - chop - 1 >= tolist
13824 && buf[filtd - chop - 1] == '\r')
13825 ++chop;
13826 len = filtd - tolist - chop;
13827 if (prev == NULL)
13828 s = vim_strnsave(buf + tolist, len);
13829 else
13831 s = alloc((unsigned)(prevlen + len + 1));
13832 if (s != NULL)
13834 mch_memmove(s, prev, prevlen);
13835 vim_free(prev);
13836 prev = NULL;
13837 mch_memmove(s + prevlen, buf + tolist, len);
13838 s[prevlen + len] = NUL;
13841 tolist = filtd + 1;
13843 li = listitem_alloc();
13844 if (li == NULL)
13846 vim_free(s);
13847 break;
13849 li->li_tv.v_type = VAR_STRING;
13850 li->li_tv.v_lock = 0;
13851 li->li_tv.vval.v_string = s;
13852 list_append(rettv->vval.v_list, li);
13854 if (++cnt >= maxline && maxline >= 0)
13855 break;
13856 if (readlen <= 0)
13857 break;
13859 else if (buf[filtd] == NUL)
13860 buf[filtd] = '\n';
13862 if (readlen <= 0)
13863 break;
13865 if (tolist == 0)
13867 /* "buf" is full, need to move text to an allocated buffer */
13868 if (prev == NULL)
13870 prev = vim_strnsave(buf, buflen);
13871 prevlen = buflen;
13873 else
13875 s = alloc((unsigned)(prevlen + buflen));
13876 if (s != NULL)
13878 mch_memmove(s, prev, prevlen);
13879 mch_memmove(s + prevlen, buf, buflen);
13880 vim_free(prev);
13881 prev = s;
13882 prevlen += buflen;
13885 filtd = 0;
13887 else
13889 mch_memmove(buf, buf + tolist, buflen - tolist);
13890 filtd -= tolist;
13895 * For a negative line count use only the lines at the end of the file,
13896 * free the rest.
13898 if (maxline < 0)
13899 while (cnt > -maxline)
13901 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13902 --cnt;
13905 vim_free(prev);
13906 fclose(fd);
13909 #if defined(FEAT_RELTIME)
13910 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13913 * Convert a List to proftime_T.
13914 * Return FAIL when there is something wrong.
13916 static int
13917 list2proftime(arg, tm)
13918 typval_T *arg;
13919 proftime_T *tm;
13921 long n1, n2;
13922 int error = FALSE;
13924 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13925 || arg->vval.v_list->lv_len != 2)
13926 return FAIL;
13927 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13928 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13929 # ifdef WIN3264
13930 tm->HighPart = n1;
13931 tm->LowPart = n2;
13932 # else
13933 tm->tv_sec = n1;
13934 tm->tv_usec = n2;
13935 # endif
13936 return error ? FAIL : OK;
13938 #endif /* FEAT_RELTIME */
13941 * "reltime()" function
13943 static void
13944 f_reltime(argvars, rettv)
13945 typval_T *argvars;
13946 typval_T *rettv;
13948 #ifdef FEAT_RELTIME
13949 proftime_T res;
13950 proftime_T start;
13952 if (argvars[0].v_type == VAR_UNKNOWN)
13954 /* No arguments: get current time. */
13955 profile_start(&res);
13957 else if (argvars[1].v_type == VAR_UNKNOWN)
13959 if (list2proftime(&argvars[0], &res) == FAIL)
13960 return;
13961 profile_end(&res);
13963 else
13965 /* Two arguments: compute the difference. */
13966 if (list2proftime(&argvars[0], &start) == FAIL
13967 || list2proftime(&argvars[1], &res) == FAIL)
13968 return;
13969 profile_sub(&res, &start);
13972 if (rettv_list_alloc(rettv) == OK)
13974 long n1, n2;
13976 # ifdef WIN3264
13977 n1 = res.HighPart;
13978 n2 = res.LowPart;
13979 # else
13980 n1 = res.tv_sec;
13981 n2 = res.tv_usec;
13982 # endif
13983 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
13984 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
13986 #endif
13990 * "reltimestr()" function
13992 static void
13993 f_reltimestr(argvars, rettv)
13994 typval_T *argvars;
13995 typval_T *rettv;
13997 #ifdef FEAT_RELTIME
13998 proftime_T tm;
13999 #endif
14001 rettv->v_type = VAR_STRING;
14002 rettv->vval.v_string = NULL;
14003 #ifdef FEAT_RELTIME
14004 if (list2proftime(&argvars[0], &tm) == OK)
14005 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14006 #endif
14009 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14010 static void make_connection __ARGS((void));
14011 static int check_connection __ARGS((void));
14013 static void
14014 make_connection()
14016 if (X_DISPLAY == NULL
14017 # ifdef FEAT_GUI
14018 && !gui.in_use
14019 # endif
14022 x_force_connect = TRUE;
14023 setup_term_clip();
14024 x_force_connect = FALSE;
14028 static int
14029 check_connection()
14031 make_connection();
14032 if (X_DISPLAY == NULL)
14034 EMSG(_("E240: No connection to Vim server"));
14035 return FAIL;
14037 return OK;
14039 #endif
14041 #ifdef FEAT_CLIENTSERVER
14042 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14044 static void
14045 remote_common(argvars, rettv, expr)
14046 typval_T *argvars;
14047 typval_T *rettv;
14048 int expr;
14050 char_u *server_name;
14051 char_u *keys;
14052 char_u *r = NULL;
14053 char_u buf[NUMBUFLEN];
14054 # ifdef WIN32
14055 HWND w;
14056 # elif defined(FEAT_X11)
14057 Window w;
14058 # elif defined(MAC_CLIENTSERVER)
14059 int w; // This is the port number ('w' is a bit confusing)
14060 # endif
14062 if (check_restricted() || check_secure())
14063 return;
14065 # ifdef FEAT_X11
14066 if (check_connection() == FAIL)
14067 return;
14068 # endif
14070 server_name = get_tv_string_chk(&argvars[0]);
14071 if (server_name == NULL)
14072 return; /* type error; errmsg already given */
14073 keys = get_tv_string_buf(&argvars[1], buf);
14074 # ifdef WIN32
14075 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14076 # elif defined(FEAT_X11)
14077 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14078 < 0)
14079 # elif defined(MAC_CLIENTSERVER)
14080 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14081 # endif
14083 if (r != NULL)
14084 EMSG(r); /* sending worked but evaluation failed */
14085 else
14086 EMSG2(_("E241: Unable to send to %s"), server_name);
14087 return;
14090 rettv->vval.v_string = r;
14092 if (argvars[2].v_type != VAR_UNKNOWN)
14094 dictitem_T v;
14095 char_u str[30];
14096 char_u *idvar;
14098 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14099 v.di_tv.v_type = VAR_STRING;
14100 v.di_tv.vval.v_string = vim_strsave(str);
14101 idvar = get_tv_string_chk(&argvars[2]);
14102 if (idvar != NULL)
14103 set_var(idvar, &v.di_tv, FALSE);
14104 vim_free(v.di_tv.vval.v_string);
14107 #endif
14110 * "remote_expr()" function
14112 /*ARGSUSED*/
14113 static void
14114 f_remote_expr(argvars, rettv)
14115 typval_T *argvars;
14116 typval_T *rettv;
14118 rettv->v_type = VAR_STRING;
14119 rettv->vval.v_string = NULL;
14120 #ifdef FEAT_CLIENTSERVER
14121 remote_common(argvars, rettv, TRUE);
14122 #endif
14126 * "remote_foreground()" function
14128 /*ARGSUSED*/
14129 static void
14130 f_remote_foreground(argvars, rettv)
14131 typval_T *argvars;
14132 typval_T *rettv;
14134 rettv->vval.v_number = 0;
14135 #ifdef FEAT_CLIENTSERVER
14136 # ifdef WIN32
14137 /* On Win32 it's done in this application. */
14139 char_u *server_name = get_tv_string_chk(&argvars[0]);
14141 if (server_name != NULL)
14142 serverForeground(server_name);
14144 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14145 /* Send a foreground() expression to the server. */
14146 argvars[1].v_type = VAR_STRING;
14147 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14148 argvars[2].v_type = VAR_UNKNOWN;
14149 remote_common(argvars, rettv, TRUE);
14150 vim_free(argvars[1].vval.v_string);
14151 # endif
14152 #endif
14155 /*ARGSUSED*/
14156 static void
14157 f_remote_peek(argvars, rettv)
14158 typval_T *argvars;
14159 typval_T *rettv;
14161 #ifdef FEAT_CLIENTSERVER
14162 dictitem_T v;
14163 char_u *s = NULL;
14164 # ifdef WIN32
14165 long_u n = 0;
14166 # endif
14167 char_u *serverid;
14169 if (check_restricted() || check_secure())
14171 rettv->vval.v_number = -1;
14172 return;
14174 serverid = get_tv_string_chk(&argvars[0]);
14175 if (serverid == NULL)
14177 rettv->vval.v_number = -1;
14178 return; /* type error; errmsg already given */
14180 # ifdef WIN32
14181 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14182 if (n == 0)
14183 rettv->vval.v_number = -1;
14184 else
14186 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14187 rettv->vval.v_number = (s != NULL);
14189 # elif defined(FEAT_X11)
14190 rettv->vval.v_number = 0;
14191 if (check_connection() == FAIL)
14192 return;
14194 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14195 serverStrToWin(serverid), &s);
14196 # elif defined(MAC_CLIENTSERVER)
14197 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14198 # endif
14200 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14202 char_u *retvar;
14204 v.di_tv.v_type = VAR_STRING;
14205 v.di_tv.vval.v_string = vim_strsave(s);
14206 retvar = get_tv_string_chk(&argvars[1]);
14207 if (retvar != NULL)
14208 set_var(retvar, &v.di_tv, FALSE);
14209 vim_free(v.di_tv.vval.v_string);
14211 #else
14212 rettv->vval.v_number = -1;
14213 #endif
14216 /*ARGSUSED*/
14217 static void
14218 f_remote_read(argvars, rettv)
14219 typval_T *argvars;
14220 typval_T *rettv;
14222 char_u *r = NULL;
14224 #ifdef FEAT_CLIENTSERVER
14225 char_u *serverid = get_tv_string_chk(&argvars[0]);
14227 if (serverid != NULL && !check_restricted() && !check_secure())
14229 # ifdef WIN32
14230 /* The server's HWND is encoded in the 'id' parameter */
14231 long_u n = 0;
14233 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14234 if (n != 0)
14235 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14236 if (r == NULL)
14237 # elif defined(FEAT_X11)
14238 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14239 serverStrToWin(serverid), &r, FALSE) < 0)
14240 # elif defined(MAC_CLIENTSERVER)
14241 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14242 # endif
14243 EMSG(_("E277: Unable to read a server reply"));
14245 #endif
14246 rettv->v_type = VAR_STRING;
14247 rettv->vval.v_string = r;
14251 * "remote_send()" function
14253 /*ARGSUSED*/
14254 static void
14255 f_remote_send(argvars, rettv)
14256 typval_T *argvars;
14257 typval_T *rettv;
14259 rettv->v_type = VAR_STRING;
14260 rettv->vval.v_string = NULL;
14261 #ifdef FEAT_CLIENTSERVER
14262 remote_common(argvars, rettv, FALSE);
14263 #endif
14267 * "remove()" function
14269 static void
14270 f_remove(argvars, rettv)
14271 typval_T *argvars;
14272 typval_T *rettv;
14274 list_T *l;
14275 listitem_T *item, *item2;
14276 listitem_T *li;
14277 long idx;
14278 long end;
14279 char_u *key;
14280 dict_T *d;
14281 dictitem_T *di;
14283 rettv->vval.v_number = 0;
14284 if (argvars[0].v_type == VAR_DICT)
14286 if (argvars[2].v_type != VAR_UNKNOWN)
14287 EMSG2(_(e_toomanyarg), "remove()");
14288 else if ((d = argvars[0].vval.v_dict) != NULL
14289 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14291 key = get_tv_string_chk(&argvars[1]);
14292 if (key != NULL)
14294 di = dict_find(d, key, -1);
14295 if (di == NULL)
14296 EMSG2(_(e_dictkey), key);
14297 else
14299 *rettv = di->di_tv;
14300 init_tv(&di->di_tv);
14301 dictitem_remove(d, di);
14306 else if (argvars[0].v_type != VAR_LIST)
14307 EMSG2(_(e_listdictarg), "remove()");
14308 else if ((l = argvars[0].vval.v_list) != NULL
14309 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14311 int error = FALSE;
14313 idx = get_tv_number_chk(&argvars[1], &error);
14314 if (error)
14315 ; /* type error: do nothing, errmsg already given */
14316 else if ((item = list_find(l, idx)) == NULL)
14317 EMSGN(_(e_listidx), idx);
14318 else
14320 if (argvars[2].v_type == VAR_UNKNOWN)
14322 /* Remove one item, return its value. */
14323 list_remove(l, item, item);
14324 *rettv = item->li_tv;
14325 vim_free(item);
14327 else
14329 /* Remove range of items, return list with values. */
14330 end = get_tv_number_chk(&argvars[2], &error);
14331 if (error)
14332 ; /* type error: do nothing */
14333 else if ((item2 = list_find(l, end)) == NULL)
14334 EMSGN(_(e_listidx), end);
14335 else
14337 int cnt = 0;
14339 for (li = item; li != NULL; li = li->li_next)
14341 ++cnt;
14342 if (li == item2)
14343 break;
14345 if (li == NULL) /* didn't find "item2" after "item" */
14346 EMSG(_(e_invrange));
14347 else
14349 list_remove(l, item, item2);
14350 if (rettv_list_alloc(rettv) == OK)
14352 l = rettv->vval.v_list;
14353 l->lv_first = item;
14354 l->lv_last = item2;
14355 item->li_prev = NULL;
14356 item2->li_next = NULL;
14357 l->lv_len = cnt;
14367 * "rename({from}, {to})" function
14369 static void
14370 f_rename(argvars, rettv)
14371 typval_T *argvars;
14372 typval_T *rettv;
14374 char_u buf[NUMBUFLEN];
14376 if (check_restricted() || check_secure())
14377 rettv->vval.v_number = -1;
14378 else
14379 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14380 get_tv_string_buf(&argvars[1], buf));
14384 * "repeat()" function
14386 /*ARGSUSED*/
14387 static void
14388 f_repeat(argvars, rettv)
14389 typval_T *argvars;
14390 typval_T *rettv;
14392 char_u *p;
14393 int n;
14394 int slen;
14395 int len;
14396 char_u *r;
14397 int i;
14399 n = get_tv_number(&argvars[1]);
14400 if (argvars[0].v_type == VAR_LIST)
14402 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14403 while (n-- > 0)
14404 if (list_extend(rettv->vval.v_list,
14405 argvars[0].vval.v_list, NULL) == FAIL)
14406 break;
14408 else
14410 p = get_tv_string(&argvars[0]);
14411 rettv->v_type = VAR_STRING;
14412 rettv->vval.v_string = NULL;
14414 slen = (int)STRLEN(p);
14415 len = slen * n;
14416 if (len <= 0)
14417 return;
14419 r = alloc(len + 1);
14420 if (r != NULL)
14422 for (i = 0; i < n; i++)
14423 mch_memmove(r + i * slen, p, (size_t)slen);
14424 r[len] = NUL;
14427 rettv->vval.v_string = r;
14432 * "resolve()" function
14434 static void
14435 f_resolve(argvars, rettv)
14436 typval_T *argvars;
14437 typval_T *rettv;
14439 char_u *p;
14441 p = get_tv_string(&argvars[0]);
14442 #ifdef FEAT_SHORTCUT
14444 char_u *v = NULL;
14446 v = mch_resolve_shortcut(p);
14447 if (v != NULL)
14448 rettv->vval.v_string = v;
14449 else
14450 rettv->vval.v_string = vim_strsave(p);
14452 #else
14453 # ifdef HAVE_READLINK
14455 char_u buf[MAXPATHL + 1];
14456 char_u *cpy;
14457 int len;
14458 char_u *remain = NULL;
14459 char_u *q;
14460 int is_relative_to_current = FALSE;
14461 int has_trailing_pathsep = FALSE;
14462 int limit = 100;
14464 p = vim_strsave(p);
14466 if (p[0] == '.' && (vim_ispathsep(p[1])
14467 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14468 is_relative_to_current = TRUE;
14470 len = STRLEN(p);
14471 if (len > 0 && after_pathsep(p, p + len))
14472 has_trailing_pathsep = TRUE;
14474 q = getnextcomp(p);
14475 if (*q != NUL)
14477 /* Separate the first path component in "p", and keep the
14478 * remainder (beginning with the path separator). */
14479 remain = vim_strsave(q - 1);
14480 q[-1] = NUL;
14483 for (;;)
14485 for (;;)
14487 len = readlink((char *)p, (char *)buf, MAXPATHL);
14488 if (len <= 0)
14489 break;
14490 buf[len] = NUL;
14492 if (limit-- == 0)
14494 vim_free(p);
14495 vim_free(remain);
14496 EMSG(_("E655: Too many symbolic links (cycle?)"));
14497 rettv->vval.v_string = NULL;
14498 goto fail;
14501 /* Ensure that the result will have a trailing path separator
14502 * if the argument has one. */
14503 if (remain == NULL && has_trailing_pathsep)
14504 add_pathsep(buf);
14506 /* Separate the first path component in the link value and
14507 * concatenate the remainders. */
14508 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14509 if (*q != NUL)
14511 if (remain == NULL)
14512 remain = vim_strsave(q - 1);
14513 else
14515 cpy = concat_str(q - 1, remain);
14516 if (cpy != NULL)
14518 vim_free(remain);
14519 remain = cpy;
14522 q[-1] = NUL;
14525 q = gettail(p);
14526 if (q > p && *q == NUL)
14528 /* Ignore trailing path separator. */
14529 q[-1] = NUL;
14530 q = gettail(p);
14532 if (q > p && !mch_isFullName(buf))
14534 /* symlink is relative to directory of argument */
14535 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14536 if (cpy != NULL)
14538 STRCPY(cpy, p);
14539 STRCPY(gettail(cpy), buf);
14540 vim_free(p);
14541 p = cpy;
14544 else
14546 vim_free(p);
14547 p = vim_strsave(buf);
14551 if (remain == NULL)
14552 break;
14554 /* Append the first path component of "remain" to "p". */
14555 q = getnextcomp(remain + 1);
14556 len = q - remain - (*q != NUL);
14557 cpy = vim_strnsave(p, STRLEN(p) + len);
14558 if (cpy != NULL)
14560 STRNCAT(cpy, remain, len);
14561 vim_free(p);
14562 p = cpy;
14564 /* Shorten "remain". */
14565 if (*q != NUL)
14566 STRMOVE(remain, q - 1);
14567 else
14569 vim_free(remain);
14570 remain = NULL;
14574 /* If the result is a relative path name, make it explicitly relative to
14575 * the current directory if and only if the argument had this form. */
14576 if (!vim_ispathsep(*p))
14578 if (is_relative_to_current
14579 && *p != NUL
14580 && !(p[0] == '.'
14581 && (p[1] == NUL
14582 || vim_ispathsep(p[1])
14583 || (p[1] == '.'
14584 && (p[2] == NUL
14585 || vim_ispathsep(p[2]))))))
14587 /* Prepend "./". */
14588 cpy = concat_str((char_u *)"./", p);
14589 if (cpy != NULL)
14591 vim_free(p);
14592 p = cpy;
14595 else if (!is_relative_to_current)
14597 /* Strip leading "./". */
14598 q = p;
14599 while (q[0] == '.' && vim_ispathsep(q[1]))
14600 q += 2;
14601 if (q > p)
14602 STRMOVE(p, p + 2);
14606 /* Ensure that the result will have no trailing path separator
14607 * if the argument had none. But keep "/" or "//". */
14608 if (!has_trailing_pathsep)
14610 q = p + STRLEN(p);
14611 if (after_pathsep(p, q))
14612 *gettail_sep(p) = NUL;
14615 rettv->vval.v_string = p;
14617 # else
14618 rettv->vval.v_string = vim_strsave(p);
14619 # endif
14620 #endif
14622 simplify_filename(rettv->vval.v_string);
14624 #ifdef HAVE_READLINK
14625 fail:
14626 #endif
14627 rettv->v_type = VAR_STRING;
14631 * "reverse({list})" function
14633 static void
14634 f_reverse(argvars, rettv)
14635 typval_T *argvars;
14636 typval_T *rettv;
14638 list_T *l;
14639 listitem_T *li, *ni;
14641 rettv->vval.v_number = 0;
14642 if (argvars[0].v_type != VAR_LIST)
14643 EMSG2(_(e_listarg), "reverse()");
14644 else if ((l = argvars[0].vval.v_list) != NULL
14645 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14647 li = l->lv_last;
14648 l->lv_first = l->lv_last = NULL;
14649 l->lv_len = 0;
14650 while (li != NULL)
14652 ni = li->li_prev;
14653 list_append(l, li);
14654 li = ni;
14656 rettv->vval.v_list = l;
14657 rettv->v_type = VAR_LIST;
14658 ++l->lv_refcount;
14659 l->lv_idx = l->lv_len - l->lv_idx - 1;
14663 #define SP_NOMOVE 0x01 /* don't move cursor */
14664 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14665 #define SP_RETCOUNT 0x04 /* return matchcount */
14666 #define SP_SETPCMARK 0x08 /* set previous context mark */
14667 #define SP_START 0x10 /* accept match at start position */
14668 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14669 #define SP_END 0x40 /* leave cursor at end of match */
14671 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14674 * Get flags for a search function.
14675 * Possibly sets "p_ws".
14676 * Returns BACKWARD, FORWARD or zero (for an error).
14678 static int
14679 get_search_arg(varp, flagsp)
14680 typval_T *varp;
14681 int *flagsp;
14683 int dir = FORWARD;
14684 char_u *flags;
14685 char_u nbuf[NUMBUFLEN];
14686 int mask;
14688 if (varp->v_type != VAR_UNKNOWN)
14690 flags = get_tv_string_buf_chk(varp, nbuf);
14691 if (flags == NULL)
14692 return 0; /* type error; errmsg already given */
14693 while (*flags != NUL)
14695 switch (*flags)
14697 case 'b': dir = BACKWARD; break;
14698 case 'w': p_ws = TRUE; break;
14699 case 'W': p_ws = FALSE; break;
14700 default: mask = 0;
14701 if (flagsp != NULL)
14702 switch (*flags)
14704 case 'c': mask = SP_START; break;
14705 case 'e': mask = SP_END; break;
14706 case 'm': mask = SP_RETCOUNT; break;
14707 case 'n': mask = SP_NOMOVE; break;
14708 case 'p': mask = SP_SUBPAT; break;
14709 case 'r': mask = SP_REPEAT; break;
14710 case 's': mask = SP_SETPCMARK; break;
14712 if (mask == 0)
14714 EMSG2(_(e_invarg2), flags);
14715 dir = 0;
14717 else
14718 *flagsp |= mask;
14720 if (dir == 0)
14721 break;
14722 ++flags;
14725 return dir;
14729 * Shared by search() and searchpos() functions
14731 static int
14732 search_cmn(argvars, match_pos, flagsp)
14733 typval_T *argvars;
14734 pos_T *match_pos;
14735 int *flagsp;
14737 int flags;
14738 char_u *pat;
14739 pos_T pos;
14740 pos_T save_cursor;
14741 int save_p_ws = p_ws;
14742 int dir;
14743 int retval = 0; /* default: FAIL */
14744 long lnum_stop = 0;
14745 proftime_T tm;
14746 #ifdef FEAT_RELTIME
14747 long time_limit = 0;
14748 #endif
14749 int options = SEARCH_KEEP;
14750 int subpatnum;
14752 pat = get_tv_string(&argvars[0]);
14753 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14754 if (dir == 0)
14755 goto theend;
14756 flags = *flagsp;
14757 if (flags & SP_START)
14758 options |= SEARCH_START;
14759 if (flags & SP_END)
14760 options |= SEARCH_END;
14762 /* Optional arguments: line number to stop searching and timeout. */
14763 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14765 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14766 if (lnum_stop < 0)
14767 goto theend;
14768 #ifdef FEAT_RELTIME
14769 if (argvars[3].v_type != VAR_UNKNOWN)
14771 time_limit = get_tv_number_chk(&argvars[3], NULL);
14772 if (time_limit < 0)
14773 goto theend;
14775 #endif
14778 #ifdef FEAT_RELTIME
14779 /* Set the time limit, if there is one. */
14780 profile_setlimit(time_limit, &tm);
14781 #endif
14784 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14785 * Check to make sure only those flags are set.
14786 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14787 * flags cannot be set. Check for that condition also.
14789 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14790 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14792 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14793 goto theend;
14796 pos = save_cursor = curwin->w_cursor;
14797 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14798 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14799 if (subpatnum != FAIL)
14801 if (flags & SP_SUBPAT)
14802 retval = subpatnum;
14803 else
14804 retval = pos.lnum;
14805 if (flags & SP_SETPCMARK)
14806 setpcmark();
14807 curwin->w_cursor = pos;
14808 if (match_pos != NULL)
14810 /* Store the match cursor position */
14811 match_pos->lnum = pos.lnum;
14812 match_pos->col = pos.col + 1;
14814 /* "/$" will put the cursor after the end of the line, may need to
14815 * correct that here */
14816 check_cursor();
14819 /* If 'n' flag is used: restore cursor position. */
14820 if (flags & SP_NOMOVE)
14821 curwin->w_cursor = save_cursor;
14822 else
14823 curwin->w_set_curswant = TRUE;
14824 theend:
14825 p_ws = save_p_ws;
14827 return retval;
14830 #ifdef FEAT_FLOAT
14832 * "round({float})" function
14834 static void
14835 f_round(argvars, rettv)
14836 typval_T *argvars;
14837 typval_T *rettv;
14839 float_T f;
14841 rettv->v_type = VAR_FLOAT;
14842 if (get_float_arg(argvars, &f) == OK)
14843 /* round() is not in C90, use ceil() or floor() instead. */
14844 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14845 else
14846 rettv->vval.v_float = 0.0;
14848 #endif
14851 * "search()" function
14853 static void
14854 f_search(argvars, rettv)
14855 typval_T *argvars;
14856 typval_T *rettv;
14858 int flags = 0;
14860 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14864 * "searchdecl()" function
14866 static void
14867 f_searchdecl(argvars, rettv)
14868 typval_T *argvars;
14869 typval_T *rettv;
14871 int locally = 1;
14872 int thisblock = 0;
14873 int error = FALSE;
14874 char_u *name;
14876 rettv->vval.v_number = 1; /* default: FAIL */
14878 name = get_tv_string_chk(&argvars[0]);
14879 if (argvars[1].v_type != VAR_UNKNOWN)
14881 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14882 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14883 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14885 if (!error && name != NULL)
14886 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14887 locally, thisblock, SEARCH_KEEP) == FAIL;
14891 * Used by searchpair() and searchpairpos()
14893 static int
14894 searchpair_cmn(argvars, match_pos)
14895 typval_T *argvars;
14896 pos_T *match_pos;
14898 char_u *spat, *mpat, *epat;
14899 char_u *skip;
14900 int save_p_ws = p_ws;
14901 int dir;
14902 int flags = 0;
14903 char_u nbuf1[NUMBUFLEN];
14904 char_u nbuf2[NUMBUFLEN];
14905 char_u nbuf3[NUMBUFLEN];
14906 int retval = 0; /* default: FAIL */
14907 long lnum_stop = 0;
14908 long time_limit = 0;
14910 /* Get the three pattern arguments: start, middle, end. */
14911 spat = get_tv_string_chk(&argvars[0]);
14912 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14913 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14914 if (spat == NULL || mpat == NULL || epat == NULL)
14915 goto theend; /* type error */
14917 /* Handle the optional fourth argument: flags */
14918 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14919 if (dir == 0)
14920 goto theend;
14922 /* Don't accept SP_END or SP_SUBPAT.
14923 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14925 if ((flags & (SP_END | SP_SUBPAT)) != 0
14926 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14928 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14929 goto theend;
14932 /* Using 'r' implies 'W', otherwise it doesn't work. */
14933 if (flags & SP_REPEAT)
14934 p_ws = FALSE;
14936 /* Optional fifth argument: skip expression */
14937 if (argvars[3].v_type == VAR_UNKNOWN
14938 || argvars[4].v_type == VAR_UNKNOWN)
14939 skip = (char_u *)"";
14940 else
14942 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14943 if (argvars[5].v_type != VAR_UNKNOWN)
14945 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14946 if (lnum_stop < 0)
14947 goto theend;
14948 #ifdef FEAT_RELTIME
14949 if (argvars[6].v_type != VAR_UNKNOWN)
14951 time_limit = get_tv_number_chk(&argvars[6], NULL);
14952 if (time_limit < 0)
14953 goto theend;
14955 #endif
14958 if (skip == NULL)
14959 goto theend; /* type error */
14961 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14962 match_pos, lnum_stop, time_limit);
14964 theend:
14965 p_ws = save_p_ws;
14967 return retval;
14971 * "searchpair()" function
14973 static void
14974 f_searchpair(argvars, rettv)
14975 typval_T *argvars;
14976 typval_T *rettv;
14978 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
14982 * "searchpairpos()" function
14984 static void
14985 f_searchpairpos(argvars, rettv)
14986 typval_T *argvars;
14987 typval_T *rettv;
14989 pos_T match_pos;
14990 int lnum = 0;
14991 int col = 0;
14993 rettv->vval.v_number = 0;
14995 if (rettv_list_alloc(rettv) == FAIL)
14996 return;
14998 if (searchpair_cmn(argvars, &match_pos) > 0)
15000 lnum = match_pos.lnum;
15001 col = match_pos.col;
15004 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15005 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15009 * Search for a start/middle/end thing.
15010 * Used by searchpair(), see its documentation for the details.
15011 * Returns 0 or -1 for no match,
15013 long
15014 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15015 lnum_stop, time_limit)
15016 char_u *spat; /* start pattern */
15017 char_u *mpat; /* middle pattern */
15018 char_u *epat; /* end pattern */
15019 int dir; /* BACKWARD or FORWARD */
15020 char_u *skip; /* skip expression */
15021 int flags; /* SP_SETPCMARK and other SP_ values */
15022 pos_T *match_pos;
15023 linenr_T lnum_stop; /* stop at this line if not zero */
15024 long time_limit; /* stop after this many msec */
15026 char_u *save_cpo;
15027 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15028 long retval = 0;
15029 pos_T pos;
15030 pos_T firstpos;
15031 pos_T foundpos;
15032 pos_T save_cursor;
15033 pos_T save_pos;
15034 int n;
15035 int r;
15036 int nest = 1;
15037 int err;
15038 int options = SEARCH_KEEP;
15039 proftime_T tm;
15041 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15042 save_cpo = p_cpo;
15043 p_cpo = empty_option;
15045 #ifdef FEAT_RELTIME
15046 /* Set the time limit, if there is one. */
15047 profile_setlimit(time_limit, &tm);
15048 #endif
15050 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15051 * start/middle/end (pat3, for the top pair). */
15052 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15053 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15054 if (pat2 == NULL || pat3 == NULL)
15055 goto theend;
15056 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15057 if (*mpat == NUL)
15058 STRCPY(pat3, pat2);
15059 else
15060 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15061 spat, epat, mpat);
15062 if (flags & SP_START)
15063 options |= SEARCH_START;
15065 save_cursor = curwin->w_cursor;
15066 pos = curwin->w_cursor;
15067 clearpos(&firstpos);
15068 clearpos(&foundpos);
15069 pat = pat3;
15070 for (;;)
15072 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15073 options, RE_SEARCH, lnum_stop, &tm);
15074 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15075 /* didn't find it or found the first match again: FAIL */
15076 break;
15078 if (firstpos.lnum == 0)
15079 firstpos = pos;
15080 if (equalpos(pos, foundpos))
15082 /* Found the same position again. Can happen with a pattern that
15083 * has "\zs" at the end and searching backwards. Advance one
15084 * character and try again. */
15085 if (dir == BACKWARD)
15086 decl(&pos);
15087 else
15088 incl(&pos);
15090 foundpos = pos;
15092 /* clear the start flag to avoid getting stuck here */
15093 options &= ~SEARCH_START;
15095 /* If the skip pattern matches, ignore this match. */
15096 if (*skip != NUL)
15098 save_pos = curwin->w_cursor;
15099 curwin->w_cursor = pos;
15100 r = eval_to_bool(skip, &err, NULL, FALSE);
15101 curwin->w_cursor = save_pos;
15102 if (err)
15104 /* Evaluating {skip} caused an error, break here. */
15105 curwin->w_cursor = save_cursor;
15106 retval = -1;
15107 break;
15109 if (r)
15110 continue;
15113 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15115 /* Found end when searching backwards or start when searching
15116 * forward: nested pair. */
15117 ++nest;
15118 pat = pat2; /* nested, don't search for middle */
15120 else
15122 /* Found end when searching forward or start when searching
15123 * backward: end of (nested) pair; or found middle in outer pair. */
15124 if (--nest == 1)
15125 pat = pat3; /* outer level, search for middle */
15128 if (nest == 0)
15130 /* Found the match: return matchcount or line number. */
15131 if (flags & SP_RETCOUNT)
15132 ++retval;
15133 else
15134 retval = pos.lnum;
15135 if (flags & SP_SETPCMARK)
15136 setpcmark();
15137 curwin->w_cursor = pos;
15138 if (!(flags & SP_REPEAT))
15139 break;
15140 nest = 1; /* search for next unmatched */
15144 if (match_pos != NULL)
15146 /* Store the match cursor position */
15147 match_pos->lnum = curwin->w_cursor.lnum;
15148 match_pos->col = curwin->w_cursor.col + 1;
15151 /* If 'n' flag is used or search failed: restore cursor position. */
15152 if ((flags & SP_NOMOVE) || retval == 0)
15153 curwin->w_cursor = save_cursor;
15155 theend:
15156 vim_free(pat2);
15157 vim_free(pat3);
15158 if (p_cpo == empty_option)
15159 p_cpo = save_cpo;
15160 else
15161 /* Darn, evaluating the {skip} expression changed the value. */
15162 free_string_option(save_cpo);
15164 return retval;
15168 * "searchpos()" function
15170 static void
15171 f_searchpos(argvars, rettv)
15172 typval_T *argvars;
15173 typval_T *rettv;
15175 pos_T match_pos;
15176 int lnum = 0;
15177 int col = 0;
15178 int n;
15179 int flags = 0;
15181 rettv->vval.v_number = 0;
15183 if (rettv_list_alloc(rettv) == FAIL)
15184 return;
15186 n = search_cmn(argvars, &match_pos, &flags);
15187 if (n > 0)
15189 lnum = match_pos.lnum;
15190 col = match_pos.col;
15193 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15194 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15195 if (flags & SP_SUBPAT)
15196 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15200 /*ARGSUSED*/
15201 static void
15202 f_server2client(argvars, rettv)
15203 typval_T *argvars;
15204 typval_T *rettv;
15206 #ifdef FEAT_CLIENTSERVER
15207 char_u buf[NUMBUFLEN];
15208 char_u *server = get_tv_string_chk(&argvars[0]);
15209 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15211 rettv->vval.v_number = -1;
15212 if (server == NULL || reply == NULL)
15213 return;
15214 if (check_restricted() || check_secure())
15215 return;
15216 # ifdef FEAT_X11
15217 if (check_connection() == FAIL)
15218 return;
15219 # endif
15221 if (serverSendReply(server, reply) < 0)
15223 EMSG(_("E258: Unable to send to client"));
15224 return;
15226 rettv->vval.v_number = 0;
15227 #else
15228 rettv->vval.v_number = -1;
15229 #endif
15232 /*ARGSUSED*/
15233 static void
15234 f_serverlist(argvars, rettv)
15235 typval_T *argvars;
15236 typval_T *rettv;
15238 char_u *r = NULL;
15240 #ifdef FEAT_CLIENTSERVER
15241 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15242 r = serverGetVimNames();
15243 # elif defined(FEAT_X11)
15244 make_connection();
15245 if (X_DISPLAY != NULL)
15246 r = serverGetVimNames(X_DISPLAY);
15247 # endif
15248 #endif
15249 rettv->v_type = VAR_STRING;
15250 rettv->vval.v_string = r;
15254 * "setbufvar()" function
15256 /*ARGSUSED*/
15257 static void
15258 f_setbufvar(argvars, rettv)
15259 typval_T *argvars;
15260 typval_T *rettv;
15262 buf_T *buf;
15263 aco_save_T aco;
15264 char_u *varname, *bufvarname;
15265 typval_T *varp;
15266 char_u nbuf[NUMBUFLEN];
15268 rettv->vval.v_number = 0;
15270 if (check_restricted() || check_secure())
15271 return;
15272 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15273 varname = get_tv_string_chk(&argvars[1]);
15274 buf = get_buf_tv(&argvars[0]);
15275 varp = &argvars[2];
15277 if (buf != NULL && varname != NULL && varp != NULL)
15279 /* set curbuf to be our buf, temporarily */
15280 aucmd_prepbuf(&aco, buf);
15282 if (*varname == '&')
15284 long numval;
15285 char_u *strval;
15286 int error = FALSE;
15288 ++varname;
15289 numval = get_tv_number_chk(varp, &error);
15290 strval = get_tv_string_buf_chk(varp, nbuf);
15291 if (!error && strval != NULL)
15292 set_option_value(varname, numval, strval, OPT_LOCAL);
15294 else
15296 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15297 if (bufvarname != NULL)
15299 STRCPY(bufvarname, "b:");
15300 STRCPY(bufvarname + 2, varname);
15301 set_var(bufvarname, varp, TRUE);
15302 vim_free(bufvarname);
15306 /* reset notion of buffer */
15307 aucmd_restbuf(&aco);
15312 * "setcmdpos()" function
15314 static void
15315 f_setcmdpos(argvars, rettv)
15316 typval_T *argvars;
15317 typval_T *rettv;
15319 int pos = (int)get_tv_number(&argvars[0]) - 1;
15321 if (pos >= 0)
15322 rettv->vval.v_number = set_cmdline_pos(pos);
15326 * "setline()" function
15328 static void
15329 f_setline(argvars, rettv)
15330 typval_T *argvars;
15331 typval_T *rettv;
15333 linenr_T lnum;
15334 char_u *line = NULL;
15335 list_T *l = NULL;
15336 listitem_T *li = NULL;
15337 long added = 0;
15338 linenr_T lcount = curbuf->b_ml.ml_line_count;
15340 lnum = get_tv_lnum(&argvars[0]);
15341 if (argvars[1].v_type == VAR_LIST)
15343 l = argvars[1].vval.v_list;
15344 li = l->lv_first;
15346 else
15347 line = get_tv_string_chk(&argvars[1]);
15349 rettv->vval.v_number = 0; /* OK */
15350 for (;;)
15352 if (l != NULL)
15354 /* list argument, get next string */
15355 if (li == NULL)
15356 break;
15357 line = get_tv_string_chk(&li->li_tv);
15358 li = li->li_next;
15361 rettv->vval.v_number = 1; /* FAIL */
15362 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15363 break;
15364 if (lnum <= curbuf->b_ml.ml_line_count)
15366 /* existing line, replace it */
15367 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15369 changed_bytes(lnum, 0);
15370 if (lnum == curwin->w_cursor.lnum)
15371 check_cursor_col();
15372 rettv->vval.v_number = 0; /* OK */
15375 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15377 /* lnum is one past the last line, append the line */
15378 ++added;
15379 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15380 rettv->vval.v_number = 0; /* OK */
15383 if (l == NULL) /* only one string argument */
15384 break;
15385 ++lnum;
15388 if (added > 0)
15389 appended_lines_mark(lcount, added);
15392 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15395 * Used by "setqflist()" and "setloclist()" functions
15397 /*ARGSUSED*/
15398 static void
15399 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15400 win_T *wp;
15401 typval_T *list_arg;
15402 typval_T *action_arg;
15403 typval_T *rettv;
15405 #ifdef FEAT_QUICKFIX
15406 char_u *act;
15407 int action = ' ';
15408 #endif
15410 rettv->vval.v_number = -1;
15412 #ifdef FEAT_QUICKFIX
15413 if (list_arg->v_type != VAR_LIST)
15414 EMSG(_(e_listreq));
15415 else
15417 list_T *l = list_arg->vval.v_list;
15419 if (action_arg->v_type == VAR_STRING)
15421 act = get_tv_string_chk(action_arg);
15422 if (act == NULL)
15423 return; /* type error; errmsg already given */
15424 if (*act == 'a' || *act == 'r')
15425 action = *act;
15428 if (l != NULL && set_errorlist(wp, l, action) == OK)
15429 rettv->vval.v_number = 0;
15431 #endif
15435 * "setloclist()" function
15437 /*ARGSUSED*/
15438 static void
15439 f_setloclist(argvars, rettv)
15440 typval_T *argvars;
15441 typval_T *rettv;
15443 win_T *win;
15445 rettv->vval.v_number = -1;
15447 win = find_win_by_nr(&argvars[0], NULL);
15448 if (win != NULL)
15449 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15453 * "setmatches()" function
15455 static void
15456 f_setmatches(argvars, rettv)
15457 typval_T *argvars;
15458 typval_T *rettv;
15460 #ifdef FEAT_SEARCH_EXTRA
15461 list_T *l;
15462 listitem_T *li;
15463 dict_T *d;
15465 rettv->vval.v_number = -1;
15466 if (argvars[0].v_type != VAR_LIST)
15468 EMSG(_(e_listreq));
15469 return;
15471 if ((l = argvars[0].vval.v_list) != NULL)
15474 /* To some extent make sure that we are dealing with a list from
15475 * "getmatches()". */
15476 li = l->lv_first;
15477 while (li != NULL)
15479 if (li->li_tv.v_type != VAR_DICT
15480 || (d = li->li_tv.vval.v_dict) == NULL)
15482 EMSG(_(e_invarg));
15483 return;
15485 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15486 && dict_find(d, (char_u *)"pattern", -1) != NULL
15487 && dict_find(d, (char_u *)"priority", -1) != NULL
15488 && dict_find(d, (char_u *)"id", -1) != NULL))
15490 EMSG(_(e_invarg));
15491 return;
15493 li = li->li_next;
15496 clear_matches(curwin);
15497 li = l->lv_first;
15498 while (li != NULL)
15500 d = li->li_tv.vval.v_dict;
15501 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15502 get_dict_string(d, (char_u *)"pattern", FALSE),
15503 (int)get_dict_number(d, (char_u *)"priority"),
15504 (int)get_dict_number(d, (char_u *)"id"));
15505 li = li->li_next;
15507 rettv->vval.v_number = 0;
15509 #endif
15513 * "setpos()" function
15515 /*ARGSUSED*/
15516 static void
15517 f_setpos(argvars, rettv)
15518 typval_T *argvars;
15519 typval_T *rettv;
15521 pos_T pos;
15522 int fnum;
15523 char_u *name;
15525 rettv->vval.v_number = -1;
15526 name = get_tv_string_chk(argvars);
15527 if (name != NULL)
15529 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15531 --pos.col;
15532 if (name[0] == '.' && name[1] == NUL)
15534 /* set cursor */
15535 if (fnum == curbuf->b_fnum)
15537 curwin->w_cursor = pos;
15538 check_cursor();
15539 rettv->vval.v_number = 0;
15541 else
15542 EMSG(_(e_invarg));
15544 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15546 /* set mark */
15547 if (setmark_pos(name[1], &pos, fnum) == OK)
15548 rettv->vval.v_number = 0;
15550 else
15551 EMSG(_(e_invarg));
15557 * "setqflist()" function
15559 /*ARGSUSED*/
15560 static void
15561 f_setqflist(argvars, rettv)
15562 typval_T *argvars;
15563 typval_T *rettv;
15565 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15569 * "setreg()" function
15571 static void
15572 f_setreg(argvars, rettv)
15573 typval_T *argvars;
15574 typval_T *rettv;
15576 int regname;
15577 char_u *strregname;
15578 char_u *stropt;
15579 char_u *strval;
15580 int append;
15581 char_u yank_type;
15582 long block_len;
15584 block_len = -1;
15585 yank_type = MAUTO;
15586 append = FALSE;
15588 strregname = get_tv_string_chk(argvars);
15589 rettv->vval.v_number = 1; /* FAIL is default */
15591 if (strregname == NULL)
15592 return; /* type error; errmsg already given */
15593 regname = *strregname;
15594 if (regname == 0 || regname == '@')
15595 regname = '"';
15596 else if (regname == '=')
15597 return;
15599 if (argvars[2].v_type != VAR_UNKNOWN)
15601 stropt = get_tv_string_chk(&argvars[2]);
15602 if (stropt == NULL)
15603 return; /* type error */
15604 for (; *stropt != NUL; ++stropt)
15605 switch (*stropt)
15607 case 'a': case 'A': /* append */
15608 append = TRUE;
15609 break;
15610 case 'v': case 'c': /* character-wise selection */
15611 yank_type = MCHAR;
15612 break;
15613 case 'V': case 'l': /* line-wise selection */
15614 yank_type = MLINE;
15615 break;
15616 #ifdef FEAT_VISUAL
15617 case 'b': case Ctrl_V: /* block-wise selection */
15618 yank_type = MBLOCK;
15619 if (VIM_ISDIGIT(stropt[1]))
15621 ++stropt;
15622 block_len = getdigits(&stropt) - 1;
15623 --stropt;
15625 break;
15626 #endif
15630 strval = get_tv_string_chk(&argvars[1]);
15631 if (strval != NULL)
15632 write_reg_contents_ex(regname, strval, -1,
15633 append, yank_type, block_len);
15634 rettv->vval.v_number = 0;
15638 * "settabwinvar()" function
15640 static void
15641 f_settabwinvar(argvars, rettv)
15642 typval_T *argvars;
15643 typval_T *rettv;
15645 setwinvar(argvars, rettv, 1);
15649 * "setwinvar()" function
15651 static void
15652 f_setwinvar(argvars, rettv)
15653 typval_T *argvars;
15654 typval_T *rettv;
15656 setwinvar(argvars, rettv, 0);
15660 * "setwinvar()" and "settabwinvar()" functions
15662 static void
15663 setwinvar(argvars, rettv, off)
15664 typval_T *argvars;
15665 typval_T *rettv;
15666 int off;
15668 win_T *win;
15669 #ifdef FEAT_WINDOWS
15670 win_T *save_curwin;
15671 tabpage_T *save_curtab;
15672 #endif
15673 char_u *varname, *winvarname;
15674 typval_T *varp;
15675 char_u nbuf[NUMBUFLEN];
15676 tabpage_T *tp;
15678 rettv->vval.v_number = 0;
15680 if (check_restricted() || check_secure())
15681 return;
15683 #ifdef FEAT_WINDOWS
15684 if (off == 1)
15685 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15686 else
15687 tp = curtab;
15688 #endif
15689 win = find_win_by_nr(&argvars[off], tp);
15690 varname = get_tv_string_chk(&argvars[off + 1]);
15691 varp = &argvars[off + 2];
15693 if (win != NULL && varname != NULL && varp != NULL)
15695 #ifdef FEAT_WINDOWS
15696 /* set curwin to be our win, temporarily */
15697 save_curwin = curwin;
15698 save_curtab = curtab;
15699 goto_tabpage_tp(tp);
15700 if (!win_valid(win))
15701 return;
15702 curwin = win;
15703 curbuf = curwin->w_buffer;
15704 #endif
15706 if (*varname == '&')
15708 long numval;
15709 char_u *strval;
15710 int error = FALSE;
15712 ++varname;
15713 numval = get_tv_number_chk(varp, &error);
15714 strval = get_tv_string_buf_chk(varp, nbuf);
15715 if (!error && strval != NULL)
15716 set_option_value(varname, numval, strval, OPT_LOCAL);
15718 else
15720 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15721 if (winvarname != NULL)
15723 STRCPY(winvarname, "w:");
15724 STRCPY(winvarname + 2, varname);
15725 set_var(winvarname, varp, TRUE);
15726 vim_free(winvarname);
15730 #ifdef FEAT_WINDOWS
15731 /* Restore current tabpage and window, if still valid (autocomands can
15732 * make them invalid). */
15733 if (valid_tabpage(save_curtab))
15734 goto_tabpage_tp(save_curtab);
15735 if (win_valid(save_curwin))
15737 curwin = save_curwin;
15738 curbuf = curwin->w_buffer;
15740 #endif
15745 * "shellescape({string})" function
15747 static void
15748 f_shellescape(argvars, rettv)
15749 typval_T *argvars;
15750 typval_T *rettv;
15752 rettv->vval.v_string = vim_strsave_shellescape(
15753 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15754 rettv->v_type = VAR_STRING;
15758 * "simplify()" function
15760 static void
15761 f_simplify(argvars, rettv)
15762 typval_T *argvars;
15763 typval_T *rettv;
15765 char_u *p;
15767 p = get_tv_string(&argvars[0]);
15768 rettv->vval.v_string = vim_strsave(p);
15769 simplify_filename(rettv->vval.v_string); /* simplify in place */
15770 rettv->v_type = VAR_STRING;
15773 #ifdef FEAT_FLOAT
15775 * "sin()" function
15777 static void
15778 f_sin(argvars, rettv)
15779 typval_T *argvars;
15780 typval_T *rettv;
15782 float_T f;
15784 rettv->v_type = VAR_FLOAT;
15785 if (get_float_arg(argvars, &f) == OK)
15786 rettv->vval.v_float = sin(f);
15787 else
15788 rettv->vval.v_float = 0.0;
15790 #endif
15792 static int
15793 #ifdef __BORLANDC__
15794 _RTLENTRYF
15795 #endif
15796 item_compare __ARGS((const void *s1, const void *s2));
15797 static int
15798 #ifdef __BORLANDC__
15799 _RTLENTRYF
15800 #endif
15801 item_compare2 __ARGS((const void *s1, const void *s2));
15803 static int item_compare_ic;
15804 static char_u *item_compare_func;
15805 static int item_compare_func_err;
15806 #define ITEM_COMPARE_FAIL 999
15809 * Compare functions for f_sort() below.
15811 static int
15812 #ifdef __BORLANDC__
15813 _RTLENTRYF
15814 #endif
15815 item_compare(s1, s2)
15816 const void *s1;
15817 const void *s2;
15819 char_u *p1, *p2;
15820 char_u *tofree1, *tofree2;
15821 int res;
15822 char_u numbuf1[NUMBUFLEN];
15823 char_u numbuf2[NUMBUFLEN];
15825 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15826 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15827 if (p1 == NULL)
15828 p1 = (char_u *)"";
15829 if (p2 == NULL)
15830 p2 = (char_u *)"";
15831 if (item_compare_ic)
15832 res = STRICMP(p1, p2);
15833 else
15834 res = STRCMP(p1, p2);
15835 vim_free(tofree1);
15836 vim_free(tofree2);
15837 return res;
15840 static int
15841 #ifdef __BORLANDC__
15842 _RTLENTRYF
15843 #endif
15844 item_compare2(s1, s2)
15845 const void *s1;
15846 const void *s2;
15848 int res;
15849 typval_T rettv;
15850 typval_T argv[3];
15851 int dummy;
15853 /* shortcut after failure in previous call; compare all items equal */
15854 if (item_compare_func_err)
15855 return 0;
15857 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15858 * in the copy without changing the original list items. */
15859 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15860 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15862 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15863 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15864 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15865 clear_tv(&argv[0]);
15866 clear_tv(&argv[1]);
15868 if (res == FAIL)
15869 res = ITEM_COMPARE_FAIL;
15870 else
15871 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15872 if (item_compare_func_err)
15873 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15874 clear_tv(&rettv);
15875 return res;
15879 * "sort({list})" function
15881 static void
15882 f_sort(argvars, rettv)
15883 typval_T *argvars;
15884 typval_T *rettv;
15886 list_T *l;
15887 listitem_T *li;
15888 listitem_T **ptrs;
15889 long len;
15890 long i;
15892 rettv->vval.v_number = 0;
15893 if (argvars[0].v_type != VAR_LIST)
15894 EMSG2(_(e_listarg), "sort()");
15895 else
15897 l = argvars[0].vval.v_list;
15898 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15899 return;
15900 rettv->vval.v_list = l;
15901 rettv->v_type = VAR_LIST;
15902 ++l->lv_refcount;
15904 len = list_len(l);
15905 if (len <= 1)
15906 return; /* short list sorts pretty quickly */
15908 item_compare_ic = FALSE;
15909 item_compare_func = NULL;
15910 if (argvars[1].v_type != VAR_UNKNOWN)
15912 if (argvars[1].v_type == VAR_FUNC)
15913 item_compare_func = argvars[1].vval.v_string;
15914 else
15916 int error = FALSE;
15918 i = get_tv_number_chk(&argvars[1], &error);
15919 if (error)
15920 return; /* type error; errmsg already given */
15921 if (i == 1)
15922 item_compare_ic = TRUE;
15923 else
15924 item_compare_func = get_tv_string(&argvars[1]);
15928 /* Make an array with each entry pointing to an item in the List. */
15929 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15930 if (ptrs == NULL)
15931 return;
15932 i = 0;
15933 for (li = l->lv_first; li != NULL; li = li->li_next)
15934 ptrs[i++] = li;
15936 item_compare_func_err = FALSE;
15937 /* test the compare function */
15938 if (item_compare_func != NULL
15939 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15940 == ITEM_COMPARE_FAIL)
15941 EMSG(_("E702: Sort compare function failed"));
15942 else
15944 /* Sort the array with item pointers. */
15945 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15946 item_compare_func == NULL ? item_compare : item_compare2);
15948 if (!item_compare_func_err)
15950 /* Clear the List and append the items in the sorted order. */
15951 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15952 l->lv_len = 0;
15953 for (i = 0; i < len; ++i)
15954 list_append(l, ptrs[i]);
15958 vim_free(ptrs);
15963 * "soundfold({word})" function
15965 static void
15966 f_soundfold(argvars, rettv)
15967 typval_T *argvars;
15968 typval_T *rettv;
15970 char_u *s;
15972 rettv->v_type = VAR_STRING;
15973 s = get_tv_string(&argvars[0]);
15974 #ifdef FEAT_SPELL
15975 rettv->vval.v_string = eval_soundfold(s);
15976 #else
15977 rettv->vval.v_string = vim_strsave(s);
15978 #endif
15982 * "spellbadword()" function
15984 /* ARGSUSED */
15985 static void
15986 f_spellbadword(argvars, rettv)
15987 typval_T *argvars;
15988 typval_T *rettv;
15990 char_u *word = (char_u *)"";
15991 hlf_T attr = HLF_COUNT;
15992 int len = 0;
15994 if (rettv_list_alloc(rettv) == FAIL)
15995 return;
15997 #ifdef FEAT_SPELL
15998 if (argvars[0].v_type == VAR_UNKNOWN)
16000 /* Find the start and length of the badly spelled word. */
16001 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16002 if (len != 0)
16003 word = ml_get_cursor();
16005 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16007 char_u *str = get_tv_string_chk(&argvars[0]);
16008 int capcol = -1;
16010 if (str != NULL)
16012 /* Check the argument for spelling. */
16013 while (*str != NUL)
16015 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16016 if (attr != HLF_COUNT)
16018 word = str;
16019 break;
16021 str += len;
16025 #endif
16027 list_append_string(rettv->vval.v_list, word, len);
16028 list_append_string(rettv->vval.v_list, (char_u *)(
16029 attr == HLF_SPB ? "bad" :
16030 attr == HLF_SPR ? "rare" :
16031 attr == HLF_SPL ? "local" :
16032 attr == HLF_SPC ? "caps" :
16033 ""), -1);
16037 * "spellsuggest()" function
16039 /*ARGSUSED*/
16040 static void
16041 f_spellsuggest(argvars, rettv)
16042 typval_T *argvars;
16043 typval_T *rettv;
16045 #ifdef FEAT_SPELL
16046 char_u *str;
16047 int typeerr = FALSE;
16048 int maxcount;
16049 garray_T ga;
16050 int i;
16051 listitem_T *li;
16052 int need_capital = FALSE;
16053 #endif
16055 if (rettv_list_alloc(rettv) == FAIL)
16056 return;
16058 #ifdef FEAT_SPELL
16059 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16061 str = get_tv_string(&argvars[0]);
16062 if (argvars[1].v_type != VAR_UNKNOWN)
16064 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16065 if (maxcount <= 0)
16066 return;
16067 if (argvars[2].v_type != VAR_UNKNOWN)
16069 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16070 if (typeerr)
16071 return;
16074 else
16075 maxcount = 25;
16077 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16079 for (i = 0; i < ga.ga_len; ++i)
16081 str = ((char_u **)ga.ga_data)[i];
16083 li = listitem_alloc();
16084 if (li == NULL)
16085 vim_free(str);
16086 else
16088 li->li_tv.v_type = VAR_STRING;
16089 li->li_tv.v_lock = 0;
16090 li->li_tv.vval.v_string = str;
16091 list_append(rettv->vval.v_list, li);
16094 ga_clear(&ga);
16096 #endif
16099 static void
16100 f_split(argvars, rettv)
16101 typval_T *argvars;
16102 typval_T *rettv;
16104 char_u *str;
16105 char_u *end;
16106 char_u *pat = NULL;
16107 regmatch_T regmatch;
16108 char_u patbuf[NUMBUFLEN];
16109 char_u *save_cpo;
16110 int match;
16111 colnr_T col = 0;
16112 int keepempty = FALSE;
16113 int typeerr = FALSE;
16115 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16116 save_cpo = p_cpo;
16117 p_cpo = (char_u *)"";
16119 str = get_tv_string(&argvars[0]);
16120 if (argvars[1].v_type != VAR_UNKNOWN)
16122 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16123 if (pat == NULL)
16124 typeerr = TRUE;
16125 if (argvars[2].v_type != VAR_UNKNOWN)
16126 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16128 if (pat == NULL || *pat == NUL)
16129 pat = (char_u *)"[\\x01- ]\\+";
16131 if (rettv_list_alloc(rettv) == FAIL)
16132 return;
16133 if (typeerr)
16134 return;
16136 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16137 if (regmatch.regprog != NULL)
16139 regmatch.rm_ic = FALSE;
16140 while (*str != NUL || keepempty)
16142 if (*str == NUL)
16143 match = FALSE; /* empty item at the end */
16144 else
16145 match = vim_regexec_nl(&regmatch, str, col);
16146 if (match)
16147 end = regmatch.startp[0];
16148 else
16149 end = str + STRLEN(str);
16150 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16151 && *str != NUL && match && end < regmatch.endp[0]))
16153 if (list_append_string(rettv->vval.v_list, str,
16154 (int)(end - str)) == FAIL)
16155 break;
16157 if (!match)
16158 break;
16159 /* Advance to just after the match. */
16160 if (regmatch.endp[0] > str)
16161 col = 0;
16162 else
16164 /* Don't get stuck at the same match. */
16165 #ifdef FEAT_MBYTE
16166 col = (*mb_ptr2len)(regmatch.endp[0]);
16167 #else
16168 col = 1;
16169 #endif
16171 str = regmatch.endp[0];
16174 vim_free(regmatch.regprog);
16177 p_cpo = save_cpo;
16180 #ifdef FEAT_FLOAT
16182 * "sqrt()" function
16184 static void
16185 f_sqrt(argvars, rettv)
16186 typval_T *argvars;
16187 typval_T *rettv;
16189 float_T f;
16191 rettv->v_type = VAR_FLOAT;
16192 if (get_float_arg(argvars, &f) == OK)
16193 rettv->vval.v_float = sqrt(f);
16194 else
16195 rettv->vval.v_float = 0.0;
16199 * "str2float()" function
16201 static void
16202 f_str2float(argvars, rettv)
16203 typval_T *argvars;
16204 typval_T *rettv;
16206 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16208 if (*p == '+')
16209 p = skipwhite(p + 1);
16210 (void)string2float(p, &rettv->vval.v_float);
16211 rettv->v_type = VAR_FLOAT;
16213 #endif
16216 * "str2nr()" function
16218 static void
16219 f_str2nr(argvars, rettv)
16220 typval_T *argvars;
16221 typval_T *rettv;
16223 int base = 10;
16224 char_u *p;
16225 long n;
16227 if (argvars[1].v_type != VAR_UNKNOWN)
16229 base = get_tv_number(&argvars[1]);
16230 if (base != 8 && base != 10 && base != 16)
16232 EMSG(_(e_invarg));
16233 return;
16237 p = skipwhite(get_tv_string(&argvars[0]));
16238 if (*p == '+')
16239 p = skipwhite(p + 1);
16240 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16241 rettv->vval.v_number = n;
16244 #ifdef HAVE_STRFTIME
16246 * "strftime({format}[, {time}])" function
16248 static void
16249 f_strftime(argvars, rettv)
16250 typval_T *argvars;
16251 typval_T *rettv;
16253 char_u result_buf[256];
16254 struct tm *curtime;
16255 time_t seconds;
16256 char_u *p;
16258 rettv->v_type = VAR_STRING;
16260 p = get_tv_string(&argvars[0]);
16261 if (argvars[1].v_type == VAR_UNKNOWN)
16262 seconds = time(NULL);
16263 else
16264 seconds = (time_t)get_tv_number(&argvars[1]);
16265 curtime = localtime(&seconds);
16266 /* MSVC returns NULL for an invalid value of seconds. */
16267 if (curtime == NULL)
16268 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16269 else
16271 # ifdef FEAT_MBYTE
16272 vimconv_T conv;
16273 char_u *enc;
16275 conv.vc_type = CONV_NONE;
16276 enc = enc_locale();
16277 convert_setup(&conv, p_enc, enc);
16278 if (conv.vc_type != CONV_NONE)
16279 p = string_convert(&conv, p, NULL);
16280 # endif
16281 if (p != NULL)
16282 (void)strftime((char *)result_buf, sizeof(result_buf),
16283 (char *)p, curtime);
16284 else
16285 result_buf[0] = NUL;
16287 # ifdef FEAT_MBYTE
16288 if (conv.vc_type != CONV_NONE)
16289 vim_free(p);
16290 convert_setup(&conv, enc, p_enc);
16291 if (conv.vc_type != CONV_NONE)
16292 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16293 else
16294 # endif
16295 rettv->vval.v_string = vim_strsave(result_buf);
16297 # ifdef FEAT_MBYTE
16298 /* Release conversion descriptors */
16299 convert_setup(&conv, NULL, NULL);
16300 vim_free(enc);
16301 # endif
16304 #endif
16307 * "stridx()" function
16309 static void
16310 f_stridx(argvars, rettv)
16311 typval_T *argvars;
16312 typval_T *rettv;
16314 char_u buf[NUMBUFLEN];
16315 char_u *needle;
16316 char_u *haystack;
16317 char_u *save_haystack;
16318 char_u *pos;
16319 int start_idx;
16321 needle = get_tv_string_chk(&argvars[1]);
16322 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16323 rettv->vval.v_number = -1;
16324 if (needle == NULL || haystack == NULL)
16325 return; /* type error; errmsg already given */
16327 if (argvars[2].v_type != VAR_UNKNOWN)
16329 int error = FALSE;
16331 start_idx = get_tv_number_chk(&argvars[2], &error);
16332 if (error || start_idx >= (int)STRLEN(haystack))
16333 return;
16334 if (start_idx >= 0)
16335 haystack += start_idx;
16338 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16339 if (pos != NULL)
16340 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16344 * "string()" function
16346 static void
16347 f_string(argvars, rettv)
16348 typval_T *argvars;
16349 typval_T *rettv;
16351 char_u *tofree;
16352 char_u numbuf[NUMBUFLEN];
16354 rettv->v_type = VAR_STRING;
16355 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16356 /* Make a copy if we have a value but it's not in allocated memory. */
16357 if (rettv->vval.v_string != NULL && tofree == NULL)
16358 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16362 * "strlen()" function
16364 static void
16365 f_strlen(argvars, rettv)
16366 typval_T *argvars;
16367 typval_T *rettv;
16369 rettv->vval.v_number = (varnumber_T)(STRLEN(
16370 get_tv_string(&argvars[0])));
16374 * "strpart()" function
16376 static void
16377 f_strpart(argvars, rettv)
16378 typval_T *argvars;
16379 typval_T *rettv;
16381 char_u *p;
16382 int n;
16383 int len;
16384 int slen;
16385 int error = FALSE;
16387 p = get_tv_string(&argvars[0]);
16388 slen = (int)STRLEN(p);
16390 n = get_tv_number_chk(&argvars[1], &error);
16391 if (error)
16392 len = 0;
16393 else if (argvars[2].v_type != VAR_UNKNOWN)
16394 len = get_tv_number(&argvars[2]);
16395 else
16396 len = slen - n; /* default len: all bytes that are available. */
16399 * Only return the overlap between the specified part and the actual
16400 * string.
16402 if (n < 0)
16404 len += n;
16405 n = 0;
16407 else if (n > slen)
16408 n = slen;
16409 if (len < 0)
16410 len = 0;
16411 else if (n + len > slen)
16412 len = slen - n;
16414 rettv->v_type = VAR_STRING;
16415 rettv->vval.v_string = vim_strnsave(p + n, len);
16419 * "strridx()" function
16421 static void
16422 f_strridx(argvars, rettv)
16423 typval_T *argvars;
16424 typval_T *rettv;
16426 char_u buf[NUMBUFLEN];
16427 char_u *needle;
16428 char_u *haystack;
16429 char_u *rest;
16430 char_u *lastmatch = NULL;
16431 int haystack_len, end_idx;
16433 needle = get_tv_string_chk(&argvars[1]);
16434 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16436 rettv->vval.v_number = -1;
16437 if (needle == NULL || haystack == NULL)
16438 return; /* type error; errmsg already given */
16440 haystack_len = (int)STRLEN(haystack);
16441 if (argvars[2].v_type != VAR_UNKNOWN)
16443 /* Third argument: upper limit for index */
16444 end_idx = get_tv_number_chk(&argvars[2], NULL);
16445 if (end_idx < 0)
16446 return; /* can never find a match */
16448 else
16449 end_idx = haystack_len;
16451 if (*needle == NUL)
16453 /* Empty string matches past the end. */
16454 lastmatch = haystack + end_idx;
16456 else
16458 for (rest = haystack; *rest != '\0'; ++rest)
16460 rest = (char_u *)strstr((char *)rest, (char *)needle);
16461 if (rest == NULL || rest > haystack + end_idx)
16462 break;
16463 lastmatch = rest;
16467 if (lastmatch == NULL)
16468 rettv->vval.v_number = -1;
16469 else
16470 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16474 * "strtrans()" function
16476 static void
16477 f_strtrans(argvars, rettv)
16478 typval_T *argvars;
16479 typval_T *rettv;
16481 rettv->v_type = VAR_STRING;
16482 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16486 * "submatch()" function
16488 static void
16489 f_submatch(argvars, rettv)
16490 typval_T *argvars;
16491 typval_T *rettv;
16493 rettv->v_type = VAR_STRING;
16494 rettv->vval.v_string =
16495 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16499 * "substitute()" function
16501 static void
16502 f_substitute(argvars, rettv)
16503 typval_T *argvars;
16504 typval_T *rettv;
16506 char_u patbuf[NUMBUFLEN];
16507 char_u subbuf[NUMBUFLEN];
16508 char_u flagsbuf[NUMBUFLEN];
16510 char_u *str = get_tv_string_chk(&argvars[0]);
16511 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16512 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16513 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16515 rettv->v_type = VAR_STRING;
16516 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16517 rettv->vval.v_string = NULL;
16518 else
16519 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16523 * "synID(lnum, col, trans)" function
16525 /*ARGSUSED*/
16526 static void
16527 f_synID(argvars, rettv)
16528 typval_T *argvars;
16529 typval_T *rettv;
16531 int id = 0;
16532 #ifdef FEAT_SYN_HL
16533 long lnum;
16534 long col;
16535 int trans;
16536 int transerr = FALSE;
16538 lnum = get_tv_lnum(argvars); /* -1 on type error */
16539 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16540 trans = get_tv_number_chk(&argvars[2], &transerr);
16542 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16543 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16544 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16545 #endif
16547 rettv->vval.v_number = id;
16551 * "synIDattr(id, what [, mode])" function
16553 /*ARGSUSED*/
16554 static void
16555 f_synIDattr(argvars, rettv)
16556 typval_T *argvars;
16557 typval_T *rettv;
16559 char_u *p = NULL;
16560 #ifdef FEAT_SYN_HL
16561 int id;
16562 char_u *what;
16563 char_u *mode;
16564 char_u modebuf[NUMBUFLEN];
16565 int modec;
16567 id = get_tv_number(&argvars[0]);
16568 what = get_tv_string(&argvars[1]);
16569 if (argvars[2].v_type != VAR_UNKNOWN)
16571 mode = get_tv_string_buf(&argvars[2], modebuf);
16572 modec = TOLOWER_ASC(mode[0]);
16573 if (modec != 't' && modec != 'c'
16574 #ifdef FEAT_GUI
16575 && modec != 'g'
16576 #endif
16578 modec = 0; /* replace invalid with current */
16580 else
16582 #ifdef FEAT_GUI
16583 if (gui.in_use)
16584 modec = 'g';
16585 else
16586 #endif
16587 if (t_colors > 1)
16588 modec = 'c';
16589 else
16590 modec = 't';
16594 switch (TOLOWER_ASC(what[0]))
16596 case 'b':
16597 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16598 p = highlight_color(id, what, modec);
16599 else /* bold */
16600 p = highlight_has_attr(id, HL_BOLD, modec);
16601 break;
16603 case 'f': /* fg[#] */
16604 p = highlight_color(id, what, modec);
16605 break;
16607 case 'i':
16608 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16609 p = highlight_has_attr(id, HL_INVERSE, modec);
16610 else /* italic */
16611 p = highlight_has_attr(id, HL_ITALIC, modec);
16612 break;
16614 case 'n': /* name */
16615 p = get_highlight_name(NULL, id - 1);
16616 break;
16618 case 'r': /* reverse */
16619 p = highlight_has_attr(id, HL_INVERSE, modec);
16620 break;
16622 case 's': /* standout */
16623 p = highlight_has_attr(id, HL_STANDOUT, modec);
16624 break;
16626 case 'u':
16627 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16628 /* underline */
16629 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16630 else
16631 /* undercurl */
16632 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16633 break;
16636 if (p != NULL)
16637 p = vim_strsave(p);
16638 #endif
16639 rettv->v_type = VAR_STRING;
16640 rettv->vval.v_string = p;
16644 * "synIDtrans(id)" function
16646 /*ARGSUSED*/
16647 static void
16648 f_synIDtrans(argvars, rettv)
16649 typval_T *argvars;
16650 typval_T *rettv;
16652 int id;
16654 #ifdef FEAT_SYN_HL
16655 id = get_tv_number(&argvars[0]);
16657 if (id > 0)
16658 id = syn_get_final_id(id);
16659 else
16660 #endif
16661 id = 0;
16663 rettv->vval.v_number = id;
16667 * "synstack(lnum, col)" function
16669 /*ARGSUSED*/
16670 static void
16671 f_synstack(argvars, rettv)
16672 typval_T *argvars;
16673 typval_T *rettv;
16675 #ifdef FEAT_SYN_HL
16676 long lnum;
16677 long col;
16678 int i;
16679 int id;
16680 #endif
16682 rettv->v_type = VAR_LIST;
16683 rettv->vval.v_list = NULL;
16685 #ifdef FEAT_SYN_HL
16686 lnum = get_tv_lnum(argvars); /* -1 on type error */
16687 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16689 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16690 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16691 && rettv_list_alloc(rettv) != FAIL)
16693 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16694 for (i = 0; ; ++i)
16696 id = syn_get_stack_item(i);
16697 if (id < 0)
16698 break;
16699 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16700 break;
16703 #endif
16707 * "system()" function
16709 static void
16710 f_system(argvars, rettv)
16711 typval_T *argvars;
16712 typval_T *rettv;
16714 char_u *res = NULL;
16715 char_u *p;
16716 char_u *infile = NULL;
16717 char_u buf[NUMBUFLEN];
16718 int err = FALSE;
16719 FILE *fd;
16721 if (check_restricted() || check_secure())
16722 goto done;
16724 if (argvars[1].v_type != VAR_UNKNOWN)
16727 * Write the string to a temp file, to be used for input of the shell
16728 * command.
16730 if ((infile = vim_tempname('i')) == NULL)
16732 EMSG(_(e_notmp));
16733 goto done;
16736 fd = mch_fopen((char *)infile, WRITEBIN);
16737 if (fd == NULL)
16739 EMSG2(_(e_notopen), infile);
16740 goto done;
16742 p = get_tv_string_buf_chk(&argvars[1], buf);
16743 if (p == NULL)
16745 fclose(fd);
16746 goto done; /* type error; errmsg already given */
16748 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16749 err = TRUE;
16750 if (fclose(fd) != 0)
16751 err = TRUE;
16752 if (err)
16754 EMSG(_("E677: Error writing temp file"));
16755 goto done;
16759 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16760 SHELL_SILENT | SHELL_COOKED);
16762 #ifdef USE_CR
16763 /* translate <CR> into <NL> */
16764 if (res != NULL)
16766 char_u *s;
16768 for (s = res; *s; ++s)
16770 if (*s == CAR)
16771 *s = NL;
16774 #else
16775 # ifdef USE_CRNL
16776 /* translate <CR><NL> into <NL> */
16777 if (res != NULL)
16779 char_u *s, *d;
16781 d = res;
16782 for (s = res; *s; ++s)
16784 if (s[0] == CAR && s[1] == NL)
16785 ++s;
16786 *d++ = *s;
16788 *d = NUL;
16790 # endif
16791 #endif
16793 done:
16794 if (infile != NULL)
16796 mch_remove(infile);
16797 vim_free(infile);
16799 rettv->v_type = VAR_STRING;
16800 rettv->vval.v_string = res;
16804 * "tabpagebuflist()" function
16806 /* ARGSUSED */
16807 static void
16808 f_tabpagebuflist(argvars, rettv)
16809 typval_T *argvars;
16810 typval_T *rettv;
16812 #ifndef FEAT_WINDOWS
16813 rettv->vval.v_number = 0;
16814 #else
16815 tabpage_T *tp;
16816 win_T *wp = NULL;
16818 if (argvars[0].v_type == VAR_UNKNOWN)
16819 wp = firstwin;
16820 else
16822 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16823 if (tp != NULL)
16824 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16826 if (wp == NULL)
16827 rettv->vval.v_number = 0;
16828 else
16830 if (rettv_list_alloc(rettv) == FAIL)
16831 rettv->vval.v_number = 0;
16832 else
16834 for (; wp != NULL; wp = wp->w_next)
16835 if (list_append_number(rettv->vval.v_list,
16836 wp->w_buffer->b_fnum) == FAIL)
16837 break;
16840 #endif
16845 * "tabpagenr()" function
16847 /* ARGSUSED */
16848 static void
16849 f_tabpagenr(argvars, rettv)
16850 typval_T *argvars;
16851 typval_T *rettv;
16853 int nr = 1;
16854 #ifdef FEAT_WINDOWS
16855 char_u *arg;
16857 if (argvars[0].v_type != VAR_UNKNOWN)
16859 arg = get_tv_string_chk(&argvars[0]);
16860 nr = 0;
16861 if (arg != NULL)
16863 if (STRCMP(arg, "$") == 0)
16864 nr = tabpage_index(NULL) - 1;
16865 else
16866 EMSG2(_(e_invexpr2), arg);
16869 else
16870 nr = tabpage_index(curtab);
16871 #endif
16872 rettv->vval.v_number = nr;
16876 #ifdef FEAT_WINDOWS
16877 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16880 * Common code for tabpagewinnr() and winnr().
16882 static int
16883 get_winnr(tp, argvar)
16884 tabpage_T *tp;
16885 typval_T *argvar;
16887 win_T *twin;
16888 int nr = 1;
16889 win_T *wp;
16890 char_u *arg;
16892 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16893 if (argvar->v_type != VAR_UNKNOWN)
16895 arg = get_tv_string_chk(argvar);
16896 if (arg == NULL)
16897 nr = 0; /* type error; errmsg already given */
16898 else if (STRCMP(arg, "$") == 0)
16899 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16900 else if (STRCMP(arg, "#") == 0)
16902 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16903 if (twin == NULL)
16904 nr = 0;
16906 else
16908 EMSG2(_(e_invexpr2), arg);
16909 nr = 0;
16913 if (nr > 0)
16914 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16915 wp != twin; wp = wp->w_next)
16917 if (wp == NULL)
16919 /* didn't find it in this tabpage */
16920 nr = 0;
16921 break;
16923 ++nr;
16925 return nr;
16927 #endif
16930 * "tabpagewinnr()" function
16932 /* ARGSUSED */
16933 static void
16934 f_tabpagewinnr(argvars, rettv)
16935 typval_T *argvars;
16936 typval_T *rettv;
16938 int nr = 1;
16939 #ifdef FEAT_WINDOWS
16940 tabpage_T *tp;
16942 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16943 if (tp == NULL)
16944 nr = 0;
16945 else
16946 nr = get_winnr(tp, &argvars[1]);
16947 #endif
16948 rettv->vval.v_number = nr;
16953 * "tagfiles()" function
16955 /*ARGSUSED*/
16956 static void
16957 f_tagfiles(argvars, rettv)
16958 typval_T *argvars;
16959 typval_T *rettv;
16961 char_u fname[MAXPATHL + 1];
16962 tagname_T tn;
16963 int first;
16965 if (rettv_list_alloc(rettv) == FAIL)
16967 rettv->vval.v_number = 0;
16968 return;
16971 for (first = TRUE; ; first = FALSE)
16972 if (get_tagfname(&tn, first, fname) == FAIL
16973 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16974 break;
16975 tagname_free(&tn);
16979 * "taglist()" function
16981 static void
16982 f_taglist(argvars, rettv)
16983 typval_T *argvars;
16984 typval_T *rettv;
16986 char_u *tag_pattern;
16988 tag_pattern = get_tv_string(&argvars[0]);
16990 rettv->vval.v_number = FALSE;
16991 if (*tag_pattern == NUL)
16992 return;
16994 if (rettv_list_alloc(rettv) == OK)
16995 (void)get_tags(rettv->vval.v_list, tag_pattern);
16999 * "tempname()" function
17001 /*ARGSUSED*/
17002 static void
17003 f_tempname(argvars, rettv)
17004 typval_T *argvars;
17005 typval_T *rettv;
17007 static int x = 'A';
17009 rettv->v_type = VAR_STRING;
17010 rettv->vval.v_string = vim_tempname(x);
17012 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17013 * names. Skip 'I' and 'O', they are used for shell redirection. */
17016 if (x == 'Z')
17017 x = '0';
17018 else if (x == '9')
17019 x = 'A';
17020 else
17022 #ifdef EBCDIC
17023 if (x == 'I')
17024 x = 'J';
17025 else if (x == 'R')
17026 x = 'S';
17027 else
17028 #endif
17029 ++x;
17031 } while (x == 'I' || x == 'O');
17035 * "test(list)" function: Just checking the walls...
17037 /*ARGSUSED*/
17038 static void
17039 f_test(argvars, rettv)
17040 typval_T *argvars;
17041 typval_T *rettv;
17043 /* Used for unit testing. Change the code below to your liking. */
17044 #if 0
17045 listitem_T *li;
17046 list_T *l;
17047 char_u *bad, *good;
17049 if (argvars[0].v_type != VAR_LIST)
17050 return;
17051 l = argvars[0].vval.v_list;
17052 if (l == NULL)
17053 return;
17054 li = l->lv_first;
17055 if (li == NULL)
17056 return;
17057 bad = get_tv_string(&li->li_tv);
17058 li = li->li_next;
17059 if (li == NULL)
17060 return;
17061 good = get_tv_string(&li->li_tv);
17062 rettv->vval.v_number = test_edit_score(bad, good);
17063 #endif
17067 * "tolower(string)" function
17069 static void
17070 f_tolower(argvars, rettv)
17071 typval_T *argvars;
17072 typval_T *rettv;
17074 char_u *p;
17076 p = vim_strsave(get_tv_string(&argvars[0]));
17077 rettv->v_type = VAR_STRING;
17078 rettv->vval.v_string = p;
17080 if (p != NULL)
17081 while (*p != NUL)
17083 #ifdef FEAT_MBYTE
17084 int l;
17086 if (enc_utf8)
17088 int c, lc;
17090 c = utf_ptr2char(p);
17091 lc = utf_tolower(c);
17092 l = utf_ptr2len(p);
17093 /* TODO: reallocate string when byte count changes. */
17094 if (utf_char2len(lc) == l)
17095 utf_char2bytes(lc, p);
17096 p += l;
17098 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17099 p += l; /* skip multi-byte character */
17100 else
17101 #endif
17103 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17104 ++p;
17110 * "toupper(string)" function
17112 static void
17113 f_toupper(argvars, rettv)
17114 typval_T *argvars;
17115 typval_T *rettv;
17117 rettv->v_type = VAR_STRING;
17118 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17122 * "tr(string, fromstr, tostr)" function
17124 static void
17125 f_tr(argvars, rettv)
17126 typval_T *argvars;
17127 typval_T *rettv;
17129 char_u *instr;
17130 char_u *fromstr;
17131 char_u *tostr;
17132 char_u *p;
17133 #ifdef FEAT_MBYTE
17134 int inlen;
17135 int fromlen;
17136 int tolen;
17137 int idx;
17138 char_u *cpstr;
17139 int cplen;
17140 int first = TRUE;
17141 #endif
17142 char_u buf[NUMBUFLEN];
17143 char_u buf2[NUMBUFLEN];
17144 garray_T ga;
17146 instr = get_tv_string(&argvars[0]);
17147 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17148 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17150 /* Default return value: empty string. */
17151 rettv->v_type = VAR_STRING;
17152 rettv->vval.v_string = NULL;
17153 if (fromstr == NULL || tostr == NULL)
17154 return; /* type error; errmsg already given */
17155 ga_init2(&ga, (int)sizeof(char), 80);
17157 #ifdef FEAT_MBYTE
17158 if (!has_mbyte)
17159 #endif
17160 /* not multi-byte: fromstr and tostr must be the same length */
17161 if (STRLEN(fromstr) != STRLEN(tostr))
17163 #ifdef FEAT_MBYTE
17164 error:
17165 #endif
17166 EMSG2(_(e_invarg2), fromstr);
17167 ga_clear(&ga);
17168 return;
17171 /* fromstr and tostr have to contain the same number of chars */
17172 while (*instr != NUL)
17174 #ifdef FEAT_MBYTE
17175 if (has_mbyte)
17177 inlen = (*mb_ptr2len)(instr);
17178 cpstr = instr;
17179 cplen = inlen;
17180 idx = 0;
17181 for (p = fromstr; *p != NUL; p += fromlen)
17183 fromlen = (*mb_ptr2len)(p);
17184 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17186 for (p = tostr; *p != NUL; p += tolen)
17188 tolen = (*mb_ptr2len)(p);
17189 if (idx-- == 0)
17191 cplen = tolen;
17192 cpstr = p;
17193 break;
17196 if (*p == NUL) /* tostr is shorter than fromstr */
17197 goto error;
17198 break;
17200 ++idx;
17203 if (first && cpstr == instr)
17205 /* Check that fromstr and tostr have the same number of
17206 * (multi-byte) characters. Done only once when a character
17207 * of instr doesn't appear in fromstr. */
17208 first = FALSE;
17209 for (p = tostr; *p != NUL; p += tolen)
17211 tolen = (*mb_ptr2len)(p);
17212 --idx;
17214 if (idx != 0)
17215 goto error;
17218 ga_grow(&ga, cplen);
17219 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17220 ga.ga_len += cplen;
17222 instr += inlen;
17224 else
17225 #endif
17227 /* When not using multi-byte chars we can do it faster. */
17228 p = vim_strchr(fromstr, *instr);
17229 if (p != NULL)
17230 ga_append(&ga, tostr[p - fromstr]);
17231 else
17232 ga_append(&ga, *instr);
17233 ++instr;
17237 /* add a terminating NUL */
17238 ga_grow(&ga, 1);
17239 ga_append(&ga, NUL);
17241 rettv->vval.v_string = ga.ga_data;
17244 #ifdef FEAT_FLOAT
17246 * "trunc({float})" function
17248 static void
17249 f_trunc(argvars, rettv)
17250 typval_T *argvars;
17251 typval_T *rettv;
17253 float_T f;
17255 rettv->v_type = VAR_FLOAT;
17256 if (get_float_arg(argvars, &f) == OK)
17257 /* trunc() is not in C90, use floor() or ceil() instead. */
17258 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17259 else
17260 rettv->vval.v_float = 0.0;
17262 #endif
17265 * "type(expr)" function
17267 static void
17268 f_type(argvars, rettv)
17269 typval_T *argvars;
17270 typval_T *rettv;
17272 int n;
17274 switch (argvars[0].v_type)
17276 case VAR_NUMBER: n = 0; break;
17277 case VAR_STRING: n = 1; break;
17278 case VAR_FUNC: n = 2; break;
17279 case VAR_LIST: n = 3; break;
17280 case VAR_DICT: n = 4; break;
17281 #ifdef FEAT_FLOAT
17282 case VAR_FLOAT: n = 5; break;
17283 #endif
17284 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17286 rettv->vval.v_number = n;
17290 * "values(dict)" function
17292 static void
17293 f_values(argvars, rettv)
17294 typval_T *argvars;
17295 typval_T *rettv;
17297 dict_list(argvars, rettv, 1);
17301 * "virtcol(string)" function
17303 static void
17304 f_virtcol(argvars, rettv)
17305 typval_T *argvars;
17306 typval_T *rettv;
17308 colnr_T vcol = 0;
17309 pos_T *fp;
17310 int fnum = curbuf->b_fnum;
17312 fp = var2fpos(&argvars[0], FALSE, &fnum);
17313 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17314 && fnum == curbuf->b_fnum)
17316 getvvcol(curwin, fp, NULL, NULL, &vcol);
17317 ++vcol;
17320 rettv->vval.v_number = vcol;
17324 * "visualmode()" function
17326 /*ARGSUSED*/
17327 static void
17328 f_visualmode(argvars, rettv)
17329 typval_T *argvars;
17330 typval_T *rettv;
17332 #ifdef FEAT_VISUAL
17333 char_u str[2];
17335 rettv->v_type = VAR_STRING;
17336 str[0] = curbuf->b_visual_mode_eval;
17337 str[1] = NUL;
17338 rettv->vval.v_string = vim_strsave(str);
17340 /* A non-zero number or non-empty string argument: reset mode. */
17341 if (non_zero_arg(&argvars[0]))
17342 curbuf->b_visual_mode_eval = NUL;
17343 #else
17344 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17345 #endif
17349 * "winbufnr(nr)" function
17351 static void
17352 f_winbufnr(argvars, rettv)
17353 typval_T *argvars;
17354 typval_T *rettv;
17356 win_T *wp;
17358 wp = find_win_by_nr(&argvars[0], NULL);
17359 if (wp == NULL)
17360 rettv->vval.v_number = -1;
17361 else
17362 rettv->vval.v_number = wp->w_buffer->b_fnum;
17366 * "wincol()" function
17368 /*ARGSUSED*/
17369 static void
17370 f_wincol(argvars, rettv)
17371 typval_T *argvars;
17372 typval_T *rettv;
17374 validate_cursor();
17375 rettv->vval.v_number = curwin->w_wcol + 1;
17379 * "winheight(nr)" function
17381 static void
17382 f_winheight(argvars, rettv)
17383 typval_T *argvars;
17384 typval_T *rettv;
17386 win_T *wp;
17388 wp = find_win_by_nr(&argvars[0], NULL);
17389 if (wp == NULL)
17390 rettv->vval.v_number = -1;
17391 else
17392 rettv->vval.v_number = wp->w_height;
17396 * "winline()" function
17398 /*ARGSUSED*/
17399 static void
17400 f_winline(argvars, rettv)
17401 typval_T *argvars;
17402 typval_T *rettv;
17404 validate_cursor();
17405 rettv->vval.v_number = curwin->w_wrow + 1;
17409 * "winnr()" function
17411 /* ARGSUSED */
17412 static void
17413 f_winnr(argvars, rettv)
17414 typval_T *argvars;
17415 typval_T *rettv;
17417 int nr = 1;
17419 #ifdef FEAT_WINDOWS
17420 nr = get_winnr(curtab, &argvars[0]);
17421 #endif
17422 rettv->vval.v_number = nr;
17426 * "winrestcmd()" function
17428 /* ARGSUSED */
17429 static void
17430 f_winrestcmd(argvars, rettv)
17431 typval_T *argvars;
17432 typval_T *rettv;
17434 #ifdef FEAT_WINDOWS
17435 win_T *wp;
17436 int winnr = 1;
17437 garray_T ga;
17438 char_u buf[50];
17440 ga_init2(&ga, (int)sizeof(char), 70);
17441 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17443 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17444 ga_concat(&ga, buf);
17445 # ifdef FEAT_VERTSPLIT
17446 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17447 ga_concat(&ga, buf);
17448 # endif
17449 ++winnr;
17451 ga_append(&ga, NUL);
17453 rettv->vval.v_string = ga.ga_data;
17454 #else
17455 rettv->vval.v_string = NULL;
17456 #endif
17457 rettv->v_type = VAR_STRING;
17461 * "winrestview()" function
17463 /* ARGSUSED */
17464 static void
17465 f_winrestview(argvars, rettv)
17466 typval_T *argvars;
17467 typval_T *rettv;
17469 dict_T *dict;
17471 if (argvars[0].v_type != VAR_DICT
17472 || (dict = argvars[0].vval.v_dict) == NULL)
17473 EMSG(_(e_invarg));
17474 else
17476 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17477 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17478 #ifdef FEAT_VIRTUALEDIT
17479 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17480 #endif
17481 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17482 curwin->w_set_curswant = FALSE;
17484 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17485 #ifdef FEAT_DIFF
17486 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17487 #endif
17488 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17489 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17491 check_cursor();
17492 changed_cline_bef_curs();
17493 invalidate_botline();
17494 redraw_later(VALID);
17496 if (curwin->w_topline == 0)
17497 curwin->w_topline = 1;
17498 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17499 curwin->w_topline = curbuf->b_ml.ml_line_count;
17500 #ifdef FEAT_DIFF
17501 check_topfill(curwin, TRUE);
17502 #endif
17507 * "winsaveview()" function
17509 /* ARGSUSED */
17510 static void
17511 f_winsaveview(argvars, rettv)
17512 typval_T *argvars;
17513 typval_T *rettv;
17515 dict_T *dict;
17517 dict = dict_alloc();
17518 if (dict == NULL)
17519 return;
17520 rettv->v_type = VAR_DICT;
17521 rettv->vval.v_dict = dict;
17522 ++dict->dv_refcount;
17524 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17525 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17526 #ifdef FEAT_VIRTUALEDIT
17527 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17528 #endif
17529 update_curswant();
17530 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17532 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17533 #ifdef FEAT_DIFF
17534 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17535 #endif
17536 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17537 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17541 * "winwidth(nr)" function
17543 static void
17544 f_winwidth(argvars, rettv)
17545 typval_T *argvars;
17546 typval_T *rettv;
17548 win_T *wp;
17550 wp = find_win_by_nr(&argvars[0], NULL);
17551 if (wp == NULL)
17552 rettv->vval.v_number = -1;
17553 else
17554 #ifdef FEAT_VERTSPLIT
17555 rettv->vval.v_number = wp->w_width;
17556 #else
17557 rettv->vval.v_number = Columns;
17558 #endif
17562 * "writefile()" function
17564 static void
17565 f_writefile(argvars, rettv)
17566 typval_T *argvars;
17567 typval_T *rettv;
17569 int binary = FALSE;
17570 char_u *fname;
17571 FILE *fd;
17572 listitem_T *li;
17573 char_u *s;
17574 int ret = 0;
17575 int c;
17577 if (check_restricted() || check_secure())
17578 return;
17580 if (argvars[0].v_type != VAR_LIST)
17582 EMSG2(_(e_listarg), "writefile()");
17583 return;
17585 if (argvars[0].vval.v_list == NULL)
17586 return;
17588 if (argvars[2].v_type != VAR_UNKNOWN
17589 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17590 binary = TRUE;
17592 /* Always open the file in binary mode, library functions have a mind of
17593 * their own about CR-LF conversion. */
17594 fname = get_tv_string(&argvars[1]);
17595 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17597 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17598 ret = -1;
17600 else
17602 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17603 li = li->li_next)
17605 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17607 if (*s == '\n')
17608 c = putc(NUL, fd);
17609 else
17610 c = putc(*s, fd);
17611 if (c == EOF)
17613 ret = -1;
17614 break;
17617 if (!binary || li->li_next != NULL)
17618 if (putc('\n', fd) == EOF)
17620 ret = -1;
17621 break;
17623 if (ret < 0)
17625 EMSG(_(e_write));
17626 break;
17629 fclose(fd);
17632 rettv->vval.v_number = ret;
17636 * Translate a String variable into a position.
17637 * Returns NULL when there is an error.
17639 static pos_T *
17640 var2fpos(varp, dollar_lnum, fnum)
17641 typval_T *varp;
17642 int dollar_lnum; /* TRUE when $ is last line */
17643 int *fnum; /* set to fnum for '0, 'A, etc. */
17645 char_u *name;
17646 static pos_T pos;
17647 pos_T *pp;
17649 /* Argument can be [lnum, col, coladd]. */
17650 if (varp->v_type == VAR_LIST)
17652 list_T *l;
17653 int len;
17654 int error = FALSE;
17655 listitem_T *li;
17657 l = varp->vval.v_list;
17658 if (l == NULL)
17659 return NULL;
17661 /* Get the line number */
17662 pos.lnum = list_find_nr(l, 0L, &error);
17663 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17664 return NULL; /* invalid line number */
17666 /* Get the column number */
17667 pos.col = list_find_nr(l, 1L, &error);
17668 if (error)
17669 return NULL;
17670 len = (long)STRLEN(ml_get(pos.lnum));
17672 /* We accept "$" for the column number: last column. */
17673 li = list_find(l, 1L);
17674 if (li != NULL && li->li_tv.v_type == VAR_STRING
17675 && li->li_tv.vval.v_string != NULL
17676 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17677 pos.col = len + 1;
17679 /* Accept a position up to the NUL after the line. */
17680 if (pos.col == 0 || (int)pos.col > len + 1)
17681 return NULL; /* invalid column number */
17682 --pos.col;
17684 #ifdef FEAT_VIRTUALEDIT
17685 /* Get the virtual offset. Defaults to zero. */
17686 pos.coladd = list_find_nr(l, 2L, &error);
17687 if (error)
17688 pos.coladd = 0;
17689 #endif
17691 return &pos;
17694 name = get_tv_string_chk(varp);
17695 if (name == NULL)
17696 return NULL;
17697 if (name[0] == '.') /* cursor */
17698 return &curwin->w_cursor;
17699 #ifdef FEAT_VISUAL
17700 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17702 if (VIsual_active)
17703 return &VIsual;
17704 return &curwin->w_cursor;
17706 #endif
17707 if (name[0] == '\'') /* mark */
17709 pp = getmark_fnum(name[1], FALSE, fnum);
17710 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17711 return NULL;
17712 return pp;
17715 #ifdef FEAT_VIRTUALEDIT
17716 pos.coladd = 0;
17717 #endif
17719 if (name[0] == 'w' && dollar_lnum)
17721 pos.col = 0;
17722 if (name[1] == '0') /* "w0": first visible line */
17724 update_topline();
17725 pos.lnum = curwin->w_topline;
17726 return &pos;
17728 else if (name[1] == '$') /* "w$": last visible line */
17730 validate_botline();
17731 pos.lnum = curwin->w_botline - 1;
17732 return &pos;
17735 else if (name[0] == '$') /* last column or line */
17737 if (dollar_lnum)
17739 pos.lnum = curbuf->b_ml.ml_line_count;
17740 pos.col = 0;
17742 else
17744 pos.lnum = curwin->w_cursor.lnum;
17745 pos.col = (colnr_T)STRLEN(ml_get_curline());
17747 return &pos;
17749 return NULL;
17753 * Convert list in "arg" into a position and optional file number.
17754 * When "fnump" is NULL there is no file number, only 3 items.
17755 * Note that the column is passed on as-is, the caller may want to decrement
17756 * it to use 1 for the first column.
17757 * Return FAIL when conversion is not possible, doesn't check the position for
17758 * validity.
17760 static int
17761 list2fpos(arg, posp, fnump)
17762 typval_T *arg;
17763 pos_T *posp;
17764 int *fnump;
17766 list_T *l = arg->vval.v_list;
17767 long i = 0;
17768 long n;
17770 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17771 * when "fnump" isn't NULL and "coladd" is optional. */
17772 if (arg->v_type != VAR_LIST
17773 || l == NULL
17774 || l->lv_len < (fnump == NULL ? 2 : 3)
17775 || l->lv_len > (fnump == NULL ? 3 : 4))
17776 return FAIL;
17778 if (fnump != NULL)
17780 n = list_find_nr(l, i++, NULL); /* fnum */
17781 if (n < 0)
17782 return FAIL;
17783 if (n == 0)
17784 n = curbuf->b_fnum; /* current buffer */
17785 *fnump = n;
17788 n = list_find_nr(l, i++, NULL); /* lnum */
17789 if (n < 0)
17790 return FAIL;
17791 posp->lnum = n;
17793 n = list_find_nr(l, i++, NULL); /* col */
17794 if (n < 0)
17795 return FAIL;
17796 posp->col = n;
17798 #ifdef FEAT_VIRTUALEDIT
17799 n = list_find_nr(l, i, NULL);
17800 if (n < 0)
17801 posp->coladd = 0;
17802 else
17803 posp->coladd = n;
17804 #endif
17806 return OK;
17810 * Get the length of an environment variable name.
17811 * Advance "arg" to the first character after the name.
17812 * Return 0 for error.
17814 static int
17815 get_env_len(arg)
17816 char_u **arg;
17818 char_u *p;
17819 int len;
17821 for (p = *arg; vim_isIDc(*p); ++p)
17823 if (p == *arg) /* no name found */
17824 return 0;
17826 len = (int)(p - *arg);
17827 *arg = p;
17828 return len;
17832 * Get the length of the name of a function or internal variable.
17833 * "arg" is advanced to the first non-white character after the name.
17834 * Return 0 if something is wrong.
17836 static int
17837 get_id_len(arg)
17838 char_u **arg;
17840 char_u *p;
17841 int len;
17843 /* Find the end of the name. */
17844 for (p = *arg; eval_isnamec(*p); ++p)
17846 if (p == *arg) /* no name found */
17847 return 0;
17849 len = (int)(p - *arg);
17850 *arg = skipwhite(p);
17852 return len;
17856 * Get the length of the name of a variable or function.
17857 * Only the name is recognized, does not handle ".key" or "[idx]".
17858 * "arg" is advanced to the first non-white character after the name.
17859 * Return -1 if curly braces expansion failed.
17860 * Return 0 if something else is wrong.
17861 * If the name contains 'magic' {}'s, expand them and return the
17862 * expanded name in an allocated string via 'alias' - caller must free.
17864 static int
17865 get_name_len(arg, alias, evaluate, verbose)
17866 char_u **arg;
17867 char_u **alias;
17868 int evaluate;
17869 int verbose;
17871 int len;
17872 char_u *p;
17873 char_u *expr_start;
17874 char_u *expr_end;
17876 *alias = NULL; /* default to no alias */
17878 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17879 && (*arg)[2] == (int)KE_SNR)
17881 /* hard coded <SNR>, already translated */
17882 *arg += 3;
17883 return get_id_len(arg) + 3;
17885 len = eval_fname_script(*arg);
17886 if (len > 0)
17888 /* literal "<SID>", "s:" or "<SNR>" */
17889 *arg += len;
17893 * Find the end of the name; check for {} construction.
17895 p = find_name_end(*arg, &expr_start, &expr_end,
17896 len > 0 ? 0 : FNE_CHECK_START);
17897 if (expr_start != NULL)
17899 char_u *temp_string;
17901 if (!evaluate)
17903 len += (int)(p - *arg);
17904 *arg = skipwhite(p);
17905 return len;
17909 * Include any <SID> etc in the expanded string:
17910 * Thus the -len here.
17912 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17913 if (temp_string == NULL)
17914 return -1;
17915 *alias = temp_string;
17916 *arg = skipwhite(p);
17917 return (int)STRLEN(temp_string);
17920 len += get_id_len(arg);
17921 if (len == 0 && verbose)
17922 EMSG2(_(e_invexpr2), *arg);
17924 return len;
17928 * Find the end of a variable or function name, taking care of magic braces.
17929 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17930 * start and end of the first magic braces item.
17931 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17932 * Return a pointer to just after the name. Equal to "arg" if there is no
17933 * valid name.
17935 static char_u *
17936 find_name_end(arg, expr_start, expr_end, flags)
17937 char_u *arg;
17938 char_u **expr_start;
17939 char_u **expr_end;
17940 int flags;
17942 int mb_nest = 0;
17943 int br_nest = 0;
17944 char_u *p;
17946 if (expr_start != NULL)
17948 *expr_start = NULL;
17949 *expr_end = NULL;
17952 /* Quick check for valid starting character. */
17953 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17954 return arg;
17956 for (p = arg; *p != NUL
17957 && (eval_isnamec(*p)
17958 || *p == '{'
17959 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17960 || mb_nest != 0
17961 || br_nest != 0); mb_ptr_adv(p))
17963 if (*p == '\'')
17965 /* skip over 'string' to avoid counting [ and ] inside it. */
17966 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17968 if (*p == NUL)
17969 break;
17971 else if (*p == '"')
17973 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17974 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17975 if (*p == '\\' && p[1] != NUL)
17976 ++p;
17977 if (*p == NUL)
17978 break;
17981 if (mb_nest == 0)
17983 if (*p == '[')
17984 ++br_nest;
17985 else if (*p == ']')
17986 --br_nest;
17989 if (br_nest == 0)
17991 if (*p == '{')
17993 mb_nest++;
17994 if (expr_start != NULL && *expr_start == NULL)
17995 *expr_start = p;
17997 else if (*p == '}')
17999 mb_nest--;
18000 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18001 *expr_end = p;
18006 return p;
18010 * Expands out the 'magic' {}'s in a variable/function name.
18011 * Note that this can call itself recursively, to deal with
18012 * constructs like foo{bar}{baz}{bam}
18013 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18014 * "in_start" ^
18015 * "expr_start" ^
18016 * "expr_end" ^
18017 * "in_end" ^
18019 * Returns a new allocated string, which the caller must free.
18020 * Returns NULL for failure.
18022 static char_u *
18023 make_expanded_name(in_start, expr_start, expr_end, in_end)
18024 char_u *in_start;
18025 char_u *expr_start;
18026 char_u *expr_end;
18027 char_u *in_end;
18029 char_u c1;
18030 char_u *retval = NULL;
18031 char_u *temp_result;
18032 char_u *nextcmd = NULL;
18034 if (expr_end == NULL || in_end == NULL)
18035 return NULL;
18036 *expr_start = NUL;
18037 *expr_end = NUL;
18038 c1 = *in_end;
18039 *in_end = NUL;
18041 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18042 if (temp_result != NULL && nextcmd == NULL)
18044 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18045 + (in_end - expr_end) + 1));
18046 if (retval != NULL)
18048 STRCPY(retval, in_start);
18049 STRCAT(retval, temp_result);
18050 STRCAT(retval, expr_end + 1);
18053 vim_free(temp_result);
18055 *in_end = c1; /* put char back for error messages */
18056 *expr_start = '{';
18057 *expr_end = '}';
18059 if (retval != NULL)
18061 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18062 if (expr_start != NULL)
18064 /* Further expansion! */
18065 temp_result = make_expanded_name(retval, expr_start,
18066 expr_end, temp_result);
18067 vim_free(retval);
18068 retval = temp_result;
18072 return retval;
18076 * Return TRUE if character "c" can be used in a variable or function name.
18077 * Does not include '{' or '}' for magic braces.
18079 static int
18080 eval_isnamec(c)
18081 int c;
18083 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18087 * Return TRUE if character "c" can be used as the first character in a
18088 * variable or function name (excluding '{' and '}').
18090 static int
18091 eval_isnamec1(c)
18092 int c;
18094 return (ASCII_ISALPHA(c) || c == '_');
18098 * Set number v: variable to "val".
18100 void
18101 set_vim_var_nr(idx, val)
18102 int idx;
18103 long val;
18105 vimvars[idx].vv_nr = val;
18109 * Get number v: variable value.
18111 long
18112 get_vim_var_nr(idx)
18113 int idx;
18115 return vimvars[idx].vv_nr;
18119 * Get string v: variable value. Uses a static buffer, can only be used once.
18121 char_u *
18122 get_vim_var_str(idx)
18123 int idx;
18125 return get_tv_string(&vimvars[idx].vv_tv);
18129 * Set v:count, v:count1 and v:prevcount.
18131 void
18132 set_vcount(count, count1)
18133 long count;
18134 long count1;
18136 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18137 vimvars[VV_COUNT].vv_nr = count;
18138 vimvars[VV_COUNT1].vv_nr = count1;
18142 * Set string v: variable to a copy of "val".
18144 void
18145 set_vim_var_string(idx, val, len)
18146 int idx;
18147 char_u *val;
18148 int len; /* length of "val" to use or -1 (whole string) */
18150 /* Need to do this (at least) once, since we can't initialize a union.
18151 * Will always be invoked when "v:progname" is set. */
18152 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18154 vim_free(vimvars[idx].vv_str);
18155 if (val == NULL)
18156 vimvars[idx].vv_str = NULL;
18157 else if (len == -1)
18158 vimvars[idx].vv_str = vim_strsave(val);
18159 else
18160 vimvars[idx].vv_str = vim_strnsave(val, len);
18164 * Set v:register if needed.
18166 void
18167 set_reg_var(c)
18168 int c;
18170 char_u regname;
18172 if (c == 0 || c == ' ')
18173 regname = '"';
18174 else
18175 regname = c;
18176 /* Avoid free/alloc when the value is already right. */
18177 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18178 set_vim_var_string(VV_REG, &regname, 1);
18182 * Get or set v:exception. If "oldval" == NULL, return the current value.
18183 * Otherwise, restore the value to "oldval" and return NULL.
18184 * Must always be called in pairs to save and restore v:exception! Does not
18185 * take care of memory allocations.
18187 char_u *
18188 v_exception(oldval)
18189 char_u *oldval;
18191 if (oldval == NULL)
18192 return vimvars[VV_EXCEPTION].vv_str;
18194 vimvars[VV_EXCEPTION].vv_str = oldval;
18195 return NULL;
18199 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18200 * Otherwise, restore the value to "oldval" and return NULL.
18201 * Must always be called in pairs to save and restore v:throwpoint! Does not
18202 * take care of memory allocations.
18204 char_u *
18205 v_throwpoint(oldval)
18206 char_u *oldval;
18208 if (oldval == NULL)
18209 return vimvars[VV_THROWPOINT].vv_str;
18211 vimvars[VV_THROWPOINT].vv_str = oldval;
18212 return NULL;
18215 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18217 * Set v:cmdarg.
18218 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18219 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18220 * Must always be called in pairs!
18222 char_u *
18223 set_cmdarg(eap, oldarg)
18224 exarg_T *eap;
18225 char_u *oldarg;
18227 char_u *oldval;
18228 char_u *newval;
18229 unsigned len;
18231 oldval = vimvars[VV_CMDARG].vv_str;
18232 if (eap == NULL)
18234 vim_free(oldval);
18235 vimvars[VV_CMDARG].vv_str = oldarg;
18236 return NULL;
18239 if (eap->force_bin == FORCE_BIN)
18240 len = 6;
18241 else if (eap->force_bin == FORCE_NOBIN)
18242 len = 8;
18243 else
18244 len = 0;
18246 if (eap->read_edit)
18247 len += 7;
18249 if (eap->force_ff != 0)
18250 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18251 # ifdef FEAT_MBYTE
18252 if (eap->force_enc != 0)
18253 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18254 if (eap->bad_char != 0)
18255 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18256 # endif
18258 newval = alloc(len + 1);
18259 if (newval == NULL)
18260 return NULL;
18262 if (eap->force_bin == FORCE_BIN)
18263 sprintf((char *)newval, " ++bin");
18264 else if (eap->force_bin == FORCE_NOBIN)
18265 sprintf((char *)newval, " ++nobin");
18266 else
18267 *newval = NUL;
18269 if (eap->read_edit)
18270 STRCAT(newval, " ++edit");
18272 if (eap->force_ff != 0)
18273 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18274 eap->cmd + eap->force_ff);
18275 # ifdef FEAT_MBYTE
18276 if (eap->force_enc != 0)
18277 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18278 eap->cmd + eap->force_enc);
18279 if (eap->bad_char != 0)
18280 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18281 eap->cmd + eap->bad_char);
18282 # endif
18283 vimvars[VV_CMDARG].vv_str = newval;
18284 return oldval;
18286 #endif
18289 * Get the value of internal variable "name".
18290 * Return OK or FAIL.
18292 static int
18293 get_var_tv(name, len, rettv, verbose)
18294 char_u *name;
18295 int len; /* length of "name" */
18296 typval_T *rettv; /* NULL when only checking existence */
18297 int verbose; /* may give error message */
18299 int ret = OK;
18300 typval_T *tv = NULL;
18301 typval_T atv;
18302 dictitem_T *v;
18303 int cc;
18305 /* truncate the name, so that we can use strcmp() */
18306 cc = name[len];
18307 name[len] = NUL;
18310 * Check for "b:changedtick".
18312 if (STRCMP(name, "b:changedtick") == 0)
18314 atv.v_type = VAR_NUMBER;
18315 atv.vval.v_number = curbuf->b_changedtick;
18316 tv = &atv;
18320 * Check for user-defined variables.
18322 else
18324 v = find_var(name, NULL);
18325 if (v != NULL)
18326 tv = &v->di_tv;
18329 if (tv == NULL)
18331 if (rettv != NULL && verbose)
18332 EMSG2(_(e_undefvar), name);
18333 ret = FAIL;
18335 else if (rettv != NULL)
18336 copy_tv(tv, rettv);
18338 name[len] = cc;
18340 return ret;
18344 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18345 * Also handle function call with Funcref variable: func(expr)
18346 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18348 static int
18349 handle_subscript(arg, rettv, evaluate, verbose)
18350 char_u **arg;
18351 typval_T *rettv;
18352 int evaluate; /* do more than finding the end */
18353 int verbose; /* give error messages */
18355 int ret = OK;
18356 dict_T *selfdict = NULL;
18357 char_u *s;
18358 int len;
18359 typval_T functv;
18361 while (ret == OK
18362 && (**arg == '['
18363 || (**arg == '.' && rettv->v_type == VAR_DICT)
18364 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18365 && !vim_iswhite(*(*arg - 1)))
18367 if (**arg == '(')
18369 /* need to copy the funcref so that we can clear rettv */
18370 functv = *rettv;
18371 rettv->v_type = VAR_UNKNOWN;
18373 /* Invoke the function. Recursive! */
18374 s = functv.vval.v_string;
18375 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18376 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18377 &len, evaluate, selfdict);
18379 /* Clear the funcref afterwards, so that deleting it while
18380 * evaluating the arguments is possible (see test55). */
18381 clear_tv(&functv);
18383 /* Stop the expression evaluation when immediately aborting on
18384 * error, or when an interrupt occurred or an exception was thrown
18385 * but not caught. */
18386 if (aborting())
18388 if (ret == OK)
18389 clear_tv(rettv);
18390 ret = FAIL;
18392 dict_unref(selfdict);
18393 selfdict = NULL;
18395 else /* **arg == '[' || **arg == '.' */
18397 dict_unref(selfdict);
18398 if (rettv->v_type == VAR_DICT)
18400 selfdict = rettv->vval.v_dict;
18401 if (selfdict != NULL)
18402 ++selfdict->dv_refcount;
18404 else
18405 selfdict = NULL;
18406 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18408 clear_tv(rettv);
18409 ret = FAIL;
18413 dict_unref(selfdict);
18414 return ret;
18418 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18419 * value).
18421 static typval_T *
18422 alloc_tv()
18424 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18428 * Allocate memory for a variable type-value, and assign a string to it.
18429 * The string "s" must have been allocated, it is consumed.
18430 * Return NULL for out of memory, the variable otherwise.
18432 static typval_T *
18433 alloc_string_tv(s)
18434 char_u *s;
18436 typval_T *rettv;
18438 rettv = alloc_tv();
18439 if (rettv != NULL)
18441 rettv->v_type = VAR_STRING;
18442 rettv->vval.v_string = s;
18444 else
18445 vim_free(s);
18446 return rettv;
18450 * Free the memory for a variable type-value.
18452 void
18453 free_tv(varp)
18454 typval_T *varp;
18456 if (varp != NULL)
18458 switch (varp->v_type)
18460 case VAR_FUNC:
18461 func_unref(varp->vval.v_string);
18462 /*FALLTHROUGH*/
18463 case VAR_STRING:
18464 vim_free(varp->vval.v_string);
18465 break;
18466 case VAR_LIST:
18467 list_unref(varp->vval.v_list);
18468 break;
18469 case VAR_DICT:
18470 dict_unref(varp->vval.v_dict);
18471 break;
18472 case VAR_NUMBER:
18473 #ifdef FEAT_FLOAT
18474 case VAR_FLOAT:
18475 #endif
18476 case VAR_UNKNOWN:
18477 break;
18478 default:
18479 EMSG2(_(e_intern2), "free_tv()");
18480 break;
18482 vim_free(varp);
18487 * Free the memory for a variable value and set the value to NULL or 0.
18489 void
18490 clear_tv(varp)
18491 typval_T *varp;
18493 if (varp != NULL)
18495 switch (varp->v_type)
18497 case VAR_FUNC:
18498 func_unref(varp->vval.v_string);
18499 /*FALLTHROUGH*/
18500 case VAR_STRING:
18501 vim_free(varp->vval.v_string);
18502 varp->vval.v_string = NULL;
18503 break;
18504 case VAR_LIST:
18505 list_unref(varp->vval.v_list);
18506 varp->vval.v_list = NULL;
18507 break;
18508 case VAR_DICT:
18509 dict_unref(varp->vval.v_dict);
18510 varp->vval.v_dict = NULL;
18511 break;
18512 case VAR_NUMBER:
18513 varp->vval.v_number = 0;
18514 break;
18515 #ifdef FEAT_FLOAT
18516 case VAR_FLOAT:
18517 varp->vval.v_float = 0.0;
18518 break;
18519 #endif
18520 case VAR_UNKNOWN:
18521 break;
18522 default:
18523 EMSG2(_(e_intern2), "clear_tv()");
18525 varp->v_lock = 0;
18530 * Set the value of a variable to NULL without freeing items.
18532 static void
18533 init_tv(varp)
18534 typval_T *varp;
18536 if (varp != NULL)
18537 vim_memset(varp, 0, sizeof(typval_T));
18541 * Get the number value of a variable.
18542 * If it is a String variable, uses vim_str2nr().
18543 * For incompatible types, return 0.
18544 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18545 * caller of incompatible types: it sets *denote to TRUE if "denote"
18546 * is not NULL or returns -1 otherwise.
18548 static long
18549 get_tv_number(varp)
18550 typval_T *varp;
18552 int error = FALSE;
18554 return get_tv_number_chk(varp, &error); /* return 0L on error */
18557 long
18558 get_tv_number_chk(varp, denote)
18559 typval_T *varp;
18560 int *denote;
18562 long n = 0L;
18564 switch (varp->v_type)
18566 case VAR_NUMBER:
18567 return (long)(varp->vval.v_number);
18568 #ifdef FEAT_FLOAT
18569 case VAR_FLOAT:
18570 EMSG(_("E805: Using a Float as a Number"));
18571 break;
18572 #endif
18573 case VAR_FUNC:
18574 EMSG(_("E703: Using a Funcref as a Number"));
18575 break;
18576 case VAR_STRING:
18577 if (varp->vval.v_string != NULL)
18578 vim_str2nr(varp->vval.v_string, NULL, NULL,
18579 TRUE, TRUE, &n, NULL);
18580 return n;
18581 case VAR_LIST:
18582 EMSG(_("E745: Using a List as a Number"));
18583 break;
18584 case VAR_DICT:
18585 EMSG(_("E728: Using a Dictionary as a Number"));
18586 break;
18587 default:
18588 EMSG2(_(e_intern2), "get_tv_number()");
18589 break;
18591 if (denote == NULL) /* useful for values that must be unsigned */
18592 n = -1;
18593 else
18594 *denote = TRUE;
18595 return n;
18599 * Get the lnum from the first argument.
18600 * Also accepts ".", "$", etc., but that only works for the current buffer.
18601 * Returns -1 on error.
18603 static linenr_T
18604 get_tv_lnum(argvars)
18605 typval_T *argvars;
18607 typval_T rettv;
18608 linenr_T lnum;
18610 lnum = get_tv_number_chk(&argvars[0], NULL);
18611 if (lnum == 0) /* no valid number, try using line() */
18613 rettv.v_type = VAR_NUMBER;
18614 f_line(argvars, &rettv);
18615 lnum = rettv.vval.v_number;
18616 clear_tv(&rettv);
18618 return lnum;
18622 * Get the lnum from the first argument.
18623 * Also accepts "$", then "buf" is used.
18624 * Returns 0 on error.
18626 static linenr_T
18627 get_tv_lnum_buf(argvars, buf)
18628 typval_T *argvars;
18629 buf_T *buf;
18631 if (argvars[0].v_type == VAR_STRING
18632 && argvars[0].vval.v_string != NULL
18633 && argvars[0].vval.v_string[0] == '$'
18634 && buf != NULL)
18635 return buf->b_ml.ml_line_count;
18636 return get_tv_number_chk(&argvars[0], NULL);
18640 * Get the string value of a variable.
18641 * If it is a Number variable, the number is converted into a string.
18642 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18643 * get_tv_string_buf() uses a given buffer.
18644 * If the String variable has never been set, return an empty string.
18645 * Never returns NULL;
18646 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18647 * NULL on error.
18649 static char_u *
18650 get_tv_string(varp)
18651 typval_T *varp;
18653 static char_u mybuf[NUMBUFLEN];
18655 return get_tv_string_buf(varp, mybuf);
18658 static char_u *
18659 get_tv_string_buf(varp, buf)
18660 typval_T *varp;
18661 char_u *buf;
18663 char_u *res = get_tv_string_buf_chk(varp, buf);
18665 return res != NULL ? res : (char_u *)"";
18668 char_u *
18669 get_tv_string_chk(varp)
18670 typval_T *varp;
18672 static char_u mybuf[NUMBUFLEN];
18674 return get_tv_string_buf_chk(varp, mybuf);
18677 static char_u *
18678 get_tv_string_buf_chk(varp, buf)
18679 typval_T *varp;
18680 char_u *buf;
18682 switch (varp->v_type)
18684 case VAR_NUMBER:
18685 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18686 return buf;
18687 case VAR_FUNC:
18688 EMSG(_("E729: using Funcref as a String"));
18689 break;
18690 case VAR_LIST:
18691 EMSG(_("E730: using List as a String"));
18692 break;
18693 case VAR_DICT:
18694 EMSG(_("E731: using Dictionary as a String"));
18695 break;
18696 #ifdef FEAT_FLOAT
18697 case VAR_FLOAT:
18698 EMSG(_("E806: using Float as a String"));
18699 break;
18700 #endif
18701 case VAR_STRING:
18702 if (varp->vval.v_string != NULL)
18703 return varp->vval.v_string;
18704 return (char_u *)"";
18705 default:
18706 EMSG2(_(e_intern2), "get_tv_string_buf()");
18707 break;
18709 return NULL;
18713 * Find variable "name" in the list of variables.
18714 * Return a pointer to it if found, NULL if not found.
18715 * Careful: "a:0" variables don't have a name.
18716 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18717 * hashtab_T used.
18719 static dictitem_T *
18720 find_var(name, htp)
18721 char_u *name;
18722 hashtab_T **htp;
18724 char_u *varname;
18725 hashtab_T *ht;
18727 ht = find_var_ht(name, &varname);
18728 if (htp != NULL)
18729 *htp = ht;
18730 if (ht == NULL)
18731 return NULL;
18732 return find_var_in_ht(ht, varname, htp != NULL);
18736 * Find variable "varname" in hashtab "ht".
18737 * Returns NULL if not found.
18739 static dictitem_T *
18740 find_var_in_ht(ht, varname, writing)
18741 hashtab_T *ht;
18742 char_u *varname;
18743 int writing;
18745 hashitem_T *hi;
18747 if (*varname == NUL)
18749 /* Must be something like "s:", otherwise "ht" would be NULL. */
18750 switch (varname[-2])
18752 case 's': return &SCRIPT_SV(current_SID).sv_var;
18753 case 'g': return &globvars_var;
18754 case 'v': return &vimvars_var;
18755 case 'b': return &curbuf->b_bufvar;
18756 case 'w': return &curwin->w_winvar;
18757 #ifdef FEAT_WINDOWS
18758 case 't': return &curtab->tp_winvar;
18759 #endif
18760 case 'l': return current_funccal == NULL
18761 ? NULL : &current_funccal->l_vars_var;
18762 case 'a': return current_funccal == NULL
18763 ? NULL : &current_funccal->l_avars_var;
18765 return NULL;
18768 hi = hash_find(ht, varname);
18769 if (HASHITEM_EMPTY(hi))
18771 /* For global variables we may try auto-loading the script. If it
18772 * worked find the variable again. Don't auto-load a script if it was
18773 * loaded already, otherwise it would be loaded every time when
18774 * checking if a function name is a Funcref variable. */
18775 if (ht == &globvarht && !writing
18776 && script_autoload(varname, FALSE) && !aborting())
18777 hi = hash_find(ht, varname);
18778 if (HASHITEM_EMPTY(hi))
18779 return NULL;
18781 return HI2DI(hi);
18785 * Find the hashtab used for a variable name.
18786 * Set "varname" to the start of name without ':'.
18788 static hashtab_T *
18789 find_var_ht(name, varname)
18790 char_u *name;
18791 char_u **varname;
18793 hashitem_T *hi;
18795 if (name[1] != ':')
18797 /* The name must not start with a colon or #. */
18798 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18799 return NULL;
18800 *varname = name;
18802 /* "version" is "v:version" in all scopes */
18803 hi = hash_find(&compat_hashtab, name);
18804 if (!HASHITEM_EMPTY(hi))
18805 return &compat_hashtab;
18807 if (current_funccal == NULL)
18808 return &globvarht; /* global variable */
18809 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18811 *varname = name + 2;
18812 if (*name == 'g') /* global variable */
18813 return &globvarht;
18814 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18816 if (vim_strchr(name + 2, ':') != NULL
18817 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18818 return NULL;
18819 if (*name == 'b') /* buffer variable */
18820 return &curbuf->b_vars.dv_hashtab;
18821 if (*name == 'w') /* window variable */
18822 return &curwin->w_vars.dv_hashtab;
18823 #ifdef FEAT_WINDOWS
18824 if (*name == 't') /* tab page variable */
18825 return &curtab->tp_vars.dv_hashtab;
18826 #endif
18827 if (*name == 'v') /* v: variable */
18828 return &vimvarht;
18829 if (*name == 'a' && current_funccal != NULL) /* function argument */
18830 return &current_funccal->l_avars.dv_hashtab;
18831 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18832 return &current_funccal->l_vars.dv_hashtab;
18833 if (*name == 's' /* script variable */
18834 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18835 return &SCRIPT_VARS(current_SID);
18836 return NULL;
18840 * Get the string value of a (global/local) variable.
18841 * Returns NULL when it doesn't exist.
18843 char_u *
18844 get_var_value(name)
18845 char_u *name;
18847 dictitem_T *v;
18849 v = find_var(name, NULL);
18850 if (v == NULL)
18851 return NULL;
18852 return get_tv_string(&v->di_tv);
18856 * Allocate a new hashtab for a sourced script. It will be used while
18857 * sourcing this script and when executing functions defined in the script.
18859 void
18860 new_script_vars(id)
18861 scid_T id;
18863 int i;
18864 hashtab_T *ht;
18865 scriptvar_T *sv;
18867 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18869 /* Re-allocating ga_data means that an ht_array pointing to
18870 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18871 * at its init value. Also reset "v_dict", it's always the same. */
18872 for (i = 1; i <= ga_scripts.ga_len; ++i)
18874 ht = &SCRIPT_VARS(i);
18875 if (ht->ht_mask == HT_INIT_SIZE - 1)
18876 ht->ht_array = ht->ht_smallarray;
18877 sv = &SCRIPT_SV(i);
18878 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18881 while (ga_scripts.ga_len < id)
18883 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18884 init_var_dict(&sv->sv_dict, &sv->sv_var);
18885 ++ga_scripts.ga_len;
18891 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18892 * point to it.
18894 void
18895 init_var_dict(dict, dict_var)
18896 dict_T *dict;
18897 dictitem_T *dict_var;
18899 hash_init(&dict->dv_hashtab);
18900 dict->dv_refcount = 99999;
18901 dict_var->di_tv.vval.v_dict = dict;
18902 dict_var->di_tv.v_type = VAR_DICT;
18903 dict_var->di_tv.v_lock = VAR_FIXED;
18904 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18905 dict_var->di_key[0] = NUL;
18909 * Clean up a list of internal variables.
18910 * Frees all allocated variables and the value they contain.
18911 * Clears hashtab "ht", does not free it.
18913 void
18914 vars_clear(ht)
18915 hashtab_T *ht;
18917 vars_clear_ext(ht, TRUE);
18921 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18923 static void
18924 vars_clear_ext(ht, free_val)
18925 hashtab_T *ht;
18926 int free_val;
18928 int todo;
18929 hashitem_T *hi;
18930 dictitem_T *v;
18932 hash_lock(ht);
18933 todo = (int)ht->ht_used;
18934 for (hi = ht->ht_array; todo > 0; ++hi)
18936 if (!HASHITEM_EMPTY(hi))
18938 --todo;
18940 /* Free the variable. Don't remove it from the hashtab,
18941 * ht_array might change then. hash_clear() takes care of it
18942 * later. */
18943 v = HI2DI(hi);
18944 if (free_val)
18945 clear_tv(&v->di_tv);
18946 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18947 vim_free(v);
18950 hash_clear(ht);
18951 ht->ht_used = 0;
18955 * Delete a variable from hashtab "ht" at item "hi".
18956 * Clear the variable value and free the dictitem.
18958 static void
18959 delete_var(ht, hi)
18960 hashtab_T *ht;
18961 hashitem_T *hi;
18963 dictitem_T *di = HI2DI(hi);
18965 hash_remove(ht, hi);
18966 clear_tv(&di->di_tv);
18967 vim_free(di);
18971 * List the value of one internal variable.
18973 static void
18974 list_one_var(v, prefix, first)
18975 dictitem_T *v;
18976 char_u *prefix;
18977 int *first;
18979 char_u *tofree;
18980 char_u *s;
18981 char_u numbuf[NUMBUFLEN];
18983 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
18984 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
18985 s == NULL ? (char_u *)"" : s, first);
18986 vim_free(tofree);
18989 static void
18990 list_one_var_a(prefix, name, type, string, first)
18991 char_u *prefix;
18992 char_u *name;
18993 int type;
18994 char_u *string;
18995 int *first; /* when TRUE clear rest of screen and set to FALSE */
18997 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
18998 msg_start();
18999 msg_puts(prefix);
19000 if (name != NULL) /* "a:" vars don't have a name stored */
19001 msg_puts(name);
19002 msg_putchar(' ');
19003 msg_advance(22);
19004 if (type == VAR_NUMBER)
19005 msg_putchar('#');
19006 else if (type == VAR_FUNC)
19007 msg_putchar('*');
19008 else if (type == VAR_LIST)
19010 msg_putchar('[');
19011 if (*string == '[')
19012 ++string;
19014 else if (type == VAR_DICT)
19016 msg_putchar('{');
19017 if (*string == '{')
19018 ++string;
19020 else
19021 msg_putchar(' ');
19023 msg_outtrans(string);
19025 if (type == VAR_FUNC)
19026 msg_puts((char_u *)"()");
19027 if (*first)
19029 msg_clr_eos();
19030 *first = FALSE;
19035 * Set variable "name" to value in "tv".
19036 * If the variable already exists, the value is updated.
19037 * Otherwise the variable is created.
19039 static void
19040 set_var(name, tv, copy)
19041 char_u *name;
19042 typval_T *tv;
19043 int copy; /* make copy of value in "tv" */
19045 dictitem_T *v;
19046 char_u *varname;
19047 hashtab_T *ht;
19048 char_u *p;
19050 if (tv->v_type == VAR_FUNC)
19052 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19053 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19054 ? name[2] : name[0]))
19056 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19057 return;
19059 if (function_exists(name))
19061 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19062 name);
19063 return;
19067 ht = find_var_ht(name, &varname);
19068 if (ht == NULL || *varname == NUL)
19070 EMSG2(_(e_illvar), name);
19071 return;
19074 v = find_var_in_ht(ht, varname, TRUE);
19075 if (v != NULL)
19077 /* existing variable, need to clear the value */
19078 if (var_check_ro(v->di_flags, name)
19079 || tv_check_lock(v->di_tv.v_lock, name))
19080 return;
19081 if (v->di_tv.v_type != tv->v_type
19082 && !((v->di_tv.v_type == VAR_STRING
19083 || v->di_tv.v_type == VAR_NUMBER)
19084 && (tv->v_type == VAR_STRING
19085 || tv->v_type == VAR_NUMBER))
19086 #ifdef FEAT_FLOAT
19087 && !((v->di_tv.v_type == VAR_NUMBER
19088 || v->di_tv.v_type == VAR_FLOAT)
19089 && (tv->v_type == VAR_NUMBER
19090 || tv->v_type == VAR_FLOAT))
19091 #endif
19094 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19095 return;
19099 * Handle setting internal v: variables separately: we don't change
19100 * the type.
19102 if (ht == &vimvarht)
19104 if (v->di_tv.v_type == VAR_STRING)
19106 vim_free(v->di_tv.vval.v_string);
19107 if (copy || tv->v_type != VAR_STRING)
19108 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19109 else
19111 /* Take over the string to avoid an extra alloc/free. */
19112 v->di_tv.vval.v_string = tv->vval.v_string;
19113 tv->vval.v_string = NULL;
19116 else if (v->di_tv.v_type != VAR_NUMBER)
19117 EMSG2(_(e_intern2), "set_var()");
19118 else
19120 v->di_tv.vval.v_number = get_tv_number(tv);
19121 if (STRCMP(varname, "searchforward") == 0)
19122 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19124 return;
19127 clear_tv(&v->di_tv);
19129 else /* add a new variable */
19131 /* Can't add "v:" variable. */
19132 if (ht == &vimvarht)
19134 EMSG2(_(e_illvar), name);
19135 return;
19138 /* Make sure the variable name is valid. */
19139 for (p = varname; *p != NUL; ++p)
19140 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19141 && *p != AUTOLOAD_CHAR)
19143 EMSG2(_(e_illvar), varname);
19144 return;
19147 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19148 + STRLEN(varname)));
19149 if (v == NULL)
19150 return;
19151 STRCPY(v->di_key, varname);
19152 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19154 vim_free(v);
19155 return;
19157 v->di_flags = 0;
19160 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19161 copy_tv(tv, &v->di_tv);
19162 else
19164 v->di_tv = *tv;
19165 v->di_tv.v_lock = 0;
19166 init_tv(tv);
19171 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19172 * Also give an error message.
19174 static int
19175 var_check_ro(flags, name)
19176 int flags;
19177 char_u *name;
19179 if (flags & DI_FLAGS_RO)
19181 EMSG2(_(e_readonlyvar), name);
19182 return TRUE;
19184 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19186 EMSG2(_(e_readonlysbx), name);
19187 return TRUE;
19189 return FALSE;
19193 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19194 * Also give an error message.
19196 static int
19197 var_check_fixed(flags, name)
19198 int flags;
19199 char_u *name;
19201 if (flags & DI_FLAGS_FIX)
19203 EMSG2(_("E795: Cannot delete variable %s"), name);
19204 return TRUE;
19206 return FALSE;
19210 * Return TRUE if typeval "tv" is set to be locked (immutable).
19211 * Also give an error message, using "name".
19213 static int
19214 tv_check_lock(lock, name)
19215 int lock;
19216 char_u *name;
19218 if (lock & VAR_LOCKED)
19220 EMSG2(_("E741: Value is locked: %s"),
19221 name == NULL ? (char_u *)_("Unknown") : name);
19222 return TRUE;
19224 if (lock & VAR_FIXED)
19226 EMSG2(_("E742: Cannot change value of %s"),
19227 name == NULL ? (char_u *)_("Unknown") : name);
19228 return TRUE;
19230 return FALSE;
19234 * Copy the values from typval_T "from" to typval_T "to".
19235 * When needed allocates string or increases reference count.
19236 * Does not make a copy of a list or dict but copies the reference!
19238 static void
19239 copy_tv(from, to)
19240 typval_T *from;
19241 typval_T *to;
19243 to->v_type = from->v_type;
19244 to->v_lock = 0;
19245 switch (from->v_type)
19247 case VAR_NUMBER:
19248 to->vval.v_number = from->vval.v_number;
19249 break;
19250 #ifdef FEAT_FLOAT
19251 case VAR_FLOAT:
19252 to->vval.v_float = from->vval.v_float;
19253 break;
19254 #endif
19255 case VAR_STRING:
19256 case VAR_FUNC:
19257 if (from->vval.v_string == NULL)
19258 to->vval.v_string = NULL;
19259 else
19261 to->vval.v_string = vim_strsave(from->vval.v_string);
19262 if (from->v_type == VAR_FUNC)
19263 func_ref(to->vval.v_string);
19265 break;
19266 case VAR_LIST:
19267 if (from->vval.v_list == NULL)
19268 to->vval.v_list = NULL;
19269 else
19271 to->vval.v_list = from->vval.v_list;
19272 ++to->vval.v_list->lv_refcount;
19274 break;
19275 case VAR_DICT:
19276 if (from->vval.v_dict == NULL)
19277 to->vval.v_dict = NULL;
19278 else
19280 to->vval.v_dict = from->vval.v_dict;
19281 ++to->vval.v_dict->dv_refcount;
19283 break;
19284 default:
19285 EMSG2(_(e_intern2), "copy_tv()");
19286 break;
19291 * Make a copy of an item.
19292 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19293 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19294 * reference to an already copied list/dict can be used.
19295 * Returns FAIL or OK.
19297 static int
19298 item_copy(from, to, deep, copyID)
19299 typval_T *from;
19300 typval_T *to;
19301 int deep;
19302 int copyID;
19304 static int recurse = 0;
19305 int ret = OK;
19307 if (recurse >= DICT_MAXNEST)
19309 EMSG(_("E698: variable nested too deep for making a copy"));
19310 return FAIL;
19312 ++recurse;
19314 switch (from->v_type)
19316 case VAR_NUMBER:
19317 #ifdef FEAT_FLOAT
19318 case VAR_FLOAT:
19319 #endif
19320 case VAR_STRING:
19321 case VAR_FUNC:
19322 copy_tv(from, to);
19323 break;
19324 case VAR_LIST:
19325 to->v_type = VAR_LIST;
19326 to->v_lock = 0;
19327 if (from->vval.v_list == NULL)
19328 to->vval.v_list = NULL;
19329 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19331 /* use the copy made earlier */
19332 to->vval.v_list = from->vval.v_list->lv_copylist;
19333 ++to->vval.v_list->lv_refcount;
19335 else
19336 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19337 if (to->vval.v_list == NULL)
19338 ret = FAIL;
19339 break;
19340 case VAR_DICT:
19341 to->v_type = VAR_DICT;
19342 to->v_lock = 0;
19343 if (from->vval.v_dict == NULL)
19344 to->vval.v_dict = NULL;
19345 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19347 /* use the copy made earlier */
19348 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19349 ++to->vval.v_dict->dv_refcount;
19351 else
19352 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19353 if (to->vval.v_dict == NULL)
19354 ret = FAIL;
19355 break;
19356 default:
19357 EMSG2(_(e_intern2), "item_copy()");
19358 ret = FAIL;
19360 --recurse;
19361 return ret;
19365 * ":echo expr1 ..." print each argument separated with a space, add a
19366 * newline at the end.
19367 * ":echon expr1 ..." print each argument plain.
19369 void
19370 ex_echo(eap)
19371 exarg_T *eap;
19373 char_u *arg = eap->arg;
19374 typval_T rettv;
19375 char_u *tofree;
19376 char_u *p;
19377 int needclr = TRUE;
19378 int atstart = TRUE;
19379 char_u numbuf[NUMBUFLEN];
19381 if (eap->skip)
19382 ++emsg_skip;
19383 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19385 /* If eval1() causes an error message the text from the command may
19386 * still need to be cleared. E.g., "echo 22,44". */
19387 need_clr_eos = needclr;
19389 p = arg;
19390 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19393 * Report the invalid expression unless the expression evaluation
19394 * has been cancelled due to an aborting error, an interrupt, or an
19395 * exception.
19397 if (!aborting())
19398 EMSG2(_(e_invexpr2), p);
19399 need_clr_eos = FALSE;
19400 break;
19402 need_clr_eos = FALSE;
19404 if (!eap->skip)
19406 if (atstart)
19408 atstart = FALSE;
19409 /* Call msg_start() after eval1(), evaluating the expression
19410 * may cause a message to appear. */
19411 if (eap->cmdidx == CMD_echo)
19412 msg_start();
19414 else if (eap->cmdidx == CMD_echo)
19415 msg_puts_attr((char_u *)" ", echo_attr);
19416 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19417 if (p != NULL)
19418 for ( ; *p != NUL && !got_int; ++p)
19420 if (*p == '\n' || *p == '\r' || *p == TAB)
19422 if (*p != TAB && needclr)
19424 /* remove any text still there from the command */
19425 msg_clr_eos();
19426 needclr = FALSE;
19428 msg_putchar_attr(*p, echo_attr);
19430 else
19432 #ifdef FEAT_MBYTE
19433 if (has_mbyte)
19435 int i = (*mb_ptr2len)(p);
19437 (void)msg_outtrans_len_attr(p, i, echo_attr);
19438 p += i - 1;
19440 else
19441 #endif
19442 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19445 vim_free(tofree);
19447 clear_tv(&rettv);
19448 arg = skipwhite(arg);
19450 eap->nextcmd = check_nextcmd(arg);
19452 if (eap->skip)
19453 --emsg_skip;
19454 else
19456 /* remove text that may still be there from the command */
19457 if (needclr)
19458 msg_clr_eos();
19459 if (eap->cmdidx == CMD_echo)
19460 msg_end();
19465 * ":echohl {name}".
19467 void
19468 ex_echohl(eap)
19469 exarg_T *eap;
19471 int id;
19473 id = syn_name2id(eap->arg);
19474 if (id == 0)
19475 echo_attr = 0;
19476 else
19477 echo_attr = syn_id2attr(id);
19481 * ":execute expr1 ..." execute the result of an expression.
19482 * ":echomsg expr1 ..." Print a message
19483 * ":echoerr expr1 ..." Print an error
19484 * Each gets spaces around each argument and a newline at the end for
19485 * echo commands
19487 void
19488 ex_execute(eap)
19489 exarg_T *eap;
19491 char_u *arg = eap->arg;
19492 typval_T rettv;
19493 int ret = OK;
19494 char_u *p;
19495 garray_T ga;
19496 int len;
19497 int save_did_emsg;
19499 ga_init2(&ga, 1, 80);
19501 if (eap->skip)
19502 ++emsg_skip;
19503 while (*arg != NUL && *arg != '|' && *arg != '\n')
19505 p = arg;
19506 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19509 * Report the invalid expression unless the expression evaluation
19510 * has been cancelled due to an aborting error, an interrupt, or an
19511 * exception.
19513 if (!aborting())
19514 EMSG2(_(e_invexpr2), p);
19515 ret = FAIL;
19516 break;
19519 if (!eap->skip)
19521 p = get_tv_string(&rettv);
19522 len = (int)STRLEN(p);
19523 if (ga_grow(&ga, len + 2) == FAIL)
19525 clear_tv(&rettv);
19526 ret = FAIL;
19527 break;
19529 if (ga.ga_len)
19530 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19531 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19532 ga.ga_len += len;
19535 clear_tv(&rettv);
19536 arg = skipwhite(arg);
19539 if (ret != FAIL && ga.ga_data != NULL)
19541 if (eap->cmdidx == CMD_echomsg)
19543 MSG_ATTR(ga.ga_data, echo_attr);
19544 out_flush();
19546 else if (eap->cmdidx == CMD_echoerr)
19548 /* We don't want to abort following commands, restore did_emsg. */
19549 save_did_emsg = did_emsg;
19550 EMSG((char_u *)ga.ga_data);
19551 if (!force_abort)
19552 did_emsg = save_did_emsg;
19554 else if (eap->cmdidx == CMD_execute)
19555 do_cmdline((char_u *)ga.ga_data,
19556 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19559 ga_clear(&ga);
19561 if (eap->skip)
19562 --emsg_skip;
19564 eap->nextcmd = check_nextcmd(arg);
19568 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19569 * "arg" points to the "&" or '+' when called, to "option" when returning.
19570 * Returns NULL when no option name found. Otherwise pointer to the char
19571 * after the option name.
19573 static char_u *
19574 find_option_end(arg, opt_flags)
19575 char_u **arg;
19576 int *opt_flags;
19578 char_u *p = *arg;
19580 ++p;
19581 if (*p == 'g' && p[1] == ':')
19583 *opt_flags = OPT_GLOBAL;
19584 p += 2;
19586 else if (*p == 'l' && p[1] == ':')
19588 *opt_flags = OPT_LOCAL;
19589 p += 2;
19591 else
19592 *opt_flags = 0;
19594 if (!ASCII_ISALPHA(*p))
19595 return NULL;
19596 *arg = p;
19598 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19599 p += 4; /* termcap option */
19600 else
19601 while (ASCII_ISALPHA(*p))
19602 ++p;
19603 return p;
19607 * ":function"
19609 void
19610 ex_function(eap)
19611 exarg_T *eap;
19613 char_u *theline;
19614 int j;
19615 int c;
19616 int saved_did_emsg;
19617 char_u *name = NULL;
19618 char_u *p;
19619 char_u *arg;
19620 char_u *line_arg = NULL;
19621 garray_T newargs;
19622 garray_T newlines;
19623 int varargs = FALSE;
19624 int mustend = FALSE;
19625 int flags = 0;
19626 ufunc_T *fp;
19627 int indent;
19628 int nesting;
19629 char_u *skip_until = NULL;
19630 dictitem_T *v;
19631 funcdict_T fudi;
19632 static int func_nr = 0; /* number for nameless function */
19633 int paren;
19634 hashtab_T *ht;
19635 int todo;
19636 hashitem_T *hi;
19637 int sourcing_lnum_off;
19640 * ":function" without argument: list functions.
19642 if (ends_excmd(*eap->arg))
19644 if (!eap->skip)
19646 todo = (int)func_hashtab.ht_used;
19647 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19649 if (!HASHITEM_EMPTY(hi))
19651 --todo;
19652 fp = HI2UF(hi);
19653 if (!isdigit(*fp->uf_name))
19654 list_func_head(fp, FALSE);
19658 eap->nextcmd = check_nextcmd(eap->arg);
19659 return;
19663 * ":function /pat": list functions matching pattern.
19665 if (*eap->arg == '/')
19667 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19668 if (!eap->skip)
19670 regmatch_T regmatch;
19672 c = *p;
19673 *p = NUL;
19674 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19675 *p = c;
19676 if (regmatch.regprog != NULL)
19678 regmatch.rm_ic = p_ic;
19680 todo = (int)func_hashtab.ht_used;
19681 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19683 if (!HASHITEM_EMPTY(hi))
19685 --todo;
19686 fp = HI2UF(hi);
19687 if (!isdigit(*fp->uf_name)
19688 && vim_regexec(&regmatch, fp->uf_name, 0))
19689 list_func_head(fp, FALSE);
19694 if (*p == '/')
19695 ++p;
19696 eap->nextcmd = check_nextcmd(p);
19697 return;
19701 * Get the function name. There are these situations:
19702 * func normal function name
19703 * "name" == func, "fudi.fd_dict" == NULL
19704 * dict.func new dictionary entry
19705 * "name" == NULL, "fudi.fd_dict" set,
19706 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19707 * dict.func existing dict entry with a Funcref
19708 * "name" == func, "fudi.fd_dict" set,
19709 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19710 * dict.func existing dict entry that's not a Funcref
19711 * "name" == NULL, "fudi.fd_dict" set,
19712 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19714 p = eap->arg;
19715 name = trans_function_name(&p, eap->skip, 0, &fudi);
19716 paren = (vim_strchr(p, '(') != NULL);
19717 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19720 * Return on an invalid expression in braces, unless the expression
19721 * evaluation has been cancelled due to an aborting error, an
19722 * interrupt, or an exception.
19724 if (!aborting())
19726 if (!eap->skip && fudi.fd_newkey != NULL)
19727 EMSG2(_(e_dictkey), fudi.fd_newkey);
19728 vim_free(fudi.fd_newkey);
19729 return;
19731 else
19732 eap->skip = TRUE;
19735 /* An error in a function call during evaluation of an expression in magic
19736 * braces should not cause the function not to be defined. */
19737 saved_did_emsg = did_emsg;
19738 did_emsg = FALSE;
19741 * ":function func" with only function name: list function.
19743 if (!paren)
19745 if (!ends_excmd(*skipwhite(p)))
19747 EMSG(_(e_trailing));
19748 goto ret_free;
19750 eap->nextcmd = check_nextcmd(p);
19751 if (eap->nextcmd != NULL)
19752 *p = NUL;
19753 if (!eap->skip && !got_int)
19755 fp = find_func(name);
19756 if (fp != NULL)
19758 list_func_head(fp, TRUE);
19759 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19761 if (FUNCLINE(fp, j) == NULL)
19762 continue;
19763 msg_putchar('\n');
19764 msg_outnum((long)(j + 1));
19765 if (j < 9)
19766 msg_putchar(' ');
19767 if (j < 99)
19768 msg_putchar(' ');
19769 msg_prt_line(FUNCLINE(fp, j), FALSE);
19770 out_flush(); /* show a line at a time */
19771 ui_breakcheck();
19773 if (!got_int)
19775 msg_putchar('\n');
19776 msg_puts((char_u *)" endfunction");
19779 else
19780 emsg_funcname("E123: Undefined function: %s", name);
19782 goto ret_free;
19786 * ":function name(arg1, arg2)" Define function.
19788 p = skipwhite(p);
19789 if (*p != '(')
19791 if (!eap->skip)
19793 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19794 goto ret_free;
19796 /* attempt to continue by skipping some text */
19797 if (vim_strchr(p, '(') != NULL)
19798 p = vim_strchr(p, '(');
19800 p = skipwhite(p + 1);
19802 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19803 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19805 if (!eap->skip)
19807 /* Check the name of the function. Unless it's a dictionary function
19808 * (that we are overwriting). */
19809 if (name != NULL)
19810 arg = name;
19811 else
19812 arg = fudi.fd_newkey;
19813 if (arg != NULL && (fudi.fd_di == NULL
19814 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19816 if (*arg == K_SPECIAL)
19817 j = 3;
19818 else
19819 j = 0;
19820 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19821 : eval_isnamec(arg[j])))
19822 ++j;
19823 if (arg[j] != NUL)
19824 emsg_funcname(_(e_invarg2), arg);
19829 * Isolate the arguments: "arg1, arg2, ...)"
19831 while (*p != ')')
19833 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19835 varargs = TRUE;
19836 p += 3;
19837 mustend = TRUE;
19839 else
19841 arg = p;
19842 while (ASCII_ISALNUM(*p) || *p == '_')
19843 ++p;
19844 if (arg == p || isdigit(*arg)
19845 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19846 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19848 if (!eap->skip)
19849 EMSG2(_("E125: Illegal argument: %s"), arg);
19850 break;
19852 if (ga_grow(&newargs, 1) == FAIL)
19853 goto erret;
19854 c = *p;
19855 *p = NUL;
19856 arg = vim_strsave(arg);
19857 if (arg == NULL)
19858 goto erret;
19859 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19860 *p = c;
19861 newargs.ga_len++;
19862 if (*p == ',')
19863 ++p;
19864 else
19865 mustend = TRUE;
19867 p = skipwhite(p);
19868 if (mustend && *p != ')')
19870 if (!eap->skip)
19871 EMSG2(_(e_invarg2), eap->arg);
19872 break;
19875 ++p; /* skip the ')' */
19877 /* find extra arguments "range", "dict" and "abort" */
19878 for (;;)
19880 p = skipwhite(p);
19881 if (STRNCMP(p, "range", 5) == 0)
19883 flags |= FC_RANGE;
19884 p += 5;
19886 else if (STRNCMP(p, "dict", 4) == 0)
19888 flags |= FC_DICT;
19889 p += 4;
19891 else if (STRNCMP(p, "abort", 5) == 0)
19893 flags |= FC_ABORT;
19894 p += 5;
19896 else
19897 break;
19900 /* When there is a line break use what follows for the function body.
19901 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19902 if (*p == '\n')
19903 line_arg = p + 1;
19904 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19905 EMSG(_(e_trailing));
19908 * Read the body of the function, until ":endfunction" is found.
19910 if (KeyTyped)
19912 /* Check if the function already exists, don't let the user type the
19913 * whole function before telling him it doesn't work! For a script we
19914 * need to skip the body to be able to find what follows. */
19915 if (!eap->skip && !eap->forceit)
19917 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19918 EMSG(_(e_funcdict));
19919 else if (name != NULL && find_func(name) != NULL)
19920 emsg_funcname(e_funcexts, name);
19923 if (!eap->skip && did_emsg)
19924 goto erret;
19926 msg_putchar('\n'); /* don't overwrite the function name */
19927 cmdline_row = msg_row;
19930 indent = 2;
19931 nesting = 0;
19932 for (;;)
19934 msg_scroll = TRUE;
19935 need_wait_return = FALSE;
19936 sourcing_lnum_off = sourcing_lnum;
19938 if (line_arg != NULL)
19940 /* Use eap->arg, split up in parts by line breaks. */
19941 theline = line_arg;
19942 p = vim_strchr(theline, '\n');
19943 if (p == NULL)
19944 line_arg += STRLEN(line_arg);
19945 else
19947 *p = NUL;
19948 line_arg = p + 1;
19951 else if (eap->getline == NULL)
19952 theline = getcmdline(':', 0L, indent);
19953 else
19954 theline = eap->getline(':', eap->cookie, indent);
19955 if (KeyTyped)
19956 lines_left = Rows - 1;
19957 if (theline == NULL)
19959 EMSG(_("E126: Missing :endfunction"));
19960 goto erret;
19963 /* Detect line continuation: sourcing_lnum increased more than one. */
19964 if (sourcing_lnum > sourcing_lnum_off + 1)
19965 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
19966 else
19967 sourcing_lnum_off = 0;
19969 if (skip_until != NULL)
19971 /* between ":append" and "." and between ":python <<EOF" and "EOF"
19972 * don't check for ":endfunc". */
19973 if (STRCMP(theline, skip_until) == 0)
19975 vim_free(skip_until);
19976 skip_until = NULL;
19979 else
19981 /* skip ':' and blanks*/
19982 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
19985 /* Check for "endfunction". */
19986 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
19988 if (line_arg == NULL)
19989 vim_free(theline);
19990 break;
19993 /* Increase indent inside "if", "while", "for" and "try", decrease
19994 * at "end". */
19995 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
19996 indent -= 2;
19997 else if (STRNCMP(p, "if", 2) == 0
19998 || STRNCMP(p, "wh", 2) == 0
19999 || STRNCMP(p, "for", 3) == 0
20000 || STRNCMP(p, "try", 3) == 0)
20001 indent += 2;
20003 /* Check for defining a function inside this function. */
20004 if (checkforcmd(&p, "function", 2))
20006 if (*p == '!')
20007 p = skipwhite(p + 1);
20008 p += eval_fname_script(p);
20009 if (ASCII_ISALPHA(*p))
20011 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20012 if (*skipwhite(p) == '(')
20014 ++nesting;
20015 indent += 2;
20020 /* Check for ":append" or ":insert". */
20021 p = skip_range(p, NULL);
20022 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20023 || (p[0] == 'i'
20024 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20025 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20026 skip_until = vim_strsave((char_u *)".");
20028 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20029 arg = skipwhite(skiptowhite(p));
20030 if (arg[0] == '<' && arg[1] =='<'
20031 && ((p[0] == 'p' && p[1] == 'y'
20032 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20033 || (p[0] == 'p' && p[1] == 'e'
20034 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20035 || (p[0] == 't' && p[1] == 'c'
20036 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20037 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20038 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20039 || (p[0] == 'm' && p[1] == 'z'
20040 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20043 /* ":python <<" continues until a dot, like ":append" */
20044 p = skipwhite(arg + 2);
20045 if (*p == NUL)
20046 skip_until = vim_strsave((char_u *)".");
20047 else
20048 skip_until = vim_strsave(p);
20052 /* Add the line to the function. */
20053 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20055 if (line_arg == NULL)
20056 vim_free(theline);
20057 goto erret;
20060 /* Copy the line to newly allocated memory. get_one_sourceline()
20061 * allocates 250 bytes per line, this saves 80% on average. The cost
20062 * is an extra alloc/free. */
20063 p = vim_strsave(theline);
20064 if (p != NULL)
20066 if (line_arg == NULL)
20067 vim_free(theline);
20068 theline = p;
20071 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20073 /* Add NULL lines for continuation lines, so that the line count is
20074 * equal to the index in the growarray. */
20075 while (sourcing_lnum_off-- > 0)
20076 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20078 /* Check for end of eap->arg. */
20079 if (line_arg != NULL && *line_arg == NUL)
20080 line_arg = NULL;
20083 /* Don't define the function when skipping commands or when an error was
20084 * detected. */
20085 if (eap->skip || did_emsg)
20086 goto erret;
20089 * If there are no errors, add the function
20091 if (fudi.fd_dict == NULL)
20093 v = find_var(name, &ht);
20094 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20096 emsg_funcname("E707: Function name conflicts with variable: %s",
20097 name);
20098 goto erret;
20101 fp = find_func(name);
20102 if (fp != NULL)
20104 if (!eap->forceit)
20106 emsg_funcname(e_funcexts, name);
20107 goto erret;
20109 if (fp->uf_calls > 0)
20111 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20112 name);
20113 goto erret;
20115 /* redefine existing function */
20116 ga_clear_strings(&(fp->uf_args));
20117 ga_clear_strings(&(fp->uf_lines));
20118 vim_free(name);
20119 name = NULL;
20122 else
20124 char numbuf[20];
20126 fp = NULL;
20127 if (fudi.fd_newkey == NULL && !eap->forceit)
20129 EMSG(_(e_funcdict));
20130 goto erret;
20132 if (fudi.fd_di == NULL)
20134 /* Can't add a function to a locked dictionary */
20135 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20136 goto erret;
20138 /* Can't change an existing function if it is locked */
20139 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20140 goto erret;
20142 /* Give the function a sequential number. Can only be used with a
20143 * Funcref! */
20144 vim_free(name);
20145 sprintf(numbuf, "%d", ++func_nr);
20146 name = vim_strsave((char_u *)numbuf);
20147 if (name == NULL)
20148 goto erret;
20151 if (fp == NULL)
20153 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20155 int slen, plen;
20156 char_u *scriptname;
20158 /* Check that the autoload name matches the script name. */
20159 j = FAIL;
20160 if (sourcing_name != NULL)
20162 scriptname = autoload_name(name);
20163 if (scriptname != NULL)
20165 p = vim_strchr(scriptname, '/');
20166 plen = (int)STRLEN(p);
20167 slen = (int)STRLEN(sourcing_name);
20168 if (slen > plen && fnamecmp(p,
20169 sourcing_name + slen - plen) == 0)
20170 j = OK;
20171 vim_free(scriptname);
20174 if (j == FAIL)
20176 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20177 goto erret;
20181 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20182 if (fp == NULL)
20183 goto erret;
20185 if (fudi.fd_dict != NULL)
20187 if (fudi.fd_di == NULL)
20189 /* add new dict entry */
20190 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20191 if (fudi.fd_di == NULL)
20193 vim_free(fp);
20194 goto erret;
20196 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20198 vim_free(fudi.fd_di);
20199 vim_free(fp);
20200 goto erret;
20203 else
20204 /* overwrite existing dict entry */
20205 clear_tv(&fudi.fd_di->di_tv);
20206 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20207 fudi.fd_di->di_tv.v_lock = 0;
20208 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20209 fp->uf_refcount = 1;
20211 /* behave like "dict" was used */
20212 flags |= FC_DICT;
20215 /* insert the new function in the function list */
20216 STRCPY(fp->uf_name, name);
20217 hash_add(&func_hashtab, UF2HIKEY(fp));
20219 fp->uf_args = newargs;
20220 fp->uf_lines = newlines;
20221 #ifdef FEAT_PROFILE
20222 fp->uf_tml_count = NULL;
20223 fp->uf_tml_total = NULL;
20224 fp->uf_tml_self = NULL;
20225 fp->uf_profiling = FALSE;
20226 if (prof_def_func())
20227 func_do_profile(fp);
20228 #endif
20229 fp->uf_varargs = varargs;
20230 fp->uf_flags = flags;
20231 fp->uf_calls = 0;
20232 fp->uf_script_ID = current_SID;
20233 goto ret_free;
20235 erret:
20236 ga_clear_strings(&newargs);
20237 ga_clear_strings(&newlines);
20238 ret_free:
20239 vim_free(skip_until);
20240 vim_free(fudi.fd_newkey);
20241 vim_free(name);
20242 did_emsg |= saved_did_emsg;
20246 * Get a function name, translating "<SID>" and "<SNR>".
20247 * Also handles a Funcref in a List or Dictionary.
20248 * Returns the function name in allocated memory, or NULL for failure.
20249 * flags:
20250 * TFN_INT: internal function name OK
20251 * TFN_QUIET: be quiet
20252 * Advances "pp" to just after the function name (if no error).
20254 static char_u *
20255 trans_function_name(pp, skip, flags, fdp)
20256 char_u **pp;
20257 int skip; /* only find the end, don't evaluate */
20258 int flags;
20259 funcdict_T *fdp; /* return: info about dictionary used */
20261 char_u *name = NULL;
20262 char_u *start;
20263 char_u *end;
20264 int lead;
20265 char_u sid_buf[20];
20266 int len;
20267 lval_T lv;
20269 if (fdp != NULL)
20270 vim_memset(fdp, 0, sizeof(funcdict_T));
20271 start = *pp;
20273 /* Check for hard coded <SNR>: already translated function ID (from a user
20274 * command). */
20275 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20276 && (*pp)[2] == (int)KE_SNR)
20278 *pp += 3;
20279 len = get_id_len(pp) + 3;
20280 return vim_strnsave(start, len);
20283 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20284 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20285 lead = eval_fname_script(start);
20286 if (lead > 2)
20287 start += lead;
20289 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20290 lead > 2 ? 0 : FNE_CHECK_START);
20291 if (end == start)
20293 if (!skip)
20294 EMSG(_("E129: Function name required"));
20295 goto theend;
20297 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20300 * Report an invalid expression in braces, unless the expression
20301 * evaluation has been cancelled due to an aborting error, an
20302 * interrupt, or an exception.
20304 if (!aborting())
20306 if (end != NULL)
20307 EMSG2(_(e_invarg2), start);
20309 else
20310 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20311 goto theend;
20314 if (lv.ll_tv != NULL)
20316 if (fdp != NULL)
20318 fdp->fd_dict = lv.ll_dict;
20319 fdp->fd_newkey = lv.ll_newkey;
20320 lv.ll_newkey = NULL;
20321 fdp->fd_di = lv.ll_di;
20323 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20325 name = vim_strsave(lv.ll_tv->vval.v_string);
20326 *pp = end;
20328 else
20330 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20331 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20332 EMSG(_(e_funcref));
20333 else
20334 *pp = end;
20335 name = NULL;
20337 goto theend;
20340 if (lv.ll_name == NULL)
20342 /* Error found, but continue after the function name. */
20343 *pp = end;
20344 goto theend;
20347 /* Check if the name is a Funcref. If so, use the value. */
20348 if (lv.ll_exp_name != NULL)
20350 len = (int)STRLEN(lv.ll_exp_name);
20351 name = deref_func_name(lv.ll_exp_name, &len);
20352 if (name == lv.ll_exp_name)
20353 name = NULL;
20355 else
20357 len = (int)(end - *pp);
20358 name = deref_func_name(*pp, &len);
20359 if (name == *pp)
20360 name = NULL;
20362 if (name != NULL)
20364 name = vim_strsave(name);
20365 *pp = end;
20366 goto theend;
20369 if (lv.ll_exp_name != NULL)
20371 len = (int)STRLEN(lv.ll_exp_name);
20372 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20373 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20375 /* When there was "s:" already or the name expanded to get a
20376 * leading "s:" then remove it. */
20377 lv.ll_name += 2;
20378 len -= 2;
20379 lead = 2;
20382 else
20384 if (lead == 2) /* skip over "s:" */
20385 lv.ll_name += 2;
20386 len = (int)(end - lv.ll_name);
20390 * Copy the function name to allocated memory.
20391 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20392 * Accept <SNR>123_name() outside a script.
20394 if (skip)
20395 lead = 0; /* do nothing */
20396 else if (lead > 0)
20398 lead = 3;
20399 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20400 || eval_fname_sid(*pp))
20402 /* It's "s:" or "<SID>" */
20403 if (current_SID <= 0)
20405 EMSG(_(e_usingsid));
20406 goto theend;
20408 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20409 lead += (int)STRLEN(sid_buf);
20412 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20414 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20415 goto theend;
20417 name = alloc((unsigned)(len + lead + 1));
20418 if (name != NULL)
20420 if (lead > 0)
20422 name[0] = K_SPECIAL;
20423 name[1] = KS_EXTRA;
20424 name[2] = (int)KE_SNR;
20425 if (lead > 3) /* If it's "<SID>" */
20426 STRCPY(name + 3, sid_buf);
20428 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20429 name[len + lead] = NUL;
20431 *pp = end;
20433 theend:
20434 clear_lval(&lv);
20435 return name;
20439 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20440 * Return 2 if "p" starts with "s:".
20441 * Return 0 otherwise.
20443 static int
20444 eval_fname_script(p)
20445 char_u *p;
20447 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20448 || STRNICMP(p + 1, "SNR>", 4) == 0))
20449 return 5;
20450 if (p[0] == 's' && p[1] == ':')
20451 return 2;
20452 return 0;
20456 * Return TRUE if "p" starts with "<SID>" or "s:".
20457 * Only works if eval_fname_script() returned non-zero for "p"!
20459 static int
20460 eval_fname_sid(p)
20461 char_u *p;
20463 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20467 * List the head of the function: "name(arg1, arg2)".
20469 static void
20470 list_func_head(fp, indent)
20471 ufunc_T *fp;
20472 int indent;
20474 int j;
20476 msg_start();
20477 if (indent)
20478 MSG_PUTS(" ");
20479 MSG_PUTS("function ");
20480 if (fp->uf_name[0] == K_SPECIAL)
20482 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20483 msg_puts(fp->uf_name + 3);
20485 else
20486 msg_puts(fp->uf_name);
20487 msg_putchar('(');
20488 for (j = 0; j < fp->uf_args.ga_len; ++j)
20490 if (j)
20491 MSG_PUTS(", ");
20492 msg_puts(FUNCARG(fp, j));
20494 if (fp->uf_varargs)
20496 if (j)
20497 MSG_PUTS(", ");
20498 MSG_PUTS("...");
20500 msg_putchar(')');
20501 msg_clr_eos();
20502 if (p_verbose > 0)
20503 last_set_msg(fp->uf_script_ID);
20507 * Find a function by name, return pointer to it in ufuncs.
20508 * Return NULL for unknown function.
20510 static ufunc_T *
20511 find_func(name)
20512 char_u *name;
20514 hashitem_T *hi;
20516 hi = hash_find(&func_hashtab, name);
20517 if (!HASHITEM_EMPTY(hi))
20518 return HI2UF(hi);
20519 return NULL;
20522 #if defined(EXITFREE) || defined(PROTO)
20523 void
20524 free_all_functions()
20526 hashitem_T *hi;
20528 /* Need to start all over every time, because func_free() may change the
20529 * hash table. */
20530 while (func_hashtab.ht_used > 0)
20531 for (hi = func_hashtab.ht_array; ; ++hi)
20532 if (!HASHITEM_EMPTY(hi))
20534 func_free(HI2UF(hi));
20535 break;
20538 #endif
20541 * Return TRUE if a function "name" exists.
20543 static int
20544 function_exists(name)
20545 char_u *name;
20547 char_u *nm = name;
20548 char_u *p;
20549 int n = FALSE;
20551 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20552 nm = skipwhite(nm);
20554 /* Only accept "funcname", "funcname ", "funcname (..." and
20555 * "funcname(...", not "funcname!...". */
20556 if (p != NULL && (*nm == NUL || *nm == '('))
20558 if (builtin_function(p))
20559 n = (find_internal_func(p) >= 0);
20560 else
20561 n = (find_func(p) != NULL);
20563 vim_free(p);
20564 return n;
20568 * Return TRUE if "name" looks like a builtin function name: starts with a
20569 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20571 static int
20572 builtin_function(name)
20573 char_u *name;
20575 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20576 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20579 #if defined(FEAT_PROFILE) || defined(PROTO)
20581 * Start profiling function "fp".
20583 static void
20584 func_do_profile(fp)
20585 ufunc_T *fp;
20587 fp->uf_tm_count = 0;
20588 profile_zero(&fp->uf_tm_self);
20589 profile_zero(&fp->uf_tm_total);
20590 if (fp->uf_tml_count == NULL)
20591 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20592 (sizeof(int) * fp->uf_lines.ga_len));
20593 if (fp->uf_tml_total == NULL)
20594 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20595 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20596 if (fp->uf_tml_self == NULL)
20597 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20598 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20599 fp->uf_tml_idx = -1;
20600 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20601 || fp->uf_tml_self == NULL)
20602 return; /* out of memory */
20604 fp->uf_profiling = TRUE;
20608 * Dump the profiling results for all functions in file "fd".
20610 void
20611 func_dump_profile(fd)
20612 FILE *fd;
20614 hashitem_T *hi;
20615 int todo;
20616 ufunc_T *fp;
20617 int i;
20618 ufunc_T **sorttab;
20619 int st_len = 0;
20621 todo = (int)func_hashtab.ht_used;
20622 if (todo == 0)
20623 return; /* nothing to dump */
20625 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20627 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20629 if (!HASHITEM_EMPTY(hi))
20631 --todo;
20632 fp = HI2UF(hi);
20633 if (fp->uf_profiling)
20635 if (sorttab != NULL)
20636 sorttab[st_len++] = fp;
20638 if (fp->uf_name[0] == K_SPECIAL)
20639 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20640 else
20641 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20642 if (fp->uf_tm_count == 1)
20643 fprintf(fd, "Called 1 time\n");
20644 else
20645 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20646 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20647 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20648 fprintf(fd, "\n");
20649 fprintf(fd, "count total (s) self (s)\n");
20651 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20653 if (FUNCLINE(fp, i) == NULL)
20654 continue;
20655 prof_func_line(fd, fp->uf_tml_count[i],
20656 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20657 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20659 fprintf(fd, "\n");
20664 if (sorttab != NULL && st_len > 0)
20666 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20667 prof_total_cmp);
20668 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20669 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20670 prof_self_cmp);
20671 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20674 vim_free(sorttab);
20677 static void
20678 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20679 FILE *fd;
20680 ufunc_T **sorttab;
20681 int st_len;
20682 char *title;
20683 int prefer_self; /* when equal print only self time */
20685 int i;
20686 ufunc_T *fp;
20688 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20689 fprintf(fd, "count total (s) self (s) function\n");
20690 for (i = 0; i < 20 && i < st_len; ++i)
20692 fp = sorttab[i];
20693 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20694 prefer_self);
20695 if (fp->uf_name[0] == K_SPECIAL)
20696 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20697 else
20698 fprintf(fd, " %s()\n", fp->uf_name);
20700 fprintf(fd, "\n");
20704 * Print the count and times for one function or function line.
20706 static void
20707 prof_func_line(fd, count, total, self, prefer_self)
20708 FILE *fd;
20709 int count;
20710 proftime_T *total;
20711 proftime_T *self;
20712 int prefer_self; /* when equal print only self time */
20714 if (count > 0)
20716 fprintf(fd, "%5d ", count);
20717 if (prefer_self && profile_equal(total, self))
20718 fprintf(fd, " ");
20719 else
20720 fprintf(fd, "%s ", profile_msg(total));
20721 if (!prefer_self && profile_equal(total, self))
20722 fprintf(fd, " ");
20723 else
20724 fprintf(fd, "%s ", profile_msg(self));
20726 else
20727 fprintf(fd, " ");
20731 * Compare function for total time sorting.
20733 static int
20734 #ifdef __BORLANDC__
20735 _RTLENTRYF
20736 #endif
20737 prof_total_cmp(s1, s2)
20738 const void *s1;
20739 const void *s2;
20741 ufunc_T *p1, *p2;
20743 p1 = *(ufunc_T **)s1;
20744 p2 = *(ufunc_T **)s2;
20745 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20749 * Compare function for self time sorting.
20751 static int
20752 #ifdef __BORLANDC__
20753 _RTLENTRYF
20754 #endif
20755 prof_self_cmp(s1, s2)
20756 const void *s1;
20757 const void *s2;
20759 ufunc_T *p1, *p2;
20761 p1 = *(ufunc_T **)s1;
20762 p2 = *(ufunc_T **)s2;
20763 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20766 #endif
20769 * If "name" has a package name try autoloading the script for it.
20770 * Return TRUE if a package was loaded.
20772 static int
20773 script_autoload(name, reload)
20774 char_u *name;
20775 int reload; /* load script again when already loaded */
20777 char_u *p;
20778 char_u *scriptname, *tofree;
20779 int ret = FALSE;
20780 int i;
20782 /* If there is no '#' after name[0] there is no package name. */
20783 p = vim_strchr(name, AUTOLOAD_CHAR);
20784 if (p == NULL || p == name)
20785 return FALSE;
20787 tofree = scriptname = autoload_name(name);
20789 /* Find the name in the list of previously loaded package names. Skip
20790 * "autoload/", it's always the same. */
20791 for (i = 0; i < ga_loaded.ga_len; ++i)
20792 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20793 break;
20794 if (!reload && i < ga_loaded.ga_len)
20795 ret = FALSE; /* was loaded already */
20796 else
20798 /* Remember the name if it wasn't loaded already. */
20799 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20801 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20802 tofree = NULL;
20805 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20806 if (source_runtime(scriptname, FALSE) == OK)
20807 ret = TRUE;
20810 vim_free(tofree);
20811 return ret;
20815 * Return the autoload script name for a function or variable name.
20816 * Returns NULL when out of memory.
20818 static char_u *
20819 autoload_name(name)
20820 char_u *name;
20822 char_u *p;
20823 char_u *scriptname;
20825 /* Get the script file name: replace '#' with '/', append ".vim". */
20826 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20827 if (scriptname == NULL)
20828 return FALSE;
20829 STRCPY(scriptname, "autoload/");
20830 STRCAT(scriptname, name);
20831 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20832 STRCAT(scriptname, ".vim");
20833 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20834 *p = '/';
20835 return scriptname;
20838 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20841 * Function given to ExpandGeneric() to obtain the list of user defined
20842 * function names.
20844 char_u *
20845 get_user_func_name(xp, idx)
20846 expand_T *xp;
20847 int idx;
20849 static long_u done;
20850 static hashitem_T *hi;
20851 ufunc_T *fp;
20853 if (idx == 0)
20855 done = 0;
20856 hi = func_hashtab.ht_array;
20858 if (done < func_hashtab.ht_used)
20860 if (done++ > 0)
20861 ++hi;
20862 while (HASHITEM_EMPTY(hi))
20863 ++hi;
20864 fp = HI2UF(hi);
20866 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20867 return fp->uf_name; /* prevents overflow */
20869 cat_func_name(IObuff, fp);
20870 if (xp->xp_context != EXPAND_USER_FUNC)
20872 STRCAT(IObuff, "(");
20873 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20874 STRCAT(IObuff, ")");
20876 return IObuff;
20878 return NULL;
20881 #endif /* FEAT_CMDL_COMPL */
20884 * Copy the function name of "fp" to buffer "buf".
20885 * "buf" must be able to hold the function name plus three bytes.
20886 * Takes care of script-local function names.
20888 static void
20889 cat_func_name(buf, fp)
20890 char_u *buf;
20891 ufunc_T *fp;
20893 if (fp->uf_name[0] == K_SPECIAL)
20895 STRCPY(buf, "<SNR>");
20896 STRCAT(buf, fp->uf_name + 3);
20898 else
20899 STRCPY(buf, fp->uf_name);
20903 * ":delfunction {name}"
20905 void
20906 ex_delfunction(eap)
20907 exarg_T *eap;
20909 ufunc_T *fp = NULL;
20910 char_u *p;
20911 char_u *name;
20912 funcdict_T fudi;
20914 p = eap->arg;
20915 name = trans_function_name(&p, eap->skip, 0, &fudi);
20916 vim_free(fudi.fd_newkey);
20917 if (name == NULL)
20919 if (fudi.fd_dict != NULL && !eap->skip)
20920 EMSG(_(e_funcref));
20921 return;
20923 if (!ends_excmd(*skipwhite(p)))
20925 vim_free(name);
20926 EMSG(_(e_trailing));
20927 return;
20929 eap->nextcmd = check_nextcmd(p);
20930 if (eap->nextcmd != NULL)
20931 *p = NUL;
20933 if (!eap->skip)
20934 fp = find_func(name);
20935 vim_free(name);
20937 if (!eap->skip)
20939 if (fp == NULL)
20941 EMSG2(_(e_nofunc), eap->arg);
20942 return;
20944 if (fp->uf_calls > 0)
20946 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20947 return;
20950 if (fudi.fd_dict != NULL)
20952 /* Delete the dict item that refers to the function, it will
20953 * invoke func_unref() and possibly delete the function. */
20954 dictitem_remove(fudi.fd_dict, fudi.fd_di);
20956 else
20957 func_free(fp);
20962 * Free a function and remove it from the list of functions.
20964 static void
20965 func_free(fp)
20966 ufunc_T *fp;
20968 hashitem_T *hi;
20970 /* clear this function */
20971 ga_clear_strings(&(fp->uf_args));
20972 ga_clear_strings(&(fp->uf_lines));
20973 #ifdef FEAT_PROFILE
20974 vim_free(fp->uf_tml_count);
20975 vim_free(fp->uf_tml_total);
20976 vim_free(fp->uf_tml_self);
20977 #endif
20979 /* remove the function from the function hashtable */
20980 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
20981 if (HASHITEM_EMPTY(hi))
20982 EMSG2(_(e_intern2), "func_free()");
20983 else
20984 hash_remove(&func_hashtab, hi);
20986 vim_free(fp);
20990 * Unreference a Function: decrement the reference count and free it when it
20991 * becomes zero. Only for numbered functions.
20993 static void
20994 func_unref(name)
20995 char_u *name;
20997 ufunc_T *fp;
20999 if (name != NULL && isdigit(*name))
21001 fp = find_func(name);
21002 if (fp == NULL)
21003 EMSG2(_(e_intern2), "func_unref()");
21004 else if (--fp->uf_refcount <= 0)
21006 /* Only delete it when it's not being used. Otherwise it's done
21007 * when "uf_calls" becomes zero. */
21008 if (fp->uf_calls == 0)
21009 func_free(fp);
21015 * Count a reference to a Function.
21017 static void
21018 func_ref(name)
21019 char_u *name;
21021 ufunc_T *fp;
21023 if (name != NULL && isdigit(*name))
21025 fp = find_func(name);
21026 if (fp == NULL)
21027 EMSG2(_(e_intern2), "func_ref()");
21028 else
21029 ++fp->uf_refcount;
21034 * Call a user function.
21036 static void
21037 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21038 ufunc_T *fp; /* pointer to function */
21039 int argcount; /* nr of args */
21040 typval_T *argvars; /* arguments */
21041 typval_T *rettv; /* return value */
21042 linenr_T firstline; /* first line of range */
21043 linenr_T lastline; /* last line of range */
21044 dict_T *selfdict; /* Dictionary for "self" */
21046 char_u *save_sourcing_name;
21047 linenr_T save_sourcing_lnum;
21048 scid_T save_current_SID;
21049 funccall_T fc;
21050 int save_did_emsg;
21051 static int depth = 0;
21052 dictitem_T *v;
21053 int fixvar_idx = 0; /* index in fixvar[] */
21054 int i;
21055 int ai;
21056 char_u numbuf[NUMBUFLEN];
21057 char_u *name;
21058 #ifdef FEAT_PROFILE
21059 proftime_T wait_start;
21060 proftime_T call_start;
21061 #endif
21063 /* If depth of calling is getting too high, don't execute the function */
21064 if (depth >= p_mfd)
21066 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21067 rettv->v_type = VAR_NUMBER;
21068 rettv->vval.v_number = -1;
21069 return;
21071 ++depth;
21073 line_breakcheck(); /* check for CTRL-C hit */
21075 fc.caller = current_funccal;
21076 current_funccal = &fc;
21077 fc.func = fp;
21078 fc.rettv = rettv;
21079 rettv->vval.v_number = 0;
21080 fc.linenr = 0;
21081 fc.returned = FALSE;
21082 fc.level = ex_nesting_level;
21083 /* Check if this function has a breakpoint. */
21084 fc.breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21085 fc.dbg_tick = debug_tick;
21088 * Note about using fc.fixvar[]: This is an array of FIXVAR_CNT variables
21089 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21090 * each argument variable and saves a lot of time.
21093 * Init l: variables.
21095 init_var_dict(&fc.l_vars, &fc.l_vars_var);
21096 if (selfdict != NULL)
21098 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21099 * some compiler that checks the destination size. */
21100 v = &fc.fixvar[fixvar_idx++].var;
21101 name = v->di_key;
21102 STRCPY(name, "self");
21103 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21104 hash_add(&fc.l_vars.dv_hashtab, DI2HIKEY(v));
21105 v->di_tv.v_type = VAR_DICT;
21106 v->di_tv.v_lock = 0;
21107 v->di_tv.vval.v_dict = selfdict;
21108 ++selfdict->dv_refcount;
21112 * Init a: variables.
21113 * Set a:0 to "argcount".
21114 * Set a:000 to a list with room for the "..." arguments.
21116 init_var_dict(&fc.l_avars, &fc.l_avars_var);
21117 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "0",
21118 (varnumber_T)(argcount - fp->uf_args.ga_len));
21119 v = &fc.fixvar[fixvar_idx++].var;
21120 STRCPY(v->di_key, "000");
21121 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21122 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21123 v->di_tv.v_type = VAR_LIST;
21124 v->di_tv.v_lock = VAR_FIXED;
21125 v->di_tv.vval.v_list = &fc.l_varlist;
21126 vim_memset(&fc.l_varlist, 0, sizeof(list_T));
21127 fc.l_varlist.lv_refcount = 99999;
21128 fc.l_varlist.lv_lock = VAR_FIXED;
21131 * Set a:firstline to "firstline" and a:lastline to "lastline".
21132 * Set a:name to named arguments.
21133 * Set a:N to the "..." arguments.
21135 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "firstline",
21136 (varnumber_T)firstline);
21137 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "lastline",
21138 (varnumber_T)lastline);
21139 for (i = 0; i < argcount; ++i)
21141 ai = i - fp->uf_args.ga_len;
21142 if (ai < 0)
21143 /* named argument a:name */
21144 name = FUNCARG(fp, i);
21145 else
21147 /* "..." argument a:1, a:2, etc. */
21148 sprintf((char *)numbuf, "%d", ai + 1);
21149 name = numbuf;
21151 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21153 v = &fc.fixvar[fixvar_idx++].var;
21154 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21156 else
21158 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21159 + STRLEN(name)));
21160 if (v == NULL)
21161 break;
21162 v->di_flags = DI_FLAGS_RO;
21164 STRCPY(v->di_key, name);
21165 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21167 /* Note: the values are copied directly to avoid alloc/free.
21168 * "argvars" must have VAR_FIXED for v_lock. */
21169 v->di_tv = argvars[i];
21170 v->di_tv.v_lock = VAR_FIXED;
21172 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21174 list_append(&fc.l_varlist, &fc.l_listitems[ai]);
21175 fc.l_listitems[ai].li_tv = argvars[i];
21176 fc.l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21180 /* Don't redraw while executing the function. */
21181 ++RedrawingDisabled;
21182 save_sourcing_name = sourcing_name;
21183 save_sourcing_lnum = sourcing_lnum;
21184 sourcing_lnum = 1;
21185 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21186 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21187 if (sourcing_name != NULL)
21189 if (save_sourcing_name != NULL
21190 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21191 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21192 else
21193 STRCPY(sourcing_name, "function ");
21194 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21196 if (p_verbose >= 12)
21198 ++no_wait_return;
21199 verbose_enter_scroll();
21201 smsg((char_u *)_("calling %s"), sourcing_name);
21202 if (p_verbose >= 14)
21204 char_u buf[MSG_BUF_LEN];
21205 char_u numbuf2[NUMBUFLEN];
21206 char_u *tofree;
21207 char_u *s;
21209 msg_puts((char_u *)"(");
21210 for (i = 0; i < argcount; ++i)
21212 if (i > 0)
21213 msg_puts((char_u *)", ");
21214 if (argvars[i].v_type == VAR_NUMBER)
21215 msg_outnum((long)argvars[i].vval.v_number);
21216 else
21218 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21219 if (s != NULL)
21221 trunc_string(s, buf, MSG_BUF_CLEN);
21222 msg_puts(buf);
21223 vim_free(tofree);
21227 msg_puts((char_u *)")");
21229 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21231 verbose_leave_scroll();
21232 --no_wait_return;
21235 #ifdef FEAT_PROFILE
21236 if (do_profiling == PROF_YES)
21238 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21239 func_do_profile(fp);
21240 if (fp->uf_profiling
21241 || (fc.caller != NULL && fc.caller->func->uf_profiling))
21243 ++fp->uf_tm_count;
21244 profile_start(&call_start);
21245 profile_zero(&fp->uf_tm_children);
21247 script_prof_save(&wait_start);
21249 #endif
21251 save_current_SID = current_SID;
21252 current_SID = fp->uf_script_ID;
21253 save_did_emsg = did_emsg;
21254 did_emsg = FALSE;
21256 /* call do_cmdline() to execute the lines */
21257 do_cmdline(NULL, get_func_line, (void *)&fc,
21258 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21260 --RedrawingDisabled;
21262 /* when the function was aborted because of an error, return -1 */
21263 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21265 clear_tv(rettv);
21266 rettv->v_type = VAR_NUMBER;
21267 rettv->vval.v_number = -1;
21270 #ifdef FEAT_PROFILE
21271 if (do_profiling == PROF_YES && (fp->uf_profiling
21272 || (fc.caller != NULL && fc.caller->func->uf_profiling)))
21274 profile_end(&call_start);
21275 profile_sub_wait(&wait_start, &call_start);
21276 profile_add(&fp->uf_tm_total, &call_start);
21277 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21278 if (fc.caller != NULL && fc.caller->func->uf_profiling)
21280 profile_add(&fc.caller->func->uf_tm_children, &call_start);
21281 profile_add(&fc.caller->func->uf_tml_children, &call_start);
21284 #endif
21286 /* when being verbose, mention the return value */
21287 if (p_verbose >= 12)
21289 ++no_wait_return;
21290 verbose_enter_scroll();
21292 if (aborting())
21293 smsg((char_u *)_("%s aborted"), sourcing_name);
21294 else if (fc.rettv->v_type == VAR_NUMBER)
21295 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21296 (long)fc.rettv->vval.v_number);
21297 else
21299 char_u buf[MSG_BUF_LEN];
21300 char_u numbuf2[NUMBUFLEN];
21301 char_u *tofree;
21302 char_u *s;
21304 /* The value may be very long. Skip the middle part, so that we
21305 * have some idea how it starts and ends. smsg() would always
21306 * truncate it at the end. */
21307 s = tv2string(fc.rettv, &tofree, numbuf2, 0);
21308 if (s != NULL)
21310 trunc_string(s, buf, MSG_BUF_CLEN);
21311 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21312 vim_free(tofree);
21315 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21317 verbose_leave_scroll();
21318 --no_wait_return;
21321 vim_free(sourcing_name);
21322 sourcing_name = save_sourcing_name;
21323 sourcing_lnum = save_sourcing_lnum;
21324 current_SID = save_current_SID;
21325 #ifdef FEAT_PROFILE
21326 if (do_profiling == PROF_YES)
21327 script_prof_restore(&wait_start);
21328 #endif
21330 if (p_verbose >= 12 && sourcing_name != NULL)
21332 ++no_wait_return;
21333 verbose_enter_scroll();
21335 smsg((char_u *)_("continuing in %s"), sourcing_name);
21336 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21338 verbose_leave_scroll();
21339 --no_wait_return;
21342 did_emsg |= save_did_emsg;
21343 current_funccal = fc.caller;
21345 /* The a: variables typevals were not allocated, only free the allocated
21346 * variables. */
21347 vars_clear_ext(&fc.l_avars.dv_hashtab, FALSE);
21349 vars_clear(&fc.l_vars.dv_hashtab); /* free all l: variables */
21350 --depth;
21354 * Add a number variable "name" to dict "dp" with value "nr".
21356 static void
21357 add_nr_var(dp, v, name, nr)
21358 dict_T *dp;
21359 dictitem_T *v;
21360 char *name;
21361 varnumber_T nr;
21363 STRCPY(v->di_key, name);
21364 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21365 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21366 v->di_tv.v_type = VAR_NUMBER;
21367 v->di_tv.v_lock = VAR_FIXED;
21368 v->di_tv.vval.v_number = nr;
21372 * ":return [expr]"
21374 void
21375 ex_return(eap)
21376 exarg_T *eap;
21378 char_u *arg = eap->arg;
21379 typval_T rettv;
21380 int returning = FALSE;
21382 if (current_funccal == NULL)
21384 EMSG(_("E133: :return not inside a function"));
21385 return;
21388 if (eap->skip)
21389 ++emsg_skip;
21391 eap->nextcmd = NULL;
21392 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21393 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21395 if (!eap->skip)
21396 returning = do_return(eap, FALSE, TRUE, &rettv);
21397 else
21398 clear_tv(&rettv);
21400 /* It's safer to return also on error. */
21401 else if (!eap->skip)
21404 * Return unless the expression evaluation has been cancelled due to an
21405 * aborting error, an interrupt, or an exception.
21407 if (!aborting())
21408 returning = do_return(eap, FALSE, TRUE, NULL);
21411 /* When skipping or the return gets pending, advance to the next command
21412 * in this line (!returning). Otherwise, ignore the rest of the line.
21413 * Following lines will be ignored by get_func_line(). */
21414 if (returning)
21415 eap->nextcmd = NULL;
21416 else if (eap->nextcmd == NULL) /* no argument */
21417 eap->nextcmd = check_nextcmd(arg);
21419 if (eap->skip)
21420 --emsg_skip;
21424 * Return from a function. Possibly makes the return pending. Also called
21425 * for a pending return at the ":endtry" or after returning from an extra
21426 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21427 * when called due to a ":return" command. "rettv" may point to a typval_T
21428 * with the return rettv. Returns TRUE when the return can be carried out,
21429 * FALSE when the return gets pending.
21432 do_return(eap, reanimate, is_cmd, rettv)
21433 exarg_T *eap;
21434 int reanimate;
21435 int is_cmd;
21436 void *rettv;
21438 int idx;
21439 struct condstack *cstack = eap->cstack;
21441 if (reanimate)
21442 /* Undo the return. */
21443 current_funccal->returned = FALSE;
21446 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21447 * not in its finally clause (which then is to be executed next) is found.
21448 * In this case, make the ":return" pending for execution at the ":endtry".
21449 * Otherwise, return normally.
21451 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21452 if (idx >= 0)
21454 cstack->cs_pending[idx] = CSTP_RETURN;
21456 if (!is_cmd && !reanimate)
21457 /* A pending return again gets pending. "rettv" points to an
21458 * allocated variable with the rettv of the original ":return"'s
21459 * argument if present or is NULL else. */
21460 cstack->cs_rettv[idx] = rettv;
21461 else
21463 /* When undoing a return in order to make it pending, get the stored
21464 * return rettv. */
21465 if (reanimate)
21466 rettv = current_funccal->rettv;
21468 if (rettv != NULL)
21470 /* Store the value of the pending return. */
21471 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21472 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21473 else
21474 EMSG(_(e_outofmem));
21476 else
21477 cstack->cs_rettv[idx] = NULL;
21479 if (reanimate)
21481 /* The pending return value could be overwritten by a ":return"
21482 * without argument in a finally clause; reset the default
21483 * return value. */
21484 current_funccal->rettv->v_type = VAR_NUMBER;
21485 current_funccal->rettv->vval.v_number = 0;
21488 report_make_pending(CSTP_RETURN, rettv);
21490 else
21492 current_funccal->returned = TRUE;
21494 /* If the return is carried out now, store the return value. For
21495 * a return immediately after reanimation, the value is already
21496 * there. */
21497 if (!reanimate && rettv != NULL)
21499 clear_tv(current_funccal->rettv);
21500 *current_funccal->rettv = *(typval_T *)rettv;
21501 if (!is_cmd)
21502 vim_free(rettv);
21506 return idx < 0;
21510 * Free the variable with a pending return value.
21512 void
21513 discard_pending_return(rettv)
21514 void *rettv;
21516 free_tv((typval_T *)rettv);
21520 * Generate a return command for producing the value of "rettv". The result
21521 * is an allocated string. Used by report_pending() for verbose messages.
21523 char_u *
21524 get_return_cmd(rettv)
21525 void *rettv;
21527 char_u *s = NULL;
21528 char_u *tofree = NULL;
21529 char_u numbuf[NUMBUFLEN];
21531 if (rettv != NULL)
21532 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21533 if (s == NULL)
21534 s = (char_u *)"";
21536 STRCPY(IObuff, ":return ");
21537 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21538 if (STRLEN(s) + 8 >= IOSIZE)
21539 STRCPY(IObuff + IOSIZE - 4, "...");
21540 vim_free(tofree);
21541 return vim_strsave(IObuff);
21545 * Get next function line.
21546 * Called by do_cmdline() to get the next line.
21547 * Returns allocated string, or NULL for end of function.
21549 /* ARGSUSED */
21550 char_u *
21551 get_func_line(c, cookie, indent)
21552 int c; /* not used */
21553 void *cookie;
21554 int indent; /* not used */
21556 funccall_T *fcp = (funccall_T *)cookie;
21557 ufunc_T *fp = fcp->func;
21558 char_u *retval;
21559 garray_T *gap; /* growarray with function lines */
21561 /* If breakpoints have been added/deleted need to check for it. */
21562 if (fcp->dbg_tick != debug_tick)
21564 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21565 sourcing_lnum);
21566 fcp->dbg_tick = debug_tick;
21568 #ifdef FEAT_PROFILE
21569 if (do_profiling == PROF_YES)
21570 func_line_end(cookie);
21571 #endif
21573 gap = &fp->uf_lines;
21574 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21575 || fcp->returned)
21576 retval = NULL;
21577 else
21579 /* Skip NULL lines (continuation lines). */
21580 while (fcp->linenr < gap->ga_len
21581 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21582 ++fcp->linenr;
21583 if (fcp->linenr >= gap->ga_len)
21584 retval = NULL;
21585 else
21587 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21588 sourcing_lnum = fcp->linenr;
21589 #ifdef FEAT_PROFILE
21590 if (do_profiling == PROF_YES)
21591 func_line_start(cookie);
21592 #endif
21596 /* Did we encounter a breakpoint? */
21597 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21599 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21600 /* Find next breakpoint. */
21601 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21602 sourcing_lnum);
21603 fcp->dbg_tick = debug_tick;
21606 return retval;
21609 #if defined(FEAT_PROFILE) || defined(PROTO)
21611 * Called when starting to read a function line.
21612 * "sourcing_lnum" must be correct!
21613 * When skipping lines it may not actually be executed, but we won't find out
21614 * until later and we need to store the time now.
21616 void
21617 func_line_start(cookie)
21618 void *cookie;
21620 funccall_T *fcp = (funccall_T *)cookie;
21621 ufunc_T *fp = fcp->func;
21623 if (fp->uf_profiling && sourcing_lnum >= 1
21624 && sourcing_lnum <= fp->uf_lines.ga_len)
21626 fp->uf_tml_idx = sourcing_lnum - 1;
21627 /* Skip continuation lines. */
21628 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21629 --fp->uf_tml_idx;
21630 fp->uf_tml_execed = FALSE;
21631 profile_start(&fp->uf_tml_start);
21632 profile_zero(&fp->uf_tml_children);
21633 profile_get_wait(&fp->uf_tml_wait);
21638 * Called when actually executing a function line.
21640 void
21641 func_line_exec(cookie)
21642 void *cookie;
21644 funccall_T *fcp = (funccall_T *)cookie;
21645 ufunc_T *fp = fcp->func;
21647 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21648 fp->uf_tml_execed = TRUE;
21652 * Called when done with a function line.
21654 void
21655 func_line_end(cookie)
21656 void *cookie;
21658 funccall_T *fcp = (funccall_T *)cookie;
21659 ufunc_T *fp = fcp->func;
21661 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21663 if (fp->uf_tml_execed)
21665 ++fp->uf_tml_count[fp->uf_tml_idx];
21666 profile_end(&fp->uf_tml_start);
21667 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21668 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21669 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21670 &fp->uf_tml_children);
21672 fp->uf_tml_idx = -1;
21675 #endif
21678 * Return TRUE if the currently active function should be ended, because a
21679 * return was encountered or an error occurred. Used inside a ":while".
21682 func_has_ended(cookie)
21683 void *cookie;
21685 funccall_T *fcp = (funccall_T *)cookie;
21687 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21688 * an error inside a try conditional. */
21689 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21690 || fcp->returned);
21694 * return TRUE if cookie indicates a function which "abort"s on errors.
21697 func_has_abort(cookie)
21698 void *cookie;
21700 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21703 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21704 typedef enum
21706 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21707 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21708 VAR_FLAVOUR_VIMINFO /* all uppercase */
21709 } var_flavour_T;
21711 static var_flavour_T var_flavour __ARGS((char_u *varname));
21713 static var_flavour_T
21714 var_flavour(varname)
21715 char_u *varname;
21717 char_u *p = varname;
21719 if (ASCII_ISUPPER(*p))
21721 while (*(++p))
21722 if (ASCII_ISLOWER(*p))
21723 return VAR_FLAVOUR_SESSION;
21724 return VAR_FLAVOUR_VIMINFO;
21726 else
21727 return VAR_FLAVOUR_DEFAULT;
21729 #endif
21731 #if defined(FEAT_VIMINFO) || defined(PROTO)
21733 * Restore global vars that start with a capital from the viminfo file
21736 read_viminfo_varlist(virp, writing)
21737 vir_T *virp;
21738 int writing;
21740 char_u *tab;
21741 int type = VAR_NUMBER;
21742 typval_T tv;
21744 if (!writing && (find_viminfo_parameter('!') != NULL))
21746 tab = vim_strchr(virp->vir_line + 1, '\t');
21747 if (tab != NULL)
21749 *tab++ = '\0'; /* isolate the variable name */
21750 if (*tab == 'S') /* string var */
21751 type = VAR_STRING;
21752 #ifdef FEAT_FLOAT
21753 else if (*tab == 'F')
21754 type = VAR_FLOAT;
21755 #endif
21757 tab = vim_strchr(tab, '\t');
21758 if (tab != NULL)
21760 tv.v_type = type;
21761 if (type == VAR_STRING)
21762 tv.vval.v_string = viminfo_readstring(virp,
21763 (int)(tab - virp->vir_line + 1), TRUE);
21764 #ifdef FEAT_FLOAT
21765 else if (type == VAR_FLOAT)
21766 (void)string2float(tab + 1, &tv.vval.v_float);
21767 #endif
21768 else
21769 tv.vval.v_number = atol((char *)tab + 1);
21770 set_var(virp->vir_line + 1, &tv, FALSE);
21771 if (type == VAR_STRING)
21772 vim_free(tv.vval.v_string);
21777 return viminfo_readline(virp);
21781 * Write global vars that start with a capital to the viminfo file
21783 void
21784 write_viminfo_varlist(fp)
21785 FILE *fp;
21787 hashitem_T *hi;
21788 dictitem_T *this_var;
21789 int todo;
21790 char *s;
21791 char_u *p;
21792 char_u *tofree;
21793 char_u numbuf[NUMBUFLEN];
21795 if (find_viminfo_parameter('!') == NULL)
21796 return;
21798 fprintf(fp, _("\n# global variables:\n"));
21800 todo = (int)globvarht.ht_used;
21801 for (hi = globvarht.ht_array; todo > 0; ++hi)
21803 if (!HASHITEM_EMPTY(hi))
21805 --todo;
21806 this_var = HI2DI(hi);
21807 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21809 switch (this_var->di_tv.v_type)
21811 case VAR_STRING: s = "STR"; break;
21812 case VAR_NUMBER: s = "NUM"; break;
21813 #ifdef FEAT_FLOAT
21814 case VAR_FLOAT: s = "FLO"; break;
21815 #endif
21816 default: continue;
21818 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21819 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21820 if (p != NULL)
21821 viminfo_writestring(fp, p);
21822 vim_free(tofree);
21827 #endif
21829 #if defined(FEAT_SESSION) || defined(PROTO)
21831 store_session_globals(fd)
21832 FILE *fd;
21834 hashitem_T *hi;
21835 dictitem_T *this_var;
21836 int todo;
21837 char_u *p, *t;
21839 todo = (int)globvarht.ht_used;
21840 for (hi = globvarht.ht_array; todo > 0; ++hi)
21842 if (!HASHITEM_EMPTY(hi))
21844 --todo;
21845 this_var = HI2DI(hi);
21846 if ((this_var->di_tv.v_type == VAR_NUMBER
21847 || this_var->di_tv.v_type == VAR_STRING)
21848 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21850 /* Escape special characters with a backslash. Turn a LF and
21851 * CR into \n and \r. */
21852 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21853 (char_u *)"\\\"\n\r");
21854 if (p == NULL) /* out of memory */
21855 break;
21856 for (t = p; *t != NUL; ++t)
21857 if (*t == '\n')
21858 *t = 'n';
21859 else if (*t == '\r')
21860 *t = 'r';
21861 if ((fprintf(fd, "let %s = %c%s%c",
21862 this_var->di_key,
21863 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21864 : ' ',
21866 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21867 : ' ') < 0)
21868 || put_eol(fd) == FAIL)
21870 vim_free(p);
21871 return FAIL;
21873 vim_free(p);
21875 #ifdef FEAT_FLOAT
21876 else if (this_var->di_tv.v_type == VAR_FLOAT
21877 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21879 float_T f = this_var->di_tv.vval.v_float;
21880 int sign = ' ';
21882 if (f < 0)
21884 f = -f;
21885 sign = '-';
21887 if ((fprintf(fd, "let %s = %c&%f",
21888 this_var->di_key, sign, f) < 0)
21889 || put_eol(fd) == FAIL)
21890 return FAIL;
21892 #endif
21895 return OK;
21897 #endif
21900 * Display script name where an item was last set.
21901 * Should only be invoked when 'verbose' is non-zero.
21903 void
21904 last_set_msg(scriptID)
21905 scid_T scriptID;
21907 char_u *p;
21909 if (scriptID != 0)
21911 p = home_replace_save(NULL, get_scriptname(scriptID));
21912 if (p != NULL)
21914 verbose_enter();
21915 MSG_PUTS(_("\n\tLast set from "));
21916 MSG_PUTS(p);
21917 vim_free(p);
21918 verbose_leave();
21923 #endif /* FEAT_EVAL */
21926 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
21928 #ifdef WIN3264
21930 * Functions for ":8" filename modifier: get 8.3 version of a filename.
21932 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21933 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
21934 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
21937 * Get the short path (8.3) for the filename in "fnamep".
21938 * Only works for a valid file name.
21939 * When the path gets longer "fnamep" is changed and the allocated buffer
21940 * is put in "bufp".
21941 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
21942 * Returns OK on success, FAIL on failure.
21944 static int
21945 get_short_pathname(fnamep, bufp, fnamelen)
21946 char_u **fnamep;
21947 char_u **bufp;
21948 int *fnamelen;
21950 int l, len;
21951 char_u *newbuf;
21953 len = *fnamelen;
21954 l = GetShortPathName(*fnamep, *fnamep, len);
21955 if (l > len - 1)
21957 /* If that doesn't work (not enough space), then save the string
21958 * and try again with a new buffer big enough. */
21959 newbuf = vim_strnsave(*fnamep, l);
21960 if (newbuf == NULL)
21961 return FAIL;
21963 vim_free(*bufp);
21964 *fnamep = *bufp = newbuf;
21966 /* Really should always succeed, as the buffer is big enough. */
21967 l = GetShortPathName(*fnamep, *fnamep, l+1);
21970 *fnamelen = l;
21971 return OK;
21975 * Get the short path (8.3) for the filename in "fname". The converted
21976 * path is returned in "bufp".
21978 * Some of the directories specified in "fname" may not exist. This function
21979 * will shorten the existing directories at the beginning of the path and then
21980 * append the remaining non-existing path.
21982 * fname - Pointer to the filename to shorten. On return, contains the
21983 * pointer to the shortened pathname
21984 * bufp - Pointer to an allocated buffer for the filename.
21985 * fnamelen - Length of the filename pointed to by fname
21987 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
21989 static int
21990 shortpath_for_invalid_fname(fname, bufp, fnamelen)
21991 char_u **fname;
21992 char_u **bufp;
21993 int *fnamelen;
21995 char_u *short_fname, *save_fname, *pbuf_unused;
21996 char_u *endp, *save_endp;
21997 char_u ch;
21998 int old_len, len;
21999 int new_len, sfx_len;
22000 int retval = OK;
22002 /* Make a copy */
22003 old_len = *fnamelen;
22004 save_fname = vim_strnsave(*fname, old_len);
22005 pbuf_unused = NULL;
22006 short_fname = NULL;
22008 endp = save_fname + old_len - 1; /* Find the end of the copy */
22009 save_endp = endp;
22012 * Try shortening the supplied path till it succeeds by removing one
22013 * directory at a time from the tail of the path.
22015 len = 0;
22016 for (;;)
22018 /* go back one path-separator */
22019 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22020 --endp;
22021 if (endp <= save_fname)
22022 break; /* processed the complete path */
22025 * Replace the path separator with a NUL and try to shorten the
22026 * resulting path.
22028 ch = *endp;
22029 *endp = 0;
22030 short_fname = save_fname;
22031 len = (int)STRLEN(short_fname) + 1;
22032 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22034 retval = FAIL;
22035 goto theend;
22037 *endp = ch; /* preserve the string */
22039 if (len > 0)
22040 break; /* successfully shortened the path */
22042 /* failed to shorten the path. Skip the path separator */
22043 --endp;
22046 if (len > 0)
22049 * Succeeded in shortening the path. Now concatenate the shortened
22050 * path with the remaining path at the tail.
22053 /* Compute the length of the new path. */
22054 sfx_len = (int)(save_endp - endp) + 1;
22055 new_len = len + sfx_len;
22057 *fnamelen = new_len;
22058 vim_free(*bufp);
22059 if (new_len > old_len)
22061 /* There is not enough space in the currently allocated string,
22062 * copy it to a buffer big enough. */
22063 *fname = *bufp = vim_strnsave(short_fname, new_len);
22064 if (*fname == NULL)
22066 retval = FAIL;
22067 goto theend;
22070 else
22072 /* Transfer short_fname to the main buffer (it's big enough),
22073 * unless get_short_pathname() did its work in-place. */
22074 *fname = *bufp = save_fname;
22075 if (short_fname != save_fname)
22076 vim_strncpy(save_fname, short_fname, len);
22077 save_fname = NULL;
22080 /* concat the not-shortened part of the path */
22081 vim_strncpy(*fname + len, endp, sfx_len);
22082 (*fname)[new_len] = NUL;
22085 theend:
22086 vim_free(pbuf_unused);
22087 vim_free(save_fname);
22089 return retval;
22093 * Get a pathname for a partial path.
22094 * Returns OK for success, FAIL for failure.
22096 static int
22097 shortpath_for_partial(fnamep, bufp, fnamelen)
22098 char_u **fnamep;
22099 char_u **bufp;
22100 int *fnamelen;
22102 int sepcount, len, tflen;
22103 char_u *p;
22104 char_u *pbuf, *tfname;
22105 int hasTilde;
22107 /* Count up the path separators from the RHS.. so we know which part
22108 * of the path to return. */
22109 sepcount = 0;
22110 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22111 if (vim_ispathsep(*p))
22112 ++sepcount;
22114 /* Need full path first (use expand_env() to remove a "~/") */
22115 hasTilde = (**fnamep == '~');
22116 if (hasTilde)
22117 pbuf = tfname = expand_env_save(*fnamep);
22118 else
22119 pbuf = tfname = FullName_save(*fnamep, FALSE);
22121 len = tflen = (int)STRLEN(tfname);
22123 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22124 return FAIL;
22126 if (len == 0)
22128 /* Don't have a valid filename, so shorten the rest of the
22129 * path if we can. This CAN give us invalid 8.3 filenames, but
22130 * there's not a lot of point in guessing what it might be.
22132 len = tflen;
22133 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22134 return FAIL;
22137 /* Count the paths backward to find the beginning of the desired string. */
22138 for (p = tfname + len - 1; p >= tfname; --p)
22140 #ifdef FEAT_MBYTE
22141 if (has_mbyte)
22142 p -= mb_head_off(tfname, p);
22143 #endif
22144 if (vim_ispathsep(*p))
22146 if (sepcount == 0 || (hasTilde && sepcount == 1))
22147 break;
22148 else
22149 sepcount --;
22152 if (hasTilde)
22154 --p;
22155 if (p >= tfname)
22156 *p = '~';
22157 else
22158 return FAIL;
22160 else
22161 ++p;
22163 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22164 vim_free(*bufp);
22165 *fnamelen = (int)STRLEN(p);
22166 *bufp = pbuf;
22167 *fnamep = p;
22169 return OK;
22171 #endif /* WIN3264 */
22174 * Adjust a filename, according to a string of modifiers.
22175 * *fnamep must be NUL terminated when called. When returning, the length is
22176 * determined by *fnamelen.
22177 * Returns VALID_ flags or -1 for failure.
22178 * When there is an error, *fnamep is set to NULL.
22181 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22182 char_u *src; /* string with modifiers */
22183 int *usedlen; /* characters after src that are used */
22184 char_u **fnamep; /* file name so far */
22185 char_u **bufp; /* buffer for allocated file name or NULL */
22186 int *fnamelen; /* length of fnamep */
22188 int valid = 0;
22189 char_u *tail;
22190 char_u *s, *p, *pbuf;
22191 char_u dirname[MAXPATHL];
22192 int c;
22193 int has_fullname = 0;
22194 #ifdef WIN3264
22195 int has_shortname = 0;
22196 #endif
22198 repeat:
22199 /* ":p" - full path/file_name */
22200 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22202 has_fullname = 1;
22204 valid |= VALID_PATH;
22205 *usedlen += 2;
22207 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22208 if ((*fnamep)[0] == '~'
22209 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22210 && ((*fnamep)[1] == '/'
22211 # ifdef BACKSLASH_IN_FILENAME
22212 || (*fnamep)[1] == '\\'
22213 # endif
22214 || (*fnamep)[1] == NUL)
22216 #endif
22219 *fnamep = expand_env_save(*fnamep);
22220 vim_free(*bufp); /* free any allocated file name */
22221 *bufp = *fnamep;
22222 if (*fnamep == NULL)
22223 return -1;
22226 /* When "/." or "/.." is used: force expansion to get rid of it. */
22227 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22229 if (vim_ispathsep(*p)
22230 && p[1] == '.'
22231 && (p[2] == NUL
22232 || vim_ispathsep(p[2])
22233 || (p[2] == '.'
22234 && (p[3] == NUL || vim_ispathsep(p[3])))))
22235 break;
22238 /* FullName_save() is slow, don't use it when not needed. */
22239 if (*p != NUL || !vim_isAbsName(*fnamep))
22241 *fnamep = FullName_save(*fnamep, *p != NUL);
22242 vim_free(*bufp); /* free any allocated file name */
22243 *bufp = *fnamep;
22244 if (*fnamep == NULL)
22245 return -1;
22248 /* Append a path separator to a directory. */
22249 if (mch_isdir(*fnamep))
22251 /* Make room for one or two extra characters. */
22252 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22253 vim_free(*bufp); /* free any allocated file name */
22254 *bufp = *fnamep;
22255 if (*fnamep == NULL)
22256 return -1;
22257 add_pathsep(*fnamep);
22261 /* ":." - path relative to the current directory */
22262 /* ":~" - path relative to the home directory */
22263 /* ":8" - shortname path - postponed till after */
22264 while (src[*usedlen] == ':'
22265 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22267 *usedlen += 2;
22268 if (c == '8')
22270 #ifdef WIN3264
22271 has_shortname = 1; /* Postpone this. */
22272 #endif
22273 continue;
22275 pbuf = NULL;
22276 /* Need full path first (use expand_env() to remove a "~/") */
22277 if (!has_fullname)
22279 if (c == '.' && **fnamep == '~')
22280 p = pbuf = expand_env_save(*fnamep);
22281 else
22282 p = pbuf = FullName_save(*fnamep, FALSE);
22284 else
22285 p = *fnamep;
22287 has_fullname = 0;
22289 if (p != NULL)
22291 if (c == '.')
22293 mch_dirname(dirname, MAXPATHL);
22294 s = shorten_fname(p, dirname);
22295 if (s != NULL)
22297 *fnamep = s;
22298 if (pbuf != NULL)
22300 vim_free(*bufp); /* free any allocated file name */
22301 *bufp = pbuf;
22302 pbuf = NULL;
22306 else
22308 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22309 /* Only replace it when it starts with '~' */
22310 if (*dirname == '~')
22312 s = vim_strsave(dirname);
22313 if (s != NULL)
22315 *fnamep = s;
22316 vim_free(*bufp);
22317 *bufp = s;
22321 vim_free(pbuf);
22325 tail = gettail(*fnamep);
22326 *fnamelen = (int)STRLEN(*fnamep);
22328 /* ":h" - head, remove "/file_name", can be repeated */
22329 /* Don't remove the first "/" or "c:\" */
22330 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22332 valid |= VALID_HEAD;
22333 *usedlen += 2;
22334 s = get_past_head(*fnamep);
22335 while (tail > s && after_pathsep(s, tail))
22336 mb_ptr_back(*fnamep, tail);
22337 *fnamelen = (int)(tail - *fnamep);
22338 #ifdef VMS
22339 if (*fnamelen > 0)
22340 *fnamelen += 1; /* the path separator is part of the path */
22341 #endif
22342 if (*fnamelen == 0)
22344 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22345 p = vim_strsave((char_u *)".");
22346 if (p == NULL)
22347 return -1;
22348 vim_free(*bufp);
22349 *bufp = *fnamep = tail = p;
22350 *fnamelen = 1;
22352 else
22354 while (tail > s && !after_pathsep(s, tail))
22355 mb_ptr_back(*fnamep, tail);
22359 /* ":8" - shortname */
22360 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22362 *usedlen += 2;
22363 #ifdef WIN3264
22364 has_shortname = 1;
22365 #endif
22368 #ifdef WIN3264
22369 /* Check shortname after we have done 'heads' and before we do 'tails'
22371 if (has_shortname)
22373 pbuf = NULL;
22374 /* Copy the string if it is shortened by :h */
22375 if (*fnamelen < (int)STRLEN(*fnamep))
22377 p = vim_strnsave(*fnamep, *fnamelen);
22378 if (p == 0)
22379 return -1;
22380 vim_free(*bufp);
22381 *bufp = *fnamep = p;
22384 /* Split into two implementations - makes it easier. First is where
22385 * there isn't a full name already, second is where there is.
22387 if (!has_fullname && !vim_isAbsName(*fnamep))
22389 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22390 return -1;
22392 else
22394 int l;
22396 /* Simple case, already have the full-name
22397 * Nearly always shorter, so try first time. */
22398 l = *fnamelen;
22399 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22400 return -1;
22402 if (l == 0)
22404 /* Couldn't find the filename.. search the paths.
22406 l = *fnamelen;
22407 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22408 return -1;
22410 *fnamelen = l;
22413 #endif /* WIN3264 */
22415 /* ":t" - tail, just the basename */
22416 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22418 *usedlen += 2;
22419 *fnamelen -= (int)(tail - *fnamep);
22420 *fnamep = tail;
22423 /* ":e" - extension, can be repeated */
22424 /* ":r" - root, without extension, can be repeated */
22425 while (src[*usedlen] == ':'
22426 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22428 /* find a '.' in the tail:
22429 * - for second :e: before the current fname
22430 * - otherwise: The last '.'
22432 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22433 s = *fnamep - 2;
22434 else
22435 s = *fnamep + *fnamelen - 1;
22436 for ( ; s > tail; --s)
22437 if (s[0] == '.')
22438 break;
22439 if (src[*usedlen + 1] == 'e') /* :e */
22441 if (s > tail)
22443 *fnamelen += (int)(*fnamep - (s + 1));
22444 *fnamep = s + 1;
22445 #ifdef VMS
22446 /* cut version from the extension */
22447 s = *fnamep + *fnamelen - 1;
22448 for ( ; s > *fnamep; --s)
22449 if (s[0] == ';')
22450 break;
22451 if (s > *fnamep)
22452 *fnamelen = s - *fnamep;
22453 #endif
22455 else if (*fnamep <= tail)
22456 *fnamelen = 0;
22458 else /* :r */
22460 if (s > tail) /* remove one extension */
22461 *fnamelen = (int)(s - *fnamep);
22463 *usedlen += 2;
22466 /* ":s?pat?foo?" - substitute */
22467 /* ":gs?pat?foo?" - global substitute */
22468 if (src[*usedlen] == ':'
22469 && (src[*usedlen + 1] == 's'
22470 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22472 char_u *str;
22473 char_u *pat;
22474 char_u *sub;
22475 int sep;
22476 char_u *flags;
22477 int didit = FALSE;
22479 flags = (char_u *)"";
22480 s = src + *usedlen + 2;
22481 if (src[*usedlen + 1] == 'g')
22483 flags = (char_u *)"g";
22484 ++s;
22487 sep = *s++;
22488 if (sep)
22490 /* find end of pattern */
22491 p = vim_strchr(s, sep);
22492 if (p != NULL)
22494 pat = vim_strnsave(s, (int)(p - s));
22495 if (pat != NULL)
22497 s = p + 1;
22498 /* find end of substitution */
22499 p = vim_strchr(s, sep);
22500 if (p != NULL)
22502 sub = vim_strnsave(s, (int)(p - s));
22503 str = vim_strnsave(*fnamep, *fnamelen);
22504 if (sub != NULL && str != NULL)
22506 *usedlen = (int)(p + 1 - src);
22507 s = do_string_sub(str, pat, sub, flags);
22508 if (s != NULL)
22510 *fnamep = s;
22511 *fnamelen = (int)STRLEN(s);
22512 vim_free(*bufp);
22513 *bufp = s;
22514 didit = TRUE;
22517 vim_free(sub);
22518 vim_free(str);
22520 vim_free(pat);
22523 /* after using ":s", repeat all the modifiers */
22524 if (didit)
22525 goto repeat;
22529 return valid;
22533 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22534 * "flags" can be "g" to do a global substitute.
22535 * Returns an allocated string, NULL for error.
22537 char_u *
22538 do_string_sub(str, pat, sub, flags)
22539 char_u *str;
22540 char_u *pat;
22541 char_u *sub;
22542 char_u *flags;
22544 int sublen;
22545 regmatch_T regmatch;
22546 int i;
22547 int do_all;
22548 char_u *tail;
22549 garray_T ga;
22550 char_u *ret;
22551 char_u *save_cpo;
22553 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22554 save_cpo = p_cpo;
22555 p_cpo = empty_option;
22557 ga_init2(&ga, 1, 200);
22559 do_all = (flags[0] == 'g');
22561 regmatch.rm_ic = p_ic;
22562 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22563 if (regmatch.regprog != NULL)
22565 tail = str;
22566 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22569 * Get some space for a temporary buffer to do the substitution
22570 * into. It will contain:
22571 * - The text up to where the match is.
22572 * - The substituted text.
22573 * - The text after the match.
22575 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22576 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22577 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22579 ga_clear(&ga);
22580 break;
22583 /* copy the text up to where the match is */
22584 i = (int)(regmatch.startp[0] - tail);
22585 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22586 /* add the substituted text */
22587 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22588 + ga.ga_len + i, TRUE, TRUE, FALSE);
22589 ga.ga_len += i + sublen - 1;
22590 /* avoid getting stuck on a match with an empty string */
22591 if (tail == regmatch.endp[0])
22593 if (*tail == NUL)
22594 break;
22595 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22596 ++ga.ga_len;
22598 else
22600 tail = regmatch.endp[0];
22601 if (*tail == NUL)
22602 break;
22604 if (!do_all)
22605 break;
22608 if (ga.ga_data != NULL)
22609 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22611 vim_free(regmatch.regprog);
22614 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22615 ga_clear(&ga);
22616 if (p_cpo == empty_option)
22617 p_cpo = save_cpo;
22618 else
22619 /* Darn, evaluating {sub} expression changed the value. */
22620 free_string_option(save_cpo);
22622 return ret;
22625 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */