Merge branch 'vim' into floating_point
[vim_extended.git] / src / eval.c
blob4a715426c6ba6f83d5a0e4023e9624bb7e35135a
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},
351 {VV_NAME("oldfiles", VAR_LIST), 0},
354 /* shorthand */
355 #define vv_type vv_di.di_tv.v_type
356 #define vv_nr vv_di.di_tv.vval.v_number
357 #define vv_float vv_di.di_tv.vval.v_float
358 #define vv_str vv_di.di_tv.vval.v_string
359 #define vv_list vv_di.di_tv.vval.v_list
360 #define vv_tv vv_di.di_tv
363 * The v: variables are stored in dictionary "vimvardict".
364 * "vimvars_var" is the variable that is used for the "l:" scope.
366 static dict_T vimvardict;
367 static dictitem_T vimvars_var;
368 #define vimvarht vimvardict.dv_hashtab
370 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
371 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
372 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
373 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
374 #endif
375 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
376 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
377 static char_u *skip_var_one __ARGS((char_u *arg));
378 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
379 static void list_glob_vars __ARGS((int *first));
380 static void list_buf_vars __ARGS((int *first));
381 static void list_win_vars __ARGS((int *first));
382 #ifdef FEAT_WINDOWS
383 static void list_tab_vars __ARGS((int *first));
384 #endif
385 static void list_vim_vars __ARGS((int *first));
386 static void list_script_vars __ARGS((int *first));
387 static void list_func_vars __ARGS((int *first));
388 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
389 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
390 static int check_changedtick __ARGS((char_u *arg));
391 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
392 static void clear_lval __ARGS((lval_T *lp));
393 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
394 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
395 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
396 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
397 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
398 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
399 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
400 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
401 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
402 static int tv_islocked __ARGS((typval_T *tv));
404 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
405 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
406 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
407 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
408 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
409 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
410 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
411 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
413 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
414 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
415 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
416 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
417 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
418 static int rettv_list_alloc __ARGS((typval_T *rettv));
419 static listitem_T *listitem_alloc __ARGS((void));
420 static void listitem_free __ARGS((listitem_T *item));
421 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
422 static long list_len __ARGS((list_T *l));
423 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
424 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
425 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
426 static listitem_T *list_find __ARGS((list_T *l, long n));
427 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
428 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
429 static void list_append __ARGS((list_T *l, listitem_T *item));
430 static int list_append_tv __ARGS((list_T *l, typval_T *tv));
431 static int list_append_number __ARGS((list_T *l, varnumber_T n));
432 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
433 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
434 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
435 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
436 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
437 static char_u *list2string __ARGS((typval_T *tv, int copyID));
438 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
439 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
440 static void set_ref_in_list __ARGS((list_T *l, int copyID));
441 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
442 static void dict_unref __ARGS((dict_T *d));
443 static void dict_free __ARGS((dict_T *d, int recurse));
444 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
445 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
446 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
447 static void dictitem_free __ARGS((dictitem_T *item));
448 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
449 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
450 static long dict_len __ARGS((dict_T *d));
451 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
452 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
453 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
454 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
455 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
456 static char_u *string_quote __ARGS((char_u *str, int function));
457 #ifdef FEAT_FLOAT
458 static int string2float __ARGS((char_u *text, float_T *value));
459 #endif
460 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
461 static int find_internal_func __ARGS((char_u *name));
462 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
463 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));
464 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));
465 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
466 static int non_zero_arg __ARGS((typval_T *argvars));
468 #ifdef FEAT_FLOAT
469 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
471 /* Below are the 10 added FP functions - I've kept them together */
472 /* here and in their definitions later on. Because the functions[] */
473 /* table must be in ASCII order, they are scattered there - WJMc */
475 static void f_acos __ARGS((typval_T *argvars, typval_T *rettv));
476 static void f_asin __ARGS((typval_T *argvars, typval_T *rettv));
477 static void f_atan2 __ARGS((typval_T *argvars, typval_T *rettv)); /* 2 args */
478 static void f_cosh __ARGS((typval_T *argvars, typval_T *rettv));
479 static void f_exp __ARGS((typval_T *argvars, typval_T *rettv));
480 static void f_fmod __ARGS((typval_T *argvars, typval_T *rettv)); /* 2 args */
481 static void f_log __ARGS((typval_T *argvars, typval_T *rettv));
482 static void f_sinh __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_tan __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_tanh __ARGS((typval_T *argvars, typval_T *rettv));
485 #endif
486 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
491 #ifdef FEAT_FLOAT
492 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
493 #endif
494 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
497 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
498 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
499 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
501 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
502 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
505 #ifdef FEAT_FLOAT
506 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
507 #endif
508 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
509 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
510 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
511 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
513 #if defined(FEAT_INS_EXPAND)
514 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
517 #endif
518 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
520 #ifdef FEAT_FLOAT
521 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
522 #endif
523 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
526 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
530 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
533 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
534 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
537 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
545 #ifdef FEAT_FLOAT
546 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
548 #endif
549 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
608 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
620 #ifdef FEAT_FLOAT
621 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
622 #endif
623 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
626 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
627 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
628 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
629 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
630 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
635 #ifdef vim_mkdir
636 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
637 #endif
638 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
642 #ifdef FEAT_FLOAT
643 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
644 #endif
645 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
662 #ifdef FEAT_FLOAT
663 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
664 #endif
665 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
676 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
677 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
678 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
683 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
684 #ifdef FEAT_FLOAT
685 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
686 #endif
687 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
688 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
691 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
692 #ifdef FEAT_FLOAT
693 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
695 #endif
696 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
697 #ifdef HAVE_STRFTIME
698 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
699 #endif
700 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
723 #ifdef FEAT_FLOAT
724 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
725 #endif
726 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
730 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
731 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
732 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
733 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
734 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
735 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
736 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
737 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
738 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
739 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
741 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
742 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
743 static int get_env_len __ARGS((char_u **arg));
744 static int get_id_len __ARGS((char_u **arg));
745 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
746 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
747 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
748 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
749 valid character */
750 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
751 static int eval_isnamec __ARGS((int c));
752 static int eval_isnamec1 __ARGS((int c));
753 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
754 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
755 static typval_T *alloc_tv __ARGS((void));
756 static typval_T *alloc_string_tv __ARGS((char_u *string));
757 static void init_tv __ARGS((typval_T *varp));
758 static long get_tv_number __ARGS((typval_T *varp));
759 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
760 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
761 static char_u *get_tv_string __ARGS((typval_T *varp));
762 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
763 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
764 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
765 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
766 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
767 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
768 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
769 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
770 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
771 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
772 static int var_check_ro __ARGS((int flags, char_u *name));
773 static int var_check_fixed __ARGS((int flags, char_u *name));
774 static int tv_check_lock __ARGS((int lock, char_u *name));
775 static void copy_tv __ARGS((typval_T *from, typval_T *to));
776 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
777 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
778 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
779 static int eval_fname_script __ARGS((char_u *p));
780 static int eval_fname_sid __ARGS((char_u *p));
781 static void list_func_head __ARGS((ufunc_T *fp, int indent));
782 static ufunc_T *find_func __ARGS((char_u *name));
783 static int function_exists __ARGS((char_u *name));
784 static int builtin_function __ARGS((char_u *name));
785 #ifdef FEAT_PROFILE
786 static void func_do_profile __ARGS((ufunc_T *fp));
787 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
788 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
789 static int
790 # ifdef __BORLANDC__
791 _RTLENTRYF
792 # endif
793 prof_total_cmp __ARGS((const void *s1, const void *s2));
794 static int
795 # ifdef __BORLANDC__
796 _RTLENTRYF
797 # endif
798 prof_self_cmp __ARGS((const void *s1, const void *s2));
799 #endif
800 static int script_autoload __ARGS((char_u *name, int reload));
801 static char_u *autoload_name __ARGS((char_u *name));
802 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
803 static void func_free __ARGS((ufunc_T *fp));
804 static void func_unref __ARGS((char_u *name));
805 static void func_ref __ARGS((char_u *name));
806 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));
807 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
808 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
809 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
810 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
811 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
812 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
814 /* Character used as separated in autoload function/variable names. */
815 #define AUTOLOAD_CHAR '#'
818 * Initialize the global and v: variables.
820 void
821 eval_init()
823 int i;
824 struct vimvar *p;
826 init_var_dict(&globvardict, &globvars_var);
827 init_var_dict(&vimvardict, &vimvars_var);
828 hash_init(&compat_hashtab);
829 hash_init(&func_hashtab);
831 for (i = 0; i < VV_LEN; ++i)
833 p = &vimvars[i];
834 STRCPY(p->vv_di.di_key, p->vv_name);
835 if (p->vv_flags & VV_RO)
836 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
837 else if (p->vv_flags & VV_RO_SBX)
838 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
839 else
840 p->vv_di.di_flags = DI_FLAGS_FIX;
842 /* add to v: scope dict, unless the value is not always available */
843 if (p->vv_type != VAR_UNKNOWN)
844 hash_add(&vimvarht, p->vv_di.di_key);
845 if (p->vv_flags & VV_COMPAT)
846 /* add to compat scope dict */
847 hash_add(&compat_hashtab, p->vv_di.di_key);
849 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
852 #if defined(EXITFREE) || defined(PROTO)
853 void
854 eval_clear()
856 int i;
857 struct vimvar *p;
859 for (i = 0; i < VV_LEN; ++i)
861 p = &vimvars[i];
862 if (p->vv_di.di_tv.v_type == VAR_STRING)
864 vim_free(p->vv_str);
865 p->vv_str = NULL;
867 else if (p->vv_di.di_tv.v_type == VAR_LIST)
869 list_unref(p->vv_list);
870 p->vv_list = NULL;
873 hash_clear(&vimvarht);
874 hash_init(&vimvarht); /* garbage_collect() will access it */
875 hash_clear(&compat_hashtab);
877 /* script-local variables */
878 for (i = 1; i <= ga_scripts.ga_len; ++i)
879 vars_clear(&SCRIPT_VARS(i));
880 ga_clear(&ga_scripts);
881 free_scriptnames();
883 /* global variables */
884 vars_clear(&globvarht);
886 /* autoloaded script names */
887 ga_clear_strings(&ga_loaded);
889 /* unreferenced lists and dicts */
890 (void)garbage_collect();
892 /* functions */
893 free_all_functions();
894 hash_clear(&func_hashtab);
896 #endif
899 * Return the name of the executed function.
901 char_u *
902 func_name(cookie)
903 void *cookie;
905 return ((funccall_T *)cookie)->func->uf_name;
909 * Return the address holding the next breakpoint line for a funccall cookie.
911 linenr_T *
912 func_breakpoint(cookie)
913 void *cookie;
915 return &((funccall_T *)cookie)->breakpoint;
919 * Return the address holding the debug tick for a funccall cookie.
921 int *
922 func_dbg_tick(cookie)
923 void *cookie;
925 return &((funccall_T *)cookie)->dbg_tick;
929 * Return the nesting level for a funccall cookie.
932 func_level(cookie)
933 void *cookie;
935 return ((funccall_T *)cookie)->level;
938 /* pointer to funccal for currently active function */
939 funccall_T *current_funccal = NULL;
942 * Return TRUE when a function was ended by a ":return" command.
945 current_func_returned()
947 return current_funccal->returned;
952 * Set an internal variable to a string value. Creates the variable if it does
953 * not already exist.
955 void
956 set_internal_string_var(name, value)
957 char_u *name;
958 char_u *value;
960 char_u *val;
961 typval_T *tvp;
963 val = vim_strsave(value);
964 if (val != NULL)
966 tvp = alloc_string_tv(val);
967 if (tvp != NULL)
969 set_var(name, tvp, FALSE);
970 free_tv(tvp);
975 static lval_T *redir_lval = NULL;
976 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
977 static char_u *redir_endp = NULL;
978 static char_u *redir_varname = NULL;
981 * Start recording command output to a variable
982 * Returns OK if successfully completed the setup. FAIL otherwise.
985 var_redir_start(name, append)
986 char_u *name;
987 int append; /* append to an existing variable */
989 int save_emsg;
990 int err;
991 typval_T tv;
993 /* Make sure a valid variable name is specified */
994 if (!eval_isnamec1(*name))
996 EMSG(_(e_invarg));
997 return FAIL;
1000 redir_varname = vim_strsave(name);
1001 if (redir_varname == NULL)
1002 return FAIL;
1004 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1005 if (redir_lval == NULL)
1007 var_redir_stop();
1008 return FAIL;
1011 /* The output is stored in growarray "redir_ga" until redirection ends. */
1012 ga_init2(&redir_ga, (int)sizeof(char), 500);
1014 /* Parse the variable name (can be a dict or list entry). */
1015 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1016 FNE_CHECK_START);
1017 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1019 if (redir_endp != NULL && *redir_endp != NUL)
1020 /* Trailing characters are present after the variable name */
1021 EMSG(_(e_trailing));
1022 else
1023 EMSG(_(e_invarg));
1024 var_redir_stop();
1025 return FAIL;
1028 /* check if we can write to the variable: set it to or append an empty
1029 * string */
1030 save_emsg = did_emsg;
1031 did_emsg = FALSE;
1032 tv.v_type = VAR_STRING;
1033 tv.vval.v_string = (char_u *)"";
1034 if (append)
1035 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1036 else
1037 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1038 err = did_emsg;
1039 did_emsg |= save_emsg;
1040 if (err)
1042 var_redir_stop();
1043 return FAIL;
1045 if (redir_lval->ll_newkey != NULL)
1047 /* Dictionary item was created, don't do it again. */
1048 vim_free(redir_lval->ll_newkey);
1049 redir_lval->ll_newkey = NULL;
1052 return OK;
1056 * Append "value[value_len]" to the variable set by var_redir_start().
1057 * The actual appending is postponed until redirection ends, because the value
1058 * appended may in fact be the string we write to, changing it may cause freed
1059 * memory to be used:
1060 * :redir => foo
1061 * :let foo
1062 * :redir END
1064 void
1065 var_redir_str(value, value_len)
1066 char_u *value;
1067 int value_len;
1069 int len;
1071 if (redir_lval == NULL)
1072 return;
1074 if (value_len == -1)
1075 len = (int)STRLEN(value); /* Append the entire string */
1076 else
1077 len = value_len; /* Append only "value_len" characters */
1079 if (ga_grow(&redir_ga, len) == OK)
1081 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1082 redir_ga.ga_len += len;
1084 else
1085 var_redir_stop();
1089 * Stop redirecting command output to a variable.
1091 void
1092 var_redir_stop()
1094 typval_T tv;
1096 if (redir_lval != NULL)
1098 /* Append the trailing NUL. */
1099 ga_append(&redir_ga, NUL);
1101 /* Assign the text to the variable. */
1102 tv.v_type = VAR_STRING;
1103 tv.vval.v_string = redir_ga.ga_data;
1104 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1105 vim_free(tv.vval.v_string);
1107 clear_lval(redir_lval);
1108 vim_free(redir_lval);
1109 redir_lval = NULL;
1111 vim_free(redir_varname);
1112 redir_varname = NULL;
1115 # if defined(FEAT_MBYTE) || defined(PROTO)
1117 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1118 char_u *enc_from;
1119 char_u *enc_to;
1120 char_u *fname_from;
1121 char_u *fname_to;
1123 int err = FALSE;
1125 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1126 set_vim_var_string(VV_CC_TO, enc_to, -1);
1127 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1128 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1129 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1130 err = TRUE;
1131 set_vim_var_string(VV_CC_FROM, NULL, -1);
1132 set_vim_var_string(VV_CC_TO, NULL, -1);
1133 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1134 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1136 if (err)
1137 return FAIL;
1138 return OK;
1140 # endif
1142 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1144 eval_printexpr(fname, args)
1145 char_u *fname;
1146 char_u *args;
1148 int err = FALSE;
1150 set_vim_var_string(VV_FNAME_IN, fname, -1);
1151 set_vim_var_string(VV_CMDARG, args, -1);
1152 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1153 err = TRUE;
1154 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1155 set_vim_var_string(VV_CMDARG, NULL, -1);
1157 if (err)
1159 mch_remove(fname);
1160 return FAIL;
1162 return OK;
1164 # endif
1166 # if defined(FEAT_DIFF) || defined(PROTO)
1167 void
1168 eval_diff(origfile, newfile, outfile)
1169 char_u *origfile;
1170 char_u *newfile;
1171 char_u *outfile;
1173 int err = FALSE;
1175 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1176 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1177 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1178 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1179 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1180 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1181 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1184 void
1185 eval_patch(origfile, difffile, outfile)
1186 char_u *origfile;
1187 char_u *difffile;
1188 char_u *outfile;
1190 int err;
1192 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1193 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1194 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1195 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1196 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1197 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1198 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1200 # endif
1203 * Top level evaluation function, returning a boolean.
1204 * Sets "error" to TRUE if there was an error.
1205 * Return TRUE or FALSE.
1208 eval_to_bool(arg, error, nextcmd, skip)
1209 char_u *arg;
1210 int *error;
1211 char_u **nextcmd;
1212 int skip; /* only parse, don't execute */
1214 typval_T tv;
1215 int retval = FALSE;
1217 if (skip)
1218 ++emsg_skip;
1219 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1220 *error = TRUE;
1221 else
1223 *error = FALSE;
1224 if (!skip)
1226 retval = (get_tv_number_chk(&tv, error) != 0);
1227 clear_tv(&tv);
1230 if (skip)
1231 --emsg_skip;
1233 return retval;
1237 * Top level evaluation function, returning a string. If "skip" is TRUE,
1238 * only parsing to "nextcmd" is done, without reporting errors. Return
1239 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1241 char_u *
1242 eval_to_string_skip(arg, nextcmd, skip)
1243 char_u *arg;
1244 char_u **nextcmd;
1245 int skip; /* only parse, don't execute */
1247 typval_T tv;
1248 char_u *retval;
1250 if (skip)
1251 ++emsg_skip;
1252 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1253 retval = NULL;
1254 else
1256 retval = vim_strsave(get_tv_string(&tv));
1257 clear_tv(&tv);
1259 if (skip)
1260 --emsg_skip;
1262 return retval;
1266 * Skip over an expression at "*pp".
1267 * Return FAIL for an error, OK otherwise.
1270 skip_expr(pp)
1271 char_u **pp;
1273 typval_T rettv;
1275 *pp = skipwhite(*pp);
1276 return eval1(pp, &rettv, FALSE);
1280 * Top level evaluation function, returning a string.
1281 * When "convert" is TRUE convert a List into a sequence of lines and convert
1282 * a Float to a String.
1283 * Return pointer to allocated memory, or NULL for failure.
1285 char_u *
1286 eval_to_string(arg, nextcmd, convert)
1287 char_u *arg;
1288 char_u **nextcmd;
1289 int convert;
1291 typval_T tv;
1292 char_u *retval;
1293 garray_T ga;
1294 char_u numbuf[NUMBUFLEN];
1296 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1297 retval = NULL;
1298 else
1300 if (convert && tv.v_type == VAR_LIST)
1302 ga_init2(&ga, (int)sizeof(char), 80);
1303 if (tv.vval.v_list != NULL)
1304 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1305 ga_append(&ga, NUL);
1306 retval = (char_u *)ga.ga_data;
1308 #ifdef FEAT_FLOAT
1309 else if (convert && tv.v_type == VAR_FLOAT)
1311 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1312 retval = vim_strsave(numbuf);
1314 #endif
1315 else
1316 retval = vim_strsave(get_tv_string(&tv));
1317 clear_tv(&tv);
1320 return retval;
1324 * Call eval_to_string() without using current local variables and using
1325 * textlock. When "use_sandbox" is TRUE use the sandbox.
1327 char_u *
1328 eval_to_string_safe(arg, nextcmd, use_sandbox)
1329 char_u *arg;
1330 char_u **nextcmd;
1331 int use_sandbox;
1333 char_u *retval;
1334 void *save_funccalp;
1336 save_funccalp = save_funccal();
1337 if (use_sandbox)
1338 ++sandbox;
1339 ++textlock;
1340 retval = eval_to_string(arg, nextcmd, FALSE);
1341 if (use_sandbox)
1342 --sandbox;
1343 --textlock;
1344 restore_funccal(save_funccalp);
1345 return retval;
1349 * Top level evaluation function, returning a number.
1350 * Evaluates "expr" silently.
1351 * Returns -1 for an error.
1354 eval_to_number(expr)
1355 char_u *expr;
1357 typval_T rettv;
1358 int retval;
1359 char_u *p = skipwhite(expr);
1361 ++emsg_off;
1363 if (eval1(&p, &rettv, TRUE) == FAIL)
1364 retval = -1;
1365 else
1367 retval = get_tv_number_chk(&rettv, NULL);
1368 clear_tv(&rettv);
1370 --emsg_off;
1372 return retval;
1376 * Prepare v: variable "idx" to be used.
1377 * Save the current typeval in "save_tv".
1378 * When not used yet add the variable to the v: hashtable.
1380 static void
1381 prepare_vimvar(idx, save_tv)
1382 int idx;
1383 typval_T *save_tv;
1385 *save_tv = vimvars[idx].vv_tv;
1386 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1387 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1391 * Restore v: variable "idx" to typeval "save_tv".
1392 * When no longer defined, remove the variable from the v: hashtable.
1394 static void
1395 restore_vimvar(idx, save_tv)
1396 int idx;
1397 typval_T *save_tv;
1399 hashitem_T *hi;
1401 vimvars[idx].vv_tv = *save_tv;
1402 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1404 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1405 if (HASHITEM_EMPTY(hi))
1406 EMSG2(_(e_intern2), "restore_vimvar()");
1407 else
1408 hash_remove(&vimvarht, hi);
1412 #if defined(FEAT_SPELL) || defined(PROTO)
1414 * Evaluate an expression to a list with suggestions.
1415 * For the "expr:" part of 'spellsuggest'.
1416 * Returns NULL when there is an error.
1418 list_T *
1419 eval_spell_expr(badword, expr)
1420 char_u *badword;
1421 char_u *expr;
1423 typval_T save_val;
1424 typval_T rettv;
1425 list_T *list = NULL;
1426 char_u *p = skipwhite(expr);
1428 /* Set "v:val" to the bad word. */
1429 prepare_vimvar(VV_VAL, &save_val);
1430 vimvars[VV_VAL].vv_type = VAR_STRING;
1431 vimvars[VV_VAL].vv_str = badword;
1432 if (p_verbose == 0)
1433 ++emsg_off;
1435 if (eval1(&p, &rettv, TRUE) == OK)
1437 if (rettv.v_type != VAR_LIST)
1438 clear_tv(&rettv);
1439 else
1440 list = rettv.vval.v_list;
1443 if (p_verbose == 0)
1444 --emsg_off;
1445 restore_vimvar(VV_VAL, &save_val);
1447 return list;
1451 * "list" is supposed to contain two items: a word and a number. Return the
1452 * word in "pp" and the number as the return value.
1453 * Return -1 if anything isn't right.
1454 * Used to get the good word and score from the eval_spell_expr() result.
1457 get_spellword(list, pp)
1458 list_T *list;
1459 char_u **pp;
1461 listitem_T *li;
1463 li = list->lv_first;
1464 if (li == NULL)
1465 return -1;
1466 *pp = get_tv_string(&li->li_tv);
1468 li = li->li_next;
1469 if (li == NULL)
1470 return -1;
1471 return get_tv_number(&li->li_tv);
1473 #endif
1476 * Top level evaluation function.
1477 * Returns an allocated typval_T with the result.
1478 * Returns NULL when there is an error.
1480 typval_T *
1481 eval_expr(arg, nextcmd)
1482 char_u *arg;
1483 char_u **nextcmd;
1485 typval_T *tv;
1487 tv = (typval_T *)alloc(sizeof(typval_T));
1488 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1490 vim_free(tv);
1491 tv = NULL;
1494 return tv;
1498 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1499 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1501 * Call some vimL function and return the result in "*rettv".
1502 * Uses argv[argc] for the function arguments. Only Number and String
1503 * arguments are currently supported.
1504 * Returns OK or FAIL.
1506 static int
1507 call_vim_function(func, argc, argv, safe, rettv)
1508 char_u *func;
1509 int argc;
1510 char_u **argv;
1511 int safe; /* use the sandbox */
1512 typval_T *rettv;
1514 typval_T *argvars;
1515 long n;
1516 int len;
1517 int i;
1518 int doesrange;
1519 void *save_funccalp = NULL;
1520 int ret;
1522 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1523 if (argvars == NULL)
1524 return FAIL;
1526 for (i = 0; i < argc; i++)
1528 /* Pass a NULL or empty argument as an empty string */
1529 if (argv[i] == NULL || *argv[i] == NUL)
1531 argvars[i].v_type = VAR_STRING;
1532 argvars[i].vval.v_string = (char_u *)"";
1533 continue;
1536 /* Recognize a number argument, the others must be strings. */
1537 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1538 if (len != 0 && len == (int)STRLEN(argv[i]))
1540 argvars[i].v_type = VAR_NUMBER;
1541 argvars[i].vval.v_number = n;
1543 else
1545 argvars[i].v_type = VAR_STRING;
1546 argvars[i].vval.v_string = argv[i];
1550 if (safe)
1552 save_funccalp = save_funccal();
1553 ++sandbox;
1556 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1557 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1558 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1559 &doesrange, TRUE, NULL);
1560 if (safe)
1562 --sandbox;
1563 restore_funccal(save_funccalp);
1565 vim_free(argvars);
1567 if (ret == FAIL)
1568 clear_tv(rettv);
1570 return ret;
1573 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1575 * Call vimL function "func" and return the result as a string.
1576 * Returns NULL when calling the function fails.
1577 * Uses argv[argc] for the function arguments.
1579 void *
1580 call_func_retstr(func, argc, argv, safe)
1581 char_u *func;
1582 int argc;
1583 char_u **argv;
1584 int safe; /* use the sandbox */
1586 typval_T rettv;
1587 char_u *retval;
1589 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1590 return NULL;
1592 retval = vim_strsave(get_tv_string(&rettv));
1593 clear_tv(&rettv);
1594 return retval;
1596 # endif
1598 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1600 * Call vimL function "func" and return the result as a number.
1601 * Returns -1 when calling the function fails.
1602 * Uses argv[argc] for the function arguments.
1604 long
1605 call_func_retnr(func, argc, argv, safe)
1606 char_u *func;
1607 int argc;
1608 char_u **argv;
1609 int safe; /* use the sandbox */
1611 typval_T rettv;
1612 long retval;
1614 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1615 return -1;
1617 retval = get_tv_number_chk(&rettv, NULL);
1618 clear_tv(&rettv);
1619 return retval;
1621 # endif
1624 * Call vimL function "func" and return the result as a List.
1625 * Uses argv[argc] for the function arguments.
1626 * Returns NULL when there is something wrong.
1628 void *
1629 call_func_retlist(func, argc, argv, safe)
1630 char_u *func;
1631 int argc;
1632 char_u **argv;
1633 int safe; /* use the sandbox */
1635 typval_T rettv;
1637 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1638 return NULL;
1640 if (rettv.v_type != VAR_LIST)
1642 clear_tv(&rettv);
1643 return NULL;
1646 return rettv.vval.v_list;
1648 #endif
1652 * Save the current function call pointer, and set it to NULL.
1653 * Used when executing autocommands and for ":source".
1655 void *
1656 save_funccal()
1658 funccall_T *fc = current_funccal;
1660 current_funccal = NULL;
1661 return (void *)fc;
1664 void
1665 restore_funccal(vfc)
1666 void *vfc;
1668 funccall_T *fc = (funccall_T *)vfc;
1670 current_funccal = fc;
1673 #if defined(FEAT_PROFILE) || defined(PROTO)
1675 * Prepare profiling for entering a child or something else that is not
1676 * counted for the script/function itself.
1677 * Should always be called in pair with prof_child_exit().
1679 void
1680 prof_child_enter(tm)
1681 proftime_T *tm; /* place to store waittime */
1683 funccall_T *fc = current_funccal;
1685 if (fc != NULL && fc->func->uf_profiling)
1686 profile_start(&fc->prof_child);
1687 script_prof_save(tm);
1691 * Take care of time spent in a child.
1692 * Should always be called after prof_child_enter().
1694 void
1695 prof_child_exit(tm)
1696 proftime_T *tm; /* where waittime was stored */
1698 funccall_T *fc = current_funccal;
1700 if (fc != NULL && fc->func->uf_profiling)
1702 profile_end(&fc->prof_child);
1703 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1704 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1705 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1707 script_prof_restore(tm);
1709 #endif
1712 #ifdef FEAT_FOLDING
1714 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1715 * it in "*cp". Doesn't give error messages.
1718 eval_foldexpr(arg, cp)
1719 char_u *arg;
1720 int *cp;
1722 typval_T tv;
1723 int retval;
1724 char_u *s;
1725 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1726 OPT_LOCAL);
1728 ++emsg_off;
1729 if (use_sandbox)
1730 ++sandbox;
1731 ++textlock;
1732 *cp = NUL;
1733 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1734 retval = 0;
1735 else
1737 /* If the result is a number, just return the number. */
1738 if (tv.v_type == VAR_NUMBER)
1739 retval = tv.vval.v_number;
1740 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1741 retval = 0;
1742 else
1744 /* If the result is a string, check if there is a non-digit before
1745 * the number. */
1746 s = tv.vval.v_string;
1747 if (!VIM_ISDIGIT(*s) && *s != '-')
1748 *cp = *s++;
1749 retval = atol((char *)s);
1751 clear_tv(&tv);
1753 --emsg_off;
1754 if (use_sandbox)
1755 --sandbox;
1756 --textlock;
1758 return retval;
1760 #endif
1763 * ":let" list all variable values
1764 * ":let var1 var2" list variable values
1765 * ":let var = expr" assignment command.
1766 * ":let var += expr" assignment command.
1767 * ":let var -= expr" assignment command.
1768 * ":let var .= expr" assignment command.
1769 * ":let [var1, var2] = expr" unpack list.
1771 void
1772 ex_let(eap)
1773 exarg_T *eap;
1775 char_u *arg = eap->arg;
1776 char_u *expr = NULL;
1777 typval_T rettv;
1778 int i;
1779 int var_count = 0;
1780 int semicolon = 0;
1781 char_u op[2];
1782 char_u *argend;
1783 int first = TRUE;
1785 argend = skip_var_list(arg, &var_count, &semicolon);
1786 if (argend == NULL)
1787 return;
1788 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1789 --argend;
1790 expr = vim_strchr(argend, '=');
1791 if (expr == NULL)
1794 * ":let" without "=": list variables
1796 if (*arg == '[')
1797 EMSG(_(e_invarg));
1798 else if (!ends_excmd(*arg))
1799 /* ":let var1 var2" */
1800 arg = list_arg_vars(eap, arg, &first);
1801 else if (!eap->skip)
1803 /* ":let" */
1804 list_glob_vars(&first);
1805 list_buf_vars(&first);
1806 list_win_vars(&first);
1807 #ifdef FEAT_WINDOWS
1808 list_tab_vars(&first);
1809 #endif
1810 list_script_vars(&first);
1811 list_func_vars(&first);
1812 list_vim_vars(&first);
1814 eap->nextcmd = check_nextcmd(arg);
1816 else
1818 op[0] = '=';
1819 op[1] = NUL;
1820 if (expr > argend)
1822 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1823 op[0] = expr[-1]; /* +=, -= or .= */
1825 expr = skipwhite(expr + 1);
1827 if (eap->skip)
1828 ++emsg_skip;
1829 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1830 if (eap->skip)
1832 if (i != FAIL)
1833 clear_tv(&rettv);
1834 --emsg_skip;
1836 else if (i != FAIL)
1838 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1839 op);
1840 clear_tv(&rettv);
1846 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1847 * Handles both "var" with any type and "[var, var; var]" with a list type.
1848 * When "nextchars" is not NULL it points to a string with characters that
1849 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1850 * or concatenate.
1851 * Returns OK or FAIL;
1853 static int
1854 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1855 char_u *arg_start;
1856 typval_T *tv;
1857 int copy; /* copy values from "tv", don't move */
1858 int semicolon; /* from skip_var_list() */
1859 int var_count; /* from skip_var_list() */
1860 char_u *nextchars;
1862 char_u *arg = arg_start;
1863 list_T *l;
1864 int i;
1865 listitem_T *item;
1866 typval_T ltv;
1868 if (*arg != '[')
1871 * ":let var = expr" or ":for var in list"
1873 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1874 return FAIL;
1875 return OK;
1879 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1881 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1883 EMSG(_(e_listreq));
1884 return FAIL;
1887 i = list_len(l);
1888 if (semicolon == 0 && var_count < i)
1890 EMSG(_("E687: Less targets than List items"));
1891 return FAIL;
1893 if (var_count - semicolon > i)
1895 EMSG(_("E688: More targets than List items"));
1896 return FAIL;
1899 item = l->lv_first;
1900 while (*arg != ']')
1902 arg = skipwhite(arg + 1);
1903 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1904 item = item->li_next;
1905 if (arg == NULL)
1906 return FAIL;
1908 arg = skipwhite(arg);
1909 if (*arg == ';')
1911 /* Put the rest of the list (may be empty) in the var after ';'.
1912 * Create a new list for this. */
1913 l = list_alloc();
1914 if (l == NULL)
1915 return FAIL;
1916 while (item != NULL)
1918 list_append_tv(l, &item->li_tv);
1919 item = item->li_next;
1922 ltv.v_type = VAR_LIST;
1923 ltv.v_lock = 0;
1924 ltv.vval.v_list = l;
1925 l->lv_refcount = 1;
1927 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1928 (char_u *)"]", nextchars);
1929 clear_tv(&ltv);
1930 if (arg == NULL)
1931 return FAIL;
1932 break;
1934 else if (*arg != ',' && *arg != ']')
1936 EMSG2(_(e_intern2), "ex_let_vars()");
1937 return FAIL;
1941 return OK;
1945 * Skip over assignable variable "var" or list of variables "[var, var]".
1946 * Used for ":let varvar = expr" and ":for varvar in expr".
1947 * For "[var, var]" increment "*var_count" for each variable.
1948 * for "[var, var; var]" set "semicolon".
1949 * Return NULL for an error.
1951 static char_u *
1952 skip_var_list(arg, var_count, semicolon)
1953 char_u *arg;
1954 int *var_count;
1955 int *semicolon;
1957 char_u *p, *s;
1959 if (*arg == '[')
1961 /* "[var, var]": find the matching ']'. */
1962 p = arg;
1963 for (;;)
1965 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1966 s = skip_var_one(p);
1967 if (s == p)
1969 EMSG2(_(e_invarg2), p);
1970 return NULL;
1972 ++*var_count;
1974 p = skipwhite(s);
1975 if (*p == ']')
1976 break;
1977 else if (*p == ';')
1979 if (*semicolon == 1)
1981 EMSG(_("Double ; in list of variables"));
1982 return NULL;
1984 *semicolon = 1;
1986 else if (*p != ',')
1988 EMSG2(_(e_invarg2), p);
1989 return NULL;
1992 return p + 1;
1994 else
1995 return skip_var_one(arg);
1999 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2000 * l[idx].
2002 static char_u *
2003 skip_var_one(arg)
2004 char_u *arg;
2006 if (*arg == '@' && arg[1] != NUL)
2007 return arg + 2;
2008 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2009 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2013 * List variables for hashtab "ht" with prefix "prefix".
2014 * If "empty" is TRUE also list NULL strings as empty strings.
2016 static void
2017 list_hashtable_vars(ht, prefix, empty, first)
2018 hashtab_T *ht;
2019 char_u *prefix;
2020 int empty;
2021 int *first;
2023 hashitem_T *hi;
2024 dictitem_T *di;
2025 int todo;
2027 todo = (int)ht->ht_used;
2028 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2030 if (!HASHITEM_EMPTY(hi))
2032 --todo;
2033 di = HI2DI(hi);
2034 if (empty || di->di_tv.v_type != VAR_STRING
2035 || di->di_tv.vval.v_string != NULL)
2036 list_one_var(di, prefix, first);
2042 * List global variables.
2044 static void
2045 list_glob_vars(first)
2046 int *first;
2048 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2052 * List buffer variables.
2054 static void
2055 list_buf_vars(first)
2056 int *first;
2058 char_u numbuf[NUMBUFLEN];
2060 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2061 TRUE, first);
2063 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2064 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2065 numbuf, first);
2069 * List window variables.
2071 static void
2072 list_win_vars(first)
2073 int *first;
2075 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2076 (char_u *)"w:", TRUE, first);
2079 #ifdef FEAT_WINDOWS
2081 * List tab page variables.
2083 static void
2084 list_tab_vars(first)
2085 int *first;
2087 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2088 (char_u *)"t:", TRUE, first);
2090 #endif
2093 * List Vim variables.
2095 static void
2096 list_vim_vars(first)
2097 int *first;
2099 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2103 * List script-local variables, if there is a script.
2105 static void
2106 list_script_vars(first)
2107 int *first;
2109 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2110 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2111 (char_u *)"s:", FALSE, first);
2115 * List function variables, if there is a function.
2117 static void
2118 list_func_vars(first)
2119 int *first;
2121 if (current_funccal != NULL)
2122 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2123 (char_u *)"l:", FALSE, first);
2127 * List variables in "arg".
2129 static char_u *
2130 list_arg_vars(eap, arg, first)
2131 exarg_T *eap;
2132 char_u *arg;
2133 int *first;
2135 int error = FALSE;
2136 int len;
2137 char_u *name;
2138 char_u *name_start;
2139 char_u *arg_subsc;
2140 char_u *tofree;
2141 typval_T tv;
2143 while (!ends_excmd(*arg) && !got_int)
2145 if (error || eap->skip)
2147 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2148 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2150 emsg_severe = TRUE;
2151 EMSG(_(e_trailing));
2152 break;
2155 else
2157 /* get_name_len() takes care of expanding curly braces */
2158 name_start = name = arg;
2159 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2160 if (len <= 0)
2162 /* This is mainly to keep test 49 working: when expanding
2163 * curly braces fails overrule the exception error message. */
2164 if (len < 0 && !aborting())
2166 emsg_severe = TRUE;
2167 EMSG2(_(e_invarg2), arg);
2168 break;
2170 error = TRUE;
2172 else
2174 if (tofree != NULL)
2175 name = tofree;
2176 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2177 error = TRUE;
2178 else
2180 /* handle d.key, l[idx], f(expr) */
2181 arg_subsc = arg;
2182 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2183 error = TRUE;
2184 else
2186 if (arg == arg_subsc && len == 2 && name[1] == ':')
2188 switch (*name)
2190 case 'g': list_glob_vars(first); break;
2191 case 'b': list_buf_vars(first); break;
2192 case 'w': list_win_vars(first); break;
2193 #ifdef FEAT_WINDOWS
2194 case 't': list_tab_vars(first); break;
2195 #endif
2196 case 'v': list_vim_vars(first); break;
2197 case 's': list_script_vars(first); break;
2198 case 'l': list_func_vars(first); break;
2199 default:
2200 EMSG2(_("E738: Can't list variables for %s"), name);
2203 else
2205 char_u numbuf[NUMBUFLEN];
2206 char_u *tf;
2207 int c;
2208 char_u *s;
2210 s = echo_string(&tv, &tf, numbuf, 0);
2211 c = *arg;
2212 *arg = NUL;
2213 list_one_var_a((char_u *)"",
2214 arg == arg_subsc ? name : name_start,
2215 tv.v_type,
2216 s == NULL ? (char_u *)"" : s,
2217 first);
2218 *arg = c;
2219 vim_free(tf);
2221 clear_tv(&tv);
2226 vim_free(tofree);
2229 arg = skipwhite(arg);
2232 return arg;
2236 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2237 * Returns a pointer to the char just after the var name.
2238 * Returns NULL if there is an error.
2240 static char_u *
2241 ex_let_one(arg, tv, copy, endchars, op)
2242 char_u *arg; /* points to variable name */
2243 typval_T *tv; /* value to assign to variable */
2244 int copy; /* copy value from "tv" */
2245 char_u *endchars; /* valid chars after variable name or NULL */
2246 char_u *op; /* "+", "-", "." or NULL*/
2248 int c1;
2249 char_u *name;
2250 char_u *p;
2251 char_u *arg_end = NULL;
2252 int len;
2253 int opt_flags;
2254 char_u *tofree = NULL;
2257 * ":let $VAR = expr": Set environment variable.
2259 if (*arg == '$')
2261 /* Find the end of the name. */
2262 ++arg;
2263 name = arg;
2264 len = get_env_len(&arg);
2265 if (len == 0)
2266 EMSG2(_(e_invarg2), name - 1);
2267 else
2269 if (op != NULL && (*op == '+' || *op == '-'))
2270 EMSG2(_(e_letwrong), op);
2271 else if (endchars != NULL
2272 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2273 EMSG(_(e_letunexp));
2274 else
2276 c1 = name[len];
2277 name[len] = NUL;
2278 p = get_tv_string_chk(tv);
2279 if (p != NULL && op != NULL && *op == '.')
2281 int mustfree = FALSE;
2282 char_u *s = vim_getenv(name, &mustfree);
2284 if (s != NULL)
2286 p = tofree = concat_str(s, p);
2287 if (mustfree)
2288 vim_free(s);
2291 if (p != NULL)
2293 vim_setenv(name, p);
2294 if (STRICMP(name, "HOME") == 0)
2295 init_homedir();
2296 else if (didset_vim && STRICMP(name, "VIM") == 0)
2297 didset_vim = FALSE;
2298 else if (didset_vimruntime
2299 && STRICMP(name, "VIMRUNTIME") == 0)
2300 didset_vimruntime = FALSE;
2301 arg_end = arg;
2303 name[len] = c1;
2304 vim_free(tofree);
2310 * ":let &option = expr": Set option value.
2311 * ":let &l:option = expr": Set local option value.
2312 * ":let &g:option = expr": Set global option value.
2314 else if (*arg == '&')
2316 /* Find the end of the name. */
2317 p = find_option_end(&arg, &opt_flags);
2318 if (p == NULL || (endchars != NULL
2319 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2320 EMSG(_(e_letunexp));
2321 else
2323 long n;
2324 int opt_type;
2325 long numval;
2326 char_u *stringval = NULL;
2327 char_u *s;
2329 c1 = *p;
2330 *p = NUL;
2332 n = get_tv_number(tv);
2333 s = get_tv_string_chk(tv); /* != NULL if number or string */
2334 if (s != NULL && op != NULL && *op != '=')
2336 opt_type = get_option_value(arg, &numval,
2337 &stringval, opt_flags);
2338 if ((opt_type == 1 && *op == '.')
2339 || (opt_type == 0 && *op != '.'))
2340 EMSG2(_(e_letwrong), op);
2341 else
2343 if (opt_type == 1) /* number */
2345 if (*op == '+')
2346 n = numval + n;
2347 else
2348 n = numval - n;
2350 else if (opt_type == 0 && stringval != NULL) /* string */
2352 s = concat_str(stringval, s);
2353 vim_free(stringval);
2354 stringval = s;
2358 if (s != NULL)
2360 set_option_value(arg, n, s, opt_flags);
2361 arg_end = p;
2363 *p = c1;
2364 vim_free(stringval);
2369 * ":let @r = expr": Set register contents.
2371 else if (*arg == '@')
2373 ++arg;
2374 if (op != NULL && (*op == '+' || *op == '-'))
2375 EMSG2(_(e_letwrong), op);
2376 else if (endchars != NULL
2377 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2378 EMSG(_(e_letunexp));
2379 else
2381 char_u *ptofree = NULL;
2382 char_u *s;
2384 p = get_tv_string_chk(tv);
2385 if (p != NULL && op != NULL && *op == '.')
2387 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2388 if (s != NULL)
2390 p = ptofree = concat_str(s, p);
2391 vim_free(s);
2394 if (p != NULL)
2396 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2397 arg_end = arg + 1;
2399 vim_free(ptofree);
2404 * ":let var = expr": Set internal variable.
2405 * ":let {expr} = expr": Idem, name made with curly braces
2407 else if (eval_isnamec1(*arg) || *arg == '{')
2409 lval_T lv;
2411 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2412 if (p != NULL && lv.ll_name != NULL)
2414 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2415 EMSG(_(e_letunexp));
2416 else
2418 set_var_lval(&lv, p, tv, copy, op);
2419 arg_end = p;
2422 clear_lval(&lv);
2425 else
2426 EMSG2(_(e_invarg2), arg);
2428 return arg_end;
2432 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2434 static int
2435 check_changedtick(arg)
2436 char_u *arg;
2438 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2440 EMSG2(_(e_readonlyvar), arg);
2441 return TRUE;
2443 return FALSE;
2447 * Get an lval: variable, Dict item or List item that can be assigned a value
2448 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2449 * "name.key", "name.key[expr]" etc.
2450 * Indexing only works if "name" is an existing List or Dictionary.
2451 * "name" points to the start of the name.
2452 * If "rettv" is not NULL it points to the value to be assigned.
2453 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2454 * wrong; must end in space or cmd separator.
2456 * Returns a pointer to just after the name, including indexes.
2457 * When an evaluation error occurs "lp->ll_name" is NULL;
2458 * Returns NULL for a parsing error. Still need to free items in "lp"!
2460 static char_u *
2461 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2462 char_u *name;
2463 typval_T *rettv;
2464 lval_T *lp;
2465 int unlet;
2466 int skip;
2467 int quiet; /* don't give error messages */
2468 int fne_flags; /* flags for find_name_end() */
2470 char_u *p;
2471 char_u *expr_start, *expr_end;
2472 int cc;
2473 dictitem_T *v;
2474 typval_T var1;
2475 typval_T var2;
2476 int empty1 = FALSE;
2477 listitem_T *ni;
2478 char_u *key = NULL;
2479 int len;
2480 hashtab_T *ht;
2482 /* Clear everything in "lp". */
2483 vim_memset(lp, 0, sizeof(lval_T));
2485 if (skip)
2487 /* When skipping just find the end of the name. */
2488 lp->ll_name = name;
2489 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2492 /* Find the end of the name. */
2493 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2494 if (expr_start != NULL)
2496 /* Don't expand the name when we already know there is an error. */
2497 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2498 && *p != '[' && *p != '.')
2500 EMSG(_(e_trailing));
2501 return NULL;
2504 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2505 if (lp->ll_exp_name == NULL)
2507 /* Report an invalid expression in braces, unless the
2508 * expression evaluation has been cancelled due to an
2509 * aborting error, an interrupt, or an exception. */
2510 if (!aborting() && !quiet)
2512 emsg_severe = TRUE;
2513 EMSG2(_(e_invarg2), name);
2514 return NULL;
2517 lp->ll_name = lp->ll_exp_name;
2519 else
2520 lp->ll_name = name;
2522 /* Without [idx] or .key we are done. */
2523 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2524 return p;
2526 cc = *p;
2527 *p = NUL;
2528 v = find_var(lp->ll_name, &ht);
2529 if (v == NULL && !quiet)
2530 EMSG2(_(e_undefvar), lp->ll_name);
2531 *p = cc;
2532 if (v == NULL)
2533 return NULL;
2536 * Loop until no more [idx] or .key is following.
2538 lp->ll_tv = &v->di_tv;
2539 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2541 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2542 && !(lp->ll_tv->v_type == VAR_DICT
2543 && lp->ll_tv->vval.v_dict != NULL))
2545 if (!quiet)
2546 EMSG(_("E689: Can only index a List or Dictionary"));
2547 return NULL;
2549 if (lp->ll_range)
2551 if (!quiet)
2552 EMSG(_("E708: [:] must come last"));
2553 return NULL;
2556 len = -1;
2557 if (*p == '.')
2559 key = p + 1;
2560 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2562 if (len == 0)
2564 if (!quiet)
2565 EMSG(_(e_emptykey));
2566 return NULL;
2568 p = key + len;
2570 else
2572 /* Get the index [expr] or the first index [expr: ]. */
2573 p = skipwhite(p + 1);
2574 if (*p == ':')
2575 empty1 = TRUE;
2576 else
2578 empty1 = FALSE;
2579 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2580 return NULL;
2581 if (get_tv_string_chk(&var1) == NULL)
2583 /* not a number or string */
2584 clear_tv(&var1);
2585 return NULL;
2589 /* Optionally get the second index [ :expr]. */
2590 if (*p == ':')
2592 if (lp->ll_tv->v_type == VAR_DICT)
2594 if (!quiet)
2595 EMSG(_(e_dictrange));
2596 if (!empty1)
2597 clear_tv(&var1);
2598 return NULL;
2600 if (rettv != NULL && (rettv->v_type != VAR_LIST
2601 || rettv->vval.v_list == NULL))
2603 if (!quiet)
2604 EMSG(_("E709: [:] requires a List value"));
2605 if (!empty1)
2606 clear_tv(&var1);
2607 return NULL;
2609 p = skipwhite(p + 1);
2610 if (*p == ']')
2611 lp->ll_empty2 = TRUE;
2612 else
2614 lp->ll_empty2 = FALSE;
2615 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2617 if (!empty1)
2618 clear_tv(&var1);
2619 return NULL;
2621 if (get_tv_string_chk(&var2) == NULL)
2623 /* not a number or string */
2624 if (!empty1)
2625 clear_tv(&var1);
2626 clear_tv(&var2);
2627 return NULL;
2630 lp->ll_range = TRUE;
2632 else
2633 lp->ll_range = FALSE;
2635 if (*p != ']')
2637 if (!quiet)
2638 EMSG(_(e_missbrac));
2639 if (!empty1)
2640 clear_tv(&var1);
2641 if (lp->ll_range && !lp->ll_empty2)
2642 clear_tv(&var2);
2643 return NULL;
2646 /* Skip to past ']'. */
2647 ++p;
2650 if (lp->ll_tv->v_type == VAR_DICT)
2652 if (len == -1)
2654 /* "[key]": get key from "var1" */
2655 key = get_tv_string(&var1); /* is number or string */
2656 if (*key == NUL)
2658 if (!quiet)
2659 EMSG(_(e_emptykey));
2660 clear_tv(&var1);
2661 return NULL;
2664 lp->ll_list = NULL;
2665 lp->ll_dict = lp->ll_tv->vval.v_dict;
2666 lp->ll_di = dict_find(lp->ll_dict, key, len);
2667 if (lp->ll_di == NULL)
2669 /* Key does not exist in dict: may need to add it. */
2670 if (*p == '[' || *p == '.' || unlet)
2672 if (!quiet)
2673 EMSG2(_(e_dictkey), key);
2674 if (len == -1)
2675 clear_tv(&var1);
2676 return NULL;
2678 if (len == -1)
2679 lp->ll_newkey = vim_strsave(key);
2680 else
2681 lp->ll_newkey = vim_strnsave(key, len);
2682 if (len == -1)
2683 clear_tv(&var1);
2684 if (lp->ll_newkey == NULL)
2685 p = NULL;
2686 break;
2688 if (len == -1)
2689 clear_tv(&var1);
2690 lp->ll_tv = &lp->ll_di->di_tv;
2692 else
2695 * Get the number and item for the only or first index of the List.
2697 if (empty1)
2698 lp->ll_n1 = 0;
2699 else
2701 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2702 clear_tv(&var1);
2704 lp->ll_dict = NULL;
2705 lp->ll_list = lp->ll_tv->vval.v_list;
2706 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2707 if (lp->ll_li == NULL)
2709 if (lp->ll_n1 < 0)
2711 lp->ll_n1 = 0;
2712 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2715 if (lp->ll_li == NULL)
2717 if (lp->ll_range && !lp->ll_empty2)
2718 clear_tv(&var2);
2719 return NULL;
2723 * May need to find the item or absolute index for the second
2724 * index of a range.
2725 * When no index given: "lp->ll_empty2" is TRUE.
2726 * Otherwise "lp->ll_n2" is set to the second index.
2728 if (lp->ll_range && !lp->ll_empty2)
2730 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2731 clear_tv(&var2);
2732 if (lp->ll_n2 < 0)
2734 ni = list_find(lp->ll_list, lp->ll_n2);
2735 if (ni == NULL)
2736 return NULL;
2737 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2740 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2741 if (lp->ll_n1 < 0)
2742 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2743 if (lp->ll_n2 < lp->ll_n1)
2744 return NULL;
2747 lp->ll_tv = &lp->ll_li->li_tv;
2751 return p;
2755 * Clear lval "lp" that was filled by get_lval().
2757 static void
2758 clear_lval(lp)
2759 lval_T *lp;
2761 vim_free(lp->ll_exp_name);
2762 vim_free(lp->ll_newkey);
2766 * Set a variable that was parsed by get_lval() to "rettv".
2767 * "endp" points to just after the parsed name.
2768 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2770 static void
2771 set_var_lval(lp, endp, rettv, copy, op)
2772 lval_T *lp;
2773 char_u *endp;
2774 typval_T *rettv;
2775 int copy;
2776 char_u *op;
2778 int cc;
2779 listitem_T *ri;
2780 dictitem_T *di;
2782 if (lp->ll_tv == NULL)
2784 if (!check_changedtick(lp->ll_name))
2786 cc = *endp;
2787 *endp = NUL;
2788 if (op != NULL && *op != '=')
2790 typval_T tv;
2792 /* handle +=, -= and .= */
2793 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2794 &tv, TRUE) == OK)
2796 if (tv_op(&tv, rettv, op) == OK)
2797 set_var(lp->ll_name, &tv, FALSE);
2798 clear_tv(&tv);
2801 else
2802 set_var(lp->ll_name, rettv, copy);
2803 *endp = cc;
2806 else if (tv_check_lock(lp->ll_newkey == NULL
2807 ? lp->ll_tv->v_lock
2808 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2810 else if (lp->ll_range)
2813 * Assign the List values to the list items.
2815 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2817 if (op != NULL && *op != '=')
2818 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2819 else
2821 clear_tv(&lp->ll_li->li_tv);
2822 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2824 ri = ri->li_next;
2825 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2826 break;
2827 if (lp->ll_li->li_next == NULL)
2829 /* Need to add an empty item. */
2830 if (list_append_number(lp->ll_list, 0) == FAIL)
2832 ri = NULL;
2833 break;
2836 lp->ll_li = lp->ll_li->li_next;
2837 ++lp->ll_n1;
2839 if (ri != NULL)
2840 EMSG(_("E710: List value has more items than target"));
2841 else if (lp->ll_empty2
2842 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2843 : lp->ll_n1 != lp->ll_n2)
2844 EMSG(_("E711: List value has not enough items"));
2846 else
2849 * Assign to a List or Dictionary item.
2851 if (lp->ll_newkey != NULL)
2853 if (op != NULL && *op != '=')
2855 EMSG2(_(e_letwrong), op);
2856 return;
2859 /* Need to add an item to the Dictionary. */
2860 di = dictitem_alloc(lp->ll_newkey);
2861 if (di == NULL)
2862 return;
2863 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2865 vim_free(di);
2866 return;
2868 lp->ll_tv = &di->di_tv;
2870 else if (op != NULL && *op != '=')
2872 tv_op(lp->ll_tv, rettv, op);
2873 return;
2875 else
2876 clear_tv(lp->ll_tv);
2879 * Assign the value to the variable or list item.
2881 if (copy)
2882 copy_tv(rettv, lp->ll_tv);
2883 else
2885 *lp->ll_tv = *rettv;
2886 lp->ll_tv->v_lock = 0;
2887 init_tv(rettv);
2893 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2894 * Returns OK or FAIL.
2896 static int
2897 tv_op(tv1, tv2, op)
2898 typval_T *tv1;
2899 typval_T *tv2;
2900 char_u *op;
2902 long n;
2903 char_u numbuf[NUMBUFLEN];
2904 char_u *s;
2906 /* Can't do anything with a Funcref or a Dict on the right. */
2907 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2909 switch (tv1->v_type)
2911 case VAR_DICT:
2912 case VAR_FUNC:
2913 break;
2915 case VAR_LIST:
2916 if (*op != '+' || tv2->v_type != VAR_LIST)
2917 break;
2918 /* List += List */
2919 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2920 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2921 return OK;
2923 case VAR_NUMBER:
2924 case VAR_STRING:
2925 if (tv2->v_type == VAR_LIST)
2926 break;
2927 if (*op == '+' || *op == '-')
2929 /* nr += nr or nr -= nr*/
2930 n = get_tv_number(tv1);
2931 #ifdef FEAT_FLOAT
2932 if (tv2->v_type == VAR_FLOAT)
2934 float_T f = n;
2936 if (*op == '+')
2937 f += tv2->vval.v_float;
2938 else
2939 f -= tv2->vval.v_float;
2940 clear_tv(tv1);
2941 tv1->v_type = VAR_FLOAT;
2942 tv1->vval.v_float = f;
2944 else
2945 #endif
2947 if (*op == '+')
2948 n += get_tv_number(tv2);
2949 else
2950 n -= get_tv_number(tv2);
2951 clear_tv(tv1);
2952 tv1->v_type = VAR_NUMBER;
2953 tv1->vval.v_number = n;
2956 else
2958 if (tv2->v_type == VAR_FLOAT)
2959 break;
2961 /* str .= str */
2962 s = get_tv_string(tv1);
2963 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2964 clear_tv(tv1);
2965 tv1->v_type = VAR_STRING;
2966 tv1->vval.v_string = s;
2968 return OK;
2970 #ifdef FEAT_FLOAT
2971 case VAR_FLOAT:
2973 float_T f;
2975 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2976 && tv2->v_type != VAR_NUMBER
2977 && tv2->v_type != VAR_STRING))
2978 break;
2979 if (tv2->v_type == VAR_FLOAT)
2980 f = tv2->vval.v_float;
2981 else
2982 f = get_tv_number(tv2);
2983 if (*op == '+')
2984 tv1->vval.v_float += f;
2985 else
2986 tv1->vval.v_float -= f;
2988 return OK;
2989 #endif
2993 EMSG2(_(e_letwrong), op);
2994 return FAIL;
2998 * Add a watcher to a list.
3000 static void
3001 list_add_watch(l, lw)
3002 list_T *l;
3003 listwatch_T *lw;
3005 lw->lw_next = l->lv_watch;
3006 l->lv_watch = lw;
3010 * Remove a watcher from a list.
3011 * No warning when it isn't found...
3013 static void
3014 list_rem_watch(l, lwrem)
3015 list_T *l;
3016 listwatch_T *lwrem;
3018 listwatch_T *lw, **lwp;
3020 lwp = &l->lv_watch;
3021 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3023 if (lw == lwrem)
3025 *lwp = lw->lw_next;
3026 break;
3028 lwp = &lw->lw_next;
3033 * Just before removing an item from a list: advance watchers to the next
3034 * item.
3036 static void
3037 list_fix_watch(l, item)
3038 list_T *l;
3039 listitem_T *item;
3041 listwatch_T *lw;
3043 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3044 if (lw->lw_item == item)
3045 lw->lw_item = item->li_next;
3049 * Evaluate the expression used in a ":for var in expr" command.
3050 * "arg" points to "var".
3051 * Set "*errp" to TRUE for an error, FALSE otherwise;
3052 * Return a pointer that holds the info. Null when there is an error.
3054 void *
3055 eval_for_line(arg, errp, nextcmdp, skip)
3056 char_u *arg;
3057 int *errp;
3058 char_u **nextcmdp;
3059 int skip;
3061 forinfo_T *fi;
3062 char_u *expr;
3063 typval_T tv;
3064 list_T *l;
3066 *errp = TRUE; /* default: there is an error */
3068 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3069 if (fi == NULL)
3070 return NULL;
3072 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3073 if (expr == NULL)
3074 return fi;
3076 expr = skipwhite(expr);
3077 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3079 EMSG(_("E690: Missing \"in\" after :for"));
3080 return fi;
3083 if (skip)
3084 ++emsg_skip;
3085 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3087 *errp = FALSE;
3088 if (!skip)
3090 l = tv.vval.v_list;
3091 if (tv.v_type != VAR_LIST || l == NULL)
3093 EMSG(_(e_listreq));
3094 clear_tv(&tv);
3096 else
3098 /* No need to increment the refcount, it's already set for the
3099 * list being used in "tv". */
3100 fi->fi_list = l;
3101 list_add_watch(l, &fi->fi_lw);
3102 fi->fi_lw.lw_item = l->lv_first;
3106 if (skip)
3107 --emsg_skip;
3109 return fi;
3113 * Use the first item in a ":for" list. Advance to the next.
3114 * Assign the values to the variable (list). "arg" points to the first one.
3115 * Return TRUE when a valid item was found, FALSE when at end of list or
3116 * something wrong.
3119 next_for_item(fi_void, arg)
3120 void *fi_void;
3121 char_u *arg;
3123 forinfo_T *fi = (forinfo_T *)fi_void;
3124 int result;
3125 listitem_T *item;
3127 item = fi->fi_lw.lw_item;
3128 if (item == NULL)
3129 result = FALSE;
3130 else
3132 fi->fi_lw.lw_item = item->li_next;
3133 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3134 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3136 return result;
3140 * Free the structure used to store info used by ":for".
3142 void
3143 free_for_info(fi_void)
3144 void *fi_void;
3146 forinfo_T *fi = (forinfo_T *)fi_void;
3148 if (fi != NULL && fi->fi_list != NULL)
3150 list_rem_watch(fi->fi_list, &fi->fi_lw);
3151 list_unref(fi->fi_list);
3153 vim_free(fi);
3156 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3158 void
3159 set_context_for_expression(xp, arg, cmdidx)
3160 expand_T *xp;
3161 char_u *arg;
3162 cmdidx_T cmdidx;
3164 int got_eq = FALSE;
3165 int c;
3166 char_u *p;
3168 if (cmdidx == CMD_let)
3170 xp->xp_context = EXPAND_USER_VARS;
3171 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3173 /* ":let var1 var2 ...": find last space. */
3174 for (p = arg + STRLEN(arg); p >= arg; )
3176 xp->xp_pattern = p;
3177 mb_ptr_back(arg, p);
3178 if (vim_iswhite(*p))
3179 break;
3181 return;
3184 else
3185 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3186 : EXPAND_EXPRESSION;
3187 while ((xp->xp_pattern = vim_strpbrk(arg,
3188 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3190 c = *xp->xp_pattern;
3191 if (c == '&')
3193 c = xp->xp_pattern[1];
3194 if (c == '&')
3196 ++xp->xp_pattern;
3197 xp->xp_context = cmdidx != CMD_let || got_eq
3198 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3200 else if (c != ' ')
3202 xp->xp_context = EXPAND_SETTINGS;
3203 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3204 xp->xp_pattern += 2;
3208 else if (c == '$')
3210 /* environment variable */
3211 xp->xp_context = EXPAND_ENV_VARS;
3213 else if (c == '=')
3215 got_eq = TRUE;
3216 xp->xp_context = EXPAND_EXPRESSION;
3218 else if (c == '<'
3219 && xp->xp_context == EXPAND_FUNCTIONS
3220 && vim_strchr(xp->xp_pattern, '(') == NULL)
3222 /* Function name can start with "<SNR>" */
3223 break;
3225 else if (cmdidx != CMD_let || got_eq)
3227 if (c == '"') /* string */
3229 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3230 if (c == '\\' && xp->xp_pattern[1] != NUL)
3231 ++xp->xp_pattern;
3232 xp->xp_context = EXPAND_NOTHING;
3234 else if (c == '\'') /* literal string */
3236 /* Trick: '' is like stopping and starting a literal string. */
3237 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3238 /* skip */ ;
3239 xp->xp_context = EXPAND_NOTHING;
3241 else if (c == '|')
3243 if (xp->xp_pattern[1] == '|')
3245 ++xp->xp_pattern;
3246 xp->xp_context = EXPAND_EXPRESSION;
3248 else
3249 xp->xp_context = EXPAND_COMMANDS;
3251 else
3252 xp->xp_context = EXPAND_EXPRESSION;
3254 else
3255 /* Doesn't look like something valid, expand as an expression
3256 * anyway. */
3257 xp->xp_context = EXPAND_EXPRESSION;
3258 arg = xp->xp_pattern;
3259 if (*arg != NUL)
3260 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3261 /* skip */ ;
3263 xp->xp_pattern = arg;
3266 #endif /* FEAT_CMDL_COMPL */
3269 * ":1,25call func(arg1, arg2)" function call.
3271 void
3272 ex_call(eap)
3273 exarg_T *eap;
3275 char_u *arg = eap->arg;
3276 char_u *startarg;
3277 char_u *name;
3278 char_u *tofree;
3279 int len;
3280 typval_T rettv;
3281 linenr_T lnum;
3282 int doesrange;
3283 int failed = FALSE;
3284 funcdict_T fudi;
3286 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3287 if (fudi.fd_newkey != NULL)
3289 /* Still need to give an error message for missing key. */
3290 EMSG2(_(e_dictkey), fudi.fd_newkey);
3291 vim_free(fudi.fd_newkey);
3293 if (tofree == NULL)
3294 return;
3296 /* Increase refcount on dictionary, it could get deleted when evaluating
3297 * the arguments. */
3298 if (fudi.fd_dict != NULL)
3299 ++fudi.fd_dict->dv_refcount;
3301 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3302 len = (int)STRLEN(tofree);
3303 name = deref_func_name(tofree, &len);
3305 /* Skip white space to allow ":call func ()". Not good, but required for
3306 * backward compatibility. */
3307 startarg = skipwhite(arg);
3308 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3310 if (*startarg != '(')
3312 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3313 goto end;
3317 * When skipping, evaluate the function once, to find the end of the
3318 * arguments.
3319 * When the function takes a range, this is discovered after the first
3320 * call, and the loop is broken.
3322 if (eap->skip)
3324 ++emsg_skip;
3325 lnum = eap->line2; /* do it once, also with an invalid range */
3327 else
3328 lnum = eap->line1;
3329 for ( ; lnum <= eap->line2; ++lnum)
3331 if (!eap->skip && eap->addr_count > 0)
3333 curwin->w_cursor.lnum = lnum;
3334 curwin->w_cursor.col = 0;
3336 arg = startarg;
3337 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3338 eap->line1, eap->line2, &doesrange,
3339 !eap->skip, fudi.fd_dict) == FAIL)
3341 failed = TRUE;
3342 break;
3345 /* Handle a function returning a Funcref, Dictionary or List. */
3346 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3348 failed = TRUE;
3349 break;
3352 clear_tv(&rettv);
3353 if (doesrange || eap->skip)
3354 break;
3356 /* Stop when immediately aborting on error, or when an interrupt
3357 * occurred or an exception was thrown but not caught.
3358 * get_func_tv() returned OK, so that the check for trailing
3359 * characters below is executed. */
3360 if (aborting())
3361 break;
3363 if (eap->skip)
3364 --emsg_skip;
3366 if (!failed)
3368 /* Check for trailing illegal characters and a following command. */
3369 if (!ends_excmd(*arg))
3371 emsg_severe = TRUE;
3372 EMSG(_(e_trailing));
3374 else
3375 eap->nextcmd = check_nextcmd(arg);
3378 end:
3379 dict_unref(fudi.fd_dict);
3380 vim_free(tofree);
3384 * ":unlet[!] var1 ... " command.
3386 void
3387 ex_unlet(eap)
3388 exarg_T *eap;
3390 ex_unletlock(eap, eap->arg, 0);
3394 * ":lockvar" and ":unlockvar" commands
3396 void
3397 ex_lockvar(eap)
3398 exarg_T *eap;
3400 char_u *arg = eap->arg;
3401 int deep = 2;
3403 if (eap->forceit)
3404 deep = -1;
3405 else if (vim_isdigit(*arg))
3407 deep = getdigits(&arg);
3408 arg = skipwhite(arg);
3411 ex_unletlock(eap, arg, deep);
3415 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3417 static void
3418 ex_unletlock(eap, argstart, deep)
3419 exarg_T *eap;
3420 char_u *argstart;
3421 int deep;
3423 char_u *arg = argstart;
3424 char_u *name_end;
3425 int error = FALSE;
3426 lval_T lv;
3430 /* Parse the name and find the end. */
3431 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3432 FNE_CHECK_START);
3433 if (lv.ll_name == NULL)
3434 error = TRUE; /* error but continue parsing */
3435 if (name_end == NULL || (!vim_iswhite(*name_end)
3436 && !ends_excmd(*name_end)))
3438 if (name_end != NULL)
3440 emsg_severe = TRUE;
3441 EMSG(_(e_trailing));
3443 if (!(eap->skip || error))
3444 clear_lval(&lv);
3445 break;
3448 if (!error && !eap->skip)
3450 if (eap->cmdidx == CMD_unlet)
3452 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3453 error = TRUE;
3455 else
3457 if (do_lock_var(&lv, name_end, deep,
3458 eap->cmdidx == CMD_lockvar) == FAIL)
3459 error = TRUE;
3463 if (!eap->skip)
3464 clear_lval(&lv);
3466 arg = skipwhite(name_end);
3467 } while (!ends_excmd(*arg));
3469 eap->nextcmd = check_nextcmd(arg);
3472 static int
3473 do_unlet_var(lp, name_end, forceit)
3474 lval_T *lp;
3475 char_u *name_end;
3476 int forceit;
3478 int ret = OK;
3479 int cc;
3481 if (lp->ll_tv == NULL)
3483 cc = *name_end;
3484 *name_end = NUL;
3486 /* Normal name or expanded name. */
3487 if (check_changedtick(lp->ll_name))
3488 ret = FAIL;
3489 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3490 ret = FAIL;
3491 *name_end = cc;
3493 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3494 return FAIL;
3495 else if (lp->ll_range)
3497 listitem_T *li;
3499 /* Delete a range of List items. */
3500 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3502 li = lp->ll_li->li_next;
3503 listitem_remove(lp->ll_list, lp->ll_li);
3504 lp->ll_li = li;
3505 ++lp->ll_n1;
3508 else
3510 if (lp->ll_list != NULL)
3511 /* unlet a List item. */
3512 listitem_remove(lp->ll_list, lp->ll_li);
3513 else
3514 /* unlet a Dictionary item. */
3515 dictitem_remove(lp->ll_dict, lp->ll_di);
3518 return ret;
3522 * "unlet" a variable. Return OK if it existed, FAIL if not.
3523 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3526 do_unlet(name, forceit)
3527 char_u *name;
3528 int forceit;
3530 hashtab_T *ht;
3531 hashitem_T *hi;
3532 char_u *varname;
3533 dictitem_T *di;
3535 ht = find_var_ht(name, &varname);
3536 if (ht != NULL && *varname != NUL)
3538 hi = hash_find(ht, varname);
3539 if (!HASHITEM_EMPTY(hi))
3541 di = HI2DI(hi);
3542 if (var_check_fixed(di->di_flags, name)
3543 || var_check_ro(di->di_flags, name))
3544 return FAIL;
3545 delete_var(ht, hi);
3546 return OK;
3549 if (forceit)
3550 return OK;
3551 EMSG2(_("E108: No such variable: \"%s\""), name);
3552 return FAIL;
3556 * Lock or unlock variable indicated by "lp".
3557 * "deep" is the levels to go (-1 for unlimited);
3558 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3560 static int
3561 do_lock_var(lp, name_end, deep, lock)
3562 lval_T *lp;
3563 char_u *name_end;
3564 int deep;
3565 int lock;
3567 int ret = OK;
3568 int cc;
3569 dictitem_T *di;
3571 if (deep == 0) /* nothing to do */
3572 return OK;
3574 if (lp->ll_tv == NULL)
3576 cc = *name_end;
3577 *name_end = NUL;
3579 /* Normal name or expanded name. */
3580 if (check_changedtick(lp->ll_name))
3581 ret = FAIL;
3582 else
3584 di = find_var(lp->ll_name, NULL);
3585 if (di == NULL)
3586 ret = FAIL;
3587 else
3589 if (lock)
3590 di->di_flags |= DI_FLAGS_LOCK;
3591 else
3592 di->di_flags &= ~DI_FLAGS_LOCK;
3593 item_lock(&di->di_tv, deep, lock);
3596 *name_end = cc;
3598 else if (lp->ll_range)
3600 listitem_T *li = lp->ll_li;
3602 /* (un)lock a range of List items. */
3603 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3605 item_lock(&li->li_tv, deep, lock);
3606 li = li->li_next;
3607 ++lp->ll_n1;
3610 else if (lp->ll_list != NULL)
3611 /* (un)lock a List item. */
3612 item_lock(&lp->ll_li->li_tv, deep, lock);
3613 else
3614 /* un(lock) a Dictionary item. */
3615 item_lock(&lp->ll_di->di_tv, deep, lock);
3617 return ret;
3621 * Lock or unlock an item. "deep" is nr of levels to go.
3623 static void
3624 item_lock(tv, deep, lock)
3625 typval_T *tv;
3626 int deep;
3627 int lock;
3629 static int recurse = 0;
3630 list_T *l;
3631 listitem_T *li;
3632 dict_T *d;
3633 hashitem_T *hi;
3634 int todo;
3636 if (recurse >= DICT_MAXNEST)
3638 EMSG(_("E743: variable nested too deep for (un)lock"));
3639 return;
3641 if (deep == 0)
3642 return;
3643 ++recurse;
3645 /* lock/unlock the item itself */
3646 if (lock)
3647 tv->v_lock |= VAR_LOCKED;
3648 else
3649 tv->v_lock &= ~VAR_LOCKED;
3651 switch (tv->v_type)
3653 case VAR_LIST:
3654 if ((l = tv->vval.v_list) != NULL)
3656 if (lock)
3657 l->lv_lock |= VAR_LOCKED;
3658 else
3659 l->lv_lock &= ~VAR_LOCKED;
3660 if (deep < 0 || deep > 1)
3661 /* recursive: lock/unlock the items the List contains */
3662 for (li = l->lv_first; li != NULL; li = li->li_next)
3663 item_lock(&li->li_tv, deep - 1, lock);
3665 break;
3666 case VAR_DICT:
3667 if ((d = tv->vval.v_dict) != NULL)
3669 if (lock)
3670 d->dv_lock |= VAR_LOCKED;
3671 else
3672 d->dv_lock &= ~VAR_LOCKED;
3673 if (deep < 0 || deep > 1)
3675 /* recursive: lock/unlock the items the List contains */
3676 todo = (int)d->dv_hashtab.ht_used;
3677 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3679 if (!HASHITEM_EMPTY(hi))
3681 --todo;
3682 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3688 --recurse;
3692 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3693 * or it refers to a List or Dictionary that is locked.
3695 static int
3696 tv_islocked(tv)
3697 typval_T *tv;
3699 return (tv->v_lock & VAR_LOCKED)
3700 || (tv->v_type == VAR_LIST
3701 && tv->vval.v_list != NULL
3702 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3703 || (tv->v_type == VAR_DICT
3704 && tv->vval.v_dict != NULL
3705 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3708 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3710 * Delete all "menutrans_" variables.
3712 void
3713 del_menutrans_vars()
3715 hashitem_T *hi;
3716 int todo;
3718 hash_lock(&globvarht);
3719 todo = (int)globvarht.ht_used;
3720 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3722 if (!HASHITEM_EMPTY(hi))
3724 --todo;
3725 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3726 delete_var(&globvarht, hi);
3729 hash_unlock(&globvarht);
3731 #endif
3733 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3736 * Local string buffer for the next two functions to store a variable name
3737 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3738 * get_user_var_name().
3741 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3743 static char_u *varnamebuf = NULL;
3744 static int varnamebuflen = 0;
3747 * Function to concatenate a prefix and a variable name.
3749 static char_u *
3750 cat_prefix_varname(prefix, name)
3751 int prefix;
3752 char_u *name;
3754 int len;
3756 len = (int)STRLEN(name) + 3;
3757 if (len > varnamebuflen)
3759 vim_free(varnamebuf);
3760 len += 10; /* some additional space */
3761 varnamebuf = alloc(len);
3762 if (varnamebuf == NULL)
3764 varnamebuflen = 0;
3765 return NULL;
3767 varnamebuflen = len;
3769 *varnamebuf = prefix;
3770 varnamebuf[1] = ':';
3771 STRCPY(varnamebuf + 2, name);
3772 return varnamebuf;
3776 * Function given to ExpandGeneric() to obtain the list of user defined
3777 * (global/buffer/window/built-in) variable names.
3779 /*ARGSUSED*/
3780 char_u *
3781 get_user_var_name(xp, idx)
3782 expand_T *xp;
3783 int idx;
3785 static long_u gdone;
3786 static long_u bdone;
3787 static long_u wdone;
3788 #ifdef FEAT_WINDOWS
3789 static long_u tdone;
3790 #endif
3791 static int vidx;
3792 static hashitem_T *hi;
3793 hashtab_T *ht;
3795 if (idx == 0)
3797 gdone = bdone = wdone = vidx = 0;
3798 #ifdef FEAT_WINDOWS
3799 tdone = 0;
3800 #endif
3803 /* Global variables */
3804 if (gdone < globvarht.ht_used)
3806 if (gdone++ == 0)
3807 hi = globvarht.ht_array;
3808 else
3809 ++hi;
3810 while (HASHITEM_EMPTY(hi))
3811 ++hi;
3812 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3813 return cat_prefix_varname('g', hi->hi_key);
3814 return hi->hi_key;
3817 /* b: variables */
3818 ht = &curbuf->b_vars.dv_hashtab;
3819 if (bdone < ht->ht_used)
3821 if (bdone++ == 0)
3822 hi = ht->ht_array;
3823 else
3824 ++hi;
3825 while (HASHITEM_EMPTY(hi))
3826 ++hi;
3827 return cat_prefix_varname('b', hi->hi_key);
3829 if (bdone == ht->ht_used)
3831 ++bdone;
3832 return (char_u *)"b:changedtick";
3835 /* w: variables */
3836 ht = &curwin->w_vars.dv_hashtab;
3837 if (wdone < ht->ht_used)
3839 if (wdone++ == 0)
3840 hi = ht->ht_array;
3841 else
3842 ++hi;
3843 while (HASHITEM_EMPTY(hi))
3844 ++hi;
3845 return cat_prefix_varname('w', hi->hi_key);
3848 #ifdef FEAT_WINDOWS
3849 /* t: variables */
3850 ht = &curtab->tp_vars.dv_hashtab;
3851 if (tdone < ht->ht_used)
3853 if (tdone++ == 0)
3854 hi = ht->ht_array;
3855 else
3856 ++hi;
3857 while (HASHITEM_EMPTY(hi))
3858 ++hi;
3859 return cat_prefix_varname('t', hi->hi_key);
3861 #endif
3863 /* v: variables */
3864 if (vidx < VV_LEN)
3865 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3867 vim_free(varnamebuf);
3868 varnamebuf = NULL;
3869 varnamebuflen = 0;
3870 return NULL;
3873 #endif /* FEAT_CMDL_COMPL */
3876 * types for expressions.
3878 typedef enum
3880 TYPE_UNKNOWN = 0
3881 , TYPE_EQUAL /* == */
3882 , TYPE_NEQUAL /* != */
3883 , TYPE_GREATER /* > */
3884 , TYPE_GEQUAL /* >= */
3885 , TYPE_SMALLER /* < */
3886 , TYPE_SEQUAL /* <= */
3887 , TYPE_MATCH /* =~ */
3888 , TYPE_NOMATCH /* !~ */
3889 } exptype_T;
3892 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3893 * executed. The function may return OK, but the rettv will be of type
3894 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3898 * Handle zero level expression.
3899 * This calls eval1() and handles error message and nextcmd.
3900 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3901 * Note: "rettv.v_lock" is not set.
3902 * Return OK or FAIL.
3904 static int
3905 eval0(arg, rettv, nextcmd, evaluate)
3906 char_u *arg;
3907 typval_T *rettv;
3908 char_u **nextcmd;
3909 int evaluate;
3911 int ret;
3912 char_u *p;
3914 p = skipwhite(arg);
3915 ret = eval1(&p, rettv, evaluate);
3916 if (ret == FAIL || !ends_excmd(*p))
3918 if (ret != FAIL)
3919 clear_tv(rettv);
3921 * Report the invalid expression unless the expression evaluation has
3922 * been cancelled due to an aborting error, an interrupt, or an
3923 * exception.
3925 if (!aborting())
3926 EMSG2(_(e_invexpr2), arg);
3927 ret = FAIL;
3929 if (nextcmd != NULL)
3930 *nextcmd = check_nextcmd(p);
3932 return ret;
3936 * Handle top level expression:
3937 * expr1 ? expr0 : expr0
3939 * "arg" must point to the first non-white of the expression.
3940 * "arg" is advanced to the next non-white after the recognized expression.
3942 * Note: "rettv.v_lock" is not set.
3944 * Return OK or FAIL.
3946 static int
3947 eval1(arg, rettv, evaluate)
3948 char_u **arg;
3949 typval_T *rettv;
3950 int evaluate;
3952 int result;
3953 typval_T var2;
3956 * Get the first variable.
3958 if (eval2(arg, rettv, evaluate) == FAIL)
3959 return FAIL;
3961 if ((*arg)[0] == '?')
3963 result = FALSE;
3964 if (evaluate)
3966 int error = FALSE;
3968 if (get_tv_number_chk(rettv, &error) != 0)
3969 result = TRUE;
3970 clear_tv(rettv);
3971 if (error)
3972 return FAIL;
3976 * Get the second variable.
3978 *arg = skipwhite(*arg + 1);
3979 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3980 return FAIL;
3983 * Check for the ":".
3985 if ((*arg)[0] != ':')
3987 EMSG(_("E109: Missing ':' after '?'"));
3988 if (evaluate && result)
3989 clear_tv(rettv);
3990 return FAIL;
3994 * Get the third variable.
3996 *arg = skipwhite(*arg + 1);
3997 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3999 if (evaluate && result)
4000 clear_tv(rettv);
4001 return FAIL;
4003 if (evaluate && !result)
4004 *rettv = var2;
4007 return OK;
4011 * Handle first level expression:
4012 * expr2 || expr2 || expr2 logical OR
4014 * "arg" must point to the first non-white of the expression.
4015 * "arg" is advanced to the next non-white after the recognized expression.
4017 * Return OK or FAIL.
4019 static int
4020 eval2(arg, rettv, evaluate)
4021 char_u **arg;
4022 typval_T *rettv;
4023 int evaluate;
4025 typval_T var2;
4026 long result;
4027 int first;
4028 int error = FALSE;
4031 * Get the first variable.
4033 if (eval3(arg, rettv, evaluate) == FAIL)
4034 return FAIL;
4037 * Repeat until there is no following "||".
4039 first = TRUE;
4040 result = FALSE;
4041 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4043 if (evaluate && first)
4045 if (get_tv_number_chk(rettv, &error) != 0)
4046 result = TRUE;
4047 clear_tv(rettv);
4048 if (error)
4049 return FAIL;
4050 first = FALSE;
4054 * Get the second variable.
4056 *arg = skipwhite(*arg + 2);
4057 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4058 return FAIL;
4061 * Compute the result.
4063 if (evaluate && !result)
4065 if (get_tv_number_chk(&var2, &error) != 0)
4066 result = TRUE;
4067 clear_tv(&var2);
4068 if (error)
4069 return FAIL;
4071 if (evaluate)
4073 rettv->v_type = VAR_NUMBER;
4074 rettv->vval.v_number = result;
4078 return OK;
4082 * Handle second level expression:
4083 * expr3 && expr3 && expr3 logical AND
4085 * "arg" must point to the first non-white of the expression.
4086 * "arg" is advanced to the next non-white after the recognized expression.
4088 * Return OK or FAIL.
4090 static int
4091 eval3(arg, rettv, evaluate)
4092 char_u **arg;
4093 typval_T *rettv;
4094 int evaluate;
4096 typval_T var2;
4097 long result;
4098 int first;
4099 int error = FALSE;
4102 * Get the first variable.
4104 if (eval4(arg, rettv, evaluate) == FAIL)
4105 return FAIL;
4108 * Repeat until there is no following "&&".
4110 first = TRUE;
4111 result = TRUE;
4112 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4114 if (evaluate && first)
4116 if (get_tv_number_chk(rettv, &error) == 0)
4117 result = FALSE;
4118 clear_tv(rettv);
4119 if (error)
4120 return FAIL;
4121 first = FALSE;
4125 * Get the second variable.
4127 *arg = skipwhite(*arg + 2);
4128 if (eval4(arg, &var2, evaluate && result) == FAIL)
4129 return FAIL;
4132 * Compute the result.
4134 if (evaluate && result)
4136 if (get_tv_number_chk(&var2, &error) == 0)
4137 result = FALSE;
4138 clear_tv(&var2);
4139 if (error)
4140 return FAIL;
4142 if (evaluate)
4144 rettv->v_type = VAR_NUMBER;
4145 rettv->vval.v_number = result;
4149 return OK;
4153 * Handle third level expression:
4154 * var1 == var2
4155 * var1 =~ var2
4156 * var1 != var2
4157 * var1 !~ var2
4158 * var1 > var2
4159 * var1 >= var2
4160 * var1 < var2
4161 * var1 <= var2
4162 * var1 is var2
4163 * var1 isnot var2
4165 * "arg" must point to the first non-white of the expression.
4166 * "arg" is advanced to the next non-white after the recognized expression.
4168 * Return OK or FAIL.
4170 static int
4171 eval4(arg, rettv, evaluate)
4172 char_u **arg;
4173 typval_T *rettv;
4174 int evaluate;
4176 typval_T var2;
4177 char_u *p;
4178 int i;
4179 exptype_T type = TYPE_UNKNOWN;
4180 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4181 int len = 2;
4182 long n1, n2;
4183 char_u *s1, *s2;
4184 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4185 regmatch_T regmatch;
4186 int ic;
4187 char_u *save_cpo;
4190 * Get the first variable.
4192 if (eval5(arg, rettv, evaluate) == FAIL)
4193 return FAIL;
4195 p = *arg;
4196 switch (p[0])
4198 case '=': if (p[1] == '=')
4199 type = TYPE_EQUAL;
4200 else if (p[1] == '~')
4201 type = TYPE_MATCH;
4202 break;
4203 case '!': if (p[1] == '=')
4204 type = TYPE_NEQUAL;
4205 else if (p[1] == '~')
4206 type = TYPE_NOMATCH;
4207 break;
4208 case '>': if (p[1] != '=')
4210 type = TYPE_GREATER;
4211 len = 1;
4213 else
4214 type = TYPE_GEQUAL;
4215 break;
4216 case '<': if (p[1] != '=')
4218 type = TYPE_SMALLER;
4219 len = 1;
4221 else
4222 type = TYPE_SEQUAL;
4223 break;
4224 case 'i': if (p[1] == 's')
4226 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4227 len = 5;
4228 if (!vim_isIDc(p[len]))
4230 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4231 type_is = TRUE;
4234 break;
4238 * If there is a comparative operator, use it.
4240 if (type != TYPE_UNKNOWN)
4242 /* extra question mark appended: ignore case */
4243 if (p[len] == '?')
4245 ic = TRUE;
4246 ++len;
4248 /* extra '#' appended: match case */
4249 else if (p[len] == '#')
4251 ic = FALSE;
4252 ++len;
4254 /* nothing appended: use 'ignorecase' */
4255 else
4256 ic = p_ic;
4259 * Get the second variable.
4261 *arg = skipwhite(p + len);
4262 if (eval5(arg, &var2, evaluate) == FAIL)
4264 clear_tv(rettv);
4265 return FAIL;
4268 if (evaluate)
4270 if (type_is && rettv->v_type != var2.v_type)
4272 /* For "is" a different type always means FALSE, for "notis"
4273 * it means TRUE. */
4274 n1 = (type == TYPE_NEQUAL);
4276 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4278 if (type_is)
4280 n1 = (rettv->v_type == var2.v_type
4281 && rettv->vval.v_list == var2.vval.v_list);
4282 if (type == TYPE_NEQUAL)
4283 n1 = !n1;
4285 else if (rettv->v_type != var2.v_type
4286 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4288 if (rettv->v_type != var2.v_type)
4289 EMSG(_("E691: Can only compare List with List"));
4290 else
4291 EMSG(_("E692: Invalid operation for Lists"));
4292 clear_tv(rettv);
4293 clear_tv(&var2);
4294 return FAIL;
4296 else
4298 /* Compare two Lists for being equal or unequal. */
4299 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4300 if (type == TYPE_NEQUAL)
4301 n1 = !n1;
4305 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4307 if (type_is)
4309 n1 = (rettv->v_type == var2.v_type
4310 && rettv->vval.v_dict == var2.vval.v_dict);
4311 if (type == TYPE_NEQUAL)
4312 n1 = !n1;
4314 else if (rettv->v_type != var2.v_type
4315 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4317 if (rettv->v_type != var2.v_type)
4318 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4319 else
4320 EMSG(_("E736: Invalid operation for Dictionary"));
4321 clear_tv(rettv);
4322 clear_tv(&var2);
4323 return FAIL;
4325 else
4327 /* Compare two Dictionaries for being equal or unequal. */
4328 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4329 if (type == TYPE_NEQUAL)
4330 n1 = !n1;
4334 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4336 if (rettv->v_type != var2.v_type
4337 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4339 if (rettv->v_type != var2.v_type)
4340 EMSG(_("E693: Can only compare Funcref with Funcref"));
4341 else
4342 EMSG(_("E694: Invalid operation for Funcrefs"));
4343 clear_tv(rettv);
4344 clear_tv(&var2);
4345 return FAIL;
4347 else
4349 /* Compare two Funcrefs for being equal or unequal. */
4350 if (rettv->vval.v_string == NULL
4351 || var2.vval.v_string == NULL)
4352 n1 = FALSE;
4353 else
4354 n1 = STRCMP(rettv->vval.v_string,
4355 var2.vval.v_string) == 0;
4356 if (type == TYPE_NEQUAL)
4357 n1 = !n1;
4361 #ifdef FEAT_FLOAT
4363 * If one of the two variables is a float, compare as a float.
4364 * When using "=~" or "!~", always compare as string.
4366 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4367 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4369 float_T f1, f2;
4371 if (rettv->v_type == VAR_FLOAT)
4372 f1 = rettv->vval.v_float;
4373 else
4374 f1 = get_tv_number(rettv);
4375 if (var2.v_type == VAR_FLOAT)
4376 f2 = var2.vval.v_float;
4377 else
4378 f2 = get_tv_number(&var2);
4379 n1 = FALSE;
4380 switch (type)
4382 case TYPE_EQUAL: n1 = (f1 == f2); break;
4383 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4384 case TYPE_GREATER: n1 = (f1 > f2); break;
4385 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4386 case TYPE_SMALLER: n1 = (f1 < f2); break;
4387 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4388 case TYPE_UNKNOWN:
4389 case TYPE_MATCH:
4390 case TYPE_NOMATCH: break; /* avoid gcc warning */
4393 #endif
4396 * If one of the two variables is a number, compare as a number.
4397 * When using "=~" or "!~", always compare as string.
4399 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4400 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4402 n1 = get_tv_number(rettv);
4403 n2 = get_tv_number(&var2);
4404 switch (type)
4406 case TYPE_EQUAL: n1 = (n1 == n2); break;
4407 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4408 case TYPE_GREATER: n1 = (n1 > n2); break;
4409 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4410 case TYPE_SMALLER: n1 = (n1 < n2); break;
4411 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4412 case TYPE_UNKNOWN:
4413 case TYPE_MATCH:
4414 case TYPE_NOMATCH: break; /* avoid gcc warning */
4417 else
4419 s1 = get_tv_string_buf(rettv, buf1);
4420 s2 = get_tv_string_buf(&var2, buf2);
4421 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4422 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4423 else
4424 i = 0;
4425 n1 = FALSE;
4426 switch (type)
4428 case TYPE_EQUAL: n1 = (i == 0); break;
4429 case TYPE_NEQUAL: n1 = (i != 0); break;
4430 case TYPE_GREATER: n1 = (i > 0); break;
4431 case TYPE_GEQUAL: n1 = (i >= 0); break;
4432 case TYPE_SMALLER: n1 = (i < 0); break;
4433 case TYPE_SEQUAL: n1 = (i <= 0); break;
4435 case TYPE_MATCH:
4436 case TYPE_NOMATCH:
4437 /* avoid 'l' flag in 'cpoptions' */
4438 save_cpo = p_cpo;
4439 p_cpo = (char_u *)"";
4440 regmatch.regprog = vim_regcomp(s2,
4441 RE_MAGIC + RE_STRING);
4442 regmatch.rm_ic = ic;
4443 if (regmatch.regprog != NULL)
4445 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4446 vim_free(regmatch.regprog);
4447 if (type == TYPE_NOMATCH)
4448 n1 = !n1;
4450 p_cpo = save_cpo;
4451 break;
4453 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4456 clear_tv(rettv);
4457 clear_tv(&var2);
4458 rettv->v_type = VAR_NUMBER;
4459 rettv->vval.v_number = n1;
4463 return OK;
4467 * Handle fourth level expression:
4468 * + number addition
4469 * - number subtraction
4470 * . string concatenation
4472 * "arg" must point to the first non-white of the expression.
4473 * "arg" is advanced to the next non-white after the recognized expression.
4475 * Return OK or FAIL.
4477 static int
4478 eval5(arg, rettv, evaluate)
4479 char_u **arg;
4480 typval_T *rettv;
4481 int evaluate;
4483 typval_T var2;
4484 typval_T var3;
4485 int op;
4486 long n1, n2;
4487 #ifdef FEAT_FLOAT
4488 float_T f1 = 0, f2 = 0;
4489 #endif
4490 char_u *s1, *s2;
4491 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4492 char_u *p;
4495 * Get the first variable.
4497 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4498 return FAIL;
4501 * Repeat computing, until no '+', '-' or '.' is following.
4503 for (;;)
4505 op = **arg;
4506 if (op != '+' && op != '-' && op != '.')
4507 break;
4509 if ((op != '+' || rettv->v_type != VAR_LIST)
4510 #ifdef FEAT_FLOAT
4511 && (op == '.' || rettv->v_type != VAR_FLOAT)
4512 #endif
4515 /* For "list + ...", an illegal use of the first operand as
4516 * a number cannot be determined before evaluating the 2nd
4517 * operand: if this is also a list, all is ok.
4518 * For "something . ...", "something - ..." or "non-list + ...",
4519 * we know that the first operand needs to be a string or number
4520 * without evaluating the 2nd operand. So check before to avoid
4521 * side effects after an error. */
4522 if (evaluate && get_tv_string_chk(rettv) == NULL)
4524 clear_tv(rettv);
4525 return FAIL;
4530 * Get the second variable.
4532 *arg = skipwhite(*arg + 1);
4533 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4535 clear_tv(rettv);
4536 return FAIL;
4539 if (evaluate)
4542 * Compute the result.
4544 if (op == '.')
4546 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4547 s2 = get_tv_string_buf_chk(&var2, buf2);
4548 if (s2 == NULL) /* type error ? */
4550 clear_tv(rettv);
4551 clear_tv(&var2);
4552 return FAIL;
4554 p = concat_str(s1, s2);
4555 clear_tv(rettv);
4556 rettv->v_type = VAR_STRING;
4557 rettv->vval.v_string = p;
4559 else if (op == '+' && rettv->v_type == VAR_LIST
4560 && var2.v_type == VAR_LIST)
4562 /* concatenate Lists */
4563 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4564 &var3) == FAIL)
4566 clear_tv(rettv);
4567 clear_tv(&var2);
4568 return FAIL;
4570 clear_tv(rettv);
4571 *rettv = var3;
4573 else
4575 int error = FALSE;
4577 #ifdef FEAT_FLOAT
4578 if (rettv->v_type == VAR_FLOAT)
4580 f1 = rettv->vval.v_float;
4581 n1 = 0;
4583 else
4584 #endif
4586 n1 = get_tv_number_chk(rettv, &error);
4587 if (error)
4589 /* This can only happen for "list + non-list". For
4590 * "non-list + ..." or "something - ...", we returned
4591 * before evaluating the 2nd operand. */
4592 clear_tv(rettv);
4593 return FAIL;
4595 #ifdef FEAT_FLOAT
4596 if (var2.v_type == VAR_FLOAT)
4597 f1 = n1;
4598 #endif
4600 #ifdef FEAT_FLOAT
4601 if (var2.v_type == VAR_FLOAT)
4603 f2 = var2.vval.v_float;
4604 n2 = 0;
4606 else
4607 #endif
4609 n2 = get_tv_number_chk(&var2, &error);
4610 if (error)
4612 clear_tv(rettv);
4613 clear_tv(&var2);
4614 return FAIL;
4616 #ifdef FEAT_FLOAT
4617 if (rettv->v_type == VAR_FLOAT)
4618 f2 = n2;
4619 #endif
4621 clear_tv(rettv);
4623 #ifdef FEAT_FLOAT
4624 /* If there is a float on either side the result is a float. */
4625 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4627 if (op == '+')
4628 f1 = f1 + f2;
4629 else
4630 f1 = f1 - f2;
4631 rettv->v_type = VAR_FLOAT;
4632 rettv->vval.v_float = f1;
4634 else
4635 #endif
4637 if (op == '+')
4638 n1 = n1 + n2;
4639 else
4640 n1 = n1 - n2;
4641 rettv->v_type = VAR_NUMBER;
4642 rettv->vval.v_number = n1;
4645 clear_tv(&var2);
4648 return OK;
4652 * Handle fifth level expression:
4653 * * number multiplication
4654 * / number division
4655 * % number modulo
4657 * "arg" must point to the first non-white of the expression.
4658 * "arg" is advanced to the next non-white after the recognized expression.
4660 * Return OK or FAIL.
4662 static int
4663 eval6(arg, rettv, evaluate, want_string)
4664 char_u **arg;
4665 typval_T *rettv;
4666 int evaluate;
4667 int want_string; /* after "." operator */
4669 typval_T var2;
4670 int op;
4671 long n1, n2;
4672 #ifdef FEAT_FLOAT
4673 int use_float = FALSE;
4674 float_T f1 = 0, f2;
4675 #endif
4676 int error = FALSE;
4679 * Get the first variable.
4681 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4682 return FAIL;
4685 * Repeat computing, until no '*', '/' or '%' is following.
4687 for (;;)
4689 op = **arg;
4690 if (op != '*' && op != '/' && op != '%')
4691 break;
4693 if (evaluate)
4695 #ifdef FEAT_FLOAT
4696 if (rettv->v_type == VAR_FLOAT)
4698 f1 = rettv->vval.v_float;
4699 use_float = TRUE;
4700 n1 = 0;
4702 else
4703 #endif
4704 n1 = get_tv_number_chk(rettv, &error);
4705 clear_tv(rettv);
4706 if (error)
4707 return FAIL;
4709 else
4710 n1 = 0;
4713 * Get the second variable.
4715 *arg = skipwhite(*arg + 1);
4716 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4717 return FAIL;
4719 if (evaluate)
4721 #ifdef FEAT_FLOAT
4722 if (var2.v_type == VAR_FLOAT)
4724 if (!use_float)
4726 f1 = n1;
4727 use_float = TRUE;
4729 f2 = var2.vval.v_float;
4730 n2 = 0;
4732 else
4733 #endif
4735 n2 = get_tv_number_chk(&var2, &error);
4736 clear_tv(&var2);
4737 if (error)
4738 return FAIL;
4739 #ifdef FEAT_FLOAT
4740 if (use_float)
4741 f2 = n2;
4742 #endif
4746 * Compute the result.
4747 * When either side is a float the result is a float.
4749 #ifdef FEAT_FLOAT
4750 if (use_float)
4752 if (op == '*')
4753 f1 = f1 * f2;
4754 else if (op == '/')
4756 /* We rely on the floating point library to handle divide
4757 * by zero to result in "inf" and not a crash. */
4758 f1 = f1 / f2;
4760 else
4762 EMSG(_("E804: Cannot use '%' with Float"));
4763 return FAIL;
4765 rettv->v_type = VAR_FLOAT;
4766 rettv->vval.v_float = f1;
4768 else
4769 #endif
4771 if (op == '*')
4772 n1 = n1 * n2;
4773 else if (op == '/')
4775 if (n2 == 0) /* give an error message? */
4777 if (n1 == 0)
4778 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4779 else if (n1 < 0)
4780 n1 = -0x7fffffffL;
4781 else
4782 n1 = 0x7fffffffL;
4784 else
4785 n1 = n1 / n2;
4787 else
4789 if (n2 == 0) /* give an error message? */
4790 n1 = 0;
4791 else
4792 n1 = n1 % n2;
4794 rettv->v_type = VAR_NUMBER;
4795 rettv->vval.v_number = n1;
4800 return OK;
4804 * Handle sixth level expression:
4805 * number number constant
4806 * "string" string constant
4807 * 'string' literal string constant
4808 * &option-name option value
4809 * @r register contents
4810 * identifier variable value
4811 * function() function call
4812 * $VAR environment variable
4813 * (expression) nested expression
4814 * [expr, expr] List
4815 * {key: val, key: val} Dictionary
4817 * Also handle:
4818 * ! in front logical NOT
4819 * - in front unary minus
4820 * + in front unary plus (ignored)
4821 * trailing [] subscript in String or List
4822 * trailing .name entry in Dictionary
4824 * "arg" must point to the first non-white of the expression.
4825 * "arg" is advanced to the next non-white after the recognized expression.
4827 * Return OK or FAIL.
4829 static int
4830 eval7(arg, rettv, evaluate, want_string)
4831 char_u **arg;
4832 typval_T *rettv;
4833 int evaluate;
4834 int want_string; /* after "." operator */
4836 long n;
4837 int len;
4838 char_u *s;
4839 char_u *start_leader, *end_leader;
4840 int ret = OK;
4841 char_u *alias;
4844 * Initialise variable so that clear_tv() can't mistake this for a
4845 * string and free a string that isn't there.
4847 rettv->v_type = VAR_UNKNOWN;
4850 * Skip '!' and '-' characters. They are handled later.
4852 start_leader = *arg;
4853 while (**arg == '!' || **arg == '-' || **arg == '+')
4854 *arg = skipwhite(*arg + 1);
4855 end_leader = *arg;
4857 switch (**arg)
4860 * Number constant.
4862 case '0':
4863 case '1':
4864 case '2':
4865 case '3':
4866 case '4':
4867 case '5':
4868 case '6':
4869 case '7':
4870 case '8':
4871 case '9':
4873 #ifdef FEAT_FLOAT
4874 char_u *p = skipdigits(*arg + 1);
4875 int get_float = FALSE;
4877 /* We accept a float when the format matches
4878 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4879 * strict to avoid backwards compatibility problems.
4880 * Don't look for a float after the "." operator, so that
4881 * ":let vers = 1.2.3" doesn't fail. */
4882 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4884 get_float = TRUE;
4885 p = skipdigits(p + 2);
4886 if (*p == 'e' || *p == 'E')
4888 ++p;
4889 if (*p == '-' || *p == '+')
4890 ++p;
4891 if (!vim_isdigit(*p))
4892 get_float = FALSE;
4893 else
4894 p = skipdigits(p + 1);
4896 if (ASCII_ISALPHA(*p) || *p == '.')
4897 get_float = FALSE;
4899 if (get_float)
4901 float_T f;
4903 *arg += string2float(*arg, &f);
4904 if (evaluate)
4906 rettv->v_type = VAR_FLOAT;
4907 rettv->vval.v_float = f;
4910 else
4911 #endif
4913 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4914 *arg += len;
4915 if (evaluate)
4917 rettv->v_type = VAR_NUMBER;
4918 rettv->vval.v_number = n;
4921 break;
4925 * String constant: "string".
4927 case '"': ret = get_string_tv(arg, rettv, evaluate);
4928 break;
4931 * Literal string constant: 'str''ing'.
4933 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4934 break;
4937 * List: [expr, expr]
4939 case '[': ret = get_list_tv(arg, rettv, evaluate);
4940 break;
4943 * Dictionary: {key: val, key: val}
4945 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4946 break;
4949 * Option value: &name
4951 case '&': ret = get_option_tv(arg, rettv, evaluate);
4952 break;
4955 * Environment variable: $VAR.
4957 case '$': ret = get_env_tv(arg, rettv, evaluate);
4958 break;
4961 * Register contents: @r.
4963 case '@': ++*arg;
4964 if (evaluate)
4966 rettv->v_type = VAR_STRING;
4967 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4969 if (**arg != NUL)
4970 ++*arg;
4971 break;
4974 * nested expression: (expression).
4976 case '(': *arg = skipwhite(*arg + 1);
4977 ret = eval1(arg, rettv, evaluate); /* recursive! */
4978 if (**arg == ')')
4979 ++*arg;
4980 else if (ret == OK)
4982 EMSG(_("E110: Missing ')'"));
4983 clear_tv(rettv);
4984 ret = FAIL;
4986 break;
4988 default: ret = NOTDONE;
4989 break;
4992 if (ret == NOTDONE)
4995 * Must be a variable or function name.
4996 * Can also be a curly-braces kind of name: {expr}.
4998 s = *arg;
4999 len = get_name_len(arg, &alias, evaluate, TRUE);
5000 if (alias != NULL)
5001 s = alias;
5003 if (len <= 0)
5004 ret = FAIL;
5005 else
5007 if (**arg == '(') /* recursive! */
5009 /* If "s" is the name of a variable of type VAR_FUNC
5010 * use its contents. */
5011 s = deref_func_name(s, &len);
5013 /* Invoke the function. */
5014 ret = get_func_tv(s, len, rettv, arg,
5015 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5016 &len, evaluate, NULL);
5017 /* Stop the expression evaluation when immediately
5018 * aborting on error, or when an interrupt occurred or
5019 * an exception was thrown but not caught. */
5020 if (aborting())
5022 if (ret == OK)
5023 clear_tv(rettv);
5024 ret = FAIL;
5027 else if (evaluate)
5028 ret = get_var_tv(s, len, rettv, TRUE);
5029 else
5030 ret = OK;
5033 if (alias != NULL)
5034 vim_free(alias);
5037 *arg = skipwhite(*arg);
5039 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5040 * expr(expr). */
5041 if (ret == OK)
5042 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5045 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5047 if (ret == OK && evaluate && end_leader > start_leader)
5049 int error = FALSE;
5050 int val = 0;
5051 #ifdef FEAT_FLOAT
5052 float_T f = 0.0;
5054 if (rettv->v_type == VAR_FLOAT)
5055 f = rettv->vval.v_float;
5056 else
5057 #endif
5058 val = get_tv_number_chk(rettv, &error);
5059 if (error)
5061 clear_tv(rettv);
5062 ret = FAIL;
5064 else
5066 while (end_leader > start_leader)
5068 --end_leader;
5069 if (*end_leader == '!')
5071 #ifdef FEAT_FLOAT
5072 if (rettv->v_type == VAR_FLOAT)
5073 f = !f;
5074 else
5075 #endif
5076 val = !val;
5078 else if (*end_leader == '-')
5080 #ifdef FEAT_FLOAT
5081 if (rettv->v_type == VAR_FLOAT)
5082 f = -f;
5083 else
5084 #endif
5085 val = -val;
5088 #ifdef FEAT_FLOAT
5089 if (rettv->v_type == VAR_FLOAT)
5091 clear_tv(rettv);
5092 rettv->vval.v_float = f;
5094 else
5095 #endif
5097 clear_tv(rettv);
5098 rettv->v_type = VAR_NUMBER;
5099 rettv->vval.v_number = val;
5104 return ret;
5108 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5109 * "*arg" points to the '[' or '.'.
5110 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5112 static int
5113 eval_index(arg, rettv, evaluate, verbose)
5114 char_u **arg;
5115 typval_T *rettv;
5116 int evaluate;
5117 int verbose; /* give error messages */
5119 int empty1 = FALSE, empty2 = FALSE;
5120 typval_T var1, var2;
5121 long n1, n2 = 0;
5122 long len = -1;
5123 int range = FALSE;
5124 char_u *s;
5125 char_u *key = NULL;
5127 if (rettv->v_type == VAR_FUNC
5128 #ifdef FEAT_FLOAT
5129 || rettv->v_type == VAR_FLOAT
5130 #endif
5133 if (verbose)
5134 EMSG(_("E695: Cannot index a Funcref"));
5135 return FAIL;
5138 if (**arg == '.')
5141 * dict.name
5143 key = *arg + 1;
5144 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5146 if (len == 0)
5147 return FAIL;
5148 *arg = skipwhite(key + len);
5150 else
5153 * something[idx]
5155 * Get the (first) variable from inside the [].
5157 *arg = skipwhite(*arg + 1);
5158 if (**arg == ':')
5159 empty1 = TRUE;
5160 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5161 return FAIL;
5162 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5164 /* not a number or string */
5165 clear_tv(&var1);
5166 return FAIL;
5170 * Get the second variable from inside the [:].
5172 if (**arg == ':')
5174 range = TRUE;
5175 *arg = skipwhite(*arg + 1);
5176 if (**arg == ']')
5177 empty2 = TRUE;
5178 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5180 if (!empty1)
5181 clear_tv(&var1);
5182 return FAIL;
5184 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5186 /* not a number or string */
5187 if (!empty1)
5188 clear_tv(&var1);
5189 clear_tv(&var2);
5190 return FAIL;
5194 /* Check for the ']'. */
5195 if (**arg != ']')
5197 if (verbose)
5198 EMSG(_(e_missbrac));
5199 clear_tv(&var1);
5200 if (range)
5201 clear_tv(&var2);
5202 return FAIL;
5204 *arg = skipwhite(*arg + 1); /* skip the ']' */
5207 if (evaluate)
5209 n1 = 0;
5210 if (!empty1 && rettv->v_type != VAR_DICT)
5212 n1 = get_tv_number(&var1);
5213 clear_tv(&var1);
5215 if (range)
5217 if (empty2)
5218 n2 = -1;
5219 else
5221 n2 = get_tv_number(&var2);
5222 clear_tv(&var2);
5226 switch (rettv->v_type)
5228 case VAR_NUMBER:
5229 case VAR_STRING:
5230 s = get_tv_string(rettv);
5231 len = (long)STRLEN(s);
5232 if (range)
5234 /* The resulting variable is a substring. If the indexes
5235 * are out of range the result is empty. */
5236 if (n1 < 0)
5238 n1 = len + n1;
5239 if (n1 < 0)
5240 n1 = 0;
5242 if (n2 < 0)
5243 n2 = len + n2;
5244 else if (n2 >= len)
5245 n2 = len;
5246 if (n1 >= len || n2 < 0 || n1 > n2)
5247 s = NULL;
5248 else
5249 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5251 else
5253 /* The resulting variable is a string of a single
5254 * character. If the index is too big or negative the
5255 * result is empty. */
5256 if (n1 >= len || n1 < 0)
5257 s = NULL;
5258 else
5259 s = vim_strnsave(s + n1, 1);
5261 clear_tv(rettv);
5262 rettv->v_type = VAR_STRING;
5263 rettv->vval.v_string = s;
5264 break;
5266 case VAR_LIST:
5267 len = list_len(rettv->vval.v_list);
5268 if (n1 < 0)
5269 n1 = len + n1;
5270 if (!empty1 && (n1 < 0 || n1 >= len))
5272 /* For a range we allow invalid values and return an empty
5273 * list. A list index out of range is an error. */
5274 if (!range)
5276 if (verbose)
5277 EMSGN(_(e_listidx), n1);
5278 return FAIL;
5280 n1 = len;
5282 if (range)
5284 list_T *l;
5285 listitem_T *item;
5287 if (n2 < 0)
5288 n2 = len + n2;
5289 else if (n2 >= len)
5290 n2 = len - 1;
5291 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5292 n2 = -1;
5293 l = list_alloc();
5294 if (l == NULL)
5295 return FAIL;
5296 for (item = list_find(rettv->vval.v_list, n1);
5297 n1 <= n2; ++n1)
5299 if (list_append_tv(l, &item->li_tv) == FAIL)
5301 list_free(l, TRUE);
5302 return FAIL;
5304 item = item->li_next;
5306 clear_tv(rettv);
5307 rettv->v_type = VAR_LIST;
5308 rettv->vval.v_list = l;
5309 ++l->lv_refcount;
5311 else
5313 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5314 clear_tv(rettv);
5315 *rettv = var1;
5317 break;
5319 case VAR_DICT:
5320 if (range)
5322 if (verbose)
5323 EMSG(_(e_dictrange));
5324 if (len == -1)
5325 clear_tv(&var1);
5326 return FAIL;
5329 dictitem_T *item;
5331 if (len == -1)
5333 key = get_tv_string(&var1);
5334 if (*key == NUL)
5336 if (verbose)
5337 EMSG(_(e_emptykey));
5338 clear_tv(&var1);
5339 return FAIL;
5343 item = dict_find(rettv->vval.v_dict, key, (int)len);
5345 if (item == NULL && verbose)
5346 EMSG2(_(e_dictkey), key);
5347 if (len == -1)
5348 clear_tv(&var1);
5349 if (item == NULL)
5350 return FAIL;
5352 copy_tv(&item->di_tv, &var1);
5353 clear_tv(rettv);
5354 *rettv = var1;
5356 break;
5360 return OK;
5364 * Get an option value.
5365 * "arg" points to the '&' or '+' before the option name.
5366 * "arg" is advanced to character after the option name.
5367 * Return OK or FAIL.
5369 static int
5370 get_option_tv(arg, rettv, evaluate)
5371 char_u **arg;
5372 typval_T *rettv; /* when NULL, only check if option exists */
5373 int evaluate;
5375 char_u *option_end;
5376 long numval;
5377 char_u *stringval;
5378 int opt_type;
5379 int c;
5380 int working = (**arg == '+'); /* has("+option") */
5381 int ret = OK;
5382 int opt_flags;
5385 * Isolate the option name and find its value.
5387 option_end = find_option_end(arg, &opt_flags);
5388 if (option_end == NULL)
5390 if (rettv != NULL)
5391 EMSG2(_("E112: Option name missing: %s"), *arg);
5392 return FAIL;
5395 if (!evaluate)
5397 *arg = option_end;
5398 return OK;
5401 c = *option_end;
5402 *option_end = NUL;
5403 opt_type = get_option_value(*arg, &numval,
5404 rettv == NULL ? NULL : &stringval, opt_flags);
5406 if (opt_type == -3) /* invalid name */
5408 if (rettv != NULL)
5409 EMSG2(_("E113: Unknown option: %s"), *arg);
5410 ret = FAIL;
5412 else if (rettv != NULL)
5414 if (opt_type == -2) /* hidden string option */
5416 rettv->v_type = VAR_STRING;
5417 rettv->vval.v_string = NULL;
5419 else if (opt_type == -1) /* hidden number option */
5421 rettv->v_type = VAR_NUMBER;
5422 rettv->vval.v_number = 0;
5424 else if (opt_type == 1) /* number option */
5426 rettv->v_type = VAR_NUMBER;
5427 rettv->vval.v_number = numval;
5429 else /* string option */
5431 rettv->v_type = VAR_STRING;
5432 rettv->vval.v_string = stringval;
5435 else if (working && (opt_type == -2 || opt_type == -1))
5436 ret = FAIL;
5438 *option_end = c; /* put back for error messages */
5439 *arg = option_end;
5441 return ret;
5445 * Allocate a variable for a string constant.
5446 * Return OK or FAIL.
5448 static int
5449 get_string_tv(arg, rettv, evaluate)
5450 char_u **arg;
5451 typval_T *rettv;
5452 int evaluate;
5454 char_u *p;
5455 char_u *name;
5456 int extra = 0;
5459 * Find the end of the string, skipping backslashed characters.
5461 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5463 if (*p == '\\' && p[1] != NUL)
5465 ++p;
5466 /* A "\<x>" form occupies at least 4 characters, and produces up
5467 * to 6 characters: reserve space for 2 extra */
5468 if (*p == '<')
5469 extra += 2;
5473 if (*p != '"')
5475 EMSG2(_("E114: Missing quote: %s"), *arg);
5476 return FAIL;
5479 /* If only parsing, set *arg and return here */
5480 if (!evaluate)
5482 *arg = p + 1;
5483 return OK;
5487 * Copy the string into allocated memory, handling backslashed
5488 * characters.
5490 name = alloc((unsigned)(p - *arg + extra));
5491 if (name == NULL)
5492 return FAIL;
5493 rettv->v_type = VAR_STRING;
5494 rettv->vval.v_string = name;
5496 for (p = *arg + 1; *p != NUL && *p != '"'; )
5498 if (*p == '\\')
5500 switch (*++p)
5502 case 'b': *name++ = BS; ++p; break;
5503 case 'e': *name++ = ESC; ++p; break;
5504 case 'f': *name++ = FF; ++p; break;
5505 case 'n': *name++ = NL; ++p; break;
5506 case 'r': *name++ = CAR; ++p; break;
5507 case 't': *name++ = TAB; ++p; break;
5509 case 'X': /* hex: "\x1", "\x12" */
5510 case 'x':
5511 case 'u': /* Unicode: "\u0023" */
5512 case 'U':
5513 if (vim_isxdigit(p[1]))
5515 int n, nr;
5516 int c = toupper(*p);
5518 if (c == 'X')
5519 n = 2;
5520 else
5521 n = 4;
5522 nr = 0;
5523 while (--n >= 0 && vim_isxdigit(p[1]))
5525 ++p;
5526 nr = (nr << 4) + hex2nr(*p);
5528 ++p;
5529 #ifdef FEAT_MBYTE
5530 /* For "\u" store the number according to
5531 * 'encoding'. */
5532 if (c != 'X')
5533 name += (*mb_char2bytes)(nr, name);
5534 else
5535 #endif
5536 *name++ = nr;
5538 break;
5540 /* octal: "\1", "\12", "\123" */
5541 case '0':
5542 case '1':
5543 case '2':
5544 case '3':
5545 case '4':
5546 case '5':
5547 case '6':
5548 case '7': *name = *p++ - '0';
5549 if (*p >= '0' && *p <= '7')
5551 *name = (*name << 3) + *p++ - '0';
5552 if (*p >= '0' && *p <= '7')
5553 *name = (*name << 3) + *p++ - '0';
5555 ++name;
5556 break;
5558 /* Special key, e.g.: "\<C-W>" */
5559 case '<': extra = trans_special(&p, name, TRUE);
5560 if (extra != 0)
5562 name += extra;
5563 break;
5565 /* FALLTHROUGH */
5567 default: MB_COPY_CHAR(p, name);
5568 break;
5571 else
5572 MB_COPY_CHAR(p, name);
5575 *name = NUL;
5576 *arg = p + 1;
5578 return OK;
5582 * Allocate a variable for a 'str''ing' constant.
5583 * Return OK or FAIL.
5585 static int
5586 get_lit_string_tv(arg, rettv, evaluate)
5587 char_u **arg;
5588 typval_T *rettv;
5589 int evaluate;
5591 char_u *p;
5592 char_u *str;
5593 int reduce = 0;
5596 * Find the end of the string, skipping ''.
5598 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5600 if (*p == '\'')
5602 if (p[1] != '\'')
5603 break;
5604 ++reduce;
5605 ++p;
5609 if (*p != '\'')
5611 EMSG2(_("E115: Missing quote: %s"), *arg);
5612 return FAIL;
5615 /* If only parsing return after setting "*arg" */
5616 if (!evaluate)
5618 *arg = p + 1;
5619 return OK;
5623 * Copy the string into allocated memory, handling '' to ' reduction.
5625 str = alloc((unsigned)((p - *arg) - reduce));
5626 if (str == NULL)
5627 return FAIL;
5628 rettv->v_type = VAR_STRING;
5629 rettv->vval.v_string = str;
5631 for (p = *arg + 1; *p != NUL; )
5633 if (*p == '\'')
5635 if (p[1] != '\'')
5636 break;
5637 ++p;
5639 MB_COPY_CHAR(p, str);
5641 *str = NUL;
5642 *arg = p + 1;
5644 return OK;
5648 * Allocate a variable for a List and fill it from "*arg".
5649 * Return OK or FAIL.
5651 static int
5652 get_list_tv(arg, rettv, evaluate)
5653 char_u **arg;
5654 typval_T *rettv;
5655 int evaluate;
5657 list_T *l = NULL;
5658 typval_T tv;
5659 listitem_T *item;
5661 if (evaluate)
5663 l = list_alloc();
5664 if (l == NULL)
5665 return FAIL;
5668 *arg = skipwhite(*arg + 1);
5669 while (**arg != ']' && **arg != NUL)
5671 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5672 goto failret;
5673 if (evaluate)
5675 item = listitem_alloc();
5676 if (item != NULL)
5678 item->li_tv = tv;
5679 item->li_tv.v_lock = 0;
5680 list_append(l, item);
5682 else
5683 clear_tv(&tv);
5686 if (**arg == ']')
5687 break;
5688 if (**arg != ',')
5690 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5691 goto failret;
5693 *arg = skipwhite(*arg + 1);
5696 if (**arg != ']')
5698 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5699 failret:
5700 if (evaluate)
5701 list_free(l, TRUE);
5702 return FAIL;
5705 *arg = skipwhite(*arg + 1);
5706 if (evaluate)
5708 rettv->v_type = VAR_LIST;
5709 rettv->vval.v_list = l;
5710 ++l->lv_refcount;
5713 return OK;
5717 * Allocate an empty header for a list.
5718 * Caller should take care of the reference count.
5720 list_T *
5721 list_alloc()
5723 list_T *l;
5725 l = (list_T *)alloc_clear(sizeof(list_T));
5726 if (l != NULL)
5728 /* Prepend the list to the list of lists for garbage collection. */
5729 if (first_list != NULL)
5730 first_list->lv_used_prev = l;
5731 l->lv_used_prev = NULL;
5732 l->lv_used_next = first_list;
5733 first_list = l;
5735 return l;
5739 * Allocate an empty list for a return value.
5740 * Returns OK or FAIL.
5742 static int
5743 rettv_list_alloc(rettv)
5744 typval_T *rettv;
5746 list_T *l = list_alloc();
5748 if (l == NULL)
5749 return FAIL;
5751 rettv->vval.v_list = l;
5752 rettv->v_type = VAR_LIST;
5753 ++l->lv_refcount;
5754 return OK;
5758 * Unreference a list: decrement the reference count and free it when it
5759 * becomes zero.
5761 void
5762 list_unref(l)
5763 list_T *l;
5765 if (l != NULL && --l->lv_refcount <= 0)
5766 list_free(l, TRUE);
5770 * Free a list, including all items it points to.
5771 * Ignores the reference count.
5773 void
5774 list_free(l, recurse)
5775 list_T *l;
5776 int recurse; /* Free Lists and Dictionaries recursively. */
5778 listitem_T *item;
5780 /* Remove the list from the list of lists for garbage collection. */
5781 if (l->lv_used_prev == NULL)
5782 first_list = l->lv_used_next;
5783 else
5784 l->lv_used_prev->lv_used_next = l->lv_used_next;
5785 if (l->lv_used_next != NULL)
5786 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5788 for (item = l->lv_first; item != NULL; item = l->lv_first)
5790 /* Remove the item before deleting it. */
5791 l->lv_first = item->li_next;
5792 if (recurse || (item->li_tv.v_type != VAR_LIST
5793 && item->li_tv.v_type != VAR_DICT))
5794 clear_tv(&item->li_tv);
5795 vim_free(item);
5797 vim_free(l);
5801 * Allocate a list item.
5803 static listitem_T *
5804 listitem_alloc()
5806 return (listitem_T *)alloc(sizeof(listitem_T));
5810 * Free a list item. Also clears the value. Does not notify watchers.
5812 static void
5813 listitem_free(item)
5814 listitem_T *item;
5816 clear_tv(&item->li_tv);
5817 vim_free(item);
5821 * Remove a list item from a List and free it. Also clears the value.
5823 static void
5824 listitem_remove(l, item)
5825 list_T *l;
5826 listitem_T *item;
5828 list_remove(l, item, item);
5829 listitem_free(item);
5833 * Get the number of items in a list.
5835 static long
5836 list_len(l)
5837 list_T *l;
5839 if (l == NULL)
5840 return 0L;
5841 return l->lv_len;
5845 * Return TRUE when two lists have exactly the same values.
5847 static int
5848 list_equal(l1, l2, ic)
5849 list_T *l1;
5850 list_T *l2;
5851 int ic; /* ignore case for strings */
5853 listitem_T *item1, *item2;
5855 if (l1 == NULL || l2 == NULL)
5856 return FALSE;
5857 if (l1 == l2)
5858 return TRUE;
5859 if (list_len(l1) != list_len(l2))
5860 return FALSE;
5862 for (item1 = l1->lv_first, item2 = l2->lv_first;
5863 item1 != NULL && item2 != NULL;
5864 item1 = item1->li_next, item2 = item2->li_next)
5865 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5866 return FALSE;
5867 return item1 == NULL && item2 == NULL;
5870 #if defined(FEAT_PYTHON) || defined(PROTO)
5872 * Return the dictitem that an entry in a hashtable points to.
5874 dictitem_T *
5875 dict_lookup(hi)
5876 hashitem_T *hi;
5878 return HI2DI(hi);
5880 #endif
5883 * Return TRUE when two dictionaries have exactly the same key/values.
5885 static int
5886 dict_equal(d1, d2, ic)
5887 dict_T *d1;
5888 dict_T *d2;
5889 int ic; /* ignore case for strings */
5891 hashitem_T *hi;
5892 dictitem_T *item2;
5893 int todo;
5895 if (d1 == NULL || d2 == NULL)
5896 return FALSE;
5897 if (d1 == d2)
5898 return TRUE;
5899 if (dict_len(d1) != dict_len(d2))
5900 return FALSE;
5902 todo = (int)d1->dv_hashtab.ht_used;
5903 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5905 if (!HASHITEM_EMPTY(hi))
5907 item2 = dict_find(d2, hi->hi_key, -1);
5908 if (item2 == NULL)
5909 return FALSE;
5910 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5911 return FALSE;
5912 --todo;
5915 return TRUE;
5919 * Return TRUE if "tv1" and "tv2" have the same value.
5920 * Compares the items just like "==" would compare them, but strings and
5921 * numbers are different. Floats and numbers are also different.
5923 static int
5924 tv_equal(tv1, tv2, ic)
5925 typval_T *tv1;
5926 typval_T *tv2;
5927 int ic; /* ignore case */
5929 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5930 char_u *s1, *s2;
5931 static int recursive = 0; /* cach recursive loops */
5932 int r;
5934 if (tv1->v_type != tv2->v_type)
5935 return FALSE;
5936 /* Catch lists and dicts that have an endless loop by limiting
5937 * recursiveness to 1000. We guess they are equal then. */
5938 if (recursive >= 1000)
5939 return TRUE;
5941 switch (tv1->v_type)
5943 case VAR_LIST:
5944 ++recursive;
5945 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5946 --recursive;
5947 return r;
5949 case VAR_DICT:
5950 ++recursive;
5951 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5952 --recursive;
5953 return r;
5955 case VAR_FUNC:
5956 return (tv1->vval.v_string != NULL
5957 && tv2->vval.v_string != NULL
5958 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5960 case VAR_NUMBER:
5961 return tv1->vval.v_number == tv2->vval.v_number;
5963 #ifdef FEAT_FLOAT
5964 case VAR_FLOAT:
5965 return tv1->vval.v_float == tv2->vval.v_float;
5966 #endif
5968 case VAR_STRING:
5969 s1 = get_tv_string_buf(tv1, buf1);
5970 s2 = get_tv_string_buf(tv2, buf2);
5971 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5974 EMSG2(_(e_intern2), "tv_equal()");
5975 return TRUE;
5979 * Locate item with index "n" in list "l" and return it.
5980 * A negative index is counted from the end; -1 is the last item.
5981 * Returns NULL when "n" is out of range.
5983 static listitem_T *
5984 list_find(l, n)
5985 list_T *l;
5986 long n;
5988 listitem_T *item;
5989 long idx;
5991 if (l == NULL)
5992 return NULL;
5994 /* Negative index is relative to the end. */
5995 if (n < 0)
5996 n = l->lv_len + n;
5998 /* Check for index out of range. */
5999 if (n < 0 || n >= l->lv_len)
6000 return NULL;
6002 /* When there is a cached index may start search from there. */
6003 if (l->lv_idx_item != NULL)
6005 if (n < l->lv_idx / 2)
6007 /* closest to the start of the list */
6008 item = l->lv_first;
6009 idx = 0;
6011 else if (n > (l->lv_idx + l->lv_len) / 2)
6013 /* closest to the end of the list */
6014 item = l->lv_last;
6015 idx = l->lv_len - 1;
6017 else
6019 /* closest to the cached index */
6020 item = l->lv_idx_item;
6021 idx = l->lv_idx;
6024 else
6026 if (n < l->lv_len / 2)
6028 /* closest to the start of the list */
6029 item = l->lv_first;
6030 idx = 0;
6032 else
6034 /* closest to the end of the list */
6035 item = l->lv_last;
6036 idx = l->lv_len - 1;
6040 while (n > idx)
6042 /* search forward */
6043 item = item->li_next;
6044 ++idx;
6046 while (n < idx)
6048 /* search backward */
6049 item = item->li_prev;
6050 --idx;
6053 /* cache the used index */
6054 l->lv_idx = idx;
6055 l->lv_idx_item = item;
6057 return item;
6061 * Get list item "l[idx]" as a number.
6063 static long
6064 list_find_nr(l, idx, errorp)
6065 list_T *l;
6066 long idx;
6067 int *errorp; /* set to TRUE when something wrong */
6069 listitem_T *li;
6071 li = list_find(l, idx);
6072 if (li == NULL)
6074 if (errorp != NULL)
6075 *errorp = TRUE;
6076 return -1L;
6078 return get_tv_number_chk(&li->li_tv, errorp);
6082 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6084 char_u *
6085 list_find_str(l, idx)
6086 list_T *l;
6087 long idx;
6089 listitem_T *li;
6091 li = list_find(l, idx - 1);
6092 if (li == NULL)
6094 EMSGN(_(e_listidx), idx);
6095 return NULL;
6097 return get_tv_string(&li->li_tv);
6101 * Locate "item" list "l" and return its index.
6102 * Returns -1 when "item" is not in the list.
6104 static long
6105 list_idx_of_item(l, item)
6106 list_T *l;
6107 listitem_T *item;
6109 long idx = 0;
6110 listitem_T *li;
6112 if (l == NULL)
6113 return -1;
6114 idx = 0;
6115 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6116 ++idx;
6117 if (li == NULL)
6118 return -1;
6119 return idx;
6123 * Append item "item" to the end of list "l".
6125 static void
6126 list_append(l, item)
6127 list_T *l;
6128 listitem_T *item;
6130 if (l->lv_last == NULL)
6132 /* empty list */
6133 l->lv_first = item;
6134 l->lv_last = item;
6135 item->li_prev = NULL;
6137 else
6139 l->lv_last->li_next = item;
6140 item->li_prev = l->lv_last;
6141 l->lv_last = item;
6143 ++l->lv_len;
6144 item->li_next = NULL;
6148 * Append typval_T "tv" to the end of list "l".
6149 * Return FAIL when out of memory.
6151 static int
6152 list_append_tv(l, tv)
6153 list_T *l;
6154 typval_T *tv;
6156 listitem_T *li = listitem_alloc();
6158 if (li == NULL)
6159 return FAIL;
6160 copy_tv(tv, &li->li_tv);
6161 list_append(l, li);
6162 return OK;
6166 * Add a dictionary to a list. Used by getqflist().
6167 * Return FAIL when out of memory.
6170 list_append_dict(list, dict)
6171 list_T *list;
6172 dict_T *dict;
6174 listitem_T *li = listitem_alloc();
6176 if (li == NULL)
6177 return FAIL;
6178 li->li_tv.v_type = VAR_DICT;
6179 li->li_tv.v_lock = 0;
6180 li->li_tv.vval.v_dict = dict;
6181 list_append(list, li);
6182 ++dict->dv_refcount;
6183 return OK;
6187 * Make a copy of "str" and append it as an item to list "l".
6188 * When "len" >= 0 use "str[len]".
6189 * Returns FAIL when out of memory.
6192 list_append_string(l, str, len)
6193 list_T *l;
6194 char_u *str;
6195 int len;
6197 listitem_T *li = listitem_alloc();
6199 if (li == NULL)
6200 return FAIL;
6201 list_append(l, li);
6202 li->li_tv.v_type = VAR_STRING;
6203 li->li_tv.v_lock = 0;
6204 if (str == NULL)
6205 li->li_tv.vval.v_string = NULL;
6206 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6207 : vim_strsave(str))) == NULL)
6208 return FAIL;
6209 return OK;
6213 * Append "n" to list "l".
6214 * Returns FAIL when out of memory.
6216 static int
6217 list_append_number(l, n)
6218 list_T *l;
6219 varnumber_T n;
6221 listitem_T *li;
6223 li = listitem_alloc();
6224 if (li == NULL)
6225 return FAIL;
6226 li->li_tv.v_type = VAR_NUMBER;
6227 li->li_tv.v_lock = 0;
6228 li->li_tv.vval.v_number = n;
6229 list_append(l, li);
6230 return OK;
6234 * Insert typval_T "tv" in list "l" before "item".
6235 * If "item" is NULL append at the end.
6236 * Return FAIL when out of memory.
6238 static int
6239 list_insert_tv(l, tv, item)
6240 list_T *l;
6241 typval_T *tv;
6242 listitem_T *item;
6244 listitem_T *ni = listitem_alloc();
6246 if (ni == NULL)
6247 return FAIL;
6248 copy_tv(tv, &ni->li_tv);
6249 if (item == NULL)
6250 /* Append new item at end of list. */
6251 list_append(l, ni);
6252 else
6254 /* Insert new item before existing item. */
6255 ni->li_prev = item->li_prev;
6256 ni->li_next = item;
6257 if (item->li_prev == NULL)
6259 l->lv_first = ni;
6260 ++l->lv_idx;
6262 else
6264 item->li_prev->li_next = ni;
6265 l->lv_idx_item = NULL;
6267 item->li_prev = ni;
6268 ++l->lv_len;
6270 return OK;
6274 * Extend "l1" with "l2".
6275 * If "bef" is NULL append at the end, otherwise insert before this item.
6276 * Returns FAIL when out of memory.
6278 static int
6279 list_extend(l1, l2, bef)
6280 list_T *l1;
6281 list_T *l2;
6282 listitem_T *bef;
6284 listitem_T *item;
6285 int todo = l2->lv_len;
6287 /* We also quit the loop when we have inserted the original item count of
6288 * the list, avoid a hang when we extend a list with itself. */
6289 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6290 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6291 return FAIL;
6292 return OK;
6296 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6297 * Return FAIL when out of memory.
6299 static int
6300 list_concat(l1, l2, tv)
6301 list_T *l1;
6302 list_T *l2;
6303 typval_T *tv;
6305 list_T *l;
6307 if (l1 == NULL || l2 == NULL)
6308 return FAIL;
6310 /* make a copy of the first list. */
6311 l = list_copy(l1, FALSE, 0);
6312 if (l == NULL)
6313 return FAIL;
6314 tv->v_type = VAR_LIST;
6315 tv->vval.v_list = l;
6317 /* append all items from the second list */
6318 return list_extend(l, l2, NULL);
6322 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6323 * The refcount of the new list is set to 1.
6324 * See item_copy() for "copyID".
6325 * Returns NULL when out of memory.
6327 static list_T *
6328 list_copy(orig, deep, copyID)
6329 list_T *orig;
6330 int deep;
6331 int copyID;
6333 list_T *copy;
6334 listitem_T *item;
6335 listitem_T *ni;
6337 if (orig == NULL)
6338 return NULL;
6340 copy = list_alloc();
6341 if (copy != NULL)
6343 if (copyID != 0)
6345 /* Do this before adding the items, because one of the items may
6346 * refer back to this list. */
6347 orig->lv_copyID = copyID;
6348 orig->lv_copylist = copy;
6350 for (item = orig->lv_first; item != NULL && !got_int;
6351 item = item->li_next)
6353 ni = listitem_alloc();
6354 if (ni == NULL)
6355 break;
6356 if (deep)
6358 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6360 vim_free(ni);
6361 break;
6364 else
6365 copy_tv(&item->li_tv, &ni->li_tv);
6366 list_append(copy, ni);
6368 ++copy->lv_refcount;
6369 if (item != NULL)
6371 list_unref(copy);
6372 copy = NULL;
6376 return copy;
6380 * Remove items "item" to "item2" from list "l".
6381 * Does not free the listitem or the value!
6383 static void
6384 list_remove(l, item, item2)
6385 list_T *l;
6386 listitem_T *item;
6387 listitem_T *item2;
6389 listitem_T *ip;
6391 /* notify watchers */
6392 for (ip = item; ip != NULL; ip = ip->li_next)
6394 --l->lv_len;
6395 list_fix_watch(l, ip);
6396 if (ip == item2)
6397 break;
6400 if (item2->li_next == NULL)
6401 l->lv_last = item->li_prev;
6402 else
6403 item2->li_next->li_prev = item->li_prev;
6404 if (item->li_prev == NULL)
6405 l->lv_first = item2->li_next;
6406 else
6407 item->li_prev->li_next = item2->li_next;
6408 l->lv_idx_item = NULL;
6412 * Return an allocated string with the string representation of a list.
6413 * May return NULL.
6415 static char_u *
6416 list2string(tv, copyID)
6417 typval_T *tv;
6418 int copyID;
6420 garray_T ga;
6422 if (tv->vval.v_list == NULL)
6423 return NULL;
6424 ga_init2(&ga, (int)sizeof(char), 80);
6425 ga_append(&ga, '[');
6426 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6428 vim_free(ga.ga_data);
6429 return NULL;
6431 ga_append(&ga, ']');
6432 ga_append(&ga, NUL);
6433 return (char_u *)ga.ga_data;
6437 * Join list "l" into a string in "*gap", using separator "sep".
6438 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6439 * Return FAIL or OK.
6441 static int
6442 list_join(gap, l, sep, echo, copyID)
6443 garray_T *gap;
6444 list_T *l;
6445 char_u *sep;
6446 int echo;
6447 int copyID;
6449 int first = TRUE;
6450 char_u *tofree;
6451 char_u numbuf[NUMBUFLEN];
6452 listitem_T *item;
6453 char_u *s;
6455 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6457 if (first)
6458 first = FALSE;
6459 else
6460 ga_concat(gap, sep);
6462 if (echo)
6463 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6464 else
6465 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6466 if (s != NULL)
6467 ga_concat(gap, s);
6468 vim_free(tofree);
6469 if (s == NULL)
6470 return FAIL;
6472 return OK;
6476 * Garbage collection for lists and dictionaries.
6478 * We use reference counts to be able to free most items right away when they
6479 * are no longer used. But for composite items it's possible that it becomes
6480 * unused while the reference count is > 0: When there is a recursive
6481 * reference. Example:
6482 * :let l = [1, 2, 3]
6483 * :let d = {9: l}
6484 * :let l[1] = d
6486 * Since this is quite unusual we handle this with garbage collection: every
6487 * once in a while find out which lists and dicts are not referenced from any
6488 * variable.
6490 * Here is a good reference text about garbage collection (refers to Python
6491 * but it applies to all reference-counting mechanisms):
6492 * http://python.ca/nas/python/gc/
6496 * Do garbage collection for lists and dicts.
6497 * Return TRUE if some memory was freed.
6500 garbage_collect()
6502 dict_T *dd;
6503 list_T *ll;
6504 int copyID = ++current_copyID;
6505 buf_T *buf;
6506 win_T *wp;
6507 int i;
6508 funccall_T *fc;
6509 int did_free = FALSE;
6510 #ifdef FEAT_WINDOWS
6511 tabpage_T *tp;
6512 #endif
6514 /* Only do this once. */
6515 want_garbage_collect = FALSE;
6516 may_garbage_collect = FALSE;
6517 garbage_collect_at_exit = FALSE;
6520 * 1. Go through all accessible variables and mark all lists and dicts
6521 * with copyID.
6523 /* script-local variables */
6524 for (i = 1; i <= ga_scripts.ga_len; ++i)
6525 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6527 /* buffer-local variables */
6528 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6529 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6531 /* window-local variables */
6532 FOR_ALL_TAB_WINDOWS(tp, wp)
6533 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6535 #ifdef FEAT_WINDOWS
6536 /* tabpage-local variables */
6537 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6538 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6539 #endif
6541 /* global variables */
6542 set_ref_in_ht(&globvarht, copyID);
6544 /* function-local variables */
6545 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6547 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6548 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6551 /* v: vars */
6552 set_ref_in_ht(&vimvarht, copyID);
6555 * 2. Go through the list of dicts and free items without the copyID.
6557 for (dd = first_dict; dd != NULL; )
6558 if (dd->dv_copyID != copyID)
6560 /* Free the Dictionary and ordinary items it contains, but don't
6561 * recurse into Lists and Dictionaries, they will be in the list
6562 * of dicts or list of lists. */
6563 dict_free(dd, FALSE);
6564 did_free = TRUE;
6566 /* restart, next dict may also have been freed */
6567 dd = first_dict;
6569 else
6570 dd = dd->dv_used_next;
6573 * 3. Go through the list of lists and free items without the copyID.
6574 * But don't free a list that has a watcher (used in a for loop), these
6575 * are not referenced anywhere.
6577 for (ll = first_list; ll != NULL; )
6578 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6580 /* Free the List and ordinary items it contains, but don't recurse
6581 * into Lists and Dictionaries, they will be in the list of dicts
6582 * or list of lists. */
6583 list_free(ll, FALSE);
6584 did_free = TRUE;
6586 /* restart, next list may also have been freed */
6587 ll = first_list;
6589 else
6590 ll = ll->lv_used_next;
6592 return did_free;
6596 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6598 static void
6599 set_ref_in_ht(ht, copyID)
6600 hashtab_T *ht;
6601 int copyID;
6603 int todo;
6604 hashitem_T *hi;
6606 todo = (int)ht->ht_used;
6607 for (hi = ht->ht_array; todo > 0; ++hi)
6608 if (!HASHITEM_EMPTY(hi))
6610 --todo;
6611 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6616 * Mark all lists and dicts referenced through list "l" with "copyID".
6618 static void
6619 set_ref_in_list(l, copyID)
6620 list_T *l;
6621 int copyID;
6623 listitem_T *li;
6625 for (li = l->lv_first; li != NULL; li = li->li_next)
6626 set_ref_in_item(&li->li_tv, copyID);
6630 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6632 static void
6633 set_ref_in_item(tv, copyID)
6634 typval_T *tv;
6635 int copyID;
6637 dict_T *dd;
6638 list_T *ll;
6640 switch (tv->v_type)
6642 case VAR_DICT:
6643 dd = tv->vval.v_dict;
6644 if (dd != NULL && dd->dv_copyID != copyID)
6646 /* Didn't see this dict yet. */
6647 dd->dv_copyID = copyID;
6648 set_ref_in_ht(&dd->dv_hashtab, copyID);
6650 break;
6652 case VAR_LIST:
6653 ll = tv->vval.v_list;
6654 if (ll != NULL && ll->lv_copyID != copyID)
6656 /* Didn't see this list yet. */
6657 ll->lv_copyID = copyID;
6658 set_ref_in_list(ll, copyID);
6660 break;
6662 return;
6666 * Allocate an empty header for a dictionary.
6668 dict_T *
6669 dict_alloc()
6671 dict_T *d;
6673 d = (dict_T *)alloc(sizeof(dict_T));
6674 if (d != NULL)
6676 /* Add the list to the list of dicts for garbage collection. */
6677 if (first_dict != NULL)
6678 first_dict->dv_used_prev = d;
6679 d->dv_used_next = first_dict;
6680 d->dv_used_prev = NULL;
6681 first_dict = d;
6683 hash_init(&d->dv_hashtab);
6684 d->dv_lock = 0;
6685 d->dv_refcount = 0;
6686 d->dv_copyID = 0;
6688 return d;
6692 * Unreference a Dictionary: decrement the reference count and free it when it
6693 * becomes zero.
6695 static void
6696 dict_unref(d)
6697 dict_T *d;
6699 if (d != NULL && --d->dv_refcount <= 0)
6700 dict_free(d, TRUE);
6704 * Free a Dictionary, including all items it contains.
6705 * Ignores the reference count.
6707 static void
6708 dict_free(d, recurse)
6709 dict_T *d;
6710 int recurse; /* Free Lists and Dictionaries recursively. */
6712 int todo;
6713 hashitem_T *hi;
6714 dictitem_T *di;
6716 /* Remove the dict from the list of dicts for garbage collection. */
6717 if (d->dv_used_prev == NULL)
6718 first_dict = d->dv_used_next;
6719 else
6720 d->dv_used_prev->dv_used_next = d->dv_used_next;
6721 if (d->dv_used_next != NULL)
6722 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6724 /* Lock the hashtab, we don't want it to resize while freeing items. */
6725 hash_lock(&d->dv_hashtab);
6726 todo = (int)d->dv_hashtab.ht_used;
6727 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6729 if (!HASHITEM_EMPTY(hi))
6731 /* Remove the item before deleting it, just in case there is
6732 * something recursive causing trouble. */
6733 di = HI2DI(hi);
6734 hash_remove(&d->dv_hashtab, hi);
6735 if (recurse || (di->di_tv.v_type != VAR_LIST
6736 && di->di_tv.v_type != VAR_DICT))
6737 clear_tv(&di->di_tv);
6738 vim_free(di);
6739 --todo;
6742 hash_clear(&d->dv_hashtab);
6743 vim_free(d);
6747 * Allocate a Dictionary item.
6748 * The "key" is copied to the new item.
6749 * Note that the value of the item "di_tv" still needs to be initialized!
6750 * Returns NULL when out of memory.
6752 static dictitem_T *
6753 dictitem_alloc(key)
6754 char_u *key;
6756 dictitem_T *di;
6758 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6759 if (di != NULL)
6761 STRCPY(di->di_key, key);
6762 di->di_flags = 0;
6764 return di;
6768 * Make a copy of a Dictionary item.
6770 static dictitem_T *
6771 dictitem_copy(org)
6772 dictitem_T *org;
6774 dictitem_T *di;
6776 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6777 + STRLEN(org->di_key)));
6778 if (di != NULL)
6780 STRCPY(di->di_key, org->di_key);
6781 di->di_flags = 0;
6782 copy_tv(&org->di_tv, &di->di_tv);
6784 return di;
6788 * Remove item "item" from Dictionary "dict" and free it.
6790 static void
6791 dictitem_remove(dict, item)
6792 dict_T *dict;
6793 dictitem_T *item;
6795 hashitem_T *hi;
6797 hi = hash_find(&dict->dv_hashtab, item->di_key);
6798 if (HASHITEM_EMPTY(hi))
6799 EMSG2(_(e_intern2), "dictitem_remove()");
6800 else
6801 hash_remove(&dict->dv_hashtab, hi);
6802 dictitem_free(item);
6806 * Free a dict item. Also clears the value.
6808 static void
6809 dictitem_free(item)
6810 dictitem_T *item;
6812 clear_tv(&item->di_tv);
6813 vim_free(item);
6817 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6818 * The refcount of the new dict is set to 1.
6819 * See item_copy() for "copyID".
6820 * Returns NULL when out of memory.
6822 static dict_T *
6823 dict_copy(orig, deep, copyID)
6824 dict_T *orig;
6825 int deep;
6826 int copyID;
6828 dict_T *copy;
6829 dictitem_T *di;
6830 int todo;
6831 hashitem_T *hi;
6833 if (orig == NULL)
6834 return NULL;
6836 copy = dict_alloc();
6837 if (copy != NULL)
6839 if (copyID != 0)
6841 orig->dv_copyID = copyID;
6842 orig->dv_copydict = copy;
6844 todo = (int)orig->dv_hashtab.ht_used;
6845 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6847 if (!HASHITEM_EMPTY(hi))
6849 --todo;
6851 di = dictitem_alloc(hi->hi_key);
6852 if (di == NULL)
6853 break;
6854 if (deep)
6856 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6857 copyID) == FAIL)
6859 vim_free(di);
6860 break;
6863 else
6864 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6865 if (dict_add(copy, di) == FAIL)
6867 dictitem_free(di);
6868 break;
6873 ++copy->dv_refcount;
6874 if (todo > 0)
6876 dict_unref(copy);
6877 copy = NULL;
6881 return copy;
6885 * Add item "item" to Dictionary "d".
6886 * Returns FAIL when out of memory and when key already existed.
6888 static int
6889 dict_add(d, item)
6890 dict_T *d;
6891 dictitem_T *item;
6893 return hash_add(&d->dv_hashtab, item->di_key);
6897 * Add a number or string entry to dictionary "d".
6898 * When "str" is NULL use number "nr", otherwise use "str".
6899 * Returns FAIL when out of memory and when key already exists.
6902 dict_add_nr_str(d, key, nr, str)
6903 dict_T *d;
6904 char *key;
6905 long nr;
6906 char_u *str;
6908 dictitem_T *item;
6910 item = dictitem_alloc((char_u *)key);
6911 if (item == NULL)
6912 return FAIL;
6913 item->di_tv.v_lock = 0;
6914 if (str == NULL)
6916 item->di_tv.v_type = VAR_NUMBER;
6917 item->di_tv.vval.v_number = nr;
6919 else
6921 item->di_tv.v_type = VAR_STRING;
6922 item->di_tv.vval.v_string = vim_strsave(str);
6924 if (dict_add(d, item) == FAIL)
6926 dictitem_free(item);
6927 return FAIL;
6929 return OK;
6933 * Get the number of items in a Dictionary.
6935 static long
6936 dict_len(d)
6937 dict_T *d;
6939 if (d == NULL)
6940 return 0L;
6941 return (long)d->dv_hashtab.ht_used;
6945 * Find item "key[len]" in Dictionary "d".
6946 * If "len" is negative use strlen(key).
6947 * Returns NULL when not found.
6949 static dictitem_T *
6950 dict_find(d, key, len)
6951 dict_T *d;
6952 char_u *key;
6953 int len;
6955 #define AKEYLEN 200
6956 char_u buf[AKEYLEN];
6957 char_u *akey;
6958 char_u *tofree = NULL;
6959 hashitem_T *hi;
6961 if (len < 0)
6962 akey = key;
6963 else if (len >= AKEYLEN)
6965 tofree = akey = vim_strnsave(key, len);
6966 if (akey == NULL)
6967 return NULL;
6969 else
6971 /* Avoid a malloc/free by using buf[]. */
6972 vim_strncpy(buf, key, len);
6973 akey = buf;
6976 hi = hash_find(&d->dv_hashtab, akey);
6977 vim_free(tofree);
6978 if (HASHITEM_EMPTY(hi))
6979 return NULL;
6980 return HI2DI(hi);
6984 * Get a string item from a dictionary.
6985 * When "save" is TRUE allocate memory for it.
6986 * Returns NULL if the entry doesn't exist or out of memory.
6988 char_u *
6989 get_dict_string(d, key, save)
6990 dict_T *d;
6991 char_u *key;
6992 int save;
6994 dictitem_T *di;
6995 char_u *s;
6997 di = dict_find(d, key, -1);
6998 if (di == NULL)
6999 return NULL;
7000 s = get_tv_string(&di->di_tv);
7001 if (save && s != NULL)
7002 s = vim_strsave(s);
7003 return s;
7007 * Get a number item from a dictionary.
7008 * Returns 0 if the entry doesn't exist or out of memory.
7010 long
7011 get_dict_number(d, key)
7012 dict_T *d;
7013 char_u *key;
7015 dictitem_T *di;
7017 di = dict_find(d, key, -1);
7018 if (di == NULL)
7019 return 0;
7020 return get_tv_number(&di->di_tv);
7024 * Return an allocated string with the string representation of a Dictionary.
7025 * May return NULL.
7027 static char_u *
7028 dict2string(tv, copyID)
7029 typval_T *tv;
7030 int copyID;
7032 garray_T ga;
7033 int first = TRUE;
7034 char_u *tofree;
7035 char_u numbuf[NUMBUFLEN];
7036 hashitem_T *hi;
7037 char_u *s;
7038 dict_T *d;
7039 int todo;
7041 if ((d = tv->vval.v_dict) == NULL)
7042 return NULL;
7043 ga_init2(&ga, (int)sizeof(char), 80);
7044 ga_append(&ga, '{');
7046 todo = (int)d->dv_hashtab.ht_used;
7047 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7049 if (!HASHITEM_EMPTY(hi))
7051 --todo;
7053 if (first)
7054 first = FALSE;
7055 else
7056 ga_concat(&ga, (char_u *)", ");
7058 tofree = string_quote(hi->hi_key, FALSE);
7059 if (tofree != NULL)
7061 ga_concat(&ga, tofree);
7062 vim_free(tofree);
7064 ga_concat(&ga, (char_u *)": ");
7065 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7066 if (s != NULL)
7067 ga_concat(&ga, s);
7068 vim_free(tofree);
7069 if (s == NULL)
7070 break;
7073 if (todo > 0)
7075 vim_free(ga.ga_data);
7076 return NULL;
7079 ga_append(&ga, '}');
7080 ga_append(&ga, NUL);
7081 return (char_u *)ga.ga_data;
7085 * Allocate a variable for a Dictionary and fill it from "*arg".
7086 * Return OK or FAIL. Returns NOTDONE for {expr}.
7088 static int
7089 get_dict_tv(arg, rettv, evaluate)
7090 char_u **arg;
7091 typval_T *rettv;
7092 int evaluate;
7094 dict_T *d = NULL;
7095 typval_T tvkey;
7096 typval_T tv;
7097 char_u *key = NULL;
7098 dictitem_T *item;
7099 char_u *start = skipwhite(*arg + 1);
7100 char_u buf[NUMBUFLEN];
7103 * First check if it's not a curly-braces thing: {expr}.
7104 * Must do this without evaluating, otherwise a function may be called
7105 * twice. Unfortunately this means we need to call eval1() twice for the
7106 * first item.
7107 * But {} is an empty Dictionary.
7109 if (*start != '}')
7111 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7112 return FAIL;
7113 if (*start == '}')
7114 return NOTDONE;
7117 if (evaluate)
7119 d = dict_alloc();
7120 if (d == NULL)
7121 return FAIL;
7123 tvkey.v_type = VAR_UNKNOWN;
7124 tv.v_type = VAR_UNKNOWN;
7126 *arg = skipwhite(*arg + 1);
7127 while (**arg != '}' && **arg != NUL)
7129 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7130 goto failret;
7131 if (**arg != ':')
7133 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7134 clear_tv(&tvkey);
7135 goto failret;
7137 if (evaluate)
7139 key = get_tv_string_buf_chk(&tvkey, buf);
7140 if (key == NULL || *key == NUL)
7142 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7143 if (key != NULL)
7144 EMSG(_(e_emptykey));
7145 clear_tv(&tvkey);
7146 goto failret;
7150 *arg = skipwhite(*arg + 1);
7151 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7153 if (evaluate)
7154 clear_tv(&tvkey);
7155 goto failret;
7157 if (evaluate)
7159 item = dict_find(d, key, -1);
7160 if (item != NULL)
7162 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7163 clear_tv(&tvkey);
7164 clear_tv(&tv);
7165 goto failret;
7167 item = dictitem_alloc(key);
7168 clear_tv(&tvkey);
7169 if (item != NULL)
7171 item->di_tv = tv;
7172 item->di_tv.v_lock = 0;
7173 if (dict_add(d, item) == FAIL)
7174 dictitem_free(item);
7178 if (**arg == '}')
7179 break;
7180 if (**arg != ',')
7182 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7183 goto failret;
7185 *arg = skipwhite(*arg + 1);
7188 if (**arg != '}')
7190 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7191 failret:
7192 if (evaluate)
7193 dict_free(d, TRUE);
7194 return FAIL;
7197 *arg = skipwhite(*arg + 1);
7198 if (evaluate)
7200 rettv->v_type = VAR_DICT;
7201 rettv->vval.v_dict = d;
7202 ++d->dv_refcount;
7205 return OK;
7209 * Return a string with the string representation of a variable.
7210 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7211 * "numbuf" is used for a number.
7212 * Does not put quotes around strings, as ":echo" displays values.
7213 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7214 * May return NULL.
7216 static char_u *
7217 echo_string(tv, tofree, numbuf, copyID)
7218 typval_T *tv;
7219 char_u **tofree;
7220 char_u *numbuf;
7221 int copyID;
7223 static int recurse = 0;
7224 char_u *r = NULL;
7226 if (recurse >= DICT_MAXNEST)
7228 EMSG(_("E724: variable nested too deep for displaying"));
7229 *tofree = NULL;
7230 return NULL;
7232 ++recurse;
7234 switch (tv->v_type)
7236 case VAR_FUNC:
7237 *tofree = NULL;
7238 r = tv->vval.v_string;
7239 break;
7241 case VAR_LIST:
7242 if (tv->vval.v_list == NULL)
7244 *tofree = NULL;
7245 r = NULL;
7247 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7249 *tofree = NULL;
7250 r = (char_u *)"[...]";
7252 else
7254 tv->vval.v_list->lv_copyID = copyID;
7255 *tofree = list2string(tv, copyID);
7256 r = *tofree;
7258 break;
7260 case VAR_DICT:
7261 if (tv->vval.v_dict == NULL)
7263 *tofree = NULL;
7264 r = NULL;
7266 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7268 *tofree = NULL;
7269 r = (char_u *)"{...}";
7271 else
7273 tv->vval.v_dict->dv_copyID = copyID;
7274 *tofree = dict2string(tv, copyID);
7275 r = *tofree;
7277 break;
7279 case VAR_STRING:
7280 case VAR_NUMBER:
7281 *tofree = NULL;
7282 r = get_tv_string_buf(tv, numbuf);
7283 break;
7285 #ifdef FEAT_FLOAT
7286 case VAR_FLOAT:
7287 *tofree = NULL;
7288 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7289 r = numbuf;
7290 break;
7291 #endif
7293 default:
7294 EMSG2(_(e_intern2), "echo_string()");
7295 *tofree = NULL;
7298 --recurse;
7299 return r;
7303 * Return a string with the string representation of a variable.
7304 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7305 * "numbuf" is used for a number.
7306 * Puts quotes around strings, so that they can be parsed back by eval().
7307 * May return NULL.
7309 static char_u *
7310 tv2string(tv, tofree, numbuf, copyID)
7311 typval_T *tv;
7312 char_u **tofree;
7313 char_u *numbuf;
7314 int copyID;
7316 switch (tv->v_type)
7318 case VAR_FUNC:
7319 *tofree = string_quote(tv->vval.v_string, TRUE);
7320 return *tofree;
7321 case VAR_STRING:
7322 *tofree = string_quote(tv->vval.v_string, FALSE);
7323 return *tofree;
7324 #ifdef FEAT_FLOAT
7325 case VAR_FLOAT:
7326 *tofree = NULL;
7327 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7328 return numbuf;
7329 #endif
7330 case VAR_NUMBER:
7331 case VAR_LIST:
7332 case VAR_DICT:
7333 break;
7334 default:
7335 EMSG2(_(e_intern2), "tv2string()");
7337 return echo_string(tv, tofree, numbuf, copyID);
7341 * Return string "str" in ' quotes, doubling ' characters.
7342 * If "str" is NULL an empty string is assumed.
7343 * If "function" is TRUE make it function('string').
7345 static char_u *
7346 string_quote(str, function)
7347 char_u *str;
7348 int function;
7350 unsigned len;
7351 char_u *p, *r, *s;
7353 len = (function ? 13 : 3);
7354 if (str != NULL)
7356 len += (unsigned)STRLEN(str);
7357 for (p = str; *p != NUL; mb_ptr_adv(p))
7358 if (*p == '\'')
7359 ++len;
7361 s = r = alloc(len);
7362 if (r != NULL)
7364 if (function)
7366 STRCPY(r, "function('");
7367 r += 10;
7369 else
7370 *r++ = '\'';
7371 if (str != NULL)
7372 for (p = str; *p != NUL; )
7374 if (*p == '\'')
7375 *r++ = '\'';
7376 MB_COPY_CHAR(p, r);
7378 *r++ = '\'';
7379 if (function)
7380 *r++ = ')';
7381 *r++ = NUL;
7383 return s;
7386 #ifdef FEAT_FLOAT
7388 * Convert the string "text" to a floating point number.
7389 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7390 * this always uses a decimal point.
7391 * Returns the length of the text that was consumed.
7393 static int
7394 string2float(text, value)
7395 char_u *text;
7396 float_T *value; /* result stored here */
7398 char *s = (char *)text;
7399 float_T f;
7401 f = strtod(s, &s);
7402 *value = f;
7403 return (int)((char_u *)s - text);
7405 #endif
7408 * Get the value of an environment variable.
7409 * "arg" is pointing to the '$'. It is advanced to after the name.
7410 * If the environment variable was not set, silently assume it is empty.
7411 * Always return OK.
7413 static int
7414 get_env_tv(arg, rettv, evaluate)
7415 char_u **arg;
7416 typval_T *rettv;
7417 int evaluate;
7419 char_u *string = NULL;
7420 int len;
7421 int cc;
7422 char_u *name;
7423 int mustfree = FALSE;
7425 ++*arg;
7426 name = *arg;
7427 len = get_env_len(arg);
7428 if (evaluate)
7430 if (len != 0)
7432 cc = name[len];
7433 name[len] = NUL;
7434 /* first try vim_getenv(), fast for normal environment vars */
7435 string = vim_getenv(name, &mustfree);
7436 if (string != NULL && *string != NUL)
7438 if (!mustfree)
7439 string = vim_strsave(string);
7441 else
7443 if (mustfree)
7444 vim_free(string);
7446 /* next try expanding things like $VIM and ${HOME} */
7447 string = expand_env_save(name - 1);
7448 if (string != NULL && *string == '$')
7450 vim_free(string);
7451 string = NULL;
7454 name[len] = cc;
7456 rettv->v_type = VAR_STRING;
7457 rettv->vval.v_string = string;
7460 return OK;
7464 * Array with names and number of arguments of all internal functions
7465 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7467 static struct fst
7469 char *f_name; /* function name */
7470 char f_min_argc; /* minimal number of arguments */
7471 char f_max_argc; /* maximal number of arguments */
7472 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7473 /* implementation of function */
7474 } functions[] =
7476 #ifdef FEAT_FLOAT
7477 {"abs", 1, 1, f_abs},
7478 {"acos", 1, 1, f_acos}, /* WJMc */
7479 #endif
7480 {"add", 2, 2, f_add},
7481 {"append", 2, 2, f_append},
7482 {"argc", 0, 0, f_argc},
7483 {"argidx", 0, 0, f_argidx},
7484 {"argv", 0, 1, f_argv},
7485 #ifdef FEAT_FLOAT
7486 {"asin", 1, 1, f_asin}, /* WJMc */
7487 {"atan", 1, 1, f_atan},
7488 {"atan2", 2, 2, f_atan2}, /* WJMc */
7489 #endif
7490 {"browse", 4, 4, f_browse},
7491 {"browsedir", 2, 2, f_browsedir},
7492 {"bufexists", 1, 1, f_bufexists},
7493 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7494 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7495 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7496 {"buflisted", 1, 1, f_buflisted},
7497 {"bufloaded", 1, 1, f_bufloaded},
7498 {"bufname", 1, 1, f_bufname},
7499 {"bufnr", 1, 2, f_bufnr},
7500 {"bufwinnr", 1, 1, f_bufwinnr},
7501 {"byte2line", 1, 1, f_byte2line},
7502 {"byteidx", 2, 2, f_byteidx},
7503 {"call", 2, 3, f_call},
7504 #ifdef FEAT_FLOAT
7505 {"ceil", 1, 1, f_ceil},
7506 #endif
7507 {"changenr", 0, 0, f_changenr},
7508 {"char2nr", 1, 1, f_char2nr},
7509 {"cindent", 1, 1, f_cindent},
7510 {"clearmatches", 0, 0, f_clearmatches},
7511 {"col", 1, 1, f_col},
7512 #if defined(FEAT_INS_EXPAND)
7513 {"complete", 2, 2, f_complete},
7514 {"complete_add", 1, 1, f_complete_add},
7515 {"complete_check", 0, 0, f_complete_check},
7516 #endif
7517 {"confirm", 1, 4, f_confirm},
7518 {"copy", 1, 1, f_copy},
7519 #ifdef FEAT_FLOAT
7520 {"cos", 1, 1, f_cos},
7521 {"cosh", 1, 1, f_cosh}, /* WJMc */
7522 #endif
7523 {"count", 2, 4, f_count},
7524 {"cscope_connection",0,3, f_cscope_connection},
7525 {"cursor", 1, 3, f_cursor},
7526 {"deepcopy", 1, 2, f_deepcopy},
7527 {"delete", 1, 1, f_delete},
7528 {"did_filetype", 0, 0, f_did_filetype},
7529 {"diff_filler", 1, 1, f_diff_filler},
7530 {"diff_hlID", 2, 2, f_diff_hlID},
7531 {"empty", 1, 1, f_empty},
7532 {"escape", 2, 2, f_escape},
7533 {"eval", 1, 1, f_eval},
7534 {"eventhandler", 0, 0, f_eventhandler},
7535 {"executable", 1, 1, f_executable},
7536 {"exists", 1, 1, f_exists},
7537 #ifdef FEAT_FLOAT
7538 {"exp", 1, 1, f_exp}, /* WJMc */
7539 #endif
7540 {"expand", 1, 2, f_expand},
7541 {"extend", 2, 3, f_extend},
7542 {"feedkeys", 1, 2, f_feedkeys},
7543 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7544 {"filereadable", 1, 1, f_filereadable},
7545 {"filewritable", 1, 1, f_filewritable},
7546 {"filter", 2, 2, f_filter},
7547 {"finddir", 1, 3, f_finddir},
7548 {"findfile", 1, 3, f_findfile},
7549 #ifdef FEAT_FLOAT
7550 {"float2nr", 1, 1, f_float2nr},
7551 {"floor", 1, 1, f_floor},
7552 {"fmod", 2, 2, f_fmod}, /* WJMc */
7553 #endif
7554 {"fnameescape", 1, 1, f_fnameescape},
7555 {"fnamemodify", 2, 2, f_fnamemodify},
7556 {"foldclosed", 1, 1, f_foldclosed},
7557 {"foldclosedend", 1, 1, f_foldclosedend},
7558 {"foldlevel", 1, 1, f_foldlevel},
7559 {"foldtext", 0, 0, f_foldtext},
7560 {"foldtextresult", 1, 1, f_foldtextresult},
7561 {"foreground", 0, 0, f_foreground},
7562 {"function", 1, 1, f_function},
7563 {"garbagecollect", 0, 1, f_garbagecollect},
7564 {"get", 2, 3, f_get},
7565 {"getbufline", 2, 3, f_getbufline},
7566 {"getbufvar", 2, 2, f_getbufvar},
7567 {"getchar", 0, 1, f_getchar},
7568 {"getcharmod", 0, 0, f_getcharmod},
7569 {"getcmdline", 0, 0, f_getcmdline},
7570 {"getcmdpos", 0, 0, f_getcmdpos},
7571 {"getcmdtype", 0, 0, f_getcmdtype},
7572 {"getcwd", 0, 0, f_getcwd},
7573 {"getfontname", 0, 1, f_getfontname},
7574 {"getfperm", 1, 1, f_getfperm},
7575 {"getfsize", 1, 1, f_getfsize},
7576 {"getftime", 1, 1, f_getftime},
7577 {"getftype", 1, 1, f_getftype},
7578 {"getline", 1, 2, f_getline},
7579 {"getloclist", 1, 1, f_getqflist},
7580 {"getmatches", 0, 0, f_getmatches},
7581 {"getpid", 0, 0, f_getpid},
7582 {"getpos", 1, 1, f_getpos},
7583 {"getqflist", 0, 0, f_getqflist},
7584 {"getreg", 0, 2, f_getreg},
7585 {"getregtype", 0, 1, f_getregtype},
7586 {"gettabwinvar", 3, 3, f_gettabwinvar},
7587 {"getwinposx", 0, 0, f_getwinposx},
7588 {"getwinposy", 0, 0, f_getwinposy},
7589 {"getwinvar", 2, 2, f_getwinvar},
7590 {"glob", 1, 1, f_glob},
7591 {"globpath", 2, 2, f_globpath},
7592 {"has", 1, 1, f_has},
7593 {"has_key", 2, 2, f_has_key},
7594 {"haslocaldir", 0, 0, f_haslocaldir},
7595 {"hasmapto", 1, 3, f_hasmapto},
7596 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7597 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7598 {"histadd", 2, 2, f_histadd},
7599 {"histdel", 1, 2, f_histdel},
7600 {"histget", 1, 2, f_histget},
7601 {"histnr", 1, 1, f_histnr},
7602 {"hlID", 1, 1, f_hlID},
7603 {"hlexists", 1, 1, f_hlexists},
7604 {"hostname", 0, 0, f_hostname},
7605 {"iconv", 3, 3, f_iconv},
7606 {"indent", 1, 1, f_indent},
7607 {"index", 2, 4, f_index},
7608 {"input", 1, 3, f_input},
7609 {"inputdialog", 1, 3, f_inputdialog},
7610 {"inputlist", 1, 1, f_inputlist},
7611 {"inputrestore", 0, 0, f_inputrestore},
7612 {"inputsave", 0, 0, f_inputsave},
7613 {"inputsecret", 1, 2, f_inputsecret},
7614 {"insert", 2, 3, f_insert},
7615 {"isdirectory", 1, 1, f_isdirectory},
7616 {"islocked", 1, 1, f_islocked},
7617 {"items", 1, 1, f_items},
7618 {"join", 1, 2, f_join},
7619 {"keys", 1, 1, f_keys},
7620 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7621 {"len", 1, 1, f_len},
7622 {"libcall", 3, 3, f_libcall},
7623 {"libcallnr", 3, 3, f_libcallnr},
7624 {"line", 1, 1, f_line},
7625 {"line2byte", 1, 1, f_line2byte},
7626 {"lispindent", 1, 1, f_lispindent},
7627 {"localtime", 0, 0, f_localtime},
7628 #ifdef FEAT_FLOAT
7629 {"log", 1, 1, f_log}, /* WJMc */
7630 {"log10", 1, 1, f_log10},
7631 #endif
7632 {"map", 2, 2, f_map},
7633 {"maparg", 1, 3, f_maparg},
7634 {"mapcheck", 1, 3, f_mapcheck},
7635 {"match", 2, 4, f_match},
7636 {"matchadd", 2, 4, f_matchadd},
7637 {"matcharg", 1, 1, f_matcharg},
7638 {"matchdelete", 1, 1, f_matchdelete},
7639 {"matchend", 2, 4, f_matchend},
7640 {"matchlist", 2, 4, f_matchlist},
7641 {"matchstr", 2, 4, f_matchstr},
7642 {"max", 1, 1, f_max},
7643 {"min", 1, 1, f_min},
7644 #ifdef vim_mkdir
7645 {"mkdir", 1, 3, f_mkdir},
7646 #endif
7647 {"mode", 0, 1, f_mode},
7648 {"nextnonblank", 1, 1, f_nextnonblank},
7649 {"nr2char", 1, 1, f_nr2char},
7650 {"pathshorten", 1, 1, f_pathshorten},
7651 #ifdef FEAT_FLOAT
7652 {"pow", 2, 2, f_pow},
7653 #endif
7654 {"prevnonblank", 1, 1, f_prevnonblank},
7655 {"printf", 2, 19, f_printf},
7656 {"pumvisible", 0, 0, f_pumvisible},
7657 {"range", 1, 3, f_range},
7658 {"readfile", 1, 3, f_readfile},
7659 {"reltime", 0, 2, f_reltime},
7660 {"reltimestr", 1, 1, f_reltimestr},
7661 {"remote_expr", 2, 3, f_remote_expr},
7662 {"remote_foreground", 1, 1, f_remote_foreground},
7663 {"remote_peek", 1, 2, f_remote_peek},
7664 {"remote_read", 1, 1, f_remote_read},
7665 {"remote_send", 2, 3, f_remote_send},
7666 {"remove", 2, 3, f_remove},
7667 {"rename", 2, 2, f_rename},
7668 {"repeat", 2, 2, f_repeat},
7669 {"resolve", 1, 1, f_resolve},
7670 {"reverse", 1, 1, f_reverse},
7671 #ifdef FEAT_FLOAT
7672 {"round", 1, 1, f_round},
7673 #endif
7674 {"search", 1, 4, f_search},
7675 {"searchdecl", 1, 3, f_searchdecl},
7676 {"searchpair", 3, 7, f_searchpair},
7677 {"searchpairpos", 3, 7, f_searchpairpos},
7678 {"searchpos", 1, 4, f_searchpos},
7679 {"server2client", 2, 2, f_server2client},
7680 {"serverlist", 0, 0, f_serverlist},
7681 {"setbufvar", 3, 3, f_setbufvar},
7682 {"setcmdpos", 1, 1, f_setcmdpos},
7683 {"setline", 2, 2, f_setline},
7684 {"setloclist", 2, 3, f_setloclist},
7685 {"setmatches", 1, 1, f_setmatches},
7686 {"setpos", 2, 2, f_setpos},
7687 {"setqflist", 1, 2, f_setqflist},
7688 {"setreg", 2, 3, f_setreg},
7689 {"settabwinvar", 4, 4, f_settabwinvar},
7690 {"setwinvar", 3, 3, f_setwinvar},
7691 {"shellescape", 1, 2, f_shellescape},
7692 {"simplify", 1, 1, f_simplify},
7693 #ifdef FEAT_FLOAT
7694 {"sin", 1, 1, f_sin},
7695 {"sinh", 1, 1, f_sinh}, /* WJMc */
7696 #endif
7697 {"sort", 1, 2, f_sort},
7698 {"soundfold", 1, 1, f_soundfold},
7699 {"spellbadword", 0, 1, f_spellbadword},
7700 {"spellsuggest", 1, 3, f_spellsuggest},
7701 {"split", 1, 3, f_split},
7702 #ifdef FEAT_FLOAT
7703 {"sqrt", 1, 1, f_sqrt},
7704 {"str2float", 1, 1, f_str2float},
7705 #endif
7706 {"str2nr", 1, 2, f_str2nr},
7707 #ifdef HAVE_STRFTIME
7708 {"strftime", 1, 2, f_strftime},
7709 #endif
7710 {"stridx", 2, 3, f_stridx},
7711 {"string", 1, 1, f_string},
7712 {"strlen", 1, 1, f_strlen},
7713 {"strpart", 2, 3, f_strpart},
7714 {"strridx", 2, 3, f_strridx},
7715 {"strtrans", 1, 1, f_strtrans},
7716 {"submatch", 1, 1, f_submatch},
7717 {"substitute", 4, 4, f_substitute},
7718 {"synID", 3, 3, f_synID},
7719 {"synIDattr", 2, 3, f_synIDattr},
7720 {"synIDtrans", 1, 1, f_synIDtrans},
7721 {"synstack", 2, 2, f_synstack},
7722 {"system", 1, 2, f_system},
7723 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7724 {"tabpagenr", 0, 1, f_tabpagenr},
7725 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7726 {"tagfiles", 0, 0, f_tagfiles},
7727 {"taglist", 1, 1, f_taglist},
7728 {"tan", 1, 1, f_tan}, /* WJMc */
7729 {"tanh", 1, 1, f_tanh}, /* WJMc */
7730 {"tempname", 0, 0, f_tempname},
7731 {"test", 1, 1, f_test},
7732 {"tolower", 1, 1, f_tolower},
7733 {"toupper", 1, 1, f_toupper},
7734 {"tr", 3, 3, f_tr},
7735 #ifdef FEAT_FLOAT
7736 {"trunc", 1, 1, f_trunc},
7737 #endif
7738 {"type", 1, 1, f_type},
7739 {"values", 1, 1, f_values},
7740 {"virtcol", 1, 1, f_virtcol},
7741 {"visualmode", 0, 1, f_visualmode},
7742 {"winbufnr", 1, 1, f_winbufnr},
7743 {"wincol", 0, 0, f_wincol},
7744 {"winheight", 1, 1, f_winheight},
7745 {"winline", 0, 0, f_winline},
7746 {"winnr", 0, 1, f_winnr},
7747 {"winrestcmd", 0, 0, f_winrestcmd},
7748 {"winrestview", 1, 1, f_winrestview},
7749 {"winsaveview", 0, 0, f_winsaveview},
7750 {"winwidth", 1, 1, f_winwidth},
7751 {"writefile", 2, 3, f_writefile},
7754 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7757 * Function given to ExpandGeneric() to obtain the list of internal
7758 * or user defined function names.
7760 char_u *
7761 get_function_name(xp, idx)
7762 expand_T *xp;
7763 int idx;
7765 static int intidx = -1;
7766 char_u *name;
7768 if (idx == 0)
7769 intidx = -1;
7770 if (intidx < 0)
7772 name = get_user_func_name(xp, idx);
7773 if (name != NULL)
7774 return name;
7776 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7778 STRCPY(IObuff, functions[intidx].f_name);
7779 STRCAT(IObuff, "(");
7780 if (functions[intidx].f_max_argc == 0)
7781 STRCAT(IObuff, ")");
7782 return IObuff;
7785 return NULL;
7789 * Function given to ExpandGeneric() to obtain the list of internal or
7790 * user defined variable or function names.
7792 /*ARGSUSED*/
7793 char_u *
7794 get_expr_name(xp, idx)
7795 expand_T *xp;
7796 int idx;
7798 static int intidx = -1;
7799 char_u *name;
7801 if (idx == 0)
7802 intidx = -1;
7803 if (intidx < 0)
7805 name = get_function_name(xp, idx);
7806 if (name != NULL)
7807 return name;
7809 return get_user_var_name(xp, ++intidx);
7812 #endif /* FEAT_CMDL_COMPL */
7815 * Find internal function in table above.
7816 * Return index, or -1 if not found
7818 static int
7819 find_internal_func(name)
7820 char_u *name; /* name of the function */
7822 int first = 0;
7823 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7824 int cmp;
7825 int x;
7828 * Find the function name in the table. Binary search.
7830 while (first <= last)
7832 x = first + ((unsigned)(last - first) >> 1);
7833 cmp = STRCMP(name, functions[x].f_name);
7834 if (cmp < 0)
7835 last = x - 1;
7836 else if (cmp > 0)
7837 first = x + 1;
7838 else
7839 return x;
7841 return -1;
7845 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7846 * name it contains, otherwise return "name".
7848 static char_u *
7849 deref_func_name(name, lenp)
7850 char_u *name;
7851 int *lenp;
7853 dictitem_T *v;
7854 int cc;
7856 cc = name[*lenp];
7857 name[*lenp] = NUL;
7858 v = find_var(name, NULL);
7859 name[*lenp] = cc;
7860 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7862 if (v->di_tv.vval.v_string == NULL)
7864 *lenp = 0;
7865 return (char_u *)""; /* just in case */
7867 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7868 return v->di_tv.vval.v_string;
7871 return name;
7875 * Allocate a variable for the result of a function.
7876 * Return OK or FAIL.
7878 static int
7879 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7880 evaluate, selfdict)
7881 char_u *name; /* name of the function */
7882 int len; /* length of "name" */
7883 typval_T *rettv;
7884 char_u **arg; /* argument, pointing to the '(' */
7885 linenr_T firstline; /* first line of range */
7886 linenr_T lastline; /* last line of range */
7887 int *doesrange; /* return: function handled range */
7888 int evaluate;
7889 dict_T *selfdict; /* Dictionary for "self" */
7891 char_u *argp;
7892 int ret = OK;
7893 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7894 int argcount = 0; /* number of arguments found */
7897 * Get the arguments.
7899 argp = *arg;
7900 while (argcount < MAX_FUNC_ARGS)
7902 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7903 if (*argp == ')' || *argp == ',' || *argp == NUL)
7904 break;
7905 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7907 ret = FAIL;
7908 break;
7910 ++argcount;
7911 if (*argp != ',')
7912 break;
7914 if (*argp == ')')
7915 ++argp;
7916 else
7917 ret = FAIL;
7919 if (ret == OK)
7920 ret = call_func(name, len, rettv, argcount, argvars,
7921 firstline, lastline, doesrange, evaluate, selfdict);
7922 else if (!aborting())
7924 if (argcount == MAX_FUNC_ARGS)
7925 emsg_funcname("E740: Too many arguments for function %s", name);
7926 else
7927 emsg_funcname("E116: Invalid arguments for function %s", name);
7930 while (--argcount >= 0)
7931 clear_tv(&argvars[argcount]);
7933 *arg = skipwhite(argp);
7934 return ret;
7939 * Call a function with its resolved parameters
7940 * Return OK when the function can't be called, FAIL otherwise.
7941 * Also returns OK when an error was encountered while executing the function.
7943 static int
7944 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7945 doesrange, evaluate, selfdict)
7946 char_u *name; /* name of the function */
7947 int len; /* length of "name" */
7948 typval_T *rettv; /* return value goes here */
7949 int argcount; /* number of "argvars" */
7950 typval_T *argvars; /* vars for arguments, must have "argcount"
7951 PLUS ONE elements! */
7952 linenr_T firstline; /* first line of range */
7953 linenr_T lastline; /* last line of range */
7954 int *doesrange; /* return: function handled range */
7955 int evaluate;
7956 dict_T *selfdict; /* Dictionary for "self" */
7958 int ret = FAIL;
7959 #define ERROR_UNKNOWN 0
7960 #define ERROR_TOOMANY 1
7961 #define ERROR_TOOFEW 2
7962 #define ERROR_SCRIPT 3
7963 #define ERROR_DICT 4
7964 #define ERROR_NONE 5
7965 #define ERROR_OTHER 6
7966 int error = ERROR_NONE;
7967 int i;
7968 int llen;
7969 ufunc_T *fp;
7970 int cc;
7971 #define FLEN_FIXED 40
7972 char_u fname_buf[FLEN_FIXED + 1];
7973 char_u *fname;
7976 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7977 * Change <SNR>123_name() to K_SNR 123_name().
7978 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7980 cc = name[len];
7981 name[len] = NUL;
7982 llen = eval_fname_script(name);
7983 if (llen > 0)
7985 fname_buf[0] = K_SPECIAL;
7986 fname_buf[1] = KS_EXTRA;
7987 fname_buf[2] = (int)KE_SNR;
7988 i = 3;
7989 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7991 if (current_SID <= 0)
7992 error = ERROR_SCRIPT;
7993 else
7995 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7996 i = (int)STRLEN(fname_buf);
7999 if (i + STRLEN(name + llen) < FLEN_FIXED)
8001 STRCPY(fname_buf + i, name + llen);
8002 fname = fname_buf;
8004 else
8006 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8007 if (fname == NULL)
8008 error = ERROR_OTHER;
8009 else
8011 mch_memmove(fname, fname_buf, (size_t)i);
8012 STRCPY(fname + i, name + llen);
8016 else
8017 fname = name;
8019 *doesrange = FALSE;
8022 /* execute the function if no errors detected and executing */
8023 if (evaluate && error == ERROR_NONE)
8025 rettv->v_type = VAR_NUMBER; /* default is number rettv */
8026 error = ERROR_UNKNOWN;
8028 if (!builtin_function(fname))
8031 * User defined function.
8033 fp = find_func(fname);
8035 #ifdef FEAT_AUTOCMD
8036 /* Trigger FuncUndefined event, may load the function. */
8037 if (fp == NULL
8038 && apply_autocmds(EVENT_FUNCUNDEFINED,
8039 fname, fname, TRUE, NULL)
8040 && !aborting())
8042 /* executed an autocommand, search for the function again */
8043 fp = find_func(fname);
8045 #endif
8046 /* Try loading a package. */
8047 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8049 /* loaded a package, search for the function again */
8050 fp = find_func(fname);
8053 if (fp != NULL)
8055 if (fp->uf_flags & FC_RANGE)
8056 *doesrange = TRUE;
8057 if (argcount < fp->uf_args.ga_len)
8058 error = ERROR_TOOFEW;
8059 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8060 error = ERROR_TOOMANY;
8061 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8062 error = ERROR_DICT;
8063 else
8066 * Call the user function.
8067 * Save and restore search patterns, script variables and
8068 * redo buffer.
8070 save_search_patterns();
8071 saveRedobuff();
8072 ++fp->uf_calls;
8073 call_user_func(fp, argcount, argvars, rettv,
8074 firstline, lastline,
8075 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8076 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8077 && fp->uf_refcount <= 0)
8078 /* Function was unreferenced while being used, free it
8079 * now. */
8080 func_free(fp);
8081 restoreRedobuff();
8082 restore_search_patterns();
8083 error = ERROR_NONE;
8087 else
8090 * Find the function name in the table, call its implementation.
8092 i = find_internal_func(fname);
8093 if (i >= 0)
8095 if (argcount < functions[i].f_min_argc)
8096 error = ERROR_TOOFEW;
8097 else if (argcount > functions[i].f_max_argc)
8098 error = ERROR_TOOMANY;
8099 else
8101 argvars[argcount].v_type = VAR_UNKNOWN;
8102 functions[i].f_func(argvars, rettv);
8103 error = ERROR_NONE;
8108 * The function call (or "FuncUndefined" autocommand sequence) might
8109 * have been aborted by an error, an interrupt, or an explicitly thrown
8110 * exception that has not been caught so far. This situation can be
8111 * tested for by calling aborting(). For an error in an internal
8112 * function or for the "E132" error in call_user_func(), however, the
8113 * throw point at which the "force_abort" flag (temporarily reset by
8114 * emsg()) is normally updated has not been reached yet. We need to
8115 * update that flag first to make aborting() reliable.
8117 update_force_abort();
8119 if (error == ERROR_NONE)
8120 ret = OK;
8123 * Report an error unless the argument evaluation or function call has been
8124 * cancelled due to an aborting error, an interrupt, or an exception.
8126 if (!aborting())
8128 switch (error)
8130 case ERROR_UNKNOWN:
8131 emsg_funcname(N_("E117: Unknown function: %s"), name);
8132 break;
8133 case ERROR_TOOMANY:
8134 emsg_funcname(e_toomanyarg, name);
8135 break;
8136 case ERROR_TOOFEW:
8137 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8138 name);
8139 break;
8140 case ERROR_SCRIPT:
8141 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8142 name);
8143 break;
8144 case ERROR_DICT:
8145 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8146 name);
8147 break;
8151 name[len] = cc;
8152 if (fname != name && fname != fname_buf)
8153 vim_free(fname);
8155 return ret;
8159 * Give an error message with a function name. Handle <SNR> things.
8161 static void
8162 emsg_funcname(ermsg, name)
8163 char *ermsg;
8164 char_u *name;
8166 char_u *p;
8168 if (*name == K_SPECIAL)
8169 p = concat_str((char_u *)"<SNR>", name + 3);
8170 else
8171 p = name;
8172 EMSG2(_(ermsg), p);
8173 if (p != name)
8174 vim_free(p);
8178 * Return TRUE for a non-zero Number and a non-empty String.
8180 static int
8181 non_zero_arg(argvars)
8182 typval_T *argvars;
8184 return ((argvars[0].v_type == VAR_NUMBER
8185 && argvars[0].vval.v_number != 0)
8186 || (argvars[0].v_type == VAR_STRING
8187 && argvars[0].vval.v_string != NULL
8188 && *argvars[0].vval.v_string != NUL));
8191 /*********************************************
8192 * Implementation of the built-in functions
8195 #ifdef FEAT_FLOAT
8197 * "abs(expr)" function
8199 static void
8200 f_abs(argvars, rettv)
8201 typval_T *argvars;
8202 typval_T *rettv;
8204 if (argvars[0].v_type == VAR_FLOAT)
8206 rettv->v_type = VAR_FLOAT;
8207 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8209 else
8211 varnumber_T n;
8212 int error = FALSE;
8214 n = get_tv_number_chk(&argvars[0], &error);
8215 if (error)
8216 rettv->vval.v_number = -1;
8217 else if (n > 0)
8218 rettv->vval.v_number = n;
8219 else
8220 rettv->vval.v_number = -n;
8223 #endif
8226 * "add(list, item)" function
8228 static void
8229 f_add(argvars, rettv)
8230 typval_T *argvars;
8231 typval_T *rettv;
8233 list_T *l;
8235 rettv->vval.v_number = 1; /* Default: Failed */
8236 if (argvars[0].v_type == VAR_LIST)
8238 if ((l = argvars[0].vval.v_list) != NULL
8239 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8240 && list_append_tv(l, &argvars[1]) == OK)
8241 copy_tv(&argvars[0], rettv);
8243 else
8244 EMSG(_(e_listreq));
8248 * "append(lnum, string/list)" function
8250 static void
8251 f_append(argvars, rettv)
8252 typval_T *argvars;
8253 typval_T *rettv;
8255 long lnum;
8256 char_u *line;
8257 list_T *l = NULL;
8258 listitem_T *li = NULL;
8259 typval_T *tv;
8260 long added = 0;
8262 lnum = get_tv_lnum(argvars);
8263 if (lnum >= 0
8264 && lnum <= curbuf->b_ml.ml_line_count
8265 && u_save(lnum, lnum + 1) == OK)
8267 if (argvars[1].v_type == VAR_LIST)
8269 l = argvars[1].vval.v_list;
8270 if (l == NULL)
8271 return;
8272 li = l->lv_first;
8274 rettv->vval.v_number = 0; /* Default: Success */
8275 for (;;)
8277 if (l == NULL)
8278 tv = &argvars[1]; /* append a string */
8279 else if (li == NULL)
8280 break; /* end of list */
8281 else
8282 tv = &li->li_tv; /* append item from list */
8283 line = get_tv_string_chk(tv);
8284 if (line == NULL) /* type error */
8286 rettv->vval.v_number = 1; /* Failed */
8287 break;
8289 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8290 ++added;
8291 if (l == NULL)
8292 break;
8293 li = li->li_next;
8296 appended_lines_mark(lnum, added);
8297 if (curwin->w_cursor.lnum > lnum)
8298 curwin->w_cursor.lnum += added;
8300 else
8301 rettv->vval.v_number = 1; /* Failed */
8305 * "argc()" function
8307 /* ARGSUSED */
8308 static void
8309 f_argc(argvars, rettv)
8310 typval_T *argvars;
8311 typval_T *rettv;
8313 rettv->vval.v_number = ARGCOUNT;
8317 * "argidx()" function
8319 /* ARGSUSED */
8320 static void
8321 f_argidx(argvars, rettv)
8322 typval_T *argvars;
8323 typval_T *rettv;
8325 rettv->vval.v_number = curwin->w_arg_idx;
8329 * "argv(nr)" function
8331 static void
8332 f_argv(argvars, rettv)
8333 typval_T *argvars;
8334 typval_T *rettv;
8336 int idx;
8338 if (argvars[0].v_type != VAR_UNKNOWN)
8340 idx = get_tv_number_chk(&argvars[0], NULL);
8341 if (idx >= 0 && idx < ARGCOUNT)
8342 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8343 else
8344 rettv->vval.v_string = NULL;
8345 rettv->v_type = VAR_STRING;
8347 else if (rettv_list_alloc(rettv) == OK)
8348 for (idx = 0; idx < ARGCOUNT; ++idx)
8349 list_append_string(rettv->vval.v_list,
8350 alist_name(&ARGLIST[idx]), -1);
8353 #ifdef FEAT_FLOAT
8354 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8357 * Get the float value of "argvars[0]" into "f".
8358 * Returns FAIL when the argument is not a Number or Float.
8360 static int
8361 get_float_arg(argvars, f)
8362 typval_T *argvars;
8363 float_T *f;
8365 if (argvars[0].v_type == VAR_FLOAT)
8367 *f = argvars[0].vval.v_float;
8368 return OK;
8370 if (argvars[0].v_type == VAR_NUMBER)
8372 *f = (float_T)argvars[0].vval.v_number;
8373 return OK;
8375 EMSG(_("E808: Number or Float required"));
8376 return FAIL;
8379 /* The 10 added FP functions are defined immediately before atan() - WJMc */
8382 * "acos()" function
8384 static void
8385 f_acos(argvars, rettv)
8386 typval_T *argvars;
8387 typval_T *rettv;
8389 float_T f;
8391 rettv->v_type = VAR_FLOAT;
8392 if (get_float_arg(argvars, &f) == OK)
8393 rettv->vval.v_float = acos(f);
8394 else
8395 rettv->vval.v_float = 0.0;
8399 * "asin()" function
8401 static void
8402 f_asin(argvars, rettv)
8403 typval_T *argvars;
8404 typval_T *rettv;
8406 float_T f;
8408 rettv->v_type = VAR_FLOAT;
8409 if (get_float_arg(argvars, &f) == OK)
8410 rettv->vval.v_float = asin(f);
8411 else
8412 rettv->vval.v_float = 0.0;
8416 * "atan2()" function
8418 static void
8419 f_atan2(argvars, rettv)
8420 typval_T *argvars;
8421 typval_T *rettv;
8423 float_T fx, fy;
8425 rettv->v_type = VAR_FLOAT;
8426 if (get_float_arg(argvars, &fx) == OK
8427 && get_float_arg(&argvars[1], &fy) == OK)
8428 rettv->vval.v_float = atan2(fx, fy);
8429 else
8430 rettv->vval.v_float = 0.0;
8434 * "cosh()" function
8436 static void
8437 f_cosh(argvars, rettv)
8438 typval_T *argvars;
8439 typval_T *rettv;
8441 float_T f;
8443 rettv->v_type = VAR_FLOAT;
8444 if (get_float_arg(argvars, &f) == OK)
8445 rettv->vval.v_float = cosh(f);
8446 else
8447 rettv->vval.v_float = 0.0;
8451 * "exp()" function
8453 static void
8454 f_exp(argvars, rettv)
8455 typval_T *argvars;
8456 typval_T *rettv;
8458 float_T f;
8460 rettv->v_type = VAR_FLOAT;
8461 if (get_float_arg(argvars, &f) == OK)
8462 rettv->vval.v_float = exp(f);
8463 else
8464 rettv->vval.v_float = 0.0;
8468 * "fmod()" function
8470 static void
8471 f_fmod(argvars, rettv)
8472 typval_T *argvars;
8473 typval_T *rettv;
8475 float_T fx, fy;
8477 rettv->v_type = VAR_FLOAT;
8478 if (get_float_arg(argvars, &fx) == OK
8479 && get_float_arg(&argvars[1], &fy) == OK)
8480 rettv->vval.v_float = fmod(fx, fy);
8481 else
8482 rettv->vval.v_float = 0.0;
8486 * "log()" function
8488 static void
8489 f_log(argvars, rettv)
8490 typval_T *argvars;
8491 typval_T *rettv;
8493 float_T f;
8495 rettv->v_type = VAR_FLOAT;
8496 if (get_float_arg(argvars, &f) == OK)
8497 rettv->vval.v_float = log(f);
8498 else
8499 rettv->vval.v_float = 0.0;
8503 * "sinh()" function
8505 static void
8506 f_sinh(argvars, rettv)
8507 typval_T *argvars;
8508 typval_T *rettv;
8510 float_T f;
8512 rettv->v_type = VAR_FLOAT;
8513 if (get_float_arg(argvars, &f) == OK)
8514 rettv->vval.v_float = sinh(f);
8515 else
8516 rettv->vval.v_float = 0.0;
8520 * "tan()" function
8522 static void
8523 f_tan(argvars, rettv)
8524 typval_T *argvars;
8525 typval_T *rettv;
8527 float_T f;
8529 rettv->v_type = VAR_FLOAT;
8530 if (get_float_arg(argvars, &f) == OK)
8531 rettv->vval.v_float = tan(f);
8532 else
8533 rettv->vval.v_float = 0.0;
8537 * "tanh()" function
8539 static void
8540 f_tanh(argvars, rettv)
8541 typval_T *argvars;
8542 typval_T *rettv;
8544 float_T f;
8546 rettv->v_type = VAR_FLOAT;
8547 if (get_float_arg(argvars, &f) == OK)
8548 rettv->vval.v_float = tanh(f);
8549 else
8550 rettv->vval.v_float = 0.0;
8553 /* End of the 10 added FP functions - WJMc */
8556 * "atan()" function
8558 static void
8559 f_atan(argvars, rettv)
8560 typval_T *argvars;
8561 typval_T *rettv;
8563 float_T f;
8565 rettv->v_type = VAR_FLOAT;
8566 if (get_float_arg(argvars, &f) == OK)
8567 rettv->vval.v_float = atan(f);
8568 else
8569 rettv->vval.v_float = 0.0;
8571 #endif
8574 * "browse(save, title, initdir, default)" function
8576 /* ARGSUSED */
8577 static void
8578 f_browse(argvars, rettv)
8579 typval_T *argvars;
8580 typval_T *rettv;
8582 #ifdef FEAT_BROWSE
8583 int save;
8584 char_u *title;
8585 char_u *initdir;
8586 char_u *defname;
8587 char_u buf[NUMBUFLEN];
8588 char_u buf2[NUMBUFLEN];
8589 int error = FALSE;
8591 save = get_tv_number_chk(&argvars[0], &error);
8592 title = get_tv_string_chk(&argvars[1]);
8593 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8594 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8596 if (error || title == NULL || initdir == NULL || defname == NULL)
8597 rettv->vval.v_string = NULL;
8598 else
8599 rettv->vval.v_string =
8600 do_browse(save ? BROWSE_SAVE : 0,
8601 title, defname, NULL, initdir, NULL, curbuf);
8602 #else
8603 rettv->vval.v_string = NULL;
8604 #endif
8605 rettv->v_type = VAR_STRING;
8609 * "browsedir(title, initdir)" function
8611 /* ARGSUSED */
8612 static void
8613 f_browsedir(argvars, rettv)
8614 typval_T *argvars;
8615 typval_T *rettv;
8617 #ifdef FEAT_BROWSE
8618 char_u *title;
8619 char_u *initdir;
8620 char_u buf[NUMBUFLEN];
8622 title = get_tv_string_chk(&argvars[0]);
8623 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8625 if (title == NULL || initdir == NULL)
8626 rettv->vval.v_string = NULL;
8627 else
8628 rettv->vval.v_string = do_browse(BROWSE_DIR,
8629 title, NULL, NULL, initdir, NULL, curbuf);
8630 #else
8631 rettv->vval.v_string = NULL;
8632 #endif
8633 rettv->v_type = VAR_STRING;
8636 static buf_T *find_buffer __ARGS((typval_T *avar));
8639 * Find a buffer by number or exact name.
8641 static buf_T *
8642 find_buffer(avar)
8643 typval_T *avar;
8645 buf_T *buf = NULL;
8647 if (avar->v_type == VAR_NUMBER)
8648 buf = buflist_findnr((int)avar->vval.v_number);
8649 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8651 buf = buflist_findname_exp(avar->vval.v_string);
8652 if (buf == NULL)
8654 /* No full path name match, try a match with a URL or a "nofile"
8655 * buffer, these don't use the full path. */
8656 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8657 if (buf->b_fname != NULL
8658 && (path_with_url(buf->b_fname)
8659 #ifdef FEAT_QUICKFIX
8660 || bt_nofile(buf)
8661 #endif
8663 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8664 break;
8667 return buf;
8671 * "bufexists(expr)" function
8673 static void
8674 f_bufexists(argvars, rettv)
8675 typval_T *argvars;
8676 typval_T *rettv;
8678 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8682 * "buflisted(expr)" function
8684 static void
8685 f_buflisted(argvars, rettv)
8686 typval_T *argvars;
8687 typval_T *rettv;
8689 buf_T *buf;
8691 buf = find_buffer(&argvars[0]);
8692 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8696 * "bufloaded(expr)" function
8698 static void
8699 f_bufloaded(argvars, rettv)
8700 typval_T *argvars;
8701 typval_T *rettv;
8703 buf_T *buf;
8705 buf = find_buffer(&argvars[0]);
8706 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8709 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8712 * Get buffer by number or pattern.
8714 static buf_T *
8715 get_buf_tv(tv)
8716 typval_T *tv;
8718 char_u *name = tv->vval.v_string;
8719 int save_magic;
8720 char_u *save_cpo;
8721 buf_T *buf;
8723 if (tv->v_type == VAR_NUMBER)
8724 return buflist_findnr((int)tv->vval.v_number);
8725 if (tv->v_type != VAR_STRING)
8726 return NULL;
8727 if (name == NULL || *name == NUL)
8728 return curbuf;
8729 if (name[0] == '$' && name[1] == NUL)
8730 return lastbuf;
8732 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8733 save_magic = p_magic;
8734 p_magic = TRUE;
8735 save_cpo = p_cpo;
8736 p_cpo = (char_u *)"";
8738 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8739 TRUE, FALSE));
8741 p_magic = save_magic;
8742 p_cpo = save_cpo;
8744 /* If not found, try expanding the name, like done for bufexists(). */
8745 if (buf == NULL)
8746 buf = find_buffer(tv);
8748 return buf;
8752 * "bufname(expr)" function
8754 static void
8755 f_bufname(argvars, rettv)
8756 typval_T *argvars;
8757 typval_T *rettv;
8759 buf_T *buf;
8761 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8762 ++emsg_off;
8763 buf = get_buf_tv(&argvars[0]);
8764 rettv->v_type = VAR_STRING;
8765 if (buf != NULL && buf->b_fname != NULL)
8766 rettv->vval.v_string = vim_strsave(buf->b_fname);
8767 else
8768 rettv->vval.v_string = NULL;
8769 --emsg_off;
8773 * "bufnr(expr)" function
8775 static void
8776 f_bufnr(argvars, rettv)
8777 typval_T *argvars;
8778 typval_T *rettv;
8780 buf_T *buf;
8781 int error = FALSE;
8782 char_u *name;
8784 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8785 ++emsg_off;
8786 buf = get_buf_tv(&argvars[0]);
8787 --emsg_off;
8789 /* If the buffer isn't found and the second argument is not zero create a
8790 * new buffer. */
8791 if (buf == NULL
8792 && argvars[1].v_type != VAR_UNKNOWN
8793 && get_tv_number_chk(&argvars[1], &error) != 0
8794 && !error
8795 && (name = get_tv_string_chk(&argvars[0])) != NULL
8796 && !error)
8797 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8799 if (buf != NULL)
8800 rettv->vval.v_number = buf->b_fnum;
8801 else
8802 rettv->vval.v_number = -1;
8806 * "bufwinnr(nr)" function
8808 static void
8809 f_bufwinnr(argvars, rettv)
8810 typval_T *argvars;
8811 typval_T *rettv;
8813 #ifdef FEAT_WINDOWS
8814 win_T *wp;
8815 int winnr = 0;
8816 #endif
8817 buf_T *buf;
8819 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8820 ++emsg_off;
8821 buf = get_buf_tv(&argvars[0]);
8822 #ifdef FEAT_WINDOWS
8823 for (wp = firstwin; wp; wp = wp->w_next)
8825 ++winnr;
8826 if (wp->w_buffer == buf)
8827 break;
8829 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8830 #else
8831 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8832 #endif
8833 --emsg_off;
8837 * "byte2line(byte)" function
8839 /*ARGSUSED*/
8840 static void
8841 f_byte2line(argvars, rettv)
8842 typval_T *argvars;
8843 typval_T *rettv;
8845 #ifndef FEAT_BYTEOFF
8846 rettv->vval.v_number = -1;
8847 #else
8848 long boff = 0;
8850 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8851 if (boff < 0)
8852 rettv->vval.v_number = -1;
8853 else
8854 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8855 (linenr_T)0, &boff);
8856 #endif
8860 * "byteidx()" function
8862 /*ARGSUSED*/
8863 static void
8864 f_byteidx(argvars, rettv)
8865 typval_T *argvars;
8866 typval_T *rettv;
8868 #ifdef FEAT_MBYTE
8869 char_u *t;
8870 #endif
8871 char_u *str;
8872 long idx;
8874 str = get_tv_string_chk(&argvars[0]);
8875 idx = get_tv_number_chk(&argvars[1], NULL);
8876 rettv->vval.v_number = -1;
8877 if (str == NULL || idx < 0)
8878 return;
8880 #ifdef FEAT_MBYTE
8881 t = str;
8882 for ( ; idx > 0; idx--)
8884 if (*t == NUL) /* EOL reached */
8885 return;
8886 t += (*mb_ptr2len)(t);
8888 rettv->vval.v_number = (varnumber_T)(t - str);
8889 #else
8890 if ((size_t)idx <= STRLEN(str))
8891 rettv->vval.v_number = idx;
8892 #endif
8896 * "call(func, arglist)" function
8898 static void
8899 f_call(argvars, rettv)
8900 typval_T *argvars;
8901 typval_T *rettv;
8903 char_u *func;
8904 typval_T argv[MAX_FUNC_ARGS + 1];
8905 int argc = 0;
8906 listitem_T *item;
8907 int dummy;
8908 dict_T *selfdict = NULL;
8910 rettv->vval.v_number = 0;
8911 if (argvars[1].v_type != VAR_LIST)
8913 EMSG(_(e_listreq));
8914 return;
8916 if (argvars[1].vval.v_list == NULL)
8917 return;
8919 if (argvars[0].v_type == VAR_FUNC)
8920 func = argvars[0].vval.v_string;
8921 else
8922 func = get_tv_string(&argvars[0]);
8923 if (*func == NUL)
8924 return; /* type error or empty name */
8926 if (argvars[2].v_type != VAR_UNKNOWN)
8928 if (argvars[2].v_type != VAR_DICT)
8930 EMSG(_(e_dictreq));
8931 return;
8933 selfdict = argvars[2].vval.v_dict;
8936 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8937 item = item->li_next)
8939 if (argc == MAX_FUNC_ARGS)
8941 EMSG(_("E699: Too many arguments"));
8942 break;
8944 /* Make a copy of each argument. This is needed to be able to set
8945 * v_lock to VAR_FIXED in the copy without changing the original list.
8947 copy_tv(&item->li_tv, &argv[argc++]);
8950 if (item == NULL)
8951 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8952 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8953 &dummy, TRUE, selfdict);
8955 /* Free the arguments. */
8956 while (argc > 0)
8957 clear_tv(&argv[--argc]);
8960 #ifdef FEAT_FLOAT
8962 * "ceil({float})" function
8964 static void
8965 f_ceil(argvars, rettv)
8966 typval_T *argvars;
8967 typval_T *rettv;
8969 float_T f;
8971 rettv->v_type = VAR_FLOAT;
8972 if (get_float_arg(argvars, &f) == OK)
8973 rettv->vval.v_float = ceil(f);
8974 else
8975 rettv->vval.v_float = 0.0;
8977 #endif
8980 * "changenr()" function
8982 /*ARGSUSED*/
8983 static void
8984 f_changenr(argvars, rettv)
8985 typval_T *argvars;
8986 typval_T *rettv;
8988 rettv->vval.v_number = curbuf->b_u_seq_cur;
8992 * "char2nr(string)" function
8994 static void
8995 f_char2nr(argvars, rettv)
8996 typval_T *argvars;
8997 typval_T *rettv;
8999 #ifdef FEAT_MBYTE
9000 if (has_mbyte)
9001 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
9002 else
9003 #endif
9004 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
9008 * "cindent(lnum)" function
9010 static void
9011 f_cindent(argvars, rettv)
9012 typval_T *argvars;
9013 typval_T *rettv;
9015 #ifdef FEAT_CINDENT
9016 pos_T pos;
9017 linenr_T lnum;
9019 pos = curwin->w_cursor;
9020 lnum = get_tv_lnum(argvars);
9021 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
9023 curwin->w_cursor.lnum = lnum;
9024 rettv->vval.v_number = get_c_indent();
9025 curwin->w_cursor = pos;
9027 else
9028 #endif
9029 rettv->vval.v_number = -1;
9033 * "clearmatches()" function
9035 /*ARGSUSED*/
9036 static void
9037 f_clearmatches(argvars, rettv)
9038 typval_T *argvars;
9039 typval_T *rettv;
9041 #ifdef FEAT_SEARCH_EXTRA
9042 clear_matches(curwin);
9043 #endif
9047 * "col(string)" function
9049 static void
9050 f_col(argvars, rettv)
9051 typval_T *argvars;
9052 typval_T *rettv;
9054 colnr_T col = 0;
9055 pos_T *fp;
9056 int fnum = curbuf->b_fnum;
9058 fp = var2fpos(&argvars[0], FALSE, &fnum);
9059 if (fp != NULL && fnum == curbuf->b_fnum)
9061 if (fp->col == MAXCOL)
9063 /* '> can be MAXCOL, get the length of the line then */
9064 if (fp->lnum <= curbuf->b_ml.ml_line_count)
9065 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
9066 else
9067 col = MAXCOL;
9069 else
9071 col = fp->col + 1;
9072 #ifdef FEAT_VIRTUALEDIT
9073 /* col(".") when the cursor is on the NUL at the end of the line
9074 * because of "coladd" can be seen as an extra column. */
9075 if (virtual_active() && fp == &curwin->w_cursor)
9077 char_u *p = ml_get_cursor();
9079 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
9080 curwin->w_virtcol - curwin->w_cursor.coladd))
9082 # ifdef FEAT_MBYTE
9083 int l;
9085 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
9086 col += l;
9087 # else
9088 if (*p != NUL && p[1] == NUL)
9089 ++col;
9090 # endif
9093 #endif
9096 rettv->vval.v_number = col;
9099 #if defined(FEAT_INS_EXPAND)
9101 * "complete()" function
9103 /*ARGSUSED*/
9104 static void
9105 f_complete(argvars, rettv)
9106 typval_T *argvars;
9107 typval_T *rettv;
9109 int startcol;
9111 if ((State & INSERT) == 0)
9113 EMSG(_("E785: complete() can only be used in Insert mode"));
9114 return;
9117 /* Check for undo allowed here, because if something was already inserted
9118 * the line was already saved for undo and this check isn't done. */
9119 if (!undo_allowed())
9120 return;
9122 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
9124 EMSG(_(e_invarg));
9125 return;
9128 startcol = get_tv_number_chk(&argvars[0], NULL);
9129 if (startcol <= 0)
9130 return;
9132 set_completion(startcol - 1, argvars[1].vval.v_list);
9136 * "complete_add()" function
9138 /*ARGSUSED*/
9139 static void
9140 f_complete_add(argvars, rettv)
9141 typval_T *argvars;
9142 typval_T *rettv;
9144 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9148 * "complete_check()" function
9150 /*ARGSUSED*/
9151 static void
9152 f_complete_check(argvars, rettv)
9153 typval_T *argvars;
9154 typval_T *rettv;
9156 int saved = RedrawingDisabled;
9158 RedrawingDisabled = 0;
9159 ins_compl_check_keys(0);
9160 rettv->vval.v_number = compl_interrupted;
9161 RedrawingDisabled = saved;
9163 #endif
9166 * "confirm(message, buttons[, default [, type]])" function
9168 /*ARGSUSED*/
9169 static void
9170 f_confirm(argvars, rettv)
9171 typval_T *argvars;
9172 typval_T *rettv;
9174 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9175 char_u *message;
9176 char_u *buttons = NULL;
9177 char_u buf[NUMBUFLEN];
9178 char_u buf2[NUMBUFLEN];
9179 int def = 1;
9180 int type = VIM_GENERIC;
9181 char_u *typestr;
9182 int error = FALSE;
9184 message = get_tv_string_chk(&argvars[0]);
9185 if (message == NULL)
9186 error = TRUE;
9187 if (argvars[1].v_type != VAR_UNKNOWN)
9189 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9190 if (buttons == NULL)
9191 error = TRUE;
9192 if (argvars[2].v_type != VAR_UNKNOWN)
9194 def = get_tv_number_chk(&argvars[2], &error);
9195 if (argvars[3].v_type != VAR_UNKNOWN)
9197 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9198 if (typestr == NULL)
9199 error = TRUE;
9200 else
9202 switch (TOUPPER_ASC(*typestr))
9204 case 'E': type = VIM_ERROR; break;
9205 case 'Q': type = VIM_QUESTION; break;
9206 case 'I': type = VIM_INFO; break;
9207 case 'W': type = VIM_WARNING; break;
9208 case 'G': type = VIM_GENERIC; break;
9215 if (buttons == NULL || *buttons == NUL)
9216 buttons = (char_u *)_("&Ok");
9218 if (error)
9219 rettv->vval.v_number = 0;
9220 else
9221 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9222 def, NULL);
9223 #else
9224 rettv->vval.v_number = 0;
9225 #endif
9229 * "copy()" function
9231 static void
9232 f_copy(argvars, rettv)
9233 typval_T *argvars;
9234 typval_T *rettv;
9236 item_copy(&argvars[0], rettv, FALSE, 0);
9239 #ifdef FEAT_FLOAT
9241 * "cos()" function
9243 static void
9244 f_cos(argvars, rettv)
9245 typval_T *argvars;
9246 typval_T *rettv;
9248 float_T f;
9250 rettv->v_type = VAR_FLOAT;
9251 if (get_float_arg(argvars, &f) == OK)
9252 rettv->vval.v_float = cos(f);
9253 else
9254 rettv->vval.v_float = 0.0;
9256 #endif
9259 * "count()" function
9261 static void
9262 f_count(argvars, rettv)
9263 typval_T *argvars;
9264 typval_T *rettv;
9266 long n = 0;
9267 int ic = FALSE;
9269 if (argvars[0].v_type == VAR_LIST)
9271 listitem_T *li;
9272 list_T *l;
9273 long idx;
9275 if ((l = argvars[0].vval.v_list) != NULL)
9277 li = l->lv_first;
9278 if (argvars[2].v_type != VAR_UNKNOWN)
9280 int error = FALSE;
9282 ic = get_tv_number_chk(&argvars[2], &error);
9283 if (argvars[3].v_type != VAR_UNKNOWN)
9285 idx = get_tv_number_chk(&argvars[3], &error);
9286 if (!error)
9288 li = list_find(l, idx);
9289 if (li == NULL)
9290 EMSGN(_(e_listidx), idx);
9293 if (error)
9294 li = NULL;
9297 for ( ; li != NULL; li = li->li_next)
9298 if (tv_equal(&li->li_tv, &argvars[1], ic))
9299 ++n;
9302 else if (argvars[0].v_type == VAR_DICT)
9304 int todo;
9305 dict_T *d;
9306 hashitem_T *hi;
9308 if ((d = argvars[0].vval.v_dict) != NULL)
9310 int error = FALSE;
9312 if (argvars[2].v_type != VAR_UNKNOWN)
9314 ic = get_tv_number_chk(&argvars[2], &error);
9315 if (argvars[3].v_type != VAR_UNKNOWN)
9316 EMSG(_(e_invarg));
9319 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9320 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9322 if (!HASHITEM_EMPTY(hi))
9324 --todo;
9325 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9326 ++n;
9331 else
9332 EMSG2(_(e_listdictarg), "count()");
9333 rettv->vval.v_number = n;
9337 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9339 * Checks the existence of a cscope connection.
9341 /*ARGSUSED*/
9342 static void
9343 f_cscope_connection(argvars, rettv)
9344 typval_T *argvars;
9345 typval_T *rettv;
9347 #ifdef FEAT_CSCOPE
9348 int num = 0;
9349 char_u *dbpath = NULL;
9350 char_u *prepend = NULL;
9351 char_u buf[NUMBUFLEN];
9353 if (argvars[0].v_type != VAR_UNKNOWN
9354 && argvars[1].v_type != VAR_UNKNOWN)
9356 num = (int)get_tv_number(&argvars[0]);
9357 dbpath = get_tv_string(&argvars[1]);
9358 if (argvars[2].v_type != VAR_UNKNOWN)
9359 prepend = get_tv_string_buf(&argvars[2], buf);
9362 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9363 #else
9364 rettv->vval.v_number = 0;
9365 #endif
9369 * "cursor(lnum, col)" function
9371 * Moves the cursor to the specified line and column
9373 /*ARGSUSED*/
9374 static void
9375 f_cursor(argvars, rettv)
9376 typval_T *argvars;
9377 typval_T *rettv;
9379 long line, col;
9380 #ifdef FEAT_VIRTUALEDIT
9381 long coladd = 0;
9382 #endif
9384 if (argvars[1].v_type == VAR_UNKNOWN)
9386 pos_T pos;
9388 if (list2fpos(argvars, &pos, NULL) == FAIL)
9389 return;
9390 line = pos.lnum;
9391 col = pos.col;
9392 #ifdef FEAT_VIRTUALEDIT
9393 coladd = pos.coladd;
9394 #endif
9396 else
9398 line = get_tv_lnum(argvars);
9399 col = get_tv_number_chk(&argvars[1], NULL);
9400 #ifdef FEAT_VIRTUALEDIT
9401 if (argvars[2].v_type != VAR_UNKNOWN)
9402 coladd = get_tv_number_chk(&argvars[2], NULL);
9403 #endif
9405 if (line < 0 || col < 0
9406 #ifdef FEAT_VIRTUALEDIT
9407 || coladd < 0
9408 #endif
9410 return; /* type error; errmsg already given */
9411 if (line > 0)
9412 curwin->w_cursor.lnum = line;
9413 if (col > 0)
9414 curwin->w_cursor.col = col - 1;
9415 #ifdef FEAT_VIRTUALEDIT
9416 curwin->w_cursor.coladd = coladd;
9417 #endif
9419 /* Make sure the cursor is in a valid position. */
9420 check_cursor();
9421 #ifdef FEAT_MBYTE
9422 /* Correct cursor for multi-byte character. */
9423 if (has_mbyte)
9424 mb_adjust_cursor();
9425 #endif
9427 curwin->w_set_curswant = TRUE;
9431 * "deepcopy()" function
9433 static void
9434 f_deepcopy(argvars, rettv)
9435 typval_T *argvars;
9436 typval_T *rettv;
9438 int noref = 0;
9440 if (argvars[1].v_type != VAR_UNKNOWN)
9441 noref = get_tv_number_chk(&argvars[1], NULL);
9442 if (noref < 0 || noref > 1)
9443 EMSG(_(e_invarg));
9444 else
9445 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9449 * "delete()" function
9451 static void
9452 f_delete(argvars, rettv)
9453 typval_T *argvars;
9454 typval_T *rettv;
9456 if (check_restricted() || check_secure())
9457 rettv->vval.v_number = -1;
9458 else
9459 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9463 * "did_filetype()" function
9465 /*ARGSUSED*/
9466 static void
9467 f_did_filetype(argvars, rettv)
9468 typval_T *argvars;
9469 typval_T *rettv;
9471 #ifdef FEAT_AUTOCMD
9472 rettv->vval.v_number = did_filetype;
9473 #else
9474 rettv->vval.v_number = 0;
9475 #endif
9479 * "diff_filler()" function
9481 /*ARGSUSED*/
9482 static void
9483 f_diff_filler(argvars, rettv)
9484 typval_T *argvars;
9485 typval_T *rettv;
9487 #ifdef FEAT_DIFF
9488 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9489 #endif
9493 * "diff_hlID()" function
9495 /*ARGSUSED*/
9496 static void
9497 f_diff_hlID(argvars, rettv)
9498 typval_T *argvars;
9499 typval_T *rettv;
9501 #ifdef FEAT_DIFF
9502 linenr_T lnum = get_tv_lnum(argvars);
9503 static linenr_T prev_lnum = 0;
9504 static int changedtick = 0;
9505 static int fnum = 0;
9506 static int change_start = 0;
9507 static int change_end = 0;
9508 static hlf_T hlID = (hlf_T)0;
9509 int filler_lines;
9510 int col;
9512 if (lnum < 0) /* ignore type error in {lnum} arg */
9513 lnum = 0;
9514 if (lnum != prev_lnum
9515 || changedtick != curbuf->b_changedtick
9516 || fnum != curbuf->b_fnum)
9518 /* New line, buffer, change: need to get the values. */
9519 filler_lines = diff_check(curwin, lnum);
9520 if (filler_lines < 0)
9522 if (filler_lines == -1)
9524 change_start = MAXCOL;
9525 change_end = -1;
9526 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9527 hlID = HLF_ADD; /* added line */
9528 else
9529 hlID = HLF_CHD; /* changed line */
9531 else
9532 hlID = HLF_ADD; /* added line */
9534 else
9535 hlID = (hlf_T)0;
9536 prev_lnum = lnum;
9537 changedtick = curbuf->b_changedtick;
9538 fnum = curbuf->b_fnum;
9541 if (hlID == HLF_CHD || hlID == HLF_TXD)
9543 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9544 if (col >= change_start && col <= change_end)
9545 hlID = HLF_TXD; /* changed text */
9546 else
9547 hlID = HLF_CHD; /* changed line */
9549 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9550 #endif
9554 * "empty({expr})" function
9556 static void
9557 f_empty(argvars, rettv)
9558 typval_T *argvars;
9559 typval_T *rettv;
9561 int n;
9563 switch (argvars[0].v_type)
9565 case VAR_STRING:
9566 case VAR_FUNC:
9567 n = argvars[0].vval.v_string == NULL
9568 || *argvars[0].vval.v_string == NUL;
9569 break;
9570 case VAR_NUMBER:
9571 n = argvars[0].vval.v_number == 0;
9572 break;
9573 #ifdef FEAT_FLOAT
9574 case VAR_FLOAT:
9575 n = argvars[0].vval.v_float == 0.0;
9576 break;
9577 #endif
9578 case VAR_LIST:
9579 n = argvars[0].vval.v_list == NULL
9580 || argvars[0].vval.v_list->lv_first == NULL;
9581 break;
9582 case VAR_DICT:
9583 n = argvars[0].vval.v_dict == NULL
9584 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9585 break;
9586 default:
9587 EMSG2(_(e_intern2), "f_empty()");
9588 n = 0;
9591 rettv->vval.v_number = n;
9595 * "escape({string}, {chars})" function
9597 static void
9598 f_escape(argvars, rettv)
9599 typval_T *argvars;
9600 typval_T *rettv;
9602 char_u buf[NUMBUFLEN];
9604 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9605 get_tv_string_buf(&argvars[1], buf));
9606 rettv->v_type = VAR_STRING;
9610 * "eval()" function
9612 /*ARGSUSED*/
9613 static void
9614 f_eval(argvars, rettv)
9615 typval_T *argvars;
9616 typval_T *rettv;
9618 char_u *s;
9620 s = get_tv_string_chk(&argvars[0]);
9621 if (s != NULL)
9622 s = skipwhite(s);
9624 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9626 rettv->v_type = VAR_NUMBER;
9627 rettv->vval.v_number = 0;
9629 else if (*s != NUL)
9630 EMSG(_(e_trailing));
9634 * "eventhandler()" function
9636 /*ARGSUSED*/
9637 static void
9638 f_eventhandler(argvars, rettv)
9639 typval_T *argvars;
9640 typval_T *rettv;
9642 rettv->vval.v_number = vgetc_busy;
9646 * "executable()" function
9648 static void
9649 f_executable(argvars, rettv)
9650 typval_T *argvars;
9651 typval_T *rettv;
9653 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9657 * "exists()" function
9659 static void
9660 f_exists(argvars, rettv)
9661 typval_T *argvars;
9662 typval_T *rettv;
9664 char_u *p;
9665 char_u *name;
9666 int n = FALSE;
9667 int len = 0;
9669 p = get_tv_string(&argvars[0]);
9670 if (*p == '$') /* environment variable */
9672 /* first try "normal" environment variables (fast) */
9673 if (mch_getenv(p + 1) != NULL)
9674 n = TRUE;
9675 else
9677 /* try expanding things like $VIM and ${HOME} */
9678 p = expand_env_save(p);
9679 if (p != NULL && *p != '$')
9680 n = TRUE;
9681 vim_free(p);
9684 else if (*p == '&' || *p == '+') /* option */
9686 n = (get_option_tv(&p, NULL, TRUE) == OK);
9687 if (*skipwhite(p) != NUL)
9688 n = FALSE; /* trailing garbage */
9690 else if (*p == '*') /* internal or user defined function */
9692 n = function_exists(p + 1);
9694 else if (*p == ':')
9696 n = cmd_exists(p + 1);
9698 else if (*p == '#')
9700 #ifdef FEAT_AUTOCMD
9701 if (p[1] == '#')
9702 n = autocmd_supported(p + 2);
9703 else
9704 n = au_exists(p + 1);
9705 #endif
9707 else /* internal variable */
9709 char_u *tofree;
9710 typval_T tv;
9712 /* get_name_len() takes care of expanding curly braces */
9713 name = p;
9714 len = get_name_len(&p, &tofree, TRUE, FALSE);
9715 if (len > 0)
9717 if (tofree != NULL)
9718 name = tofree;
9719 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9720 if (n)
9722 /* handle d.key, l[idx], f(expr) */
9723 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9724 if (n)
9725 clear_tv(&tv);
9728 if (*p != NUL)
9729 n = FALSE;
9731 vim_free(tofree);
9734 rettv->vval.v_number = n;
9738 * "expand()" function
9740 static void
9741 f_expand(argvars, rettv)
9742 typval_T *argvars;
9743 typval_T *rettv;
9745 char_u *s;
9746 int len;
9747 char_u *errormsg;
9748 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9749 expand_T xpc;
9750 int error = FALSE;
9752 rettv->v_type = VAR_STRING;
9753 s = get_tv_string(&argvars[0]);
9754 if (*s == '%' || *s == '#' || *s == '<')
9756 ++emsg_off;
9757 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9758 --emsg_off;
9760 else
9762 /* When the optional second argument is non-zero, don't remove matches
9763 * for 'suffixes' and 'wildignore' */
9764 if (argvars[1].v_type != VAR_UNKNOWN
9765 && get_tv_number_chk(&argvars[1], &error))
9766 flags |= WILD_KEEP_ALL;
9767 if (!error)
9769 ExpandInit(&xpc);
9770 xpc.xp_context = EXPAND_FILES;
9771 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9773 else
9774 rettv->vval.v_string = NULL;
9779 * "extend(list, list [, idx])" function
9780 * "extend(dict, dict [, action])" function
9782 static void
9783 f_extend(argvars, rettv)
9784 typval_T *argvars;
9785 typval_T *rettv;
9787 rettv->vval.v_number = 0;
9788 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9790 list_T *l1, *l2;
9791 listitem_T *item;
9792 long before;
9793 int error = FALSE;
9795 l1 = argvars[0].vval.v_list;
9796 l2 = argvars[1].vval.v_list;
9797 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9798 && l2 != NULL)
9800 if (argvars[2].v_type != VAR_UNKNOWN)
9802 before = get_tv_number_chk(&argvars[2], &error);
9803 if (error)
9804 return; /* type error; errmsg already given */
9806 if (before == l1->lv_len)
9807 item = NULL;
9808 else
9810 item = list_find(l1, before);
9811 if (item == NULL)
9813 EMSGN(_(e_listidx), before);
9814 return;
9818 else
9819 item = NULL;
9820 list_extend(l1, l2, item);
9822 copy_tv(&argvars[0], rettv);
9825 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9827 dict_T *d1, *d2;
9828 dictitem_T *di1;
9829 char_u *action;
9830 int i;
9831 hashitem_T *hi2;
9832 int todo;
9834 d1 = argvars[0].vval.v_dict;
9835 d2 = argvars[1].vval.v_dict;
9836 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9837 && d2 != NULL)
9839 /* Check the third argument. */
9840 if (argvars[2].v_type != VAR_UNKNOWN)
9842 static char *(av[]) = {"keep", "force", "error"};
9844 action = get_tv_string_chk(&argvars[2]);
9845 if (action == NULL)
9846 return; /* type error; errmsg already given */
9847 for (i = 0; i < 3; ++i)
9848 if (STRCMP(action, av[i]) == 0)
9849 break;
9850 if (i == 3)
9852 EMSG2(_(e_invarg2), action);
9853 return;
9856 else
9857 action = (char_u *)"force";
9859 /* Go over all entries in the second dict and add them to the
9860 * first dict. */
9861 todo = (int)d2->dv_hashtab.ht_used;
9862 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9864 if (!HASHITEM_EMPTY(hi2))
9866 --todo;
9867 di1 = dict_find(d1, hi2->hi_key, -1);
9868 if (di1 == NULL)
9870 di1 = dictitem_copy(HI2DI(hi2));
9871 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9872 dictitem_free(di1);
9874 else if (*action == 'e')
9876 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9877 break;
9879 else if (*action == 'f')
9881 clear_tv(&di1->di_tv);
9882 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9887 copy_tv(&argvars[0], rettv);
9890 else
9891 EMSG2(_(e_listdictarg), "extend()");
9895 * "feedkeys()" function
9897 /*ARGSUSED*/
9898 static void
9899 f_feedkeys(argvars, rettv)
9900 typval_T *argvars;
9901 typval_T *rettv;
9903 int remap = TRUE;
9904 char_u *keys, *flags;
9905 char_u nbuf[NUMBUFLEN];
9906 int typed = FALSE;
9907 char_u *keys_esc;
9909 /* This is not allowed in the sandbox. If the commands would still be
9910 * executed in the sandbox it would be OK, but it probably happens later,
9911 * when "sandbox" is no longer set. */
9912 if (check_secure())
9913 return;
9915 rettv->vval.v_number = 0;
9916 keys = get_tv_string(&argvars[0]);
9917 if (*keys != NUL)
9919 if (argvars[1].v_type != VAR_UNKNOWN)
9921 flags = get_tv_string_buf(&argvars[1], nbuf);
9922 for ( ; *flags != NUL; ++flags)
9924 switch (*flags)
9926 case 'n': remap = FALSE; break;
9927 case 'm': remap = TRUE; break;
9928 case 't': typed = TRUE; break;
9933 /* Need to escape K_SPECIAL and CSI before putting the string in the
9934 * typeahead buffer. */
9935 keys_esc = vim_strsave_escape_csi(keys);
9936 if (keys_esc != NULL)
9938 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9939 typebuf.tb_len, !typed, FALSE);
9940 vim_free(keys_esc);
9941 if (vgetc_busy)
9942 typebuf_was_filled = TRUE;
9948 * "filereadable()" function
9950 static void
9951 f_filereadable(argvars, rettv)
9952 typval_T *argvars;
9953 typval_T *rettv;
9955 int fd;
9956 char_u *p;
9957 int n;
9959 #ifndef O_NONBLOCK
9960 # define O_NONBLOCK 0
9961 #endif
9962 p = get_tv_string(&argvars[0]);
9963 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9964 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9966 n = TRUE;
9967 close(fd);
9969 else
9970 n = FALSE;
9972 rettv->vval.v_number = n;
9976 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9977 * rights to write into.
9979 static void
9980 f_filewritable(argvars, rettv)
9981 typval_T *argvars;
9982 typval_T *rettv;
9984 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9987 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9989 static void
9990 findfilendir(argvars, rettv, find_what)
9991 typval_T *argvars;
9992 typval_T *rettv;
9993 int find_what;
9995 #ifdef FEAT_SEARCHPATH
9996 char_u *fname;
9997 char_u *fresult = NULL;
9998 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9999 char_u *p;
10000 char_u pathbuf[NUMBUFLEN];
10001 int count = 1;
10002 int first = TRUE;
10003 int error = FALSE;
10004 #endif
10006 rettv->vval.v_string = NULL;
10007 rettv->v_type = VAR_STRING;
10009 #ifdef FEAT_SEARCHPATH
10010 fname = get_tv_string(&argvars[0]);
10012 if (argvars[1].v_type != VAR_UNKNOWN)
10014 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
10015 if (p == NULL)
10016 error = TRUE;
10017 else
10019 if (*p != NUL)
10020 path = p;
10022 if (argvars[2].v_type != VAR_UNKNOWN)
10023 count = get_tv_number_chk(&argvars[2], &error);
10027 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
10028 error = TRUE;
10030 if (*fname != NUL && !error)
10034 if (rettv->v_type == VAR_STRING)
10035 vim_free(fresult);
10036 fresult = find_file_in_path_option(first ? fname : NULL,
10037 first ? (int)STRLEN(fname) : 0,
10038 0, first, path,
10039 find_what,
10040 curbuf->b_ffname,
10041 find_what == FINDFILE_DIR
10042 ? (char_u *)"" : curbuf->b_p_sua);
10043 first = FALSE;
10045 if (fresult != NULL && rettv->v_type == VAR_LIST)
10046 list_append_string(rettv->vval.v_list, fresult, -1);
10048 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
10051 if (rettv->v_type == VAR_STRING)
10052 rettv->vval.v_string = fresult;
10053 #endif
10056 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
10057 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
10060 * Implementation of map() and filter().
10062 static void
10063 filter_map(argvars, rettv, map)
10064 typval_T *argvars;
10065 typval_T *rettv;
10066 int map;
10068 char_u buf[NUMBUFLEN];
10069 char_u *expr;
10070 listitem_T *li, *nli;
10071 list_T *l = NULL;
10072 dictitem_T *di;
10073 hashtab_T *ht;
10074 hashitem_T *hi;
10075 dict_T *d = NULL;
10076 typval_T save_val;
10077 typval_T save_key;
10078 int rem;
10079 int todo;
10080 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
10081 int save_did_emsg;
10083 rettv->vval.v_number = 0;
10084 if (argvars[0].v_type == VAR_LIST)
10086 if ((l = argvars[0].vval.v_list) == NULL
10087 || (map && tv_check_lock(l->lv_lock, ermsg)))
10088 return;
10090 else if (argvars[0].v_type == VAR_DICT)
10092 if ((d = argvars[0].vval.v_dict) == NULL
10093 || (map && tv_check_lock(d->dv_lock, ermsg)))
10094 return;
10096 else
10098 EMSG2(_(e_listdictarg), ermsg);
10099 return;
10102 expr = get_tv_string_buf_chk(&argvars[1], buf);
10103 /* On type errors, the preceding call has already displayed an error
10104 * message. Avoid a misleading error message for an empty string that
10105 * was not passed as argument. */
10106 if (expr != NULL)
10108 prepare_vimvar(VV_VAL, &save_val);
10109 expr = skipwhite(expr);
10111 /* We reset "did_emsg" to be able to detect whether an error
10112 * occurred during evaluation of the expression. */
10113 save_did_emsg = did_emsg;
10114 did_emsg = FALSE;
10116 if (argvars[0].v_type == VAR_DICT)
10118 prepare_vimvar(VV_KEY, &save_key);
10119 vimvars[VV_KEY].vv_type = VAR_STRING;
10121 ht = &d->dv_hashtab;
10122 hash_lock(ht);
10123 todo = (int)ht->ht_used;
10124 for (hi = ht->ht_array; todo > 0; ++hi)
10126 if (!HASHITEM_EMPTY(hi))
10128 --todo;
10129 di = HI2DI(hi);
10130 if (tv_check_lock(di->di_tv.v_lock, ermsg))
10131 break;
10132 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
10133 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
10134 || did_emsg)
10135 break;
10136 if (!map && rem)
10137 dictitem_remove(d, di);
10138 clear_tv(&vimvars[VV_KEY].vv_tv);
10141 hash_unlock(ht);
10143 restore_vimvar(VV_KEY, &save_key);
10145 else
10147 for (li = l->lv_first; li != NULL; li = nli)
10149 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10150 break;
10151 nli = li->li_next;
10152 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10153 || did_emsg)
10154 break;
10155 if (!map && rem)
10156 listitem_remove(l, li);
10160 restore_vimvar(VV_VAL, &save_val);
10162 did_emsg |= save_did_emsg;
10165 copy_tv(&argvars[0], rettv);
10168 static int
10169 filter_map_one(tv, expr, map, remp)
10170 typval_T *tv;
10171 char_u *expr;
10172 int map;
10173 int *remp;
10175 typval_T rettv;
10176 char_u *s;
10177 int retval = FAIL;
10179 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10180 s = expr;
10181 if (eval1(&s, &rettv, TRUE) == FAIL)
10182 goto theend;
10183 if (*s != NUL) /* check for trailing chars after expr */
10185 EMSG2(_(e_invexpr2), s);
10186 goto theend;
10188 if (map)
10190 /* map(): replace the list item value */
10191 clear_tv(tv);
10192 rettv.v_lock = 0;
10193 *tv = rettv;
10195 else
10197 int error = FALSE;
10199 /* filter(): when expr is zero remove the item */
10200 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10201 clear_tv(&rettv);
10202 /* On type error, nothing has been removed; return FAIL to stop the
10203 * loop. The error message was given by get_tv_number_chk(). */
10204 if (error)
10205 goto theend;
10207 retval = OK;
10208 theend:
10209 clear_tv(&vimvars[VV_VAL].vv_tv);
10210 return retval;
10214 * "filter()" function
10216 static void
10217 f_filter(argvars, rettv)
10218 typval_T *argvars;
10219 typval_T *rettv;
10221 filter_map(argvars, rettv, FALSE);
10225 * "finddir({fname}[, {path}[, {count}]])" function
10227 static void
10228 f_finddir(argvars, rettv)
10229 typval_T *argvars;
10230 typval_T *rettv;
10232 findfilendir(argvars, rettv, FINDFILE_DIR);
10236 * "findfile({fname}[, {path}[, {count}]])" function
10238 static void
10239 f_findfile(argvars, rettv)
10240 typval_T *argvars;
10241 typval_T *rettv;
10243 findfilendir(argvars, rettv, FINDFILE_FILE);
10246 #ifdef FEAT_FLOAT
10248 * "float2nr({float})" function
10250 static void
10251 f_float2nr(argvars, rettv)
10252 typval_T *argvars;
10253 typval_T *rettv;
10255 float_T f;
10257 if (get_float_arg(argvars, &f) == OK)
10259 if (f < -0x7fffffff)
10260 rettv->vval.v_number = -0x7fffffff;
10261 else if (f > 0x7fffffff)
10262 rettv->vval.v_number = 0x7fffffff;
10263 else
10264 rettv->vval.v_number = (varnumber_T)f;
10266 else
10267 rettv->vval.v_number = 0;
10271 * "floor({float})" function
10273 static void
10274 f_floor(argvars, rettv)
10275 typval_T *argvars;
10276 typval_T *rettv;
10278 float_T f;
10280 rettv->v_type = VAR_FLOAT;
10281 if (get_float_arg(argvars, &f) == OK)
10282 rettv->vval.v_float = floor(f);
10283 else
10284 rettv->vval.v_float = 0.0;
10286 #endif
10289 * "fnameescape({string})" function
10291 static void
10292 f_fnameescape(argvars, rettv)
10293 typval_T *argvars;
10294 typval_T *rettv;
10296 rettv->vval.v_string = vim_strsave_fnameescape(
10297 get_tv_string(&argvars[0]), FALSE);
10298 rettv->v_type = VAR_STRING;
10302 * "fnamemodify({fname}, {mods})" function
10304 static void
10305 f_fnamemodify(argvars, rettv)
10306 typval_T *argvars;
10307 typval_T *rettv;
10309 char_u *fname;
10310 char_u *mods;
10311 int usedlen = 0;
10312 int len;
10313 char_u *fbuf = NULL;
10314 char_u buf[NUMBUFLEN];
10316 fname = get_tv_string_chk(&argvars[0]);
10317 mods = get_tv_string_buf_chk(&argvars[1], buf);
10318 if (fname == NULL || mods == NULL)
10319 fname = NULL;
10320 else
10322 len = (int)STRLEN(fname);
10323 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10326 rettv->v_type = VAR_STRING;
10327 if (fname == NULL)
10328 rettv->vval.v_string = NULL;
10329 else
10330 rettv->vval.v_string = vim_strnsave(fname, len);
10331 vim_free(fbuf);
10334 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10337 * "foldclosed()" function
10339 static void
10340 foldclosed_both(argvars, rettv, end)
10341 typval_T *argvars;
10342 typval_T *rettv;
10343 int end;
10345 #ifdef FEAT_FOLDING
10346 linenr_T lnum;
10347 linenr_T first, last;
10349 lnum = get_tv_lnum(argvars);
10350 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10352 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10354 if (end)
10355 rettv->vval.v_number = (varnumber_T)last;
10356 else
10357 rettv->vval.v_number = (varnumber_T)first;
10358 return;
10361 #endif
10362 rettv->vval.v_number = -1;
10366 * "foldclosed()" function
10368 static void
10369 f_foldclosed(argvars, rettv)
10370 typval_T *argvars;
10371 typval_T *rettv;
10373 foldclosed_both(argvars, rettv, FALSE);
10377 * "foldclosedend()" function
10379 static void
10380 f_foldclosedend(argvars, rettv)
10381 typval_T *argvars;
10382 typval_T *rettv;
10384 foldclosed_both(argvars, rettv, TRUE);
10388 * "foldlevel()" function
10390 static void
10391 f_foldlevel(argvars, rettv)
10392 typval_T *argvars;
10393 typval_T *rettv;
10395 #ifdef FEAT_FOLDING
10396 linenr_T lnum;
10398 lnum = get_tv_lnum(argvars);
10399 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10400 rettv->vval.v_number = foldLevel(lnum);
10401 else
10402 #endif
10403 rettv->vval.v_number = 0;
10407 * "foldtext()" function
10409 /*ARGSUSED*/
10410 static void
10411 f_foldtext(argvars, rettv)
10412 typval_T *argvars;
10413 typval_T *rettv;
10415 #ifdef FEAT_FOLDING
10416 linenr_T lnum;
10417 char_u *s;
10418 char_u *r;
10419 int len;
10420 char *txt;
10421 #endif
10423 rettv->v_type = VAR_STRING;
10424 rettv->vval.v_string = NULL;
10425 #ifdef FEAT_FOLDING
10426 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10427 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10428 <= curbuf->b_ml.ml_line_count
10429 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10431 /* Find first non-empty line in the fold. */
10432 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10433 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10435 if (!linewhite(lnum))
10436 break;
10437 ++lnum;
10440 /* Find interesting text in this line. */
10441 s = skipwhite(ml_get(lnum));
10442 /* skip C comment-start */
10443 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10445 s = skipwhite(s + 2);
10446 if (*skipwhite(s) == NUL
10447 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10449 s = skipwhite(ml_get(lnum + 1));
10450 if (*s == '*')
10451 s = skipwhite(s + 1);
10454 txt = _("+-%s%3ld lines: ");
10455 r = alloc((unsigned)(STRLEN(txt)
10456 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10457 + 20 /* for %3ld */
10458 + STRLEN(s))); /* concatenated */
10459 if (r != NULL)
10461 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10462 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10463 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10464 len = (int)STRLEN(r);
10465 STRCAT(r, s);
10466 /* remove 'foldmarker' and 'commentstring' */
10467 foldtext_cleanup(r + len);
10468 rettv->vval.v_string = r;
10471 #endif
10475 * "foldtextresult(lnum)" function
10477 /*ARGSUSED*/
10478 static void
10479 f_foldtextresult(argvars, rettv)
10480 typval_T *argvars;
10481 typval_T *rettv;
10483 #ifdef FEAT_FOLDING
10484 linenr_T lnum;
10485 char_u *text;
10486 char_u buf[51];
10487 foldinfo_T foldinfo;
10488 int fold_count;
10489 #endif
10491 rettv->v_type = VAR_STRING;
10492 rettv->vval.v_string = NULL;
10493 #ifdef FEAT_FOLDING
10494 lnum = get_tv_lnum(argvars);
10495 /* treat illegal types and illegal string values for {lnum} the same */
10496 if (lnum < 0)
10497 lnum = 0;
10498 fold_count = foldedCount(curwin, lnum, &foldinfo);
10499 if (fold_count > 0)
10501 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10502 &foldinfo, buf);
10503 if (text == buf)
10504 text = vim_strsave(text);
10505 rettv->vval.v_string = text;
10507 #endif
10511 * "foreground()" function
10513 /*ARGSUSED*/
10514 static void
10515 f_foreground(argvars, rettv)
10516 typval_T *argvars;
10517 typval_T *rettv;
10519 rettv->vval.v_number = 0;
10520 #ifdef FEAT_GUI
10521 if (gui.in_use)
10522 gui_mch_set_foreground();
10523 #else
10524 # ifdef WIN32
10525 win32_set_foreground();
10526 # endif
10527 #endif
10531 * "function()" function
10533 /*ARGSUSED*/
10534 static void
10535 f_function(argvars, rettv)
10536 typval_T *argvars;
10537 typval_T *rettv;
10539 char_u *s;
10541 rettv->vval.v_number = 0;
10542 s = get_tv_string(&argvars[0]);
10543 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10544 EMSG2(_(e_invarg2), s);
10545 else if (!function_exists(s))
10546 EMSG2(_("E700: Unknown function: %s"), s);
10547 else
10549 rettv->vval.v_string = vim_strsave(s);
10550 rettv->v_type = VAR_FUNC;
10555 * "garbagecollect()" function
10557 /*ARGSUSED*/
10558 static void
10559 f_garbagecollect(argvars, rettv)
10560 typval_T *argvars;
10561 typval_T *rettv;
10563 /* This is postponed until we are back at the toplevel, because we may be
10564 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10565 want_garbage_collect = TRUE;
10567 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10568 garbage_collect_at_exit = TRUE;
10572 * "get()" function
10574 static void
10575 f_get(argvars, rettv)
10576 typval_T *argvars;
10577 typval_T *rettv;
10579 listitem_T *li;
10580 list_T *l;
10581 dictitem_T *di;
10582 dict_T *d;
10583 typval_T *tv = NULL;
10585 if (argvars[0].v_type == VAR_LIST)
10587 if ((l = argvars[0].vval.v_list) != NULL)
10589 int error = FALSE;
10591 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10592 if (!error && li != NULL)
10593 tv = &li->li_tv;
10596 else if (argvars[0].v_type == VAR_DICT)
10598 if ((d = argvars[0].vval.v_dict) != NULL)
10600 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10601 if (di != NULL)
10602 tv = &di->di_tv;
10605 else
10606 EMSG2(_(e_listdictarg), "get()");
10608 if (tv == NULL)
10610 if (argvars[2].v_type == VAR_UNKNOWN)
10611 rettv->vval.v_number = 0;
10612 else
10613 copy_tv(&argvars[2], rettv);
10615 else
10616 copy_tv(tv, rettv);
10619 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10622 * Get line or list of lines from buffer "buf" into "rettv".
10623 * Return a range (from start to end) of lines in rettv from the specified
10624 * buffer.
10625 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10627 static void
10628 get_buffer_lines(buf, start, end, retlist, rettv)
10629 buf_T *buf;
10630 linenr_T start;
10631 linenr_T end;
10632 int retlist;
10633 typval_T *rettv;
10635 char_u *p;
10637 if (retlist)
10639 if (rettv_list_alloc(rettv) == FAIL)
10640 return;
10642 else
10643 rettv->vval.v_number = 0;
10645 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10646 return;
10648 if (!retlist)
10650 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10651 p = ml_get_buf(buf, start, FALSE);
10652 else
10653 p = (char_u *)"";
10655 rettv->v_type = VAR_STRING;
10656 rettv->vval.v_string = vim_strsave(p);
10658 else
10660 if (end < start)
10661 return;
10663 if (start < 1)
10664 start = 1;
10665 if (end > buf->b_ml.ml_line_count)
10666 end = buf->b_ml.ml_line_count;
10667 while (start <= end)
10668 if (list_append_string(rettv->vval.v_list,
10669 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10670 break;
10675 * "getbufline()" function
10677 static void
10678 f_getbufline(argvars, rettv)
10679 typval_T *argvars;
10680 typval_T *rettv;
10682 linenr_T lnum;
10683 linenr_T end;
10684 buf_T *buf;
10686 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10687 ++emsg_off;
10688 buf = get_buf_tv(&argvars[0]);
10689 --emsg_off;
10691 lnum = get_tv_lnum_buf(&argvars[1], buf);
10692 if (argvars[2].v_type == VAR_UNKNOWN)
10693 end = lnum;
10694 else
10695 end = get_tv_lnum_buf(&argvars[2], buf);
10697 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10701 * "getbufvar()" function
10703 static void
10704 f_getbufvar(argvars, rettv)
10705 typval_T *argvars;
10706 typval_T *rettv;
10708 buf_T *buf;
10709 buf_T *save_curbuf;
10710 char_u *varname;
10711 dictitem_T *v;
10713 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10714 varname = get_tv_string_chk(&argvars[1]);
10715 ++emsg_off;
10716 buf = get_buf_tv(&argvars[0]);
10718 rettv->v_type = VAR_STRING;
10719 rettv->vval.v_string = NULL;
10721 if (buf != NULL && varname != NULL)
10723 /* set curbuf to be our buf, temporarily */
10724 save_curbuf = curbuf;
10725 curbuf = buf;
10727 if (*varname == '&') /* buffer-local-option */
10728 get_option_tv(&varname, rettv, TRUE);
10729 else
10731 if (*varname == NUL)
10732 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10733 * scope prefix before the NUL byte is required by
10734 * find_var_in_ht(). */
10735 varname = (char_u *)"b:" + 2;
10736 /* look up the variable */
10737 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10738 if (v != NULL)
10739 copy_tv(&v->di_tv, rettv);
10742 /* restore previous notion of curbuf */
10743 curbuf = save_curbuf;
10746 --emsg_off;
10750 * "getchar()" function
10752 static void
10753 f_getchar(argvars, rettv)
10754 typval_T *argvars;
10755 typval_T *rettv;
10757 varnumber_T n;
10758 int error = FALSE;
10760 /* Position the cursor. Needed after a message that ends in a space. */
10761 windgoto(msg_row, msg_col);
10763 ++no_mapping;
10764 ++allow_keys;
10765 for (;;)
10767 if (argvars[0].v_type == VAR_UNKNOWN)
10768 /* getchar(): blocking wait. */
10769 n = safe_vgetc();
10770 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10771 /* getchar(1): only check if char avail */
10772 n = vpeekc();
10773 else if (error || vpeekc() == NUL)
10774 /* illegal argument or getchar(0) and no char avail: return zero */
10775 n = 0;
10776 else
10777 /* getchar(0) and char avail: return char */
10778 n = safe_vgetc();
10779 if (n == K_IGNORE)
10780 continue;
10781 break;
10783 --no_mapping;
10784 --allow_keys;
10786 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10787 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10788 vimvars[VV_MOUSE_COL].vv_nr = 0;
10790 rettv->vval.v_number = n;
10791 if (IS_SPECIAL(n) || mod_mask != 0)
10793 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10794 int i = 0;
10796 /* Turn a special key into three bytes, plus modifier. */
10797 if (mod_mask != 0)
10799 temp[i++] = K_SPECIAL;
10800 temp[i++] = KS_MODIFIER;
10801 temp[i++] = mod_mask;
10803 if (IS_SPECIAL(n))
10805 temp[i++] = K_SPECIAL;
10806 temp[i++] = K_SECOND(n);
10807 temp[i++] = K_THIRD(n);
10809 #ifdef FEAT_MBYTE
10810 else if (has_mbyte)
10811 i += (*mb_char2bytes)(n, temp + i);
10812 #endif
10813 else
10814 temp[i++] = n;
10815 temp[i++] = NUL;
10816 rettv->v_type = VAR_STRING;
10817 rettv->vval.v_string = vim_strsave(temp);
10819 #ifdef FEAT_MOUSE
10820 if (n == K_LEFTMOUSE
10821 || n == K_LEFTMOUSE_NM
10822 || n == K_LEFTDRAG
10823 || n == K_LEFTRELEASE
10824 || n == K_LEFTRELEASE_NM
10825 || n == K_MIDDLEMOUSE
10826 || n == K_MIDDLEDRAG
10827 || n == K_MIDDLERELEASE
10828 || n == K_RIGHTMOUSE
10829 || n == K_RIGHTDRAG
10830 || n == K_RIGHTRELEASE
10831 || n == K_X1MOUSE
10832 || n == K_X1DRAG
10833 || n == K_X1RELEASE
10834 || n == K_X2MOUSE
10835 || n == K_X2DRAG
10836 || n == K_X2RELEASE
10837 || n == K_MOUSEDOWN
10838 || n == K_MOUSEUP)
10840 int row = mouse_row;
10841 int col = mouse_col;
10842 win_T *win;
10843 linenr_T lnum;
10844 # ifdef FEAT_WINDOWS
10845 win_T *wp;
10846 # endif
10847 int n = 1;
10849 if (row >= 0 && col >= 0)
10851 /* Find the window at the mouse coordinates and compute the
10852 * text position. */
10853 win = mouse_find_win(&row, &col);
10854 (void)mouse_comp_pos(win, &row, &col, &lnum);
10855 # ifdef FEAT_WINDOWS
10856 for (wp = firstwin; wp != win; wp = wp->w_next)
10857 ++n;
10858 # endif
10859 vimvars[VV_MOUSE_WIN].vv_nr = n;
10860 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10861 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10864 #endif
10869 * "getcharmod()" function
10871 /*ARGSUSED*/
10872 static void
10873 f_getcharmod(argvars, rettv)
10874 typval_T *argvars;
10875 typval_T *rettv;
10877 rettv->vval.v_number = mod_mask;
10881 * "getcmdline()" function
10883 /*ARGSUSED*/
10884 static void
10885 f_getcmdline(argvars, rettv)
10886 typval_T *argvars;
10887 typval_T *rettv;
10889 rettv->v_type = VAR_STRING;
10890 rettv->vval.v_string = get_cmdline_str();
10894 * "getcmdpos()" function
10896 /*ARGSUSED*/
10897 static void
10898 f_getcmdpos(argvars, rettv)
10899 typval_T *argvars;
10900 typval_T *rettv;
10902 rettv->vval.v_number = get_cmdline_pos() + 1;
10906 * "getcmdtype()" function
10908 /*ARGSUSED*/
10909 static void
10910 f_getcmdtype(argvars, rettv)
10911 typval_T *argvars;
10912 typval_T *rettv;
10914 rettv->v_type = VAR_STRING;
10915 rettv->vval.v_string = alloc(2);
10916 if (rettv->vval.v_string != NULL)
10918 rettv->vval.v_string[0] = get_cmdline_type();
10919 rettv->vval.v_string[1] = NUL;
10924 * "getcwd()" function
10926 /*ARGSUSED*/
10927 static void
10928 f_getcwd(argvars, rettv)
10929 typval_T *argvars;
10930 typval_T *rettv;
10932 char_u cwd[MAXPATHL];
10934 rettv->v_type = VAR_STRING;
10935 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10936 rettv->vval.v_string = NULL;
10937 else
10939 rettv->vval.v_string = vim_strsave(cwd);
10940 #ifdef BACKSLASH_IN_FILENAME
10941 if (rettv->vval.v_string != NULL)
10942 slash_adjust(rettv->vval.v_string);
10943 #endif
10948 * "getfontname()" function
10950 /*ARGSUSED*/
10951 static void
10952 f_getfontname(argvars, rettv)
10953 typval_T *argvars;
10954 typval_T *rettv;
10956 rettv->v_type = VAR_STRING;
10957 rettv->vval.v_string = NULL;
10958 #ifdef FEAT_GUI
10959 if (gui.in_use)
10961 GuiFont font;
10962 char_u *name = NULL;
10964 if (argvars[0].v_type == VAR_UNKNOWN)
10966 /* Get the "Normal" font. Either the name saved by
10967 * hl_set_font_name() or from the font ID. */
10968 font = gui.norm_font;
10969 name = hl_get_font_name();
10971 else
10973 name = get_tv_string(&argvars[0]);
10974 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10975 return;
10976 font = gui_mch_get_font(name, FALSE);
10977 if (font == NOFONT)
10978 return; /* Invalid font name, return empty string. */
10980 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10981 if (argvars[0].v_type != VAR_UNKNOWN)
10982 gui_mch_free_font(font);
10984 #endif
10988 * "getfperm({fname})" function
10990 static void
10991 f_getfperm(argvars, rettv)
10992 typval_T *argvars;
10993 typval_T *rettv;
10995 char_u *fname;
10996 struct stat st;
10997 char_u *perm = NULL;
10998 char_u flags[] = "rwx";
10999 int i;
11001 fname = get_tv_string(&argvars[0]);
11003 rettv->v_type = VAR_STRING;
11004 if (mch_stat((char *)fname, &st) >= 0)
11006 perm = vim_strsave((char_u *)"---------");
11007 if (perm != NULL)
11009 for (i = 0; i < 9; i++)
11011 if (st.st_mode & (1 << (8 - i)))
11012 perm[i] = flags[i % 3];
11016 rettv->vval.v_string = perm;
11020 * "getfsize({fname})" function
11022 static void
11023 f_getfsize(argvars, rettv)
11024 typval_T *argvars;
11025 typval_T *rettv;
11027 char_u *fname;
11028 struct stat st;
11030 fname = get_tv_string(&argvars[0]);
11032 rettv->v_type = VAR_NUMBER;
11034 if (mch_stat((char *)fname, &st) >= 0)
11036 if (mch_isdir(fname))
11037 rettv->vval.v_number = 0;
11038 else
11040 rettv->vval.v_number = (varnumber_T)st.st_size;
11042 /* non-perfect check for overflow */
11043 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
11044 rettv->vval.v_number = -2;
11047 else
11048 rettv->vval.v_number = -1;
11052 * "getftime({fname})" function
11054 static void
11055 f_getftime(argvars, rettv)
11056 typval_T *argvars;
11057 typval_T *rettv;
11059 char_u *fname;
11060 struct stat st;
11062 fname = get_tv_string(&argvars[0]);
11064 if (mch_stat((char *)fname, &st) >= 0)
11065 rettv->vval.v_number = (varnumber_T)st.st_mtime;
11066 else
11067 rettv->vval.v_number = -1;
11071 * "getftype({fname})" function
11073 static void
11074 f_getftype(argvars, rettv)
11075 typval_T *argvars;
11076 typval_T *rettv;
11078 char_u *fname;
11079 struct stat st;
11080 char_u *type = NULL;
11081 char *t;
11083 fname = get_tv_string(&argvars[0]);
11085 rettv->v_type = VAR_STRING;
11086 if (mch_lstat((char *)fname, &st) >= 0)
11088 #ifdef S_ISREG
11089 if (S_ISREG(st.st_mode))
11090 t = "file";
11091 else if (S_ISDIR(st.st_mode))
11092 t = "dir";
11093 # ifdef S_ISLNK
11094 else if (S_ISLNK(st.st_mode))
11095 t = "link";
11096 # endif
11097 # ifdef S_ISBLK
11098 else if (S_ISBLK(st.st_mode))
11099 t = "bdev";
11100 # endif
11101 # ifdef S_ISCHR
11102 else if (S_ISCHR(st.st_mode))
11103 t = "cdev";
11104 # endif
11105 # ifdef S_ISFIFO
11106 else if (S_ISFIFO(st.st_mode))
11107 t = "fifo";
11108 # endif
11109 # ifdef S_ISSOCK
11110 else if (S_ISSOCK(st.st_mode))
11111 t = "fifo";
11112 # endif
11113 else
11114 t = "other";
11115 #else
11116 # ifdef S_IFMT
11117 switch (st.st_mode & S_IFMT)
11119 case S_IFREG: t = "file"; break;
11120 case S_IFDIR: t = "dir"; break;
11121 # ifdef S_IFLNK
11122 case S_IFLNK: t = "link"; break;
11123 # endif
11124 # ifdef S_IFBLK
11125 case S_IFBLK: t = "bdev"; break;
11126 # endif
11127 # ifdef S_IFCHR
11128 case S_IFCHR: t = "cdev"; break;
11129 # endif
11130 # ifdef S_IFIFO
11131 case S_IFIFO: t = "fifo"; break;
11132 # endif
11133 # ifdef S_IFSOCK
11134 case S_IFSOCK: t = "socket"; break;
11135 # endif
11136 default: t = "other";
11138 # else
11139 if (mch_isdir(fname))
11140 t = "dir";
11141 else
11142 t = "file";
11143 # endif
11144 #endif
11145 type = vim_strsave((char_u *)t);
11147 rettv->vval.v_string = type;
11151 * "getline(lnum, [end])" function
11153 static void
11154 f_getline(argvars, rettv)
11155 typval_T *argvars;
11156 typval_T *rettv;
11158 linenr_T lnum;
11159 linenr_T end;
11160 int retlist;
11162 lnum = get_tv_lnum(argvars);
11163 if (argvars[1].v_type == VAR_UNKNOWN)
11165 end = 0;
11166 retlist = FALSE;
11168 else
11170 end = get_tv_lnum(&argvars[1]);
11171 retlist = TRUE;
11174 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11178 * "getmatches()" function
11180 /*ARGSUSED*/
11181 static void
11182 f_getmatches(argvars, rettv)
11183 typval_T *argvars;
11184 typval_T *rettv;
11186 #ifdef FEAT_SEARCH_EXTRA
11187 dict_T *dict;
11188 matchitem_T *cur = curwin->w_match_head;
11190 rettv->vval.v_number = 0;
11192 if (rettv_list_alloc(rettv) == OK)
11194 while (cur != NULL)
11196 dict = dict_alloc();
11197 if (dict == NULL)
11198 return;
11199 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11200 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11201 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11202 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11203 list_append_dict(rettv->vval.v_list, dict);
11204 cur = cur->next;
11207 #endif
11211 * "getpid()" function
11213 /*ARGSUSED*/
11214 static void
11215 f_getpid(argvars, rettv)
11216 typval_T *argvars;
11217 typval_T *rettv;
11219 rettv->vval.v_number = mch_get_pid();
11223 * "getpos(string)" function
11225 static void
11226 f_getpos(argvars, rettv)
11227 typval_T *argvars;
11228 typval_T *rettv;
11230 pos_T *fp;
11231 list_T *l;
11232 int fnum = -1;
11234 if (rettv_list_alloc(rettv) == OK)
11236 l = rettv->vval.v_list;
11237 fp = var2fpos(&argvars[0], TRUE, &fnum);
11238 if (fnum != -1)
11239 list_append_number(l, (varnumber_T)fnum);
11240 else
11241 list_append_number(l, (varnumber_T)0);
11242 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11243 : (varnumber_T)0);
11244 list_append_number(l, (fp != NULL)
11245 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11246 : (varnumber_T)0);
11247 list_append_number(l,
11248 #ifdef FEAT_VIRTUALEDIT
11249 (fp != NULL) ? (varnumber_T)fp->coladd :
11250 #endif
11251 (varnumber_T)0);
11253 else
11254 rettv->vval.v_number = FALSE;
11258 * "getqflist()" and "getloclist()" functions
11260 /*ARGSUSED*/
11261 static void
11262 f_getqflist(argvars, rettv)
11263 typval_T *argvars;
11264 typval_T *rettv;
11266 #ifdef FEAT_QUICKFIX
11267 win_T *wp;
11268 #endif
11270 rettv->vval.v_number = 0;
11271 #ifdef FEAT_QUICKFIX
11272 if (rettv_list_alloc(rettv) == OK)
11274 wp = NULL;
11275 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11277 wp = find_win_by_nr(&argvars[0], NULL);
11278 if (wp == NULL)
11279 return;
11282 (void)get_errorlist(wp, rettv->vval.v_list);
11284 #endif
11288 * "getreg()" function
11290 static void
11291 f_getreg(argvars, rettv)
11292 typval_T *argvars;
11293 typval_T *rettv;
11295 char_u *strregname;
11296 int regname;
11297 int arg2 = FALSE;
11298 int error = FALSE;
11300 if (argvars[0].v_type != VAR_UNKNOWN)
11302 strregname = get_tv_string_chk(&argvars[0]);
11303 error = strregname == NULL;
11304 if (argvars[1].v_type != VAR_UNKNOWN)
11305 arg2 = get_tv_number_chk(&argvars[1], &error);
11307 else
11308 strregname = vimvars[VV_REG].vv_str;
11309 regname = (strregname == NULL ? '"' : *strregname);
11310 if (regname == 0)
11311 regname = '"';
11313 rettv->v_type = VAR_STRING;
11314 rettv->vval.v_string = error ? NULL :
11315 get_reg_contents(regname, TRUE, arg2);
11319 * "getregtype()" function
11321 static void
11322 f_getregtype(argvars, rettv)
11323 typval_T *argvars;
11324 typval_T *rettv;
11326 char_u *strregname;
11327 int regname;
11328 char_u buf[NUMBUFLEN + 2];
11329 long reglen = 0;
11331 if (argvars[0].v_type != VAR_UNKNOWN)
11333 strregname = get_tv_string_chk(&argvars[0]);
11334 if (strregname == NULL) /* type error; errmsg already given */
11336 rettv->v_type = VAR_STRING;
11337 rettv->vval.v_string = NULL;
11338 return;
11341 else
11342 /* Default to v:register */
11343 strregname = vimvars[VV_REG].vv_str;
11345 regname = (strregname == NULL ? '"' : *strregname);
11346 if (regname == 0)
11347 regname = '"';
11349 buf[0] = NUL;
11350 buf[1] = NUL;
11351 switch (get_reg_type(regname, &reglen))
11353 case MLINE: buf[0] = 'V'; break;
11354 case MCHAR: buf[0] = 'v'; break;
11355 #ifdef FEAT_VISUAL
11356 case MBLOCK:
11357 buf[0] = Ctrl_V;
11358 sprintf((char *)buf + 1, "%ld", reglen + 1);
11359 break;
11360 #endif
11362 rettv->v_type = VAR_STRING;
11363 rettv->vval.v_string = vim_strsave(buf);
11367 * "gettabwinvar()" function
11369 static void
11370 f_gettabwinvar(argvars, rettv)
11371 typval_T *argvars;
11372 typval_T *rettv;
11374 getwinvar(argvars, rettv, 1);
11378 * "getwinposx()" function
11380 /*ARGSUSED*/
11381 static void
11382 f_getwinposx(argvars, rettv)
11383 typval_T *argvars;
11384 typval_T *rettv;
11386 rettv->vval.v_number = -1;
11387 #ifdef FEAT_GUI
11388 if (gui.in_use)
11390 int x, y;
11392 if (gui_mch_get_winpos(&x, &y) == OK)
11393 rettv->vval.v_number = x;
11395 #endif
11399 * "getwinposy()" function
11401 /*ARGSUSED*/
11402 static void
11403 f_getwinposy(argvars, rettv)
11404 typval_T *argvars;
11405 typval_T *rettv;
11407 rettv->vval.v_number = -1;
11408 #ifdef FEAT_GUI
11409 if (gui.in_use)
11411 int x, y;
11413 if (gui_mch_get_winpos(&x, &y) == OK)
11414 rettv->vval.v_number = y;
11416 #endif
11420 * Find window specified by "vp" in tabpage "tp".
11422 static win_T *
11423 find_win_by_nr(vp, tp)
11424 typval_T *vp;
11425 tabpage_T *tp; /* NULL for current tab page */
11427 #ifdef FEAT_WINDOWS
11428 win_T *wp;
11429 #endif
11430 int nr;
11432 nr = get_tv_number_chk(vp, NULL);
11434 #ifdef FEAT_WINDOWS
11435 if (nr < 0)
11436 return NULL;
11437 if (nr == 0)
11438 return curwin;
11440 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11441 wp != NULL; wp = wp->w_next)
11442 if (--nr <= 0)
11443 break;
11444 return wp;
11445 #else
11446 if (nr == 0 || nr == 1)
11447 return curwin;
11448 return NULL;
11449 #endif
11453 * "getwinvar()" function
11455 static void
11456 f_getwinvar(argvars, rettv)
11457 typval_T *argvars;
11458 typval_T *rettv;
11460 getwinvar(argvars, rettv, 0);
11464 * getwinvar() and gettabwinvar()
11466 static void
11467 getwinvar(argvars, rettv, off)
11468 typval_T *argvars;
11469 typval_T *rettv;
11470 int off; /* 1 for gettabwinvar() */
11472 win_T *win, *oldcurwin;
11473 char_u *varname;
11474 dictitem_T *v;
11475 tabpage_T *tp;
11477 #ifdef FEAT_WINDOWS
11478 if (off == 1)
11479 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11480 else
11481 tp = curtab;
11482 #endif
11483 win = find_win_by_nr(&argvars[off], tp);
11484 varname = get_tv_string_chk(&argvars[off + 1]);
11485 ++emsg_off;
11487 rettv->v_type = VAR_STRING;
11488 rettv->vval.v_string = NULL;
11490 if (win != NULL && varname != NULL)
11492 /* Set curwin to be our win, temporarily. Also set curbuf, so
11493 * that we can get buffer-local options. */
11494 oldcurwin = curwin;
11495 curwin = win;
11496 curbuf = win->w_buffer;
11498 if (*varname == '&') /* window-local-option */
11499 get_option_tv(&varname, rettv, 1);
11500 else
11502 if (*varname == NUL)
11503 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11504 * scope prefix before the NUL byte is required by
11505 * find_var_in_ht(). */
11506 varname = (char_u *)"w:" + 2;
11507 /* look up the variable */
11508 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11509 if (v != NULL)
11510 copy_tv(&v->di_tv, rettv);
11513 /* restore previous notion of curwin */
11514 curwin = oldcurwin;
11515 curbuf = curwin->w_buffer;
11518 --emsg_off;
11522 * "glob()" function
11524 static void
11525 f_glob(argvars, rettv)
11526 typval_T *argvars;
11527 typval_T *rettv;
11529 expand_T xpc;
11531 ExpandInit(&xpc);
11532 xpc.xp_context = EXPAND_FILES;
11533 rettv->v_type = VAR_STRING;
11534 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11535 NULL, WILD_USE_NL|WILD_SILENT, WILD_ALL);
11539 * "globpath()" function
11541 static void
11542 f_globpath(argvars, rettv)
11543 typval_T *argvars;
11544 typval_T *rettv;
11546 char_u buf1[NUMBUFLEN];
11547 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11549 rettv->v_type = VAR_STRING;
11550 if (file == NULL)
11551 rettv->vval.v_string = NULL;
11552 else
11553 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file);
11557 * "has()" function
11559 static void
11560 f_has(argvars, rettv)
11561 typval_T *argvars;
11562 typval_T *rettv;
11564 int i;
11565 char_u *name;
11566 int n = FALSE;
11567 static char *(has_list[]) =
11569 #ifdef AMIGA
11570 "amiga",
11571 # ifdef FEAT_ARP
11572 "arp",
11573 # endif
11574 #endif
11575 #ifdef __BEOS__
11576 "beos",
11577 #endif
11578 #ifdef MSDOS
11579 # ifdef DJGPP
11580 "dos32",
11581 # else
11582 "dos16",
11583 # endif
11584 #endif
11585 #ifdef MACOS
11586 "mac",
11587 #endif
11588 #if defined(MACOS_X_UNIX)
11589 "macunix",
11590 #endif
11591 #ifdef OS2
11592 "os2",
11593 #endif
11594 #ifdef __QNX__
11595 "qnx",
11596 #endif
11597 #ifdef RISCOS
11598 "riscos",
11599 #endif
11600 #ifdef UNIX
11601 "unix",
11602 #endif
11603 #ifdef VMS
11604 "vms",
11605 #endif
11606 #ifdef WIN16
11607 "win16",
11608 #endif
11609 #ifdef WIN32
11610 "win32",
11611 #endif
11612 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11613 "win32unix",
11614 #endif
11615 #ifdef WIN64
11616 "win64",
11617 #endif
11618 #ifdef EBCDIC
11619 "ebcdic",
11620 #endif
11621 #ifndef CASE_INSENSITIVE_FILENAME
11622 "fname_case",
11623 #endif
11624 #ifdef FEAT_ARABIC
11625 "arabic",
11626 #endif
11627 #ifdef FEAT_AUTOCMD
11628 "autocmd",
11629 #endif
11630 #ifdef FEAT_BEVAL
11631 "balloon_eval",
11632 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11633 "balloon_multiline",
11634 # endif
11635 #endif
11636 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11637 "builtin_terms",
11638 # ifdef ALL_BUILTIN_TCAPS
11639 "all_builtin_terms",
11640 # endif
11641 #endif
11642 #ifdef FEAT_BYTEOFF
11643 "byte_offset",
11644 #endif
11645 #ifdef FEAT_CINDENT
11646 "cindent",
11647 #endif
11648 #ifdef FEAT_CLIENTSERVER
11649 "clientserver",
11650 #endif
11651 #ifdef FEAT_CLIPBOARD
11652 "clipboard",
11653 #endif
11654 #ifdef FEAT_CMDL_COMPL
11655 "cmdline_compl",
11656 #endif
11657 #ifdef FEAT_CMDHIST
11658 "cmdline_hist",
11659 #endif
11660 #ifdef FEAT_COMMENTS
11661 "comments",
11662 #endif
11663 #ifdef FEAT_CRYPT
11664 "cryptv",
11665 #endif
11666 #ifdef FEAT_CSCOPE
11667 "cscope",
11668 #endif
11669 #ifdef CURSOR_SHAPE
11670 "cursorshape",
11671 #endif
11672 #ifdef DEBUG
11673 "debug",
11674 #endif
11675 #ifdef FEAT_CON_DIALOG
11676 "dialog_con",
11677 #endif
11678 #ifdef FEAT_GUI_DIALOG
11679 "dialog_gui",
11680 #endif
11681 #ifdef FEAT_DIFF
11682 "diff",
11683 #endif
11684 #ifdef FEAT_DIGRAPHS
11685 "digraphs",
11686 #endif
11687 #ifdef FEAT_DND
11688 "dnd",
11689 #endif
11690 #ifdef FEAT_EMACS_TAGS
11691 "emacs_tags",
11692 #endif
11693 "eval", /* always present, of course! */
11694 #ifdef FEAT_EX_EXTRA
11695 "ex_extra",
11696 #endif
11697 #ifdef FEAT_SEARCH_EXTRA
11698 "extra_search",
11699 #endif
11700 #ifdef FEAT_FKMAP
11701 "farsi",
11702 #endif
11703 #ifdef FEAT_SEARCHPATH
11704 "file_in_path",
11705 #endif
11706 #if defined(UNIX) && !defined(USE_SYSTEM)
11707 "filterpipe",
11708 #endif
11709 #ifdef FEAT_FIND_ID
11710 "find_in_path",
11711 #endif
11712 #ifdef FEAT_FLOAT
11713 "float",
11714 #endif
11715 #ifdef FEAT_FOLDING
11716 "folding",
11717 #endif
11718 #ifdef FEAT_FOOTER
11719 "footer",
11720 #endif
11721 #if !defined(USE_SYSTEM) && defined(UNIX)
11722 "fork",
11723 #endif
11724 #ifdef FEAT_GETTEXT
11725 "gettext",
11726 #endif
11727 #ifdef FEAT_GUI
11728 "gui",
11729 #endif
11730 #ifdef FEAT_GUI_ATHENA
11731 # ifdef FEAT_GUI_NEXTAW
11732 "gui_neXtaw",
11733 # else
11734 "gui_athena",
11735 # endif
11736 #endif
11737 #ifdef FEAT_GUI_GTK
11738 "gui_gtk",
11739 # ifdef HAVE_GTK2
11740 "gui_gtk2",
11741 # endif
11742 #endif
11743 #ifdef FEAT_GUI_GNOME
11744 "gui_gnome",
11745 #endif
11746 #ifdef FEAT_GUI_MAC
11747 "gui_mac",
11748 #endif
11749 #ifdef FEAT_GUI_MOTIF
11750 "gui_motif",
11751 #endif
11752 #ifdef FEAT_GUI_PHOTON
11753 "gui_photon",
11754 #endif
11755 #ifdef FEAT_GUI_W16
11756 "gui_win16",
11757 #endif
11758 #ifdef FEAT_GUI_W32
11759 "gui_win32",
11760 #endif
11761 #ifdef FEAT_HANGULIN
11762 "hangul_input",
11763 #endif
11764 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11765 "iconv",
11766 #endif
11767 #ifdef FEAT_INS_EXPAND
11768 "insert_expand",
11769 #endif
11770 #ifdef FEAT_JUMPLIST
11771 "jumplist",
11772 #endif
11773 #ifdef FEAT_KEYMAP
11774 "keymap",
11775 #endif
11776 #ifdef FEAT_LANGMAP
11777 "langmap",
11778 #endif
11779 #ifdef FEAT_LIBCALL
11780 "libcall",
11781 #endif
11782 #ifdef FEAT_LINEBREAK
11783 "linebreak",
11784 #endif
11785 #ifdef FEAT_LISP
11786 "lispindent",
11787 #endif
11788 #ifdef FEAT_LISTCMDS
11789 "listcmds",
11790 #endif
11791 #ifdef FEAT_LOCALMAP
11792 "localmap",
11793 #endif
11794 #ifdef FEAT_MENU
11795 "menu",
11796 #endif
11797 #ifdef FEAT_SESSION
11798 "mksession",
11799 #endif
11800 #ifdef FEAT_MODIFY_FNAME
11801 "modify_fname",
11802 #endif
11803 #ifdef FEAT_MOUSE
11804 "mouse",
11805 #endif
11806 #ifdef FEAT_MOUSESHAPE
11807 "mouseshape",
11808 #endif
11809 #if defined(UNIX) || defined(VMS)
11810 # ifdef FEAT_MOUSE_DEC
11811 "mouse_dec",
11812 # endif
11813 # ifdef FEAT_MOUSE_GPM
11814 "mouse_gpm",
11815 # endif
11816 # ifdef FEAT_MOUSE_JSB
11817 "mouse_jsbterm",
11818 # endif
11819 # ifdef FEAT_MOUSE_NET
11820 "mouse_netterm",
11821 # endif
11822 # ifdef FEAT_MOUSE_PTERM
11823 "mouse_pterm",
11824 # endif
11825 # ifdef FEAT_SYSMOUSE
11826 "mouse_sysmouse",
11827 # endif
11828 # ifdef FEAT_MOUSE_XTERM
11829 "mouse_xterm",
11830 # endif
11831 #endif
11832 #ifdef FEAT_MBYTE
11833 "multi_byte",
11834 #endif
11835 #ifdef FEAT_MBYTE_IME
11836 "multi_byte_ime",
11837 #endif
11838 #ifdef FEAT_MULTI_LANG
11839 "multi_lang",
11840 #endif
11841 #ifdef FEAT_MZSCHEME
11842 #ifndef DYNAMIC_MZSCHEME
11843 "mzscheme",
11844 #endif
11845 #endif
11846 #ifdef FEAT_OLE
11847 "ole",
11848 #endif
11849 #ifdef FEAT_OSFILETYPE
11850 "osfiletype",
11851 #endif
11852 #ifdef FEAT_PATH_EXTRA
11853 "path_extra",
11854 #endif
11855 #ifdef FEAT_PERL
11856 #ifndef DYNAMIC_PERL
11857 "perl",
11858 #endif
11859 #endif
11860 #ifdef FEAT_PYTHON
11861 #ifndef DYNAMIC_PYTHON
11862 "python",
11863 #endif
11864 #endif
11865 #ifdef FEAT_POSTSCRIPT
11866 "postscript",
11867 #endif
11868 #ifdef FEAT_PRINTER
11869 "printer",
11870 #endif
11871 #ifdef FEAT_PROFILE
11872 "profile",
11873 #endif
11874 #ifdef FEAT_RELTIME
11875 "reltime",
11876 #endif
11877 #ifdef FEAT_QUICKFIX
11878 "quickfix",
11879 #endif
11880 #ifdef FEAT_RIGHTLEFT
11881 "rightleft",
11882 #endif
11883 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11884 "ruby",
11885 #endif
11886 #ifdef FEAT_SCROLLBIND
11887 "scrollbind",
11888 #endif
11889 #ifdef FEAT_CMDL_INFO
11890 "showcmd",
11891 "cmdline_info",
11892 #endif
11893 #ifdef FEAT_SIGNS
11894 "signs",
11895 #endif
11896 #ifdef FEAT_SMARTINDENT
11897 "smartindent",
11898 #endif
11899 #ifdef FEAT_SNIFF
11900 "sniff",
11901 #endif
11902 #ifdef FEAT_STL_OPT
11903 "statusline",
11904 #endif
11905 #ifdef FEAT_SUN_WORKSHOP
11906 "sun_workshop",
11907 #endif
11908 #ifdef FEAT_NETBEANS_INTG
11909 "netbeans_intg",
11910 #endif
11911 #ifdef FEAT_SPELL
11912 "spell",
11913 #endif
11914 #ifdef FEAT_SYN_HL
11915 "syntax",
11916 #endif
11917 #if defined(USE_SYSTEM) || !defined(UNIX)
11918 "system",
11919 #endif
11920 #ifdef FEAT_TAG_BINS
11921 "tag_binary",
11922 #endif
11923 #ifdef FEAT_TAG_OLDSTATIC
11924 "tag_old_static",
11925 #endif
11926 #ifdef FEAT_TAG_ANYWHITE
11927 "tag_any_white",
11928 #endif
11929 #ifdef FEAT_TCL
11930 # ifndef DYNAMIC_TCL
11931 "tcl",
11932 # endif
11933 #endif
11934 #ifdef TERMINFO
11935 "terminfo",
11936 #endif
11937 #ifdef FEAT_TERMRESPONSE
11938 "termresponse",
11939 #endif
11940 #ifdef FEAT_TEXTOBJ
11941 "textobjects",
11942 #endif
11943 #ifdef HAVE_TGETENT
11944 "tgetent",
11945 #endif
11946 #ifdef FEAT_TITLE
11947 "title",
11948 #endif
11949 #ifdef FEAT_TOOLBAR
11950 "toolbar",
11951 #endif
11952 #ifdef FEAT_USR_CMDS
11953 "user-commands", /* was accidentally included in 5.4 */
11954 "user_commands",
11955 #endif
11956 #ifdef FEAT_VIMINFO
11957 "viminfo",
11958 #endif
11959 #ifdef FEAT_VERTSPLIT
11960 "vertsplit",
11961 #endif
11962 #ifdef FEAT_VIRTUALEDIT
11963 "virtualedit",
11964 #endif
11965 #ifdef FEAT_VISUAL
11966 "visual",
11967 #endif
11968 #ifdef FEAT_VISUALEXTRA
11969 "visualextra",
11970 #endif
11971 #ifdef FEAT_VREPLACE
11972 "vreplace",
11973 #endif
11974 #ifdef FEAT_WILDIGN
11975 "wildignore",
11976 #endif
11977 #ifdef FEAT_WILDMENU
11978 "wildmenu",
11979 #endif
11980 #ifdef FEAT_WINDOWS
11981 "windows",
11982 #endif
11983 #ifdef FEAT_WAK
11984 "winaltkeys",
11985 #endif
11986 #ifdef FEAT_WRITEBACKUP
11987 "writebackup",
11988 #endif
11989 #ifdef FEAT_XIM
11990 "xim",
11991 #endif
11992 #ifdef FEAT_XFONTSET
11993 "xfontset",
11994 #endif
11995 #ifdef USE_XSMP
11996 "xsmp",
11997 #endif
11998 #ifdef USE_XSMP_INTERACT
11999 "xsmp_interact",
12000 #endif
12001 #ifdef FEAT_XCLIPBOARD
12002 "xterm_clipboard",
12003 #endif
12004 #ifdef FEAT_XTERM_SAVE
12005 "xterm_save",
12006 #endif
12007 #if defined(UNIX) && defined(FEAT_X11)
12008 "X11",
12009 #endif
12010 NULL
12013 name = get_tv_string(&argvars[0]);
12014 for (i = 0; has_list[i] != NULL; ++i)
12015 if (STRICMP(name, has_list[i]) == 0)
12017 n = TRUE;
12018 break;
12021 if (n == FALSE)
12023 if (STRNICMP(name, "patch", 5) == 0)
12024 n = has_patch(atoi((char *)name + 5));
12025 else if (STRICMP(name, "vim_starting") == 0)
12026 n = (starting != 0);
12027 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
12028 else if (STRICMP(name, "balloon_multiline") == 0)
12029 n = multiline_balloon_available();
12030 #endif
12031 #ifdef DYNAMIC_TCL
12032 else if (STRICMP(name, "tcl") == 0)
12033 n = tcl_enabled(FALSE);
12034 #endif
12035 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
12036 else if (STRICMP(name, "iconv") == 0)
12037 n = iconv_enabled(FALSE);
12038 #endif
12039 #ifdef DYNAMIC_MZSCHEME
12040 else if (STRICMP(name, "mzscheme") == 0)
12041 n = mzscheme_enabled(FALSE);
12042 #endif
12043 #ifdef DYNAMIC_RUBY
12044 else if (STRICMP(name, "ruby") == 0)
12045 n = ruby_enabled(FALSE);
12046 #endif
12047 #ifdef DYNAMIC_PYTHON
12048 else if (STRICMP(name, "python") == 0)
12049 n = python_enabled(FALSE);
12050 #endif
12051 #ifdef DYNAMIC_PERL
12052 else if (STRICMP(name, "perl") == 0)
12053 n = perl_enabled(FALSE);
12054 #endif
12055 #ifdef FEAT_GUI
12056 else if (STRICMP(name, "gui_running") == 0)
12057 n = (gui.in_use || gui.starting);
12058 # ifdef FEAT_GUI_W32
12059 else if (STRICMP(name, "gui_win32s") == 0)
12060 n = gui_is_win32s();
12061 # endif
12062 # ifdef FEAT_BROWSE
12063 else if (STRICMP(name, "browse") == 0)
12064 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
12065 # endif
12066 #endif
12067 #ifdef FEAT_SYN_HL
12068 else if (STRICMP(name, "syntax_items") == 0)
12069 n = syntax_present(curbuf);
12070 #endif
12071 #if defined(WIN3264)
12072 else if (STRICMP(name, "win95") == 0)
12073 n = mch_windows95();
12074 #endif
12075 #ifdef FEAT_NETBEANS_INTG
12076 else if (STRICMP(name, "netbeans_enabled") == 0)
12077 n = usingNetbeans;
12078 #endif
12081 rettv->vval.v_number = n;
12085 * "has_key()" function
12087 static void
12088 f_has_key(argvars, rettv)
12089 typval_T *argvars;
12090 typval_T *rettv;
12092 rettv->vval.v_number = 0;
12093 if (argvars[0].v_type != VAR_DICT)
12095 EMSG(_(e_dictreq));
12096 return;
12098 if (argvars[0].vval.v_dict == NULL)
12099 return;
12101 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
12102 get_tv_string(&argvars[1]), -1) != NULL;
12106 * "haslocaldir()" function
12108 /*ARGSUSED*/
12109 static void
12110 f_haslocaldir(argvars, rettv)
12111 typval_T *argvars;
12112 typval_T *rettv;
12114 rettv->vval.v_number = (curwin->w_localdir != NULL);
12118 * "hasmapto()" function
12120 static void
12121 f_hasmapto(argvars, rettv)
12122 typval_T *argvars;
12123 typval_T *rettv;
12125 char_u *name;
12126 char_u *mode;
12127 char_u buf[NUMBUFLEN];
12128 int abbr = FALSE;
12130 name = get_tv_string(&argvars[0]);
12131 if (argvars[1].v_type == VAR_UNKNOWN)
12132 mode = (char_u *)"nvo";
12133 else
12135 mode = get_tv_string_buf(&argvars[1], buf);
12136 if (argvars[2].v_type != VAR_UNKNOWN)
12137 abbr = get_tv_number(&argvars[2]);
12140 if (map_to_exists(name, mode, abbr))
12141 rettv->vval.v_number = TRUE;
12142 else
12143 rettv->vval.v_number = FALSE;
12147 * "histadd()" function
12149 /*ARGSUSED*/
12150 static void
12151 f_histadd(argvars, rettv)
12152 typval_T *argvars;
12153 typval_T *rettv;
12155 #ifdef FEAT_CMDHIST
12156 int histype;
12157 char_u *str;
12158 char_u buf[NUMBUFLEN];
12159 #endif
12161 rettv->vval.v_number = FALSE;
12162 if (check_restricted() || check_secure())
12163 return;
12164 #ifdef FEAT_CMDHIST
12165 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12166 histype = str != NULL ? get_histtype(str) : -1;
12167 if (histype >= 0)
12169 str = get_tv_string_buf(&argvars[1], buf);
12170 if (*str != NUL)
12172 add_to_history(histype, str, FALSE, NUL);
12173 rettv->vval.v_number = TRUE;
12174 return;
12177 #endif
12181 * "histdel()" function
12183 /*ARGSUSED*/
12184 static void
12185 f_histdel(argvars, rettv)
12186 typval_T *argvars;
12187 typval_T *rettv;
12189 #ifdef FEAT_CMDHIST
12190 int n;
12191 char_u buf[NUMBUFLEN];
12192 char_u *str;
12194 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12195 if (str == NULL)
12196 n = 0;
12197 else if (argvars[1].v_type == VAR_UNKNOWN)
12198 /* only one argument: clear entire history */
12199 n = clr_history(get_histtype(str));
12200 else if (argvars[1].v_type == VAR_NUMBER)
12201 /* index given: remove that entry */
12202 n = del_history_idx(get_histtype(str),
12203 (int)get_tv_number(&argvars[1]));
12204 else
12205 /* string given: remove all matching entries */
12206 n = del_history_entry(get_histtype(str),
12207 get_tv_string_buf(&argvars[1], buf));
12208 rettv->vval.v_number = n;
12209 #else
12210 rettv->vval.v_number = 0;
12211 #endif
12215 * "histget()" function
12217 /*ARGSUSED*/
12218 static void
12219 f_histget(argvars, rettv)
12220 typval_T *argvars;
12221 typval_T *rettv;
12223 #ifdef FEAT_CMDHIST
12224 int type;
12225 int idx;
12226 char_u *str;
12228 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12229 if (str == NULL)
12230 rettv->vval.v_string = NULL;
12231 else
12233 type = get_histtype(str);
12234 if (argvars[1].v_type == VAR_UNKNOWN)
12235 idx = get_history_idx(type);
12236 else
12237 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12238 /* -1 on type error */
12239 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12241 #else
12242 rettv->vval.v_string = NULL;
12243 #endif
12244 rettv->v_type = VAR_STRING;
12248 * "histnr()" function
12250 /*ARGSUSED*/
12251 static void
12252 f_histnr(argvars, rettv)
12253 typval_T *argvars;
12254 typval_T *rettv;
12256 int i;
12258 #ifdef FEAT_CMDHIST
12259 char_u *history = get_tv_string_chk(&argvars[0]);
12261 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12262 if (i >= HIST_CMD && i < HIST_COUNT)
12263 i = get_history_idx(i);
12264 else
12265 #endif
12266 i = -1;
12267 rettv->vval.v_number = i;
12271 * "highlightID(name)" function
12273 static void
12274 f_hlID(argvars, rettv)
12275 typval_T *argvars;
12276 typval_T *rettv;
12278 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12282 * "highlight_exists()" function
12284 static void
12285 f_hlexists(argvars, rettv)
12286 typval_T *argvars;
12287 typval_T *rettv;
12289 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12293 * "hostname()" function
12295 /*ARGSUSED*/
12296 static void
12297 f_hostname(argvars, rettv)
12298 typval_T *argvars;
12299 typval_T *rettv;
12301 char_u hostname[256];
12303 mch_get_host_name(hostname, 256);
12304 rettv->v_type = VAR_STRING;
12305 rettv->vval.v_string = vim_strsave(hostname);
12309 * iconv() function
12311 /*ARGSUSED*/
12312 static void
12313 f_iconv(argvars, rettv)
12314 typval_T *argvars;
12315 typval_T *rettv;
12317 #ifdef FEAT_MBYTE
12318 char_u buf1[NUMBUFLEN];
12319 char_u buf2[NUMBUFLEN];
12320 char_u *from, *to, *str;
12321 vimconv_T vimconv;
12322 #endif
12324 rettv->v_type = VAR_STRING;
12325 rettv->vval.v_string = NULL;
12327 #ifdef FEAT_MBYTE
12328 str = get_tv_string(&argvars[0]);
12329 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12330 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12331 vimconv.vc_type = CONV_NONE;
12332 convert_setup(&vimconv, from, to);
12334 /* If the encodings are equal, no conversion needed. */
12335 if (vimconv.vc_type == CONV_NONE)
12336 rettv->vval.v_string = vim_strsave(str);
12337 else
12338 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12340 convert_setup(&vimconv, NULL, NULL);
12341 vim_free(from);
12342 vim_free(to);
12343 #endif
12347 * "indent()" function
12349 static void
12350 f_indent(argvars, rettv)
12351 typval_T *argvars;
12352 typval_T *rettv;
12354 linenr_T lnum;
12356 lnum = get_tv_lnum(argvars);
12357 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12358 rettv->vval.v_number = get_indent_lnum(lnum);
12359 else
12360 rettv->vval.v_number = -1;
12364 * "index()" function
12366 static void
12367 f_index(argvars, rettv)
12368 typval_T *argvars;
12369 typval_T *rettv;
12371 list_T *l;
12372 listitem_T *item;
12373 long idx = 0;
12374 int ic = FALSE;
12376 rettv->vval.v_number = -1;
12377 if (argvars[0].v_type != VAR_LIST)
12379 EMSG(_(e_listreq));
12380 return;
12382 l = argvars[0].vval.v_list;
12383 if (l != NULL)
12385 item = l->lv_first;
12386 if (argvars[2].v_type != VAR_UNKNOWN)
12388 int error = FALSE;
12390 /* Start at specified item. Use the cached index that list_find()
12391 * sets, so that a negative number also works. */
12392 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12393 idx = l->lv_idx;
12394 if (argvars[3].v_type != VAR_UNKNOWN)
12395 ic = get_tv_number_chk(&argvars[3], &error);
12396 if (error)
12397 item = NULL;
12400 for ( ; item != NULL; item = item->li_next, ++idx)
12401 if (tv_equal(&item->li_tv, &argvars[1], ic))
12403 rettv->vval.v_number = idx;
12404 break;
12409 static int inputsecret_flag = 0;
12411 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12414 * This function is used by f_input() and f_inputdialog() functions. The third
12415 * argument to f_input() specifies the type of completion to use at the
12416 * prompt. The third argument to f_inputdialog() specifies the value to return
12417 * when the user cancels the prompt.
12419 static void
12420 get_user_input(argvars, rettv, inputdialog)
12421 typval_T *argvars;
12422 typval_T *rettv;
12423 int inputdialog;
12425 char_u *prompt = get_tv_string_chk(&argvars[0]);
12426 char_u *p = NULL;
12427 int c;
12428 char_u buf[NUMBUFLEN];
12429 int cmd_silent_save = cmd_silent;
12430 char_u *defstr = (char_u *)"";
12431 int xp_type = EXPAND_NOTHING;
12432 char_u *xp_arg = NULL;
12434 rettv->v_type = VAR_STRING;
12435 rettv->vval.v_string = NULL;
12437 #ifdef NO_CONSOLE_INPUT
12438 /* While starting up, there is no place to enter text. */
12439 if (no_console_input())
12440 return;
12441 #endif
12443 cmd_silent = FALSE; /* Want to see the prompt. */
12444 if (prompt != NULL)
12446 /* Only the part of the message after the last NL is considered as
12447 * prompt for the command line */
12448 p = vim_strrchr(prompt, '\n');
12449 if (p == NULL)
12450 p = prompt;
12451 else
12453 ++p;
12454 c = *p;
12455 *p = NUL;
12456 msg_start();
12457 msg_clr_eos();
12458 msg_puts_attr(prompt, echo_attr);
12459 msg_didout = FALSE;
12460 msg_starthere();
12461 *p = c;
12463 cmdline_row = msg_row;
12465 if (argvars[1].v_type != VAR_UNKNOWN)
12467 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12468 if (defstr != NULL)
12469 stuffReadbuffSpec(defstr);
12471 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12473 char_u *xp_name;
12474 int xp_namelen;
12475 long argt;
12477 rettv->vval.v_string = NULL;
12479 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12480 if (xp_name == NULL)
12481 return;
12483 xp_namelen = (int)STRLEN(xp_name);
12485 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12486 &xp_arg) == FAIL)
12487 return;
12491 if (defstr != NULL)
12492 rettv->vval.v_string =
12493 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12494 xp_type, xp_arg);
12496 vim_free(xp_arg);
12498 /* since the user typed this, no need to wait for return */
12499 need_wait_return = FALSE;
12500 msg_didout = FALSE;
12502 cmd_silent = cmd_silent_save;
12506 * "input()" function
12507 * Also handles inputsecret() when inputsecret is set.
12509 static void
12510 f_input(argvars, rettv)
12511 typval_T *argvars;
12512 typval_T *rettv;
12514 get_user_input(argvars, rettv, FALSE);
12518 * "inputdialog()" function
12520 static void
12521 f_inputdialog(argvars, rettv)
12522 typval_T *argvars;
12523 typval_T *rettv;
12525 #if defined(FEAT_GUI_TEXTDIALOG)
12526 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12527 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12529 char_u *message;
12530 char_u buf[NUMBUFLEN];
12531 char_u *defstr = (char_u *)"";
12533 message = get_tv_string_chk(&argvars[0]);
12534 if (argvars[1].v_type != VAR_UNKNOWN
12535 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12536 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12537 else
12538 IObuff[0] = NUL;
12539 if (message != NULL && defstr != NULL
12540 && do_dialog(VIM_QUESTION, NULL, message,
12541 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12542 rettv->vval.v_string = vim_strsave(IObuff);
12543 else
12545 if (message != NULL && defstr != NULL
12546 && argvars[1].v_type != VAR_UNKNOWN
12547 && argvars[2].v_type != VAR_UNKNOWN)
12548 rettv->vval.v_string = vim_strsave(
12549 get_tv_string_buf(&argvars[2], buf));
12550 else
12551 rettv->vval.v_string = NULL;
12553 rettv->v_type = VAR_STRING;
12555 else
12556 #endif
12557 get_user_input(argvars, rettv, TRUE);
12561 * "inputlist()" function
12563 static void
12564 f_inputlist(argvars, rettv)
12565 typval_T *argvars;
12566 typval_T *rettv;
12568 listitem_T *li;
12569 int selected;
12570 int mouse_used;
12572 rettv->vval.v_number = 0;
12573 #ifdef NO_CONSOLE_INPUT
12574 /* While starting up, there is no place to enter text. */
12575 if (no_console_input())
12576 return;
12577 #endif
12578 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12580 EMSG2(_(e_listarg), "inputlist()");
12581 return;
12584 msg_start();
12585 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12586 lines_left = Rows; /* avoid more prompt */
12587 msg_scroll = TRUE;
12588 msg_clr_eos();
12590 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12592 msg_puts(get_tv_string(&li->li_tv));
12593 msg_putchar('\n');
12596 /* Ask for choice. */
12597 selected = prompt_for_number(&mouse_used);
12598 if (mouse_used)
12599 selected -= lines_left;
12601 rettv->vval.v_number = selected;
12605 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12608 * "inputrestore()" function
12610 /*ARGSUSED*/
12611 static void
12612 f_inputrestore(argvars, rettv)
12613 typval_T *argvars;
12614 typval_T *rettv;
12616 if (ga_userinput.ga_len > 0)
12618 --ga_userinput.ga_len;
12619 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12620 + ga_userinput.ga_len);
12621 rettv->vval.v_number = 0; /* OK */
12623 else if (p_verbose > 1)
12625 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12626 rettv->vval.v_number = 1; /* Failed */
12631 * "inputsave()" function
12633 /*ARGSUSED*/
12634 static void
12635 f_inputsave(argvars, rettv)
12636 typval_T *argvars;
12637 typval_T *rettv;
12639 /* Add an entry to the stack of typeahead storage. */
12640 if (ga_grow(&ga_userinput, 1) == OK)
12642 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12643 + ga_userinput.ga_len);
12644 ++ga_userinput.ga_len;
12645 rettv->vval.v_number = 0; /* OK */
12647 else
12648 rettv->vval.v_number = 1; /* Failed */
12652 * "inputsecret()" function
12654 static void
12655 f_inputsecret(argvars, rettv)
12656 typval_T *argvars;
12657 typval_T *rettv;
12659 ++cmdline_star;
12660 ++inputsecret_flag;
12661 f_input(argvars, rettv);
12662 --cmdline_star;
12663 --inputsecret_flag;
12667 * "insert()" function
12669 static void
12670 f_insert(argvars, rettv)
12671 typval_T *argvars;
12672 typval_T *rettv;
12674 long before = 0;
12675 listitem_T *item;
12676 list_T *l;
12677 int error = FALSE;
12679 rettv->vval.v_number = 0;
12680 if (argvars[0].v_type != VAR_LIST)
12681 EMSG2(_(e_listarg), "insert()");
12682 else if ((l = argvars[0].vval.v_list) != NULL
12683 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12685 if (argvars[2].v_type != VAR_UNKNOWN)
12686 before = get_tv_number_chk(&argvars[2], &error);
12687 if (error)
12688 return; /* type error; errmsg already given */
12690 if (before == l->lv_len)
12691 item = NULL;
12692 else
12694 item = list_find(l, before);
12695 if (item == NULL)
12697 EMSGN(_(e_listidx), before);
12698 l = NULL;
12701 if (l != NULL)
12703 list_insert_tv(l, &argvars[1], item);
12704 copy_tv(&argvars[0], rettv);
12710 * "isdirectory()" function
12712 static void
12713 f_isdirectory(argvars, rettv)
12714 typval_T *argvars;
12715 typval_T *rettv;
12717 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12721 * "islocked()" function
12723 static void
12724 f_islocked(argvars, rettv)
12725 typval_T *argvars;
12726 typval_T *rettv;
12728 lval_T lv;
12729 char_u *end;
12730 dictitem_T *di;
12732 rettv->vval.v_number = -1;
12733 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12734 FNE_CHECK_START);
12735 if (end != NULL && lv.ll_name != NULL)
12737 if (*end != NUL)
12738 EMSG(_(e_trailing));
12739 else
12741 if (lv.ll_tv == NULL)
12743 if (check_changedtick(lv.ll_name))
12744 rettv->vval.v_number = 1; /* always locked */
12745 else
12747 di = find_var(lv.ll_name, NULL);
12748 if (di != NULL)
12750 /* Consider a variable locked when:
12751 * 1. the variable itself is locked
12752 * 2. the value of the variable is locked.
12753 * 3. the List or Dict value is locked.
12755 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12756 || tv_islocked(&di->di_tv));
12760 else if (lv.ll_range)
12761 EMSG(_("E786: Range not allowed"));
12762 else if (lv.ll_newkey != NULL)
12763 EMSG2(_(e_dictkey), lv.ll_newkey);
12764 else if (lv.ll_list != NULL)
12765 /* List item. */
12766 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12767 else
12768 /* Dictionary item. */
12769 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12773 clear_lval(&lv);
12776 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12779 * Turn a dict into a list:
12780 * "what" == 0: list of keys
12781 * "what" == 1: list of values
12782 * "what" == 2: list of items
12784 static void
12785 dict_list(argvars, rettv, what)
12786 typval_T *argvars;
12787 typval_T *rettv;
12788 int what;
12790 list_T *l2;
12791 dictitem_T *di;
12792 hashitem_T *hi;
12793 listitem_T *li;
12794 listitem_T *li2;
12795 dict_T *d;
12796 int todo;
12798 rettv->vval.v_number = 0;
12799 if (argvars[0].v_type != VAR_DICT)
12801 EMSG(_(e_dictreq));
12802 return;
12804 if ((d = argvars[0].vval.v_dict) == NULL)
12805 return;
12807 if (rettv_list_alloc(rettv) == FAIL)
12808 return;
12810 todo = (int)d->dv_hashtab.ht_used;
12811 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12813 if (!HASHITEM_EMPTY(hi))
12815 --todo;
12816 di = HI2DI(hi);
12818 li = listitem_alloc();
12819 if (li == NULL)
12820 break;
12821 list_append(rettv->vval.v_list, li);
12823 if (what == 0)
12825 /* keys() */
12826 li->li_tv.v_type = VAR_STRING;
12827 li->li_tv.v_lock = 0;
12828 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12830 else if (what == 1)
12832 /* values() */
12833 copy_tv(&di->di_tv, &li->li_tv);
12835 else
12837 /* items() */
12838 l2 = list_alloc();
12839 li->li_tv.v_type = VAR_LIST;
12840 li->li_tv.v_lock = 0;
12841 li->li_tv.vval.v_list = l2;
12842 if (l2 == NULL)
12843 break;
12844 ++l2->lv_refcount;
12846 li2 = listitem_alloc();
12847 if (li2 == NULL)
12848 break;
12849 list_append(l2, li2);
12850 li2->li_tv.v_type = VAR_STRING;
12851 li2->li_tv.v_lock = 0;
12852 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12854 li2 = listitem_alloc();
12855 if (li2 == NULL)
12856 break;
12857 list_append(l2, li2);
12858 copy_tv(&di->di_tv, &li2->li_tv);
12865 * "items(dict)" function
12867 static void
12868 f_items(argvars, rettv)
12869 typval_T *argvars;
12870 typval_T *rettv;
12872 dict_list(argvars, rettv, 2);
12876 * "join()" function
12878 static void
12879 f_join(argvars, rettv)
12880 typval_T *argvars;
12881 typval_T *rettv;
12883 garray_T ga;
12884 char_u *sep;
12886 rettv->vval.v_number = 0;
12887 if (argvars[0].v_type != VAR_LIST)
12889 EMSG(_(e_listreq));
12890 return;
12892 if (argvars[0].vval.v_list == NULL)
12893 return;
12894 if (argvars[1].v_type == VAR_UNKNOWN)
12895 sep = (char_u *)" ";
12896 else
12897 sep = get_tv_string_chk(&argvars[1]);
12899 rettv->v_type = VAR_STRING;
12901 if (sep != NULL)
12903 ga_init2(&ga, (int)sizeof(char), 80);
12904 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12905 ga_append(&ga, NUL);
12906 rettv->vval.v_string = (char_u *)ga.ga_data;
12908 else
12909 rettv->vval.v_string = NULL;
12913 * "keys()" function
12915 static void
12916 f_keys(argvars, rettv)
12917 typval_T *argvars;
12918 typval_T *rettv;
12920 dict_list(argvars, rettv, 0);
12924 * "last_buffer_nr()" function.
12926 /*ARGSUSED*/
12927 static void
12928 f_last_buffer_nr(argvars, rettv)
12929 typval_T *argvars;
12930 typval_T *rettv;
12932 int n = 0;
12933 buf_T *buf;
12935 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12936 if (n < buf->b_fnum)
12937 n = buf->b_fnum;
12939 rettv->vval.v_number = n;
12943 * "len()" function
12945 static void
12946 f_len(argvars, rettv)
12947 typval_T *argvars;
12948 typval_T *rettv;
12950 switch (argvars[0].v_type)
12952 case VAR_STRING:
12953 case VAR_NUMBER:
12954 rettv->vval.v_number = (varnumber_T)STRLEN(
12955 get_tv_string(&argvars[0]));
12956 break;
12957 case VAR_LIST:
12958 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12959 break;
12960 case VAR_DICT:
12961 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12962 break;
12963 default:
12964 EMSG(_("E701: Invalid type for len()"));
12965 break;
12969 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12971 static void
12972 libcall_common(argvars, rettv, type)
12973 typval_T *argvars;
12974 typval_T *rettv;
12975 int type;
12977 #ifdef FEAT_LIBCALL
12978 char_u *string_in;
12979 char_u **string_result;
12980 int nr_result;
12981 #endif
12983 rettv->v_type = type;
12984 if (type == VAR_NUMBER)
12985 rettv->vval.v_number = 0;
12986 else
12987 rettv->vval.v_string = NULL;
12989 if (check_restricted() || check_secure())
12990 return;
12992 #ifdef FEAT_LIBCALL
12993 /* The first two args must be strings, otherwise its meaningless */
12994 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12996 string_in = NULL;
12997 if (argvars[2].v_type == VAR_STRING)
12998 string_in = argvars[2].vval.v_string;
12999 if (type == VAR_NUMBER)
13000 string_result = NULL;
13001 else
13002 string_result = &rettv->vval.v_string;
13003 if (mch_libcall(argvars[0].vval.v_string,
13004 argvars[1].vval.v_string,
13005 string_in,
13006 argvars[2].vval.v_number,
13007 string_result,
13008 &nr_result) == OK
13009 && type == VAR_NUMBER)
13010 rettv->vval.v_number = nr_result;
13012 #endif
13016 * "libcall()" function
13018 static void
13019 f_libcall(argvars, rettv)
13020 typval_T *argvars;
13021 typval_T *rettv;
13023 libcall_common(argvars, rettv, VAR_STRING);
13027 * "libcallnr()" function
13029 static void
13030 f_libcallnr(argvars, rettv)
13031 typval_T *argvars;
13032 typval_T *rettv;
13034 libcall_common(argvars, rettv, VAR_NUMBER);
13038 * "line(string)" function
13040 static void
13041 f_line(argvars, rettv)
13042 typval_T *argvars;
13043 typval_T *rettv;
13045 linenr_T lnum = 0;
13046 pos_T *fp;
13047 int fnum;
13049 fp = var2fpos(&argvars[0], TRUE, &fnum);
13050 if (fp != NULL)
13051 lnum = fp->lnum;
13052 rettv->vval.v_number = lnum;
13056 * "line2byte(lnum)" function
13058 /*ARGSUSED*/
13059 static void
13060 f_line2byte(argvars, rettv)
13061 typval_T *argvars;
13062 typval_T *rettv;
13064 #ifndef FEAT_BYTEOFF
13065 rettv->vval.v_number = -1;
13066 #else
13067 linenr_T lnum;
13069 lnum = get_tv_lnum(argvars);
13070 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
13071 rettv->vval.v_number = -1;
13072 else
13073 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
13074 if (rettv->vval.v_number >= 0)
13075 ++rettv->vval.v_number;
13076 #endif
13080 * "lispindent(lnum)" function
13082 static void
13083 f_lispindent(argvars, rettv)
13084 typval_T *argvars;
13085 typval_T *rettv;
13087 #ifdef FEAT_LISP
13088 pos_T pos;
13089 linenr_T lnum;
13091 pos = curwin->w_cursor;
13092 lnum = get_tv_lnum(argvars);
13093 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
13095 curwin->w_cursor.lnum = lnum;
13096 rettv->vval.v_number = get_lisp_indent();
13097 curwin->w_cursor = pos;
13099 else
13100 #endif
13101 rettv->vval.v_number = -1;
13105 * "localtime()" function
13107 /*ARGSUSED*/
13108 static void
13109 f_localtime(argvars, rettv)
13110 typval_T *argvars;
13111 typval_T *rettv;
13113 rettv->vval.v_number = (varnumber_T)time(NULL);
13116 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
13118 static void
13119 get_maparg(argvars, rettv, exact)
13120 typval_T *argvars;
13121 typval_T *rettv;
13122 int exact;
13124 char_u *keys;
13125 char_u *which;
13126 char_u buf[NUMBUFLEN];
13127 char_u *keys_buf = NULL;
13128 char_u *rhs;
13129 int mode;
13130 garray_T ga;
13131 int abbr = FALSE;
13133 /* return empty string for failure */
13134 rettv->v_type = VAR_STRING;
13135 rettv->vval.v_string = NULL;
13137 keys = get_tv_string(&argvars[0]);
13138 if (*keys == NUL)
13139 return;
13141 if (argvars[1].v_type != VAR_UNKNOWN)
13143 which = get_tv_string_buf_chk(&argvars[1], buf);
13144 if (argvars[2].v_type != VAR_UNKNOWN)
13145 abbr = get_tv_number(&argvars[2]);
13147 else
13148 which = (char_u *)"";
13149 if (which == NULL)
13150 return;
13152 mode = get_map_mode(&which, 0);
13154 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
13155 rhs = check_map(keys, mode, exact, FALSE, abbr);
13156 vim_free(keys_buf);
13157 if (rhs != NULL)
13159 ga_init(&ga);
13160 ga.ga_itemsize = 1;
13161 ga.ga_growsize = 40;
13163 while (*rhs != NUL)
13164 ga_concat(&ga, str2special(&rhs, FALSE));
13166 ga_append(&ga, NUL);
13167 rettv->vval.v_string = (char_u *)ga.ga_data;
13171 #ifdef FEAT_FLOAT
13173 * "log10()" function
13175 static void
13176 f_log10(argvars, rettv)
13177 typval_T *argvars;
13178 typval_T *rettv;
13180 float_T f;
13182 rettv->v_type = VAR_FLOAT;
13183 if (get_float_arg(argvars, &f) == OK)
13184 rettv->vval.v_float = log10(f);
13185 else
13186 rettv->vval.v_float = 0.0;
13188 #endif
13191 * "map()" function
13193 static void
13194 f_map(argvars, rettv)
13195 typval_T *argvars;
13196 typval_T *rettv;
13198 filter_map(argvars, rettv, TRUE);
13202 * "maparg()" function
13204 static void
13205 f_maparg(argvars, rettv)
13206 typval_T *argvars;
13207 typval_T *rettv;
13209 get_maparg(argvars, rettv, TRUE);
13213 * "mapcheck()" function
13215 static void
13216 f_mapcheck(argvars, rettv)
13217 typval_T *argvars;
13218 typval_T *rettv;
13220 get_maparg(argvars, rettv, FALSE);
13223 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13225 static void
13226 find_some_match(argvars, rettv, type)
13227 typval_T *argvars;
13228 typval_T *rettv;
13229 int type;
13231 char_u *str = NULL;
13232 char_u *expr = NULL;
13233 char_u *pat;
13234 regmatch_T regmatch;
13235 char_u patbuf[NUMBUFLEN];
13236 char_u strbuf[NUMBUFLEN];
13237 char_u *save_cpo;
13238 long start = 0;
13239 long nth = 1;
13240 colnr_T startcol = 0;
13241 int match = 0;
13242 list_T *l = NULL;
13243 listitem_T *li = NULL;
13244 long idx = 0;
13245 char_u *tofree = NULL;
13247 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13248 save_cpo = p_cpo;
13249 p_cpo = (char_u *)"";
13251 rettv->vval.v_number = -1;
13252 if (type == 3)
13254 /* return empty list when there are no matches */
13255 if (rettv_list_alloc(rettv) == FAIL)
13256 goto theend;
13258 else if (type == 2)
13260 rettv->v_type = VAR_STRING;
13261 rettv->vval.v_string = NULL;
13264 if (argvars[0].v_type == VAR_LIST)
13266 if ((l = argvars[0].vval.v_list) == NULL)
13267 goto theend;
13268 li = l->lv_first;
13270 else
13271 expr = str = get_tv_string(&argvars[0]);
13273 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13274 if (pat == NULL)
13275 goto theend;
13277 if (argvars[2].v_type != VAR_UNKNOWN)
13279 int error = FALSE;
13281 start = get_tv_number_chk(&argvars[2], &error);
13282 if (error)
13283 goto theend;
13284 if (l != NULL)
13286 li = list_find(l, start);
13287 if (li == NULL)
13288 goto theend;
13289 idx = l->lv_idx; /* use the cached index */
13291 else
13293 if (start < 0)
13294 start = 0;
13295 if (start > (long)STRLEN(str))
13296 goto theend;
13297 /* When "count" argument is there ignore matches before "start",
13298 * otherwise skip part of the string. Differs when pattern is "^"
13299 * or "\<". */
13300 if (argvars[3].v_type != VAR_UNKNOWN)
13301 startcol = start;
13302 else
13303 str += start;
13306 if (argvars[3].v_type != VAR_UNKNOWN)
13307 nth = get_tv_number_chk(&argvars[3], &error);
13308 if (error)
13309 goto theend;
13312 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13313 if (regmatch.regprog != NULL)
13315 regmatch.rm_ic = p_ic;
13317 for (;;)
13319 if (l != NULL)
13321 if (li == NULL)
13323 match = FALSE;
13324 break;
13326 vim_free(tofree);
13327 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13328 if (str == NULL)
13329 break;
13332 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13334 if (match && --nth <= 0)
13335 break;
13336 if (l == NULL && !match)
13337 break;
13339 /* Advance to just after the match. */
13340 if (l != NULL)
13342 li = li->li_next;
13343 ++idx;
13345 else
13347 #ifdef FEAT_MBYTE
13348 startcol = (colnr_T)(regmatch.startp[0]
13349 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13350 #else
13351 startcol = regmatch.startp[0] + 1 - str;
13352 #endif
13356 if (match)
13358 if (type == 3)
13360 int i;
13362 /* return list with matched string and submatches */
13363 for (i = 0; i < NSUBEXP; ++i)
13365 if (regmatch.endp[i] == NULL)
13367 if (list_append_string(rettv->vval.v_list,
13368 (char_u *)"", 0) == FAIL)
13369 break;
13371 else if (list_append_string(rettv->vval.v_list,
13372 regmatch.startp[i],
13373 (int)(regmatch.endp[i] - regmatch.startp[i]))
13374 == FAIL)
13375 break;
13378 else if (type == 2)
13380 /* return matched string */
13381 if (l != NULL)
13382 copy_tv(&li->li_tv, rettv);
13383 else
13384 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13385 (int)(regmatch.endp[0] - regmatch.startp[0]));
13387 else if (l != NULL)
13388 rettv->vval.v_number = idx;
13389 else
13391 if (type != 0)
13392 rettv->vval.v_number =
13393 (varnumber_T)(regmatch.startp[0] - str);
13394 else
13395 rettv->vval.v_number =
13396 (varnumber_T)(regmatch.endp[0] - str);
13397 rettv->vval.v_number += (varnumber_T)(str - expr);
13400 vim_free(regmatch.regprog);
13403 theend:
13404 vim_free(tofree);
13405 p_cpo = save_cpo;
13409 * "match()" function
13411 static void
13412 f_match(argvars, rettv)
13413 typval_T *argvars;
13414 typval_T *rettv;
13416 find_some_match(argvars, rettv, 1);
13420 * "matchadd()" function
13422 static void
13423 f_matchadd(argvars, rettv)
13424 typval_T *argvars;
13425 typval_T *rettv;
13427 #ifdef FEAT_SEARCH_EXTRA
13428 char_u buf[NUMBUFLEN];
13429 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13430 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13431 int prio = 10; /* default priority */
13432 int id = -1;
13433 int error = FALSE;
13435 rettv->vval.v_number = -1;
13437 if (grp == NULL || pat == NULL)
13438 return;
13439 if (argvars[2].v_type != VAR_UNKNOWN)
13441 prio = get_tv_number_chk(&argvars[2], &error);
13442 if (argvars[3].v_type != VAR_UNKNOWN)
13443 id = get_tv_number_chk(&argvars[3], &error);
13445 if (error == TRUE)
13446 return;
13447 if (id >= 1 && id <= 3)
13449 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13450 return;
13453 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13454 #endif
13458 * "matcharg()" function
13460 static void
13461 f_matcharg(argvars, rettv)
13462 typval_T *argvars;
13463 typval_T *rettv;
13465 if (rettv_list_alloc(rettv) == OK)
13467 #ifdef FEAT_SEARCH_EXTRA
13468 int id = get_tv_number(&argvars[0]);
13469 matchitem_T *m;
13471 if (id >= 1 && id <= 3)
13473 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13475 list_append_string(rettv->vval.v_list,
13476 syn_id2name(m->hlg_id), -1);
13477 list_append_string(rettv->vval.v_list, m->pattern, -1);
13479 else
13481 list_append_string(rettv->vval.v_list, NUL, -1);
13482 list_append_string(rettv->vval.v_list, NUL, -1);
13485 #endif
13490 * "matchdelete()" function
13492 static void
13493 f_matchdelete(argvars, rettv)
13494 typval_T *argvars;
13495 typval_T *rettv;
13497 #ifdef FEAT_SEARCH_EXTRA
13498 rettv->vval.v_number = match_delete(curwin,
13499 (int)get_tv_number(&argvars[0]), TRUE);
13500 #endif
13504 * "matchend()" function
13506 static void
13507 f_matchend(argvars, rettv)
13508 typval_T *argvars;
13509 typval_T *rettv;
13511 find_some_match(argvars, rettv, 0);
13515 * "matchlist()" function
13517 static void
13518 f_matchlist(argvars, rettv)
13519 typval_T *argvars;
13520 typval_T *rettv;
13522 find_some_match(argvars, rettv, 3);
13526 * "matchstr()" function
13528 static void
13529 f_matchstr(argvars, rettv)
13530 typval_T *argvars;
13531 typval_T *rettv;
13533 find_some_match(argvars, rettv, 2);
13536 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13538 static void
13539 max_min(argvars, rettv, domax)
13540 typval_T *argvars;
13541 typval_T *rettv;
13542 int domax;
13544 long n = 0;
13545 long i;
13546 int error = FALSE;
13548 if (argvars[0].v_type == VAR_LIST)
13550 list_T *l;
13551 listitem_T *li;
13553 l = argvars[0].vval.v_list;
13554 if (l != NULL)
13556 li = l->lv_first;
13557 if (li != NULL)
13559 n = get_tv_number_chk(&li->li_tv, &error);
13560 for (;;)
13562 li = li->li_next;
13563 if (li == NULL)
13564 break;
13565 i = get_tv_number_chk(&li->li_tv, &error);
13566 if (domax ? i > n : i < n)
13567 n = i;
13572 else if (argvars[0].v_type == VAR_DICT)
13574 dict_T *d;
13575 int first = TRUE;
13576 hashitem_T *hi;
13577 int todo;
13579 d = argvars[0].vval.v_dict;
13580 if (d != NULL)
13582 todo = (int)d->dv_hashtab.ht_used;
13583 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13585 if (!HASHITEM_EMPTY(hi))
13587 --todo;
13588 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13589 if (first)
13591 n = i;
13592 first = FALSE;
13594 else if (domax ? i > n : i < n)
13595 n = i;
13600 else
13601 EMSG(_(e_listdictarg));
13602 rettv->vval.v_number = error ? 0 : n;
13606 * "max()" function
13608 static void
13609 f_max(argvars, rettv)
13610 typval_T *argvars;
13611 typval_T *rettv;
13613 max_min(argvars, rettv, TRUE);
13617 * "min()" function
13619 static void
13620 f_min(argvars, rettv)
13621 typval_T *argvars;
13622 typval_T *rettv;
13624 max_min(argvars, rettv, FALSE);
13627 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13630 * Create the directory in which "dir" is located, and higher levels when
13631 * needed.
13633 static int
13634 mkdir_recurse(dir, prot)
13635 char_u *dir;
13636 int prot;
13638 char_u *p;
13639 char_u *updir;
13640 int r = FAIL;
13642 /* Get end of directory name in "dir".
13643 * We're done when it's "/" or "c:/". */
13644 p = gettail_sep(dir);
13645 if (p <= get_past_head(dir))
13646 return OK;
13648 /* If the directory exists we're done. Otherwise: create it.*/
13649 updir = vim_strnsave(dir, (int)(p - dir));
13650 if (updir == NULL)
13651 return FAIL;
13652 if (mch_isdir(updir))
13653 r = OK;
13654 else if (mkdir_recurse(updir, prot) == OK)
13655 r = vim_mkdir_emsg(updir, prot);
13656 vim_free(updir);
13657 return r;
13660 #ifdef vim_mkdir
13662 * "mkdir()" function
13664 static void
13665 f_mkdir(argvars, rettv)
13666 typval_T *argvars;
13667 typval_T *rettv;
13669 char_u *dir;
13670 char_u buf[NUMBUFLEN];
13671 int prot = 0755;
13673 rettv->vval.v_number = FAIL;
13674 if (check_restricted() || check_secure())
13675 return;
13677 dir = get_tv_string_buf(&argvars[0], buf);
13678 if (argvars[1].v_type != VAR_UNKNOWN)
13680 if (argvars[2].v_type != VAR_UNKNOWN)
13681 prot = get_tv_number_chk(&argvars[2], NULL);
13682 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13683 mkdir_recurse(dir, prot);
13685 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13687 #endif
13690 * "mode()" function
13692 /*ARGSUSED*/
13693 static void
13694 f_mode(argvars, rettv)
13695 typval_T *argvars;
13696 typval_T *rettv;
13698 char_u buf[3];
13700 buf[1] = NUL;
13701 buf[2] = NUL;
13703 #ifdef FEAT_VISUAL
13704 if (VIsual_active)
13706 if (VIsual_select)
13707 buf[0] = VIsual_mode + 's' - 'v';
13708 else
13709 buf[0] = VIsual_mode;
13711 else
13712 #endif
13713 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13714 || State == CONFIRM)
13716 buf[0] = 'r';
13717 if (State == ASKMORE)
13718 buf[1] = 'm';
13719 else if (State == CONFIRM)
13720 buf[1] = '?';
13722 else if (State == EXTERNCMD)
13723 buf[0] = '!';
13724 else if (State & INSERT)
13726 #ifdef FEAT_VREPLACE
13727 if (State & VREPLACE_FLAG)
13729 buf[0] = 'R';
13730 buf[1] = 'v';
13732 else
13733 #endif
13734 if (State & REPLACE_FLAG)
13735 buf[0] = 'R';
13736 else
13737 buf[0] = 'i';
13739 else if (State & CMDLINE)
13741 buf[0] = 'c';
13742 if (exmode_active)
13743 buf[1] = 'v';
13745 else if (exmode_active)
13747 buf[0] = 'c';
13748 buf[1] = 'e';
13750 else
13752 buf[0] = 'n';
13753 if (finish_op)
13754 buf[1] = 'o';
13757 /* Clear out the minor mode when the argument is not a non-zero number or
13758 * non-empty string. */
13759 if (!non_zero_arg(&argvars[0]))
13760 buf[1] = NUL;
13762 rettv->vval.v_string = vim_strsave(buf);
13763 rettv->v_type = VAR_STRING;
13767 * "nextnonblank()" function
13769 static void
13770 f_nextnonblank(argvars, rettv)
13771 typval_T *argvars;
13772 typval_T *rettv;
13774 linenr_T lnum;
13776 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13778 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13780 lnum = 0;
13781 break;
13783 if (*skipwhite(ml_get(lnum)) != NUL)
13784 break;
13786 rettv->vval.v_number = lnum;
13790 * "nr2char()" function
13792 static void
13793 f_nr2char(argvars, rettv)
13794 typval_T *argvars;
13795 typval_T *rettv;
13797 char_u buf[NUMBUFLEN];
13799 #ifdef FEAT_MBYTE
13800 if (has_mbyte)
13801 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13802 else
13803 #endif
13805 buf[0] = (char_u)get_tv_number(&argvars[0]);
13806 buf[1] = NUL;
13808 rettv->v_type = VAR_STRING;
13809 rettv->vval.v_string = vim_strsave(buf);
13813 * "pathshorten()" function
13815 static void
13816 f_pathshorten(argvars, rettv)
13817 typval_T *argvars;
13818 typval_T *rettv;
13820 char_u *p;
13822 rettv->v_type = VAR_STRING;
13823 p = get_tv_string_chk(&argvars[0]);
13824 if (p == NULL)
13825 rettv->vval.v_string = NULL;
13826 else
13828 p = vim_strsave(p);
13829 rettv->vval.v_string = p;
13830 if (p != NULL)
13831 shorten_dir(p);
13835 #ifdef FEAT_FLOAT
13837 * "pow()" function
13839 static void
13840 f_pow(argvars, rettv)
13841 typval_T *argvars;
13842 typval_T *rettv;
13844 float_T fx, fy;
13846 rettv->v_type = VAR_FLOAT;
13847 if (get_float_arg(argvars, &fx) == OK
13848 && get_float_arg(&argvars[1], &fy) == OK)
13849 rettv->vval.v_float = pow(fx, fy);
13850 else
13851 rettv->vval.v_float = 0.0;
13853 #endif
13856 * "prevnonblank()" function
13858 static void
13859 f_prevnonblank(argvars, rettv)
13860 typval_T *argvars;
13861 typval_T *rettv;
13863 linenr_T lnum;
13865 lnum = get_tv_lnum(argvars);
13866 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13867 lnum = 0;
13868 else
13869 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13870 --lnum;
13871 rettv->vval.v_number = lnum;
13874 #ifdef HAVE_STDARG_H
13875 /* This dummy va_list is here because:
13876 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13877 * - locally in the function results in a "used before set" warning
13878 * - using va_start() to initialize it gives "function with fixed args" error */
13879 static va_list ap;
13880 #endif
13883 * "printf()" function
13885 static void
13886 f_printf(argvars, rettv)
13887 typval_T *argvars;
13888 typval_T *rettv;
13890 rettv->v_type = VAR_STRING;
13891 rettv->vval.v_string = NULL;
13892 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13894 char_u buf[NUMBUFLEN];
13895 int len;
13896 char_u *s;
13897 int saved_did_emsg = did_emsg;
13898 char *fmt;
13900 /* Get the required length, allocate the buffer and do it for real. */
13901 did_emsg = FALSE;
13902 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13903 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13904 if (!did_emsg)
13906 s = alloc(len + 1);
13907 if (s != NULL)
13909 rettv->vval.v_string = s;
13910 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13913 did_emsg |= saved_did_emsg;
13915 #endif
13919 * "pumvisible()" function
13921 /*ARGSUSED*/
13922 static void
13923 f_pumvisible(argvars, rettv)
13924 typval_T *argvars;
13925 typval_T *rettv;
13927 rettv->vval.v_number = 0;
13928 #ifdef FEAT_INS_EXPAND
13929 if (pum_visible())
13930 rettv->vval.v_number = 1;
13931 #endif
13935 * "range()" function
13937 static void
13938 f_range(argvars, rettv)
13939 typval_T *argvars;
13940 typval_T *rettv;
13942 long start;
13943 long end;
13944 long stride = 1;
13945 long i;
13946 int error = FALSE;
13948 start = get_tv_number_chk(&argvars[0], &error);
13949 if (argvars[1].v_type == VAR_UNKNOWN)
13951 end = start - 1;
13952 start = 0;
13954 else
13956 end = get_tv_number_chk(&argvars[1], &error);
13957 if (argvars[2].v_type != VAR_UNKNOWN)
13958 stride = get_tv_number_chk(&argvars[2], &error);
13961 rettv->vval.v_number = 0;
13962 if (error)
13963 return; /* type error; errmsg already given */
13964 if (stride == 0)
13965 EMSG(_("E726: Stride is zero"));
13966 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13967 EMSG(_("E727: Start past end"));
13968 else
13970 if (rettv_list_alloc(rettv) == OK)
13971 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13972 if (list_append_number(rettv->vval.v_list,
13973 (varnumber_T)i) == FAIL)
13974 break;
13979 * "readfile()" function
13981 static void
13982 f_readfile(argvars, rettv)
13983 typval_T *argvars;
13984 typval_T *rettv;
13986 int binary = FALSE;
13987 char_u *fname;
13988 FILE *fd;
13989 listitem_T *li;
13990 #define FREAD_SIZE 200 /* optimized for text lines */
13991 char_u buf[FREAD_SIZE];
13992 int readlen; /* size of last fread() */
13993 int buflen; /* nr of valid chars in buf[] */
13994 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13995 int tolist; /* first byte in buf[] still to be put in list */
13996 int chop; /* how many CR to chop off */
13997 char_u *prev = NULL; /* previously read bytes, if any */
13998 int prevlen = 0; /* length of "prev" if not NULL */
13999 char_u *s;
14000 int len;
14001 long maxline = MAXLNUM;
14002 long cnt = 0;
14004 if (argvars[1].v_type != VAR_UNKNOWN)
14006 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
14007 binary = TRUE;
14008 if (argvars[2].v_type != VAR_UNKNOWN)
14009 maxline = get_tv_number(&argvars[2]);
14012 if (rettv_list_alloc(rettv) == FAIL)
14013 return;
14015 /* Always open the file in binary mode, library functions have a mind of
14016 * their own about CR-LF conversion. */
14017 fname = get_tv_string(&argvars[0]);
14018 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
14020 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
14021 return;
14024 filtd = 0;
14025 while (cnt < maxline || maxline < 0)
14027 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
14028 buflen = filtd + readlen;
14029 tolist = 0;
14030 for ( ; filtd < buflen || readlen <= 0; ++filtd)
14032 if (buf[filtd] == '\n' || readlen <= 0)
14034 /* Only when in binary mode add an empty list item when the
14035 * last line ends in a '\n'. */
14036 if (!binary && readlen == 0 && filtd == 0)
14037 break;
14039 /* Found end-of-line or end-of-file: add a text line to the
14040 * list. */
14041 chop = 0;
14042 if (!binary)
14043 while (filtd - chop - 1 >= tolist
14044 && buf[filtd - chop - 1] == '\r')
14045 ++chop;
14046 len = filtd - tolist - chop;
14047 if (prev == NULL)
14048 s = vim_strnsave(buf + tolist, len);
14049 else
14051 s = alloc((unsigned)(prevlen + len + 1));
14052 if (s != NULL)
14054 mch_memmove(s, prev, prevlen);
14055 vim_free(prev);
14056 prev = NULL;
14057 mch_memmove(s + prevlen, buf + tolist, len);
14058 s[prevlen + len] = NUL;
14061 tolist = filtd + 1;
14063 li = listitem_alloc();
14064 if (li == NULL)
14066 vim_free(s);
14067 break;
14069 li->li_tv.v_type = VAR_STRING;
14070 li->li_tv.v_lock = 0;
14071 li->li_tv.vval.v_string = s;
14072 list_append(rettv->vval.v_list, li);
14074 if (++cnt >= maxline && maxline >= 0)
14075 break;
14076 if (readlen <= 0)
14077 break;
14079 else if (buf[filtd] == NUL)
14080 buf[filtd] = '\n';
14082 if (readlen <= 0)
14083 break;
14085 if (tolist == 0)
14087 /* "buf" is full, need to move text to an allocated buffer */
14088 if (prev == NULL)
14090 prev = vim_strnsave(buf, buflen);
14091 prevlen = buflen;
14093 else
14095 s = alloc((unsigned)(prevlen + buflen));
14096 if (s != NULL)
14098 mch_memmove(s, prev, prevlen);
14099 mch_memmove(s + prevlen, buf, buflen);
14100 vim_free(prev);
14101 prev = s;
14102 prevlen += buflen;
14105 filtd = 0;
14107 else
14109 mch_memmove(buf, buf + tolist, buflen - tolist);
14110 filtd -= tolist;
14115 * For a negative line count use only the lines at the end of the file,
14116 * free the rest.
14118 if (maxline < 0)
14119 while (cnt > -maxline)
14121 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
14122 --cnt;
14125 vim_free(prev);
14126 fclose(fd);
14129 #if defined(FEAT_RELTIME)
14130 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
14133 * Convert a List to proftime_T.
14134 * Return FAIL when there is something wrong.
14136 static int
14137 list2proftime(arg, tm)
14138 typval_T *arg;
14139 proftime_T *tm;
14141 long n1, n2;
14142 int error = FALSE;
14144 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
14145 || arg->vval.v_list->lv_len != 2)
14146 return FAIL;
14147 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14148 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14149 # ifdef WIN3264
14150 tm->HighPart = n1;
14151 tm->LowPart = n2;
14152 # else
14153 tm->tv_sec = n1;
14154 tm->tv_usec = n2;
14155 # endif
14156 return error ? FAIL : OK;
14158 #endif /* FEAT_RELTIME */
14161 * "reltime()" function
14163 static void
14164 f_reltime(argvars, rettv)
14165 typval_T *argvars;
14166 typval_T *rettv;
14168 #ifdef FEAT_RELTIME
14169 proftime_T res;
14170 proftime_T start;
14172 if (argvars[0].v_type == VAR_UNKNOWN)
14174 /* No arguments: get current time. */
14175 profile_start(&res);
14177 else if (argvars[1].v_type == VAR_UNKNOWN)
14179 if (list2proftime(&argvars[0], &res) == FAIL)
14180 return;
14181 profile_end(&res);
14183 else
14185 /* Two arguments: compute the difference. */
14186 if (list2proftime(&argvars[0], &start) == FAIL
14187 || list2proftime(&argvars[1], &res) == FAIL)
14188 return;
14189 profile_sub(&res, &start);
14192 if (rettv_list_alloc(rettv) == OK)
14194 long n1, n2;
14196 # ifdef WIN3264
14197 n1 = res.HighPart;
14198 n2 = res.LowPart;
14199 # else
14200 n1 = res.tv_sec;
14201 n2 = res.tv_usec;
14202 # endif
14203 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14204 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14206 #endif
14210 * "reltimestr()" function
14212 static void
14213 f_reltimestr(argvars, rettv)
14214 typval_T *argvars;
14215 typval_T *rettv;
14217 #ifdef FEAT_RELTIME
14218 proftime_T tm;
14219 #endif
14221 rettv->v_type = VAR_STRING;
14222 rettv->vval.v_string = NULL;
14223 #ifdef FEAT_RELTIME
14224 if (list2proftime(&argvars[0], &tm) == OK)
14225 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14226 #endif
14229 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14230 static void make_connection __ARGS((void));
14231 static int check_connection __ARGS((void));
14233 static void
14234 make_connection()
14236 if (X_DISPLAY == NULL
14237 # ifdef FEAT_GUI
14238 && !gui.in_use
14239 # endif
14242 x_force_connect = TRUE;
14243 setup_term_clip();
14244 x_force_connect = FALSE;
14248 static int
14249 check_connection()
14251 make_connection();
14252 if (X_DISPLAY == NULL)
14254 EMSG(_("E240: No connection to Vim server"));
14255 return FAIL;
14257 return OK;
14259 #endif
14261 #ifdef FEAT_CLIENTSERVER
14262 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14264 static void
14265 remote_common(argvars, rettv, expr)
14266 typval_T *argvars;
14267 typval_T *rettv;
14268 int expr;
14270 char_u *server_name;
14271 char_u *keys;
14272 char_u *r = NULL;
14273 char_u buf[NUMBUFLEN];
14274 # ifdef WIN32
14275 HWND w;
14276 # else
14277 Window w;
14278 # endif
14280 if (check_restricted() || check_secure())
14281 return;
14283 # ifdef FEAT_X11
14284 if (check_connection() == FAIL)
14285 return;
14286 # endif
14288 server_name = get_tv_string_chk(&argvars[0]);
14289 if (server_name == NULL)
14290 return; /* type error; errmsg already given */
14291 keys = get_tv_string_buf(&argvars[1], buf);
14292 # ifdef WIN32
14293 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14294 # else
14295 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14296 < 0)
14297 # endif
14299 if (r != NULL)
14300 EMSG(r); /* sending worked but evaluation failed */
14301 else
14302 EMSG2(_("E241: Unable to send to %s"), server_name);
14303 return;
14306 rettv->vval.v_string = r;
14308 if (argvars[2].v_type != VAR_UNKNOWN)
14310 dictitem_T v;
14311 char_u str[30];
14312 char_u *idvar;
14314 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14315 v.di_tv.v_type = VAR_STRING;
14316 v.di_tv.vval.v_string = vim_strsave(str);
14317 idvar = get_tv_string_chk(&argvars[2]);
14318 if (idvar != NULL)
14319 set_var(idvar, &v.di_tv, FALSE);
14320 vim_free(v.di_tv.vval.v_string);
14323 #endif
14326 * "remote_expr()" function
14328 /*ARGSUSED*/
14329 static void
14330 f_remote_expr(argvars, rettv)
14331 typval_T *argvars;
14332 typval_T *rettv;
14334 rettv->v_type = VAR_STRING;
14335 rettv->vval.v_string = NULL;
14336 #ifdef FEAT_CLIENTSERVER
14337 remote_common(argvars, rettv, TRUE);
14338 #endif
14342 * "remote_foreground()" function
14344 /*ARGSUSED*/
14345 static void
14346 f_remote_foreground(argvars, rettv)
14347 typval_T *argvars;
14348 typval_T *rettv;
14350 rettv->vval.v_number = 0;
14351 #ifdef FEAT_CLIENTSERVER
14352 # ifdef WIN32
14353 /* On Win32 it's done in this application. */
14355 char_u *server_name = get_tv_string_chk(&argvars[0]);
14357 if (server_name != NULL)
14358 serverForeground(server_name);
14360 # else
14361 /* Send a foreground() expression to the server. */
14362 argvars[1].v_type = VAR_STRING;
14363 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14364 argvars[2].v_type = VAR_UNKNOWN;
14365 remote_common(argvars, rettv, TRUE);
14366 vim_free(argvars[1].vval.v_string);
14367 # endif
14368 #endif
14371 /*ARGSUSED*/
14372 static void
14373 f_remote_peek(argvars, rettv)
14374 typval_T *argvars;
14375 typval_T *rettv;
14377 #ifdef FEAT_CLIENTSERVER
14378 dictitem_T v;
14379 char_u *s = NULL;
14380 # ifdef WIN32
14381 long_u n = 0;
14382 # endif
14383 char_u *serverid;
14385 if (check_restricted() || check_secure())
14387 rettv->vval.v_number = -1;
14388 return;
14390 serverid = get_tv_string_chk(&argvars[0]);
14391 if (serverid == NULL)
14393 rettv->vval.v_number = -1;
14394 return; /* type error; errmsg already given */
14396 # ifdef WIN32
14397 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14398 if (n == 0)
14399 rettv->vval.v_number = -1;
14400 else
14402 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14403 rettv->vval.v_number = (s != NULL);
14405 # else
14406 rettv->vval.v_number = 0;
14407 if (check_connection() == FAIL)
14408 return;
14410 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14411 serverStrToWin(serverid), &s);
14412 # endif
14414 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14416 char_u *retvar;
14418 v.di_tv.v_type = VAR_STRING;
14419 v.di_tv.vval.v_string = vim_strsave(s);
14420 retvar = get_tv_string_chk(&argvars[1]);
14421 if (retvar != NULL)
14422 set_var(retvar, &v.di_tv, FALSE);
14423 vim_free(v.di_tv.vval.v_string);
14425 #else
14426 rettv->vval.v_number = -1;
14427 #endif
14430 /*ARGSUSED*/
14431 static void
14432 f_remote_read(argvars, rettv)
14433 typval_T *argvars;
14434 typval_T *rettv;
14436 char_u *r = NULL;
14438 #ifdef FEAT_CLIENTSERVER
14439 char_u *serverid = get_tv_string_chk(&argvars[0]);
14441 if (serverid != NULL && !check_restricted() && !check_secure())
14443 # ifdef WIN32
14444 /* The server's HWND is encoded in the 'id' parameter */
14445 long_u n = 0;
14447 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14448 if (n != 0)
14449 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14450 if (r == NULL)
14451 # else
14452 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14453 serverStrToWin(serverid), &r, FALSE) < 0)
14454 # endif
14455 EMSG(_("E277: Unable to read a server reply"));
14457 #endif
14458 rettv->v_type = VAR_STRING;
14459 rettv->vval.v_string = r;
14463 * "remote_send()" function
14465 /*ARGSUSED*/
14466 static void
14467 f_remote_send(argvars, rettv)
14468 typval_T *argvars;
14469 typval_T *rettv;
14471 rettv->v_type = VAR_STRING;
14472 rettv->vval.v_string = NULL;
14473 #ifdef FEAT_CLIENTSERVER
14474 remote_common(argvars, rettv, FALSE);
14475 #endif
14479 * "remove()" function
14481 static void
14482 f_remove(argvars, rettv)
14483 typval_T *argvars;
14484 typval_T *rettv;
14486 list_T *l;
14487 listitem_T *item, *item2;
14488 listitem_T *li;
14489 long idx;
14490 long end;
14491 char_u *key;
14492 dict_T *d;
14493 dictitem_T *di;
14495 rettv->vval.v_number = 0;
14496 if (argvars[0].v_type == VAR_DICT)
14498 if (argvars[2].v_type != VAR_UNKNOWN)
14499 EMSG2(_(e_toomanyarg), "remove()");
14500 else if ((d = argvars[0].vval.v_dict) != NULL
14501 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14503 key = get_tv_string_chk(&argvars[1]);
14504 if (key != NULL)
14506 di = dict_find(d, key, -1);
14507 if (di == NULL)
14508 EMSG2(_(e_dictkey), key);
14509 else
14511 *rettv = di->di_tv;
14512 init_tv(&di->di_tv);
14513 dictitem_remove(d, di);
14518 else if (argvars[0].v_type != VAR_LIST)
14519 EMSG2(_(e_listdictarg), "remove()");
14520 else if ((l = argvars[0].vval.v_list) != NULL
14521 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14523 int error = FALSE;
14525 idx = get_tv_number_chk(&argvars[1], &error);
14526 if (error)
14527 ; /* type error: do nothing, errmsg already given */
14528 else if ((item = list_find(l, idx)) == NULL)
14529 EMSGN(_(e_listidx), idx);
14530 else
14532 if (argvars[2].v_type == VAR_UNKNOWN)
14534 /* Remove one item, return its value. */
14535 list_remove(l, item, item);
14536 *rettv = item->li_tv;
14537 vim_free(item);
14539 else
14541 /* Remove range of items, return list with values. */
14542 end = get_tv_number_chk(&argvars[2], &error);
14543 if (error)
14544 ; /* type error: do nothing */
14545 else if ((item2 = list_find(l, end)) == NULL)
14546 EMSGN(_(e_listidx), end);
14547 else
14549 int cnt = 0;
14551 for (li = item; li != NULL; li = li->li_next)
14553 ++cnt;
14554 if (li == item2)
14555 break;
14557 if (li == NULL) /* didn't find "item2" after "item" */
14558 EMSG(_(e_invrange));
14559 else
14561 list_remove(l, item, item2);
14562 if (rettv_list_alloc(rettv) == OK)
14564 l = rettv->vval.v_list;
14565 l->lv_first = item;
14566 l->lv_last = item2;
14567 item->li_prev = NULL;
14568 item2->li_next = NULL;
14569 l->lv_len = cnt;
14579 * "rename({from}, {to})" function
14581 static void
14582 f_rename(argvars, rettv)
14583 typval_T *argvars;
14584 typval_T *rettv;
14586 char_u buf[NUMBUFLEN];
14588 if (check_restricted() || check_secure())
14589 rettv->vval.v_number = -1;
14590 else
14591 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14592 get_tv_string_buf(&argvars[1], buf));
14596 * "repeat()" function
14598 /*ARGSUSED*/
14599 static void
14600 f_repeat(argvars, rettv)
14601 typval_T *argvars;
14602 typval_T *rettv;
14604 char_u *p;
14605 int n;
14606 int slen;
14607 int len;
14608 char_u *r;
14609 int i;
14611 n = get_tv_number(&argvars[1]);
14612 if (argvars[0].v_type == VAR_LIST)
14614 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14615 while (n-- > 0)
14616 if (list_extend(rettv->vval.v_list,
14617 argvars[0].vval.v_list, NULL) == FAIL)
14618 break;
14620 else
14622 p = get_tv_string(&argvars[0]);
14623 rettv->v_type = VAR_STRING;
14624 rettv->vval.v_string = NULL;
14626 slen = (int)STRLEN(p);
14627 len = slen * n;
14628 if (len <= 0)
14629 return;
14631 r = alloc(len + 1);
14632 if (r != NULL)
14634 for (i = 0; i < n; i++)
14635 mch_memmove(r + i * slen, p, (size_t)slen);
14636 r[len] = NUL;
14639 rettv->vval.v_string = r;
14644 * "resolve()" function
14646 static void
14647 f_resolve(argvars, rettv)
14648 typval_T *argvars;
14649 typval_T *rettv;
14651 char_u *p;
14653 p = get_tv_string(&argvars[0]);
14654 #ifdef FEAT_SHORTCUT
14656 char_u *v = NULL;
14658 v = mch_resolve_shortcut(p);
14659 if (v != NULL)
14660 rettv->vval.v_string = v;
14661 else
14662 rettv->vval.v_string = vim_strsave(p);
14664 #else
14665 # ifdef HAVE_READLINK
14667 char_u buf[MAXPATHL + 1];
14668 char_u *cpy;
14669 int len;
14670 char_u *remain = NULL;
14671 char_u *q;
14672 int is_relative_to_current = FALSE;
14673 int has_trailing_pathsep = FALSE;
14674 int limit = 100;
14676 p = vim_strsave(p);
14678 if (p[0] == '.' && (vim_ispathsep(p[1])
14679 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14680 is_relative_to_current = TRUE;
14682 len = STRLEN(p);
14683 if (len > 0 && after_pathsep(p, p + len))
14684 has_trailing_pathsep = TRUE;
14686 q = getnextcomp(p);
14687 if (*q != NUL)
14689 /* Separate the first path component in "p", and keep the
14690 * remainder (beginning with the path separator). */
14691 remain = vim_strsave(q - 1);
14692 q[-1] = NUL;
14695 for (;;)
14697 for (;;)
14699 len = readlink((char *)p, (char *)buf, MAXPATHL);
14700 if (len <= 0)
14701 break;
14702 buf[len] = NUL;
14704 if (limit-- == 0)
14706 vim_free(p);
14707 vim_free(remain);
14708 EMSG(_("E655: Too many symbolic links (cycle?)"));
14709 rettv->vval.v_string = NULL;
14710 goto fail;
14713 /* Ensure that the result will have a trailing path separator
14714 * if the argument has one. */
14715 if (remain == NULL && has_trailing_pathsep)
14716 add_pathsep(buf);
14718 /* Separate the first path component in the link value and
14719 * concatenate the remainders. */
14720 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14721 if (*q != NUL)
14723 if (remain == NULL)
14724 remain = vim_strsave(q - 1);
14725 else
14727 cpy = concat_str(q - 1, remain);
14728 if (cpy != NULL)
14730 vim_free(remain);
14731 remain = cpy;
14734 q[-1] = NUL;
14737 q = gettail(p);
14738 if (q > p && *q == NUL)
14740 /* Ignore trailing path separator. */
14741 q[-1] = NUL;
14742 q = gettail(p);
14744 if (q > p && !mch_isFullName(buf))
14746 /* symlink is relative to directory of argument */
14747 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14748 if (cpy != NULL)
14750 STRCPY(cpy, p);
14751 STRCPY(gettail(cpy), buf);
14752 vim_free(p);
14753 p = cpy;
14756 else
14758 vim_free(p);
14759 p = vim_strsave(buf);
14763 if (remain == NULL)
14764 break;
14766 /* Append the first path component of "remain" to "p". */
14767 q = getnextcomp(remain + 1);
14768 len = q - remain - (*q != NUL);
14769 cpy = vim_strnsave(p, STRLEN(p) + len);
14770 if (cpy != NULL)
14772 STRNCAT(cpy, remain, len);
14773 vim_free(p);
14774 p = cpy;
14776 /* Shorten "remain". */
14777 if (*q != NUL)
14778 STRMOVE(remain, q - 1);
14779 else
14781 vim_free(remain);
14782 remain = NULL;
14786 /* If the result is a relative path name, make it explicitly relative to
14787 * the current directory if and only if the argument had this form. */
14788 if (!vim_ispathsep(*p))
14790 if (is_relative_to_current
14791 && *p != NUL
14792 && !(p[0] == '.'
14793 && (p[1] == NUL
14794 || vim_ispathsep(p[1])
14795 || (p[1] == '.'
14796 && (p[2] == NUL
14797 || vim_ispathsep(p[2]))))))
14799 /* Prepend "./". */
14800 cpy = concat_str((char_u *)"./", p);
14801 if (cpy != NULL)
14803 vim_free(p);
14804 p = cpy;
14807 else if (!is_relative_to_current)
14809 /* Strip leading "./". */
14810 q = p;
14811 while (q[0] == '.' && vim_ispathsep(q[1]))
14812 q += 2;
14813 if (q > p)
14814 STRMOVE(p, p + 2);
14818 /* Ensure that the result will have no trailing path separator
14819 * if the argument had none. But keep "/" or "//". */
14820 if (!has_trailing_pathsep)
14822 q = p + STRLEN(p);
14823 if (after_pathsep(p, q))
14824 *gettail_sep(p) = NUL;
14827 rettv->vval.v_string = p;
14829 # else
14830 rettv->vval.v_string = vim_strsave(p);
14831 # endif
14832 #endif
14834 simplify_filename(rettv->vval.v_string);
14836 #ifdef HAVE_READLINK
14837 fail:
14838 #endif
14839 rettv->v_type = VAR_STRING;
14843 * "reverse({list})" function
14845 static void
14846 f_reverse(argvars, rettv)
14847 typval_T *argvars;
14848 typval_T *rettv;
14850 list_T *l;
14851 listitem_T *li, *ni;
14853 rettv->vval.v_number = 0;
14854 if (argvars[0].v_type != VAR_LIST)
14855 EMSG2(_(e_listarg), "reverse()");
14856 else if ((l = argvars[0].vval.v_list) != NULL
14857 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14859 li = l->lv_last;
14860 l->lv_first = l->lv_last = NULL;
14861 l->lv_len = 0;
14862 while (li != NULL)
14864 ni = li->li_prev;
14865 list_append(l, li);
14866 li = ni;
14868 rettv->vval.v_list = l;
14869 rettv->v_type = VAR_LIST;
14870 ++l->lv_refcount;
14871 l->lv_idx = l->lv_len - l->lv_idx - 1;
14875 #define SP_NOMOVE 0x01 /* don't move cursor */
14876 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14877 #define SP_RETCOUNT 0x04 /* return matchcount */
14878 #define SP_SETPCMARK 0x08 /* set previous context mark */
14879 #define SP_START 0x10 /* accept match at start position */
14880 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14881 #define SP_END 0x40 /* leave cursor at end of match */
14883 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14886 * Get flags for a search function.
14887 * Possibly sets "p_ws".
14888 * Returns BACKWARD, FORWARD or zero (for an error).
14890 static int
14891 get_search_arg(varp, flagsp)
14892 typval_T *varp;
14893 int *flagsp;
14895 int dir = FORWARD;
14896 char_u *flags;
14897 char_u nbuf[NUMBUFLEN];
14898 int mask;
14900 if (varp->v_type != VAR_UNKNOWN)
14902 flags = get_tv_string_buf_chk(varp, nbuf);
14903 if (flags == NULL)
14904 return 0; /* type error; errmsg already given */
14905 while (*flags != NUL)
14907 switch (*flags)
14909 case 'b': dir = BACKWARD; break;
14910 case 'w': p_ws = TRUE; break;
14911 case 'W': p_ws = FALSE; break;
14912 default: mask = 0;
14913 if (flagsp != NULL)
14914 switch (*flags)
14916 case 'c': mask = SP_START; break;
14917 case 'e': mask = SP_END; break;
14918 case 'm': mask = SP_RETCOUNT; break;
14919 case 'n': mask = SP_NOMOVE; break;
14920 case 'p': mask = SP_SUBPAT; break;
14921 case 'r': mask = SP_REPEAT; break;
14922 case 's': mask = SP_SETPCMARK; break;
14924 if (mask == 0)
14926 EMSG2(_(e_invarg2), flags);
14927 dir = 0;
14929 else
14930 *flagsp |= mask;
14932 if (dir == 0)
14933 break;
14934 ++flags;
14937 return dir;
14941 * Shared by search() and searchpos() functions
14943 static int
14944 search_cmn(argvars, match_pos, flagsp)
14945 typval_T *argvars;
14946 pos_T *match_pos;
14947 int *flagsp;
14949 int flags;
14950 char_u *pat;
14951 pos_T pos;
14952 pos_T save_cursor;
14953 int save_p_ws = p_ws;
14954 int dir;
14955 int retval = 0; /* default: FAIL */
14956 long lnum_stop = 0;
14957 proftime_T tm;
14958 #ifdef FEAT_RELTIME
14959 long time_limit = 0;
14960 #endif
14961 int options = SEARCH_KEEP;
14962 int subpatnum;
14964 pat = get_tv_string(&argvars[0]);
14965 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14966 if (dir == 0)
14967 goto theend;
14968 flags = *flagsp;
14969 if (flags & SP_START)
14970 options |= SEARCH_START;
14971 if (flags & SP_END)
14972 options |= SEARCH_END;
14974 /* Optional arguments: line number to stop searching and timeout. */
14975 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14977 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14978 if (lnum_stop < 0)
14979 goto theend;
14980 #ifdef FEAT_RELTIME
14981 if (argvars[3].v_type != VAR_UNKNOWN)
14983 time_limit = get_tv_number_chk(&argvars[3], NULL);
14984 if (time_limit < 0)
14985 goto theend;
14987 #endif
14990 #ifdef FEAT_RELTIME
14991 /* Set the time limit, if there is one. */
14992 profile_setlimit(time_limit, &tm);
14993 #endif
14996 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14997 * Check to make sure only those flags are set.
14998 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14999 * flags cannot be set. Check for that condition also.
15001 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
15002 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15004 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
15005 goto theend;
15008 pos = save_cursor = curwin->w_cursor;
15009 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15010 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
15011 if (subpatnum != FAIL)
15013 if (flags & SP_SUBPAT)
15014 retval = subpatnum;
15015 else
15016 retval = pos.lnum;
15017 if (flags & SP_SETPCMARK)
15018 setpcmark();
15019 curwin->w_cursor = pos;
15020 if (match_pos != NULL)
15022 /* Store the match cursor position */
15023 match_pos->lnum = pos.lnum;
15024 match_pos->col = pos.col + 1;
15026 /* "/$" will put the cursor after the end of the line, may need to
15027 * correct that here */
15028 check_cursor();
15031 /* If 'n' flag is used: restore cursor position. */
15032 if (flags & SP_NOMOVE)
15033 curwin->w_cursor = save_cursor;
15034 else
15035 curwin->w_set_curswant = TRUE;
15036 theend:
15037 p_ws = save_p_ws;
15039 return retval;
15042 #ifdef FEAT_FLOAT
15044 * "round({float})" function
15046 static void
15047 f_round(argvars, rettv)
15048 typval_T *argvars;
15049 typval_T *rettv;
15051 float_T f;
15053 rettv->v_type = VAR_FLOAT;
15054 if (get_float_arg(argvars, &f) == OK)
15055 /* round() is not in C90, use ceil() or floor() instead. */
15056 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
15057 else
15058 rettv->vval.v_float = 0.0;
15060 #endif
15063 * "search()" function
15065 static void
15066 f_search(argvars, rettv)
15067 typval_T *argvars;
15068 typval_T *rettv;
15070 int flags = 0;
15072 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
15076 * "searchdecl()" function
15078 static void
15079 f_searchdecl(argvars, rettv)
15080 typval_T *argvars;
15081 typval_T *rettv;
15083 int locally = 1;
15084 int thisblock = 0;
15085 int error = FALSE;
15086 char_u *name;
15088 rettv->vval.v_number = 1; /* default: FAIL */
15090 name = get_tv_string_chk(&argvars[0]);
15091 if (argvars[1].v_type != VAR_UNKNOWN)
15093 locally = get_tv_number_chk(&argvars[1], &error) == 0;
15094 if (!error && argvars[2].v_type != VAR_UNKNOWN)
15095 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
15097 if (!error && name != NULL)
15098 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
15099 locally, thisblock, SEARCH_KEEP) == FAIL;
15103 * Used by searchpair() and searchpairpos()
15105 static int
15106 searchpair_cmn(argvars, match_pos)
15107 typval_T *argvars;
15108 pos_T *match_pos;
15110 char_u *spat, *mpat, *epat;
15111 char_u *skip;
15112 int save_p_ws = p_ws;
15113 int dir;
15114 int flags = 0;
15115 char_u nbuf1[NUMBUFLEN];
15116 char_u nbuf2[NUMBUFLEN];
15117 char_u nbuf3[NUMBUFLEN];
15118 int retval = 0; /* default: FAIL */
15119 long lnum_stop = 0;
15120 long time_limit = 0;
15122 /* Get the three pattern arguments: start, middle, end. */
15123 spat = get_tv_string_chk(&argvars[0]);
15124 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
15125 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
15126 if (spat == NULL || mpat == NULL || epat == NULL)
15127 goto theend; /* type error */
15129 /* Handle the optional fourth argument: flags */
15130 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
15131 if (dir == 0)
15132 goto theend;
15134 /* Don't accept SP_END or SP_SUBPAT.
15135 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
15137 if ((flags & (SP_END | SP_SUBPAT)) != 0
15138 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15140 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
15141 goto theend;
15144 /* Using 'r' implies 'W', otherwise it doesn't work. */
15145 if (flags & SP_REPEAT)
15146 p_ws = FALSE;
15148 /* Optional fifth argument: skip expression */
15149 if (argvars[3].v_type == VAR_UNKNOWN
15150 || argvars[4].v_type == VAR_UNKNOWN)
15151 skip = (char_u *)"";
15152 else
15154 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15155 if (argvars[5].v_type != VAR_UNKNOWN)
15157 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15158 if (lnum_stop < 0)
15159 goto theend;
15160 #ifdef FEAT_RELTIME
15161 if (argvars[6].v_type != VAR_UNKNOWN)
15163 time_limit = get_tv_number_chk(&argvars[6], NULL);
15164 if (time_limit < 0)
15165 goto theend;
15167 #endif
15170 if (skip == NULL)
15171 goto theend; /* type error */
15173 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15174 match_pos, lnum_stop, time_limit);
15176 theend:
15177 p_ws = save_p_ws;
15179 return retval;
15183 * "searchpair()" function
15185 static void
15186 f_searchpair(argvars, rettv)
15187 typval_T *argvars;
15188 typval_T *rettv;
15190 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15194 * "searchpairpos()" function
15196 static void
15197 f_searchpairpos(argvars, rettv)
15198 typval_T *argvars;
15199 typval_T *rettv;
15201 pos_T match_pos;
15202 int lnum = 0;
15203 int col = 0;
15205 rettv->vval.v_number = 0;
15207 if (rettv_list_alloc(rettv) == FAIL)
15208 return;
15210 if (searchpair_cmn(argvars, &match_pos) > 0)
15212 lnum = match_pos.lnum;
15213 col = match_pos.col;
15216 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15217 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15221 * Search for a start/middle/end thing.
15222 * Used by searchpair(), see its documentation for the details.
15223 * Returns 0 or -1 for no match,
15225 long
15226 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15227 lnum_stop, time_limit)
15228 char_u *spat; /* start pattern */
15229 char_u *mpat; /* middle pattern */
15230 char_u *epat; /* end pattern */
15231 int dir; /* BACKWARD or FORWARD */
15232 char_u *skip; /* skip expression */
15233 int flags; /* SP_SETPCMARK and other SP_ values */
15234 pos_T *match_pos;
15235 linenr_T lnum_stop; /* stop at this line if not zero */
15236 long time_limit; /* stop after this many msec */
15238 char_u *save_cpo;
15239 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15240 long retval = 0;
15241 pos_T pos;
15242 pos_T firstpos;
15243 pos_T foundpos;
15244 pos_T save_cursor;
15245 pos_T save_pos;
15246 int n;
15247 int r;
15248 int nest = 1;
15249 int err;
15250 int options = SEARCH_KEEP;
15251 proftime_T tm;
15253 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15254 save_cpo = p_cpo;
15255 p_cpo = empty_option;
15257 #ifdef FEAT_RELTIME
15258 /* Set the time limit, if there is one. */
15259 profile_setlimit(time_limit, &tm);
15260 #endif
15262 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15263 * start/middle/end (pat3, for the top pair). */
15264 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15265 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15266 if (pat2 == NULL || pat3 == NULL)
15267 goto theend;
15268 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15269 if (*mpat == NUL)
15270 STRCPY(pat3, pat2);
15271 else
15272 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15273 spat, epat, mpat);
15274 if (flags & SP_START)
15275 options |= SEARCH_START;
15277 save_cursor = curwin->w_cursor;
15278 pos = curwin->w_cursor;
15279 clearpos(&firstpos);
15280 clearpos(&foundpos);
15281 pat = pat3;
15282 for (;;)
15284 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15285 options, RE_SEARCH, lnum_stop, &tm);
15286 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15287 /* didn't find it or found the first match again: FAIL */
15288 break;
15290 if (firstpos.lnum == 0)
15291 firstpos = pos;
15292 if (equalpos(pos, foundpos))
15294 /* Found the same position again. Can happen with a pattern that
15295 * has "\zs" at the end and searching backwards. Advance one
15296 * character and try again. */
15297 if (dir == BACKWARD)
15298 decl(&pos);
15299 else
15300 incl(&pos);
15302 foundpos = pos;
15304 /* clear the start flag to avoid getting stuck here */
15305 options &= ~SEARCH_START;
15307 /* If the skip pattern matches, ignore this match. */
15308 if (*skip != NUL)
15310 save_pos = curwin->w_cursor;
15311 curwin->w_cursor = pos;
15312 r = eval_to_bool(skip, &err, NULL, FALSE);
15313 curwin->w_cursor = save_pos;
15314 if (err)
15316 /* Evaluating {skip} caused an error, break here. */
15317 curwin->w_cursor = save_cursor;
15318 retval = -1;
15319 break;
15321 if (r)
15322 continue;
15325 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15327 /* Found end when searching backwards or start when searching
15328 * forward: nested pair. */
15329 ++nest;
15330 pat = pat2; /* nested, don't search for middle */
15332 else
15334 /* Found end when searching forward or start when searching
15335 * backward: end of (nested) pair; or found middle in outer pair. */
15336 if (--nest == 1)
15337 pat = pat3; /* outer level, search for middle */
15340 if (nest == 0)
15342 /* Found the match: return matchcount or line number. */
15343 if (flags & SP_RETCOUNT)
15344 ++retval;
15345 else
15346 retval = pos.lnum;
15347 if (flags & SP_SETPCMARK)
15348 setpcmark();
15349 curwin->w_cursor = pos;
15350 if (!(flags & SP_REPEAT))
15351 break;
15352 nest = 1; /* search for next unmatched */
15356 if (match_pos != NULL)
15358 /* Store the match cursor position */
15359 match_pos->lnum = curwin->w_cursor.lnum;
15360 match_pos->col = curwin->w_cursor.col + 1;
15363 /* If 'n' flag is used or search failed: restore cursor position. */
15364 if ((flags & SP_NOMOVE) || retval == 0)
15365 curwin->w_cursor = save_cursor;
15367 theend:
15368 vim_free(pat2);
15369 vim_free(pat3);
15370 if (p_cpo == empty_option)
15371 p_cpo = save_cpo;
15372 else
15373 /* Darn, evaluating the {skip} expression changed the value. */
15374 free_string_option(save_cpo);
15376 return retval;
15380 * "searchpos()" function
15382 static void
15383 f_searchpos(argvars, rettv)
15384 typval_T *argvars;
15385 typval_T *rettv;
15387 pos_T match_pos;
15388 int lnum = 0;
15389 int col = 0;
15390 int n;
15391 int flags = 0;
15393 rettv->vval.v_number = 0;
15395 if (rettv_list_alloc(rettv) == FAIL)
15396 return;
15398 n = search_cmn(argvars, &match_pos, &flags);
15399 if (n > 0)
15401 lnum = match_pos.lnum;
15402 col = match_pos.col;
15405 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15406 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15407 if (flags & SP_SUBPAT)
15408 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15412 /*ARGSUSED*/
15413 static void
15414 f_server2client(argvars, rettv)
15415 typval_T *argvars;
15416 typval_T *rettv;
15418 #ifdef FEAT_CLIENTSERVER
15419 char_u buf[NUMBUFLEN];
15420 char_u *server = get_tv_string_chk(&argvars[0]);
15421 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15423 rettv->vval.v_number = -1;
15424 if (server == NULL || reply == NULL)
15425 return;
15426 if (check_restricted() || check_secure())
15427 return;
15428 # ifdef FEAT_X11
15429 if (check_connection() == FAIL)
15430 return;
15431 # endif
15433 if (serverSendReply(server, reply) < 0)
15435 EMSG(_("E258: Unable to send to client"));
15436 return;
15438 rettv->vval.v_number = 0;
15439 #else
15440 rettv->vval.v_number = -1;
15441 #endif
15444 /*ARGSUSED*/
15445 static void
15446 f_serverlist(argvars, rettv)
15447 typval_T *argvars;
15448 typval_T *rettv;
15450 char_u *r = NULL;
15452 #ifdef FEAT_CLIENTSERVER
15453 # ifdef WIN32
15454 r = serverGetVimNames();
15455 # else
15456 make_connection();
15457 if (X_DISPLAY != NULL)
15458 r = serverGetVimNames(X_DISPLAY);
15459 # endif
15460 #endif
15461 rettv->v_type = VAR_STRING;
15462 rettv->vval.v_string = r;
15466 * "setbufvar()" function
15468 /*ARGSUSED*/
15469 static void
15470 f_setbufvar(argvars, rettv)
15471 typval_T *argvars;
15472 typval_T *rettv;
15474 buf_T *buf;
15475 aco_save_T aco;
15476 char_u *varname, *bufvarname;
15477 typval_T *varp;
15478 char_u nbuf[NUMBUFLEN];
15480 rettv->vval.v_number = 0;
15482 if (check_restricted() || check_secure())
15483 return;
15484 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15485 varname = get_tv_string_chk(&argvars[1]);
15486 buf = get_buf_tv(&argvars[0]);
15487 varp = &argvars[2];
15489 if (buf != NULL && varname != NULL && varp != NULL)
15491 /* set curbuf to be our buf, temporarily */
15492 aucmd_prepbuf(&aco, buf);
15494 if (*varname == '&')
15496 long numval;
15497 char_u *strval;
15498 int error = FALSE;
15500 ++varname;
15501 numval = get_tv_number_chk(varp, &error);
15502 strval = get_tv_string_buf_chk(varp, nbuf);
15503 if (!error && strval != NULL)
15504 set_option_value(varname, numval, strval, OPT_LOCAL);
15506 else
15508 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15509 if (bufvarname != NULL)
15511 STRCPY(bufvarname, "b:");
15512 STRCPY(bufvarname + 2, varname);
15513 set_var(bufvarname, varp, TRUE);
15514 vim_free(bufvarname);
15518 /* reset notion of buffer */
15519 aucmd_restbuf(&aco);
15524 * "setcmdpos()" function
15526 static void
15527 f_setcmdpos(argvars, rettv)
15528 typval_T *argvars;
15529 typval_T *rettv;
15531 int pos = (int)get_tv_number(&argvars[0]) - 1;
15533 if (pos >= 0)
15534 rettv->vval.v_number = set_cmdline_pos(pos);
15538 * "setline()" function
15540 static void
15541 f_setline(argvars, rettv)
15542 typval_T *argvars;
15543 typval_T *rettv;
15545 linenr_T lnum;
15546 char_u *line = NULL;
15547 list_T *l = NULL;
15548 listitem_T *li = NULL;
15549 long added = 0;
15550 linenr_T lcount = curbuf->b_ml.ml_line_count;
15552 lnum = get_tv_lnum(&argvars[0]);
15553 if (argvars[1].v_type == VAR_LIST)
15555 l = argvars[1].vval.v_list;
15556 li = l->lv_first;
15558 else
15559 line = get_tv_string_chk(&argvars[1]);
15561 rettv->vval.v_number = 0; /* OK */
15562 for (;;)
15564 if (l != NULL)
15566 /* list argument, get next string */
15567 if (li == NULL)
15568 break;
15569 line = get_tv_string_chk(&li->li_tv);
15570 li = li->li_next;
15573 rettv->vval.v_number = 1; /* FAIL */
15574 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15575 break;
15576 if (lnum <= curbuf->b_ml.ml_line_count)
15578 /* existing line, replace it */
15579 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15581 changed_bytes(lnum, 0);
15582 if (lnum == curwin->w_cursor.lnum)
15583 check_cursor_col();
15584 rettv->vval.v_number = 0; /* OK */
15587 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15589 /* lnum is one past the last line, append the line */
15590 ++added;
15591 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15592 rettv->vval.v_number = 0; /* OK */
15595 if (l == NULL) /* only one string argument */
15596 break;
15597 ++lnum;
15600 if (added > 0)
15601 appended_lines_mark(lcount, added);
15604 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15607 * Used by "setqflist()" and "setloclist()" functions
15609 /*ARGSUSED*/
15610 static void
15611 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15612 win_T *wp;
15613 typval_T *list_arg;
15614 typval_T *action_arg;
15615 typval_T *rettv;
15617 #ifdef FEAT_QUICKFIX
15618 char_u *act;
15619 int action = ' ';
15620 #endif
15622 rettv->vval.v_number = -1;
15624 #ifdef FEAT_QUICKFIX
15625 if (list_arg->v_type != VAR_LIST)
15626 EMSG(_(e_listreq));
15627 else
15629 list_T *l = list_arg->vval.v_list;
15631 if (action_arg->v_type == VAR_STRING)
15633 act = get_tv_string_chk(action_arg);
15634 if (act == NULL)
15635 return; /* type error; errmsg already given */
15636 if (*act == 'a' || *act == 'r')
15637 action = *act;
15640 if (l != NULL && set_errorlist(wp, l, action) == OK)
15641 rettv->vval.v_number = 0;
15643 #endif
15647 * "setloclist()" function
15649 /*ARGSUSED*/
15650 static void
15651 f_setloclist(argvars, rettv)
15652 typval_T *argvars;
15653 typval_T *rettv;
15655 win_T *win;
15657 rettv->vval.v_number = -1;
15659 win = find_win_by_nr(&argvars[0], NULL);
15660 if (win != NULL)
15661 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15665 * "setmatches()" function
15667 static void
15668 f_setmatches(argvars, rettv)
15669 typval_T *argvars;
15670 typval_T *rettv;
15672 #ifdef FEAT_SEARCH_EXTRA
15673 list_T *l;
15674 listitem_T *li;
15675 dict_T *d;
15677 rettv->vval.v_number = -1;
15678 if (argvars[0].v_type != VAR_LIST)
15680 EMSG(_(e_listreq));
15681 return;
15683 if ((l = argvars[0].vval.v_list) != NULL)
15686 /* To some extent make sure that we are dealing with a list from
15687 * "getmatches()". */
15688 li = l->lv_first;
15689 while (li != NULL)
15691 if (li->li_tv.v_type != VAR_DICT
15692 || (d = li->li_tv.vval.v_dict) == NULL)
15694 EMSG(_(e_invarg));
15695 return;
15697 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15698 && dict_find(d, (char_u *)"pattern", -1) != NULL
15699 && dict_find(d, (char_u *)"priority", -1) != NULL
15700 && dict_find(d, (char_u *)"id", -1) != NULL))
15702 EMSG(_(e_invarg));
15703 return;
15705 li = li->li_next;
15708 clear_matches(curwin);
15709 li = l->lv_first;
15710 while (li != NULL)
15712 d = li->li_tv.vval.v_dict;
15713 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15714 get_dict_string(d, (char_u *)"pattern", FALSE),
15715 (int)get_dict_number(d, (char_u *)"priority"),
15716 (int)get_dict_number(d, (char_u *)"id"));
15717 li = li->li_next;
15719 rettv->vval.v_number = 0;
15721 #endif
15725 * "setpos()" function
15727 /*ARGSUSED*/
15728 static void
15729 f_setpos(argvars, rettv)
15730 typval_T *argvars;
15731 typval_T *rettv;
15733 pos_T pos;
15734 int fnum;
15735 char_u *name;
15737 rettv->vval.v_number = -1;
15738 name = get_tv_string_chk(argvars);
15739 if (name != NULL)
15741 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15743 --pos.col;
15744 if (name[0] == '.' && name[1] == NUL)
15746 /* set cursor */
15747 if (fnum == curbuf->b_fnum)
15749 curwin->w_cursor = pos;
15750 check_cursor();
15751 rettv->vval.v_number = 0;
15753 else
15754 EMSG(_(e_invarg));
15756 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15758 /* set mark */
15759 if (setmark_pos(name[1], &pos, fnum) == OK)
15760 rettv->vval.v_number = 0;
15762 else
15763 EMSG(_(e_invarg));
15769 * "setqflist()" function
15771 /*ARGSUSED*/
15772 static void
15773 f_setqflist(argvars, rettv)
15774 typval_T *argvars;
15775 typval_T *rettv;
15777 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15781 * "setreg()" function
15783 static void
15784 f_setreg(argvars, rettv)
15785 typval_T *argvars;
15786 typval_T *rettv;
15788 int regname;
15789 char_u *strregname;
15790 char_u *stropt;
15791 char_u *strval;
15792 int append;
15793 char_u yank_type;
15794 long block_len;
15796 block_len = -1;
15797 yank_type = MAUTO;
15798 append = FALSE;
15800 strregname = get_tv_string_chk(argvars);
15801 rettv->vval.v_number = 1; /* FAIL is default */
15803 if (strregname == NULL)
15804 return; /* type error; errmsg already given */
15805 regname = *strregname;
15806 if (regname == 0 || regname == '@')
15807 regname = '"';
15808 else if (regname == '=')
15809 return;
15811 if (argvars[2].v_type != VAR_UNKNOWN)
15813 stropt = get_tv_string_chk(&argvars[2]);
15814 if (stropt == NULL)
15815 return; /* type error */
15816 for (; *stropt != NUL; ++stropt)
15817 switch (*stropt)
15819 case 'a': case 'A': /* append */
15820 append = TRUE;
15821 break;
15822 case 'v': case 'c': /* character-wise selection */
15823 yank_type = MCHAR;
15824 break;
15825 case 'V': case 'l': /* line-wise selection */
15826 yank_type = MLINE;
15827 break;
15828 #ifdef FEAT_VISUAL
15829 case 'b': case Ctrl_V: /* block-wise selection */
15830 yank_type = MBLOCK;
15831 if (VIM_ISDIGIT(stropt[1]))
15833 ++stropt;
15834 block_len = getdigits(&stropt) - 1;
15835 --stropt;
15837 break;
15838 #endif
15842 strval = get_tv_string_chk(&argvars[1]);
15843 if (strval != NULL)
15844 write_reg_contents_ex(regname, strval, -1,
15845 append, yank_type, block_len);
15846 rettv->vval.v_number = 0;
15850 * "settabwinvar()" function
15852 static void
15853 f_settabwinvar(argvars, rettv)
15854 typval_T *argvars;
15855 typval_T *rettv;
15857 setwinvar(argvars, rettv, 1);
15861 * "setwinvar()" function
15863 static void
15864 f_setwinvar(argvars, rettv)
15865 typval_T *argvars;
15866 typval_T *rettv;
15868 setwinvar(argvars, rettv, 0);
15872 * "setwinvar()" and "settabwinvar()" functions
15874 static void
15875 setwinvar(argvars, rettv, off)
15876 typval_T *argvars;
15877 typval_T *rettv;
15878 int off;
15880 win_T *win;
15881 #ifdef FEAT_WINDOWS
15882 win_T *save_curwin;
15883 tabpage_T *save_curtab;
15884 #endif
15885 char_u *varname, *winvarname;
15886 typval_T *varp;
15887 char_u nbuf[NUMBUFLEN];
15888 tabpage_T *tp;
15890 rettv->vval.v_number = 0;
15892 if (check_restricted() || check_secure())
15893 return;
15895 #ifdef FEAT_WINDOWS
15896 if (off == 1)
15897 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15898 else
15899 tp = curtab;
15900 #endif
15901 win = find_win_by_nr(&argvars[off], tp);
15902 varname = get_tv_string_chk(&argvars[off + 1]);
15903 varp = &argvars[off + 2];
15905 if (win != NULL && varname != NULL && varp != NULL)
15907 #ifdef FEAT_WINDOWS
15908 /* set curwin to be our win, temporarily */
15909 save_curwin = curwin;
15910 save_curtab = curtab;
15911 goto_tabpage_tp(tp);
15912 if (!win_valid(win))
15913 return;
15914 curwin = win;
15915 curbuf = curwin->w_buffer;
15916 #endif
15918 if (*varname == '&')
15920 long numval;
15921 char_u *strval;
15922 int error = FALSE;
15924 ++varname;
15925 numval = get_tv_number_chk(varp, &error);
15926 strval = get_tv_string_buf_chk(varp, nbuf);
15927 if (!error && strval != NULL)
15928 set_option_value(varname, numval, strval, OPT_LOCAL);
15930 else
15932 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15933 if (winvarname != NULL)
15935 STRCPY(winvarname, "w:");
15936 STRCPY(winvarname + 2, varname);
15937 set_var(winvarname, varp, TRUE);
15938 vim_free(winvarname);
15942 #ifdef FEAT_WINDOWS
15943 /* Restore current tabpage and window, if still valid (autocomands can
15944 * make them invalid). */
15945 if (valid_tabpage(save_curtab))
15946 goto_tabpage_tp(save_curtab);
15947 if (win_valid(save_curwin))
15949 curwin = save_curwin;
15950 curbuf = curwin->w_buffer;
15952 #endif
15957 * "shellescape({string})" function
15959 static void
15960 f_shellescape(argvars, rettv)
15961 typval_T *argvars;
15962 typval_T *rettv;
15964 rettv->vval.v_string = vim_strsave_shellescape(
15965 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15966 rettv->v_type = VAR_STRING;
15970 * "simplify()" function
15972 static void
15973 f_simplify(argvars, rettv)
15974 typval_T *argvars;
15975 typval_T *rettv;
15977 char_u *p;
15979 p = get_tv_string(&argvars[0]);
15980 rettv->vval.v_string = vim_strsave(p);
15981 simplify_filename(rettv->vval.v_string); /* simplify in place */
15982 rettv->v_type = VAR_STRING;
15985 #ifdef FEAT_FLOAT
15987 * "sin()" function
15989 static void
15990 f_sin(argvars, rettv)
15991 typval_T *argvars;
15992 typval_T *rettv;
15994 float_T f;
15996 rettv->v_type = VAR_FLOAT;
15997 if (get_float_arg(argvars, &f) == OK)
15998 rettv->vval.v_float = sin(f);
15999 else
16000 rettv->vval.v_float = 0.0;
16002 #endif
16004 static int
16005 #ifdef __BORLANDC__
16006 _RTLENTRYF
16007 #endif
16008 item_compare __ARGS((const void *s1, const void *s2));
16009 static int
16010 #ifdef __BORLANDC__
16011 _RTLENTRYF
16012 #endif
16013 item_compare2 __ARGS((const void *s1, const void *s2));
16015 static int item_compare_ic;
16016 static char_u *item_compare_func;
16017 static int item_compare_func_err;
16018 #define ITEM_COMPARE_FAIL 999
16021 * Compare functions for f_sort() below.
16023 static int
16024 #ifdef __BORLANDC__
16025 _RTLENTRYF
16026 #endif
16027 item_compare(s1, s2)
16028 const void *s1;
16029 const void *s2;
16031 char_u *p1, *p2;
16032 char_u *tofree1, *tofree2;
16033 int res;
16034 char_u numbuf1[NUMBUFLEN];
16035 char_u numbuf2[NUMBUFLEN];
16037 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
16038 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
16039 if (p1 == NULL)
16040 p1 = (char_u *)"";
16041 if (p2 == NULL)
16042 p2 = (char_u *)"";
16043 if (item_compare_ic)
16044 res = STRICMP(p1, p2);
16045 else
16046 res = STRCMP(p1, p2);
16047 vim_free(tofree1);
16048 vim_free(tofree2);
16049 return res;
16052 static int
16053 #ifdef __BORLANDC__
16054 _RTLENTRYF
16055 #endif
16056 item_compare2(s1, s2)
16057 const void *s1;
16058 const void *s2;
16060 int res;
16061 typval_T rettv;
16062 typval_T argv[3];
16063 int dummy;
16065 /* shortcut after failure in previous call; compare all items equal */
16066 if (item_compare_func_err)
16067 return 0;
16069 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
16070 * in the copy without changing the original list items. */
16071 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
16072 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
16074 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
16075 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
16076 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
16077 clear_tv(&argv[0]);
16078 clear_tv(&argv[1]);
16080 if (res == FAIL)
16081 res = ITEM_COMPARE_FAIL;
16082 else
16083 res = get_tv_number_chk(&rettv, &item_compare_func_err);
16084 if (item_compare_func_err)
16085 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
16086 clear_tv(&rettv);
16087 return res;
16091 * "sort({list})" function
16093 static void
16094 f_sort(argvars, rettv)
16095 typval_T *argvars;
16096 typval_T *rettv;
16098 list_T *l;
16099 listitem_T *li;
16100 listitem_T **ptrs;
16101 long len;
16102 long i;
16104 rettv->vval.v_number = 0;
16105 if (argvars[0].v_type != VAR_LIST)
16106 EMSG2(_(e_listarg), "sort()");
16107 else
16109 l = argvars[0].vval.v_list;
16110 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
16111 return;
16112 rettv->vval.v_list = l;
16113 rettv->v_type = VAR_LIST;
16114 ++l->lv_refcount;
16116 len = list_len(l);
16117 if (len <= 1)
16118 return; /* short list sorts pretty quickly */
16120 item_compare_ic = FALSE;
16121 item_compare_func = NULL;
16122 if (argvars[1].v_type != VAR_UNKNOWN)
16124 if (argvars[1].v_type == VAR_FUNC)
16125 item_compare_func = argvars[1].vval.v_string;
16126 else
16128 int error = FALSE;
16130 i = get_tv_number_chk(&argvars[1], &error);
16131 if (error)
16132 return; /* type error; errmsg already given */
16133 if (i == 1)
16134 item_compare_ic = TRUE;
16135 else
16136 item_compare_func = get_tv_string(&argvars[1]);
16140 /* Make an array with each entry pointing to an item in the List. */
16141 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
16142 if (ptrs == NULL)
16143 return;
16144 i = 0;
16145 for (li = l->lv_first; li != NULL; li = li->li_next)
16146 ptrs[i++] = li;
16148 item_compare_func_err = FALSE;
16149 /* test the compare function */
16150 if (item_compare_func != NULL
16151 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
16152 == ITEM_COMPARE_FAIL)
16153 EMSG(_("E702: Sort compare function failed"));
16154 else
16156 /* Sort the array with item pointers. */
16157 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
16158 item_compare_func == NULL ? item_compare : item_compare2);
16160 if (!item_compare_func_err)
16162 /* Clear the List and append the items in the sorted order. */
16163 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16164 l->lv_len = 0;
16165 for (i = 0; i < len; ++i)
16166 list_append(l, ptrs[i]);
16170 vim_free(ptrs);
16175 * "soundfold({word})" function
16177 static void
16178 f_soundfold(argvars, rettv)
16179 typval_T *argvars;
16180 typval_T *rettv;
16182 char_u *s;
16184 rettv->v_type = VAR_STRING;
16185 s = get_tv_string(&argvars[0]);
16186 #ifdef FEAT_SPELL
16187 rettv->vval.v_string = eval_soundfold(s);
16188 #else
16189 rettv->vval.v_string = vim_strsave(s);
16190 #endif
16194 * "spellbadword()" function
16196 /* ARGSUSED */
16197 static void
16198 f_spellbadword(argvars, rettv)
16199 typval_T *argvars;
16200 typval_T *rettv;
16202 char_u *word = (char_u *)"";
16203 hlf_T attr = HLF_COUNT;
16204 int len = 0;
16206 if (rettv_list_alloc(rettv) == FAIL)
16207 return;
16209 #ifdef FEAT_SPELL
16210 if (argvars[0].v_type == VAR_UNKNOWN)
16212 /* Find the start and length of the badly spelled word. */
16213 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16214 if (len != 0)
16215 word = ml_get_cursor();
16217 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16219 char_u *str = get_tv_string_chk(&argvars[0]);
16220 int capcol = -1;
16222 if (str != NULL)
16224 /* Check the argument for spelling. */
16225 while (*str != NUL)
16227 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16228 if (attr != HLF_COUNT)
16230 word = str;
16231 break;
16233 str += len;
16237 #endif
16239 list_append_string(rettv->vval.v_list, word, len);
16240 list_append_string(rettv->vval.v_list, (char_u *)(
16241 attr == HLF_SPB ? "bad" :
16242 attr == HLF_SPR ? "rare" :
16243 attr == HLF_SPL ? "local" :
16244 attr == HLF_SPC ? "caps" :
16245 ""), -1);
16249 * "spellsuggest()" function
16251 /*ARGSUSED*/
16252 static void
16253 f_spellsuggest(argvars, rettv)
16254 typval_T *argvars;
16255 typval_T *rettv;
16257 #ifdef FEAT_SPELL
16258 char_u *str;
16259 int typeerr = FALSE;
16260 int maxcount;
16261 garray_T ga;
16262 int i;
16263 listitem_T *li;
16264 int need_capital = FALSE;
16265 #endif
16267 if (rettv_list_alloc(rettv) == FAIL)
16268 return;
16270 #ifdef FEAT_SPELL
16271 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16273 str = get_tv_string(&argvars[0]);
16274 if (argvars[1].v_type != VAR_UNKNOWN)
16276 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16277 if (maxcount <= 0)
16278 return;
16279 if (argvars[2].v_type != VAR_UNKNOWN)
16281 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16282 if (typeerr)
16283 return;
16286 else
16287 maxcount = 25;
16289 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16291 for (i = 0; i < ga.ga_len; ++i)
16293 str = ((char_u **)ga.ga_data)[i];
16295 li = listitem_alloc();
16296 if (li == NULL)
16297 vim_free(str);
16298 else
16300 li->li_tv.v_type = VAR_STRING;
16301 li->li_tv.v_lock = 0;
16302 li->li_tv.vval.v_string = str;
16303 list_append(rettv->vval.v_list, li);
16306 ga_clear(&ga);
16308 #endif
16311 static void
16312 f_split(argvars, rettv)
16313 typval_T *argvars;
16314 typval_T *rettv;
16316 char_u *str;
16317 char_u *end;
16318 char_u *pat = NULL;
16319 regmatch_T regmatch;
16320 char_u patbuf[NUMBUFLEN];
16321 char_u *save_cpo;
16322 int match;
16323 colnr_T col = 0;
16324 int keepempty = FALSE;
16325 int typeerr = FALSE;
16327 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16328 save_cpo = p_cpo;
16329 p_cpo = (char_u *)"";
16331 str = get_tv_string(&argvars[0]);
16332 if (argvars[1].v_type != VAR_UNKNOWN)
16334 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16335 if (pat == NULL)
16336 typeerr = TRUE;
16337 if (argvars[2].v_type != VAR_UNKNOWN)
16338 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16340 if (pat == NULL || *pat == NUL)
16341 pat = (char_u *)"[\\x01- ]\\+";
16343 if (rettv_list_alloc(rettv) == FAIL)
16344 return;
16345 if (typeerr)
16346 return;
16348 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16349 if (regmatch.regprog != NULL)
16351 regmatch.rm_ic = FALSE;
16352 while (*str != NUL || keepempty)
16354 if (*str == NUL)
16355 match = FALSE; /* empty item at the end */
16356 else
16357 match = vim_regexec_nl(&regmatch, str, col);
16358 if (match)
16359 end = regmatch.startp[0];
16360 else
16361 end = str + STRLEN(str);
16362 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16363 && *str != NUL && match && end < regmatch.endp[0]))
16365 if (list_append_string(rettv->vval.v_list, str,
16366 (int)(end - str)) == FAIL)
16367 break;
16369 if (!match)
16370 break;
16371 /* Advance to just after the match. */
16372 if (regmatch.endp[0] > str)
16373 col = 0;
16374 else
16376 /* Don't get stuck at the same match. */
16377 #ifdef FEAT_MBYTE
16378 col = (*mb_ptr2len)(regmatch.endp[0]);
16379 #else
16380 col = 1;
16381 #endif
16383 str = regmatch.endp[0];
16386 vim_free(regmatch.regprog);
16389 p_cpo = save_cpo;
16392 #ifdef FEAT_FLOAT
16394 * "sqrt()" function
16396 static void
16397 f_sqrt(argvars, rettv)
16398 typval_T *argvars;
16399 typval_T *rettv;
16401 float_T f;
16403 rettv->v_type = VAR_FLOAT;
16404 if (get_float_arg(argvars, &f) == OK)
16405 rettv->vval.v_float = sqrt(f);
16406 else
16407 rettv->vval.v_float = 0.0;
16411 * "str2float()" function
16413 static void
16414 f_str2float(argvars, rettv)
16415 typval_T *argvars;
16416 typval_T *rettv;
16418 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16420 if (*p == '+')
16421 p = skipwhite(p + 1);
16422 (void)string2float(p, &rettv->vval.v_float);
16423 rettv->v_type = VAR_FLOAT;
16425 #endif
16428 * "str2nr()" function
16430 static void
16431 f_str2nr(argvars, rettv)
16432 typval_T *argvars;
16433 typval_T *rettv;
16435 int base = 10;
16436 char_u *p;
16437 long n;
16439 if (argvars[1].v_type != VAR_UNKNOWN)
16441 base = get_tv_number(&argvars[1]);
16442 if (base != 8 && base != 10 && base != 16)
16444 EMSG(_(e_invarg));
16445 return;
16449 p = skipwhite(get_tv_string(&argvars[0]));
16450 if (*p == '+')
16451 p = skipwhite(p + 1);
16452 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16453 rettv->vval.v_number = n;
16456 #ifdef HAVE_STRFTIME
16458 * "strftime({format}[, {time}])" function
16460 static void
16461 f_strftime(argvars, rettv)
16462 typval_T *argvars;
16463 typval_T *rettv;
16465 char_u result_buf[256];
16466 struct tm *curtime;
16467 time_t seconds;
16468 char_u *p;
16470 rettv->v_type = VAR_STRING;
16472 p = get_tv_string(&argvars[0]);
16473 if (argvars[1].v_type == VAR_UNKNOWN)
16474 seconds = time(NULL);
16475 else
16476 seconds = (time_t)get_tv_number(&argvars[1]);
16477 curtime = localtime(&seconds);
16478 /* MSVC returns NULL for an invalid value of seconds. */
16479 if (curtime == NULL)
16480 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16481 else
16483 # ifdef FEAT_MBYTE
16484 vimconv_T conv;
16485 char_u *enc;
16487 conv.vc_type = CONV_NONE;
16488 enc = enc_locale();
16489 convert_setup(&conv, p_enc, enc);
16490 if (conv.vc_type != CONV_NONE)
16491 p = string_convert(&conv, p, NULL);
16492 # endif
16493 if (p != NULL)
16494 (void)strftime((char *)result_buf, sizeof(result_buf),
16495 (char *)p, curtime);
16496 else
16497 result_buf[0] = NUL;
16499 # ifdef FEAT_MBYTE
16500 if (conv.vc_type != CONV_NONE)
16501 vim_free(p);
16502 convert_setup(&conv, enc, p_enc);
16503 if (conv.vc_type != CONV_NONE)
16504 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16505 else
16506 # endif
16507 rettv->vval.v_string = vim_strsave(result_buf);
16509 # ifdef FEAT_MBYTE
16510 /* Release conversion descriptors */
16511 convert_setup(&conv, NULL, NULL);
16512 vim_free(enc);
16513 # endif
16516 #endif
16519 * "stridx()" function
16521 static void
16522 f_stridx(argvars, rettv)
16523 typval_T *argvars;
16524 typval_T *rettv;
16526 char_u buf[NUMBUFLEN];
16527 char_u *needle;
16528 char_u *haystack;
16529 char_u *save_haystack;
16530 char_u *pos;
16531 int start_idx;
16533 needle = get_tv_string_chk(&argvars[1]);
16534 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16535 rettv->vval.v_number = -1;
16536 if (needle == NULL || haystack == NULL)
16537 return; /* type error; errmsg already given */
16539 if (argvars[2].v_type != VAR_UNKNOWN)
16541 int error = FALSE;
16543 start_idx = get_tv_number_chk(&argvars[2], &error);
16544 if (error || start_idx >= (int)STRLEN(haystack))
16545 return;
16546 if (start_idx >= 0)
16547 haystack += start_idx;
16550 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16551 if (pos != NULL)
16552 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16556 * "string()" function
16558 static void
16559 f_string(argvars, rettv)
16560 typval_T *argvars;
16561 typval_T *rettv;
16563 char_u *tofree;
16564 char_u numbuf[NUMBUFLEN];
16566 rettv->v_type = VAR_STRING;
16567 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16568 /* Make a copy if we have a value but it's not in allocated memory. */
16569 if (rettv->vval.v_string != NULL && tofree == NULL)
16570 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16574 * "strlen()" function
16576 static void
16577 f_strlen(argvars, rettv)
16578 typval_T *argvars;
16579 typval_T *rettv;
16581 rettv->vval.v_number = (varnumber_T)(STRLEN(
16582 get_tv_string(&argvars[0])));
16586 * "strpart()" function
16588 static void
16589 f_strpart(argvars, rettv)
16590 typval_T *argvars;
16591 typval_T *rettv;
16593 char_u *p;
16594 int n;
16595 int len;
16596 int slen;
16597 int error = FALSE;
16599 p = get_tv_string(&argvars[0]);
16600 slen = (int)STRLEN(p);
16602 n = get_tv_number_chk(&argvars[1], &error);
16603 if (error)
16604 len = 0;
16605 else if (argvars[2].v_type != VAR_UNKNOWN)
16606 len = get_tv_number(&argvars[2]);
16607 else
16608 len = slen - n; /* default len: all bytes that are available. */
16611 * Only return the overlap between the specified part and the actual
16612 * string.
16614 if (n < 0)
16616 len += n;
16617 n = 0;
16619 else if (n > slen)
16620 n = slen;
16621 if (len < 0)
16622 len = 0;
16623 else if (n + len > slen)
16624 len = slen - n;
16626 rettv->v_type = VAR_STRING;
16627 rettv->vval.v_string = vim_strnsave(p + n, len);
16631 * "strridx()" function
16633 static void
16634 f_strridx(argvars, rettv)
16635 typval_T *argvars;
16636 typval_T *rettv;
16638 char_u buf[NUMBUFLEN];
16639 char_u *needle;
16640 char_u *haystack;
16641 char_u *rest;
16642 char_u *lastmatch = NULL;
16643 int haystack_len, end_idx;
16645 needle = get_tv_string_chk(&argvars[1]);
16646 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16648 rettv->vval.v_number = -1;
16649 if (needle == NULL || haystack == NULL)
16650 return; /* type error; errmsg already given */
16652 haystack_len = (int)STRLEN(haystack);
16653 if (argvars[2].v_type != VAR_UNKNOWN)
16655 /* Third argument: upper limit for index */
16656 end_idx = get_tv_number_chk(&argvars[2], NULL);
16657 if (end_idx < 0)
16658 return; /* can never find a match */
16660 else
16661 end_idx = haystack_len;
16663 if (*needle == NUL)
16665 /* Empty string matches past the end. */
16666 lastmatch = haystack + end_idx;
16668 else
16670 for (rest = haystack; *rest != '\0'; ++rest)
16672 rest = (char_u *)strstr((char *)rest, (char *)needle);
16673 if (rest == NULL || rest > haystack + end_idx)
16674 break;
16675 lastmatch = rest;
16679 if (lastmatch == NULL)
16680 rettv->vval.v_number = -1;
16681 else
16682 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16686 * "strtrans()" function
16688 static void
16689 f_strtrans(argvars, rettv)
16690 typval_T *argvars;
16691 typval_T *rettv;
16693 rettv->v_type = VAR_STRING;
16694 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16698 * "submatch()" function
16700 static void
16701 f_submatch(argvars, rettv)
16702 typval_T *argvars;
16703 typval_T *rettv;
16705 rettv->v_type = VAR_STRING;
16706 rettv->vval.v_string =
16707 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16711 * "substitute()" function
16713 static void
16714 f_substitute(argvars, rettv)
16715 typval_T *argvars;
16716 typval_T *rettv;
16718 char_u patbuf[NUMBUFLEN];
16719 char_u subbuf[NUMBUFLEN];
16720 char_u flagsbuf[NUMBUFLEN];
16722 char_u *str = get_tv_string_chk(&argvars[0]);
16723 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16724 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16725 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16727 rettv->v_type = VAR_STRING;
16728 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16729 rettv->vval.v_string = NULL;
16730 else
16731 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16735 * "synID(lnum, col, trans)" function
16737 /*ARGSUSED*/
16738 static void
16739 f_synID(argvars, rettv)
16740 typval_T *argvars;
16741 typval_T *rettv;
16743 int id = 0;
16744 #ifdef FEAT_SYN_HL
16745 long lnum;
16746 long col;
16747 int trans;
16748 int transerr = FALSE;
16750 lnum = get_tv_lnum(argvars); /* -1 on type error */
16751 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16752 trans = get_tv_number_chk(&argvars[2], &transerr);
16754 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16755 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16756 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16757 #endif
16759 rettv->vval.v_number = id;
16763 * "synIDattr(id, what [, mode])" function
16765 /*ARGSUSED*/
16766 static void
16767 f_synIDattr(argvars, rettv)
16768 typval_T *argvars;
16769 typval_T *rettv;
16771 char_u *p = NULL;
16772 #ifdef FEAT_SYN_HL
16773 int id;
16774 char_u *what;
16775 char_u *mode;
16776 char_u modebuf[NUMBUFLEN];
16777 int modec;
16779 id = get_tv_number(&argvars[0]);
16780 what = get_tv_string(&argvars[1]);
16781 if (argvars[2].v_type != VAR_UNKNOWN)
16783 mode = get_tv_string_buf(&argvars[2], modebuf);
16784 modec = TOLOWER_ASC(mode[0]);
16785 if (modec != 't' && modec != 'c'
16786 #ifdef FEAT_GUI
16787 && modec != 'g'
16788 #endif
16790 modec = 0; /* replace invalid with current */
16792 else
16794 #ifdef FEAT_GUI
16795 if (gui.in_use)
16796 modec = 'g';
16797 else
16798 #endif
16799 if (t_colors > 1)
16800 modec = 'c';
16801 else
16802 modec = 't';
16806 switch (TOLOWER_ASC(what[0]))
16808 case 'b':
16809 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16810 p = highlight_color(id, what, modec);
16811 else /* bold */
16812 p = highlight_has_attr(id, HL_BOLD, modec);
16813 break;
16815 case 'f': /* fg[#] */
16816 p = highlight_color(id, what, modec);
16817 break;
16819 case 'i':
16820 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16821 p = highlight_has_attr(id, HL_INVERSE, modec);
16822 else /* italic */
16823 p = highlight_has_attr(id, HL_ITALIC, modec);
16824 break;
16826 case 'n': /* name */
16827 p = get_highlight_name(NULL, id - 1);
16828 break;
16830 case 'r': /* reverse */
16831 p = highlight_has_attr(id, HL_INVERSE, modec);
16832 break;
16834 case 's': /* standout */
16835 p = highlight_has_attr(id, HL_STANDOUT, modec);
16836 break;
16838 case 'u':
16839 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16840 /* underline */
16841 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16842 else
16843 /* undercurl */
16844 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16845 break;
16848 if (p != NULL)
16849 p = vim_strsave(p);
16850 #endif
16851 rettv->v_type = VAR_STRING;
16852 rettv->vval.v_string = p;
16856 * "synIDtrans(id)" function
16858 /*ARGSUSED*/
16859 static void
16860 f_synIDtrans(argvars, rettv)
16861 typval_T *argvars;
16862 typval_T *rettv;
16864 int id;
16866 #ifdef FEAT_SYN_HL
16867 id = get_tv_number(&argvars[0]);
16869 if (id > 0)
16870 id = syn_get_final_id(id);
16871 else
16872 #endif
16873 id = 0;
16875 rettv->vval.v_number = id;
16879 * "synstack(lnum, col)" function
16881 /*ARGSUSED*/
16882 static void
16883 f_synstack(argvars, rettv)
16884 typval_T *argvars;
16885 typval_T *rettv;
16887 #ifdef FEAT_SYN_HL
16888 long lnum;
16889 long col;
16890 int i;
16891 int id;
16892 #endif
16894 rettv->v_type = VAR_LIST;
16895 rettv->vval.v_list = NULL;
16897 #ifdef FEAT_SYN_HL
16898 lnum = get_tv_lnum(argvars); /* -1 on type error */
16899 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16901 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16902 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16903 && rettv_list_alloc(rettv) != FAIL)
16905 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16906 for (i = 0; ; ++i)
16908 id = syn_get_stack_item(i);
16909 if (id < 0)
16910 break;
16911 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16912 break;
16915 #endif
16919 * "system()" function
16921 static void
16922 f_system(argvars, rettv)
16923 typval_T *argvars;
16924 typval_T *rettv;
16926 char_u *res = NULL;
16927 char_u *p;
16928 char_u *infile = NULL;
16929 char_u buf[NUMBUFLEN];
16930 int err = FALSE;
16931 FILE *fd;
16933 if (check_restricted() || check_secure())
16934 goto done;
16936 if (argvars[1].v_type != VAR_UNKNOWN)
16939 * Write the string to a temp file, to be used for input of the shell
16940 * command.
16942 if ((infile = vim_tempname('i')) == NULL)
16944 EMSG(_(e_notmp));
16945 goto done;
16948 fd = mch_fopen((char *)infile, WRITEBIN);
16949 if (fd == NULL)
16951 EMSG2(_(e_notopen), infile);
16952 goto done;
16954 p = get_tv_string_buf_chk(&argvars[1], buf);
16955 if (p == NULL)
16957 fclose(fd);
16958 goto done; /* type error; errmsg already given */
16960 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16961 err = TRUE;
16962 if (fclose(fd) != 0)
16963 err = TRUE;
16964 if (err)
16966 EMSG(_("E677: Error writing temp file"));
16967 goto done;
16971 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16972 SHELL_SILENT | SHELL_COOKED);
16974 #ifdef USE_CR
16975 /* translate <CR> into <NL> */
16976 if (res != NULL)
16978 char_u *s;
16980 for (s = res; *s; ++s)
16982 if (*s == CAR)
16983 *s = NL;
16986 #else
16987 # ifdef USE_CRNL
16988 /* translate <CR><NL> into <NL> */
16989 if (res != NULL)
16991 char_u *s, *d;
16993 d = res;
16994 for (s = res; *s; ++s)
16996 if (s[0] == CAR && s[1] == NL)
16997 ++s;
16998 *d++ = *s;
17000 *d = NUL;
17002 # endif
17003 #endif
17005 done:
17006 if (infile != NULL)
17008 mch_remove(infile);
17009 vim_free(infile);
17011 rettv->v_type = VAR_STRING;
17012 rettv->vval.v_string = res;
17016 * "tabpagebuflist()" function
17018 /* ARGSUSED */
17019 static void
17020 f_tabpagebuflist(argvars, rettv)
17021 typval_T *argvars;
17022 typval_T *rettv;
17024 #ifndef FEAT_WINDOWS
17025 rettv->vval.v_number = 0;
17026 #else
17027 tabpage_T *tp;
17028 win_T *wp = NULL;
17030 if (argvars[0].v_type == VAR_UNKNOWN)
17031 wp = firstwin;
17032 else
17034 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17035 if (tp != NULL)
17036 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
17038 if (wp == NULL)
17039 rettv->vval.v_number = 0;
17040 else
17042 if (rettv_list_alloc(rettv) == FAIL)
17043 rettv->vval.v_number = 0;
17044 else
17046 for (; wp != NULL; wp = wp->w_next)
17047 if (list_append_number(rettv->vval.v_list,
17048 wp->w_buffer->b_fnum) == FAIL)
17049 break;
17052 #endif
17057 * "tabpagenr()" function
17059 /* ARGSUSED */
17060 static void
17061 f_tabpagenr(argvars, rettv)
17062 typval_T *argvars;
17063 typval_T *rettv;
17065 int nr = 1;
17066 #ifdef FEAT_WINDOWS
17067 char_u *arg;
17069 if (argvars[0].v_type != VAR_UNKNOWN)
17071 arg = get_tv_string_chk(&argvars[0]);
17072 nr = 0;
17073 if (arg != NULL)
17075 if (STRCMP(arg, "$") == 0)
17076 nr = tabpage_index(NULL) - 1;
17077 else
17078 EMSG2(_(e_invexpr2), arg);
17081 else
17082 nr = tabpage_index(curtab);
17083 #endif
17084 rettv->vval.v_number = nr;
17088 #ifdef FEAT_WINDOWS
17089 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
17092 * Common code for tabpagewinnr() and winnr().
17094 static int
17095 get_winnr(tp, argvar)
17096 tabpage_T *tp;
17097 typval_T *argvar;
17099 win_T *twin;
17100 int nr = 1;
17101 win_T *wp;
17102 char_u *arg;
17104 twin = (tp == curtab) ? curwin : tp->tp_curwin;
17105 if (argvar->v_type != VAR_UNKNOWN)
17107 arg = get_tv_string_chk(argvar);
17108 if (arg == NULL)
17109 nr = 0; /* type error; errmsg already given */
17110 else if (STRCMP(arg, "$") == 0)
17111 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
17112 else if (STRCMP(arg, "#") == 0)
17114 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
17115 if (twin == NULL)
17116 nr = 0;
17118 else
17120 EMSG2(_(e_invexpr2), arg);
17121 nr = 0;
17125 if (nr > 0)
17126 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
17127 wp != twin; wp = wp->w_next)
17129 if (wp == NULL)
17131 /* didn't find it in this tabpage */
17132 nr = 0;
17133 break;
17135 ++nr;
17137 return nr;
17139 #endif
17142 * "tabpagewinnr()" function
17144 /* ARGSUSED */
17145 static void
17146 f_tabpagewinnr(argvars, rettv)
17147 typval_T *argvars;
17148 typval_T *rettv;
17150 int nr = 1;
17151 #ifdef FEAT_WINDOWS
17152 tabpage_T *tp;
17154 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17155 if (tp == NULL)
17156 nr = 0;
17157 else
17158 nr = get_winnr(tp, &argvars[1]);
17159 #endif
17160 rettv->vval.v_number = nr;
17165 * "tagfiles()" function
17167 /*ARGSUSED*/
17168 static void
17169 f_tagfiles(argvars, rettv)
17170 typval_T *argvars;
17171 typval_T *rettv;
17173 char_u fname[MAXPATHL + 1];
17174 tagname_T tn;
17175 int first;
17177 if (rettv_list_alloc(rettv) == FAIL)
17179 rettv->vval.v_number = 0;
17180 return;
17183 for (first = TRUE; ; first = FALSE)
17184 if (get_tagfname(&tn, first, fname) == FAIL
17185 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17186 break;
17187 tagname_free(&tn);
17191 * "taglist()" function
17193 static void
17194 f_taglist(argvars, rettv)
17195 typval_T *argvars;
17196 typval_T *rettv;
17198 char_u *tag_pattern;
17200 tag_pattern = get_tv_string(&argvars[0]);
17202 rettv->vval.v_number = FALSE;
17203 if (*tag_pattern == NUL)
17204 return;
17206 if (rettv_list_alloc(rettv) == OK)
17207 (void)get_tags(rettv->vval.v_list, tag_pattern);
17211 * "tempname()" function
17213 /*ARGSUSED*/
17214 static void
17215 f_tempname(argvars, rettv)
17216 typval_T *argvars;
17217 typval_T *rettv;
17219 static int x = 'A';
17221 rettv->v_type = VAR_STRING;
17222 rettv->vval.v_string = vim_tempname(x);
17224 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17225 * names. Skip 'I' and 'O', they are used for shell redirection. */
17228 if (x == 'Z')
17229 x = '0';
17230 else if (x == '9')
17231 x = 'A';
17232 else
17234 #ifdef EBCDIC
17235 if (x == 'I')
17236 x = 'J';
17237 else if (x == 'R')
17238 x = 'S';
17239 else
17240 #endif
17241 ++x;
17243 } while (x == 'I' || x == 'O');
17247 * "test(list)" function: Just checking the walls...
17249 /*ARGSUSED*/
17250 static void
17251 f_test(argvars, rettv)
17252 typval_T *argvars;
17253 typval_T *rettv;
17255 /* Used for unit testing. Change the code below to your liking. */
17256 #if 0
17257 listitem_T *li;
17258 list_T *l;
17259 char_u *bad, *good;
17261 if (argvars[0].v_type != VAR_LIST)
17262 return;
17263 l = argvars[0].vval.v_list;
17264 if (l == NULL)
17265 return;
17266 li = l->lv_first;
17267 if (li == NULL)
17268 return;
17269 bad = get_tv_string(&li->li_tv);
17270 li = li->li_next;
17271 if (li == NULL)
17272 return;
17273 good = get_tv_string(&li->li_tv);
17274 rettv->vval.v_number = test_edit_score(bad, good);
17275 #endif
17279 * "tolower(string)" function
17281 static void
17282 f_tolower(argvars, rettv)
17283 typval_T *argvars;
17284 typval_T *rettv;
17286 char_u *p;
17288 p = vim_strsave(get_tv_string(&argvars[0]));
17289 rettv->v_type = VAR_STRING;
17290 rettv->vval.v_string = p;
17292 if (p != NULL)
17293 while (*p != NUL)
17295 #ifdef FEAT_MBYTE
17296 int l;
17298 if (enc_utf8)
17300 int c, lc;
17302 c = utf_ptr2char(p);
17303 lc = utf_tolower(c);
17304 l = utf_ptr2len(p);
17305 /* TODO: reallocate string when byte count changes. */
17306 if (utf_char2len(lc) == l)
17307 utf_char2bytes(lc, p);
17308 p += l;
17310 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17311 p += l; /* skip multi-byte character */
17312 else
17313 #endif
17315 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17316 ++p;
17322 * "toupper(string)" function
17324 static void
17325 f_toupper(argvars, rettv)
17326 typval_T *argvars;
17327 typval_T *rettv;
17329 rettv->v_type = VAR_STRING;
17330 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17334 * "tr(string, fromstr, tostr)" function
17336 static void
17337 f_tr(argvars, rettv)
17338 typval_T *argvars;
17339 typval_T *rettv;
17341 char_u *instr;
17342 char_u *fromstr;
17343 char_u *tostr;
17344 char_u *p;
17345 #ifdef FEAT_MBYTE
17346 int inlen;
17347 int fromlen;
17348 int tolen;
17349 int idx;
17350 char_u *cpstr;
17351 int cplen;
17352 int first = TRUE;
17353 #endif
17354 char_u buf[NUMBUFLEN];
17355 char_u buf2[NUMBUFLEN];
17356 garray_T ga;
17358 instr = get_tv_string(&argvars[0]);
17359 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17360 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17362 /* Default return value: empty string. */
17363 rettv->v_type = VAR_STRING;
17364 rettv->vval.v_string = NULL;
17365 if (fromstr == NULL || tostr == NULL)
17366 return; /* type error; errmsg already given */
17367 ga_init2(&ga, (int)sizeof(char), 80);
17369 #ifdef FEAT_MBYTE
17370 if (!has_mbyte)
17371 #endif
17372 /* not multi-byte: fromstr and tostr must be the same length */
17373 if (STRLEN(fromstr) != STRLEN(tostr))
17375 #ifdef FEAT_MBYTE
17376 error:
17377 #endif
17378 EMSG2(_(e_invarg2), fromstr);
17379 ga_clear(&ga);
17380 return;
17383 /* fromstr and tostr have to contain the same number of chars */
17384 while (*instr != NUL)
17386 #ifdef FEAT_MBYTE
17387 if (has_mbyte)
17389 inlen = (*mb_ptr2len)(instr);
17390 cpstr = instr;
17391 cplen = inlen;
17392 idx = 0;
17393 for (p = fromstr; *p != NUL; p += fromlen)
17395 fromlen = (*mb_ptr2len)(p);
17396 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17398 for (p = tostr; *p != NUL; p += tolen)
17400 tolen = (*mb_ptr2len)(p);
17401 if (idx-- == 0)
17403 cplen = tolen;
17404 cpstr = p;
17405 break;
17408 if (*p == NUL) /* tostr is shorter than fromstr */
17409 goto error;
17410 break;
17412 ++idx;
17415 if (first && cpstr == instr)
17417 /* Check that fromstr and tostr have the same number of
17418 * (multi-byte) characters. Done only once when a character
17419 * of instr doesn't appear in fromstr. */
17420 first = FALSE;
17421 for (p = tostr; *p != NUL; p += tolen)
17423 tolen = (*mb_ptr2len)(p);
17424 --idx;
17426 if (idx != 0)
17427 goto error;
17430 ga_grow(&ga, cplen);
17431 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17432 ga.ga_len += cplen;
17434 instr += inlen;
17436 else
17437 #endif
17439 /* When not using multi-byte chars we can do it faster. */
17440 p = vim_strchr(fromstr, *instr);
17441 if (p != NULL)
17442 ga_append(&ga, tostr[p - fromstr]);
17443 else
17444 ga_append(&ga, *instr);
17445 ++instr;
17449 /* add a terminating NUL */
17450 ga_grow(&ga, 1);
17451 ga_append(&ga, NUL);
17453 rettv->vval.v_string = ga.ga_data;
17456 #ifdef FEAT_FLOAT
17458 * "trunc({float})" function
17460 static void
17461 f_trunc(argvars, rettv)
17462 typval_T *argvars;
17463 typval_T *rettv;
17465 float_T f;
17467 rettv->v_type = VAR_FLOAT;
17468 if (get_float_arg(argvars, &f) == OK)
17469 /* trunc() is not in C90, use floor() or ceil() instead. */
17470 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17471 else
17472 rettv->vval.v_float = 0.0;
17474 #endif
17477 * "type(expr)" function
17479 static void
17480 f_type(argvars, rettv)
17481 typval_T *argvars;
17482 typval_T *rettv;
17484 int n;
17486 switch (argvars[0].v_type)
17488 case VAR_NUMBER: n = 0; break;
17489 case VAR_STRING: n = 1; break;
17490 case VAR_FUNC: n = 2; break;
17491 case VAR_LIST: n = 3; break;
17492 case VAR_DICT: n = 4; break;
17493 #ifdef FEAT_FLOAT
17494 case VAR_FLOAT: n = 5; break;
17495 #endif
17496 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17498 rettv->vval.v_number = n;
17502 * "values(dict)" function
17504 static void
17505 f_values(argvars, rettv)
17506 typval_T *argvars;
17507 typval_T *rettv;
17509 dict_list(argvars, rettv, 1);
17513 * "virtcol(string)" function
17515 static void
17516 f_virtcol(argvars, rettv)
17517 typval_T *argvars;
17518 typval_T *rettv;
17520 colnr_T vcol = 0;
17521 pos_T *fp;
17522 int fnum = curbuf->b_fnum;
17524 fp = var2fpos(&argvars[0], FALSE, &fnum);
17525 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17526 && fnum == curbuf->b_fnum)
17528 getvvcol(curwin, fp, NULL, NULL, &vcol);
17529 ++vcol;
17532 rettv->vval.v_number = vcol;
17536 * "visualmode()" function
17538 /*ARGSUSED*/
17539 static void
17540 f_visualmode(argvars, rettv)
17541 typval_T *argvars;
17542 typval_T *rettv;
17544 #ifdef FEAT_VISUAL
17545 char_u str[2];
17547 rettv->v_type = VAR_STRING;
17548 str[0] = curbuf->b_visual_mode_eval;
17549 str[1] = NUL;
17550 rettv->vval.v_string = vim_strsave(str);
17552 /* A non-zero number or non-empty string argument: reset mode. */
17553 if (non_zero_arg(&argvars[0]))
17554 curbuf->b_visual_mode_eval = NUL;
17555 #else
17556 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17557 #endif
17561 * "winbufnr(nr)" function
17563 static void
17564 f_winbufnr(argvars, rettv)
17565 typval_T *argvars;
17566 typval_T *rettv;
17568 win_T *wp;
17570 wp = find_win_by_nr(&argvars[0], NULL);
17571 if (wp == NULL)
17572 rettv->vval.v_number = -1;
17573 else
17574 rettv->vval.v_number = wp->w_buffer->b_fnum;
17578 * "wincol()" function
17580 /*ARGSUSED*/
17581 static void
17582 f_wincol(argvars, rettv)
17583 typval_T *argvars;
17584 typval_T *rettv;
17586 validate_cursor();
17587 rettv->vval.v_number = curwin->w_wcol + 1;
17591 * "winheight(nr)" function
17593 static void
17594 f_winheight(argvars, rettv)
17595 typval_T *argvars;
17596 typval_T *rettv;
17598 win_T *wp;
17600 wp = find_win_by_nr(&argvars[0], NULL);
17601 if (wp == NULL)
17602 rettv->vval.v_number = -1;
17603 else
17604 rettv->vval.v_number = wp->w_height;
17608 * "winline()" function
17610 /*ARGSUSED*/
17611 static void
17612 f_winline(argvars, rettv)
17613 typval_T *argvars;
17614 typval_T *rettv;
17616 validate_cursor();
17617 rettv->vval.v_number = curwin->w_wrow + 1;
17621 * "winnr()" function
17623 /* ARGSUSED */
17624 static void
17625 f_winnr(argvars, rettv)
17626 typval_T *argvars;
17627 typval_T *rettv;
17629 int nr = 1;
17631 #ifdef FEAT_WINDOWS
17632 nr = get_winnr(curtab, &argvars[0]);
17633 #endif
17634 rettv->vval.v_number = nr;
17638 * "winrestcmd()" function
17640 /* ARGSUSED */
17641 static void
17642 f_winrestcmd(argvars, rettv)
17643 typval_T *argvars;
17644 typval_T *rettv;
17646 #ifdef FEAT_WINDOWS
17647 win_T *wp;
17648 int winnr = 1;
17649 garray_T ga;
17650 char_u buf[50];
17652 ga_init2(&ga, (int)sizeof(char), 70);
17653 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17655 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17656 ga_concat(&ga, buf);
17657 # ifdef FEAT_VERTSPLIT
17658 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17659 ga_concat(&ga, buf);
17660 # endif
17661 ++winnr;
17663 ga_append(&ga, NUL);
17665 rettv->vval.v_string = ga.ga_data;
17666 #else
17667 rettv->vval.v_string = NULL;
17668 #endif
17669 rettv->v_type = VAR_STRING;
17673 * "winrestview()" function
17675 /* ARGSUSED */
17676 static void
17677 f_winrestview(argvars, rettv)
17678 typval_T *argvars;
17679 typval_T *rettv;
17681 dict_T *dict;
17683 if (argvars[0].v_type != VAR_DICT
17684 || (dict = argvars[0].vval.v_dict) == NULL)
17685 EMSG(_(e_invarg));
17686 else
17688 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17689 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17690 #ifdef FEAT_VIRTUALEDIT
17691 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17692 #endif
17693 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17694 curwin->w_set_curswant = FALSE;
17696 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17697 #ifdef FEAT_DIFF
17698 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17699 #endif
17700 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17701 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17703 check_cursor();
17704 changed_cline_bef_curs();
17705 invalidate_botline();
17706 redraw_later(VALID);
17708 if (curwin->w_topline == 0)
17709 curwin->w_topline = 1;
17710 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17711 curwin->w_topline = curbuf->b_ml.ml_line_count;
17712 #ifdef FEAT_DIFF
17713 check_topfill(curwin, TRUE);
17714 #endif
17719 * "winsaveview()" function
17721 /* ARGSUSED */
17722 static void
17723 f_winsaveview(argvars, rettv)
17724 typval_T *argvars;
17725 typval_T *rettv;
17727 dict_T *dict;
17729 dict = dict_alloc();
17730 if (dict == NULL)
17731 return;
17732 rettv->v_type = VAR_DICT;
17733 rettv->vval.v_dict = dict;
17734 ++dict->dv_refcount;
17736 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17737 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17738 #ifdef FEAT_VIRTUALEDIT
17739 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17740 #endif
17741 update_curswant();
17742 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17744 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17745 #ifdef FEAT_DIFF
17746 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17747 #endif
17748 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17749 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17753 * "winwidth(nr)" function
17755 static void
17756 f_winwidth(argvars, rettv)
17757 typval_T *argvars;
17758 typval_T *rettv;
17760 win_T *wp;
17762 wp = find_win_by_nr(&argvars[0], NULL);
17763 if (wp == NULL)
17764 rettv->vval.v_number = -1;
17765 else
17766 #ifdef FEAT_VERTSPLIT
17767 rettv->vval.v_number = wp->w_width;
17768 #else
17769 rettv->vval.v_number = Columns;
17770 #endif
17774 * "writefile()" function
17776 static void
17777 f_writefile(argvars, rettv)
17778 typval_T *argvars;
17779 typval_T *rettv;
17781 int binary = FALSE;
17782 char_u *fname;
17783 FILE *fd;
17784 listitem_T *li;
17785 char_u *s;
17786 int ret = 0;
17787 int c;
17789 if (check_restricted() || check_secure())
17790 return;
17792 if (argvars[0].v_type != VAR_LIST)
17794 EMSG2(_(e_listarg), "writefile()");
17795 return;
17797 if (argvars[0].vval.v_list == NULL)
17798 return;
17800 if (argvars[2].v_type != VAR_UNKNOWN
17801 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17802 binary = TRUE;
17804 /* Always open the file in binary mode, library functions have a mind of
17805 * their own about CR-LF conversion. */
17806 fname = get_tv_string(&argvars[1]);
17807 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17809 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17810 ret = -1;
17812 else
17814 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17815 li = li->li_next)
17817 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17819 if (*s == '\n')
17820 c = putc(NUL, fd);
17821 else
17822 c = putc(*s, fd);
17823 if (c == EOF)
17825 ret = -1;
17826 break;
17829 if (!binary || li->li_next != NULL)
17830 if (putc('\n', fd) == EOF)
17832 ret = -1;
17833 break;
17835 if (ret < 0)
17837 EMSG(_(e_write));
17838 break;
17841 fclose(fd);
17844 rettv->vval.v_number = ret;
17848 * Translate a String variable into a position.
17849 * Returns NULL when there is an error.
17851 static pos_T *
17852 var2fpos(varp, dollar_lnum, fnum)
17853 typval_T *varp;
17854 int dollar_lnum; /* TRUE when $ is last line */
17855 int *fnum; /* set to fnum for '0, 'A, etc. */
17857 char_u *name;
17858 static pos_T pos;
17859 pos_T *pp;
17861 /* Argument can be [lnum, col, coladd]. */
17862 if (varp->v_type == VAR_LIST)
17864 list_T *l;
17865 int len;
17866 int error = FALSE;
17867 listitem_T *li;
17869 l = varp->vval.v_list;
17870 if (l == NULL)
17871 return NULL;
17873 /* Get the line number */
17874 pos.lnum = list_find_nr(l, 0L, &error);
17875 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17876 return NULL; /* invalid line number */
17878 /* Get the column number */
17879 pos.col = list_find_nr(l, 1L, &error);
17880 if (error)
17881 return NULL;
17882 len = (long)STRLEN(ml_get(pos.lnum));
17884 /* We accept "$" for the column number: last column. */
17885 li = list_find(l, 1L);
17886 if (li != NULL && li->li_tv.v_type == VAR_STRING
17887 && li->li_tv.vval.v_string != NULL
17888 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17889 pos.col = len + 1;
17891 /* Accept a position up to the NUL after the line. */
17892 if (pos.col == 0 || (int)pos.col > len + 1)
17893 return NULL; /* invalid column number */
17894 --pos.col;
17896 #ifdef FEAT_VIRTUALEDIT
17897 /* Get the virtual offset. Defaults to zero. */
17898 pos.coladd = list_find_nr(l, 2L, &error);
17899 if (error)
17900 pos.coladd = 0;
17901 #endif
17903 return &pos;
17906 name = get_tv_string_chk(varp);
17907 if (name == NULL)
17908 return NULL;
17909 if (name[0] == '.') /* cursor */
17910 return &curwin->w_cursor;
17911 #ifdef FEAT_VISUAL
17912 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17914 if (VIsual_active)
17915 return &VIsual;
17916 return &curwin->w_cursor;
17918 #endif
17919 if (name[0] == '\'') /* mark */
17921 pp = getmark_fnum(name[1], FALSE, fnum);
17922 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17923 return NULL;
17924 return pp;
17927 #ifdef FEAT_VIRTUALEDIT
17928 pos.coladd = 0;
17929 #endif
17931 if (name[0] == 'w' && dollar_lnum)
17933 pos.col = 0;
17934 if (name[1] == '0') /* "w0": first visible line */
17936 update_topline();
17937 pos.lnum = curwin->w_topline;
17938 return &pos;
17940 else if (name[1] == '$') /* "w$": last visible line */
17942 validate_botline();
17943 pos.lnum = curwin->w_botline - 1;
17944 return &pos;
17947 else if (name[0] == '$') /* last column or line */
17949 if (dollar_lnum)
17951 pos.lnum = curbuf->b_ml.ml_line_count;
17952 pos.col = 0;
17954 else
17956 pos.lnum = curwin->w_cursor.lnum;
17957 pos.col = (colnr_T)STRLEN(ml_get_curline());
17959 return &pos;
17961 return NULL;
17965 * Convert list in "arg" into a position and optional file number.
17966 * When "fnump" is NULL there is no file number, only 3 items.
17967 * Note that the column is passed on as-is, the caller may want to decrement
17968 * it to use 1 for the first column.
17969 * Return FAIL when conversion is not possible, doesn't check the position for
17970 * validity.
17972 static int
17973 list2fpos(arg, posp, fnump)
17974 typval_T *arg;
17975 pos_T *posp;
17976 int *fnump;
17978 list_T *l = arg->vval.v_list;
17979 long i = 0;
17980 long n;
17982 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17983 * when "fnump" isn't NULL and "coladd" is optional. */
17984 if (arg->v_type != VAR_LIST
17985 || l == NULL
17986 || l->lv_len < (fnump == NULL ? 2 : 3)
17987 || l->lv_len > (fnump == NULL ? 3 : 4))
17988 return FAIL;
17990 if (fnump != NULL)
17992 n = list_find_nr(l, i++, NULL); /* fnum */
17993 if (n < 0)
17994 return FAIL;
17995 if (n == 0)
17996 n = curbuf->b_fnum; /* current buffer */
17997 *fnump = n;
18000 n = list_find_nr(l, i++, NULL); /* lnum */
18001 if (n < 0)
18002 return FAIL;
18003 posp->lnum = n;
18005 n = list_find_nr(l, i++, NULL); /* col */
18006 if (n < 0)
18007 return FAIL;
18008 posp->col = n;
18010 #ifdef FEAT_VIRTUALEDIT
18011 n = list_find_nr(l, i, NULL);
18012 if (n < 0)
18013 posp->coladd = 0;
18014 else
18015 posp->coladd = n;
18016 #endif
18018 return OK;
18022 * Get the length of an environment variable name.
18023 * Advance "arg" to the first character after the name.
18024 * Return 0 for error.
18026 static int
18027 get_env_len(arg)
18028 char_u **arg;
18030 char_u *p;
18031 int len;
18033 for (p = *arg; vim_isIDc(*p); ++p)
18035 if (p == *arg) /* no name found */
18036 return 0;
18038 len = (int)(p - *arg);
18039 *arg = p;
18040 return len;
18044 * Get the length of the name of a function or internal variable.
18045 * "arg" is advanced to the first non-white character after the name.
18046 * Return 0 if something is wrong.
18048 static int
18049 get_id_len(arg)
18050 char_u **arg;
18052 char_u *p;
18053 int len;
18055 /* Find the end of the name. */
18056 for (p = *arg; eval_isnamec(*p); ++p)
18058 if (p == *arg) /* no name found */
18059 return 0;
18061 len = (int)(p - *arg);
18062 *arg = skipwhite(p);
18064 return len;
18068 * Get the length of the name of a variable or function.
18069 * Only the name is recognized, does not handle ".key" or "[idx]".
18070 * "arg" is advanced to the first non-white character after the name.
18071 * Return -1 if curly braces expansion failed.
18072 * Return 0 if something else is wrong.
18073 * If the name contains 'magic' {}'s, expand them and return the
18074 * expanded name in an allocated string via 'alias' - caller must free.
18076 static int
18077 get_name_len(arg, alias, evaluate, verbose)
18078 char_u **arg;
18079 char_u **alias;
18080 int evaluate;
18081 int verbose;
18083 int len;
18084 char_u *p;
18085 char_u *expr_start;
18086 char_u *expr_end;
18088 *alias = NULL; /* default to no alias */
18090 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
18091 && (*arg)[2] == (int)KE_SNR)
18093 /* hard coded <SNR>, already translated */
18094 *arg += 3;
18095 return get_id_len(arg) + 3;
18097 len = eval_fname_script(*arg);
18098 if (len > 0)
18100 /* literal "<SID>", "s:" or "<SNR>" */
18101 *arg += len;
18105 * Find the end of the name; check for {} construction.
18107 p = find_name_end(*arg, &expr_start, &expr_end,
18108 len > 0 ? 0 : FNE_CHECK_START);
18109 if (expr_start != NULL)
18111 char_u *temp_string;
18113 if (!evaluate)
18115 len += (int)(p - *arg);
18116 *arg = skipwhite(p);
18117 return len;
18121 * Include any <SID> etc in the expanded string:
18122 * Thus the -len here.
18124 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
18125 if (temp_string == NULL)
18126 return -1;
18127 *alias = temp_string;
18128 *arg = skipwhite(p);
18129 return (int)STRLEN(temp_string);
18132 len += get_id_len(arg);
18133 if (len == 0 && verbose)
18134 EMSG2(_(e_invexpr2), *arg);
18136 return len;
18140 * Find the end of a variable or function name, taking care of magic braces.
18141 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
18142 * start and end of the first magic braces item.
18143 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
18144 * Return a pointer to just after the name. Equal to "arg" if there is no
18145 * valid name.
18147 static char_u *
18148 find_name_end(arg, expr_start, expr_end, flags)
18149 char_u *arg;
18150 char_u **expr_start;
18151 char_u **expr_end;
18152 int flags;
18154 int mb_nest = 0;
18155 int br_nest = 0;
18156 char_u *p;
18158 if (expr_start != NULL)
18160 *expr_start = NULL;
18161 *expr_end = NULL;
18164 /* Quick check for valid starting character. */
18165 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
18166 return arg;
18168 for (p = arg; *p != NUL
18169 && (eval_isnamec(*p)
18170 || *p == '{'
18171 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
18172 || mb_nest != 0
18173 || br_nest != 0); mb_ptr_adv(p))
18175 if (*p == '\'')
18177 /* skip over 'string' to avoid counting [ and ] inside it. */
18178 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18180 if (*p == NUL)
18181 break;
18183 else if (*p == '"')
18185 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18186 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18187 if (*p == '\\' && p[1] != NUL)
18188 ++p;
18189 if (*p == NUL)
18190 break;
18193 if (mb_nest == 0)
18195 if (*p == '[')
18196 ++br_nest;
18197 else if (*p == ']')
18198 --br_nest;
18201 if (br_nest == 0)
18203 if (*p == '{')
18205 mb_nest++;
18206 if (expr_start != NULL && *expr_start == NULL)
18207 *expr_start = p;
18209 else if (*p == '}')
18211 mb_nest--;
18212 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18213 *expr_end = p;
18218 return p;
18222 * Expands out the 'magic' {}'s in a variable/function name.
18223 * Note that this can call itself recursively, to deal with
18224 * constructs like foo{bar}{baz}{bam}
18225 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18226 * "in_start" ^
18227 * "expr_start" ^
18228 * "expr_end" ^
18229 * "in_end" ^
18231 * Returns a new allocated string, which the caller must free.
18232 * Returns NULL for failure.
18234 static char_u *
18235 make_expanded_name(in_start, expr_start, expr_end, in_end)
18236 char_u *in_start;
18237 char_u *expr_start;
18238 char_u *expr_end;
18239 char_u *in_end;
18241 char_u c1;
18242 char_u *retval = NULL;
18243 char_u *temp_result;
18244 char_u *nextcmd = NULL;
18246 if (expr_end == NULL || in_end == NULL)
18247 return NULL;
18248 *expr_start = NUL;
18249 *expr_end = NUL;
18250 c1 = *in_end;
18251 *in_end = NUL;
18253 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18254 if (temp_result != NULL && nextcmd == NULL)
18256 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18257 + (in_end - expr_end) + 1));
18258 if (retval != NULL)
18260 STRCPY(retval, in_start);
18261 STRCAT(retval, temp_result);
18262 STRCAT(retval, expr_end + 1);
18265 vim_free(temp_result);
18267 *in_end = c1; /* put char back for error messages */
18268 *expr_start = '{';
18269 *expr_end = '}';
18271 if (retval != NULL)
18273 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18274 if (expr_start != NULL)
18276 /* Further expansion! */
18277 temp_result = make_expanded_name(retval, expr_start,
18278 expr_end, temp_result);
18279 vim_free(retval);
18280 retval = temp_result;
18284 return retval;
18288 * Return TRUE if character "c" can be used in a variable or function name.
18289 * Does not include '{' or '}' for magic braces.
18291 static int
18292 eval_isnamec(c)
18293 int c;
18295 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18299 * Return TRUE if character "c" can be used as the first character in a
18300 * variable or function name (excluding '{' and '}').
18302 static int
18303 eval_isnamec1(c)
18304 int c;
18306 return (ASCII_ISALPHA(c) || c == '_');
18310 * Set number v: variable to "val".
18312 void
18313 set_vim_var_nr(idx, val)
18314 int idx;
18315 long val;
18317 vimvars[idx].vv_nr = val;
18321 * Get number v: variable value.
18323 long
18324 get_vim_var_nr(idx)
18325 int idx;
18327 return vimvars[idx].vv_nr;
18331 * Get string v: variable value. Uses a static buffer, can only be used once.
18333 char_u *
18334 get_vim_var_str(idx)
18335 int idx;
18337 return get_tv_string(&vimvars[idx].vv_tv);
18341 * Get List v: variable value. Caller must take care of reference count when
18342 * needed.
18344 list_T *
18345 get_vim_var_list(idx)
18346 int idx;
18348 return vimvars[idx].vv_list;
18352 * Set v:count to "count" and v:count1 to "count1".
18353 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18355 void
18356 set_vcount(count, count1, set_prevcount)
18357 long count;
18358 long count1;
18359 int set_prevcount;
18361 if (set_prevcount)
18362 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18363 vimvars[VV_COUNT].vv_nr = count;
18364 vimvars[VV_COUNT1].vv_nr = count1;
18368 * Set string v: variable to a copy of "val".
18370 void
18371 set_vim_var_string(idx, val, len)
18372 int idx;
18373 char_u *val;
18374 int len; /* length of "val" to use or -1 (whole string) */
18376 /* Need to do this (at least) once, since we can't initialize a union.
18377 * Will always be invoked when "v:progname" is set. */
18378 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18380 vim_free(vimvars[idx].vv_str);
18381 if (val == NULL)
18382 vimvars[idx].vv_str = NULL;
18383 else if (len == -1)
18384 vimvars[idx].vv_str = vim_strsave(val);
18385 else
18386 vimvars[idx].vv_str = vim_strnsave(val, len);
18390 * Set List v: variable to "val".
18392 void
18393 set_vim_var_list(idx, val)
18394 int idx;
18395 list_T *val;
18397 list_unref(vimvars[idx].vv_list);
18398 vimvars[idx].vv_list = val;
18399 if (val != NULL)
18400 ++val->lv_refcount;
18404 * Set v:register if needed.
18406 void
18407 set_reg_var(c)
18408 int c;
18410 char_u regname;
18412 if (c == 0 || c == ' ')
18413 regname = '"';
18414 else
18415 regname = c;
18416 /* Avoid free/alloc when the value is already right. */
18417 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18418 set_vim_var_string(VV_REG, &regname, 1);
18422 * Get or set v:exception. If "oldval" == NULL, return the current value.
18423 * Otherwise, restore the value to "oldval" and return NULL.
18424 * Must always be called in pairs to save and restore v:exception! Does not
18425 * take care of memory allocations.
18427 char_u *
18428 v_exception(oldval)
18429 char_u *oldval;
18431 if (oldval == NULL)
18432 return vimvars[VV_EXCEPTION].vv_str;
18434 vimvars[VV_EXCEPTION].vv_str = oldval;
18435 return NULL;
18439 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18440 * Otherwise, restore the value to "oldval" and return NULL.
18441 * Must always be called in pairs to save and restore v:throwpoint! Does not
18442 * take care of memory allocations.
18444 char_u *
18445 v_throwpoint(oldval)
18446 char_u *oldval;
18448 if (oldval == NULL)
18449 return vimvars[VV_THROWPOINT].vv_str;
18451 vimvars[VV_THROWPOINT].vv_str = oldval;
18452 return NULL;
18455 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18457 * Set v:cmdarg.
18458 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18459 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18460 * Must always be called in pairs!
18462 char_u *
18463 set_cmdarg(eap, oldarg)
18464 exarg_T *eap;
18465 char_u *oldarg;
18467 char_u *oldval;
18468 char_u *newval;
18469 unsigned len;
18471 oldval = vimvars[VV_CMDARG].vv_str;
18472 if (eap == NULL)
18474 vim_free(oldval);
18475 vimvars[VV_CMDARG].vv_str = oldarg;
18476 return NULL;
18479 if (eap->force_bin == FORCE_BIN)
18480 len = 6;
18481 else if (eap->force_bin == FORCE_NOBIN)
18482 len = 8;
18483 else
18484 len = 0;
18486 if (eap->read_edit)
18487 len += 7;
18489 if (eap->force_ff != 0)
18490 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18491 # ifdef FEAT_MBYTE
18492 if (eap->force_enc != 0)
18493 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18494 if (eap->bad_char != 0)
18495 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18496 # endif
18498 newval = alloc(len + 1);
18499 if (newval == NULL)
18500 return NULL;
18502 if (eap->force_bin == FORCE_BIN)
18503 sprintf((char *)newval, " ++bin");
18504 else if (eap->force_bin == FORCE_NOBIN)
18505 sprintf((char *)newval, " ++nobin");
18506 else
18507 *newval = NUL;
18509 if (eap->read_edit)
18510 STRCAT(newval, " ++edit");
18512 if (eap->force_ff != 0)
18513 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18514 eap->cmd + eap->force_ff);
18515 # ifdef FEAT_MBYTE
18516 if (eap->force_enc != 0)
18517 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18518 eap->cmd + eap->force_enc);
18519 if (eap->bad_char != 0)
18520 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18521 eap->cmd + eap->bad_char);
18522 # endif
18523 vimvars[VV_CMDARG].vv_str = newval;
18524 return oldval;
18526 #endif
18529 * Get the value of internal variable "name".
18530 * Return OK or FAIL.
18532 static int
18533 get_var_tv(name, len, rettv, verbose)
18534 char_u *name;
18535 int len; /* length of "name" */
18536 typval_T *rettv; /* NULL when only checking existence */
18537 int verbose; /* may give error message */
18539 int ret = OK;
18540 typval_T *tv = NULL;
18541 typval_T atv;
18542 dictitem_T *v;
18543 int cc;
18545 /* truncate the name, so that we can use strcmp() */
18546 cc = name[len];
18547 name[len] = NUL;
18550 * Check for "b:changedtick".
18552 if (STRCMP(name, "b:changedtick") == 0)
18554 atv.v_type = VAR_NUMBER;
18555 atv.vval.v_number = curbuf->b_changedtick;
18556 tv = &atv;
18560 * Check for user-defined variables.
18562 else
18564 v = find_var(name, NULL);
18565 if (v != NULL)
18566 tv = &v->di_tv;
18569 if (tv == NULL)
18571 if (rettv != NULL && verbose)
18572 EMSG2(_(e_undefvar), name);
18573 ret = FAIL;
18575 else if (rettv != NULL)
18576 copy_tv(tv, rettv);
18578 name[len] = cc;
18580 return ret;
18584 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18585 * Also handle function call with Funcref variable: func(expr)
18586 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18588 static int
18589 handle_subscript(arg, rettv, evaluate, verbose)
18590 char_u **arg;
18591 typval_T *rettv;
18592 int evaluate; /* do more than finding the end */
18593 int verbose; /* give error messages */
18595 int ret = OK;
18596 dict_T *selfdict = NULL;
18597 char_u *s;
18598 int len;
18599 typval_T functv;
18601 while (ret == OK
18602 && (**arg == '['
18603 || (**arg == '.' && rettv->v_type == VAR_DICT)
18604 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18605 && !vim_iswhite(*(*arg - 1)))
18607 if (**arg == '(')
18609 /* need to copy the funcref so that we can clear rettv */
18610 functv = *rettv;
18611 rettv->v_type = VAR_UNKNOWN;
18613 /* Invoke the function. Recursive! */
18614 s = functv.vval.v_string;
18615 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18616 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18617 &len, evaluate, selfdict);
18619 /* Clear the funcref afterwards, so that deleting it while
18620 * evaluating the arguments is possible (see test55). */
18621 clear_tv(&functv);
18623 /* Stop the expression evaluation when immediately aborting on
18624 * error, or when an interrupt occurred or an exception was thrown
18625 * but not caught. */
18626 if (aborting())
18628 if (ret == OK)
18629 clear_tv(rettv);
18630 ret = FAIL;
18632 dict_unref(selfdict);
18633 selfdict = NULL;
18635 else /* **arg == '[' || **arg == '.' */
18637 dict_unref(selfdict);
18638 if (rettv->v_type == VAR_DICT)
18640 selfdict = rettv->vval.v_dict;
18641 if (selfdict != NULL)
18642 ++selfdict->dv_refcount;
18644 else
18645 selfdict = NULL;
18646 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18648 clear_tv(rettv);
18649 ret = FAIL;
18653 dict_unref(selfdict);
18654 return ret;
18658 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18659 * value).
18661 static typval_T *
18662 alloc_tv()
18664 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18668 * Allocate memory for a variable type-value, and assign a string to it.
18669 * The string "s" must have been allocated, it is consumed.
18670 * Return NULL for out of memory, the variable otherwise.
18672 static typval_T *
18673 alloc_string_tv(s)
18674 char_u *s;
18676 typval_T *rettv;
18678 rettv = alloc_tv();
18679 if (rettv != NULL)
18681 rettv->v_type = VAR_STRING;
18682 rettv->vval.v_string = s;
18684 else
18685 vim_free(s);
18686 return rettv;
18690 * Free the memory for a variable type-value.
18692 void
18693 free_tv(varp)
18694 typval_T *varp;
18696 if (varp != NULL)
18698 switch (varp->v_type)
18700 case VAR_FUNC:
18701 func_unref(varp->vval.v_string);
18702 /*FALLTHROUGH*/
18703 case VAR_STRING:
18704 vim_free(varp->vval.v_string);
18705 break;
18706 case VAR_LIST:
18707 list_unref(varp->vval.v_list);
18708 break;
18709 case VAR_DICT:
18710 dict_unref(varp->vval.v_dict);
18711 break;
18712 case VAR_NUMBER:
18713 #ifdef FEAT_FLOAT
18714 case VAR_FLOAT:
18715 #endif
18716 case VAR_UNKNOWN:
18717 break;
18718 default:
18719 EMSG2(_(e_intern2), "free_tv()");
18720 break;
18722 vim_free(varp);
18727 * Free the memory for a variable value and set the value to NULL or 0.
18729 void
18730 clear_tv(varp)
18731 typval_T *varp;
18733 if (varp != NULL)
18735 switch (varp->v_type)
18737 case VAR_FUNC:
18738 func_unref(varp->vval.v_string);
18739 /*FALLTHROUGH*/
18740 case VAR_STRING:
18741 vim_free(varp->vval.v_string);
18742 varp->vval.v_string = NULL;
18743 break;
18744 case VAR_LIST:
18745 list_unref(varp->vval.v_list);
18746 varp->vval.v_list = NULL;
18747 break;
18748 case VAR_DICT:
18749 dict_unref(varp->vval.v_dict);
18750 varp->vval.v_dict = NULL;
18751 break;
18752 case VAR_NUMBER:
18753 varp->vval.v_number = 0;
18754 break;
18755 #ifdef FEAT_FLOAT
18756 case VAR_FLOAT:
18757 varp->vval.v_float = 0.0;
18758 break;
18759 #endif
18760 case VAR_UNKNOWN:
18761 break;
18762 default:
18763 EMSG2(_(e_intern2), "clear_tv()");
18765 varp->v_lock = 0;
18770 * Set the value of a variable to NULL without freeing items.
18772 static void
18773 init_tv(varp)
18774 typval_T *varp;
18776 if (varp != NULL)
18777 vim_memset(varp, 0, sizeof(typval_T));
18781 * Get the number value of a variable.
18782 * If it is a String variable, uses vim_str2nr().
18783 * For incompatible types, return 0.
18784 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18785 * caller of incompatible types: it sets *denote to TRUE if "denote"
18786 * is not NULL or returns -1 otherwise.
18788 static long
18789 get_tv_number(varp)
18790 typval_T *varp;
18792 int error = FALSE;
18794 return get_tv_number_chk(varp, &error); /* return 0L on error */
18797 long
18798 get_tv_number_chk(varp, denote)
18799 typval_T *varp;
18800 int *denote;
18802 long n = 0L;
18804 switch (varp->v_type)
18806 case VAR_NUMBER:
18807 return (long)(varp->vval.v_number);
18808 #ifdef FEAT_FLOAT
18809 case VAR_FLOAT:
18810 EMSG(_("E805: Using a Float as a Number"));
18811 break;
18812 #endif
18813 case VAR_FUNC:
18814 EMSG(_("E703: Using a Funcref as a Number"));
18815 break;
18816 case VAR_STRING:
18817 if (varp->vval.v_string != NULL)
18818 vim_str2nr(varp->vval.v_string, NULL, NULL,
18819 TRUE, TRUE, &n, NULL);
18820 return n;
18821 case VAR_LIST:
18822 EMSG(_("E745: Using a List as a Number"));
18823 break;
18824 case VAR_DICT:
18825 EMSG(_("E728: Using a Dictionary as a Number"));
18826 break;
18827 default:
18828 EMSG2(_(e_intern2), "get_tv_number()");
18829 break;
18831 if (denote == NULL) /* useful for values that must be unsigned */
18832 n = -1;
18833 else
18834 *denote = TRUE;
18835 return n;
18839 * Get the lnum from the first argument.
18840 * Also accepts ".", "$", etc., but that only works for the current buffer.
18841 * Returns -1 on error.
18843 static linenr_T
18844 get_tv_lnum(argvars)
18845 typval_T *argvars;
18847 typval_T rettv;
18848 linenr_T lnum;
18850 lnum = get_tv_number_chk(&argvars[0], NULL);
18851 if (lnum == 0) /* no valid number, try using line() */
18853 rettv.v_type = VAR_NUMBER;
18854 f_line(argvars, &rettv);
18855 lnum = rettv.vval.v_number;
18856 clear_tv(&rettv);
18858 return lnum;
18862 * Get the lnum from the first argument.
18863 * Also accepts "$", then "buf" is used.
18864 * Returns 0 on error.
18866 static linenr_T
18867 get_tv_lnum_buf(argvars, buf)
18868 typval_T *argvars;
18869 buf_T *buf;
18871 if (argvars[0].v_type == VAR_STRING
18872 && argvars[0].vval.v_string != NULL
18873 && argvars[0].vval.v_string[0] == '$'
18874 && buf != NULL)
18875 return buf->b_ml.ml_line_count;
18876 return get_tv_number_chk(&argvars[0], NULL);
18880 * Get the string value of a variable.
18881 * If it is a Number variable, the number is converted into a string.
18882 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18883 * get_tv_string_buf() uses a given buffer.
18884 * If the String variable has never been set, return an empty string.
18885 * Never returns NULL;
18886 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18887 * NULL on error.
18889 static char_u *
18890 get_tv_string(varp)
18891 typval_T *varp;
18893 static char_u mybuf[NUMBUFLEN];
18895 return get_tv_string_buf(varp, mybuf);
18898 static char_u *
18899 get_tv_string_buf(varp, buf)
18900 typval_T *varp;
18901 char_u *buf;
18903 char_u *res = get_tv_string_buf_chk(varp, buf);
18905 return res != NULL ? res : (char_u *)"";
18908 char_u *
18909 get_tv_string_chk(varp)
18910 typval_T *varp;
18912 static char_u mybuf[NUMBUFLEN];
18914 return get_tv_string_buf_chk(varp, mybuf);
18917 static char_u *
18918 get_tv_string_buf_chk(varp, buf)
18919 typval_T *varp;
18920 char_u *buf;
18922 switch (varp->v_type)
18924 case VAR_NUMBER:
18925 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18926 return buf;
18927 case VAR_FUNC:
18928 EMSG(_("E729: using Funcref as a String"));
18929 break;
18930 case VAR_LIST:
18931 EMSG(_("E730: using List as a String"));
18932 break;
18933 case VAR_DICT:
18934 EMSG(_("E731: using Dictionary as a String"));
18935 break;
18936 #ifdef FEAT_FLOAT
18937 case VAR_FLOAT:
18938 EMSG(_("E806: using Float as a String"));
18939 break;
18940 #endif
18941 case VAR_STRING:
18942 if (varp->vval.v_string != NULL)
18943 return varp->vval.v_string;
18944 return (char_u *)"";
18945 default:
18946 EMSG2(_(e_intern2), "get_tv_string_buf()");
18947 break;
18949 return NULL;
18953 * Find variable "name" in the list of variables.
18954 * Return a pointer to it if found, NULL if not found.
18955 * Careful: "a:0" variables don't have a name.
18956 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18957 * hashtab_T used.
18959 static dictitem_T *
18960 find_var(name, htp)
18961 char_u *name;
18962 hashtab_T **htp;
18964 char_u *varname;
18965 hashtab_T *ht;
18967 ht = find_var_ht(name, &varname);
18968 if (htp != NULL)
18969 *htp = ht;
18970 if (ht == NULL)
18971 return NULL;
18972 return find_var_in_ht(ht, varname, htp != NULL);
18976 * Find variable "varname" in hashtab "ht".
18977 * Returns NULL if not found.
18979 static dictitem_T *
18980 find_var_in_ht(ht, varname, writing)
18981 hashtab_T *ht;
18982 char_u *varname;
18983 int writing;
18985 hashitem_T *hi;
18987 if (*varname == NUL)
18989 /* Must be something like "s:", otherwise "ht" would be NULL. */
18990 switch (varname[-2])
18992 case 's': return &SCRIPT_SV(current_SID).sv_var;
18993 case 'g': return &globvars_var;
18994 case 'v': return &vimvars_var;
18995 case 'b': return &curbuf->b_bufvar;
18996 case 'w': return &curwin->w_winvar;
18997 #ifdef FEAT_WINDOWS
18998 case 't': return &curtab->tp_winvar;
18999 #endif
19000 case 'l': return current_funccal == NULL
19001 ? NULL : &current_funccal->l_vars_var;
19002 case 'a': return current_funccal == NULL
19003 ? NULL : &current_funccal->l_avars_var;
19005 return NULL;
19008 hi = hash_find(ht, varname);
19009 if (HASHITEM_EMPTY(hi))
19011 /* For global variables we may try auto-loading the script. If it
19012 * worked find the variable again. Don't auto-load a script if it was
19013 * loaded already, otherwise it would be loaded every time when
19014 * checking if a function name is a Funcref variable. */
19015 if (ht == &globvarht && !writing
19016 && script_autoload(varname, FALSE) && !aborting())
19017 hi = hash_find(ht, varname);
19018 if (HASHITEM_EMPTY(hi))
19019 return NULL;
19021 return HI2DI(hi);
19025 * Find the hashtab used for a variable name.
19026 * Set "varname" to the start of name without ':'.
19028 static hashtab_T *
19029 find_var_ht(name, varname)
19030 char_u *name;
19031 char_u **varname;
19033 hashitem_T *hi;
19035 if (name[1] != ':')
19037 /* The name must not start with a colon or #. */
19038 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
19039 return NULL;
19040 *varname = name;
19042 /* "version" is "v:version" in all scopes */
19043 hi = hash_find(&compat_hashtab, name);
19044 if (!HASHITEM_EMPTY(hi))
19045 return &compat_hashtab;
19047 if (current_funccal == NULL)
19048 return &globvarht; /* global variable */
19049 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
19051 *varname = name + 2;
19052 if (*name == 'g') /* global variable */
19053 return &globvarht;
19054 /* There must be no ':' or '#' in the rest of the name, unless g: is used
19056 if (vim_strchr(name + 2, ':') != NULL
19057 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
19058 return NULL;
19059 if (*name == 'b') /* buffer variable */
19060 return &curbuf->b_vars.dv_hashtab;
19061 if (*name == 'w') /* window variable */
19062 return &curwin->w_vars.dv_hashtab;
19063 #ifdef FEAT_WINDOWS
19064 if (*name == 't') /* tab page variable */
19065 return &curtab->tp_vars.dv_hashtab;
19066 #endif
19067 if (*name == 'v') /* v: variable */
19068 return &vimvarht;
19069 if (*name == 'a' && current_funccal != NULL) /* function argument */
19070 return &current_funccal->l_avars.dv_hashtab;
19071 if (*name == 'l' && current_funccal != NULL) /* local function variable */
19072 return &current_funccal->l_vars.dv_hashtab;
19073 if (*name == 's' /* script variable */
19074 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
19075 return &SCRIPT_VARS(current_SID);
19076 return NULL;
19080 * Get the string value of a (global/local) variable.
19081 * Returns NULL when it doesn't exist.
19083 char_u *
19084 get_var_value(name)
19085 char_u *name;
19087 dictitem_T *v;
19089 v = find_var(name, NULL);
19090 if (v == NULL)
19091 return NULL;
19092 return get_tv_string(&v->di_tv);
19096 * Allocate a new hashtab for a sourced script. It will be used while
19097 * sourcing this script and when executing functions defined in the script.
19099 void
19100 new_script_vars(id)
19101 scid_T id;
19103 int i;
19104 hashtab_T *ht;
19105 scriptvar_T *sv;
19107 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
19109 /* Re-allocating ga_data means that an ht_array pointing to
19110 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
19111 * at its init value. Also reset "v_dict", it's always the same. */
19112 for (i = 1; i <= ga_scripts.ga_len; ++i)
19114 ht = &SCRIPT_VARS(i);
19115 if (ht->ht_mask == HT_INIT_SIZE - 1)
19116 ht->ht_array = ht->ht_smallarray;
19117 sv = &SCRIPT_SV(i);
19118 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
19121 while (ga_scripts.ga_len < id)
19123 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
19124 init_var_dict(&sv->sv_dict, &sv->sv_var);
19125 ++ga_scripts.ga_len;
19131 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
19132 * point to it.
19134 void
19135 init_var_dict(dict, dict_var)
19136 dict_T *dict;
19137 dictitem_T *dict_var;
19139 hash_init(&dict->dv_hashtab);
19140 dict->dv_refcount = 99999;
19141 dict_var->di_tv.vval.v_dict = dict;
19142 dict_var->di_tv.v_type = VAR_DICT;
19143 dict_var->di_tv.v_lock = VAR_FIXED;
19144 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
19145 dict_var->di_key[0] = NUL;
19149 * Clean up a list of internal variables.
19150 * Frees all allocated variables and the value they contain.
19151 * Clears hashtab "ht", does not free it.
19153 void
19154 vars_clear(ht)
19155 hashtab_T *ht;
19157 vars_clear_ext(ht, TRUE);
19161 * Like vars_clear(), but only free the value if "free_val" is TRUE.
19163 static void
19164 vars_clear_ext(ht, free_val)
19165 hashtab_T *ht;
19166 int free_val;
19168 int todo;
19169 hashitem_T *hi;
19170 dictitem_T *v;
19172 hash_lock(ht);
19173 todo = (int)ht->ht_used;
19174 for (hi = ht->ht_array; todo > 0; ++hi)
19176 if (!HASHITEM_EMPTY(hi))
19178 --todo;
19180 /* Free the variable. Don't remove it from the hashtab,
19181 * ht_array might change then. hash_clear() takes care of it
19182 * later. */
19183 v = HI2DI(hi);
19184 if (free_val)
19185 clear_tv(&v->di_tv);
19186 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19187 vim_free(v);
19190 hash_clear(ht);
19191 ht->ht_used = 0;
19195 * Delete a variable from hashtab "ht" at item "hi".
19196 * Clear the variable value and free the dictitem.
19198 static void
19199 delete_var(ht, hi)
19200 hashtab_T *ht;
19201 hashitem_T *hi;
19203 dictitem_T *di = HI2DI(hi);
19205 hash_remove(ht, hi);
19206 clear_tv(&di->di_tv);
19207 vim_free(di);
19211 * List the value of one internal variable.
19213 static void
19214 list_one_var(v, prefix, first)
19215 dictitem_T *v;
19216 char_u *prefix;
19217 int *first;
19219 char_u *tofree;
19220 char_u *s;
19221 char_u numbuf[NUMBUFLEN];
19223 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
19224 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19225 s == NULL ? (char_u *)"" : s, first);
19226 vim_free(tofree);
19229 static void
19230 list_one_var_a(prefix, name, type, string, first)
19231 char_u *prefix;
19232 char_u *name;
19233 int type;
19234 char_u *string;
19235 int *first; /* when TRUE clear rest of screen and set to FALSE */
19237 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19238 msg_start();
19239 msg_puts(prefix);
19240 if (name != NULL) /* "a:" vars don't have a name stored */
19241 msg_puts(name);
19242 msg_putchar(' ');
19243 msg_advance(22);
19244 if (type == VAR_NUMBER)
19245 msg_putchar('#');
19246 else if (type == VAR_FUNC)
19247 msg_putchar('*');
19248 else if (type == VAR_LIST)
19250 msg_putchar('[');
19251 if (*string == '[')
19252 ++string;
19254 else if (type == VAR_DICT)
19256 msg_putchar('{');
19257 if (*string == '{')
19258 ++string;
19260 else
19261 msg_putchar(' ');
19263 msg_outtrans(string);
19265 if (type == VAR_FUNC)
19266 msg_puts((char_u *)"()");
19267 if (*first)
19269 msg_clr_eos();
19270 *first = FALSE;
19275 * Set variable "name" to value in "tv".
19276 * If the variable already exists, the value is updated.
19277 * Otherwise the variable is created.
19279 static void
19280 set_var(name, tv, copy)
19281 char_u *name;
19282 typval_T *tv;
19283 int copy; /* make copy of value in "tv" */
19285 dictitem_T *v;
19286 char_u *varname;
19287 hashtab_T *ht;
19288 char_u *p;
19290 if (tv->v_type == VAR_FUNC)
19292 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19293 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19294 ? name[2] : name[0]))
19296 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19297 return;
19299 if (function_exists(name))
19301 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19302 name);
19303 return;
19307 ht = find_var_ht(name, &varname);
19308 if (ht == NULL || *varname == NUL)
19310 EMSG2(_(e_illvar), name);
19311 return;
19314 v = find_var_in_ht(ht, varname, TRUE);
19315 if (v != NULL)
19317 /* existing variable, need to clear the value */
19318 if (var_check_ro(v->di_flags, name)
19319 || tv_check_lock(v->di_tv.v_lock, name))
19320 return;
19321 if (v->di_tv.v_type != tv->v_type
19322 && !((v->di_tv.v_type == VAR_STRING
19323 || v->di_tv.v_type == VAR_NUMBER)
19324 && (tv->v_type == VAR_STRING
19325 || tv->v_type == VAR_NUMBER))
19326 #ifdef FEAT_FLOAT
19327 && !((v->di_tv.v_type == VAR_NUMBER
19328 || v->di_tv.v_type == VAR_FLOAT)
19329 && (tv->v_type == VAR_NUMBER
19330 || tv->v_type == VAR_FLOAT))
19331 #endif
19334 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19335 return;
19339 * Handle setting internal v: variables separately: we don't change
19340 * the type.
19342 if (ht == &vimvarht)
19344 if (v->di_tv.v_type == VAR_STRING)
19346 vim_free(v->di_tv.vval.v_string);
19347 if (copy || tv->v_type != VAR_STRING)
19348 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19349 else
19351 /* Take over the string to avoid an extra alloc/free. */
19352 v->di_tv.vval.v_string = tv->vval.v_string;
19353 tv->vval.v_string = NULL;
19356 else if (v->di_tv.v_type != VAR_NUMBER)
19357 EMSG2(_(e_intern2), "set_var()");
19358 else
19360 v->di_tv.vval.v_number = get_tv_number(tv);
19361 if (STRCMP(varname, "searchforward") == 0)
19362 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19364 return;
19367 clear_tv(&v->di_tv);
19369 else /* add a new variable */
19371 /* Can't add "v:" variable. */
19372 if (ht == &vimvarht)
19374 EMSG2(_(e_illvar), name);
19375 return;
19378 /* Make sure the variable name is valid. */
19379 for (p = varname; *p != NUL; ++p)
19380 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19381 && *p != AUTOLOAD_CHAR)
19383 EMSG2(_(e_illvar), varname);
19384 return;
19387 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19388 + STRLEN(varname)));
19389 if (v == NULL)
19390 return;
19391 STRCPY(v->di_key, varname);
19392 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19394 vim_free(v);
19395 return;
19397 v->di_flags = 0;
19400 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19401 copy_tv(tv, &v->di_tv);
19402 else
19404 v->di_tv = *tv;
19405 v->di_tv.v_lock = 0;
19406 init_tv(tv);
19411 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19412 * Also give an error message.
19414 static int
19415 var_check_ro(flags, name)
19416 int flags;
19417 char_u *name;
19419 if (flags & DI_FLAGS_RO)
19421 EMSG2(_(e_readonlyvar), name);
19422 return TRUE;
19424 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19426 EMSG2(_(e_readonlysbx), name);
19427 return TRUE;
19429 return FALSE;
19433 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19434 * Also give an error message.
19436 static int
19437 var_check_fixed(flags, name)
19438 int flags;
19439 char_u *name;
19441 if (flags & DI_FLAGS_FIX)
19443 EMSG2(_("E795: Cannot delete variable %s"), name);
19444 return TRUE;
19446 return FALSE;
19450 * Return TRUE if typeval "tv" is set to be locked (immutable).
19451 * Also give an error message, using "name".
19453 static int
19454 tv_check_lock(lock, name)
19455 int lock;
19456 char_u *name;
19458 if (lock & VAR_LOCKED)
19460 EMSG2(_("E741: Value is locked: %s"),
19461 name == NULL ? (char_u *)_("Unknown") : name);
19462 return TRUE;
19464 if (lock & VAR_FIXED)
19466 EMSG2(_("E742: Cannot change value of %s"),
19467 name == NULL ? (char_u *)_("Unknown") : name);
19468 return TRUE;
19470 return FALSE;
19474 * Copy the values from typval_T "from" to typval_T "to".
19475 * When needed allocates string or increases reference count.
19476 * Does not make a copy of a list or dict but copies the reference!
19478 static void
19479 copy_tv(from, to)
19480 typval_T *from;
19481 typval_T *to;
19483 to->v_type = from->v_type;
19484 to->v_lock = 0;
19485 switch (from->v_type)
19487 case VAR_NUMBER:
19488 to->vval.v_number = from->vval.v_number;
19489 break;
19490 #ifdef FEAT_FLOAT
19491 case VAR_FLOAT:
19492 to->vval.v_float = from->vval.v_float;
19493 break;
19494 #endif
19495 case VAR_STRING:
19496 case VAR_FUNC:
19497 if (from->vval.v_string == NULL)
19498 to->vval.v_string = NULL;
19499 else
19501 to->vval.v_string = vim_strsave(from->vval.v_string);
19502 if (from->v_type == VAR_FUNC)
19503 func_ref(to->vval.v_string);
19505 break;
19506 case VAR_LIST:
19507 if (from->vval.v_list == NULL)
19508 to->vval.v_list = NULL;
19509 else
19511 to->vval.v_list = from->vval.v_list;
19512 ++to->vval.v_list->lv_refcount;
19514 break;
19515 case VAR_DICT:
19516 if (from->vval.v_dict == NULL)
19517 to->vval.v_dict = NULL;
19518 else
19520 to->vval.v_dict = from->vval.v_dict;
19521 ++to->vval.v_dict->dv_refcount;
19523 break;
19524 default:
19525 EMSG2(_(e_intern2), "copy_tv()");
19526 break;
19531 * Make a copy of an item.
19532 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19533 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19534 * reference to an already copied list/dict can be used.
19535 * Returns FAIL or OK.
19537 static int
19538 item_copy(from, to, deep, copyID)
19539 typval_T *from;
19540 typval_T *to;
19541 int deep;
19542 int copyID;
19544 static int recurse = 0;
19545 int ret = OK;
19547 if (recurse >= DICT_MAXNEST)
19549 EMSG(_("E698: variable nested too deep for making a copy"));
19550 return FAIL;
19552 ++recurse;
19554 switch (from->v_type)
19556 case VAR_NUMBER:
19557 #ifdef FEAT_FLOAT
19558 case VAR_FLOAT:
19559 #endif
19560 case VAR_STRING:
19561 case VAR_FUNC:
19562 copy_tv(from, to);
19563 break;
19564 case VAR_LIST:
19565 to->v_type = VAR_LIST;
19566 to->v_lock = 0;
19567 if (from->vval.v_list == NULL)
19568 to->vval.v_list = NULL;
19569 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19571 /* use the copy made earlier */
19572 to->vval.v_list = from->vval.v_list->lv_copylist;
19573 ++to->vval.v_list->lv_refcount;
19575 else
19576 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19577 if (to->vval.v_list == NULL)
19578 ret = FAIL;
19579 break;
19580 case VAR_DICT:
19581 to->v_type = VAR_DICT;
19582 to->v_lock = 0;
19583 if (from->vval.v_dict == NULL)
19584 to->vval.v_dict = NULL;
19585 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19587 /* use the copy made earlier */
19588 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19589 ++to->vval.v_dict->dv_refcount;
19591 else
19592 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19593 if (to->vval.v_dict == NULL)
19594 ret = FAIL;
19595 break;
19596 default:
19597 EMSG2(_(e_intern2), "item_copy()");
19598 ret = FAIL;
19600 --recurse;
19601 return ret;
19605 * ":echo expr1 ..." print each argument separated with a space, add a
19606 * newline at the end.
19607 * ":echon expr1 ..." print each argument plain.
19609 void
19610 ex_echo(eap)
19611 exarg_T *eap;
19613 char_u *arg = eap->arg;
19614 typval_T rettv;
19615 char_u *tofree;
19616 char_u *p;
19617 int needclr = TRUE;
19618 int atstart = TRUE;
19619 char_u numbuf[NUMBUFLEN];
19621 if (eap->skip)
19622 ++emsg_skip;
19623 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19625 /* If eval1() causes an error message the text from the command may
19626 * still need to be cleared. E.g., "echo 22,44". */
19627 need_clr_eos = needclr;
19629 p = arg;
19630 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19633 * Report the invalid expression unless the expression evaluation
19634 * has been cancelled due to an aborting error, an interrupt, or an
19635 * exception.
19637 if (!aborting())
19638 EMSG2(_(e_invexpr2), p);
19639 need_clr_eos = FALSE;
19640 break;
19642 need_clr_eos = FALSE;
19644 if (!eap->skip)
19646 if (atstart)
19648 atstart = FALSE;
19649 /* Call msg_start() after eval1(), evaluating the expression
19650 * may cause a message to appear. */
19651 if (eap->cmdidx == CMD_echo)
19652 msg_start();
19654 else if (eap->cmdidx == CMD_echo)
19655 msg_puts_attr((char_u *)" ", echo_attr);
19656 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19657 if (p != NULL)
19658 for ( ; *p != NUL && !got_int; ++p)
19660 if (*p == '\n' || *p == '\r' || *p == TAB)
19662 if (*p != TAB && needclr)
19664 /* remove any text still there from the command */
19665 msg_clr_eos();
19666 needclr = FALSE;
19668 msg_putchar_attr(*p, echo_attr);
19670 else
19672 #ifdef FEAT_MBYTE
19673 if (has_mbyte)
19675 int i = (*mb_ptr2len)(p);
19677 (void)msg_outtrans_len_attr(p, i, echo_attr);
19678 p += i - 1;
19680 else
19681 #endif
19682 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19685 vim_free(tofree);
19687 clear_tv(&rettv);
19688 arg = skipwhite(arg);
19690 eap->nextcmd = check_nextcmd(arg);
19692 if (eap->skip)
19693 --emsg_skip;
19694 else
19696 /* remove text that may still be there from the command */
19697 if (needclr)
19698 msg_clr_eos();
19699 if (eap->cmdidx == CMD_echo)
19700 msg_end();
19705 * ":echohl {name}".
19707 void
19708 ex_echohl(eap)
19709 exarg_T *eap;
19711 int id;
19713 id = syn_name2id(eap->arg);
19714 if (id == 0)
19715 echo_attr = 0;
19716 else
19717 echo_attr = syn_id2attr(id);
19721 * ":execute expr1 ..." execute the result of an expression.
19722 * ":echomsg expr1 ..." Print a message
19723 * ":echoerr expr1 ..." Print an error
19724 * Each gets spaces around each argument and a newline at the end for
19725 * echo commands
19727 void
19728 ex_execute(eap)
19729 exarg_T *eap;
19731 char_u *arg = eap->arg;
19732 typval_T rettv;
19733 int ret = OK;
19734 char_u *p;
19735 garray_T ga;
19736 int len;
19737 int save_did_emsg;
19739 ga_init2(&ga, 1, 80);
19741 if (eap->skip)
19742 ++emsg_skip;
19743 while (*arg != NUL && *arg != '|' && *arg != '\n')
19745 p = arg;
19746 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19749 * Report the invalid expression unless the expression evaluation
19750 * has been cancelled due to an aborting error, an interrupt, or an
19751 * exception.
19753 if (!aborting())
19754 EMSG2(_(e_invexpr2), p);
19755 ret = FAIL;
19756 break;
19759 if (!eap->skip)
19761 p = get_tv_string(&rettv);
19762 len = (int)STRLEN(p);
19763 if (ga_grow(&ga, len + 2) == FAIL)
19765 clear_tv(&rettv);
19766 ret = FAIL;
19767 break;
19769 if (ga.ga_len)
19770 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19771 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19772 ga.ga_len += len;
19775 clear_tv(&rettv);
19776 arg = skipwhite(arg);
19779 if (ret != FAIL && ga.ga_data != NULL)
19781 if (eap->cmdidx == CMD_echomsg)
19783 MSG_ATTR(ga.ga_data, echo_attr);
19784 out_flush();
19786 else if (eap->cmdidx == CMD_echoerr)
19788 /* We don't want to abort following commands, restore did_emsg. */
19789 save_did_emsg = did_emsg;
19790 EMSG((char_u *)ga.ga_data);
19791 if (!force_abort)
19792 did_emsg = save_did_emsg;
19794 else if (eap->cmdidx == CMD_execute)
19795 do_cmdline((char_u *)ga.ga_data,
19796 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19799 ga_clear(&ga);
19801 if (eap->skip)
19802 --emsg_skip;
19804 eap->nextcmd = check_nextcmd(arg);
19808 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19809 * "arg" points to the "&" or '+' when called, to "option" when returning.
19810 * Returns NULL when no option name found. Otherwise pointer to the char
19811 * after the option name.
19813 static char_u *
19814 find_option_end(arg, opt_flags)
19815 char_u **arg;
19816 int *opt_flags;
19818 char_u *p = *arg;
19820 ++p;
19821 if (*p == 'g' && p[1] == ':')
19823 *opt_flags = OPT_GLOBAL;
19824 p += 2;
19826 else if (*p == 'l' && p[1] == ':')
19828 *opt_flags = OPT_LOCAL;
19829 p += 2;
19831 else
19832 *opt_flags = 0;
19834 if (!ASCII_ISALPHA(*p))
19835 return NULL;
19836 *arg = p;
19838 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19839 p += 4; /* termcap option */
19840 else
19841 while (ASCII_ISALPHA(*p))
19842 ++p;
19843 return p;
19847 * ":function"
19849 void
19850 ex_function(eap)
19851 exarg_T *eap;
19853 char_u *theline;
19854 int j;
19855 int c;
19856 int saved_did_emsg;
19857 char_u *name = NULL;
19858 char_u *p;
19859 char_u *arg;
19860 char_u *line_arg = NULL;
19861 garray_T newargs;
19862 garray_T newlines;
19863 int varargs = FALSE;
19864 int mustend = FALSE;
19865 int flags = 0;
19866 ufunc_T *fp;
19867 int indent;
19868 int nesting;
19869 char_u *skip_until = NULL;
19870 dictitem_T *v;
19871 funcdict_T fudi;
19872 static int func_nr = 0; /* number for nameless function */
19873 int paren;
19874 hashtab_T *ht;
19875 int todo;
19876 hashitem_T *hi;
19877 int sourcing_lnum_off;
19880 * ":function" without argument: list functions.
19882 if (ends_excmd(*eap->arg))
19884 if (!eap->skip)
19886 todo = (int)func_hashtab.ht_used;
19887 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19889 if (!HASHITEM_EMPTY(hi))
19891 --todo;
19892 fp = HI2UF(hi);
19893 if (!isdigit(*fp->uf_name))
19894 list_func_head(fp, FALSE);
19898 eap->nextcmd = check_nextcmd(eap->arg);
19899 return;
19903 * ":function /pat": list functions matching pattern.
19905 if (*eap->arg == '/')
19907 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19908 if (!eap->skip)
19910 regmatch_T regmatch;
19912 c = *p;
19913 *p = NUL;
19914 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19915 *p = c;
19916 if (regmatch.regprog != NULL)
19918 regmatch.rm_ic = p_ic;
19920 todo = (int)func_hashtab.ht_used;
19921 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19923 if (!HASHITEM_EMPTY(hi))
19925 --todo;
19926 fp = HI2UF(hi);
19927 if (!isdigit(*fp->uf_name)
19928 && vim_regexec(&regmatch, fp->uf_name, 0))
19929 list_func_head(fp, FALSE);
19934 if (*p == '/')
19935 ++p;
19936 eap->nextcmd = check_nextcmd(p);
19937 return;
19941 * Get the function name. There are these situations:
19942 * func normal function name
19943 * "name" == func, "fudi.fd_dict" == NULL
19944 * dict.func new dictionary entry
19945 * "name" == NULL, "fudi.fd_dict" set,
19946 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19947 * dict.func existing dict entry with a Funcref
19948 * "name" == func, "fudi.fd_dict" set,
19949 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19950 * dict.func existing dict entry that's not a Funcref
19951 * "name" == NULL, "fudi.fd_dict" set,
19952 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19954 p = eap->arg;
19955 name = trans_function_name(&p, eap->skip, 0, &fudi);
19956 paren = (vim_strchr(p, '(') != NULL);
19957 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19960 * Return on an invalid expression in braces, unless the expression
19961 * evaluation has been cancelled due to an aborting error, an
19962 * interrupt, or an exception.
19964 if (!aborting())
19966 if (!eap->skip && fudi.fd_newkey != NULL)
19967 EMSG2(_(e_dictkey), fudi.fd_newkey);
19968 vim_free(fudi.fd_newkey);
19969 return;
19971 else
19972 eap->skip = TRUE;
19975 /* An error in a function call during evaluation of an expression in magic
19976 * braces should not cause the function not to be defined. */
19977 saved_did_emsg = did_emsg;
19978 did_emsg = FALSE;
19981 * ":function func" with only function name: list function.
19983 if (!paren)
19985 if (!ends_excmd(*skipwhite(p)))
19987 EMSG(_(e_trailing));
19988 goto ret_free;
19990 eap->nextcmd = check_nextcmd(p);
19991 if (eap->nextcmd != NULL)
19992 *p = NUL;
19993 if (!eap->skip && !got_int)
19995 fp = find_func(name);
19996 if (fp != NULL)
19998 list_func_head(fp, TRUE);
19999 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
20001 if (FUNCLINE(fp, j) == NULL)
20002 continue;
20003 msg_putchar('\n');
20004 msg_outnum((long)(j + 1));
20005 if (j < 9)
20006 msg_putchar(' ');
20007 if (j < 99)
20008 msg_putchar(' ');
20009 msg_prt_line(FUNCLINE(fp, j), FALSE);
20010 out_flush(); /* show a line at a time */
20011 ui_breakcheck();
20013 if (!got_int)
20015 msg_putchar('\n');
20016 msg_puts((char_u *)" endfunction");
20019 else
20020 emsg_funcname("E123: Undefined function: %s", name);
20022 goto ret_free;
20026 * ":function name(arg1, arg2)" Define function.
20028 p = skipwhite(p);
20029 if (*p != '(')
20031 if (!eap->skip)
20033 EMSG2(_("E124: Missing '(': %s"), eap->arg);
20034 goto ret_free;
20036 /* attempt to continue by skipping some text */
20037 if (vim_strchr(p, '(') != NULL)
20038 p = vim_strchr(p, '(');
20040 p = skipwhite(p + 1);
20042 ga_init2(&newargs, (int)sizeof(char_u *), 3);
20043 ga_init2(&newlines, (int)sizeof(char_u *), 3);
20045 if (!eap->skip)
20047 /* Check the name of the function. Unless it's a dictionary function
20048 * (that we are overwriting). */
20049 if (name != NULL)
20050 arg = name;
20051 else
20052 arg = fudi.fd_newkey;
20053 if (arg != NULL && (fudi.fd_di == NULL
20054 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
20056 if (*arg == K_SPECIAL)
20057 j = 3;
20058 else
20059 j = 0;
20060 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
20061 : eval_isnamec(arg[j])))
20062 ++j;
20063 if (arg[j] != NUL)
20064 emsg_funcname(_(e_invarg2), arg);
20069 * Isolate the arguments: "arg1, arg2, ...)"
20071 while (*p != ')')
20073 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
20075 varargs = TRUE;
20076 p += 3;
20077 mustend = TRUE;
20079 else
20081 arg = p;
20082 while (ASCII_ISALNUM(*p) || *p == '_')
20083 ++p;
20084 if (arg == p || isdigit(*arg)
20085 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
20086 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
20088 if (!eap->skip)
20089 EMSG2(_("E125: Illegal argument: %s"), arg);
20090 break;
20092 if (ga_grow(&newargs, 1) == FAIL)
20093 goto erret;
20094 c = *p;
20095 *p = NUL;
20096 arg = vim_strsave(arg);
20097 if (arg == NULL)
20098 goto erret;
20099 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
20100 *p = c;
20101 newargs.ga_len++;
20102 if (*p == ',')
20103 ++p;
20104 else
20105 mustend = TRUE;
20107 p = skipwhite(p);
20108 if (mustend && *p != ')')
20110 if (!eap->skip)
20111 EMSG2(_(e_invarg2), eap->arg);
20112 break;
20115 ++p; /* skip the ')' */
20117 /* find extra arguments "range", "dict" and "abort" */
20118 for (;;)
20120 p = skipwhite(p);
20121 if (STRNCMP(p, "range", 5) == 0)
20123 flags |= FC_RANGE;
20124 p += 5;
20126 else if (STRNCMP(p, "dict", 4) == 0)
20128 flags |= FC_DICT;
20129 p += 4;
20131 else if (STRNCMP(p, "abort", 5) == 0)
20133 flags |= FC_ABORT;
20134 p += 5;
20136 else
20137 break;
20140 /* When there is a line break use what follows for the function body.
20141 * Makes 'exe "func Test()\n...\nendfunc"' work. */
20142 if (*p == '\n')
20143 line_arg = p + 1;
20144 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
20145 EMSG(_(e_trailing));
20148 * Read the body of the function, until ":endfunction" is found.
20150 if (KeyTyped)
20152 /* Check if the function already exists, don't let the user type the
20153 * whole function before telling him it doesn't work! For a script we
20154 * need to skip the body to be able to find what follows. */
20155 if (!eap->skip && !eap->forceit)
20157 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20158 EMSG(_(e_funcdict));
20159 else if (name != NULL && find_func(name) != NULL)
20160 emsg_funcname(e_funcexts, name);
20163 if (!eap->skip && did_emsg)
20164 goto erret;
20166 msg_putchar('\n'); /* don't overwrite the function name */
20167 cmdline_row = msg_row;
20170 indent = 2;
20171 nesting = 0;
20172 for (;;)
20174 msg_scroll = TRUE;
20175 need_wait_return = FALSE;
20176 sourcing_lnum_off = sourcing_lnum;
20178 if (line_arg != NULL)
20180 /* Use eap->arg, split up in parts by line breaks. */
20181 theline = line_arg;
20182 p = vim_strchr(theline, '\n');
20183 if (p == NULL)
20184 line_arg += STRLEN(line_arg);
20185 else
20187 *p = NUL;
20188 line_arg = p + 1;
20191 else if (eap->getline == NULL)
20192 theline = getcmdline(':', 0L, indent);
20193 else
20194 theline = eap->getline(':', eap->cookie, indent);
20195 if (KeyTyped)
20196 lines_left = Rows - 1;
20197 if (theline == NULL)
20199 EMSG(_("E126: Missing :endfunction"));
20200 goto erret;
20203 /* Detect line continuation: sourcing_lnum increased more than one. */
20204 if (sourcing_lnum > sourcing_lnum_off + 1)
20205 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20206 else
20207 sourcing_lnum_off = 0;
20209 if (skip_until != NULL)
20211 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20212 * don't check for ":endfunc". */
20213 if (STRCMP(theline, skip_until) == 0)
20215 vim_free(skip_until);
20216 skip_until = NULL;
20219 else
20221 /* skip ':' and blanks*/
20222 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20225 /* Check for "endfunction". */
20226 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20228 if (line_arg == NULL)
20229 vim_free(theline);
20230 break;
20233 /* Increase indent inside "if", "while", "for" and "try", decrease
20234 * at "end". */
20235 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20236 indent -= 2;
20237 else if (STRNCMP(p, "if", 2) == 0
20238 || STRNCMP(p, "wh", 2) == 0
20239 || STRNCMP(p, "for", 3) == 0
20240 || STRNCMP(p, "try", 3) == 0)
20241 indent += 2;
20243 /* Check for defining a function inside this function. */
20244 if (checkforcmd(&p, "function", 2))
20246 if (*p == '!')
20247 p = skipwhite(p + 1);
20248 p += eval_fname_script(p);
20249 if (ASCII_ISALPHA(*p))
20251 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20252 if (*skipwhite(p) == '(')
20254 ++nesting;
20255 indent += 2;
20260 /* Check for ":append" or ":insert". */
20261 p = skip_range(p, NULL);
20262 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20263 || (p[0] == 'i'
20264 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20265 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20266 skip_until = vim_strsave((char_u *)".");
20268 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20269 arg = skipwhite(skiptowhite(p));
20270 if (arg[0] == '<' && arg[1] =='<'
20271 && ((p[0] == 'p' && p[1] == 'y'
20272 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20273 || (p[0] == 'p' && p[1] == 'e'
20274 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20275 || (p[0] == 't' && p[1] == 'c'
20276 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20277 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20278 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20279 || (p[0] == 'm' && p[1] == 'z'
20280 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20283 /* ":python <<" continues until a dot, like ":append" */
20284 p = skipwhite(arg + 2);
20285 if (*p == NUL)
20286 skip_until = vim_strsave((char_u *)".");
20287 else
20288 skip_until = vim_strsave(p);
20292 /* Add the line to the function. */
20293 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20295 if (line_arg == NULL)
20296 vim_free(theline);
20297 goto erret;
20300 /* Copy the line to newly allocated memory. get_one_sourceline()
20301 * allocates 250 bytes per line, this saves 80% on average. The cost
20302 * is an extra alloc/free. */
20303 p = vim_strsave(theline);
20304 if (p != NULL)
20306 if (line_arg == NULL)
20307 vim_free(theline);
20308 theline = p;
20311 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20313 /* Add NULL lines for continuation lines, so that the line count is
20314 * equal to the index in the growarray. */
20315 while (sourcing_lnum_off-- > 0)
20316 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20318 /* Check for end of eap->arg. */
20319 if (line_arg != NULL && *line_arg == NUL)
20320 line_arg = NULL;
20323 /* Don't define the function when skipping commands or when an error was
20324 * detected. */
20325 if (eap->skip || did_emsg)
20326 goto erret;
20329 * If there are no errors, add the function
20331 if (fudi.fd_dict == NULL)
20333 v = find_var(name, &ht);
20334 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20336 emsg_funcname("E707: Function name conflicts with variable: %s",
20337 name);
20338 goto erret;
20341 fp = find_func(name);
20342 if (fp != NULL)
20344 if (!eap->forceit)
20346 emsg_funcname(e_funcexts, name);
20347 goto erret;
20349 if (fp->uf_calls > 0)
20351 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20352 name);
20353 goto erret;
20355 /* redefine existing function */
20356 ga_clear_strings(&(fp->uf_args));
20357 ga_clear_strings(&(fp->uf_lines));
20358 vim_free(name);
20359 name = NULL;
20362 else
20364 char numbuf[20];
20366 fp = NULL;
20367 if (fudi.fd_newkey == NULL && !eap->forceit)
20369 EMSG(_(e_funcdict));
20370 goto erret;
20372 if (fudi.fd_di == NULL)
20374 /* Can't add a function to a locked dictionary */
20375 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20376 goto erret;
20378 /* Can't change an existing function if it is locked */
20379 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20380 goto erret;
20382 /* Give the function a sequential number. Can only be used with a
20383 * Funcref! */
20384 vim_free(name);
20385 sprintf(numbuf, "%d", ++func_nr);
20386 name = vim_strsave((char_u *)numbuf);
20387 if (name == NULL)
20388 goto erret;
20391 if (fp == NULL)
20393 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20395 int slen, plen;
20396 char_u *scriptname;
20398 /* Check that the autoload name matches the script name. */
20399 j = FAIL;
20400 if (sourcing_name != NULL)
20402 scriptname = autoload_name(name);
20403 if (scriptname != NULL)
20405 p = vim_strchr(scriptname, '/');
20406 plen = (int)STRLEN(p);
20407 slen = (int)STRLEN(sourcing_name);
20408 if (slen > plen && fnamecmp(p,
20409 sourcing_name + slen - plen) == 0)
20410 j = OK;
20411 vim_free(scriptname);
20414 if (j == FAIL)
20416 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20417 goto erret;
20421 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20422 if (fp == NULL)
20423 goto erret;
20425 if (fudi.fd_dict != NULL)
20427 if (fudi.fd_di == NULL)
20429 /* add new dict entry */
20430 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20431 if (fudi.fd_di == NULL)
20433 vim_free(fp);
20434 goto erret;
20436 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20438 vim_free(fudi.fd_di);
20439 vim_free(fp);
20440 goto erret;
20443 else
20444 /* overwrite existing dict entry */
20445 clear_tv(&fudi.fd_di->di_tv);
20446 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20447 fudi.fd_di->di_tv.v_lock = 0;
20448 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20449 fp->uf_refcount = 1;
20451 /* behave like "dict" was used */
20452 flags |= FC_DICT;
20455 /* insert the new function in the function list */
20456 STRCPY(fp->uf_name, name);
20457 hash_add(&func_hashtab, UF2HIKEY(fp));
20459 fp->uf_args = newargs;
20460 fp->uf_lines = newlines;
20461 #ifdef FEAT_PROFILE
20462 fp->uf_tml_count = NULL;
20463 fp->uf_tml_total = NULL;
20464 fp->uf_tml_self = NULL;
20465 fp->uf_profiling = FALSE;
20466 if (prof_def_func())
20467 func_do_profile(fp);
20468 #endif
20469 fp->uf_varargs = varargs;
20470 fp->uf_flags = flags;
20471 fp->uf_calls = 0;
20472 fp->uf_script_ID = current_SID;
20473 goto ret_free;
20475 erret:
20476 ga_clear_strings(&newargs);
20477 ga_clear_strings(&newlines);
20478 ret_free:
20479 vim_free(skip_until);
20480 vim_free(fudi.fd_newkey);
20481 vim_free(name);
20482 did_emsg |= saved_did_emsg;
20486 * Get a function name, translating "<SID>" and "<SNR>".
20487 * Also handles a Funcref in a List or Dictionary.
20488 * Returns the function name in allocated memory, or NULL for failure.
20489 * flags:
20490 * TFN_INT: internal function name OK
20491 * TFN_QUIET: be quiet
20492 * Advances "pp" to just after the function name (if no error).
20494 static char_u *
20495 trans_function_name(pp, skip, flags, fdp)
20496 char_u **pp;
20497 int skip; /* only find the end, don't evaluate */
20498 int flags;
20499 funcdict_T *fdp; /* return: info about dictionary used */
20501 char_u *name = NULL;
20502 char_u *start;
20503 char_u *end;
20504 int lead;
20505 char_u sid_buf[20];
20506 int len;
20507 lval_T lv;
20509 if (fdp != NULL)
20510 vim_memset(fdp, 0, sizeof(funcdict_T));
20511 start = *pp;
20513 /* Check for hard coded <SNR>: already translated function ID (from a user
20514 * command). */
20515 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20516 && (*pp)[2] == (int)KE_SNR)
20518 *pp += 3;
20519 len = get_id_len(pp) + 3;
20520 return vim_strnsave(start, len);
20523 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20524 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20525 lead = eval_fname_script(start);
20526 if (lead > 2)
20527 start += lead;
20529 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20530 lead > 2 ? 0 : FNE_CHECK_START);
20531 if (end == start)
20533 if (!skip)
20534 EMSG(_("E129: Function name required"));
20535 goto theend;
20537 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20540 * Report an invalid expression in braces, unless the expression
20541 * evaluation has been cancelled due to an aborting error, an
20542 * interrupt, or an exception.
20544 if (!aborting())
20546 if (end != NULL)
20547 EMSG2(_(e_invarg2), start);
20549 else
20550 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20551 goto theend;
20554 if (lv.ll_tv != NULL)
20556 if (fdp != NULL)
20558 fdp->fd_dict = lv.ll_dict;
20559 fdp->fd_newkey = lv.ll_newkey;
20560 lv.ll_newkey = NULL;
20561 fdp->fd_di = lv.ll_di;
20563 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20565 name = vim_strsave(lv.ll_tv->vval.v_string);
20566 *pp = end;
20568 else
20570 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20571 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20572 EMSG(_(e_funcref));
20573 else
20574 *pp = end;
20575 name = NULL;
20577 goto theend;
20580 if (lv.ll_name == NULL)
20582 /* Error found, but continue after the function name. */
20583 *pp = end;
20584 goto theend;
20587 /* Check if the name is a Funcref. If so, use the value. */
20588 if (lv.ll_exp_name != NULL)
20590 len = (int)STRLEN(lv.ll_exp_name);
20591 name = deref_func_name(lv.ll_exp_name, &len);
20592 if (name == lv.ll_exp_name)
20593 name = NULL;
20595 else
20597 len = (int)(end - *pp);
20598 name = deref_func_name(*pp, &len);
20599 if (name == *pp)
20600 name = NULL;
20602 if (name != NULL)
20604 name = vim_strsave(name);
20605 *pp = end;
20606 goto theend;
20609 if (lv.ll_exp_name != NULL)
20611 len = (int)STRLEN(lv.ll_exp_name);
20612 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20613 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20615 /* When there was "s:" already or the name expanded to get a
20616 * leading "s:" then remove it. */
20617 lv.ll_name += 2;
20618 len -= 2;
20619 lead = 2;
20622 else
20624 if (lead == 2) /* skip over "s:" */
20625 lv.ll_name += 2;
20626 len = (int)(end - lv.ll_name);
20630 * Copy the function name to allocated memory.
20631 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20632 * Accept <SNR>123_name() outside a script.
20634 if (skip)
20635 lead = 0; /* do nothing */
20636 else if (lead > 0)
20638 lead = 3;
20639 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20640 || eval_fname_sid(*pp))
20642 /* It's "s:" or "<SID>" */
20643 if (current_SID <= 0)
20645 EMSG(_(e_usingsid));
20646 goto theend;
20648 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20649 lead += (int)STRLEN(sid_buf);
20652 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20654 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20655 goto theend;
20657 name = alloc((unsigned)(len + lead + 1));
20658 if (name != NULL)
20660 if (lead > 0)
20662 name[0] = K_SPECIAL;
20663 name[1] = KS_EXTRA;
20664 name[2] = (int)KE_SNR;
20665 if (lead > 3) /* If it's "<SID>" */
20666 STRCPY(name + 3, sid_buf);
20668 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20669 name[len + lead] = NUL;
20671 *pp = end;
20673 theend:
20674 clear_lval(&lv);
20675 return name;
20679 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20680 * Return 2 if "p" starts with "s:".
20681 * Return 0 otherwise.
20683 static int
20684 eval_fname_script(p)
20685 char_u *p;
20687 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20688 || STRNICMP(p + 1, "SNR>", 4) == 0))
20689 return 5;
20690 if (p[0] == 's' && p[1] == ':')
20691 return 2;
20692 return 0;
20696 * Return TRUE if "p" starts with "<SID>" or "s:".
20697 * Only works if eval_fname_script() returned non-zero for "p"!
20699 static int
20700 eval_fname_sid(p)
20701 char_u *p;
20703 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20707 * List the head of the function: "name(arg1, arg2)".
20709 static void
20710 list_func_head(fp, indent)
20711 ufunc_T *fp;
20712 int indent;
20714 int j;
20716 msg_start();
20717 if (indent)
20718 MSG_PUTS(" ");
20719 MSG_PUTS("function ");
20720 if (fp->uf_name[0] == K_SPECIAL)
20722 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20723 msg_puts(fp->uf_name + 3);
20725 else
20726 msg_puts(fp->uf_name);
20727 msg_putchar('(');
20728 for (j = 0; j < fp->uf_args.ga_len; ++j)
20730 if (j)
20731 MSG_PUTS(", ");
20732 msg_puts(FUNCARG(fp, j));
20734 if (fp->uf_varargs)
20736 if (j)
20737 MSG_PUTS(", ");
20738 MSG_PUTS("...");
20740 msg_putchar(')');
20741 msg_clr_eos();
20742 if (p_verbose > 0)
20743 last_set_msg(fp->uf_script_ID);
20747 * Find a function by name, return pointer to it in ufuncs.
20748 * Return NULL for unknown function.
20750 static ufunc_T *
20751 find_func(name)
20752 char_u *name;
20754 hashitem_T *hi;
20756 hi = hash_find(&func_hashtab, name);
20757 if (!HASHITEM_EMPTY(hi))
20758 return HI2UF(hi);
20759 return NULL;
20762 #if defined(EXITFREE) || defined(PROTO)
20763 void
20764 free_all_functions()
20766 hashitem_T *hi;
20768 /* Need to start all over every time, because func_free() may change the
20769 * hash table. */
20770 while (func_hashtab.ht_used > 0)
20771 for (hi = func_hashtab.ht_array; ; ++hi)
20772 if (!HASHITEM_EMPTY(hi))
20774 func_free(HI2UF(hi));
20775 break;
20778 #endif
20781 * Return TRUE if a function "name" exists.
20783 static int
20784 function_exists(name)
20785 char_u *name;
20787 char_u *nm = name;
20788 char_u *p;
20789 int n = FALSE;
20791 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20792 nm = skipwhite(nm);
20794 /* Only accept "funcname", "funcname ", "funcname (..." and
20795 * "funcname(...", not "funcname!...". */
20796 if (p != NULL && (*nm == NUL || *nm == '('))
20798 if (builtin_function(p))
20799 n = (find_internal_func(p) >= 0);
20800 else
20801 n = (find_func(p) != NULL);
20803 vim_free(p);
20804 return n;
20808 * Return TRUE if "name" looks like a builtin function name: starts with a
20809 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20811 static int
20812 builtin_function(name)
20813 char_u *name;
20815 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20816 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20819 #if defined(FEAT_PROFILE) || defined(PROTO)
20821 * Start profiling function "fp".
20823 static void
20824 func_do_profile(fp)
20825 ufunc_T *fp;
20827 fp->uf_tm_count = 0;
20828 profile_zero(&fp->uf_tm_self);
20829 profile_zero(&fp->uf_tm_total);
20830 if (fp->uf_tml_count == NULL)
20831 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20832 (sizeof(int) * fp->uf_lines.ga_len));
20833 if (fp->uf_tml_total == NULL)
20834 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20835 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20836 if (fp->uf_tml_self == NULL)
20837 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20838 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20839 fp->uf_tml_idx = -1;
20840 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20841 || fp->uf_tml_self == NULL)
20842 return; /* out of memory */
20844 fp->uf_profiling = TRUE;
20848 * Dump the profiling results for all functions in file "fd".
20850 void
20851 func_dump_profile(fd)
20852 FILE *fd;
20854 hashitem_T *hi;
20855 int todo;
20856 ufunc_T *fp;
20857 int i;
20858 ufunc_T **sorttab;
20859 int st_len = 0;
20861 todo = (int)func_hashtab.ht_used;
20862 if (todo == 0)
20863 return; /* nothing to dump */
20865 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20867 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20869 if (!HASHITEM_EMPTY(hi))
20871 --todo;
20872 fp = HI2UF(hi);
20873 if (fp->uf_profiling)
20875 if (sorttab != NULL)
20876 sorttab[st_len++] = fp;
20878 if (fp->uf_name[0] == K_SPECIAL)
20879 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20880 else
20881 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20882 if (fp->uf_tm_count == 1)
20883 fprintf(fd, "Called 1 time\n");
20884 else
20885 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20886 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20887 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20888 fprintf(fd, "\n");
20889 fprintf(fd, "count total (s) self (s)\n");
20891 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20893 if (FUNCLINE(fp, i) == NULL)
20894 continue;
20895 prof_func_line(fd, fp->uf_tml_count[i],
20896 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20897 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20899 fprintf(fd, "\n");
20904 if (sorttab != NULL && st_len > 0)
20906 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20907 prof_total_cmp);
20908 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20909 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20910 prof_self_cmp);
20911 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20914 vim_free(sorttab);
20917 static void
20918 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20919 FILE *fd;
20920 ufunc_T **sorttab;
20921 int st_len;
20922 char *title;
20923 int prefer_self; /* when equal print only self time */
20925 int i;
20926 ufunc_T *fp;
20928 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20929 fprintf(fd, "count total (s) self (s) function\n");
20930 for (i = 0; i < 20 && i < st_len; ++i)
20932 fp = sorttab[i];
20933 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20934 prefer_self);
20935 if (fp->uf_name[0] == K_SPECIAL)
20936 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20937 else
20938 fprintf(fd, " %s()\n", fp->uf_name);
20940 fprintf(fd, "\n");
20944 * Print the count and times for one function or function line.
20946 static void
20947 prof_func_line(fd, count, total, self, prefer_self)
20948 FILE *fd;
20949 int count;
20950 proftime_T *total;
20951 proftime_T *self;
20952 int prefer_self; /* when equal print only self time */
20954 if (count > 0)
20956 fprintf(fd, "%5d ", count);
20957 if (prefer_self && profile_equal(total, self))
20958 fprintf(fd, " ");
20959 else
20960 fprintf(fd, "%s ", profile_msg(total));
20961 if (!prefer_self && profile_equal(total, self))
20962 fprintf(fd, " ");
20963 else
20964 fprintf(fd, "%s ", profile_msg(self));
20966 else
20967 fprintf(fd, " ");
20971 * Compare function for total time sorting.
20973 static int
20974 #ifdef __BORLANDC__
20975 _RTLENTRYF
20976 #endif
20977 prof_total_cmp(s1, s2)
20978 const void *s1;
20979 const void *s2;
20981 ufunc_T *p1, *p2;
20983 p1 = *(ufunc_T **)s1;
20984 p2 = *(ufunc_T **)s2;
20985 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20989 * Compare function for self time sorting.
20991 static int
20992 #ifdef __BORLANDC__
20993 _RTLENTRYF
20994 #endif
20995 prof_self_cmp(s1, s2)
20996 const void *s1;
20997 const void *s2;
20999 ufunc_T *p1, *p2;
21001 p1 = *(ufunc_T **)s1;
21002 p2 = *(ufunc_T **)s2;
21003 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
21006 #endif
21009 * If "name" has a package name try autoloading the script for it.
21010 * Return TRUE if a package was loaded.
21012 static int
21013 script_autoload(name, reload)
21014 char_u *name;
21015 int reload; /* load script again when already loaded */
21017 char_u *p;
21018 char_u *scriptname, *tofree;
21019 int ret = FALSE;
21020 int i;
21022 /* If there is no '#' after name[0] there is no package name. */
21023 p = vim_strchr(name, AUTOLOAD_CHAR);
21024 if (p == NULL || p == name)
21025 return FALSE;
21027 tofree = scriptname = autoload_name(name);
21029 /* Find the name in the list of previously loaded package names. Skip
21030 * "autoload/", it's always the same. */
21031 for (i = 0; i < ga_loaded.ga_len; ++i)
21032 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
21033 break;
21034 if (!reload && i < ga_loaded.ga_len)
21035 ret = FALSE; /* was loaded already */
21036 else
21038 /* Remember the name if it wasn't loaded already. */
21039 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
21041 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
21042 tofree = NULL;
21045 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
21046 if (source_runtime(scriptname, FALSE) == OK)
21047 ret = TRUE;
21050 vim_free(tofree);
21051 return ret;
21055 * Return the autoload script name for a function or variable name.
21056 * Returns NULL when out of memory.
21058 static char_u *
21059 autoload_name(name)
21060 char_u *name;
21062 char_u *p;
21063 char_u *scriptname;
21065 /* Get the script file name: replace '#' with '/', append ".vim". */
21066 scriptname = alloc((unsigned)(STRLEN(name) + 14));
21067 if (scriptname == NULL)
21068 return FALSE;
21069 STRCPY(scriptname, "autoload/");
21070 STRCAT(scriptname, name);
21071 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
21072 STRCAT(scriptname, ".vim");
21073 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
21074 *p = '/';
21075 return scriptname;
21078 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
21081 * Function given to ExpandGeneric() to obtain the list of user defined
21082 * function names.
21084 char_u *
21085 get_user_func_name(xp, idx)
21086 expand_T *xp;
21087 int idx;
21089 static long_u done;
21090 static hashitem_T *hi;
21091 ufunc_T *fp;
21093 if (idx == 0)
21095 done = 0;
21096 hi = func_hashtab.ht_array;
21098 if (done < func_hashtab.ht_used)
21100 if (done++ > 0)
21101 ++hi;
21102 while (HASHITEM_EMPTY(hi))
21103 ++hi;
21104 fp = HI2UF(hi);
21106 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
21107 return fp->uf_name; /* prevents overflow */
21109 cat_func_name(IObuff, fp);
21110 if (xp->xp_context != EXPAND_USER_FUNC)
21112 STRCAT(IObuff, "(");
21113 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
21114 STRCAT(IObuff, ")");
21116 return IObuff;
21118 return NULL;
21121 #endif /* FEAT_CMDL_COMPL */
21124 * Copy the function name of "fp" to buffer "buf".
21125 * "buf" must be able to hold the function name plus three bytes.
21126 * Takes care of script-local function names.
21128 static void
21129 cat_func_name(buf, fp)
21130 char_u *buf;
21131 ufunc_T *fp;
21133 if (fp->uf_name[0] == K_SPECIAL)
21135 STRCPY(buf, "<SNR>");
21136 STRCAT(buf, fp->uf_name + 3);
21138 else
21139 STRCPY(buf, fp->uf_name);
21143 * ":delfunction {name}"
21145 void
21146 ex_delfunction(eap)
21147 exarg_T *eap;
21149 ufunc_T *fp = NULL;
21150 char_u *p;
21151 char_u *name;
21152 funcdict_T fudi;
21154 p = eap->arg;
21155 name = trans_function_name(&p, eap->skip, 0, &fudi);
21156 vim_free(fudi.fd_newkey);
21157 if (name == NULL)
21159 if (fudi.fd_dict != NULL && !eap->skip)
21160 EMSG(_(e_funcref));
21161 return;
21163 if (!ends_excmd(*skipwhite(p)))
21165 vim_free(name);
21166 EMSG(_(e_trailing));
21167 return;
21169 eap->nextcmd = check_nextcmd(p);
21170 if (eap->nextcmd != NULL)
21171 *p = NUL;
21173 if (!eap->skip)
21174 fp = find_func(name);
21175 vim_free(name);
21177 if (!eap->skip)
21179 if (fp == NULL)
21181 EMSG2(_(e_nofunc), eap->arg);
21182 return;
21184 if (fp->uf_calls > 0)
21186 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21187 return;
21190 if (fudi.fd_dict != NULL)
21192 /* Delete the dict item that refers to the function, it will
21193 * invoke func_unref() and possibly delete the function. */
21194 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21196 else
21197 func_free(fp);
21202 * Free a function and remove it from the list of functions.
21204 static void
21205 func_free(fp)
21206 ufunc_T *fp;
21208 hashitem_T *hi;
21210 /* clear this function */
21211 ga_clear_strings(&(fp->uf_args));
21212 ga_clear_strings(&(fp->uf_lines));
21213 #ifdef FEAT_PROFILE
21214 vim_free(fp->uf_tml_count);
21215 vim_free(fp->uf_tml_total);
21216 vim_free(fp->uf_tml_self);
21217 #endif
21219 /* remove the function from the function hashtable */
21220 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21221 if (HASHITEM_EMPTY(hi))
21222 EMSG2(_(e_intern2), "func_free()");
21223 else
21224 hash_remove(&func_hashtab, hi);
21226 vim_free(fp);
21230 * Unreference a Function: decrement the reference count and free it when it
21231 * becomes zero. Only for numbered functions.
21233 static void
21234 func_unref(name)
21235 char_u *name;
21237 ufunc_T *fp;
21239 if (name != NULL && isdigit(*name))
21241 fp = find_func(name);
21242 if (fp == NULL)
21243 EMSG2(_(e_intern2), "func_unref()");
21244 else if (--fp->uf_refcount <= 0)
21246 /* Only delete it when it's not being used. Otherwise it's done
21247 * when "uf_calls" becomes zero. */
21248 if (fp->uf_calls == 0)
21249 func_free(fp);
21255 * Count a reference to a Function.
21257 static void
21258 func_ref(name)
21259 char_u *name;
21261 ufunc_T *fp;
21263 if (name != NULL && isdigit(*name))
21265 fp = find_func(name);
21266 if (fp == NULL)
21267 EMSG2(_(e_intern2), "func_ref()");
21268 else
21269 ++fp->uf_refcount;
21274 * Call a user function.
21276 static void
21277 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21278 ufunc_T *fp; /* pointer to function */
21279 int argcount; /* nr of args */
21280 typval_T *argvars; /* arguments */
21281 typval_T *rettv; /* return value */
21282 linenr_T firstline; /* first line of range */
21283 linenr_T lastline; /* last line of range */
21284 dict_T *selfdict; /* Dictionary for "self" */
21286 char_u *save_sourcing_name;
21287 linenr_T save_sourcing_lnum;
21288 scid_T save_current_SID;
21289 funccall_T fc;
21290 int save_did_emsg;
21291 static int depth = 0;
21292 dictitem_T *v;
21293 int fixvar_idx = 0; /* index in fixvar[] */
21294 int i;
21295 int ai;
21296 char_u numbuf[NUMBUFLEN];
21297 char_u *name;
21298 #ifdef FEAT_PROFILE
21299 proftime_T wait_start;
21300 proftime_T call_start;
21301 #endif
21303 /* If depth of calling is getting too high, don't execute the function */
21304 if (depth >= p_mfd)
21306 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21307 rettv->v_type = VAR_NUMBER;
21308 rettv->vval.v_number = -1;
21309 return;
21311 ++depth;
21313 line_breakcheck(); /* check for CTRL-C hit */
21315 fc.caller = current_funccal;
21316 current_funccal = &fc;
21317 fc.func = fp;
21318 fc.rettv = rettv;
21319 rettv->vval.v_number = 0;
21320 fc.linenr = 0;
21321 fc.returned = FALSE;
21322 fc.level = ex_nesting_level;
21323 /* Check if this function has a breakpoint. */
21324 fc.breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21325 fc.dbg_tick = debug_tick;
21328 * Note about using fc.fixvar[]: This is an array of FIXVAR_CNT variables
21329 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21330 * each argument variable and saves a lot of time.
21333 * Init l: variables.
21335 init_var_dict(&fc.l_vars, &fc.l_vars_var);
21336 if (selfdict != NULL)
21338 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21339 * some compiler that checks the destination size. */
21340 v = &fc.fixvar[fixvar_idx++].var;
21341 name = v->di_key;
21342 STRCPY(name, "self");
21343 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21344 hash_add(&fc.l_vars.dv_hashtab, DI2HIKEY(v));
21345 v->di_tv.v_type = VAR_DICT;
21346 v->di_tv.v_lock = 0;
21347 v->di_tv.vval.v_dict = selfdict;
21348 ++selfdict->dv_refcount;
21352 * Init a: variables.
21353 * Set a:0 to "argcount".
21354 * Set a:000 to a list with room for the "..." arguments.
21356 init_var_dict(&fc.l_avars, &fc.l_avars_var);
21357 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "0",
21358 (varnumber_T)(argcount - fp->uf_args.ga_len));
21359 /* Use "name" to avoid a warning from some compiler that checks the
21360 * destination size. */
21361 v = &fc.fixvar[fixvar_idx++].var;
21362 name = v->di_key;
21363 STRCPY(name, "000");
21364 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21365 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21366 v->di_tv.v_type = VAR_LIST;
21367 v->di_tv.v_lock = VAR_FIXED;
21368 v->di_tv.vval.v_list = &fc.l_varlist;
21369 vim_memset(&fc.l_varlist, 0, sizeof(list_T));
21370 fc.l_varlist.lv_refcount = 99999;
21371 fc.l_varlist.lv_lock = VAR_FIXED;
21374 * Set a:firstline to "firstline" and a:lastline to "lastline".
21375 * Set a:name to named arguments.
21376 * Set a:N to the "..." arguments.
21378 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "firstline",
21379 (varnumber_T)firstline);
21380 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "lastline",
21381 (varnumber_T)lastline);
21382 for (i = 0; i < argcount; ++i)
21384 ai = i - fp->uf_args.ga_len;
21385 if (ai < 0)
21386 /* named argument a:name */
21387 name = FUNCARG(fp, i);
21388 else
21390 /* "..." argument a:1, a:2, etc. */
21391 sprintf((char *)numbuf, "%d", ai + 1);
21392 name = numbuf;
21394 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21396 v = &fc.fixvar[fixvar_idx++].var;
21397 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21399 else
21401 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21402 + STRLEN(name)));
21403 if (v == NULL)
21404 break;
21405 v->di_flags = DI_FLAGS_RO;
21407 STRCPY(v->di_key, name);
21408 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21410 /* Note: the values are copied directly to avoid alloc/free.
21411 * "argvars" must have VAR_FIXED for v_lock. */
21412 v->di_tv = argvars[i];
21413 v->di_tv.v_lock = VAR_FIXED;
21415 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21417 list_append(&fc.l_varlist, &fc.l_listitems[ai]);
21418 fc.l_listitems[ai].li_tv = argvars[i];
21419 fc.l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21423 /* Don't redraw while executing the function. */
21424 ++RedrawingDisabled;
21425 save_sourcing_name = sourcing_name;
21426 save_sourcing_lnum = sourcing_lnum;
21427 sourcing_lnum = 1;
21428 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21429 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21430 if (sourcing_name != NULL)
21432 if (save_sourcing_name != NULL
21433 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21434 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21435 else
21436 STRCPY(sourcing_name, "function ");
21437 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21439 if (p_verbose >= 12)
21441 ++no_wait_return;
21442 verbose_enter_scroll();
21444 smsg((char_u *)_("calling %s"), sourcing_name);
21445 if (p_verbose >= 14)
21447 char_u buf[MSG_BUF_LEN];
21448 char_u numbuf2[NUMBUFLEN];
21449 char_u *tofree;
21450 char_u *s;
21452 msg_puts((char_u *)"(");
21453 for (i = 0; i < argcount; ++i)
21455 if (i > 0)
21456 msg_puts((char_u *)", ");
21457 if (argvars[i].v_type == VAR_NUMBER)
21458 msg_outnum((long)argvars[i].vval.v_number);
21459 else
21461 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21462 if (s != NULL)
21464 trunc_string(s, buf, MSG_BUF_CLEN);
21465 msg_puts(buf);
21466 vim_free(tofree);
21470 msg_puts((char_u *)")");
21472 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21474 verbose_leave_scroll();
21475 --no_wait_return;
21478 #ifdef FEAT_PROFILE
21479 if (do_profiling == PROF_YES)
21481 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21482 func_do_profile(fp);
21483 if (fp->uf_profiling
21484 || (fc.caller != NULL && fc.caller->func->uf_profiling))
21486 ++fp->uf_tm_count;
21487 profile_start(&call_start);
21488 profile_zero(&fp->uf_tm_children);
21490 script_prof_save(&wait_start);
21492 #endif
21494 save_current_SID = current_SID;
21495 current_SID = fp->uf_script_ID;
21496 save_did_emsg = did_emsg;
21497 did_emsg = FALSE;
21499 /* call do_cmdline() to execute the lines */
21500 do_cmdline(NULL, get_func_line, (void *)&fc,
21501 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21503 --RedrawingDisabled;
21505 /* when the function was aborted because of an error, return -1 */
21506 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21508 clear_tv(rettv);
21509 rettv->v_type = VAR_NUMBER;
21510 rettv->vval.v_number = -1;
21513 #ifdef FEAT_PROFILE
21514 if (do_profiling == PROF_YES && (fp->uf_profiling
21515 || (fc.caller != NULL && fc.caller->func->uf_profiling)))
21517 profile_end(&call_start);
21518 profile_sub_wait(&wait_start, &call_start);
21519 profile_add(&fp->uf_tm_total, &call_start);
21520 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21521 if (fc.caller != NULL && fc.caller->func->uf_profiling)
21523 profile_add(&fc.caller->func->uf_tm_children, &call_start);
21524 profile_add(&fc.caller->func->uf_tml_children, &call_start);
21527 #endif
21529 /* when being verbose, mention the return value */
21530 if (p_verbose >= 12)
21532 ++no_wait_return;
21533 verbose_enter_scroll();
21535 if (aborting())
21536 smsg((char_u *)_("%s aborted"), sourcing_name);
21537 else if (fc.rettv->v_type == VAR_NUMBER)
21538 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21539 (long)fc.rettv->vval.v_number);
21540 else
21542 char_u buf[MSG_BUF_LEN];
21543 char_u numbuf2[NUMBUFLEN];
21544 char_u *tofree;
21545 char_u *s;
21547 /* The value may be very long. Skip the middle part, so that we
21548 * have some idea how it starts and ends. smsg() would always
21549 * truncate it at the end. */
21550 s = tv2string(fc.rettv, &tofree, numbuf2, 0);
21551 if (s != NULL)
21553 trunc_string(s, buf, MSG_BUF_CLEN);
21554 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21555 vim_free(tofree);
21558 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21560 verbose_leave_scroll();
21561 --no_wait_return;
21564 vim_free(sourcing_name);
21565 sourcing_name = save_sourcing_name;
21566 sourcing_lnum = save_sourcing_lnum;
21567 current_SID = save_current_SID;
21568 #ifdef FEAT_PROFILE
21569 if (do_profiling == PROF_YES)
21570 script_prof_restore(&wait_start);
21571 #endif
21573 if (p_verbose >= 12 && sourcing_name != NULL)
21575 ++no_wait_return;
21576 verbose_enter_scroll();
21578 smsg((char_u *)_("continuing in %s"), sourcing_name);
21579 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21581 verbose_leave_scroll();
21582 --no_wait_return;
21585 did_emsg |= save_did_emsg;
21586 current_funccal = fc.caller;
21588 /* The a: variables typevals were not allocated, only free the allocated
21589 * variables. */
21590 vars_clear_ext(&fc.l_avars.dv_hashtab, FALSE);
21592 vars_clear(&fc.l_vars.dv_hashtab); /* free all l: variables */
21593 --depth;
21597 * Add a number variable "name" to dict "dp" with value "nr".
21599 static void
21600 add_nr_var(dp, v, name, nr)
21601 dict_T *dp;
21602 dictitem_T *v;
21603 char *name;
21604 varnumber_T nr;
21606 STRCPY(v->di_key, name);
21607 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21608 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21609 v->di_tv.v_type = VAR_NUMBER;
21610 v->di_tv.v_lock = VAR_FIXED;
21611 v->di_tv.vval.v_number = nr;
21615 * ":return [expr]"
21617 void
21618 ex_return(eap)
21619 exarg_T *eap;
21621 char_u *arg = eap->arg;
21622 typval_T rettv;
21623 int returning = FALSE;
21625 if (current_funccal == NULL)
21627 EMSG(_("E133: :return not inside a function"));
21628 return;
21631 if (eap->skip)
21632 ++emsg_skip;
21634 eap->nextcmd = NULL;
21635 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21636 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21638 if (!eap->skip)
21639 returning = do_return(eap, FALSE, TRUE, &rettv);
21640 else
21641 clear_tv(&rettv);
21643 /* It's safer to return also on error. */
21644 else if (!eap->skip)
21647 * Return unless the expression evaluation has been cancelled due to an
21648 * aborting error, an interrupt, or an exception.
21650 if (!aborting())
21651 returning = do_return(eap, FALSE, TRUE, NULL);
21654 /* When skipping or the return gets pending, advance to the next command
21655 * in this line (!returning). Otherwise, ignore the rest of the line.
21656 * Following lines will be ignored by get_func_line(). */
21657 if (returning)
21658 eap->nextcmd = NULL;
21659 else if (eap->nextcmd == NULL) /* no argument */
21660 eap->nextcmd = check_nextcmd(arg);
21662 if (eap->skip)
21663 --emsg_skip;
21667 * Return from a function. Possibly makes the return pending. Also called
21668 * for a pending return at the ":endtry" or after returning from an extra
21669 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21670 * when called due to a ":return" command. "rettv" may point to a typval_T
21671 * with the return rettv. Returns TRUE when the return can be carried out,
21672 * FALSE when the return gets pending.
21675 do_return(eap, reanimate, is_cmd, rettv)
21676 exarg_T *eap;
21677 int reanimate;
21678 int is_cmd;
21679 void *rettv;
21681 int idx;
21682 struct condstack *cstack = eap->cstack;
21684 if (reanimate)
21685 /* Undo the return. */
21686 current_funccal->returned = FALSE;
21689 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21690 * not in its finally clause (which then is to be executed next) is found.
21691 * In this case, make the ":return" pending for execution at the ":endtry".
21692 * Otherwise, return normally.
21694 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21695 if (idx >= 0)
21697 cstack->cs_pending[idx] = CSTP_RETURN;
21699 if (!is_cmd && !reanimate)
21700 /* A pending return again gets pending. "rettv" points to an
21701 * allocated variable with the rettv of the original ":return"'s
21702 * argument if present or is NULL else. */
21703 cstack->cs_rettv[idx] = rettv;
21704 else
21706 /* When undoing a return in order to make it pending, get the stored
21707 * return rettv. */
21708 if (reanimate)
21709 rettv = current_funccal->rettv;
21711 if (rettv != NULL)
21713 /* Store the value of the pending return. */
21714 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21715 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21716 else
21717 EMSG(_(e_outofmem));
21719 else
21720 cstack->cs_rettv[idx] = NULL;
21722 if (reanimate)
21724 /* The pending return value could be overwritten by a ":return"
21725 * without argument in a finally clause; reset the default
21726 * return value. */
21727 current_funccal->rettv->v_type = VAR_NUMBER;
21728 current_funccal->rettv->vval.v_number = 0;
21731 report_make_pending(CSTP_RETURN, rettv);
21733 else
21735 current_funccal->returned = TRUE;
21737 /* If the return is carried out now, store the return value. For
21738 * a return immediately after reanimation, the value is already
21739 * there. */
21740 if (!reanimate && rettv != NULL)
21742 clear_tv(current_funccal->rettv);
21743 *current_funccal->rettv = *(typval_T *)rettv;
21744 if (!is_cmd)
21745 vim_free(rettv);
21749 return idx < 0;
21753 * Free the variable with a pending return value.
21755 void
21756 discard_pending_return(rettv)
21757 void *rettv;
21759 free_tv((typval_T *)rettv);
21763 * Generate a return command for producing the value of "rettv". The result
21764 * is an allocated string. Used by report_pending() for verbose messages.
21766 char_u *
21767 get_return_cmd(rettv)
21768 void *rettv;
21770 char_u *s = NULL;
21771 char_u *tofree = NULL;
21772 char_u numbuf[NUMBUFLEN];
21774 if (rettv != NULL)
21775 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21776 if (s == NULL)
21777 s = (char_u *)"";
21779 STRCPY(IObuff, ":return ");
21780 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21781 if (STRLEN(s) + 8 >= IOSIZE)
21782 STRCPY(IObuff + IOSIZE - 4, "...");
21783 vim_free(tofree);
21784 return vim_strsave(IObuff);
21788 * Get next function line.
21789 * Called by do_cmdline() to get the next line.
21790 * Returns allocated string, or NULL for end of function.
21792 /* ARGSUSED */
21793 char_u *
21794 get_func_line(c, cookie, indent)
21795 int c; /* not used */
21796 void *cookie;
21797 int indent; /* not used */
21799 funccall_T *fcp = (funccall_T *)cookie;
21800 ufunc_T *fp = fcp->func;
21801 char_u *retval;
21802 garray_T *gap; /* growarray with function lines */
21804 /* If breakpoints have been added/deleted need to check for it. */
21805 if (fcp->dbg_tick != debug_tick)
21807 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21808 sourcing_lnum);
21809 fcp->dbg_tick = debug_tick;
21811 #ifdef FEAT_PROFILE
21812 if (do_profiling == PROF_YES)
21813 func_line_end(cookie);
21814 #endif
21816 gap = &fp->uf_lines;
21817 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21818 || fcp->returned)
21819 retval = NULL;
21820 else
21822 /* Skip NULL lines (continuation lines). */
21823 while (fcp->linenr < gap->ga_len
21824 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21825 ++fcp->linenr;
21826 if (fcp->linenr >= gap->ga_len)
21827 retval = NULL;
21828 else
21830 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21831 sourcing_lnum = fcp->linenr;
21832 #ifdef FEAT_PROFILE
21833 if (do_profiling == PROF_YES)
21834 func_line_start(cookie);
21835 #endif
21839 /* Did we encounter a breakpoint? */
21840 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21842 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21843 /* Find next breakpoint. */
21844 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21845 sourcing_lnum);
21846 fcp->dbg_tick = debug_tick;
21849 return retval;
21852 #if defined(FEAT_PROFILE) || defined(PROTO)
21854 * Called when starting to read a function line.
21855 * "sourcing_lnum" must be correct!
21856 * When skipping lines it may not actually be executed, but we won't find out
21857 * until later and we need to store the time now.
21859 void
21860 func_line_start(cookie)
21861 void *cookie;
21863 funccall_T *fcp = (funccall_T *)cookie;
21864 ufunc_T *fp = fcp->func;
21866 if (fp->uf_profiling && sourcing_lnum >= 1
21867 && sourcing_lnum <= fp->uf_lines.ga_len)
21869 fp->uf_tml_idx = sourcing_lnum - 1;
21870 /* Skip continuation lines. */
21871 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21872 --fp->uf_tml_idx;
21873 fp->uf_tml_execed = FALSE;
21874 profile_start(&fp->uf_tml_start);
21875 profile_zero(&fp->uf_tml_children);
21876 profile_get_wait(&fp->uf_tml_wait);
21881 * Called when actually executing a function line.
21883 void
21884 func_line_exec(cookie)
21885 void *cookie;
21887 funccall_T *fcp = (funccall_T *)cookie;
21888 ufunc_T *fp = fcp->func;
21890 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21891 fp->uf_tml_execed = TRUE;
21895 * Called when done with a function line.
21897 void
21898 func_line_end(cookie)
21899 void *cookie;
21901 funccall_T *fcp = (funccall_T *)cookie;
21902 ufunc_T *fp = fcp->func;
21904 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21906 if (fp->uf_tml_execed)
21908 ++fp->uf_tml_count[fp->uf_tml_idx];
21909 profile_end(&fp->uf_tml_start);
21910 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21911 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21912 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21913 &fp->uf_tml_children);
21915 fp->uf_tml_idx = -1;
21918 #endif
21921 * Return TRUE if the currently active function should be ended, because a
21922 * return was encountered or an error occurred. Used inside a ":while".
21925 func_has_ended(cookie)
21926 void *cookie;
21928 funccall_T *fcp = (funccall_T *)cookie;
21930 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21931 * an error inside a try conditional. */
21932 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21933 || fcp->returned);
21937 * return TRUE if cookie indicates a function which "abort"s on errors.
21940 func_has_abort(cookie)
21941 void *cookie;
21943 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21946 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21947 typedef enum
21949 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21950 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21951 VAR_FLAVOUR_VIMINFO /* all uppercase */
21952 } var_flavour_T;
21954 static var_flavour_T var_flavour __ARGS((char_u *varname));
21956 static var_flavour_T
21957 var_flavour(varname)
21958 char_u *varname;
21960 char_u *p = varname;
21962 if (ASCII_ISUPPER(*p))
21964 while (*(++p))
21965 if (ASCII_ISLOWER(*p))
21966 return VAR_FLAVOUR_SESSION;
21967 return VAR_FLAVOUR_VIMINFO;
21969 else
21970 return VAR_FLAVOUR_DEFAULT;
21972 #endif
21974 #if defined(FEAT_VIMINFO) || defined(PROTO)
21976 * Restore global vars that start with a capital from the viminfo file
21979 read_viminfo_varlist(virp, writing)
21980 vir_T *virp;
21981 int writing;
21983 char_u *tab;
21984 int type = VAR_NUMBER;
21985 typval_T tv;
21987 if (!writing && (find_viminfo_parameter('!') != NULL))
21989 tab = vim_strchr(virp->vir_line + 1, '\t');
21990 if (tab != NULL)
21992 *tab++ = '\0'; /* isolate the variable name */
21993 if (*tab == 'S') /* string var */
21994 type = VAR_STRING;
21995 #ifdef FEAT_FLOAT
21996 else if (*tab == 'F')
21997 type = VAR_FLOAT;
21998 #endif
22000 tab = vim_strchr(tab, '\t');
22001 if (tab != NULL)
22003 tv.v_type = type;
22004 if (type == VAR_STRING)
22005 tv.vval.v_string = viminfo_readstring(virp,
22006 (int)(tab - virp->vir_line + 1), TRUE);
22007 #ifdef FEAT_FLOAT
22008 else if (type == VAR_FLOAT)
22009 (void)string2float(tab + 1, &tv.vval.v_float);
22010 #endif
22011 else
22012 tv.vval.v_number = atol((char *)tab + 1);
22013 set_var(virp->vir_line + 1, &tv, FALSE);
22014 if (type == VAR_STRING)
22015 vim_free(tv.vval.v_string);
22020 return viminfo_readline(virp);
22024 * Write global vars that start with a capital to the viminfo file
22026 void
22027 write_viminfo_varlist(fp)
22028 FILE *fp;
22030 hashitem_T *hi;
22031 dictitem_T *this_var;
22032 int todo;
22033 char *s;
22034 char_u *p;
22035 char_u *tofree;
22036 char_u numbuf[NUMBUFLEN];
22038 if (find_viminfo_parameter('!') == NULL)
22039 return;
22041 fprintf(fp, _("\n# global variables:\n"));
22043 todo = (int)globvarht.ht_used;
22044 for (hi = globvarht.ht_array; todo > 0; ++hi)
22046 if (!HASHITEM_EMPTY(hi))
22048 --todo;
22049 this_var = HI2DI(hi);
22050 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
22052 switch (this_var->di_tv.v_type)
22054 case VAR_STRING: s = "STR"; break;
22055 case VAR_NUMBER: s = "NUM"; break;
22056 #ifdef FEAT_FLOAT
22057 case VAR_FLOAT: s = "FLO"; break;
22058 #endif
22059 default: continue;
22061 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
22062 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
22063 if (p != NULL)
22064 viminfo_writestring(fp, p);
22065 vim_free(tofree);
22070 #endif
22072 #if defined(FEAT_SESSION) || defined(PROTO)
22074 store_session_globals(fd)
22075 FILE *fd;
22077 hashitem_T *hi;
22078 dictitem_T *this_var;
22079 int todo;
22080 char_u *p, *t;
22082 todo = (int)globvarht.ht_used;
22083 for (hi = globvarht.ht_array; todo > 0; ++hi)
22085 if (!HASHITEM_EMPTY(hi))
22087 --todo;
22088 this_var = HI2DI(hi);
22089 if ((this_var->di_tv.v_type == VAR_NUMBER
22090 || this_var->di_tv.v_type == VAR_STRING)
22091 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22093 /* Escape special characters with a backslash. Turn a LF and
22094 * CR into \n and \r. */
22095 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22096 (char_u *)"\\\"\n\r");
22097 if (p == NULL) /* out of memory */
22098 break;
22099 for (t = p; *t != NUL; ++t)
22100 if (*t == '\n')
22101 *t = 'n';
22102 else if (*t == '\r')
22103 *t = 'r';
22104 if ((fprintf(fd, "let %s = %c%s%c",
22105 this_var->di_key,
22106 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22107 : ' ',
22109 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22110 : ' ') < 0)
22111 || put_eol(fd) == FAIL)
22113 vim_free(p);
22114 return FAIL;
22116 vim_free(p);
22118 #ifdef FEAT_FLOAT
22119 else if (this_var->di_tv.v_type == VAR_FLOAT
22120 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22122 float_T f = this_var->di_tv.vval.v_float;
22123 int sign = ' ';
22125 if (f < 0)
22127 f = -f;
22128 sign = '-';
22130 if ((fprintf(fd, "let %s = %c&%f",
22131 this_var->di_key, sign, f) < 0)
22132 || put_eol(fd) == FAIL)
22133 return FAIL;
22135 #endif
22138 return OK;
22140 #endif
22143 * Display script name where an item was last set.
22144 * Should only be invoked when 'verbose' is non-zero.
22146 void
22147 last_set_msg(scriptID)
22148 scid_T scriptID;
22150 char_u *p;
22152 if (scriptID != 0)
22154 p = home_replace_save(NULL, get_scriptname(scriptID));
22155 if (p != NULL)
22157 verbose_enter();
22158 MSG_PUTS(_("\n\tLast set from "));
22159 MSG_PUTS(p);
22160 vim_free(p);
22161 verbose_leave();
22167 * List v:oldfiles in a nice way.
22169 /*ARGSUSED*/
22170 void
22171 ex_oldfiles(eap)
22172 exarg_T *eap;
22174 list_T *l = vimvars[VV_OLDFILES].vv_list;
22175 listitem_T *li;
22176 int nr = 0;
22178 if (l == NULL)
22179 msg((char_u *)_("No old files"));
22180 else
22182 msg_start();
22183 msg_scroll = TRUE;
22184 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22186 msg_outnum((long)++nr);
22187 MSG_PUTS(": ");
22188 msg_outtrans(get_tv_string(&li->li_tv));
22189 msg_putchar('\n');
22190 out_flush(); /* output one line at a time */
22191 ui_breakcheck();
22193 /* Assume "got_int" was set to truncate the listing. */
22194 got_int = FALSE;
22196 #ifdef FEAT_BROWSE_CMD
22197 if (cmdmod.browse)
22199 quit_more = FALSE;
22200 nr = prompt_for_number(FALSE);
22201 msg_starthere();
22202 if (nr > 0)
22204 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22205 (long)nr);
22207 if (p != NULL)
22209 p = expand_env_save(p);
22210 eap->arg = p;
22211 eap->cmdidx = CMD_edit;
22212 cmdmod.browse = FALSE;
22213 do_exedit(eap, NULL);
22214 vim_free(p);
22218 #endif
22222 #endif /* FEAT_EVAL */
22225 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22227 #ifdef WIN3264
22229 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22231 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22232 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22233 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22236 * Get the short path (8.3) for the filename in "fnamep".
22237 * Only works for a valid file name.
22238 * When the path gets longer "fnamep" is changed and the allocated buffer
22239 * is put in "bufp".
22240 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22241 * Returns OK on success, FAIL on failure.
22243 static int
22244 get_short_pathname(fnamep, bufp, fnamelen)
22245 char_u **fnamep;
22246 char_u **bufp;
22247 int *fnamelen;
22249 int l, len;
22250 char_u *newbuf;
22252 len = *fnamelen;
22253 l = GetShortPathName(*fnamep, *fnamep, len);
22254 if (l > len - 1)
22256 /* If that doesn't work (not enough space), then save the string
22257 * and try again with a new buffer big enough. */
22258 newbuf = vim_strnsave(*fnamep, l);
22259 if (newbuf == NULL)
22260 return FAIL;
22262 vim_free(*bufp);
22263 *fnamep = *bufp = newbuf;
22265 /* Really should always succeed, as the buffer is big enough. */
22266 l = GetShortPathName(*fnamep, *fnamep, l+1);
22269 *fnamelen = l;
22270 return OK;
22274 * Get the short path (8.3) for the filename in "fname". The converted
22275 * path is returned in "bufp".
22277 * Some of the directories specified in "fname" may not exist. This function
22278 * will shorten the existing directories at the beginning of the path and then
22279 * append the remaining non-existing path.
22281 * fname - Pointer to the filename to shorten. On return, contains the
22282 * pointer to the shortened pathname
22283 * bufp - Pointer to an allocated buffer for the filename.
22284 * fnamelen - Length of the filename pointed to by fname
22286 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22288 static int
22289 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22290 char_u **fname;
22291 char_u **bufp;
22292 int *fnamelen;
22294 char_u *short_fname, *save_fname, *pbuf_unused;
22295 char_u *endp, *save_endp;
22296 char_u ch;
22297 int old_len, len;
22298 int new_len, sfx_len;
22299 int retval = OK;
22301 /* Make a copy */
22302 old_len = *fnamelen;
22303 save_fname = vim_strnsave(*fname, old_len);
22304 pbuf_unused = NULL;
22305 short_fname = NULL;
22307 endp = save_fname + old_len - 1; /* Find the end of the copy */
22308 save_endp = endp;
22311 * Try shortening the supplied path till it succeeds by removing one
22312 * directory at a time from the tail of the path.
22314 len = 0;
22315 for (;;)
22317 /* go back one path-separator */
22318 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22319 --endp;
22320 if (endp <= save_fname)
22321 break; /* processed the complete path */
22324 * Replace the path separator with a NUL and try to shorten the
22325 * resulting path.
22327 ch = *endp;
22328 *endp = 0;
22329 short_fname = save_fname;
22330 len = (int)STRLEN(short_fname) + 1;
22331 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22333 retval = FAIL;
22334 goto theend;
22336 *endp = ch; /* preserve the string */
22338 if (len > 0)
22339 break; /* successfully shortened the path */
22341 /* failed to shorten the path. Skip the path separator */
22342 --endp;
22345 if (len > 0)
22348 * Succeeded in shortening the path. Now concatenate the shortened
22349 * path with the remaining path at the tail.
22352 /* Compute the length of the new path. */
22353 sfx_len = (int)(save_endp - endp) + 1;
22354 new_len = len + sfx_len;
22356 *fnamelen = new_len;
22357 vim_free(*bufp);
22358 if (new_len > old_len)
22360 /* There is not enough space in the currently allocated string,
22361 * copy it to a buffer big enough. */
22362 *fname = *bufp = vim_strnsave(short_fname, new_len);
22363 if (*fname == NULL)
22365 retval = FAIL;
22366 goto theend;
22369 else
22371 /* Transfer short_fname to the main buffer (it's big enough),
22372 * unless get_short_pathname() did its work in-place. */
22373 *fname = *bufp = save_fname;
22374 if (short_fname != save_fname)
22375 vim_strncpy(save_fname, short_fname, len);
22376 save_fname = NULL;
22379 /* concat the not-shortened part of the path */
22380 vim_strncpy(*fname + len, endp, sfx_len);
22381 (*fname)[new_len] = NUL;
22384 theend:
22385 vim_free(pbuf_unused);
22386 vim_free(save_fname);
22388 return retval;
22392 * Get a pathname for a partial path.
22393 * Returns OK for success, FAIL for failure.
22395 static int
22396 shortpath_for_partial(fnamep, bufp, fnamelen)
22397 char_u **fnamep;
22398 char_u **bufp;
22399 int *fnamelen;
22401 int sepcount, len, tflen;
22402 char_u *p;
22403 char_u *pbuf, *tfname;
22404 int hasTilde;
22406 /* Count up the path separators from the RHS.. so we know which part
22407 * of the path to return. */
22408 sepcount = 0;
22409 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22410 if (vim_ispathsep(*p))
22411 ++sepcount;
22413 /* Need full path first (use expand_env() to remove a "~/") */
22414 hasTilde = (**fnamep == '~');
22415 if (hasTilde)
22416 pbuf = tfname = expand_env_save(*fnamep);
22417 else
22418 pbuf = tfname = FullName_save(*fnamep, FALSE);
22420 len = tflen = (int)STRLEN(tfname);
22422 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22423 return FAIL;
22425 if (len == 0)
22427 /* Don't have a valid filename, so shorten the rest of the
22428 * path if we can. This CAN give us invalid 8.3 filenames, but
22429 * there's not a lot of point in guessing what it might be.
22431 len = tflen;
22432 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22433 return FAIL;
22436 /* Count the paths backward to find the beginning of the desired string. */
22437 for (p = tfname + len - 1; p >= tfname; --p)
22439 #ifdef FEAT_MBYTE
22440 if (has_mbyte)
22441 p -= mb_head_off(tfname, p);
22442 #endif
22443 if (vim_ispathsep(*p))
22445 if (sepcount == 0 || (hasTilde && sepcount == 1))
22446 break;
22447 else
22448 sepcount --;
22451 if (hasTilde)
22453 --p;
22454 if (p >= tfname)
22455 *p = '~';
22456 else
22457 return FAIL;
22459 else
22460 ++p;
22462 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22463 vim_free(*bufp);
22464 *fnamelen = (int)STRLEN(p);
22465 *bufp = pbuf;
22466 *fnamep = p;
22468 return OK;
22470 #endif /* WIN3264 */
22473 * Adjust a filename, according to a string of modifiers.
22474 * *fnamep must be NUL terminated when called. When returning, the length is
22475 * determined by *fnamelen.
22476 * Returns VALID_ flags or -1 for failure.
22477 * When there is an error, *fnamep is set to NULL.
22480 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22481 char_u *src; /* string with modifiers */
22482 int *usedlen; /* characters after src that are used */
22483 char_u **fnamep; /* file name so far */
22484 char_u **bufp; /* buffer for allocated file name or NULL */
22485 int *fnamelen; /* length of fnamep */
22487 int valid = 0;
22488 char_u *tail;
22489 char_u *s, *p, *pbuf;
22490 char_u dirname[MAXPATHL];
22491 int c;
22492 int has_fullname = 0;
22493 #ifdef WIN3264
22494 int has_shortname = 0;
22495 #endif
22497 repeat:
22498 /* ":p" - full path/file_name */
22499 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22501 has_fullname = 1;
22503 valid |= VALID_PATH;
22504 *usedlen += 2;
22506 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22507 if ((*fnamep)[0] == '~'
22508 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22509 && ((*fnamep)[1] == '/'
22510 # ifdef BACKSLASH_IN_FILENAME
22511 || (*fnamep)[1] == '\\'
22512 # endif
22513 || (*fnamep)[1] == NUL)
22515 #endif
22518 *fnamep = expand_env_save(*fnamep);
22519 vim_free(*bufp); /* free any allocated file name */
22520 *bufp = *fnamep;
22521 if (*fnamep == NULL)
22522 return -1;
22525 /* When "/." or "/.." is used: force expansion to get rid of it. */
22526 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22528 if (vim_ispathsep(*p)
22529 && p[1] == '.'
22530 && (p[2] == NUL
22531 || vim_ispathsep(p[2])
22532 || (p[2] == '.'
22533 && (p[3] == NUL || vim_ispathsep(p[3])))))
22534 break;
22537 /* FullName_save() is slow, don't use it when not needed. */
22538 if (*p != NUL || !vim_isAbsName(*fnamep))
22540 *fnamep = FullName_save(*fnamep, *p != NUL);
22541 vim_free(*bufp); /* free any allocated file name */
22542 *bufp = *fnamep;
22543 if (*fnamep == NULL)
22544 return -1;
22547 /* Append a path separator to a directory. */
22548 if (mch_isdir(*fnamep))
22550 /* Make room for one or two extra characters. */
22551 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22552 vim_free(*bufp); /* free any allocated file name */
22553 *bufp = *fnamep;
22554 if (*fnamep == NULL)
22555 return -1;
22556 add_pathsep(*fnamep);
22560 /* ":." - path relative to the current directory */
22561 /* ":~" - path relative to the home directory */
22562 /* ":8" - shortname path - postponed till after */
22563 while (src[*usedlen] == ':'
22564 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22566 *usedlen += 2;
22567 if (c == '8')
22569 #ifdef WIN3264
22570 has_shortname = 1; /* Postpone this. */
22571 #endif
22572 continue;
22574 pbuf = NULL;
22575 /* Need full path first (use expand_env() to remove a "~/") */
22576 if (!has_fullname)
22578 if (c == '.' && **fnamep == '~')
22579 p = pbuf = expand_env_save(*fnamep);
22580 else
22581 p = pbuf = FullName_save(*fnamep, FALSE);
22583 else
22584 p = *fnamep;
22586 has_fullname = 0;
22588 if (p != NULL)
22590 if (c == '.')
22592 mch_dirname(dirname, MAXPATHL);
22593 s = shorten_fname(p, dirname);
22594 if (s != NULL)
22596 *fnamep = s;
22597 if (pbuf != NULL)
22599 vim_free(*bufp); /* free any allocated file name */
22600 *bufp = pbuf;
22601 pbuf = NULL;
22605 else
22607 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22608 /* Only replace it when it starts with '~' */
22609 if (*dirname == '~')
22611 s = vim_strsave(dirname);
22612 if (s != NULL)
22614 *fnamep = s;
22615 vim_free(*bufp);
22616 *bufp = s;
22620 vim_free(pbuf);
22624 tail = gettail(*fnamep);
22625 *fnamelen = (int)STRLEN(*fnamep);
22627 /* ":h" - head, remove "/file_name", can be repeated */
22628 /* Don't remove the first "/" or "c:\" */
22629 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22631 valid |= VALID_HEAD;
22632 *usedlen += 2;
22633 s = get_past_head(*fnamep);
22634 while (tail > s && after_pathsep(s, tail))
22635 mb_ptr_back(*fnamep, tail);
22636 *fnamelen = (int)(tail - *fnamep);
22637 #ifdef VMS
22638 if (*fnamelen > 0)
22639 *fnamelen += 1; /* the path separator is part of the path */
22640 #endif
22641 if (*fnamelen == 0)
22643 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22644 p = vim_strsave((char_u *)".");
22645 if (p == NULL)
22646 return -1;
22647 vim_free(*bufp);
22648 *bufp = *fnamep = tail = p;
22649 *fnamelen = 1;
22651 else
22653 while (tail > s && !after_pathsep(s, tail))
22654 mb_ptr_back(*fnamep, tail);
22658 /* ":8" - shortname */
22659 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22661 *usedlen += 2;
22662 #ifdef WIN3264
22663 has_shortname = 1;
22664 #endif
22667 #ifdef WIN3264
22668 /* Check shortname after we have done 'heads' and before we do 'tails'
22670 if (has_shortname)
22672 pbuf = NULL;
22673 /* Copy the string if it is shortened by :h */
22674 if (*fnamelen < (int)STRLEN(*fnamep))
22676 p = vim_strnsave(*fnamep, *fnamelen);
22677 if (p == 0)
22678 return -1;
22679 vim_free(*bufp);
22680 *bufp = *fnamep = p;
22683 /* Split into two implementations - makes it easier. First is where
22684 * there isn't a full name already, second is where there is.
22686 if (!has_fullname && !vim_isAbsName(*fnamep))
22688 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22689 return -1;
22691 else
22693 int l;
22695 /* Simple case, already have the full-name
22696 * Nearly always shorter, so try first time. */
22697 l = *fnamelen;
22698 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22699 return -1;
22701 if (l == 0)
22703 /* Couldn't find the filename.. search the paths.
22705 l = *fnamelen;
22706 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22707 return -1;
22709 *fnamelen = l;
22712 #endif /* WIN3264 */
22714 /* ":t" - tail, just the basename */
22715 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22717 *usedlen += 2;
22718 *fnamelen -= (int)(tail - *fnamep);
22719 *fnamep = tail;
22722 /* ":e" - extension, can be repeated */
22723 /* ":r" - root, without extension, can be repeated */
22724 while (src[*usedlen] == ':'
22725 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22727 /* find a '.' in the tail:
22728 * - for second :e: before the current fname
22729 * - otherwise: The last '.'
22731 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22732 s = *fnamep - 2;
22733 else
22734 s = *fnamep + *fnamelen - 1;
22735 for ( ; s > tail; --s)
22736 if (s[0] == '.')
22737 break;
22738 if (src[*usedlen + 1] == 'e') /* :e */
22740 if (s > tail)
22742 *fnamelen += (int)(*fnamep - (s + 1));
22743 *fnamep = s + 1;
22744 #ifdef VMS
22745 /* cut version from the extension */
22746 s = *fnamep + *fnamelen - 1;
22747 for ( ; s > *fnamep; --s)
22748 if (s[0] == ';')
22749 break;
22750 if (s > *fnamep)
22751 *fnamelen = s - *fnamep;
22752 #endif
22754 else if (*fnamep <= tail)
22755 *fnamelen = 0;
22757 else /* :r */
22759 if (s > tail) /* remove one extension */
22760 *fnamelen = (int)(s - *fnamep);
22762 *usedlen += 2;
22765 /* ":s?pat?foo?" - substitute */
22766 /* ":gs?pat?foo?" - global substitute */
22767 if (src[*usedlen] == ':'
22768 && (src[*usedlen + 1] == 's'
22769 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22771 char_u *str;
22772 char_u *pat;
22773 char_u *sub;
22774 int sep;
22775 char_u *flags;
22776 int didit = FALSE;
22778 flags = (char_u *)"";
22779 s = src + *usedlen + 2;
22780 if (src[*usedlen + 1] == 'g')
22782 flags = (char_u *)"g";
22783 ++s;
22786 sep = *s++;
22787 if (sep)
22789 /* find end of pattern */
22790 p = vim_strchr(s, sep);
22791 if (p != NULL)
22793 pat = vim_strnsave(s, (int)(p - s));
22794 if (pat != NULL)
22796 s = p + 1;
22797 /* find end of substitution */
22798 p = vim_strchr(s, sep);
22799 if (p != NULL)
22801 sub = vim_strnsave(s, (int)(p - s));
22802 str = vim_strnsave(*fnamep, *fnamelen);
22803 if (sub != NULL && str != NULL)
22805 *usedlen = (int)(p + 1 - src);
22806 s = do_string_sub(str, pat, sub, flags);
22807 if (s != NULL)
22809 *fnamep = s;
22810 *fnamelen = (int)STRLEN(s);
22811 vim_free(*bufp);
22812 *bufp = s;
22813 didit = TRUE;
22816 vim_free(sub);
22817 vim_free(str);
22819 vim_free(pat);
22822 /* after using ":s", repeat all the modifiers */
22823 if (didit)
22824 goto repeat;
22828 return valid;
22832 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22833 * "flags" can be "g" to do a global substitute.
22834 * Returns an allocated string, NULL for error.
22836 char_u *
22837 do_string_sub(str, pat, sub, flags)
22838 char_u *str;
22839 char_u *pat;
22840 char_u *sub;
22841 char_u *flags;
22843 int sublen;
22844 regmatch_T regmatch;
22845 int i;
22846 int do_all;
22847 char_u *tail;
22848 garray_T ga;
22849 char_u *ret;
22850 char_u *save_cpo;
22852 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22853 save_cpo = p_cpo;
22854 p_cpo = empty_option;
22856 ga_init2(&ga, 1, 200);
22858 do_all = (flags[0] == 'g');
22860 regmatch.rm_ic = p_ic;
22861 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22862 if (regmatch.regprog != NULL)
22864 tail = str;
22865 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22868 * Get some space for a temporary buffer to do the substitution
22869 * into. It will contain:
22870 * - The text up to where the match is.
22871 * - The substituted text.
22872 * - The text after the match.
22874 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22875 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22876 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22878 ga_clear(&ga);
22879 break;
22882 /* copy the text up to where the match is */
22883 i = (int)(regmatch.startp[0] - tail);
22884 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22885 /* add the substituted text */
22886 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22887 + ga.ga_len + i, TRUE, TRUE, FALSE);
22888 ga.ga_len += i + sublen - 1;
22889 /* avoid getting stuck on a match with an empty string */
22890 if (tail == regmatch.endp[0])
22892 if (*tail == NUL)
22893 break;
22894 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22895 ++ga.ga_len;
22897 else
22899 tail = regmatch.endp[0];
22900 if (*tail == NUL)
22901 break;
22903 if (!do_all)
22904 break;
22907 if (ga.ga_data != NULL)
22908 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22910 vim_free(regmatch.regprog);
22913 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22914 ga_clear(&ga);
22915 if (p_cpo == empty_option)
22916 p_cpo = save_cpo;
22917 else
22918 /* Darn, evaluating {sub} expression changed the value. */
22919 free_string_option(save_cpo);
22921 return ret;
22924 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */