a242ebf584f98ba9514177d3b96cbe4c93809178
[vim_extended.git] / src / eval.c
bloba242ebf584f98ba9514177d3b96cbe4c93809178
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));
470 #endif
471 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
472 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
473 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
474 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
475 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
476 #ifdef FEAT_FLOAT
477 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
478 #endif
479 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
480 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
481 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
482 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
485 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
490 #ifdef FEAT_FLOAT
491 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
492 #endif
493 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
494 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
497 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
498 #if defined(FEAT_INS_EXPAND)
499 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
501 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
502 #endif
503 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
505 #ifdef FEAT_FLOAT
506 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
507 #endif
508 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
509 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
510 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
511 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
513 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
514 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
530 #ifdef FEAT_FLOAT
531 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
533 #endif
534 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
537 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
605 #ifdef FEAT_FLOAT
606 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
607 #endif
608 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
620 #ifdef vim_mkdir
621 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
622 #endif
623 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
626 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
627 #ifdef FEAT_FLOAT
628 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
635 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
636 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
647 #ifdef FEAT_FLOAT
648 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
649 #endif
650 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
669 #ifdef FEAT_FLOAT
670 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
671 #endif
672 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
676 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
677 #ifdef FEAT_FLOAT
678 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
680 #endif
681 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
682 #ifdef HAVE_STRFTIME
683 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
684 #endif
685 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
686 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
687 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
688 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
691 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
708 #ifdef FEAT_FLOAT
709 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
710 #endif
711 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
726 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
727 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
728 static int get_env_len __ARGS((char_u **arg));
729 static int get_id_len __ARGS((char_u **arg));
730 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
731 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
732 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
733 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
734 valid character */
735 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
736 static int eval_isnamec __ARGS((int c));
737 static int eval_isnamec1 __ARGS((int c));
738 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
739 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
740 static typval_T *alloc_tv __ARGS((void));
741 static typval_T *alloc_string_tv __ARGS((char_u *string));
742 static void init_tv __ARGS((typval_T *varp));
743 static long get_tv_number __ARGS((typval_T *varp));
744 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
745 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
746 static char_u *get_tv_string __ARGS((typval_T *varp));
747 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
748 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
749 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
750 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
751 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
752 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
753 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
754 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
755 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
756 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
757 static int var_check_ro __ARGS((int flags, char_u *name));
758 static int var_check_fixed __ARGS((int flags, char_u *name));
759 static int tv_check_lock __ARGS((int lock, char_u *name));
760 static void copy_tv __ARGS((typval_T *from, typval_T *to));
761 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
762 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
763 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
764 static int eval_fname_script __ARGS((char_u *p));
765 static int eval_fname_sid __ARGS((char_u *p));
766 static void list_func_head __ARGS((ufunc_T *fp, int indent));
767 static ufunc_T *find_func __ARGS((char_u *name));
768 static int function_exists __ARGS((char_u *name));
769 static int builtin_function __ARGS((char_u *name));
770 #ifdef FEAT_PROFILE
771 static void func_do_profile __ARGS((ufunc_T *fp));
772 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
773 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
774 static int
775 # ifdef __BORLANDC__
776 _RTLENTRYF
777 # endif
778 prof_total_cmp __ARGS((const void *s1, const void *s2));
779 static int
780 # ifdef __BORLANDC__
781 _RTLENTRYF
782 # endif
783 prof_self_cmp __ARGS((const void *s1, const void *s2));
784 #endif
785 static int script_autoload __ARGS((char_u *name, int reload));
786 static char_u *autoload_name __ARGS((char_u *name));
787 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
788 static void func_free __ARGS((ufunc_T *fp));
789 static void func_unref __ARGS((char_u *name));
790 static void func_ref __ARGS((char_u *name));
791 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));
792 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
793 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
794 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
795 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
796 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
797 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
799 /* Character used as separated in autoload function/variable names. */
800 #define AUTOLOAD_CHAR '#'
803 * Initialize the global and v: variables.
805 void
806 eval_init()
808 int i;
809 struct vimvar *p;
811 init_var_dict(&globvardict, &globvars_var);
812 init_var_dict(&vimvardict, &vimvars_var);
813 hash_init(&compat_hashtab);
814 hash_init(&func_hashtab);
816 for (i = 0; i < VV_LEN; ++i)
818 p = &vimvars[i];
819 STRCPY(p->vv_di.di_key, p->vv_name);
820 if (p->vv_flags & VV_RO)
821 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
822 else if (p->vv_flags & VV_RO_SBX)
823 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
824 else
825 p->vv_di.di_flags = DI_FLAGS_FIX;
827 /* add to v: scope dict, unless the value is not always available */
828 if (p->vv_type != VAR_UNKNOWN)
829 hash_add(&vimvarht, p->vv_di.di_key);
830 if (p->vv_flags & VV_COMPAT)
831 /* add to compat scope dict */
832 hash_add(&compat_hashtab, p->vv_di.di_key);
834 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
837 #if defined(EXITFREE) || defined(PROTO)
838 void
839 eval_clear()
841 int i;
842 struct vimvar *p;
844 for (i = 0; i < VV_LEN; ++i)
846 p = &vimvars[i];
847 if (p->vv_di.di_tv.v_type == VAR_STRING)
849 vim_free(p->vv_str);
850 p->vv_str = NULL;
852 else if (p->vv_di.di_tv.v_type == VAR_LIST)
854 list_unref(p->vv_list);
855 p->vv_list = NULL;
858 hash_clear(&vimvarht);
859 hash_init(&vimvarht); /* garbage_collect() will access it */
860 hash_clear(&compat_hashtab);
862 /* script-local variables */
863 for (i = 1; i <= ga_scripts.ga_len; ++i)
864 vars_clear(&SCRIPT_VARS(i));
865 ga_clear(&ga_scripts);
866 free_scriptnames();
868 /* global variables */
869 vars_clear(&globvarht);
871 /* autoloaded script names */
872 ga_clear_strings(&ga_loaded);
874 /* unreferenced lists and dicts */
875 (void)garbage_collect();
877 /* functions */
878 free_all_functions();
879 hash_clear(&func_hashtab);
881 #endif
884 * Return the name of the executed function.
886 char_u *
887 func_name(cookie)
888 void *cookie;
890 return ((funccall_T *)cookie)->func->uf_name;
894 * Return the address holding the next breakpoint line for a funccall cookie.
896 linenr_T *
897 func_breakpoint(cookie)
898 void *cookie;
900 return &((funccall_T *)cookie)->breakpoint;
904 * Return the address holding the debug tick for a funccall cookie.
906 int *
907 func_dbg_tick(cookie)
908 void *cookie;
910 return &((funccall_T *)cookie)->dbg_tick;
914 * Return the nesting level for a funccall cookie.
917 func_level(cookie)
918 void *cookie;
920 return ((funccall_T *)cookie)->level;
923 /* pointer to funccal for currently active function */
924 funccall_T *current_funccal = NULL;
927 * Return TRUE when a function was ended by a ":return" command.
930 current_func_returned()
932 return current_funccal->returned;
937 * Set an internal variable to a string value. Creates the variable if it does
938 * not already exist.
940 void
941 set_internal_string_var(name, value)
942 char_u *name;
943 char_u *value;
945 char_u *val;
946 typval_T *tvp;
948 val = vim_strsave(value);
949 if (val != NULL)
951 tvp = alloc_string_tv(val);
952 if (tvp != NULL)
954 set_var(name, tvp, FALSE);
955 free_tv(tvp);
960 static lval_T *redir_lval = NULL;
961 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
962 static char_u *redir_endp = NULL;
963 static char_u *redir_varname = NULL;
966 * Start recording command output to a variable
967 * Returns OK if successfully completed the setup. FAIL otherwise.
970 var_redir_start(name, append)
971 char_u *name;
972 int append; /* append to an existing variable */
974 int save_emsg;
975 int err;
976 typval_T tv;
978 /* Make sure a valid variable name is specified */
979 if (!eval_isnamec1(*name))
981 EMSG(_(e_invarg));
982 return FAIL;
985 redir_varname = vim_strsave(name);
986 if (redir_varname == NULL)
987 return FAIL;
989 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
990 if (redir_lval == NULL)
992 var_redir_stop();
993 return FAIL;
996 /* The output is stored in growarray "redir_ga" until redirection ends. */
997 ga_init2(&redir_ga, (int)sizeof(char), 500);
999 /* Parse the variable name (can be a dict or list entry). */
1000 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1001 FNE_CHECK_START);
1002 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1004 if (redir_endp != NULL && *redir_endp != NUL)
1005 /* Trailing characters are present after the variable name */
1006 EMSG(_(e_trailing));
1007 else
1008 EMSG(_(e_invarg));
1009 var_redir_stop();
1010 return FAIL;
1013 /* check if we can write to the variable: set it to or append an empty
1014 * string */
1015 save_emsg = did_emsg;
1016 did_emsg = FALSE;
1017 tv.v_type = VAR_STRING;
1018 tv.vval.v_string = (char_u *)"";
1019 if (append)
1020 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1021 else
1022 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1023 err = did_emsg;
1024 did_emsg |= save_emsg;
1025 if (err)
1027 var_redir_stop();
1028 return FAIL;
1030 if (redir_lval->ll_newkey != NULL)
1032 /* Dictionary item was created, don't do it again. */
1033 vim_free(redir_lval->ll_newkey);
1034 redir_lval->ll_newkey = NULL;
1037 return OK;
1041 * Append "value[value_len]" to the variable set by var_redir_start().
1042 * The actual appending is postponed until redirection ends, because the value
1043 * appended may in fact be the string we write to, changing it may cause freed
1044 * memory to be used:
1045 * :redir => foo
1046 * :let foo
1047 * :redir END
1049 void
1050 var_redir_str(value, value_len)
1051 char_u *value;
1052 int value_len;
1054 int len;
1056 if (redir_lval == NULL)
1057 return;
1059 if (value_len == -1)
1060 len = (int)STRLEN(value); /* Append the entire string */
1061 else
1062 len = value_len; /* Append only "value_len" characters */
1064 if (ga_grow(&redir_ga, len) == OK)
1066 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1067 redir_ga.ga_len += len;
1069 else
1070 var_redir_stop();
1074 * Stop redirecting command output to a variable.
1076 void
1077 var_redir_stop()
1079 typval_T tv;
1081 if (redir_lval != NULL)
1083 /* Append the trailing NUL. */
1084 ga_append(&redir_ga, NUL);
1086 /* Assign the text to the variable. */
1087 tv.v_type = VAR_STRING;
1088 tv.vval.v_string = redir_ga.ga_data;
1089 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1090 vim_free(tv.vval.v_string);
1092 clear_lval(redir_lval);
1093 vim_free(redir_lval);
1094 redir_lval = NULL;
1096 vim_free(redir_varname);
1097 redir_varname = NULL;
1100 # if defined(FEAT_MBYTE) || defined(PROTO)
1102 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1103 char_u *enc_from;
1104 char_u *enc_to;
1105 char_u *fname_from;
1106 char_u *fname_to;
1108 int err = FALSE;
1110 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1111 set_vim_var_string(VV_CC_TO, enc_to, -1);
1112 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1113 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1114 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1115 err = TRUE;
1116 set_vim_var_string(VV_CC_FROM, NULL, -1);
1117 set_vim_var_string(VV_CC_TO, NULL, -1);
1118 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1119 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1121 if (err)
1122 return FAIL;
1123 return OK;
1125 # endif
1127 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1129 eval_printexpr(fname, args)
1130 char_u *fname;
1131 char_u *args;
1133 int err = FALSE;
1135 set_vim_var_string(VV_FNAME_IN, fname, -1);
1136 set_vim_var_string(VV_CMDARG, args, -1);
1137 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1138 err = TRUE;
1139 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1140 set_vim_var_string(VV_CMDARG, NULL, -1);
1142 if (err)
1144 mch_remove(fname);
1145 return FAIL;
1147 return OK;
1149 # endif
1151 # if defined(FEAT_DIFF) || defined(PROTO)
1152 void
1153 eval_diff(origfile, newfile, outfile)
1154 char_u *origfile;
1155 char_u *newfile;
1156 char_u *outfile;
1158 int err = FALSE;
1160 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1161 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1162 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1163 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1164 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1165 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1166 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1169 void
1170 eval_patch(origfile, difffile, outfile)
1171 char_u *origfile;
1172 char_u *difffile;
1173 char_u *outfile;
1175 int err;
1177 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1178 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1179 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1180 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1181 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1182 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1183 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1185 # endif
1188 * Top level evaluation function, returning a boolean.
1189 * Sets "error" to TRUE if there was an error.
1190 * Return TRUE or FALSE.
1193 eval_to_bool(arg, error, nextcmd, skip)
1194 char_u *arg;
1195 int *error;
1196 char_u **nextcmd;
1197 int skip; /* only parse, don't execute */
1199 typval_T tv;
1200 int retval = FALSE;
1202 if (skip)
1203 ++emsg_skip;
1204 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1205 *error = TRUE;
1206 else
1208 *error = FALSE;
1209 if (!skip)
1211 retval = (get_tv_number_chk(&tv, error) != 0);
1212 clear_tv(&tv);
1215 if (skip)
1216 --emsg_skip;
1218 return retval;
1222 * Top level evaluation function, returning a string. If "skip" is TRUE,
1223 * only parsing to "nextcmd" is done, without reporting errors. Return
1224 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1226 char_u *
1227 eval_to_string_skip(arg, nextcmd, skip)
1228 char_u *arg;
1229 char_u **nextcmd;
1230 int skip; /* only parse, don't execute */
1232 typval_T tv;
1233 char_u *retval;
1235 if (skip)
1236 ++emsg_skip;
1237 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1238 retval = NULL;
1239 else
1241 retval = vim_strsave(get_tv_string(&tv));
1242 clear_tv(&tv);
1244 if (skip)
1245 --emsg_skip;
1247 return retval;
1251 * Skip over an expression at "*pp".
1252 * Return FAIL for an error, OK otherwise.
1255 skip_expr(pp)
1256 char_u **pp;
1258 typval_T rettv;
1260 *pp = skipwhite(*pp);
1261 return eval1(pp, &rettv, FALSE);
1265 * Top level evaluation function, returning a string.
1266 * When "convert" is TRUE convert a List into a sequence of lines and convert
1267 * a Float to a String.
1268 * Return pointer to allocated memory, or NULL for failure.
1270 char_u *
1271 eval_to_string(arg, nextcmd, convert)
1272 char_u *arg;
1273 char_u **nextcmd;
1274 int convert;
1276 typval_T tv;
1277 char_u *retval;
1278 garray_T ga;
1279 char_u numbuf[NUMBUFLEN];
1281 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1282 retval = NULL;
1283 else
1285 if (convert && tv.v_type == VAR_LIST)
1287 ga_init2(&ga, (int)sizeof(char), 80);
1288 if (tv.vval.v_list != NULL)
1289 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1290 ga_append(&ga, NUL);
1291 retval = (char_u *)ga.ga_data;
1293 #ifdef FEAT_FLOAT
1294 else if (convert && tv.v_type == VAR_FLOAT)
1296 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1297 retval = vim_strsave(numbuf);
1299 #endif
1300 else
1301 retval = vim_strsave(get_tv_string(&tv));
1302 clear_tv(&tv);
1305 return retval;
1309 * Call eval_to_string() without using current local variables and using
1310 * textlock. When "use_sandbox" is TRUE use the sandbox.
1312 char_u *
1313 eval_to_string_safe(arg, nextcmd, use_sandbox)
1314 char_u *arg;
1315 char_u **nextcmd;
1316 int use_sandbox;
1318 char_u *retval;
1319 void *save_funccalp;
1321 save_funccalp = save_funccal();
1322 if (use_sandbox)
1323 ++sandbox;
1324 ++textlock;
1325 retval = eval_to_string(arg, nextcmd, FALSE);
1326 if (use_sandbox)
1327 --sandbox;
1328 --textlock;
1329 restore_funccal(save_funccalp);
1330 return retval;
1334 * Top level evaluation function, returning a number.
1335 * Evaluates "expr" silently.
1336 * Returns -1 for an error.
1339 eval_to_number(expr)
1340 char_u *expr;
1342 typval_T rettv;
1343 int retval;
1344 char_u *p = skipwhite(expr);
1346 ++emsg_off;
1348 if (eval1(&p, &rettv, TRUE) == FAIL)
1349 retval = -1;
1350 else
1352 retval = get_tv_number_chk(&rettv, NULL);
1353 clear_tv(&rettv);
1355 --emsg_off;
1357 return retval;
1361 * Prepare v: variable "idx" to be used.
1362 * Save the current typeval in "save_tv".
1363 * When not used yet add the variable to the v: hashtable.
1365 static void
1366 prepare_vimvar(idx, save_tv)
1367 int idx;
1368 typval_T *save_tv;
1370 *save_tv = vimvars[idx].vv_tv;
1371 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1372 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1376 * Restore v: variable "idx" to typeval "save_tv".
1377 * When no longer defined, remove the variable from the v: hashtable.
1379 static void
1380 restore_vimvar(idx, save_tv)
1381 int idx;
1382 typval_T *save_tv;
1384 hashitem_T *hi;
1386 vimvars[idx].vv_tv = *save_tv;
1387 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1389 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1390 if (HASHITEM_EMPTY(hi))
1391 EMSG2(_(e_intern2), "restore_vimvar()");
1392 else
1393 hash_remove(&vimvarht, hi);
1397 #if defined(FEAT_SPELL) || defined(PROTO)
1399 * Evaluate an expression to a list with suggestions.
1400 * For the "expr:" part of 'spellsuggest'.
1401 * Returns NULL when there is an error.
1403 list_T *
1404 eval_spell_expr(badword, expr)
1405 char_u *badword;
1406 char_u *expr;
1408 typval_T save_val;
1409 typval_T rettv;
1410 list_T *list = NULL;
1411 char_u *p = skipwhite(expr);
1413 /* Set "v:val" to the bad word. */
1414 prepare_vimvar(VV_VAL, &save_val);
1415 vimvars[VV_VAL].vv_type = VAR_STRING;
1416 vimvars[VV_VAL].vv_str = badword;
1417 if (p_verbose == 0)
1418 ++emsg_off;
1420 if (eval1(&p, &rettv, TRUE) == OK)
1422 if (rettv.v_type != VAR_LIST)
1423 clear_tv(&rettv);
1424 else
1425 list = rettv.vval.v_list;
1428 if (p_verbose == 0)
1429 --emsg_off;
1430 restore_vimvar(VV_VAL, &save_val);
1432 return list;
1436 * "list" is supposed to contain two items: a word and a number. Return the
1437 * word in "pp" and the number as the return value.
1438 * Return -1 if anything isn't right.
1439 * Used to get the good word and score from the eval_spell_expr() result.
1442 get_spellword(list, pp)
1443 list_T *list;
1444 char_u **pp;
1446 listitem_T *li;
1448 li = list->lv_first;
1449 if (li == NULL)
1450 return -1;
1451 *pp = get_tv_string(&li->li_tv);
1453 li = li->li_next;
1454 if (li == NULL)
1455 return -1;
1456 return get_tv_number(&li->li_tv);
1458 #endif
1461 * Top level evaluation function.
1462 * Returns an allocated typval_T with the result.
1463 * Returns NULL when there is an error.
1465 typval_T *
1466 eval_expr(arg, nextcmd)
1467 char_u *arg;
1468 char_u **nextcmd;
1470 typval_T *tv;
1472 tv = (typval_T *)alloc(sizeof(typval_T));
1473 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1475 vim_free(tv);
1476 tv = NULL;
1479 return tv;
1483 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1484 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1486 * Call some vimL function and return the result in "*rettv".
1487 * Uses argv[argc] for the function arguments. Only Number and String
1488 * arguments are currently supported.
1489 * Returns OK or FAIL.
1491 static int
1492 call_vim_function(func, argc, argv, safe, rettv)
1493 char_u *func;
1494 int argc;
1495 char_u **argv;
1496 int safe; /* use the sandbox */
1497 typval_T *rettv;
1499 typval_T *argvars;
1500 long n;
1501 int len;
1502 int i;
1503 int doesrange;
1504 void *save_funccalp = NULL;
1505 int ret;
1507 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1508 if (argvars == NULL)
1509 return FAIL;
1511 for (i = 0; i < argc; i++)
1513 /* Pass a NULL or empty argument as an empty string */
1514 if (argv[i] == NULL || *argv[i] == NUL)
1516 argvars[i].v_type = VAR_STRING;
1517 argvars[i].vval.v_string = (char_u *)"";
1518 continue;
1521 /* Recognize a number argument, the others must be strings. */
1522 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1523 if (len != 0 && len == (int)STRLEN(argv[i]))
1525 argvars[i].v_type = VAR_NUMBER;
1526 argvars[i].vval.v_number = n;
1528 else
1530 argvars[i].v_type = VAR_STRING;
1531 argvars[i].vval.v_string = argv[i];
1535 if (safe)
1537 save_funccalp = save_funccal();
1538 ++sandbox;
1541 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1542 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1543 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1544 &doesrange, TRUE, NULL);
1545 if (safe)
1547 --sandbox;
1548 restore_funccal(save_funccalp);
1550 vim_free(argvars);
1552 if (ret == FAIL)
1553 clear_tv(rettv);
1555 return ret;
1558 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1560 * Call vimL function "func" and return the result as a string.
1561 * Returns NULL when calling the function fails.
1562 * Uses argv[argc] for the function arguments.
1564 void *
1565 call_func_retstr(func, argc, argv, safe)
1566 char_u *func;
1567 int argc;
1568 char_u **argv;
1569 int safe; /* use the sandbox */
1571 typval_T rettv;
1572 char_u *retval;
1574 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1575 return NULL;
1577 retval = vim_strsave(get_tv_string(&rettv));
1578 clear_tv(&rettv);
1579 return retval;
1581 # endif
1583 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1585 * Call vimL function "func" and return the result as a number.
1586 * Returns -1 when calling the function fails.
1587 * Uses argv[argc] for the function arguments.
1589 long
1590 call_func_retnr(func, argc, argv, safe)
1591 char_u *func;
1592 int argc;
1593 char_u **argv;
1594 int safe; /* use the sandbox */
1596 typval_T rettv;
1597 long retval;
1599 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1600 return -1;
1602 retval = get_tv_number_chk(&rettv, NULL);
1603 clear_tv(&rettv);
1604 return retval;
1606 # endif
1609 * Call vimL function "func" and return the result as a List.
1610 * Uses argv[argc] for the function arguments.
1611 * Returns NULL when there is something wrong.
1613 void *
1614 call_func_retlist(func, argc, argv, safe)
1615 char_u *func;
1616 int argc;
1617 char_u **argv;
1618 int safe; /* use the sandbox */
1620 typval_T rettv;
1622 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1623 return NULL;
1625 if (rettv.v_type != VAR_LIST)
1627 clear_tv(&rettv);
1628 return NULL;
1631 return rettv.vval.v_list;
1633 #endif
1637 * Save the current function call pointer, and set it to NULL.
1638 * Used when executing autocommands and for ":source".
1640 void *
1641 save_funccal()
1643 funccall_T *fc = current_funccal;
1645 current_funccal = NULL;
1646 return (void *)fc;
1649 void
1650 restore_funccal(vfc)
1651 void *vfc;
1653 funccall_T *fc = (funccall_T *)vfc;
1655 current_funccal = fc;
1658 #if defined(FEAT_PROFILE) || defined(PROTO)
1660 * Prepare profiling for entering a child or something else that is not
1661 * counted for the script/function itself.
1662 * Should always be called in pair with prof_child_exit().
1664 void
1665 prof_child_enter(tm)
1666 proftime_T *tm; /* place to store waittime */
1668 funccall_T *fc = current_funccal;
1670 if (fc != NULL && fc->func->uf_profiling)
1671 profile_start(&fc->prof_child);
1672 script_prof_save(tm);
1676 * Take care of time spent in a child.
1677 * Should always be called after prof_child_enter().
1679 void
1680 prof_child_exit(tm)
1681 proftime_T *tm; /* where waittime was stored */
1683 funccall_T *fc = current_funccal;
1685 if (fc != NULL && fc->func->uf_profiling)
1687 profile_end(&fc->prof_child);
1688 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1689 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1690 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1692 script_prof_restore(tm);
1694 #endif
1697 #ifdef FEAT_FOLDING
1699 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1700 * it in "*cp". Doesn't give error messages.
1703 eval_foldexpr(arg, cp)
1704 char_u *arg;
1705 int *cp;
1707 typval_T tv;
1708 int retval;
1709 char_u *s;
1710 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1711 OPT_LOCAL);
1713 ++emsg_off;
1714 if (use_sandbox)
1715 ++sandbox;
1716 ++textlock;
1717 *cp = NUL;
1718 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1719 retval = 0;
1720 else
1722 /* If the result is a number, just return the number. */
1723 if (tv.v_type == VAR_NUMBER)
1724 retval = tv.vval.v_number;
1725 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1726 retval = 0;
1727 else
1729 /* If the result is a string, check if there is a non-digit before
1730 * the number. */
1731 s = tv.vval.v_string;
1732 if (!VIM_ISDIGIT(*s) && *s != '-')
1733 *cp = *s++;
1734 retval = atol((char *)s);
1736 clear_tv(&tv);
1738 --emsg_off;
1739 if (use_sandbox)
1740 --sandbox;
1741 --textlock;
1743 return retval;
1745 #endif
1748 * ":let" list all variable values
1749 * ":let var1 var2" list variable values
1750 * ":let var = expr" assignment command.
1751 * ":let var += expr" assignment command.
1752 * ":let var -= expr" assignment command.
1753 * ":let var .= expr" assignment command.
1754 * ":let [var1, var2] = expr" unpack list.
1756 void
1757 ex_let(eap)
1758 exarg_T *eap;
1760 char_u *arg = eap->arg;
1761 char_u *expr = NULL;
1762 typval_T rettv;
1763 int i;
1764 int var_count = 0;
1765 int semicolon = 0;
1766 char_u op[2];
1767 char_u *argend;
1768 int first = TRUE;
1770 argend = skip_var_list(arg, &var_count, &semicolon);
1771 if (argend == NULL)
1772 return;
1773 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1774 --argend;
1775 expr = vim_strchr(argend, '=');
1776 if (expr == NULL)
1779 * ":let" without "=": list variables
1781 if (*arg == '[')
1782 EMSG(_(e_invarg));
1783 else if (!ends_excmd(*arg))
1784 /* ":let var1 var2" */
1785 arg = list_arg_vars(eap, arg, &first);
1786 else if (!eap->skip)
1788 /* ":let" */
1789 list_glob_vars(&first);
1790 list_buf_vars(&first);
1791 list_win_vars(&first);
1792 #ifdef FEAT_WINDOWS
1793 list_tab_vars(&first);
1794 #endif
1795 list_script_vars(&first);
1796 list_func_vars(&first);
1797 list_vim_vars(&first);
1799 eap->nextcmd = check_nextcmd(arg);
1801 else
1803 op[0] = '=';
1804 op[1] = NUL;
1805 if (expr > argend)
1807 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1808 op[0] = expr[-1]; /* +=, -= or .= */
1810 expr = skipwhite(expr + 1);
1812 if (eap->skip)
1813 ++emsg_skip;
1814 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1815 if (eap->skip)
1817 if (i != FAIL)
1818 clear_tv(&rettv);
1819 --emsg_skip;
1821 else if (i != FAIL)
1823 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1824 op);
1825 clear_tv(&rettv);
1831 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1832 * Handles both "var" with any type and "[var, var; var]" with a list type.
1833 * When "nextchars" is not NULL it points to a string with characters that
1834 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1835 * or concatenate.
1836 * Returns OK or FAIL;
1838 static int
1839 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1840 char_u *arg_start;
1841 typval_T *tv;
1842 int copy; /* copy values from "tv", don't move */
1843 int semicolon; /* from skip_var_list() */
1844 int var_count; /* from skip_var_list() */
1845 char_u *nextchars;
1847 char_u *arg = arg_start;
1848 list_T *l;
1849 int i;
1850 listitem_T *item;
1851 typval_T ltv;
1853 if (*arg != '[')
1856 * ":let var = expr" or ":for var in list"
1858 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1859 return FAIL;
1860 return OK;
1864 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1866 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1868 EMSG(_(e_listreq));
1869 return FAIL;
1872 i = list_len(l);
1873 if (semicolon == 0 && var_count < i)
1875 EMSG(_("E687: Less targets than List items"));
1876 return FAIL;
1878 if (var_count - semicolon > i)
1880 EMSG(_("E688: More targets than List items"));
1881 return FAIL;
1884 item = l->lv_first;
1885 while (*arg != ']')
1887 arg = skipwhite(arg + 1);
1888 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1889 item = item->li_next;
1890 if (arg == NULL)
1891 return FAIL;
1893 arg = skipwhite(arg);
1894 if (*arg == ';')
1896 /* Put the rest of the list (may be empty) in the var after ';'.
1897 * Create a new list for this. */
1898 l = list_alloc();
1899 if (l == NULL)
1900 return FAIL;
1901 while (item != NULL)
1903 list_append_tv(l, &item->li_tv);
1904 item = item->li_next;
1907 ltv.v_type = VAR_LIST;
1908 ltv.v_lock = 0;
1909 ltv.vval.v_list = l;
1910 l->lv_refcount = 1;
1912 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1913 (char_u *)"]", nextchars);
1914 clear_tv(&ltv);
1915 if (arg == NULL)
1916 return FAIL;
1917 break;
1919 else if (*arg != ',' && *arg != ']')
1921 EMSG2(_(e_intern2), "ex_let_vars()");
1922 return FAIL;
1926 return OK;
1930 * Skip over assignable variable "var" or list of variables "[var, var]".
1931 * Used for ":let varvar = expr" and ":for varvar in expr".
1932 * For "[var, var]" increment "*var_count" for each variable.
1933 * for "[var, var; var]" set "semicolon".
1934 * Return NULL for an error.
1936 static char_u *
1937 skip_var_list(arg, var_count, semicolon)
1938 char_u *arg;
1939 int *var_count;
1940 int *semicolon;
1942 char_u *p, *s;
1944 if (*arg == '[')
1946 /* "[var, var]": find the matching ']'. */
1947 p = arg;
1948 for (;;)
1950 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1951 s = skip_var_one(p);
1952 if (s == p)
1954 EMSG2(_(e_invarg2), p);
1955 return NULL;
1957 ++*var_count;
1959 p = skipwhite(s);
1960 if (*p == ']')
1961 break;
1962 else if (*p == ';')
1964 if (*semicolon == 1)
1966 EMSG(_("Double ; in list of variables"));
1967 return NULL;
1969 *semicolon = 1;
1971 else if (*p != ',')
1973 EMSG2(_(e_invarg2), p);
1974 return NULL;
1977 return p + 1;
1979 else
1980 return skip_var_one(arg);
1984 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1985 * l[idx].
1987 static char_u *
1988 skip_var_one(arg)
1989 char_u *arg;
1991 if (*arg == '@' && arg[1] != NUL)
1992 return arg + 2;
1993 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
1994 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1998 * List variables for hashtab "ht" with prefix "prefix".
1999 * If "empty" is TRUE also list NULL strings as empty strings.
2001 static void
2002 list_hashtable_vars(ht, prefix, empty, first)
2003 hashtab_T *ht;
2004 char_u *prefix;
2005 int empty;
2006 int *first;
2008 hashitem_T *hi;
2009 dictitem_T *di;
2010 int todo;
2012 todo = (int)ht->ht_used;
2013 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2015 if (!HASHITEM_EMPTY(hi))
2017 --todo;
2018 di = HI2DI(hi);
2019 if (empty || di->di_tv.v_type != VAR_STRING
2020 || di->di_tv.vval.v_string != NULL)
2021 list_one_var(di, prefix, first);
2027 * List global variables.
2029 static void
2030 list_glob_vars(first)
2031 int *first;
2033 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2037 * List buffer variables.
2039 static void
2040 list_buf_vars(first)
2041 int *first;
2043 char_u numbuf[NUMBUFLEN];
2045 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2046 TRUE, first);
2048 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2049 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2050 numbuf, first);
2054 * List window variables.
2056 static void
2057 list_win_vars(first)
2058 int *first;
2060 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2061 (char_u *)"w:", TRUE, first);
2064 #ifdef FEAT_WINDOWS
2066 * List tab page variables.
2068 static void
2069 list_tab_vars(first)
2070 int *first;
2072 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2073 (char_u *)"t:", TRUE, first);
2075 #endif
2078 * List Vim variables.
2080 static void
2081 list_vim_vars(first)
2082 int *first;
2084 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2088 * List script-local variables, if there is a script.
2090 static void
2091 list_script_vars(first)
2092 int *first;
2094 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2095 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2096 (char_u *)"s:", FALSE, first);
2100 * List function variables, if there is a function.
2102 static void
2103 list_func_vars(first)
2104 int *first;
2106 if (current_funccal != NULL)
2107 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2108 (char_u *)"l:", FALSE, first);
2112 * List variables in "arg".
2114 static char_u *
2115 list_arg_vars(eap, arg, first)
2116 exarg_T *eap;
2117 char_u *arg;
2118 int *first;
2120 int error = FALSE;
2121 int len;
2122 char_u *name;
2123 char_u *name_start;
2124 char_u *arg_subsc;
2125 char_u *tofree;
2126 typval_T tv;
2128 while (!ends_excmd(*arg) && !got_int)
2130 if (error || eap->skip)
2132 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2133 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2135 emsg_severe = TRUE;
2136 EMSG(_(e_trailing));
2137 break;
2140 else
2142 /* get_name_len() takes care of expanding curly braces */
2143 name_start = name = arg;
2144 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2145 if (len <= 0)
2147 /* This is mainly to keep test 49 working: when expanding
2148 * curly braces fails overrule the exception error message. */
2149 if (len < 0 && !aborting())
2151 emsg_severe = TRUE;
2152 EMSG2(_(e_invarg2), arg);
2153 break;
2155 error = TRUE;
2157 else
2159 if (tofree != NULL)
2160 name = tofree;
2161 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2162 error = TRUE;
2163 else
2165 /* handle d.key, l[idx], f(expr) */
2166 arg_subsc = arg;
2167 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2168 error = TRUE;
2169 else
2171 if (arg == arg_subsc && len == 2 && name[1] == ':')
2173 switch (*name)
2175 case 'g': list_glob_vars(first); break;
2176 case 'b': list_buf_vars(first); break;
2177 case 'w': list_win_vars(first); break;
2178 #ifdef FEAT_WINDOWS
2179 case 't': list_tab_vars(first); break;
2180 #endif
2181 case 'v': list_vim_vars(first); break;
2182 case 's': list_script_vars(first); break;
2183 case 'l': list_func_vars(first); break;
2184 default:
2185 EMSG2(_("E738: Can't list variables for %s"), name);
2188 else
2190 char_u numbuf[NUMBUFLEN];
2191 char_u *tf;
2192 int c;
2193 char_u *s;
2195 s = echo_string(&tv, &tf, numbuf, 0);
2196 c = *arg;
2197 *arg = NUL;
2198 list_one_var_a((char_u *)"",
2199 arg == arg_subsc ? name : name_start,
2200 tv.v_type,
2201 s == NULL ? (char_u *)"" : s,
2202 first);
2203 *arg = c;
2204 vim_free(tf);
2206 clear_tv(&tv);
2211 vim_free(tofree);
2214 arg = skipwhite(arg);
2217 return arg;
2221 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2222 * Returns a pointer to the char just after the var name.
2223 * Returns NULL if there is an error.
2225 static char_u *
2226 ex_let_one(arg, tv, copy, endchars, op)
2227 char_u *arg; /* points to variable name */
2228 typval_T *tv; /* value to assign to variable */
2229 int copy; /* copy value from "tv" */
2230 char_u *endchars; /* valid chars after variable name or NULL */
2231 char_u *op; /* "+", "-", "." or NULL*/
2233 int c1;
2234 char_u *name;
2235 char_u *p;
2236 char_u *arg_end = NULL;
2237 int len;
2238 int opt_flags;
2239 char_u *tofree = NULL;
2242 * ":let $VAR = expr": Set environment variable.
2244 if (*arg == '$')
2246 /* Find the end of the name. */
2247 ++arg;
2248 name = arg;
2249 len = get_env_len(&arg);
2250 if (len == 0)
2251 EMSG2(_(e_invarg2), name - 1);
2252 else
2254 if (op != NULL && (*op == '+' || *op == '-'))
2255 EMSG2(_(e_letwrong), op);
2256 else if (endchars != NULL
2257 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2258 EMSG(_(e_letunexp));
2259 else
2261 c1 = name[len];
2262 name[len] = NUL;
2263 p = get_tv_string_chk(tv);
2264 if (p != NULL && op != NULL && *op == '.')
2266 int mustfree = FALSE;
2267 char_u *s = vim_getenv(name, &mustfree);
2269 if (s != NULL)
2271 p = tofree = concat_str(s, p);
2272 if (mustfree)
2273 vim_free(s);
2276 if (p != NULL)
2278 vim_setenv(name, p);
2279 if (STRICMP(name, "HOME") == 0)
2280 init_homedir();
2281 else if (didset_vim && STRICMP(name, "VIM") == 0)
2282 didset_vim = FALSE;
2283 else if (didset_vimruntime
2284 && STRICMP(name, "VIMRUNTIME") == 0)
2285 didset_vimruntime = FALSE;
2286 arg_end = arg;
2288 name[len] = c1;
2289 vim_free(tofree);
2295 * ":let &option = expr": Set option value.
2296 * ":let &l:option = expr": Set local option value.
2297 * ":let &g:option = expr": Set global option value.
2299 else if (*arg == '&')
2301 /* Find the end of the name. */
2302 p = find_option_end(&arg, &opt_flags);
2303 if (p == NULL || (endchars != NULL
2304 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2305 EMSG(_(e_letunexp));
2306 else
2308 long n;
2309 int opt_type;
2310 long numval;
2311 char_u *stringval = NULL;
2312 char_u *s;
2314 c1 = *p;
2315 *p = NUL;
2317 n = get_tv_number(tv);
2318 s = get_tv_string_chk(tv); /* != NULL if number or string */
2319 if (s != NULL && op != NULL && *op != '=')
2321 opt_type = get_option_value(arg, &numval,
2322 &stringval, opt_flags);
2323 if ((opt_type == 1 && *op == '.')
2324 || (opt_type == 0 && *op != '.'))
2325 EMSG2(_(e_letwrong), op);
2326 else
2328 if (opt_type == 1) /* number */
2330 if (*op == '+')
2331 n = numval + n;
2332 else
2333 n = numval - n;
2335 else if (opt_type == 0 && stringval != NULL) /* string */
2337 s = concat_str(stringval, s);
2338 vim_free(stringval);
2339 stringval = s;
2343 if (s != NULL)
2345 set_option_value(arg, n, s, opt_flags);
2346 arg_end = p;
2348 *p = c1;
2349 vim_free(stringval);
2354 * ":let @r = expr": Set register contents.
2356 else if (*arg == '@')
2358 ++arg;
2359 if (op != NULL && (*op == '+' || *op == '-'))
2360 EMSG2(_(e_letwrong), op);
2361 else if (endchars != NULL
2362 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2363 EMSG(_(e_letunexp));
2364 else
2366 char_u *ptofree = NULL;
2367 char_u *s;
2369 p = get_tv_string_chk(tv);
2370 if (p != NULL && op != NULL && *op == '.')
2372 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2373 if (s != NULL)
2375 p = ptofree = concat_str(s, p);
2376 vim_free(s);
2379 if (p != NULL)
2381 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2382 arg_end = arg + 1;
2384 vim_free(ptofree);
2389 * ":let var = expr": Set internal variable.
2390 * ":let {expr} = expr": Idem, name made with curly braces
2392 else if (eval_isnamec1(*arg) || *arg == '{')
2394 lval_T lv;
2396 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2397 if (p != NULL && lv.ll_name != NULL)
2399 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2400 EMSG(_(e_letunexp));
2401 else
2403 set_var_lval(&lv, p, tv, copy, op);
2404 arg_end = p;
2407 clear_lval(&lv);
2410 else
2411 EMSG2(_(e_invarg2), arg);
2413 return arg_end;
2417 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2419 static int
2420 check_changedtick(arg)
2421 char_u *arg;
2423 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2425 EMSG2(_(e_readonlyvar), arg);
2426 return TRUE;
2428 return FALSE;
2432 * Get an lval: variable, Dict item or List item that can be assigned a value
2433 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2434 * "name.key", "name.key[expr]" etc.
2435 * Indexing only works if "name" is an existing List or Dictionary.
2436 * "name" points to the start of the name.
2437 * If "rettv" is not NULL it points to the value to be assigned.
2438 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2439 * wrong; must end in space or cmd separator.
2441 * Returns a pointer to just after the name, including indexes.
2442 * When an evaluation error occurs "lp->ll_name" is NULL;
2443 * Returns NULL for a parsing error. Still need to free items in "lp"!
2445 static char_u *
2446 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2447 char_u *name;
2448 typval_T *rettv;
2449 lval_T *lp;
2450 int unlet;
2451 int skip;
2452 int quiet; /* don't give error messages */
2453 int fne_flags; /* flags for find_name_end() */
2455 char_u *p;
2456 char_u *expr_start, *expr_end;
2457 int cc;
2458 dictitem_T *v;
2459 typval_T var1;
2460 typval_T var2;
2461 int empty1 = FALSE;
2462 listitem_T *ni;
2463 char_u *key = NULL;
2464 int len;
2465 hashtab_T *ht;
2467 /* Clear everything in "lp". */
2468 vim_memset(lp, 0, sizeof(lval_T));
2470 if (skip)
2472 /* When skipping just find the end of the name. */
2473 lp->ll_name = name;
2474 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2477 /* Find the end of the name. */
2478 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2479 if (expr_start != NULL)
2481 /* Don't expand the name when we already know there is an error. */
2482 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2483 && *p != '[' && *p != '.')
2485 EMSG(_(e_trailing));
2486 return NULL;
2489 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2490 if (lp->ll_exp_name == NULL)
2492 /* Report an invalid expression in braces, unless the
2493 * expression evaluation has been cancelled due to an
2494 * aborting error, an interrupt, or an exception. */
2495 if (!aborting() && !quiet)
2497 emsg_severe = TRUE;
2498 EMSG2(_(e_invarg2), name);
2499 return NULL;
2502 lp->ll_name = lp->ll_exp_name;
2504 else
2505 lp->ll_name = name;
2507 /* Without [idx] or .key we are done. */
2508 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2509 return p;
2511 cc = *p;
2512 *p = NUL;
2513 v = find_var(lp->ll_name, &ht);
2514 if (v == NULL && !quiet)
2515 EMSG2(_(e_undefvar), lp->ll_name);
2516 *p = cc;
2517 if (v == NULL)
2518 return NULL;
2521 * Loop until no more [idx] or .key is following.
2523 lp->ll_tv = &v->di_tv;
2524 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2526 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2527 && !(lp->ll_tv->v_type == VAR_DICT
2528 && lp->ll_tv->vval.v_dict != NULL))
2530 if (!quiet)
2531 EMSG(_("E689: Can only index a List or Dictionary"));
2532 return NULL;
2534 if (lp->ll_range)
2536 if (!quiet)
2537 EMSG(_("E708: [:] must come last"));
2538 return NULL;
2541 len = -1;
2542 if (*p == '.')
2544 key = p + 1;
2545 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2547 if (len == 0)
2549 if (!quiet)
2550 EMSG(_(e_emptykey));
2551 return NULL;
2553 p = key + len;
2555 else
2557 /* Get the index [expr] or the first index [expr: ]. */
2558 p = skipwhite(p + 1);
2559 if (*p == ':')
2560 empty1 = TRUE;
2561 else
2563 empty1 = FALSE;
2564 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2565 return NULL;
2566 if (get_tv_string_chk(&var1) == NULL)
2568 /* not a number or string */
2569 clear_tv(&var1);
2570 return NULL;
2574 /* Optionally get the second index [ :expr]. */
2575 if (*p == ':')
2577 if (lp->ll_tv->v_type == VAR_DICT)
2579 if (!quiet)
2580 EMSG(_(e_dictrange));
2581 if (!empty1)
2582 clear_tv(&var1);
2583 return NULL;
2585 if (rettv != NULL && (rettv->v_type != VAR_LIST
2586 || rettv->vval.v_list == NULL))
2588 if (!quiet)
2589 EMSG(_("E709: [:] requires a List value"));
2590 if (!empty1)
2591 clear_tv(&var1);
2592 return NULL;
2594 p = skipwhite(p + 1);
2595 if (*p == ']')
2596 lp->ll_empty2 = TRUE;
2597 else
2599 lp->ll_empty2 = FALSE;
2600 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2602 if (!empty1)
2603 clear_tv(&var1);
2604 return NULL;
2606 if (get_tv_string_chk(&var2) == NULL)
2608 /* not a number or string */
2609 if (!empty1)
2610 clear_tv(&var1);
2611 clear_tv(&var2);
2612 return NULL;
2615 lp->ll_range = TRUE;
2617 else
2618 lp->ll_range = FALSE;
2620 if (*p != ']')
2622 if (!quiet)
2623 EMSG(_(e_missbrac));
2624 if (!empty1)
2625 clear_tv(&var1);
2626 if (lp->ll_range && !lp->ll_empty2)
2627 clear_tv(&var2);
2628 return NULL;
2631 /* Skip to past ']'. */
2632 ++p;
2635 if (lp->ll_tv->v_type == VAR_DICT)
2637 if (len == -1)
2639 /* "[key]": get key from "var1" */
2640 key = get_tv_string(&var1); /* is number or string */
2641 if (*key == NUL)
2643 if (!quiet)
2644 EMSG(_(e_emptykey));
2645 clear_tv(&var1);
2646 return NULL;
2649 lp->ll_list = NULL;
2650 lp->ll_dict = lp->ll_tv->vval.v_dict;
2651 lp->ll_di = dict_find(lp->ll_dict, key, len);
2652 if (lp->ll_di == NULL)
2654 /* Key does not exist in dict: may need to add it. */
2655 if (*p == '[' || *p == '.' || unlet)
2657 if (!quiet)
2658 EMSG2(_(e_dictkey), key);
2659 if (len == -1)
2660 clear_tv(&var1);
2661 return NULL;
2663 if (len == -1)
2664 lp->ll_newkey = vim_strsave(key);
2665 else
2666 lp->ll_newkey = vim_strnsave(key, len);
2667 if (len == -1)
2668 clear_tv(&var1);
2669 if (lp->ll_newkey == NULL)
2670 p = NULL;
2671 break;
2673 if (len == -1)
2674 clear_tv(&var1);
2675 lp->ll_tv = &lp->ll_di->di_tv;
2677 else
2680 * Get the number and item for the only or first index of the List.
2682 if (empty1)
2683 lp->ll_n1 = 0;
2684 else
2686 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2687 clear_tv(&var1);
2689 lp->ll_dict = NULL;
2690 lp->ll_list = lp->ll_tv->vval.v_list;
2691 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2692 if (lp->ll_li == NULL)
2694 if (lp->ll_n1 < 0)
2696 lp->ll_n1 = 0;
2697 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2700 if (lp->ll_li == NULL)
2702 if (lp->ll_range && !lp->ll_empty2)
2703 clear_tv(&var2);
2704 return NULL;
2708 * May need to find the item or absolute index for the second
2709 * index of a range.
2710 * When no index given: "lp->ll_empty2" is TRUE.
2711 * Otherwise "lp->ll_n2" is set to the second index.
2713 if (lp->ll_range && !lp->ll_empty2)
2715 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2716 clear_tv(&var2);
2717 if (lp->ll_n2 < 0)
2719 ni = list_find(lp->ll_list, lp->ll_n2);
2720 if (ni == NULL)
2721 return NULL;
2722 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2725 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2726 if (lp->ll_n1 < 0)
2727 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2728 if (lp->ll_n2 < lp->ll_n1)
2729 return NULL;
2732 lp->ll_tv = &lp->ll_li->li_tv;
2736 return p;
2740 * Clear lval "lp" that was filled by get_lval().
2742 static void
2743 clear_lval(lp)
2744 lval_T *lp;
2746 vim_free(lp->ll_exp_name);
2747 vim_free(lp->ll_newkey);
2751 * Set a variable that was parsed by get_lval() to "rettv".
2752 * "endp" points to just after the parsed name.
2753 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2755 static void
2756 set_var_lval(lp, endp, rettv, copy, op)
2757 lval_T *lp;
2758 char_u *endp;
2759 typval_T *rettv;
2760 int copy;
2761 char_u *op;
2763 int cc;
2764 listitem_T *ri;
2765 dictitem_T *di;
2767 if (lp->ll_tv == NULL)
2769 if (!check_changedtick(lp->ll_name))
2771 cc = *endp;
2772 *endp = NUL;
2773 if (op != NULL && *op != '=')
2775 typval_T tv;
2777 /* handle +=, -= and .= */
2778 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2779 &tv, TRUE) == OK)
2781 if (tv_op(&tv, rettv, op) == OK)
2782 set_var(lp->ll_name, &tv, FALSE);
2783 clear_tv(&tv);
2786 else
2787 set_var(lp->ll_name, rettv, copy);
2788 *endp = cc;
2791 else if (tv_check_lock(lp->ll_newkey == NULL
2792 ? lp->ll_tv->v_lock
2793 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2795 else if (lp->ll_range)
2798 * Assign the List values to the list items.
2800 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2802 if (op != NULL && *op != '=')
2803 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2804 else
2806 clear_tv(&lp->ll_li->li_tv);
2807 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2809 ri = ri->li_next;
2810 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2811 break;
2812 if (lp->ll_li->li_next == NULL)
2814 /* Need to add an empty item. */
2815 if (list_append_number(lp->ll_list, 0) == FAIL)
2817 ri = NULL;
2818 break;
2821 lp->ll_li = lp->ll_li->li_next;
2822 ++lp->ll_n1;
2824 if (ri != NULL)
2825 EMSG(_("E710: List value has more items than target"));
2826 else if (lp->ll_empty2
2827 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2828 : lp->ll_n1 != lp->ll_n2)
2829 EMSG(_("E711: List value has not enough items"));
2831 else
2834 * Assign to a List or Dictionary item.
2836 if (lp->ll_newkey != NULL)
2838 if (op != NULL && *op != '=')
2840 EMSG2(_(e_letwrong), op);
2841 return;
2844 /* Need to add an item to the Dictionary. */
2845 di = dictitem_alloc(lp->ll_newkey);
2846 if (di == NULL)
2847 return;
2848 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2850 vim_free(di);
2851 return;
2853 lp->ll_tv = &di->di_tv;
2855 else if (op != NULL && *op != '=')
2857 tv_op(lp->ll_tv, rettv, op);
2858 return;
2860 else
2861 clear_tv(lp->ll_tv);
2864 * Assign the value to the variable or list item.
2866 if (copy)
2867 copy_tv(rettv, lp->ll_tv);
2868 else
2870 *lp->ll_tv = *rettv;
2871 lp->ll_tv->v_lock = 0;
2872 init_tv(rettv);
2878 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2879 * Returns OK or FAIL.
2881 static int
2882 tv_op(tv1, tv2, op)
2883 typval_T *tv1;
2884 typval_T *tv2;
2885 char_u *op;
2887 long n;
2888 char_u numbuf[NUMBUFLEN];
2889 char_u *s;
2891 /* Can't do anything with a Funcref or a Dict on the right. */
2892 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2894 switch (tv1->v_type)
2896 case VAR_DICT:
2897 case VAR_FUNC:
2898 break;
2900 case VAR_LIST:
2901 if (*op != '+' || tv2->v_type != VAR_LIST)
2902 break;
2903 /* List += List */
2904 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2905 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2906 return OK;
2908 case VAR_NUMBER:
2909 case VAR_STRING:
2910 if (tv2->v_type == VAR_LIST)
2911 break;
2912 if (*op == '+' || *op == '-')
2914 /* nr += nr or nr -= nr*/
2915 n = get_tv_number(tv1);
2916 #ifdef FEAT_FLOAT
2917 if (tv2->v_type == VAR_FLOAT)
2919 float_T f = n;
2921 if (*op == '+')
2922 f += tv2->vval.v_float;
2923 else
2924 f -= tv2->vval.v_float;
2925 clear_tv(tv1);
2926 tv1->v_type = VAR_FLOAT;
2927 tv1->vval.v_float = f;
2929 else
2930 #endif
2932 if (*op == '+')
2933 n += get_tv_number(tv2);
2934 else
2935 n -= get_tv_number(tv2);
2936 clear_tv(tv1);
2937 tv1->v_type = VAR_NUMBER;
2938 tv1->vval.v_number = n;
2941 else
2943 if (tv2->v_type == VAR_FLOAT)
2944 break;
2946 /* str .= str */
2947 s = get_tv_string(tv1);
2948 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2949 clear_tv(tv1);
2950 tv1->v_type = VAR_STRING;
2951 tv1->vval.v_string = s;
2953 return OK;
2955 #ifdef FEAT_FLOAT
2956 case VAR_FLOAT:
2958 float_T f;
2960 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2961 && tv2->v_type != VAR_NUMBER
2962 && tv2->v_type != VAR_STRING))
2963 break;
2964 if (tv2->v_type == VAR_FLOAT)
2965 f = tv2->vval.v_float;
2966 else
2967 f = get_tv_number(tv2);
2968 if (*op == '+')
2969 tv1->vval.v_float += f;
2970 else
2971 tv1->vval.v_float -= f;
2973 return OK;
2974 #endif
2978 EMSG2(_(e_letwrong), op);
2979 return FAIL;
2983 * Add a watcher to a list.
2985 static void
2986 list_add_watch(l, lw)
2987 list_T *l;
2988 listwatch_T *lw;
2990 lw->lw_next = l->lv_watch;
2991 l->lv_watch = lw;
2995 * Remove a watcher from a list.
2996 * No warning when it isn't found...
2998 static void
2999 list_rem_watch(l, lwrem)
3000 list_T *l;
3001 listwatch_T *lwrem;
3003 listwatch_T *lw, **lwp;
3005 lwp = &l->lv_watch;
3006 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3008 if (lw == lwrem)
3010 *lwp = lw->lw_next;
3011 break;
3013 lwp = &lw->lw_next;
3018 * Just before removing an item from a list: advance watchers to the next
3019 * item.
3021 static void
3022 list_fix_watch(l, item)
3023 list_T *l;
3024 listitem_T *item;
3026 listwatch_T *lw;
3028 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3029 if (lw->lw_item == item)
3030 lw->lw_item = item->li_next;
3034 * Evaluate the expression used in a ":for var in expr" command.
3035 * "arg" points to "var".
3036 * Set "*errp" to TRUE for an error, FALSE otherwise;
3037 * Return a pointer that holds the info. Null when there is an error.
3039 void *
3040 eval_for_line(arg, errp, nextcmdp, skip)
3041 char_u *arg;
3042 int *errp;
3043 char_u **nextcmdp;
3044 int skip;
3046 forinfo_T *fi;
3047 char_u *expr;
3048 typval_T tv;
3049 list_T *l;
3051 *errp = TRUE; /* default: there is an error */
3053 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3054 if (fi == NULL)
3055 return NULL;
3057 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3058 if (expr == NULL)
3059 return fi;
3061 expr = skipwhite(expr);
3062 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3064 EMSG(_("E690: Missing \"in\" after :for"));
3065 return fi;
3068 if (skip)
3069 ++emsg_skip;
3070 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3072 *errp = FALSE;
3073 if (!skip)
3075 l = tv.vval.v_list;
3076 if (tv.v_type != VAR_LIST || l == NULL)
3078 EMSG(_(e_listreq));
3079 clear_tv(&tv);
3081 else
3083 /* No need to increment the refcount, it's already set for the
3084 * list being used in "tv". */
3085 fi->fi_list = l;
3086 list_add_watch(l, &fi->fi_lw);
3087 fi->fi_lw.lw_item = l->lv_first;
3091 if (skip)
3092 --emsg_skip;
3094 return fi;
3098 * Use the first item in a ":for" list. Advance to the next.
3099 * Assign the values to the variable (list). "arg" points to the first one.
3100 * Return TRUE when a valid item was found, FALSE when at end of list or
3101 * something wrong.
3104 next_for_item(fi_void, arg)
3105 void *fi_void;
3106 char_u *arg;
3108 forinfo_T *fi = (forinfo_T *)fi_void;
3109 int result;
3110 listitem_T *item;
3112 item = fi->fi_lw.lw_item;
3113 if (item == NULL)
3114 result = FALSE;
3115 else
3117 fi->fi_lw.lw_item = item->li_next;
3118 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3119 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3121 return result;
3125 * Free the structure used to store info used by ":for".
3127 void
3128 free_for_info(fi_void)
3129 void *fi_void;
3131 forinfo_T *fi = (forinfo_T *)fi_void;
3133 if (fi != NULL && fi->fi_list != NULL)
3135 list_rem_watch(fi->fi_list, &fi->fi_lw);
3136 list_unref(fi->fi_list);
3138 vim_free(fi);
3141 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3143 void
3144 set_context_for_expression(xp, arg, cmdidx)
3145 expand_T *xp;
3146 char_u *arg;
3147 cmdidx_T cmdidx;
3149 int got_eq = FALSE;
3150 int c;
3151 char_u *p;
3153 if (cmdidx == CMD_let)
3155 xp->xp_context = EXPAND_USER_VARS;
3156 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3158 /* ":let var1 var2 ...": find last space. */
3159 for (p = arg + STRLEN(arg); p >= arg; )
3161 xp->xp_pattern = p;
3162 mb_ptr_back(arg, p);
3163 if (vim_iswhite(*p))
3164 break;
3166 return;
3169 else
3170 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3171 : EXPAND_EXPRESSION;
3172 while ((xp->xp_pattern = vim_strpbrk(arg,
3173 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3175 c = *xp->xp_pattern;
3176 if (c == '&')
3178 c = xp->xp_pattern[1];
3179 if (c == '&')
3181 ++xp->xp_pattern;
3182 xp->xp_context = cmdidx != CMD_let || got_eq
3183 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3185 else if (c != ' ')
3187 xp->xp_context = EXPAND_SETTINGS;
3188 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3189 xp->xp_pattern += 2;
3193 else if (c == '$')
3195 /* environment variable */
3196 xp->xp_context = EXPAND_ENV_VARS;
3198 else if (c == '=')
3200 got_eq = TRUE;
3201 xp->xp_context = EXPAND_EXPRESSION;
3203 else if (c == '<'
3204 && xp->xp_context == EXPAND_FUNCTIONS
3205 && vim_strchr(xp->xp_pattern, '(') == NULL)
3207 /* Function name can start with "<SNR>" */
3208 break;
3210 else if (cmdidx != CMD_let || got_eq)
3212 if (c == '"') /* string */
3214 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3215 if (c == '\\' && xp->xp_pattern[1] != NUL)
3216 ++xp->xp_pattern;
3217 xp->xp_context = EXPAND_NOTHING;
3219 else if (c == '\'') /* literal string */
3221 /* Trick: '' is like stopping and starting a literal string. */
3222 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3223 /* skip */ ;
3224 xp->xp_context = EXPAND_NOTHING;
3226 else if (c == '|')
3228 if (xp->xp_pattern[1] == '|')
3230 ++xp->xp_pattern;
3231 xp->xp_context = EXPAND_EXPRESSION;
3233 else
3234 xp->xp_context = EXPAND_COMMANDS;
3236 else
3237 xp->xp_context = EXPAND_EXPRESSION;
3239 else
3240 /* Doesn't look like something valid, expand as an expression
3241 * anyway. */
3242 xp->xp_context = EXPAND_EXPRESSION;
3243 arg = xp->xp_pattern;
3244 if (*arg != NUL)
3245 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3246 /* skip */ ;
3248 xp->xp_pattern = arg;
3251 #endif /* FEAT_CMDL_COMPL */
3254 * ":1,25call func(arg1, arg2)" function call.
3256 void
3257 ex_call(eap)
3258 exarg_T *eap;
3260 char_u *arg = eap->arg;
3261 char_u *startarg;
3262 char_u *name;
3263 char_u *tofree;
3264 int len;
3265 typval_T rettv;
3266 linenr_T lnum;
3267 int doesrange;
3268 int failed = FALSE;
3269 funcdict_T fudi;
3271 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3272 if (fudi.fd_newkey != NULL)
3274 /* Still need to give an error message for missing key. */
3275 EMSG2(_(e_dictkey), fudi.fd_newkey);
3276 vim_free(fudi.fd_newkey);
3278 if (tofree == NULL)
3279 return;
3281 /* Increase refcount on dictionary, it could get deleted when evaluating
3282 * the arguments. */
3283 if (fudi.fd_dict != NULL)
3284 ++fudi.fd_dict->dv_refcount;
3286 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3287 len = (int)STRLEN(tofree);
3288 name = deref_func_name(tofree, &len);
3290 /* Skip white space to allow ":call func ()". Not good, but required for
3291 * backward compatibility. */
3292 startarg = skipwhite(arg);
3293 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3295 if (*startarg != '(')
3297 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3298 goto end;
3302 * When skipping, evaluate the function once, to find the end of the
3303 * arguments.
3304 * When the function takes a range, this is discovered after the first
3305 * call, and the loop is broken.
3307 if (eap->skip)
3309 ++emsg_skip;
3310 lnum = eap->line2; /* do it once, also with an invalid range */
3312 else
3313 lnum = eap->line1;
3314 for ( ; lnum <= eap->line2; ++lnum)
3316 if (!eap->skip && eap->addr_count > 0)
3318 curwin->w_cursor.lnum = lnum;
3319 curwin->w_cursor.col = 0;
3321 arg = startarg;
3322 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3323 eap->line1, eap->line2, &doesrange,
3324 !eap->skip, fudi.fd_dict) == FAIL)
3326 failed = TRUE;
3327 break;
3330 /* Handle a function returning a Funcref, Dictionary or List. */
3331 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3333 failed = TRUE;
3334 break;
3337 clear_tv(&rettv);
3338 if (doesrange || eap->skip)
3339 break;
3341 /* Stop when immediately aborting on error, or when an interrupt
3342 * occurred or an exception was thrown but not caught.
3343 * get_func_tv() returned OK, so that the check for trailing
3344 * characters below is executed. */
3345 if (aborting())
3346 break;
3348 if (eap->skip)
3349 --emsg_skip;
3351 if (!failed)
3353 /* Check for trailing illegal characters and a following command. */
3354 if (!ends_excmd(*arg))
3356 emsg_severe = TRUE;
3357 EMSG(_(e_trailing));
3359 else
3360 eap->nextcmd = check_nextcmd(arg);
3363 end:
3364 dict_unref(fudi.fd_dict);
3365 vim_free(tofree);
3369 * ":unlet[!] var1 ... " command.
3371 void
3372 ex_unlet(eap)
3373 exarg_T *eap;
3375 ex_unletlock(eap, eap->arg, 0);
3379 * ":lockvar" and ":unlockvar" commands
3381 void
3382 ex_lockvar(eap)
3383 exarg_T *eap;
3385 char_u *arg = eap->arg;
3386 int deep = 2;
3388 if (eap->forceit)
3389 deep = -1;
3390 else if (vim_isdigit(*arg))
3392 deep = getdigits(&arg);
3393 arg = skipwhite(arg);
3396 ex_unletlock(eap, arg, deep);
3400 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3402 static void
3403 ex_unletlock(eap, argstart, deep)
3404 exarg_T *eap;
3405 char_u *argstart;
3406 int deep;
3408 char_u *arg = argstart;
3409 char_u *name_end;
3410 int error = FALSE;
3411 lval_T lv;
3415 /* Parse the name and find the end. */
3416 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3417 FNE_CHECK_START);
3418 if (lv.ll_name == NULL)
3419 error = TRUE; /* error but continue parsing */
3420 if (name_end == NULL || (!vim_iswhite(*name_end)
3421 && !ends_excmd(*name_end)))
3423 if (name_end != NULL)
3425 emsg_severe = TRUE;
3426 EMSG(_(e_trailing));
3428 if (!(eap->skip || error))
3429 clear_lval(&lv);
3430 break;
3433 if (!error && !eap->skip)
3435 if (eap->cmdidx == CMD_unlet)
3437 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3438 error = TRUE;
3440 else
3442 if (do_lock_var(&lv, name_end, deep,
3443 eap->cmdidx == CMD_lockvar) == FAIL)
3444 error = TRUE;
3448 if (!eap->skip)
3449 clear_lval(&lv);
3451 arg = skipwhite(name_end);
3452 } while (!ends_excmd(*arg));
3454 eap->nextcmd = check_nextcmd(arg);
3457 static int
3458 do_unlet_var(lp, name_end, forceit)
3459 lval_T *lp;
3460 char_u *name_end;
3461 int forceit;
3463 int ret = OK;
3464 int cc;
3466 if (lp->ll_tv == NULL)
3468 cc = *name_end;
3469 *name_end = NUL;
3471 /* Normal name or expanded name. */
3472 if (check_changedtick(lp->ll_name))
3473 ret = FAIL;
3474 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3475 ret = FAIL;
3476 *name_end = cc;
3478 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3479 return FAIL;
3480 else if (lp->ll_range)
3482 listitem_T *li;
3484 /* Delete a range of List items. */
3485 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3487 li = lp->ll_li->li_next;
3488 listitem_remove(lp->ll_list, lp->ll_li);
3489 lp->ll_li = li;
3490 ++lp->ll_n1;
3493 else
3495 if (lp->ll_list != NULL)
3496 /* unlet a List item. */
3497 listitem_remove(lp->ll_list, lp->ll_li);
3498 else
3499 /* unlet a Dictionary item. */
3500 dictitem_remove(lp->ll_dict, lp->ll_di);
3503 return ret;
3507 * "unlet" a variable. Return OK if it existed, FAIL if not.
3508 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3511 do_unlet(name, forceit)
3512 char_u *name;
3513 int forceit;
3515 hashtab_T *ht;
3516 hashitem_T *hi;
3517 char_u *varname;
3518 dictitem_T *di;
3520 ht = find_var_ht(name, &varname);
3521 if (ht != NULL && *varname != NUL)
3523 hi = hash_find(ht, varname);
3524 if (!HASHITEM_EMPTY(hi))
3526 di = HI2DI(hi);
3527 if (var_check_fixed(di->di_flags, name)
3528 || var_check_ro(di->di_flags, name))
3529 return FAIL;
3530 delete_var(ht, hi);
3531 return OK;
3534 if (forceit)
3535 return OK;
3536 EMSG2(_("E108: No such variable: \"%s\""), name);
3537 return FAIL;
3541 * Lock or unlock variable indicated by "lp".
3542 * "deep" is the levels to go (-1 for unlimited);
3543 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3545 static int
3546 do_lock_var(lp, name_end, deep, lock)
3547 lval_T *lp;
3548 char_u *name_end;
3549 int deep;
3550 int lock;
3552 int ret = OK;
3553 int cc;
3554 dictitem_T *di;
3556 if (deep == 0) /* nothing to do */
3557 return OK;
3559 if (lp->ll_tv == NULL)
3561 cc = *name_end;
3562 *name_end = NUL;
3564 /* Normal name or expanded name. */
3565 if (check_changedtick(lp->ll_name))
3566 ret = FAIL;
3567 else
3569 di = find_var(lp->ll_name, NULL);
3570 if (di == NULL)
3571 ret = FAIL;
3572 else
3574 if (lock)
3575 di->di_flags |= DI_FLAGS_LOCK;
3576 else
3577 di->di_flags &= ~DI_FLAGS_LOCK;
3578 item_lock(&di->di_tv, deep, lock);
3581 *name_end = cc;
3583 else if (lp->ll_range)
3585 listitem_T *li = lp->ll_li;
3587 /* (un)lock a range of List items. */
3588 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3590 item_lock(&li->li_tv, deep, lock);
3591 li = li->li_next;
3592 ++lp->ll_n1;
3595 else if (lp->ll_list != NULL)
3596 /* (un)lock a List item. */
3597 item_lock(&lp->ll_li->li_tv, deep, lock);
3598 else
3599 /* un(lock) a Dictionary item. */
3600 item_lock(&lp->ll_di->di_tv, deep, lock);
3602 return ret;
3606 * Lock or unlock an item. "deep" is nr of levels to go.
3608 static void
3609 item_lock(tv, deep, lock)
3610 typval_T *tv;
3611 int deep;
3612 int lock;
3614 static int recurse = 0;
3615 list_T *l;
3616 listitem_T *li;
3617 dict_T *d;
3618 hashitem_T *hi;
3619 int todo;
3621 if (recurse >= DICT_MAXNEST)
3623 EMSG(_("E743: variable nested too deep for (un)lock"));
3624 return;
3626 if (deep == 0)
3627 return;
3628 ++recurse;
3630 /* lock/unlock the item itself */
3631 if (lock)
3632 tv->v_lock |= VAR_LOCKED;
3633 else
3634 tv->v_lock &= ~VAR_LOCKED;
3636 switch (tv->v_type)
3638 case VAR_LIST:
3639 if ((l = tv->vval.v_list) != NULL)
3641 if (lock)
3642 l->lv_lock |= VAR_LOCKED;
3643 else
3644 l->lv_lock &= ~VAR_LOCKED;
3645 if (deep < 0 || deep > 1)
3646 /* recursive: lock/unlock the items the List contains */
3647 for (li = l->lv_first; li != NULL; li = li->li_next)
3648 item_lock(&li->li_tv, deep - 1, lock);
3650 break;
3651 case VAR_DICT:
3652 if ((d = tv->vval.v_dict) != NULL)
3654 if (lock)
3655 d->dv_lock |= VAR_LOCKED;
3656 else
3657 d->dv_lock &= ~VAR_LOCKED;
3658 if (deep < 0 || deep > 1)
3660 /* recursive: lock/unlock the items the List contains */
3661 todo = (int)d->dv_hashtab.ht_used;
3662 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3664 if (!HASHITEM_EMPTY(hi))
3666 --todo;
3667 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3673 --recurse;
3677 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3678 * or it refers to a List or Dictionary that is locked.
3680 static int
3681 tv_islocked(tv)
3682 typval_T *tv;
3684 return (tv->v_lock & VAR_LOCKED)
3685 || (tv->v_type == VAR_LIST
3686 && tv->vval.v_list != NULL
3687 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3688 || (tv->v_type == VAR_DICT
3689 && tv->vval.v_dict != NULL
3690 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3693 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3695 * Delete all "menutrans_" variables.
3697 void
3698 del_menutrans_vars()
3700 hashitem_T *hi;
3701 int todo;
3703 hash_lock(&globvarht);
3704 todo = (int)globvarht.ht_used;
3705 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3707 if (!HASHITEM_EMPTY(hi))
3709 --todo;
3710 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3711 delete_var(&globvarht, hi);
3714 hash_unlock(&globvarht);
3716 #endif
3718 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3721 * Local string buffer for the next two functions to store a variable name
3722 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3723 * get_user_var_name().
3726 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3728 static char_u *varnamebuf = NULL;
3729 static int varnamebuflen = 0;
3732 * Function to concatenate a prefix and a variable name.
3734 static char_u *
3735 cat_prefix_varname(prefix, name)
3736 int prefix;
3737 char_u *name;
3739 int len;
3741 len = (int)STRLEN(name) + 3;
3742 if (len > varnamebuflen)
3744 vim_free(varnamebuf);
3745 len += 10; /* some additional space */
3746 varnamebuf = alloc(len);
3747 if (varnamebuf == NULL)
3749 varnamebuflen = 0;
3750 return NULL;
3752 varnamebuflen = len;
3754 *varnamebuf = prefix;
3755 varnamebuf[1] = ':';
3756 STRCPY(varnamebuf + 2, name);
3757 return varnamebuf;
3761 * Function given to ExpandGeneric() to obtain the list of user defined
3762 * (global/buffer/window/built-in) variable names.
3764 /*ARGSUSED*/
3765 char_u *
3766 get_user_var_name(xp, idx)
3767 expand_T *xp;
3768 int idx;
3770 static long_u gdone;
3771 static long_u bdone;
3772 static long_u wdone;
3773 #ifdef FEAT_WINDOWS
3774 static long_u tdone;
3775 #endif
3776 static int vidx;
3777 static hashitem_T *hi;
3778 hashtab_T *ht;
3780 if (idx == 0)
3782 gdone = bdone = wdone = vidx = 0;
3783 #ifdef FEAT_WINDOWS
3784 tdone = 0;
3785 #endif
3788 /* Global variables */
3789 if (gdone < globvarht.ht_used)
3791 if (gdone++ == 0)
3792 hi = globvarht.ht_array;
3793 else
3794 ++hi;
3795 while (HASHITEM_EMPTY(hi))
3796 ++hi;
3797 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3798 return cat_prefix_varname('g', hi->hi_key);
3799 return hi->hi_key;
3802 /* b: variables */
3803 ht = &curbuf->b_vars.dv_hashtab;
3804 if (bdone < ht->ht_used)
3806 if (bdone++ == 0)
3807 hi = ht->ht_array;
3808 else
3809 ++hi;
3810 while (HASHITEM_EMPTY(hi))
3811 ++hi;
3812 return cat_prefix_varname('b', hi->hi_key);
3814 if (bdone == ht->ht_used)
3816 ++bdone;
3817 return (char_u *)"b:changedtick";
3820 /* w: variables */
3821 ht = &curwin->w_vars.dv_hashtab;
3822 if (wdone < ht->ht_used)
3824 if (wdone++ == 0)
3825 hi = ht->ht_array;
3826 else
3827 ++hi;
3828 while (HASHITEM_EMPTY(hi))
3829 ++hi;
3830 return cat_prefix_varname('w', hi->hi_key);
3833 #ifdef FEAT_WINDOWS
3834 /* t: variables */
3835 ht = &curtab->tp_vars.dv_hashtab;
3836 if (tdone < ht->ht_used)
3838 if (tdone++ == 0)
3839 hi = ht->ht_array;
3840 else
3841 ++hi;
3842 while (HASHITEM_EMPTY(hi))
3843 ++hi;
3844 return cat_prefix_varname('t', hi->hi_key);
3846 #endif
3848 /* v: variables */
3849 if (vidx < VV_LEN)
3850 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3852 vim_free(varnamebuf);
3853 varnamebuf = NULL;
3854 varnamebuflen = 0;
3855 return NULL;
3858 #endif /* FEAT_CMDL_COMPL */
3861 * types for expressions.
3863 typedef enum
3865 TYPE_UNKNOWN = 0
3866 , TYPE_EQUAL /* == */
3867 , TYPE_NEQUAL /* != */
3868 , TYPE_GREATER /* > */
3869 , TYPE_GEQUAL /* >= */
3870 , TYPE_SMALLER /* < */
3871 , TYPE_SEQUAL /* <= */
3872 , TYPE_MATCH /* =~ */
3873 , TYPE_NOMATCH /* !~ */
3874 } exptype_T;
3877 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3878 * executed. The function may return OK, but the rettv will be of type
3879 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3883 * Handle zero level expression.
3884 * This calls eval1() and handles error message and nextcmd.
3885 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3886 * Note: "rettv.v_lock" is not set.
3887 * Return OK or FAIL.
3889 static int
3890 eval0(arg, rettv, nextcmd, evaluate)
3891 char_u *arg;
3892 typval_T *rettv;
3893 char_u **nextcmd;
3894 int evaluate;
3896 int ret;
3897 char_u *p;
3899 p = skipwhite(arg);
3900 ret = eval1(&p, rettv, evaluate);
3901 if (ret == FAIL || !ends_excmd(*p))
3903 if (ret != FAIL)
3904 clear_tv(rettv);
3906 * Report the invalid expression unless the expression evaluation has
3907 * been cancelled due to an aborting error, an interrupt, or an
3908 * exception.
3910 if (!aborting())
3911 EMSG2(_(e_invexpr2), arg);
3912 ret = FAIL;
3914 if (nextcmd != NULL)
3915 *nextcmd = check_nextcmd(p);
3917 return ret;
3921 * Handle top level expression:
3922 * expr1 ? expr0 : expr0
3924 * "arg" must point to the first non-white of the expression.
3925 * "arg" is advanced to the next non-white after the recognized expression.
3927 * Note: "rettv.v_lock" is not set.
3929 * Return OK or FAIL.
3931 static int
3932 eval1(arg, rettv, evaluate)
3933 char_u **arg;
3934 typval_T *rettv;
3935 int evaluate;
3937 int result;
3938 typval_T var2;
3941 * Get the first variable.
3943 if (eval2(arg, rettv, evaluate) == FAIL)
3944 return FAIL;
3946 if ((*arg)[0] == '?')
3948 result = FALSE;
3949 if (evaluate)
3951 int error = FALSE;
3953 if (get_tv_number_chk(rettv, &error) != 0)
3954 result = TRUE;
3955 clear_tv(rettv);
3956 if (error)
3957 return FAIL;
3961 * Get the second variable.
3963 *arg = skipwhite(*arg + 1);
3964 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3965 return FAIL;
3968 * Check for the ":".
3970 if ((*arg)[0] != ':')
3972 EMSG(_("E109: Missing ':' after '?'"));
3973 if (evaluate && result)
3974 clear_tv(rettv);
3975 return FAIL;
3979 * Get the third variable.
3981 *arg = skipwhite(*arg + 1);
3982 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3984 if (evaluate && result)
3985 clear_tv(rettv);
3986 return FAIL;
3988 if (evaluate && !result)
3989 *rettv = var2;
3992 return OK;
3996 * Handle first level expression:
3997 * expr2 || expr2 || expr2 logical OR
3999 * "arg" must point to the first non-white of the expression.
4000 * "arg" is advanced to the next non-white after the recognized expression.
4002 * Return OK or FAIL.
4004 static int
4005 eval2(arg, rettv, evaluate)
4006 char_u **arg;
4007 typval_T *rettv;
4008 int evaluate;
4010 typval_T var2;
4011 long result;
4012 int first;
4013 int error = FALSE;
4016 * Get the first variable.
4018 if (eval3(arg, rettv, evaluate) == FAIL)
4019 return FAIL;
4022 * Repeat until there is no following "||".
4024 first = TRUE;
4025 result = FALSE;
4026 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4028 if (evaluate && first)
4030 if (get_tv_number_chk(rettv, &error) != 0)
4031 result = TRUE;
4032 clear_tv(rettv);
4033 if (error)
4034 return FAIL;
4035 first = FALSE;
4039 * Get the second variable.
4041 *arg = skipwhite(*arg + 2);
4042 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4043 return FAIL;
4046 * Compute the result.
4048 if (evaluate && !result)
4050 if (get_tv_number_chk(&var2, &error) != 0)
4051 result = TRUE;
4052 clear_tv(&var2);
4053 if (error)
4054 return FAIL;
4056 if (evaluate)
4058 rettv->v_type = VAR_NUMBER;
4059 rettv->vval.v_number = result;
4063 return OK;
4067 * Handle second level expression:
4068 * expr3 && expr3 && expr3 logical AND
4070 * "arg" must point to the first non-white of the expression.
4071 * "arg" is advanced to the next non-white after the recognized expression.
4073 * Return OK or FAIL.
4075 static int
4076 eval3(arg, rettv, evaluate)
4077 char_u **arg;
4078 typval_T *rettv;
4079 int evaluate;
4081 typval_T var2;
4082 long result;
4083 int first;
4084 int error = FALSE;
4087 * Get the first variable.
4089 if (eval4(arg, rettv, evaluate) == FAIL)
4090 return FAIL;
4093 * Repeat until there is no following "&&".
4095 first = TRUE;
4096 result = TRUE;
4097 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4099 if (evaluate && first)
4101 if (get_tv_number_chk(rettv, &error) == 0)
4102 result = FALSE;
4103 clear_tv(rettv);
4104 if (error)
4105 return FAIL;
4106 first = FALSE;
4110 * Get the second variable.
4112 *arg = skipwhite(*arg + 2);
4113 if (eval4(arg, &var2, evaluate && result) == FAIL)
4114 return FAIL;
4117 * Compute the result.
4119 if (evaluate && result)
4121 if (get_tv_number_chk(&var2, &error) == 0)
4122 result = FALSE;
4123 clear_tv(&var2);
4124 if (error)
4125 return FAIL;
4127 if (evaluate)
4129 rettv->v_type = VAR_NUMBER;
4130 rettv->vval.v_number = result;
4134 return OK;
4138 * Handle third level expression:
4139 * var1 == var2
4140 * var1 =~ var2
4141 * var1 != var2
4142 * var1 !~ var2
4143 * var1 > var2
4144 * var1 >= var2
4145 * var1 < var2
4146 * var1 <= var2
4147 * var1 is var2
4148 * var1 isnot var2
4150 * "arg" must point to the first non-white of the expression.
4151 * "arg" is advanced to the next non-white after the recognized expression.
4153 * Return OK or FAIL.
4155 static int
4156 eval4(arg, rettv, evaluate)
4157 char_u **arg;
4158 typval_T *rettv;
4159 int evaluate;
4161 typval_T var2;
4162 char_u *p;
4163 int i;
4164 exptype_T type = TYPE_UNKNOWN;
4165 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4166 int len = 2;
4167 long n1, n2;
4168 char_u *s1, *s2;
4169 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4170 regmatch_T regmatch;
4171 int ic;
4172 char_u *save_cpo;
4175 * Get the first variable.
4177 if (eval5(arg, rettv, evaluate) == FAIL)
4178 return FAIL;
4180 p = *arg;
4181 switch (p[0])
4183 case '=': if (p[1] == '=')
4184 type = TYPE_EQUAL;
4185 else if (p[1] == '~')
4186 type = TYPE_MATCH;
4187 break;
4188 case '!': if (p[1] == '=')
4189 type = TYPE_NEQUAL;
4190 else if (p[1] == '~')
4191 type = TYPE_NOMATCH;
4192 break;
4193 case '>': if (p[1] != '=')
4195 type = TYPE_GREATER;
4196 len = 1;
4198 else
4199 type = TYPE_GEQUAL;
4200 break;
4201 case '<': if (p[1] != '=')
4203 type = TYPE_SMALLER;
4204 len = 1;
4206 else
4207 type = TYPE_SEQUAL;
4208 break;
4209 case 'i': if (p[1] == 's')
4211 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4212 len = 5;
4213 if (!vim_isIDc(p[len]))
4215 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4216 type_is = TRUE;
4219 break;
4223 * If there is a comparative operator, use it.
4225 if (type != TYPE_UNKNOWN)
4227 /* extra question mark appended: ignore case */
4228 if (p[len] == '?')
4230 ic = TRUE;
4231 ++len;
4233 /* extra '#' appended: match case */
4234 else if (p[len] == '#')
4236 ic = FALSE;
4237 ++len;
4239 /* nothing appended: use 'ignorecase' */
4240 else
4241 ic = p_ic;
4244 * Get the second variable.
4246 *arg = skipwhite(p + len);
4247 if (eval5(arg, &var2, evaluate) == FAIL)
4249 clear_tv(rettv);
4250 return FAIL;
4253 if (evaluate)
4255 if (type_is && rettv->v_type != var2.v_type)
4257 /* For "is" a different type always means FALSE, for "notis"
4258 * it means TRUE. */
4259 n1 = (type == TYPE_NEQUAL);
4261 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4263 if (type_is)
4265 n1 = (rettv->v_type == var2.v_type
4266 && rettv->vval.v_list == var2.vval.v_list);
4267 if (type == TYPE_NEQUAL)
4268 n1 = !n1;
4270 else if (rettv->v_type != var2.v_type
4271 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4273 if (rettv->v_type != var2.v_type)
4274 EMSG(_("E691: Can only compare List with List"));
4275 else
4276 EMSG(_("E692: Invalid operation for Lists"));
4277 clear_tv(rettv);
4278 clear_tv(&var2);
4279 return FAIL;
4281 else
4283 /* Compare two Lists for being equal or unequal. */
4284 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4285 if (type == TYPE_NEQUAL)
4286 n1 = !n1;
4290 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4292 if (type_is)
4294 n1 = (rettv->v_type == var2.v_type
4295 && rettv->vval.v_dict == var2.vval.v_dict);
4296 if (type == TYPE_NEQUAL)
4297 n1 = !n1;
4299 else if (rettv->v_type != var2.v_type
4300 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4302 if (rettv->v_type != var2.v_type)
4303 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4304 else
4305 EMSG(_("E736: Invalid operation for Dictionary"));
4306 clear_tv(rettv);
4307 clear_tv(&var2);
4308 return FAIL;
4310 else
4312 /* Compare two Dictionaries for being equal or unequal. */
4313 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4314 if (type == TYPE_NEQUAL)
4315 n1 = !n1;
4319 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4321 if (rettv->v_type != var2.v_type
4322 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4324 if (rettv->v_type != var2.v_type)
4325 EMSG(_("E693: Can only compare Funcref with Funcref"));
4326 else
4327 EMSG(_("E694: Invalid operation for Funcrefs"));
4328 clear_tv(rettv);
4329 clear_tv(&var2);
4330 return FAIL;
4332 else
4334 /* Compare two Funcrefs for being equal or unequal. */
4335 if (rettv->vval.v_string == NULL
4336 || var2.vval.v_string == NULL)
4337 n1 = FALSE;
4338 else
4339 n1 = STRCMP(rettv->vval.v_string,
4340 var2.vval.v_string) == 0;
4341 if (type == TYPE_NEQUAL)
4342 n1 = !n1;
4346 #ifdef FEAT_FLOAT
4348 * If one of the two variables is a float, compare as a float.
4349 * When using "=~" or "!~", always compare as string.
4351 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4352 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4354 float_T f1, f2;
4356 if (rettv->v_type == VAR_FLOAT)
4357 f1 = rettv->vval.v_float;
4358 else
4359 f1 = get_tv_number(rettv);
4360 if (var2.v_type == VAR_FLOAT)
4361 f2 = var2.vval.v_float;
4362 else
4363 f2 = get_tv_number(&var2);
4364 n1 = FALSE;
4365 switch (type)
4367 case TYPE_EQUAL: n1 = (f1 == f2); break;
4368 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4369 case TYPE_GREATER: n1 = (f1 > f2); break;
4370 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4371 case TYPE_SMALLER: n1 = (f1 < f2); break;
4372 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4373 case TYPE_UNKNOWN:
4374 case TYPE_MATCH:
4375 case TYPE_NOMATCH: break; /* avoid gcc warning */
4378 #endif
4381 * If one of the two variables is a number, compare as a number.
4382 * When using "=~" or "!~", always compare as string.
4384 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4385 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4387 n1 = get_tv_number(rettv);
4388 n2 = get_tv_number(&var2);
4389 switch (type)
4391 case TYPE_EQUAL: n1 = (n1 == n2); break;
4392 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4393 case TYPE_GREATER: n1 = (n1 > n2); break;
4394 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4395 case TYPE_SMALLER: n1 = (n1 < n2); break;
4396 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4397 case TYPE_UNKNOWN:
4398 case TYPE_MATCH:
4399 case TYPE_NOMATCH: break; /* avoid gcc warning */
4402 else
4404 s1 = get_tv_string_buf(rettv, buf1);
4405 s2 = get_tv_string_buf(&var2, buf2);
4406 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4407 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4408 else
4409 i = 0;
4410 n1 = FALSE;
4411 switch (type)
4413 case TYPE_EQUAL: n1 = (i == 0); break;
4414 case TYPE_NEQUAL: n1 = (i != 0); break;
4415 case TYPE_GREATER: n1 = (i > 0); break;
4416 case TYPE_GEQUAL: n1 = (i >= 0); break;
4417 case TYPE_SMALLER: n1 = (i < 0); break;
4418 case TYPE_SEQUAL: n1 = (i <= 0); break;
4420 case TYPE_MATCH:
4421 case TYPE_NOMATCH:
4422 /* avoid 'l' flag in 'cpoptions' */
4423 save_cpo = p_cpo;
4424 p_cpo = (char_u *)"";
4425 regmatch.regprog = vim_regcomp(s2,
4426 RE_MAGIC + RE_STRING);
4427 regmatch.rm_ic = ic;
4428 if (regmatch.regprog != NULL)
4430 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4431 vim_free(regmatch.regprog);
4432 if (type == TYPE_NOMATCH)
4433 n1 = !n1;
4435 p_cpo = save_cpo;
4436 break;
4438 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4441 clear_tv(rettv);
4442 clear_tv(&var2);
4443 rettv->v_type = VAR_NUMBER;
4444 rettv->vval.v_number = n1;
4448 return OK;
4452 * Handle fourth level expression:
4453 * + number addition
4454 * - number subtraction
4455 * . string concatenation
4457 * "arg" must point to the first non-white of the expression.
4458 * "arg" is advanced to the next non-white after the recognized expression.
4460 * Return OK or FAIL.
4462 static int
4463 eval5(arg, rettv, evaluate)
4464 char_u **arg;
4465 typval_T *rettv;
4466 int evaluate;
4468 typval_T var2;
4469 typval_T var3;
4470 int op;
4471 long n1, n2;
4472 #ifdef FEAT_FLOAT
4473 float_T f1 = 0, f2 = 0;
4474 #endif
4475 char_u *s1, *s2;
4476 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4477 char_u *p;
4480 * Get the first variable.
4482 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4483 return FAIL;
4486 * Repeat computing, until no '+', '-' or '.' is following.
4488 for (;;)
4490 op = **arg;
4491 if (op != '+' && op != '-' && op != '.')
4492 break;
4494 if ((op != '+' || rettv->v_type != VAR_LIST)
4495 #ifdef FEAT_FLOAT
4496 && (op == '.' || rettv->v_type != VAR_FLOAT)
4497 #endif
4500 /* For "list + ...", an illegal use of the first operand as
4501 * a number cannot be determined before evaluating the 2nd
4502 * operand: if this is also a list, all is ok.
4503 * For "something . ...", "something - ..." or "non-list + ...",
4504 * we know that the first operand needs to be a string or number
4505 * without evaluating the 2nd operand. So check before to avoid
4506 * side effects after an error. */
4507 if (evaluate && get_tv_string_chk(rettv) == NULL)
4509 clear_tv(rettv);
4510 return FAIL;
4515 * Get the second variable.
4517 *arg = skipwhite(*arg + 1);
4518 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4520 clear_tv(rettv);
4521 return FAIL;
4524 if (evaluate)
4527 * Compute the result.
4529 if (op == '.')
4531 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4532 s2 = get_tv_string_buf_chk(&var2, buf2);
4533 if (s2 == NULL) /* type error ? */
4535 clear_tv(rettv);
4536 clear_tv(&var2);
4537 return FAIL;
4539 p = concat_str(s1, s2);
4540 clear_tv(rettv);
4541 rettv->v_type = VAR_STRING;
4542 rettv->vval.v_string = p;
4544 else if (op == '+' && rettv->v_type == VAR_LIST
4545 && var2.v_type == VAR_LIST)
4547 /* concatenate Lists */
4548 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4549 &var3) == FAIL)
4551 clear_tv(rettv);
4552 clear_tv(&var2);
4553 return FAIL;
4555 clear_tv(rettv);
4556 *rettv = var3;
4558 else
4560 int error = FALSE;
4562 #ifdef FEAT_FLOAT
4563 if (rettv->v_type == VAR_FLOAT)
4565 f1 = rettv->vval.v_float;
4566 n1 = 0;
4568 else
4569 #endif
4571 n1 = get_tv_number_chk(rettv, &error);
4572 if (error)
4574 /* This can only happen for "list + non-list". For
4575 * "non-list + ..." or "something - ...", we returned
4576 * before evaluating the 2nd operand. */
4577 clear_tv(rettv);
4578 return FAIL;
4580 #ifdef FEAT_FLOAT
4581 if (var2.v_type == VAR_FLOAT)
4582 f1 = n1;
4583 #endif
4585 #ifdef FEAT_FLOAT
4586 if (var2.v_type == VAR_FLOAT)
4588 f2 = var2.vval.v_float;
4589 n2 = 0;
4591 else
4592 #endif
4594 n2 = get_tv_number_chk(&var2, &error);
4595 if (error)
4597 clear_tv(rettv);
4598 clear_tv(&var2);
4599 return FAIL;
4601 #ifdef FEAT_FLOAT
4602 if (rettv->v_type == VAR_FLOAT)
4603 f2 = n2;
4604 #endif
4606 clear_tv(rettv);
4608 #ifdef FEAT_FLOAT
4609 /* If there is a float on either side the result is a float. */
4610 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4612 if (op == '+')
4613 f1 = f1 + f2;
4614 else
4615 f1 = f1 - f2;
4616 rettv->v_type = VAR_FLOAT;
4617 rettv->vval.v_float = f1;
4619 else
4620 #endif
4622 if (op == '+')
4623 n1 = n1 + n2;
4624 else
4625 n1 = n1 - n2;
4626 rettv->v_type = VAR_NUMBER;
4627 rettv->vval.v_number = n1;
4630 clear_tv(&var2);
4633 return OK;
4637 * Handle fifth level expression:
4638 * * number multiplication
4639 * / number division
4640 * % number modulo
4642 * "arg" must point to the first non-white of the expression.
4643 * "arg" is advanced to the next non-white after the recognized expression.
4645 * Return OK or FAIL.
4647 static int
4648 eval6(arg, rettv, evaluate, want_string)
4649 char_u **arg;
4650 typval_T *rettv;
4651 int evaluate;
4652 int want_string; /* after "." operator */
4654 typval_T var2;
4655 int op;
4656 long n1, n2;
4657 #ifdef FEAT_FLOAT
4658 int use_float = FALSE;
4659 float_T f1 = 0, f2;
4660 #endif
4661 int error = FALSE;
4664 * Get the first variable.
4666 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4667 return FAIL;
4670 * Repeat computing, until no '*', '/' or '%' is following.
4672 for (;;)
4674 op = **arg;
4675 if (op != '*' && op != '/' && op != '%')
4676 break;
4678 if (evaluate)
4680 #ifdef FEAT_FLOAT
4681 if (rettv->v_type == VAR_FLOAT)
4683 f1 = rettv->vval.v_float;
4684 use_float = TRUE;
4685 n1 = 0;
4687 else
4688 #endif
4689 n1 = get_tv_number_chk(rettv, &error);
4690 clear_tv(rettv);
4691 if (error)
4692 return FAIL;
4694 else
4695 n1 = 0;
4698 * Get the second variable.
4700 *arg = skipwhite(*arg + 1);
4701 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4702 return FAIL;
4704 if (evaluate)
4706 #ifdef FEAT_FLOAT
4707 if (var2.v_type == VAR_FLOAT)
4709 if (!use_float)
4711 f1 = n1;
4712 use_float = TRUE;
4714 f2 = var2.vval.v_float;
4715 n2 = 0;
4717 else
4718 #endif
4720 n2 = get_tv_number_chk(&var2, &error);
4721 clear_tv(&var2);
4722 if (error)
4723 return FAIL;
4724 #ifdef FEAT_FLOAT
4725 if (use_float)
4726 f2 = n2;
4727 #endif
4731 * Compute the result.
4732 * When either side is a float the result is a float.
4734 #ifdef FEAT_FLOAT
4735 if (use_float)
4737 if (op == '*')
4738 f1 = f1 * f2;
4739 else if (op == '/')
4741 /* We rely on the floating point library to handle divide
4742 * by zero to result in "inf" and not a crash. */
4743 f1 = f1 / f2;
4745 else
4747 EMSG(_("E804: Cannot use '%' with Float"));
4748 return FAIL;
4750 rettv->v_type = VAR_FLOAT;
4751 rettv->vval.v_float = f1;
4753 else
4754 #endif
4756 if (op == '*')
4757 n1 = n1 * n2;
4758 else if (op == '/')
4760 if (n2 == 0) /* give an error message? */
4762 if (n1 == 0)
4763 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4764 else if (n1 < 0)
4765 n1 = -0x7fffffffL;
4766 else
4767 n1 = 0x7fffffffL;
4769 else
4770 n1 = n1 / n2;
4772 else
4774 if (n2 == 0) /* give an error message? */
4775 n1 = 0;
4776 else
4777 n1 = n1 % n2;
4779 rettv->v_type = VAR_NUMBER;
4780 rettv->vval.v_number = n1;
4785 return OK;
4789 * Handle sixth level expression:
4790 * number number constant
4791 * "string" string constant
4792 * 'string' literal string constant
4793 * &option-name option value
4794 * @r register contents
4795 * identifier variable value
4796 * function() function call
4797 * $VAR environment variable
4798 * (expression) nested expression
4799 * [expr, expr] List
4800 * {key: val, key: val} Dictionary
4802 * Also handle:
4803 * ! in front logical NOT
4804 * - in front unary minus
4805 * + in front unary plus (ignored)
4806 * trailing [] subscript in String or List
4807 * trailing .name entry in Dictionary
4809 * "arg" must point to the first non-white of the expression.
4810 * "arg" is advanced to the next non-white after the recognized expression.
4812 * Return OK or FAIL.
4814 static int
4815 eval7(arg, rettv, evaluate, want_string)
4816 char_u **arg;
4817 typval_T *rettv;
4818 int evaluate;
4819 int want_string; /* after "." operator */
4821 long n;
4822 int len;
4823 char_u *s;
4824 char_u *start_leader, *end_leader;
4825 int ret = OK;
4826 char_u *alias;
4829 * Initialise variable so that clear_tv() can't mistake this for a
4830 * string and free a string that isn't there.
4832 rettv->v_type = VAR_UNKNOWN;
4835 * Skip '!' and '-' characters. They are handled later.
4837 start_leader = *arg;
4838 while (**arg == '!' || **arg == '-' || **arg == '+')
4839 *arg = skipwhite(*arg + 1);
4840 end_leader = *arg;
4842 switch (**arg)
4845 * Number constant.
4847 case '0':
4848 case '1':
4849 case '2':
4850 case '3':
4851 case '4':
4852 case '5':
4853 case '6':
4854 case '7':
4855 case '8':
4856 case '9':
4858 #ifdef FEAT_FLOAT
4859 char_u *p = skipdigits(*arg + 1);
4860 int get_float = FALSE;
4862 /* We accept a float when the format matches
4863 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4864 * strict to avoid backwards compatibility problems.
4865 * Don't look for a float after the "." operator, so that
4866 * ":let vers = 1.2.3" doesn't fail. */
4867 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4869 get_float = TRUE;
4870 p = skipdigits(p + 2);
4871 if (*p == 'e' || *p == 'E')
4873 ++p;
4874 if (*p == '-' || *p == '+')
4875 ++p;
4876 if (!vim_isdigit(*p))
4877 get_float = FALSE;
4878 else
4879 p = skipdigits(p + 1);
4881 if (ASCII_ISALPHA(*p) || *p == '.')
4882 get_float = FALSE;
4884 if (get_float)
4886 float_T f;
4888 *arg += string2float(*arg, &f);
4889 if (evaluate)
4891 rettv->v_type = VAR_FLOAT;
4892 rettv->vval.v_float = f;
4895 else
4896 #endif
4898 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4899 *arg += len;
4900 if (evaluate)
4902 rettv->v_type = VAR_NUMBER;
4903 rettv->vval.v_number = n;
4906 break;
4910 * String constant: "string".
4912 case '"': ret = get_string_tv(arg, rettv, evaluate);
4913 break;
4916 * Literal string constant: 'str''ing'.
4918 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4919 break;
4922 * List: [expr, expr]
4924 case '[': ret = get_list_tv(arg, rettv, evaluate);
4925 break;
4928 * Dictionary: {key: val, key: val}
4930 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4931 break;
4934 * Option value: &name
4936 case '&': ret = get_option_tv(arg, rettv, evaluate);
4937 break;
4940 * Environment variable: $VAR.
4942 case '$': ret = get_env_tv(arg, rettv, evaluate);
4943 break;
4946 * Register contents: @r.
4948 case '@': ++*arg;
4949 if (evaluate)
4951 rettv->v_type = VAR_STRING;
4952 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4954 if (**arg != NUL)
4955 ++*arg;
4956 break;
4959 * nested expression: (expression).
4961 case '(': *arg = skipwhite(*arg + 1);
4962 ret = eval1(arg, rettv, evaluate); /* recursive! */
4963 if (**arg == ')')
4964 ++*arg;
4965 else if (ret == OK)
4967 EMSG(_("E110: Missing ')'"));
4968 clear_tv(rettv);
4969 ret = FAIL;
4971 break;
4973 default: ret = NOTDONE;
4974 break;
4977 if (ret == NOTDONE)
4980 * Must be a variable or function name.
4981 * Can also be a curly-braces kind of name: {expr}.
4983 s = *arg;
4984 len = get_name_len(arg, &alias, evaluate, TRUE);
4985 if (alias != NULL)
4986 s = alias;
4988 if (len <= 0)
4989 ret = FAIL;
4990 else
4992 if (**arg == '(') /* recursive! */
4994 /* If "s" is the name of a variable of type VAR_FUNC
4995 * use its contents. */
4996 s = deref_func_name(s, &len);
4998 /* Invoke the function. */
4999 ret = get_func_tv(s, len, rettv, arg,
5000 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5001 &len, evaluate, NULL);
5002 /* Stop the expression evaluation when immediately
5003 * aborting on error, or when an interrupt occurred or
5004 * an exception was thrown but not caught. */
5005 if (aborting())
5007 if (ret == OK)
5008 clear_tv(rettv);
5009 ret = FAIL;
5012 else if (evaluate)
5013 ret = get_var_tv(s, len, rettv, TRUE);
5014 else
5015 ret = OK;
5018 if (alias != NULL)
5019 vim_free(alias);
5022 *arg = skipwhite(*arg);
5024 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5025 * expr(expr). */
5026 if (ret == OK)
5027 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5030 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5032 if (ret == OK && evaluate && end_leader > start_leader)
5034 int error = FALSE;
5035 int val = 0;
5036 #ifdef FEAT_FLOAT
5037 float_T f = 0.0;
5039 if (rettv->v_type == VAR_FLOAT)
5040 f = rettv->vval.v_float;
5041 else
5042 #endif
5043 val = get_tv_number_chk(rettv, &error);
5044 if (error)
5046 clear_tv(rettv);
5047 ret = FAIL;
5049 else
5051 while (end_leader > start_leader)
5053 --end_leader;
5054 if (*end_leader == '!')
5056 #ifdef FEAT_FLOAT
5057 if (rettv->v_type == VAR_FLOAT)
5058 f = !f;
5059 else
5060 #endif
5061 val = !val;
5063 else if (*end_leader == '-')
5065 #ifdef FEAT_FLOAT
5066 if (rettv->v_type == VAR_FLOAT)
5067 f = -f;
5068 else
5069 #endif
5070 val = -val;
5073 #ifdef FEAT_FLOAT
5074 if (rettv->v_type == VAR_FLOAT)
5076 clear_tv(rettv);
5077 rettv->vval.v_float = f;
5079 else
5080 #endif
5082 clear_tv(rettv);
5083 rettv->v_type = VAR_NUMBER;
5084 rettv->vval.v_number = val;
5089 return ret;
5093 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5094 * "*arg" points to the '[' or '.'.
5095 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5097 static int
5098 eval_index(arg, rettv, evaluate, verbose)
5099 char_u **arg;
5100 typval_T *rettv;
5101 int evaluate;
5102 int verbose; /* give error messages */
5104 int empty1 = FALSE, empty2 = FALSE;
5105 typval_T var1, var2;
5106 long n1, n2 = 0;
5107 long len = -1;
5108 int range = FALSE;
5109 char_u *s;
5110 char_u *key = NULL;
5112 if (rettv->v_type == VAR_FUNC
5113 #ifdef FEAT_FLOAT
5114 || rettv->v_type == VAR_FLOAT
5115 #endif
5118 if (verbose)
5119 EMSG(_("E695: Cannot index a Funcref"));
5120 return FAIL;
5123 if (**arg == '.')
5126 * dict.name
5128 key = *arg + 1;
5129 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5131 if (len == 0)
5132 return FAIL;
5133 *arg = skipwhite(key + len);
5135 else
5138 * something[idx]
5140 * Get the (first) variable from inside the [].
5142 *arg = skipwhite(*arg + 1);
5143 if (**arg == ':')
5144 empty1 = TRUE;
5145 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5146 return FAIL;
5147 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5149 /* not a number or string */
5150 clear_tv(&var1);
5151 return FAIL;
5155 * Get the second variable from inside the [:].
5157 if (**arg == ':')
5159 range = TRUE;
5160 *arg = skipwhite(*arg + 1);
5161 if (**arg == ']')
5162 empty2 = TRUE;
5163 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5165 if (!empty1)
5166 clear_tv(&var1);
5167 return FAIL;
5169 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5171 /* not a number or string */
5172 if (!empty1)
5173 clear_tv(&var1);
5174 clear_tv(&var2);
5175 return FAIL;
5179 /* Check for the ']'. */
5180 if (**arg != ']')
5182 if (verbose)
5183 EMSG(_(e_missbrac));
5184 clear_tv(&var1);
5185 if (range)
5186 clear_tv(&var2);
5187 return FAIL;
5189 *arg = skipwhite(*arg + 1); /* skip the ']' */
5192 if (evaluate)
5194 n1 = 0;
5195 if (!empty1 && rettv->v_type != VAR_DICT)
5197 n1 = get_tv_number(&var1);
5198 clear_tv(&var1);
5200 if (range)
5202 if (empty2)
5203 n2 = -1;
5204 else
5206 n2 = get_tv_number(&var2);
5207 clear_tv(&var2);
5211 switch (rettv->v_type)
5213 case VAR_NUMBER:
5214 case VAR_STRING:
5215 s = get_tv_string(rettv);
5216 len = (long)STRLEN(s);
5217 if (range)
5219 /* The resulting variable is a substring. If the indexes
5220 * are out of range the result is empty. */
5221 if (n1 < 0)
5223 n1 = len + n1;
5224 if (n1 < 0)
5225 n1 = 0;
5227 if (n2 < 0)
5228 n2 = len + n2;
5229 else if (n2 >= len)
5230 n2 = len;
5231 if (n1 >= len || n2 < 0 || n1 > n2)
5232 s = NULL;
5233 else
5234 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5236 else
5238 /* The resulting variable is a string of a single
5239 * character. If the index is too big or negative the
5240 * result is empty. */
5241 if (n1 >= len || n1 < 0)
5242 s = NULL;
5243 else
5244 s = vim_strnsave(s + n1, 1);
5246 clear_tv(rettv);
5247 rettv->v_type = VAR_STRING;
5248 rettv->vval.v_string = s;
5249 break;
5251 case VAR_LIST:
5252 len = list_len(rettv->vval.v_list);
5253 if (n1 < 0)
5254 n1 = len + n1;
5255 if (!empty1 && (n1 < 0 || n1 >= len))
5257 /* For a range we allow invalid values and return an empty
5258 * list. A list index out of range is an error. */
5259 if (!range)
5261 if (verbose)
5262 EMSGN(_(e_listidx), n1);
5263 return FAIL;
5265 n1 = len;
5267 if (range)
5269 list_T *l;
5270 listitem_T *item;
5272 if (n2 < 0)
5273 n2 = len + n2;
5274 else if (n2 >= len)
5275 n2 = len - 1;
5276 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5277 n2 = -1;
5278 l = list_alloc();
5279 if (l == NULL)
5280 return FAIL;
5281 for (item = list_find(rettv->vval.v_list, n1);
5282 n1 <= n2; ++n1)
5284 if (list_append_tv(l, &item->li_tv) == FAIL)
5286 list_free(l, TRUE);
5287 return FAIL;
5289 item = item->li_next;
5291 clear_tv(rettv);
5292 rettv->v_type = VAR_LIST;
5293 rettv->vval.v_list = l;
5294 ++l->lv_refcount;
5296 else
5298 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5299 clear_tv(rettv);
5300 *rettv = var1;
5302 break;
5304 case VAR_DICT:
5305 if (range)
5307 if (verbose)
5308 EMSG(_(e_dictrange));
5309 if (len == -1)
5310 clear_tv(&var1);
5311 return FAIL;
5314 dictitem_T *item;
5316 if (len == -1)
5318 key = get_tv_string(&var1);
5319 if (*key == NUL)
5321 if (verbose)
5322 EMSG(_(e_emptykey));
5323 clear_tv(&var1);
5324 return FAIL;
5328 item = dict_find(rettv->vval.v_dict, key, (int)len);
5330 if (item == NULL && verbose)
5331 EMSG2(_(e_dictkey), key);
5332 if (len == -1)
5333 clear_tv(&var1);
5334 if (item == NULL)
5335 return FAIL;
5337 copy_tv(&item->di_tv, &var1);
5338 clear_tv(rettv);
5339 *rettv = var1;
5341 break;
5345 return OK;
5349 * Get an option value.
5350 * "arg" points to the '&' or '+' before the option name.
5351 * "arg" is advanced to character after the option name.
5352 * Return OK or FAIL.
5354 static int
5355 get_option_tv(arg, rettv, evaluate)
5356 char_u **arg;
5357 typval_T *rettv; /* when NULL, only check if option exists */
5358 int evaluate;
5360 char_u *option_end;
5361 long numval;
5362 char_u *stringval;
5363 int opt_type;
5364 int c;
5365 int working = (**arg == '+'); /* has("+option") */
5366 int ret = OK;
5367 int opt_flags;
5370 * Isolate the option name and find its value.
5372 option_end = find_option_end(arg, &opt_flags);
5373 if (option_end == NULL)
5375 if (rettv != NULL)
5376 EMSG2(_("E112: Option name missing: %s"), *arg);
5377 return FAIL;
5380 if (!evaluate)
5382 *arg = option_end;
5383 return OK;
5386 c = *option_end;
5387 *option_end = NUL;
5388 opt_type = get_option_value(*arg, &numval,
5389 rettv == NULL ? NULL : &stringval, opt_flags);
5391 if (opt_type == -3) /* invalid name */
5393 if (rettv != NULL)
5394 EMSG2(_("E113: Unknown option: %s"), *arg);
5395 ret = FAIL;
5397 else if (rettv != NULL)
5399 if (opt_type == -2) /* hidden string option */
5401 rettv->v_type = VAR_STRING;
5402 rettv->vval.v_string = NULL;
5404 else if (opt_type == -1) /* hidden number option */
5406 rettv->v_type = VAR_NUMBER;
5407 rettv->vval.v_number = 0;
5409 else if (opt_type == 1) /* number option */
5411 rettv->v_type = VAR_NUMBER;
5412 rettv->vval.v_number = numval;
5414 else /* string option */
5416 rettv->v_type = VAR_STRING;
5417 rettv->vval.v_string = stringval;
5420 else if (working && (opt_type == -2 || opt_type == -1))
5421 ret = FAIL;
5423 *option_end = c; /* put back for error messages */
5424 *arg = option_end;
5426 return ret;
5430 * Allocate a variable for a string constant.
5431 * Return OK or FAIL.
5433 static int
5434 get_string_tv(arg, rettv, evaluate)
5435 char_u **arg;
5436 typval_T *rettv;
5437 int evaluate;
5439 char_u *p;
5440 char_u *name;
5441 int extra = 0;
5444 * Find the end of the string, skipping backslashed characters.
5446 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5448 if (*p == '\\' && p[1] != NUL)
5450 ++p;
5451 /* A "\<x>" form occupies at least 4 characters, and produces up
5452 * to 6 characters: reserve space for 2 extra */
5453 if (*p == '<')
5454 extra += 2;
5458 if (*p != '"')
5460 EMSG2(_("E114: Missing quote: %s"), *arg);
5461 return FAIL;
5464 /* If only parsing, set *arg and return here */
5465 if (!evaluate)
5467 *arg = p + 1;
5468 return OK;
5472 * Copy the string into allocated memory, handling backslashed
5473 * characters.
5475 name = alloc((unsigned)(p - *arg + extra));
5476 if (name == NULL)
5477 return FAIL;
5478 rettv->v_type = VAR_STRING;
5479 rettv->vval.v_string = name;
5481 for (p = *arg + 1; *p != NUL && *p != '"'; )
5483 if (*p == '\\')
5485 switch (*++p)
5487 case 'b': *name++ = BS; ++p; break;
5488 case 'e': *name++ = ESC; ++p; break;
5489 case 'f': *name++ = FF; ++p; break;
5490 case 'n': *name++ = NL; ++p; break;
5491 case 'r': *name++ = CAR; ++p; break;
5492 case 't': *name++ = TAB; ++p; break;
5494 case 'X': /* hex: "\x1", "\x12" */
5495 case 'x':
5496 case 'u': /* Unicode: "\u0023" */
5497 case 'U':
5498 if (vim_isxdigit(p[1]))
5500 int n, nr;
5501 int c = toupper(*p);
5503 if (c == 'X')
5504 n = 2;
5505 else
5506 n = 4;
5507 nr = 0;
5508 while (--n >= 0 && vim_isxdigit(p[1]))
5510 ++p;
5511 nr = (nr << 4) + hex2nr(*p);
5513 ++p;
5514 #ifdef FEAT_MBYTE
5515 /* For "\u" store the number according to
5516 * 'encoding'. */
5517 if (c != 'X')
5518 name += (*mb_char2bytes)(nr, name);
5519 else
5520 #endif
5521 *name++ = nr;
5523 break;
5525 /* octal: "\1", "\12", "\123" */
5526 case '0':
5527 case '1':
5528 case '2':
5529 case '3':
5530 case '4':
5531 case '5':
5532 case '6':
5533 case '7': *name = *p++ - '0';
5534 if (*p >= '0' && *p <= '7')
5536 *name = (*name << 3) + *p++ - '0';
5537 if (*p >= '0' && *p <= '7')
5538 *name = (*name << 3) + *p++ - '0';
5540 ++name;
5541 break;
5543 /* Special key, e.g.: "\<C-W>" */
5544 case '<': extra = trans_special(&p, name, TRUE);
5545 if (extra != 0)
5547 name += extra;
5548 break;
5550 /* FALLTHROUGH */
5552 default: MB_COPY_CHAR(p, name);
5553 break;
5556 else
5557 MB_COPY_CHAR(p, name);
5560 *name = NUL;
5561 *arg = p + 1;
5563 return OK;
5567 * Allocate a variable for a 'str''ing' constant.
5568 * Return OK or FAIL.
5570 static int
5571 get_lit_string_tv(arg, rettv, evaluate)
5572 char_u **arg;
5573 typval_T *rettv;
5574 int evaluate;
5576 char_u *p;
5577 char_u *str;
5578 int reduce = 0;
5581 * Find the end of the string, skipping ''.
5583 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5585 if (*p == '\'')
5587 if (p[1] != '\'')
5588 break;
5589 ++reduce;
5590 ++p;
5594 if (*p != '\'')
5596 EMSG2(_("E115: Missing quote: %s"), *arg);
5597 return FAIL;
5600 /* If only parsing return after setting "*arg" */
5601 if (!evaluate)
5603 *arg = p + 1;
5604 return OK;
5608 * Copy the string into allocated memory, handling '' to ' reduction.
5610 str = alloc((unsigned)((p - *arg) - reduce));
5611 if (str == NULL)
5612 return FAIL;
5613 rettv->v_type = VAR_STRING;
5614 rettv->vval.v_string = str;
5616 for (p = *arg + 1; *p != NUL; )
5618 if (*p == '\'')
5620 if (p[1] != '\'')
5621 break;
5622 ++p;
5624 MB_COPY_CHAR(p, str);
5626 *str = NUL;
5627 *arg = p + 1;
5629 return OK;
5633 * Allocate a variable for a List and fill it from "*arg".
5634 * Return OK or FAIL.
5636 static int
5637 get_list_tv(arg, rettv, evaluate)
5638 char_u **arg;
5639 typval_T *rettv;
5640 int evaluate;
5642 list_T *l = NULL;
5643 typval_T tv;
5644 listitem_T *item;
5646 if (evaluate)
5648 l = list_alloc();
5649 if (l == NULL)
5650 return FAIL;
5653 *arg = skipwhite(*arg + 1);
5654 while (**arg != ']' && **arg != NUL)
5656 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5657 goto failret;
5658 if (evaluate)
5660 item = listitem_alloc();
5661 if (item != NULL)
5663 item->li_tv = tv;
5664 item->li_tv.v_lock = 0;
5665 list_append(l, item);
5667 else
5668 clear_tv(&tv);
5671 if (**arg == ']')
5672 break;
5673 if (**arg != ',')
5675 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5676 goto failret;
5678 *arg = skipwhite(*arg + 1);
5681 if (**arg != ']')
5683 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5684 failret:
5685 if (evaluate)
5686 list_free(l, TRUE);
5687 return FAIL;
5690 *arg = skipwhite(*arg + 1);
5691 if (evaluate)
5693 rettv->v_type = VAR_LIST;
5694 rettv->vval.v_list = l;
5695 ++l->lv_refcount;
5698 return OK;
5702 * Allocate an empty header for a list.
5703 * Caller should take care of the reference count.
5705 list_T *
5706 list_alloc()
5708 list_T *l;
5710 l = (list_T *)alloc_clear(sizeof(list_T));
5711 if (l != NULL)
5713 /* Prepend the list to the list of lists for garbage collection. */
5714 if (first_list != NULL)
5715 first_list->lv_used_prev = l;
5716 l->lv_used_prev = NULL;
5717 l->lv_used_next = first_list;
5718 first_list = l;
5720 return l;
5724 * Allocate an empty list for a return value.
5725 * Returns OK or FAIL.
5727 static int
5728 rettv_list_alloc(rettv)
5729 typval_T *rettv;
5731 list_T *l = list_alloc();
5733 if (l == NULL)
5734 return FAIL;
5736 rettv->vval.v_list = l;
5737 rettv->v_type = VAR_LIST;
5738 ++l->lv_refcount;
5739 return OK;
5743 * Unreference a list: decrement the reference count and free it when it
5744 * becomes zero.
5746 void
5747 list_unref(l)
5748 list_T *l;
5750 if (l != NULL && --l->lv_refcount <= 0)
5751 list_free(l, TRUE);
5755 * Free a list, including all items it points to.
5756 * Ignores the reference count.
5758 void
5759 list_free(l, recurse)
5760 list_T *l;
5761 int recurse; /* Free Lists and Dictionaries recursively. */
5763 listitem_T *item;
5765 /* Remove the list from the list of lists for garbage collection. */
5766 if (l->lv_used_prev == NULL)
5767 first_list = l->lv_used_next;
5768 else
5769 l->lv_used_prev->lv_used_next = l->lv_used_next;
5770 if (l->lv_used_next != NULL)
5771 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5773 for (item = l->lv_first; item != NULL; item = l->lv_first)
5775 /* Remove the item before deleting it. */
5776 l->lv_first = item->li_next;
5777 if (recurse || (item->li_tv.v_type != VAR_LIST
5778 && item->li_tv.v_type != VAR_DICT))
5779 clear_tv(&item->li_tv);
5780 vim_free(item);
5782 vim_free(l);
5786 * Allocate a list item.
5788 static listitem_T *
5789 listitem_alloc()
5791 return (listitem_T *)alloc(sizeof(listitem_T));
5795 * Free a list item. Also clears the value. Does not notify watchers.
5797 static void
5798 listitem_free(item)
5799 listitem_T *item;
5801 clear_tv(&item->li_tv);
5802 vim_free(item);
5806 * Remove a list item from a List and free it. Also clears the value.
5808 static void
5809 listitem_remove(l, item)
5810 list_T *l;
5811 listitem_T *item;
5813 list_remove(l, item, item);
5814 listitem_free(item);
5818 * Get the number of items in a list.
5820 static long
5821 list_len(l)
5822 list_T *l;
5824 if (l == NULL)
5825 return 0L;
5826 return l->lv_len;
5830 * Return TRUE when two lists have exactly the same values.
5832 static int
5833 list_equal(l1, l2, ic)
5834 list_T *l1;
5835 list_T *l2;
5836 int ic; /* ignore case for strings */
5838 listitem_T *item1, *item2;
5840 if (l1 == NULL || l2 == NULL)
5841 return FALSE;
5842 if (l1 == l2)
5843 return TRUE;
5844 if (list_len(l1) != list_len(l2))
5845 return FALSE;
5847 for (item1 = l1->lv_first, item2 = l2->lv_first;
5848 item1 != NULL && item2 != NULL;
5849 item1 = item1->li_next, item2 = item2->li_next)
5850 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5851 return FALSE;
5852 return item1 == NULL && item2 == NULL;
5855 #if defined(FEAT_PYTHON) || defined(PROTO)
5857 * Return the dictitem that an entry in a hashtable points to.
5859 dictitem_T *
5860 dict_lookup(hi)
5861 hashitem_T *hi;
5863 return HI2DI(hi);
5865 #endif
5868 * Return TRUE when two dictionaries have exactly the same key/values.
5870 static int
5871 dict_equal(d1, d2, ic)
5872 dict_T *d1;
5873 dict_T *d2;
5874 int ic; /* ignore case for strings */
5876 hashitem_T *hi;
5877 dictitem_T *item2;
5878 int todo;
5880 if (d1 == NULL || d2 == NULL)
5881 return FALSE;
5882 if (d1 == d2)
5883 return TRUE;
5884 if (dict_len(d1) != dict_len(d2))
5885 return FALSE;
5887 todo = (int)d1->dv_hashtab.ht_used;
5888 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5890 if (!HASHITEM_EMPTY(hi))
5892 item2 = dict_find(d2, hi->hi_key, -1);
5893 if (item2 == NULL)
5894 return FALSE;
5895 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5896 return FALSE;
5897 --todo;
5900 return TRUE;
5904 * Return TRUE if "tv1" and "tv2" have the same value.
5905 * Compares the items just like "==" would compare them, but strings and
5906 * numbers are different. Floats and numbers are also different.
5908 static int
5909 tv_equal(tv1, tv2, ic)
5910 typval_T *tv1;
5911 typval_T *tv2;
5912 int ic; /* ignore case */
5914 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5915 char_u *s1, *s2;
5916 static int recursive = 0; /* cach recursive loops */
5917 int r;
5919 if (tv1->v_type != tv2->v_type)
5920 return FALSE;
5921 /* Catch lists and dicts that have an endless loop by limiting
5922 * recursiveness to 1000. We guess they are equal then. */
5923 if (recursive >= 1000)
5924 return TRUE;
5926 switch (tv1->v_type)
5928 case VAR_LIST:
5929 ++recursive;
5930 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5931 --recursive;
5932 return r;
5934 case VAR_DICT:
5935 ++recursive;
5936 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5937 --recursive;
5938 return r;
5940 case VAR_FUNC:
5941 return (tv1->vval.v_string != NULL
5942 && tv2->vval.v_string != NULL
5943 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5945 case VAR_NUMBER:
5946 return tv1->vval.v_number == tv2->vval.v_number;
5948 #ifdef FEAT_FLOAT
5949 case VAR_FLOAT:
5950 return tv1->vval.v_float == tv2->vval.v_float;
5951 #endif
5953 case VAR_STRING:
5954 s1 = get_tv_string_buf(tv1, buf1);
5955 s2 = get_tv_string_buf(tv2, buf2);
5956 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5959 EMSG2(_(e_intern2), "tv_equal()");
5960 return TRUE;
5964 * Locate item with index "n" in list "l" and return it.
5965 * A negative index is counted from the end; -1 is the last item.
5966 * Returns NULL when "n" is out of range.
5968 static listitem_T *
5969 list_find(l, n)
5970 list_T *l;
5971 long n;
5973 listitem_T *item;
5974 long idx;
5976 if (l == NULL)
5977 return NULL;
5979 /* Negative index is relative to the end. */
5980 if (n < 0)
5981 n = l->lv_len + n;
5983 /* Check for index out of range. */
5984 if (n < 0 || n >= l->lv_len)
5985 return NULL;
5987 /* When there is a cached index may start search from there. */
5988 if (l->lv_idx_item != NULL)
5990 if (n < l->lv_idx / 2)
5992 /* closest to the start of the list */
5993 item = l->lv_first;
5994 idx = 0;
5996 else if (n > (l->lv_idx + l->lv_len) / 2)
5998 /* closest to the end of the list */
5999 item = l->lv_last;
6000 idx = l->lv_len - 1;
6002 else
6004 /* closest to the cached index */
6005 item = l->lv_idx_item;
6006 idx = l->lv_idx;
6009 else
6011 if (n < l->lv_len / 2)
6013 /* closest to the start of the list */
6014 item = l->lv_first;
6015 idx = 0;
6017 else
6019 /* closest to the end of the list */
6020 item = l->lv_last;
6021 idx = l->lv_len - 1;
6025 while (n > idx)
6027 /* search forward */
6028 item = item->li_next;
6029 ++idx;
6031 while (n < idx)
6033 /* search backward */
6034 item = item->li_prev;
6035 --idx;
6038 /* cache the used index */
6039 l->lv_idx = idx;
6040 l->lv_idx_item = item;
6042 return item;
6046 * Get list item "l[idx]" as a number.
6048 static long
6049 list_find_nr(l, idx, errorp)
6050 list_T *l;
6051 long idx;
6052 int *errorp; /* set to TRUE when something wrong */
6054 listitem_T *li;
6056 li = list_find(l, idx);
6057 if (li == NULL)
6059 if (errorp != NULL)
6060 *errorp = TRUE;
6061 return -1L;
6063 return get_tv_number_chk(&li->li_tv, errorp);
6067 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6069 char_u *
6070 list_find_str(l, idx)
6071 list_T *l;
6072 long idx;
6074 listitem_T *li;
6076 li = list_find(l, idx - 1);
6077 if (li == NULL)
6079 EMSGN(_(e_listidx), idx);
6080 return NULL;
6082 return get_tv_string(&li->li_tv);
6086 * Locate "item" list "l" and return its index.
6087 * Returns -1 when "item" is not in the list.
6089 static long
6090 list_idx_of_item(l, item)
6091 list_T *l;
6092 listitem_T *item;
6094 long idx = 0;
6095 listitem_T *li;
6097 if (l == NULL)
6098 return -1;
6099 idx = 0;
6100 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6101 ++idx;
6102 if (li == NULL)
6103 return -1;
6104 return idx;
6108 * Append item "item" to the end of list "l".
6110 static void
6111 list_append(l, item)
6112 list_T *l;
6113 listitem_T *item;
6115 if (l->lv_last == NULL)
6117 /* empty list */
6118 l->lv_first = item;
6119 l->lv_last = item;
6120 item->li_prev = NULL;
6122 else
6124 l->lv_last->li_next = item;
6125 item->li_prev = l->lv_last;
6126 l->lv_last = item;
6128 ++l->lv_len;
6129 item->li_next = NULL;
6133 * Append typval_T "tv" to the end of list "l".
6134 * Return FAIL when out of memory.
6136 static int
6137 list_append_tv(l, tv)
6138 list_T *l;
6139 typval_T *tv;
6141 listitem_T *li = listitem_alloc();
6143 if (li == NULL)
6144 return FAIL;
6145 copy_tv(tv, &li->li_tv);
6146 list_append(l, li);
6147 return OK;
6151 * Add a dictionary to a list. Used by getqflist().
6152 * Return FAIL when out of memory.
6155 list_append_dict(list, dict)
6156 list_T *list;
6157 dict_T *dict;
6159 listitem_T *li = listitem_alloc();
6161 if (li == NULL)
6162 return FAIL;
6163 li->li_tv.v_type = VAR_DICT;
6164 li->li_tv.v_lock = 0;
6165 li->li_tv.vval.v_dict = dict;
6166 list_append(list, li);
6167 ++dict->dv_refcount;
6168 return OK;
6172 * Make a copy of "str" and append it as an item to list "l".
6173 * When "len" >= 0 use "str[len]".
6174 * Returns FAIL when out of memory.
6177 list_append_string(l, str, len)
6178 list_T *l;
6179 char_u *str;
6180 int len;
6182 listitem_T *li = listitem_alloc();
6184 if (li == NULL)
6185 return FAIL;
6186 list_append(l, li);
6187 li->li_tv.v_type = VAR_STRING;
6188 li->li_tv.v_lock = 0;
6189 if (str == NULL)
6190 li->li_tv.vval.v_string = NULL;
6191 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6192 : vim_strsave(str))) == NULL)
6193 return FAIL;
6194 return OK;
6198 * Append "n" to list "l".
6199 * Returns FAIL when out of memory.
6201 static int
6202 list_append_number(l, n)
6203 list_T *l;
6204 varnumber_T n;
6206 listitem_T *li;
6208 li = listitem_alloc();
6209 if (li == NULL)
6210 return FAIL;
6211 li->li_tv.v_type = VAR_NUMBER;
6212 li->li_tv.v_lock = 0;
6213 li->li_tv.vval.v_number = n;
6214 list_append(l, li);
6215 return OK;
6219 * Insert typval_T "tv" in list "l" before "item".
6220 * If "item" is NULL append at the end.
6221 * Return FAIL when out of memory.
6223 static int
6224 list_insert_tv(l, tv, item)
6225 list_T *l;
6226 typval_T *tv;
6227 listitem_T *item;
6229 listitem_T *ni = listitem_alloc();
6231 if (ni == NULL)
6232 return FAIL;
6233 copy_tv(tv, &ni->li_tv);
6234 if (item == NULL)
6235 /* Append new item at end of list. */
6236 list_append(l, ni);
6237 else
6239 /* Insert new item before existing item. */
6240 ni->li_prev = item->li_prev;
6241 ni->li_next = item;
6242 if (item->li_prev == NULL)
6244 l->lv_first = ni;
6245 ++l->lv_idx;
6247 else
6249 item->li_prev->li_next = ni;
6250 l->lv_idx_item = NULL;
6252 item->li_prev = ni;
6253 ++l->lv_len;
6255 return OK;
6259 * Extend "l1" with "l2".
6260 * If "bef" is NULL append at the end, otherwise insert before this item.
6261 * Returns FAIL when out of memory.
6263 static int
6264 list_extend(l1, l2, bef)
6265 list_T *l1;
6266 list_T *l2;
6267 listitem_T *bef;
6269 listitem_T *item;
6270 int todo = l2->lv_len;
6272 /* We also quit the loop when we have inserted the original item count of
6273 * the list, avoid a hang when we extend a list with itself. */
6274 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6275 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6276 return FAIL;
6277 return OK;
6281 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6282 * Return FAIL when out of memory.
6284 static int
6285 list_concat(l1, l2, tv)
6286 list_T *l1;
6287 list_T *l2;
6288 typval_T *tv;
6290 list_T *l;
6292 if (l1 == NULL || l2 == NULL)
6293 return FAIL;
6295 /* make a copy of the first list. */
6296 l = list_copy(l1, FALSE, 0);
6297 if (l == NULL)
6298 return FAIL;
6299 tv->v_type = VAR_LIST;
6300 tv->vval.v_list = l;
6302 /* append all items from the second list */
6303 return list_extend(l, l2, NULL);
6307 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6308 * The refcount of the new list is set to 1.
6309 * See item_copy() for "copyID".
6310 * Returns NULL when out of memory.
6312 static list_T *
6313 list_copy(orig, deep, copyID)
6314 list_T *orig;
6315 int deep;
6316 int copyID;
6318 list_T *copy;
6319 listitem_T *item;
6320 listitem_T *ni;
6322 if (orig == NULL)
6323 return NULL;
6325 copy = list_alloc();
6326 if (copy != NULL)
6328 if (copyID != 0)
6330 /* Do this before adding the items, because one of the items may
6331 * refer back to this list. */
6332 orig->lv_copyID = copyID;
6333 orig->lv_copylist = copy;
6335 for (item = orig->lv_first; item != NULL && !got_int;
6336 item = item->li_next)
6338 ni = listitem_alloc();
6339 if (ni == NULL)
6340 break;
6341 if (deep)
6343 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6345 vim_free(ni);
6346 break;
6349 else
6350 copy_tv(&item->li_tv, &ni->li_tv);
6351 list_append(copy, ni);
6353 ++copy->lv_refcount;
6354 if (item != NULL)
6356 list_unref(copy);
6357 copy = NULL;
6361 return copy;
6365 * Remove items "item" to "item2" from list "l".
6366 * Does not free the listitem or the value!
6368 static void
6369 list_remove(l, item, item2)
6370 list_T *l;
6371 listitem_T *item;
6372 listitem_T *item2;
6374 listitem_T *ip;
6376 /* notify watchers */
6377 for (ip = item; ip != NULL; ip = ip->li_next)
6379 --l->lv_len;
6380 list_fix_watch(l, ip);
6381 if (ip == item2)
6382 break;
6385 if (item2->li_next == NULL)
6386 l->lv_last = item->li_prev;
6387 else
6388 item2->li_next->li_prev = item->li_prev;
6389 if (item->li_prev == NULL)
6390 l->lv_first = item2->li_next;
6391 else
6392 item->li_prev->li_next = item2->li_next;
6393 l->lv_idx_item = NULL;
6397 * Return an allocated string with the string representation of a list.
6398 * May return NULL.
6400 static char_u *
6401 list2string(tv, copyID)
6402 typval_T *tv;
6403 int copyID;
6405 garray_T ga;
6407 if (tv->vval.v_list == NULL)
6408 return NULL;
6409 ga_init2(&ga, (int)sizeof(char), 80);
6410 ga_append(&ga, '[');
6411 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6413 vim_free(ga.ga_data);
6414 return NULL;
6416 ga_append(&ga, ']');
6417 ga_append(&ga, NUL);
6418 return (char_u *)ga.ga_data;
6422 * Join list "l" into a string in "*gap", using separator "sep".
6423 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6424 * Return FAIL or OK.
6426 static int
6427 list_join(gap, l, sep, echo, copyID)
6428 garray_T *gap;
6429 list_T *l;
6430 char_u *sep;
6431 int echo;
6432 int copyID;
6434 int first = TRUE;
6435 char_u *tofree;
6436 char_u numbuf[NUMBUFLEN];
6437 listitem_T *item;
6438 char_u *s;
6440 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6442 if (first)
6443 first = FALSE;
6444 else
6445 ga_concat(gap, sep);
6447 if (echo)
6448 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6449 else
6450 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6451 if (s != NULL)
6452 ga_concat(gap, s);
6453 vim_free(tofree);
6454 if (s == NULL)
6455 return FAIL;
6457 return OK;
6461 * Garbage collection for lists and dictionaries.
6463 * We use reference counts to be able to free most items right away when they
6464 * are no longer used. But for composite items it's possible that it becomes
6465 * unused while the reference count is > 0: When there is a recursive
6466 * reference. Example:
6467 * :let l = [1, 2, 3]
6468 * :let d = {9: l}
6469 * :let l[1] = d
6471 * Since this is quite unusual we handle this with garbage collection: every
6472 * once in a while find out which lists and dicts are not referenced from any
6473 * variable.
6475 * Here is a good reference text about garbage collection (refers to Python
6476 * but it applies to all reference-counting mechanisms):
6477 * http://python.ca/nas/python/gc/
6481 * Do garbage collection for lists and dicts.
6482 * Return TRUE if some memory was freed.
6485 garbage_collect()
6487 dict_T *dd;
6488 list_T *ll;
6489 int copyID = ++current_copyID;
6490 buf_T *buf;
6491 win_T *wp;
6492 int i;
6493 funccall_T *fc;
6494 int did_free = FALSE;
6495 #ifdef FEAT_WINDOWS
6496 tabpage_T *tp;
6497 #endif
6499 /* Only do this once. */
6500 want_garbage_collect = FALSE;
6501 may_garbage_collect = FALSE;
6502 garbage_collect_at_exit = FALSE;
6505 * 1. Go through all accessible variables and mark all lists and dicts
6506 * with copyID.
6508 /* script-local variables */
6509 for (i = 1; i <= ga_scripts.ga_len; ++i)
6510 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6512 /* buffer-local variables */
6513 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6514 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6516 /* window-local variables */
6517 FOR_ALL_TAB_WINDOWS(tp, wp)
6518 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6520 #ifdef FEAT_WINDOWS
6521 /* tabpage-local variables */
6522 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6523 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6524 #endif
6526 /* global variables */
6527 set_ref_in_ht(&globvarht, copyID);
6529 /* function-local variables */
6530 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6532 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6533 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6536 /* v: vars */
6537 set_ref_in_ht(&vimvarht, copyID);
6540 * 2. Go through the list of dicts and free items without the copyID.
6542 for (dd = first_dict; dd != NULL; )
6543 if (dd->dv_copyID != copyID)
6545 /* Free the Dictionary and ordinary items it contains, but don't
6546 * recurse into Lists and Dictionaries, they will be in the list
6547 * of dicts or list of lists. */
6548 dict_free(dd, FALSE);
6549 did_free = TRUE;
6551 /* restart, next dict may also have been freed */
6552 dd = first_dict;
6554 else
6555 dd = dd->dv_used_next;
6558 * 3. Go through the list of lists and free items without the copyID.
6559 * But don't free a list that has a watcher (used in a for loop), these
6560 * are not referenced anywhere.
6562 for (ll = first_list; ll != NULL; )
6563 if (ll->lv_copyID != copyID && ll->lv_watch == NULL)
6565 /* Free the List and ordinary items it contains, but don't recurse
6566 * into Lists and Dictionaries, they will be in the list of dicts
6567 * or list of lists. */
6568 list_free(ll, FALSE);
6569 did_free = TRUE;
6571 /* restart, next list may also have been freed */
6572 ll = first_list;
6574 else
6575 ll = ll->lv_used_next;
6577 return did_free;
6581 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6583 static void
6584 set_ref_in_ht(ht, copyID)
6585 hashtab_T *ht;
6586 int copyID;
6588 int todo;
6589 hashitem_T *hi;
6591 todo = (int)ht->ht_used;
6592 for (hi = ht->ht_array; todo > 0; ++hi)
6593 if (!HASHITEM_EMPTY(hi))
6595 --todo;
6596 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6601 * Mark all lists and dicts referenced through list "l" with "copyID".
6603 static void
6604 set_ref_in_list(l, copyID)
6605 list_T *l;
6606 int copyID;
6608 listitem_T *li;
6610 for (li = l->lv_first; li != NULL; li = li->li_next)
6611 set_ref_in_item(&li->li_tv, copyID);
6615 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6617 static void
6618 set_ref_in_item(tv, copyID)
6619 typval_T *tv;
6620 int copyID;
6622 dict_T *dd;
6623 list_T *ll;
6625 switch (tv->v_type)
6627 case VAR_DICT:
6628 dd = tv->vval.v_dict;
6629 if (dd != NULL && dd->dv_copyID != copyID)
6631 /* Didn't see this dict yet. */
6632 dd->dv_copyID = copyID;
6633 set_ref_in_ht(&dd->dv_hashtab, copyID);
6635 break;
6637 case VAR_LIST:
6638 ll = tv->vval.v_list;
6639 if (ll != NULL && ll->lv_copyID != copyID)
6641 /* Didn't see this list yet. */
6642 ll->lv_copyID = copyID;
6643 set_ref_in_list(ll, copyID);
6645 break;
6647 return;
6651 * Allocate an empty header for a dictionary.
6653 dict_T *
6654 dict_alloc()
6656 dict_T *d;
6658 d = (dict_T *)alloc(sizeof(dict_T));
6659 if (d != NULL)
6661 /* Add the list to the list of dicts for garbage collection. */
6662 if (first_dict != NULL)
6663 first_dict->dv_used_prev = d;
6664 d->dv_used_next = first_dict;
6665 d->dv_used_prev = NULL;
6666 first_dict = d;
6668 hash_init(&d->dv_hashtab);
6669 d->dv_lock = 0;
6670 d->dv_refcount = 0;
6671 d->dv_copyID = 0;
6673 return d;
6677 * Unreference a Dictionary: decrement the reference count and free it when it
6678 * becomes zero.
6680 static void
6681 dict_unref(d)
6682 dict_T *d;
6684 if (d != NULL && --d->dv_refcount <= 0)
6685 dict_free(d, TRUE);
6689 * Free a Dictionary, including all items it contains.
6690 * Ignores the reference count.
6692 static void
6693 dict_free(d, recurse)
6694 dict_T *d;
6695 int recurse; /* Free Lists and Dictionaries recursively. */
6697 int todo;
6698 hashitem_T *hi;
6699 dictitem_T *di;
6701 /* Remove the dict from the list of dicts for garbage collection. */
6702 if (d->dv_used_prev == NULL)
6703 first_dict = d->dv_used_next;
6704 else
6705 d->dv_used_prev->dv_used_next = d->dv_used_next;
6706 if (d->dv_used_next != NULL)
6707 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6709 /* Lock the hashtab, we don't want it to resize while freeing items. */
6710 hash_lock(&d->dv_hashtab);
6711 todo = (int)d->dv_hashtab.ht_used;
6712 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6714 if (!HASHITEM_EMPTY(hi))
6716 /* Remove the item before deleting it, just in case there is
6717 * something recursive causing trouble. */
6718 di = HI2DI(hi);
6719 hash_remove(&d->dv_hashtab, hi);
6720 if (recurse || (di->di_tv.v_type != VAR_LIST
6721 && di->di_tv.v_type != VAR_DICT))
6722 clear_tv(&di->di_tv);
6723 vim_free(di);
6724 --todo;
6727 hash_clear(&d->dv_hashtab);
6728 vim_free(d);
6732 * Allocate a Dictionary item.
6733 * The "key" is copied to the new item.
6734 * Note that the value of the item "di_tv" still needs to be initialized!
6735 * Returns NULL when out of memory.
6737 static dictitem_T *
6738 dictitem_alloc(key)
6739 char_u *key;
6741 dictitem_T *di;
6743 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6744 if (di != NULL)
6746 STRCPY(di->di_key, key);
6747 di->di_flags = 0;
6749 return di;
6753 * Make a copy of a Dictionary item.
6755 static dictitem_T *
6756 dictitem_copy(org)
6757 dictitem_T *org;
6759 dictitem_T *di;
6761 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6762 + STRLEN(org->di_key)));
6763 if (di != NULL)
6765 STRCPY(di->di_key, org->di_key);
6766 di->di_flags = 0;
6767 copy_tv(&org->di_tv, &di->di_tv);
6769 return di;
6773 * Remove item "item" from Dictionary "dict" and free it.
6775 static void
6776 dictitem_remove(dict, item)
6777 dict_T *dict;
6778 dictitem_T *item;
6780 hashitem_T *hi;
6782 hi = hash_find(&dict->dv_hashtab, item->di_key);
6783 if (HASHITEM_EMPTY(hi))
6784 EMSG2(_(e_intern2), "dictitem_remove()");
6785 else
6786 hash_remove(&dict->dv_hashtab, hi);
6787 dictitem_free(item);
6791 * Free a dict item. Also clears the value.
6793 static void
6794 dictitem_free(item)
6795 dictitem_T *item;
6797 clear_tv(&item->di_tv);
6798 vim_free(item);
6802 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6803 * The refcount of the new dict is set to 1.
6804 * See item_copy() for "copyID".
6805 * Returns NULL when out of memory.
6807 static dict_T *
6808 dict_copy(orig, deep, copyID)
6809 dict_T *orig;
6810 int deep;
6811 int copyID;
6813 dict_T *copy;
6814 dictitem_T *di;
6815 int todo;
6816 hashitem_T *hi;
6818 if (orig == NULL)
6819 return NULL;
6821 copy = dict_alloc();
6822 if (copy != NULL)
6824 if (copyID != 0)
6826 orig->dv_copyID = copyID;
6827 orig->dv_copydict = copy;
6829 todo = (int)orig->dv_hashtab.ht_used;
6830 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6832 if (!HASHITEM_EMPTY(hi))
6834 --todo;
6836 di = dictitem_alloc(hi->hi_key);
6837 if (di == NULL)
6838 break;
6839 if (deep)
6841 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6842 copyID) == FAIL)
6844 vim_free(di);
6845 break;
6848 else
6849 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6850 if (dict_add(copy, di) == FAIL)
6852 dictitem_free(di);
6853 break;
6858 ++copy->dv_refcount;
6859 if (todo > 0)
6861 dict_unref(copy);
6862 copy = NULL;
6866 return copy;
6870 * Add item "item" to Dictionary "d".
6871 * Returns FAIL when out of memory and when key already existed.
6873 static int
6874 dict_add(d, item)
6875 dict_T *d;
6876 dictitem_T *item;
6878 return hash_add(&d->dv_hashtab, item->di_key);
6882 * Add a number or string entry to dictionary "d".
6883 * When "str" is NULL use number "nr", otherwise use "str".
6884 * Returns FAIL when out of memory and when key already exists.
6887 dict_add_nr_str(d, key, nr, str)
6888 dict_T *d;
6889 char *key;
6890 long nr;
6891 char_u *str;
6893 dictitem_T *item;
6895 item = dictitem_alloc((char_u *)key);
6896 if (item == NULL)
6897 return FAIL;
6898 item->di_tv.v_lock = 0;
6899 if (str == NULL)
6901 item->di_tv.v_type = VAR_NUMBER;
6902 item->di_tv.vval.v_number = nr;
6904 else
6906 item->di_tv.v_type = VAR_STRING;
6907 item->di_tv.vval.v_string = vim_strsave(str);
6909 if (dict_add(d, item) == FAIL)
6911 dictitem_free(item);
6912 return FAIL;
6914 return OK;
6918 * Get the number of items in a Dictionary.
6920 static long
6921 dict_len(d)
6922 dict_T *d;
6924 if (d == NULL)
6925 return 0L;
6926 return (long)d->dv_hashtab.ht_used;
6930 * Find item "key[len]" in Dictionary "d".
6931 * If "len" is negative use strlen(key).
6932 * Returns NULL when not found.
6934 static dictitem_T *
6935 dict_find(d, key, len)
6936 dict_T *d;
6937 char_u *key;
6938 int len;
6940 #define AKEYLEN 200
6941 char_u buf[AKEYLEN];
6942 char_u *akey;
6943 char_u *tofree = NULL;
6944 hashitem_T *hi;
6946 if (len < 0)
6947 akey = key;
6948 else if (len >= AKEYLEN)
6950 tofree = akey = vim_strnsave(key, len);
6951 if (akey == NULL)
6952 return NULL;
6954 else
6956 /* Avoid a malloc/free by using buf[]. */
6957 vim_strncpy(buf, key, len);
6958 akey = buf;
6961 hi = hash_find(&d->dv_hashtab, akey);
6962 vim_free(tofree);
6963 if (HASHITEM_EMPTY(hi))
6964 return NULL;
6965 return HI2DI(hi);
6969 * Get a string item from a dictionary.
6970 * When "save" is TRUE allocate memory for it.
6971 * Returns NULL if the entry doesn't exist or out of memory.
6973 char_u *
6974 get_dict_string(d, key, save)
6975 dict_T *d;
6976 char_u *key;
6977 int save;
6979 dictitem_T *di;
6980 char_u *s;
6982 di = dict_find(d, key, -1);
6983 if (di == NULL)
6984 return NULL;
6985 s = get_tv_string(&di->di_tv);
6986 if (save && s != NULL)
6987 s = vim_strsave(s);
6988 return s;
6992 * Get a number item from a dictionary.
6993 * Returns 0 if the entry doesn't exist or out of memory.
6995 long
6996 get_dict_number(d, key)
6997 dict_T *d;
6998 char_u *key;
7000 dictitem_T *di;
7002 di = dict_find(d, key, -1);
7003 if (di == NULL)
7004 return 0;
7005 return get_tv_number(&di->di_tv);
7009 * Return an allocated string with the string representation of a Dictionary.
7010 * May return NULL.
7012 static char_u *
7013 dict2string(tv, copyID)
7014 typval_T *tv;
7015 int copyID;
7017 garray_T ga;
7018 int first = TRUE;
7019 char_u *tofree;
7020 char_u numbuf[NUMBUFLEN];
7021 hashitem_T *hi;
7022 char_u *s;
7023 dict_T *d;
7024 int todo;
7026 if ((d = tv->vval.v_dict) == NULL)
7027 return NULL;
7028 ga_init2(&ga, (int)sizeof(char), 80);
7029 ga_append(&ga, '{');
7031 todo = (int)d->dv_hashtab.ht_used;
7032 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7034 if (!HASHITEM_EMPTY(hi))
7036 --todo;
7038 if (first)
7039 first = FALSE;
7040 else
7041 ga_concat(&ga, (char_u *)", ");
7043 tofree = string_quote(hi->hi_key, FALSE);
7044 if (tofree != NULL)
7046 ga_concat(&ga, tofree);
7047 vim_free(tofree);
7049 ga_concat(&ga, (char_u *)": ");
7050 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7051 if (s != NULL)
7052 ga_concat(&ga, s);
7053 vim_free(tofree);
7054 if (s == NULL)
7055 break;
7058 if (todo > 0)
7060 vim_free(ga.ga_data);
7061 return NULL;
7064 ga_append(&ga, '}');
7065 ga_append(&ga, NUL);
7066 return (char_u *)ga.ga_data;
7070 * Allocate a variable for a Dictionary and fill it from "*arg".
7071 * Return OK or FAIL. Returns NOTDONE for {expr}.
7073 static int
7074 get_dict_tv(arg, rettv, evaluate)
7075 char_u **arg;
7076 typval_T *rettv;
7077 int evaluate;
7079 dict_T *d = NULL;
7080 typval_T tvkey;
7081 typval_T tv;
7082 char_u *key = NULL;
7083 dictitem_T *item;
7084 char_u *start = skipwhite(*arg + 1);
7085 char_u buf[NUMBUFLEN];
7088 * First check if it's not a curly-braces thing: {expr}.
7089 * Must do this without evaluating, otherwise a function may be called
7090 * twice. Unfortunately this means we need to call eval1() twice for the
7091 * first item.
7092 * But {} is an empty Dictionary.
7094 if (*start != '}')
7096 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7097 return FAIL;
7098 if (*start == '}')
7099 return NOTDONE;
7102 if (evaluate)
7104 d = dict_alloc();
7105 if (d == NULL)
7106 return FAIL;
7108 tvkey.v_type = VAR_UNKNOWN;
7109 tv.v_type = VAR_UNKNOWN;
7111 *arg = skipwhite(*arg + 1);
7112 while (**arg != '}' && **arg != NUL)
7114 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7115 goto failret;
7116 if (**arg != ':')
7118 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7119 clear_tv(&tvkey);
7120 goto failret;
7122 if (evaluate)
7124 key = get_tv_string_buf_chk(&tvkey, buf);
7125 if (key == NULL || *key == NUL)
7127 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7128 if (key != NULL)
7129 EMSG(_(e_emptykey));
7130 clear_tv(&tvkey);
7131 goto failret;
7135 *arg = skipwhite(*arg + 1);
7136 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7138 if (evaluate)
7139 clear_tv(&tvkey);
7140 goto failret;
7142 if (evaluate)
7144 item = dict_find(d, key, -1);
7145 if (item != NULL)
7147 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7148 clear_tv(&tvkey);
7149 clear_tv(&tv);
7150 goto failret;
7152 item = dictitem_alloc(key);
7153 clear_tv(&tvkey);
7154 if (item != NULL)
7156 item->di_tv = tv;
7157 item->di_tv.v_lock = 0;
7158 if (dict_add(d, item) == FAIL)
7159 dictitem_free(item);
7163 if (**arg == '}')
7164 break;
7165 if (**arg != ',')
7167 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7168 goto failret;
7170 *arg = skipwhite(*arg + 1);
7173 if (**arg != '}')
7175 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7176 failret:
7177 if (evaluate)
7178 dict_free(d, TRUE);
7179 return FAIL;
7182 *arg = skipwhite(*arg + 1);
7183 if (evaluate)
7185 rettv->v_type = VAR_DICT;
7186 rettv->vval.v_dict = d;
7187 ++d->dv_refcount;
7190 return OK;
7194 * Return a string with the string representation of a variable.
7195 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7196 * "numbuf" is used for a number.
7197 * Does not put quotes around strings, as ":echo" displays values.
7198 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7199 * May return NULL.
7201 static char_u *
7202 echo_string(tv, tofree, numbuf, copyID)
7203 typval_T *tv;
7204 char_u **tofree;
7205 char_u *numbuf;
7206 int copyID;
7208 static int recurse = 0;
7209 char_u *r = NULL;
7211 if (recurse >= DICT_MAXNEST)
7213 EMSG(_("E724: variable nested too deep for displaying"));
7214 *tofree = NULL;
7215 return NULL;
7217 ++recurse;
7219 switch (tv->v_type)
7221 case VAR_FUNC:
7222 *tofree = NULL;
7223 r = tv->vval.v_string;
7224 break;
7226 case VAR_LIST:
7227 if (tv->vval.v_list == NULL)
7229 *tofree = NULL;
7230 r = NULL;
7232 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7234 *tofree = NULL;
7235 r = (char_u *)"[...]";
7237 else
7239 tv->vval.v_list->lv_copyID = copyID;
7240 *tofree = list2string(tv, copyID);
7241 r = *tofree;
7243 break;
7245 case VAR_DICT:
7246 if (tv->vval.v_dict == NULL)
7248 *tofree = NULL;
7249 r = NULL;
7251 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7253 *tofree = NULL;
7254 r = (char_u *)"{...}";
7256 else
7258 tv->vval.v_dict->dv_copyID = copyID;
7259 *tofree = dict2string(tv, copyID);
7260 r = *tofree;
7262 break;
7264 case VAR_STRING:
7265 case VAR_NUMBER:
7266 *tofree = NULL;
7267 r = get_tv_string_buf(tv, numbuf);
7268 break;
7270 #ifdef FEAT_FLOAT
7271 case VAR_FLOAT:
7272 *tofree = NULL;
7273 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7274 r = numbuf;
7275 break;
7276 #endif
7278 default:
7279 EMSG2(_(e_intern2), "echo_string()");
7280 *tofree = NULL;
7283 --recurse;
7284 return r;
7288 * Return a string with the string representation of a variable.
7289 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7290 * "numbuf" is used for a number.
7291 * Puts quotes around strings, so that they can be parsed back by eval().
7292 * May return NULL.
7294 static char_u *
7295 tv2string(tv, tofree, numbuf, copyID)
7296 typval_T *tv;
7297 char_u **tofree;
7298 char_u *numbuf;
7299 int copyID;
7301 switch (tv->v_type)
7303 case VAR_FUNC:
7304 *tofree = string_quote(tv->vval.v_string, TRUE);
7305 return *tofree;
7306 case VAR_STRING:
7307 *tofree = string_quote(tv->vval.v_string, FALSE);
7308 return *tofree;
7309 #ifdef FEAT_FLOAT
7310 case VAR_FLOAT:
7311 *tofree = NULL;
7312 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7313 return numbuf;
7314 #endif
7315 case VAR_NUMBER:
7316 case VAR_LIST:
7317 case VAR_DICT:
7318 break;
7319 default:
7320 EMSG2(_(e_intern2), "tv2string()");
7322 return echo_string(tv, tofree, numbuf, copyID);
7326 * Return string "str" in ' quotes, doubling ' characters.
7327 * If "str" is NULL an empty string is assumed.
7328 * If "function" is TRUE make it function('string').
7330 static char_u *
7331 string_quote(str, function)
7332 char_u *str;
7333 int function;
7335 unsigned len;
7336 char_u *p, *r, *s;
7338 len = (function ? 13 : 3);
7339 if (str != NULL)
7341 len += (unsigned)STRLEN(str);
7342 for (p = str; *p != NUL; mb_ptr_adv(p))
7343 if (*p == '\'')
7344 ++len;
7346 s = r = alloc(len);
7347 if (r != NULL)
7349 if (function)
7351 STRCPY(r, "function('");
7352 r += 10;
7354 else
7355 *r++ = '\'';
7356 if (str != NULL)
7357 for (p = str; *p != NUL; )
7359 if (*p == '\'')
7360 *r++ = '\'';
7361 MB_COPY_CHAR(p, r);
7363 *r++ = '\'';
7364 if (function)
7365 *r++ = ')';
7366 *r++ = NUL;
7368 return s;
7371 #ifdef FEAT_FLOAT
7373 * Convert the string "text" to a floating point number.
7374 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7375 * this always uses a decimal point.
7376 * Returns the length of the text that was consumed.
7378 static int
7379 string2float(text, value)
7380 char_u *text;
7381 float_T *value; /* result stored here */
7383 char *s = (char *)text;
7384 float_T f;
7386 f = strtod(s, &s);
7387 *value = f;
7388 return (int)((char_u *)s - text);
7390 #endif
7393 * Get the value of an environment variable.
7394 * "arg" is pointing to the '$'. It is advanced to after the name.
7395 * If the environment variable was not set, silently assume it is empty.
7396 * Always return OK.
7398 static int
7399 get_env_tv(arg, rettv, evaluate)
7400 char_u **arg;
7401 typval_T *rettv;
7402 int evaluate;
7404 char_u *string = NULL;
7405 int len;
7406 int cc;
7407 char_u *name;
7408 int mustfree = FALSE;
7410 ++*arg;
7411 name = *arg;
7412 len = get_env_len(arg);
7413 if (evaluate)
7415 if (len != 0)
7417 cc = name[len];
7418 name[len] = NUL;
7419 /* first try vim_getenv(), fast for normal environment vars */
7420 string = vim_getenv(name, &mustfree);
7421 if (string != NULL && *string != NUL)
7423 if (!mustfree)
7424 string = vim_strsave(string);
7426 else
7428 if (mustfree)
7429 vim_free(string);
7431 /* next try expanding things like $VIM and ${HOME} */
7432 string = expand_env_save(name - 1);
7433 if (string != NULL && *string == '$')
7435 vim_free(string);
7436 string = NULL;
7439 name[len] = cc;
7441 rettv->v_type = VAR_STRING;
7442 rettv->vval.v_string = string;
7445 return OK;
7449 * Array with names and number of arguments of all internal functions
7450 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7452 static struct fst
7454 char *f_name; /* function name */
7455 char f_min_argc; /* minimal number of arguments */
7456 char f_max_argc; /* maximal number of arguments */
7457 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7458 /* implementation of function */
7459 } functions[] =
7461 #ifdef FEAT_FLOAT
7462 {"abs", 1, 1, f_abs},
7463 #endif
7464 {"add", 2, 2, f_add},
7465 {"append", 2, 2, f_append},
7466 {"argc", 0, 0, f_argc},
7467 {"argidx", 0, 0, f_argidx},
7468 {"argv", 0, 1, f_argv},
7469 #ifdef FEAT_FLOAT
7470 {"atan", 1, 1, f_atan},
7471 #endif
7472 {"browse", 4, 4, f_browse},
7473 {"browsedir", 2, 2, f_browsedir},
7474 {"bufexists", 1, 1, f_bufexists},
7475 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7476 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7477 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7478 {"buflisted", 1, 1, f_buflisted},
7479 {"bufloaded", 1, 1, f_bufloaded},
7480 {"bufname", 1, 1, f_bufname},
7481 {"bufnr", 1, 2, f_bufnr},
7482 {"bufwinnr", 1, 1, f_bufwinnr},
7483 {"byte2line", 1, 1, f_byte2line},
7484 {"byteidx", 2, 2, f_byteidx},
7485 {"call", 2, 3, f_call},
7486 #ifdef FEAT_FLOAT
7487 {"ceil", 1, 1, f_ceil},
7488 #endif
7489 {"changenr", 0, 0, f_changenr},
7490 {"char2nr", 1, 1, f_char2nr},
7491 {"cindent", 1, 1, f_cindent},
7492 {"clearmatches", 0, 0, f_clearmatches},
7493 {"col", 1, 1, f_col},
7494 #if defined(FEAT_INS_EXPAND)
7495 {"complete", 2, 2, f_complete},
7496 {"complete_add", 1, 1, f_complete_add},
7497 {"complete_check", 0, 0, f_complete_check},
7498 #endif
7499 {"confirm", 1, 4, f_confirm},
7500 {"copy", 1, 1, f_copy},
7501 #ifdef FEAT_FLOAT
7502 {"cos", 1, 1, f_cos},
7503 #endif
7504 {"count", 2, 4, f_count},
7505 {"cscope_connection",0,3, f_cscope_connection},
7506 {"cursor", 1, 3, f_cursor},
7507 {"deepcopy", 1, 2, f_deepcopy},
7508 {"delete", 1, 1, f_delete},
7509 {"did_filetype", 0, 0, f_did_filetype},
7510 {"diff_filler", 1, 1, f_diff_filler},
7511 {"diff_hlID", 2, 2, f_diff_hlID},
7512 {"empty", 1, 1, f_empty},
7513 {"escape", 2, 2, f_escape},
7514 {"eval", 1, 1, f_eval},
7515 {"eventhandler", 0, 0, f_eventhandler},
7516 {"executable", 1, 1, f_executable},
7517 {"exists", 1, 1, f_exists},
7518 {"expand", 1, 2, f_expand},
7519 {"extend", 2, 3, f_extend},
7520 {"feedkeys", 1, 2, f_feedkeys},
7521 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7522 {"filereadable", 1, 1, f_filereadable},
7523 {"filewritable", 1, 1, f_filewritable},
7524 {"filter", 2, 2, f_filter},
7525 {"finddir", 1, 3, f_finddir},
7526 {"findfile", 1, 3, f_findfile},
7527 #ifdef FEAT_FLOAT
7528 {"float2nr", 1, 1, f_float2nr},
7529 {"floor", 1, 1, f_floor},
7530 #endif
7531 {"fnameescape", 1, 1, f_fnameescape},
7532 {"fnamemodify", 2, 2, f_fnamemodify},
7533 {"foldclosed", 1, 1, f_foldclosed},
7534 {"foldclosedend", 1, 1, f_foldclosedend},
7535 {"foldlevel", 1, 1, f_foldlevel},
7536 {"foldtext", 0, 0, f_foldtext},
7537 {"foldtextresult", 1, 1, f_foldtextresult},
7538 {"foreground", 0, 0, f_foreground},
7539 {"function", 1, 1, f_function},
7540 {"garbagecollect", 0, 1, f_garbagecollect},
7541 {"get", 2, 3, f_get},
7542 {"getbufline", 2, 3, f_getbufline},
7543 {"getbufvar", 2, 2, f_getbufvar},
7544 {"getchar", 0, 1, f_getchar},
7545 {"getcharmod", 0, 0, f_getcharmod},
7546 {"getcmdline", 0, 0, f_getcmdline},
7547 {"getcmdpos", 0, 0, f_getcmdpos},
7548 {"getcmdtype", 0, 0, f_getcmdtype},
7549 {"getcwd", 0, 0, f_getcwd},
7550 {"getfontname", 0, 1, f_getfontname},
7551 {"getfperm", 1, 1, f_getfperm},
7552 {"getfsize", 1, 1, f_getfsize},
7553 {"getftime", 1, 1, f_getftime},
7554 {"getftype", 1, 1, f_getftype},
7555 {"getline", 1, 2, f_getline},
7556 {"getloclist", 1, 1, f_getqflist},
7557 {"getmatches", 0, 0, f_getmatches},
7558 {"getpid", 0, 0, f_getpid},
7559 {"getpos", 1, 1, f_getpos},
7560 {"getqflist", 0, 0, f_getqflist},
7561 {"getreg", 0, 2, f_getreg},
7562 {"getregtype", 0, 1, f_getregtype},
7563 {"gettabwinvar", 3, 3, f_gettabwinvar},
7564 {"getwinposx", 0, 0, f_getwinposx},
7565 {"getwinposy", 0, 0, f_getwinposy},
7566 {"getwinvar", 2, 2, f_getwinvar},
7567 {"glob", 1, 2, f_glob},
7568 {"globpath", 2, 3, f_globpath},
7569 {"has", 1, 1, f_has},
7570 {"has_key", 2, 2, f_has_key},
7571 {"haslocaldir", 0, 0, f_haslocaldir},
7572 {"hasmapto", 1, 3, f_hasmapto},
7573 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7574 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7575 {"histadd", 2, 2, f_histadd},
7576 {"histdel", 1, 2, f_histdel},
7577 {"histget", 1, 2, f_histget},
7578 {"histnr", 1, 1, f_histnr},
7579 {"hlID", 1, 1, f_hlID},
7580 {"hlexists", 1, 1, f_hlexists},
7581 {"hostname", 0, 0, f_hostname},
7582 {"iconv", 3, 3, f_iconv},
7583 {"indent", 1, 1, f_indent},
7584 {"index", 2, 4, f_index},
7585 {"input", 1, 3, f_input},
7586 {"inputdialog", 1, 3, f_inputdialog},
7587 {"inputlist", 1, 1, f_inputlist},
7588 {"inputrestore", 0, 0, f_inputrestore},
7589 {"inputsave", 0, 0, f_inputsave},
7590 {"inputsecret", 1, 2, f_inputsecret},
7591 {"insert", 2, 3, f_insert},
7592 {"isdirectory", 1, 1, f_isdirectory},
7593 {"islocked", 1, 1, f_islocked},
7594 {"items", 1, 1, f_items},
7595 {"join", 1, 2, f_join},
7596 {"keys", 1, 1, f_keys},
7597 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7598 {"len", 1, 1, f_len},
7599 {"libcall", 3, 3, f_libcall},
7600 {"libcallnr", 3, 3, f_libcallnr},
7601 {"line", 1, 1, f_line},
7602 {"line2byte", 1, 1, f_line2byte},
7603 {"lispindent", 1, 1, f_lispindent},
7604 {"localtime", 0, 0, f_localtime},
7605 #ifdef FEAT_FLOAT
7606 {"log10", 1, 1, f_log10},
7607 #endif
7608 {"map", 2, 2, f_map},
7609 {"maparg", 1, 3, f_maparg},
7610 {"mapcheck", 1, 3, f_mapcheck},
7611 {"match", 2, 4, f_match},
7612 {"matchadd", 2, 4, f_matchadd},
7613 {"matcharg", 1, 1, f_matcharg},
7614 {"matchdelete", 1, 1, f_matchdelete},
7615 {"matchend", 2, 4, f_matchend},
7616 {"matchlist", 2, 4, f_matchlist},
7617 {"matchstr", 2, 4, f_matchstr},
7618 {"max", 1, 1, f_max},
7619 {"min", 1, 1, f_min},
7620 #ifdef vim_mkdir
7621 {"mkdir", 1, 3, f_mkdir},
7622 #endif
7623 {"mode", 0, 1, f_mode},
7624 {"nextnonblank", 1, 1, f_nextnonblank},
7625 {"nr2char", 1, 1, f_nr2char},
7626 {"pathshorten", 1, 1, f_pathshorten},
7627 #ifdef FEAT_FLOAT
7628 {"pow", 2, 2, f_pow},
7629 #endif
7630 {"prevnonblank", 1, 1, f_prevnonblank},
7631 {"printf", 2, 19, f_printf},
7632 {"pumvisible", 0, 0, f_pumvisible},
7633 {"range", 1, 3, f_range},
7634 {"readfile", 1, 3, f_readfile},
7635 {"reltime", 0, 2, f_reltime},
7636 {"reltimestr", 1, 1, f_reltimestr},
7637 {"remote_expr", 2, 3, f_remote_expr},
7638 {"remote_foreground", 1, 1, f_remote_foreground},
7639 {"remote_peek", 1, 2, f_remote_peek},
7640 {"remote_read", 1, 1, f_remote_read},
7641 {"remote_send", 2, 3, f_remote_send},
7642 {"remove", 2, 3, f_remove},
7643 {"rename", 2, 2, f_rename},
7644 {"repeat", 2, 2, f_repeat},
7645 {"resolve", 1, 1, f_resolve},
7646 {"reverse", 1, 1, f_reverse},
7647 #ifdef FEAT_FLOAT
7648 {"round", 1, 1, f_round},
7649 #endif
7650 {"search", 1, 4, f_search},
7651 {"searchdecl", 1, 3, f_searchdecl},
7652 {"searchpair", 3, 7, f_searchpair},
7653 {"searchpairpos", 3, 7, f_searchpairpos},
7654 {"searchpos", 1, 4, f_searchpos},
7655 {"server2client", 2, 2, f_server2client},
7656 {"serverlist", 0, 0, f_serverlist},
7657 {"setbufvar", 3, 3, f_setbufvar},
7658 {"setcmdpos", 1, 1, f_setcmdpos},
7659 {"setline", 2, 2, f_setline},
7660 {"setloclist", 2, 3, f_setloclist},
7661 {"setmatches", 1, 1, f_setmatches},
7662 {"setpos", 2, 2, f_setpos},
7663 {"setqflist", 1, 2, f_setqflist},
7664 {"setreg", 2, 3, f_setreg},
7665 {"settabwinvar", 4, 4, f_settabwinvar},
7666 {"setwinvar", 3, 3, f_setwinvar},
7667 {"shellescape", 1, 2, f_shellescape},
7668 {"simplify", 1, 1, f_simplify},
7669 #ifdef FEAT_FLOAT
7670 {"sin", 1, 1, f_sin},
7671 #endif
7672 {"sort", 1, 2, f_sort},
7673 {"soundfold", 1, 1, f_soundfold},
7674 {"spellbadword", 0, 1, f_spellbadword},
7675 {"spellsuggest", 1, 3, f_spellsuggest},
7676 {"split", 1, 3, f_split},
7677 #ifdef FEAT_FLOAT
7678 {"sqrt", 1, 1, f_sqrt},
7679 {"str2float", 1, 1, f_str2float},
7680 #endif
7681 {"str2nr", 1, 2, f_str2nr},
7682 #ifdef HAVE_STRFTIME
7683 {"strftime", 1, 2, f_strftime},
7684 #endif
7685 {"stridx", 2, 3, f_stridx},
7686 {"string", 1, 1, f_string},
7687 {"strlen", 1, 1, f_strlen},
7688 {"strpart", 2, 3, f_strpart},
7689 {"strridx", 2, 3, f_strridx},
7690 {"strtrans", 1, 1, f_strtrans},
7691 {"submatch", 1, 1, f_submatch},
7692 {"substitute", 4, 4, f_substitute},
7693 {"synID", 3, 3, f_synID},
7694 {"synIDattr", 2, 3, f_synIDattr},
7695 {"synIDtrans", 1, 1, f_synIDtrans},
7696 {"synstack", 2, 2, f_synstack},
7697 {"system", 1, 2, f_system},
7698 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7699 {"tabpagenr", 0, 1, f_tabpagenr},
7700 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7701 {"tagfiles", 0, 0, f_tagfiles},
7702 {"taglist", 1, 1, f_taglist},
7703 {"tempname", 0, 0, f_tempname},
7704 {"test", 1, 1, f_test},
7705 {"tolower", 1, 1, f_tolower},
7706 {"toupper", 1, 1, f_toupper},
7707 {"tr", 3, 3, f_tr},
7708 #ifdef FEAT_FLOAT
7709 {"trunc", 1, 1, f_trunc},
7710 #endif
7711 {"type", 1, 1, f_type},
7712 {"values", 1, 1, f_values},
7713 {"virtcol", 1, 1, f_virtcol},
7714 {"visualmode", 0, 1, f_visualmode},
7715 {"winbufnr", 1, 1, f_winbufnr},
7716 {"wincol", 0, 0, f_wincol},
7717 {"winheight", 1, 1, f_winheight},
7718 {"winline", 0, 0, f_winline},
7719 {"winnr", 0, 1, f_winnr},
7720 {"winrestcmd", 0, 0, f_winrestcmd},
7721 {"winrestview", 1, 1, f_winrestview},
7722 {"winsaveview", 0, 0, f_winsaveview},
7723 {"winwidth", 1, 1, f_winwidth},
7724 {"writefile", 2, 3, f_writefile},
7727 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7730 * Function given to ExpandGeneric() to obtain the list of internal
7731 * or user defined function names.
7733 char_u *
7734 get_function_name(xp, idx)
7735 expand_T *xp;
7736 int idx;
7738 static int intidx = -1;
7739 char_u *name;
7741 if (idx == 0)
7742 intidx = -1;
7743 if (intidx < 0)
7745 name = get_user_func_name(xp, idx);
7746 if (name != NULL)
7747 return name;
7749 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7751 STRCPY(IObuff, functions[intidx].f_name);
7752 STRCAT(IObuff, "(");
7753 if (functions[intidx].f_max_argc == 0)
7754 STRCAT(IObuff, ")");
7755 return IObuff;
7758 return NULL;
7762 * Function given to ExpandGeneric() to obtain the list of internal or
7763 * user defined variable or function names.
7765 /*ARGSUSED*/
7766 char_u *
7767 get_expr_name(xp, idx)
7768 expand_T *xp;
7769 int idx;
7771 static int intidx = -1;
7772 char_u *name;
7774 if (idx == 0)
7775 intidx = -1;
7776 if (intidx < 0)
7778 name = get_function_name(xp, idx);
7779 if (name != NULL)
7780 return name;
7782 return get_user_var_name(xp, ++intidx);
7785 #endif /* FEAT_CMDL_COMPL */
7788 * Find internal function in table above.
7789 * Return index, or -1 if not found
7791 static int
7792 find_internal_func(name)
7793 char_u *name; /* name of the function */
7795 int first = 0;
7796 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7797 int cmp;
7798 int x;
7801 * Find the function name in the table. Binary search.
7803 while (first <= last)
7805 x = first + ((unsigned)(last - first) >> 1);
7806 cmp = STRCMP(name, functions[x].f_name);
7807 if (cmp < 0)
7808 last = x - 1;
7809 else if (cmp > 0)
7810 first = x + 1;
7811 else
7812 return x;
7814 return -1;
7818 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7819 * name it contains, otherwise return "name".
7821 static char_u *
7822 deref_func_name(name, lenp)
7823 char_u *name;
7824 int *lenp;
7826 dictitem_T *v;
7827 int cc;
7829 cc = name[*lenp];
7830 name[*lenp] = NUL;
7831 v = find_var(name, NULL);
7832 name[*lenp] = cc;
7833 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7835 if (v->di_tv.vval.v_string == NULL)
7837 *lenp = 0;
7838 return (char_u *)""; /* just in case */
7840 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7841 return v->di_tv.vval.v_string;
7844 return name;
7848 * Allocate a variable for the result of a function.
7849 * Return OK or FAIL.
7851 static int
7852 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7853 evaluate, selfdict)
7854 char_u *name; /* name of the function */
7855 int len; /* length of "name" */
7856 typval_T *rettv;
7857 char_u **arg; /* argument, pointing to the '(' */
7858 linenr_T firstline; /* first line of range */
7859 linenr_T lastline; /* last line of range */
7860 int *doesrange; /* return: function handled range */
7861 int evaluate;
7862 dict_T *selfdict; /* Dictionary for "self" */
7864 char_u *argp;
7865 int ret = OK;
7866 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7867 int argcount = 0; /* number of arguments found */
7870 * Get the arguments.
7872 argp = *arg;
7873 while (argcount < MAX_FUNC_ARGS)
7875 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7876 if (*argp == ')' || *argp == ',' || *argp == NUL)
7877 break;
7878 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7880 ret = FAIL;
7881 break;
7883 ++argcount;
7884 if (*argp != ',')
7885 break;
7887 if (*argp == ')')
7888 ++argp;
7889 else
7890 ret = FAIL;
7892 if (ret == OK)
7893 ret = call_func(name, len, rettv, argcount, argvars,
7894 firstline, lastline, doesrange, evaluate, selfdict);
7895 else if (!aborting())
7897 if (argcount == MAX_FUNC_ARGS)
7898 emsg_funcname("E740: Too many arguments for function %s", name);
7899 else
7900 emsg_funcname("E116: Invalid arguments for function %s", name);
7903 while (--argcount >= 0)
7904 clear_tv(&argvars[argcount]);
7906 *arg = skipwhite(argp);
7907 return ret;
7912 * Call a function with its resolved parameters
7913 * Return OK when the function can't be called, FAIL otherwise.
7914 * Also returns OK when an error was encountered while executing the function.
7916 static int
7917 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7918 doesrange, evaluate, selfdict)
7919 char_u *name; /* name of the function */
7920 int len; /* length of "name" */
7921 typval_T *rettv; /* return value goes here */
7922 int argcount; /* number of "argvars" */
7923 typval_T *argvars; /* vars for arguments, must have "argcount"
7924 PLUS ONE elements! */
7925 linenr_T firstline; /* first line of range */
7926 linenr_T lastline; /* last line of range */
7927 int *doesrange; /* return: function handled range */
7928 int evaluate;
7929 dict_T *selfdict; /* Dictionary for "self" */
7931 int ret = FAIL;
7932 #define ERROR_UNKNOWN 0
7933 #define ERROR_TOOMANY 1
7934 #define ERROR_TOOFEW 2
7935 #define ERROR_SCRIPT 3
7936 #define ERROR_DICT 4
7937 #define ERROR_NONE 5
7938 #define ERROR_OTHER 6
7939 int error = ERROR_NONE;
7940 int i;
7941 int llen;
7942 ufunc_T *fp;
7943 int cc;
7944 #define FLEN_FIXED 40
7945 char_u fname_buf[FLEN_FIXED + 1];
7946 char_u *fname;
7949 * In a script change <SID>name() and s:name() to K_SNR 123_name().
7950 * Change <SNR>123_name() to K_SNR 123_name().
7951 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
7953 cc = name[len];
7954 name[len] = NUL;
7955 llen = eval_fname_script(name);
7956 if (llen > 0)
7958 fname_buf[0] = K_SPECIAL;
7959 fname_buf[1] = KS_EXTRA;
7960 fname_buf[2] = (int)KE_SNR;
7961 i = 3;
7962 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
7964 if (current_SID <= 0)
7965 error = ERROR_SCRIPT;
7966 else
7968 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
7969 i = (int)STRLEN(fname_buf);
7972 if (i + STRLEN(name + llen) < FLEN_FIXED)
7974 STRCPY(fname_buf + i, name + llen);
7975 fname = fname_buf;
7977 else
7979 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
7980 if (fname == NULL)
7981 error = ERROR_OTHER;
7982 else
7984 mch_memmove(fname, fname_buf, (size_t)i);
7985 STRCPY(fname + i, name + llen);
7989 else
7990 fname = name;
7992 *doesrange = FALSE;
7995 /* execute the function if no errors detected and executing */
7996 if (evaluate && error == ERROR_NONE)
7998 rettv->v_type = VAR_NUMBER; /* default is number rettv */
7999 error = ERROR_UNKNOWN;
8001 if (!builtin_function(fname))
8004 * User defined function.
8006 fp = find_func(fname);
8008 #ifdef FEAT_AUTOCMD
8009 /* Trigger FuncUndefined event, may load the function. */
8010 if (fp == NULL
8011 && apply_autocmds(EVENT_FUNCUNDEFINED,
8012 fname, fname, TRUE, NULL)
8013 && !aborting())
8015 /* executed an autocommand, search for the function again */
8016 fp = find_func(fname);
8018 #endif
8019 /* Try loading a package. */
8020 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8022 /* loaded a package, search for the function again */
8023 fp = find_func(fname);
8026 if (fp != NULL)
8028 if (fp->uf_flags & FC_RANGE)
8029 *doesrange = TRUE;
8030 if (argcount < fp->uf_args.ga_len)
8031 error = ERROR_TOOFEW;
8032 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8033 error = ERROR_TOOMANY;
8034 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8035 error = ERROR_DICT;
8036 else
8039 * Call the user function.
8040 * Save and restore search patterns, script variables and
8041 * redo buffer.
8043 save_search_patterns();
8044 saveRedobuff();
8045 ++fp->uf_calls;
8046 call_user_func(fp, argcount, argvars, rettv,
8047 firstline, lastline,
8048 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8049 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8050 && fp->uf_refcount <= 0)
8051 /* Function was unreferenced while being used, free it
8052 * now. */
8053 func_free(fp);
8054 restoreRedobuff();
8055 restore_search_patterns();
8056 error = ERROR_NONE;
8060 else
8063 * Find the function name in the table, call its implementation.
8065 i = find_internal_func(fname);
8066 if (i >= 0)
8068 if (argcount < functions[i].f_min_argc)
8069 error = ERROR_TOOFEW;
8070 else if (argcount > functions[i].f_max_argc)
8071 error = ERROR_TOOMANY;
8072 else
8074 argvars[argcount].v_type = VAR_UNKNOWN;
8075 functions[i].f_func(argvars, rettv);
8076 error = ERROR_NONE;
8081 * The function call (or "FuncUndefined" autocommand sequence) might
8082 * have been aborted by an error, an interrupt, or an explicitly thrown
8083 * exception that has not been caught so far. This situation can be
8084 * tested for by calling aborting(). For an error in an internal
8085 * function or for the "E132" error in call_user_func(), however, the
8086 * throw point at which the "force_abort" flag (temporarily reset by
8087 * emsg()) is normally updated has not been reached yet. We need to
8088 * update that flag first to make aborting() reliable.
8090 update_force_abort();
8092 if (error == ERROR_NONE)
8093 ret = OK;
8096 * Report an error unless the argument evaluation or function call has been
8097 * cancelled due to an aborting error, an interrupt, or an exception.
8099 if (!aborting())
8101 switch (error)
8103 case ERROR_UNKNOWN:
8104 emsg_funcname(N_("E117: Unknown function: %s"), name);
8105 break;
8106 case ERROR_TOOMANY:
8107 emsg_funcname(e_toomanyarg, name);
8108 break;
8109 case ERROR_TOOFEW:
8110 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8111 name);
8112 break;
8113 case ERROR_SCRIPT:
8114 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8115 name);
8116 break;
8117 case ERROR_DICT:
8118 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8119 name);
8120 break;
8124 name[len] = cc;
8125 if (fname != name && fname != fname_buf)
8126 vim_free(fname);
8128 return ret;
8132 * Give an error message with a function name. Handle <SNR> things.
8134 static void
8135 emsg_funcname(ermsg, name)
8136 char *ermsg;
8137 char_u *name;
8139 char_u *p;
8141 if (*name == K_SPECIAL)
8142 p = concat_str((char_u *)"<SNR>", name + 3);
8143 else
8144 p = name;
8145 EMSG2(_(ermsg), p);
8146 if (p != name)
8147 vim_free(p);
8151 * Return TRUE for a non-zero Number and a non-empty String.
8153 static int
8154 non_zero_arg(argvars)
8155 typval_T *argvars;
8157 return ((argvars[0].v_type == VAR_NUMBER
8158 && argvars[0].vval.v_number != 0)
8159 || (argvars[0].v_type == VAR_STRING
8160 && argvars[0].vval.v_string != NULL
8161 && *argvars[0].vval.v_string != NUL));
8164 /*********************************************
8165 * Implementation of the built-in functions
8168 #ifdef FEAT_FLOAT
8170 * "abs(expr)" function
8172 static void
8173 f_abs(argvars, rettv)
8174 typval_T *argvars;
8175 typval_T *rettv;
8177 if (argvars[0].v_type == VAR_FLOAT)
8179 rettv->v_type = VAR_FLOAT;
8180 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8182 else
8184 varnumber_T n;
8185 int error = FALSE;
8187 n = get_tv_number_chk(&argvars[0], &error);
8188 if (error)
8189 rettv->vval.v_number = -1;
8190 else if (n > 0)
8191 rettv->vval.v_number = n;
8192 else
8193 rettv->vval.v_number = -n;
8196 #endif
8199 * "add(list, item)" function
8201 static void
8202 f_add(argvars, rettv)
8203 typval_T *argvars;
8204 typval_T *rettv;
8206 list_T *l;
8208 rettv->vval.v_number = 1; /* Default: Failed */
8209 if (argvars[0].v_type == VAR_LIST)
8211 if ((l = argvars[0].vval.v_list) != NULL
8212 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8213 && list_append_tv(l, &argvars[1]) == OK)
8214 copy_tv(&argvars[0], rettv);
8216 else
8217 EMSG(_(e_listreq));
8221 * "append(lnum, string/list)" function
8223 static void
8224 f_append(argvars, rettv)
8225 typval_T *argvars;
8226 typval_T *rettv;
8228 long lnum;
8229 char_u *line;
8230 list_T *l = NULL;
8231 listitem_T *li = NULL;
8232 typval_T *tv;
8233 long added = 0;
8235 lnum = get_tv_lnum(argvars);
8236 if (lnum >= 0
8237 && lnum <= curbuf->b_ml.ml_line_count
8238 && u_save(lnum, lnum + 1) == OK)
8240 if (argvars[1].v_type == VAR_LIST)
8242 l = argvars[1].vval.v_list;
8243 if (l == NULL)
8244 return;
8245 li = l->lv_first;
8247 rettv->vval.v_number = 0; /* Default: Success */
8248 for (;;)
8250 if (l == NULL)
8251 tv = &argvars[1]; /* append a string */
8252 else if (li == NULL)
8253 break; /* end of list */
8254 else
8255 tv = &li->li_tv; /* append item from list */
8256 line = get_tv_string_chk(tv);
8257 if (line == NULL) /* type error */
8259 rettv->vval.v_number = 1; /* Failed */
8260 break;
8262 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8263 ++added;
8264 if (l == NULL)
8265 break;
8266 li = li->li_next;
8269 appended_lines_mark(lnum, added);
8270 if (curwin->w_cursor.lnum > lnum)
8271 curwin->w_cursor.lnum += added;
8273 else
8274 rettv->vval.v_number = 1; /* Failed */
8278 * "argc()" function
8280 /* ARGSUSED */
8281 static void
8282 f_argc(argvars, rettv)
8283 typval_T *argvars;
8284 typval_T *rettv;
8286 rettv->vval.v_number = ARGCOUNT;
8290 * "argidx()" function
8292 /* ARGSUSED */
8293 static void
8294 f_argidx(argvars, rettv)
8295 typval_T *argvars;
8296 typval_T *rettv;
8298 rettv->vval.v_number = curwin->w_arg_idx;
8302 * "argv(nr)" function
8304 static void
8305 f_argv(argvars, rettv)
8306 typval_T *argvars;
8307 typval_T *rettv;
8309 int idx;
8311 if (argvars[0].v_type != VAR_UNKNOWN)
8313 idx = get_tv_number_chk(&argvars[0], NULL);
8314 if (idx >= 0 && idx < ARGCOUNT)
8315 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8316 else
8317 rettv->vval.v_string = NULL;
8318 rettv->v_type = VAR_STRING;
8320 else if (rettv_list_alloc(rettv) == OK)
8321 for (idx = 0; idx < ARGCOUNT; ++idx)
8322 list_append_string(rettv->vval.v_list,
8323 alist_name(&ARGLIST[idx]), -1);
8326 #ifdef FEAT_FLOAT
8327 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8330 * Get the float value of "argvars[0]" into "f".
8331 * Returns FAIL when the argument is not a Number or Float.
8333 static int
8334 get_float_arg(argvars, f)
8335 typval_T *argvars;
8336 float_T *f;
8338 if (argvars[0].v_type == VAR_FLOAT)
8340 *f = argvars[0].vval.v_float;
8341 return OK;
8343 if (argvars[0].v_type == VAR_NUMBER)
8345 *f = (float_T)argvars[0].vval.v_number;
8346 return OK;
8348 EMSG(_("E808: Number or Float required"));
8349 return FAIL;
8353 * "atan()" function
8355 static void
8356 f_atan(argvars, rettv)
8357 typval_T *argvars;
8358 typval_T *rettv;
8360 float_T f;
8362 rettv->v_type = VAR_FLOAT;
8363 if (get_float_arg(argvars, &f) == OK)
8364 rettv->vval.v_float = atan(f);
8365 else
8366 rettv->vval.v_float = 0.0;
8368 #endif
8371 * "browse(save, title, initdir, default)" function
8373 /* ARGSUSED */
8374 static void
8375 f_browse(argvars, rettv)
8376 typval_T *argvars;
8377 typval_T *rettv;
8379 #ifdef FEAT_BROWSE
8380 int save;
8381 char_u *title;
8382 char_u *initdir;
8383 char_u *defname;
8384 char_u buf[NUMBUFLEN];
8385 char_u buf2[NUMBUFLEN];
8386 int error = FALSE;
8388 save = get_tv_number_chk(&argvars[0], &error);
8389 title = get_tv_string_chk(&argvars[1]);
8390 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8391 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8393 if (error || title == NULL || initdir == NULL || defname == NULL)
8394 rettv->vval.v_string = NULL;
8395 else
8396 rettv->vval.v_string =
8397 do_browse(save ? BROWSE_SAVE : 0,
8398 title, defname, NULL, initdir, NULL, curbuf);
8399 #else
8400 rettv->vval.v_string = NULL;
8401 #endif
8402 rettv->v_type = VAR_STRING;
8406 * "browsedir(title, initdir)" function
8408 /* ARGSUSED */
8409 static void
8410 f_browsedir(argvars, rettv)
8411 typval_T *argvars;
8412 typval_T *rettv;
8414 #ifdef FEAT_BROWSE
8415 char_u *title;
8416 char_u *initdir;
8417 char_u buf[NUMBUFLEN];
8419 title = get_tv_string_chk(&argvars[0]);
8420 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8422 if (title == NULL || initdir == NULL)
8423 rettv->vval.v_string = NULL;
8424 else
8425 rettv->vval.v_string = do_browse(BROWSE_DIR,
8426 title, NULL, NULL, initdir, NULL, curbuf);
8427 #else
8428 rettv->vval.v_string = NULL;
8429 #endif
8430 rettv->v_type = VAR_STRING;
8433 static buf_T *find_buffer __ARGS((typval_T *avar));
8436 * Find a buffer by number or exact name.
8438 static buf_T *
8439 find_buffer(avar)
8440 typval_T *avar;
8442 buf_T *buf = NULL;
8444 if (avar->v_type == VAR_NUMBER)
8445 buf = buflist_findnr((int)avar->vval.v_number);
8446 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8448 buf = buflist_findname_exp(avar->vval.v_string);
8449 if (buf == NULL)
8451 /* No full path name match, try a match with a URL or a "nofile"
8452 * buffer, these don't use the full path. */
8453 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8454 if (buf->b_fname != NULL
8455 && (path_with_url(buf->b_fname)
8456 #ifdef FEAT_QUICKFIX
8457 || bt_nofile(buf)
8458 #endif
8460 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8461 break;
8464 return buf;
8468 * "bufexists(expr)" function
8470 static void
8471 f_bufexists(argvars, rettv)
8472 typval_T *argvars;
8473 typval_T *rettv;
8475 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8479 * "buflisted(expr)" function
8481 static void
8482 f_buflisted(argvars, rettv)
8483 typval_T *argvars;
8484 typval_T *rettv;
8486 buf_T *buf;
8488 buf = find_buffer(&argvars[0]);
8489 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8493 * "bufloaded(expr)" function
8495 static void
8496 f_bufloaded(argvars, rettv)
8497 typval_T *argvars;
8498 typval_T *rettv;
8500 buf_T *buf;
8502 buf = find_buffer(&argvars[0]);
8503 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8506 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8509 * Get buffer by number or pattern.
8511 static buf_T *
8512 get_buf_tv(tv)
8513 typval_T *tv;
8515 char_u *name = tv->vval.v_string;
8516 int save_magic;
8517 char_u *save_cpo;
8518 buf_T *buf;
8520 if (tv->v_type == VAR_NUMBER)
8521 return buflist_findnr((int)tv->vval.v_number);
8522 if (tv->v_type != VAR_STRING)
8523 return NULL;
8524 if (name == NULL || *name == NUL)
8525 return curbuf;
8526 if (name[0] == '$' && name[1] == NUL)
8527 return lastbuf;
8529 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8530 save_magic = p_magic;
8531 p_magic = TRUE;
8532 save_cpo = p_cpo;
8533 p_cpo = (char_u *)"";
8535 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8536 TRUE, FALSE));
8538 p_magic = save_magic;
8539 p_cpo = save_cpo;
8541 /* If not found, try expanding the name, like done for bufexists(). */
8542 if (buf == NULL)
8543 buf = find_buffer(tv);
8545 return buf;
8549 * "bufname(expr)" function
8551 static void
8552 f_bufname(argvars, rettv)
8553 typval_T *argvars;
8554 typval_T *rettv;
8556 buf_T *buf;
8558 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8559 ++emsg_off;
8560 buf = get_buf_tv(&argvars[0]);
8561 rettv->v_type = VAR_STRING;
8562 if (buf != NULL && buf->b_fname != NULL)
8563 rettv->vval.v_string = vim_strsave(buf->b_fname);
8564 else
8565 rettv->vval.v_string = NULL;
8566 --emsg_off;
8570 * "bufnr(expr)" function
8572 static void
8573 f_bufnr(argvars, rettv)
8574 typval_T *argvars;
8575 typval_T *rettv;
8577 buf_T *buf;
8578 int error = FALSE;
8579 char_u *name;
8581 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8582 ++emsg_off;
8583 buf = get_buf_tv(&argvars[0]);
8584 --emsg_off;
8586 /* If the buffer isn't found and the second argument is not zero create a
8587 * new buffer. */
8588 if (buf == NULL
8589 && argvars[1].v_type != VAR_UNKNOWN
8590 && get_tv_number_chk(&argvars[1], &error) != 0
8591 && !error
8592 && (name = get_tv_string_chk(&argvars[0])) != NULL
8593 && !error)
8594 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8596 if (buf != NULL)
8597 rettv->vval.v_number = buf->b_fnum;
8598 else
8599 rettv->vval.v_number = -1;
8603 * "bufwinnr(nr)" function
8605 static void
8606 f_bufwinnr(argvars, rettv)
8607 typval_T *argvars;
8608 typval_T *rettv;
8610 #ifdef FEAT_WINDOWS
8611 win_T *wp;
8612 int winnr = 0;
8613 #endif
8614 buf_T *buf;
8616 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8617 ++emsg_off;
8618 buf = get_buf_tv(&argvars[0]);
8619 #ifdef FEAT_WINDOWS
8620 for (wp = firstwin; wp; wp = wp->w_next)
8622 ++winnr;
8623 if (wp->w_buffer == buf)
8624 break;
8626 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8627 #else
8628 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8629 #endif
8630 --emsg_off;
8634 * "byte2line(byte)" function
8636 /*ARGSUSED*/
8637 static void
8638 f_byte2line(argvars, rettv)
8639 typval_T *argvars;
8640 typval_T *rettv;
8642 #ifndef FEAT_BYTEOFF
8643 rettv->vval.v_number = -1;
8644 #else
8645 long boff = 0;
8647 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8648 if (boff < 0)
8649 rettv->vval.v_number = -1;
8650 else
8651 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8652 (linenr_T)0, &boff);
8653 #endif
8657 * "byteidx()" function
8659 /*ARGSUSED*/
8660 static void
8661 f_byteidx(argvars, rettv)
8662 typval_T *argvars;
8663 typval_T *rettv;
8665 #ifdef FEAT_MBYTE
8666 char_u *t;
8667 #endif
8668 char_u *str;
8669 long idx;
8671 str = get_tv_string_chk(&argvars[0]);
8672 idx = get_tv_number_chk(&argvars[1], NULL);
8673 rettv->vval.v_number = -1;
8674 if (str == NULL || idx < 0)
8675 return;
8677 #ifdef FEAT_MBYTE
8678 t = str;
8679 for ( ; idx > 0; idx--)
8681 if (*t == NUL) /* EOL reached */
8682 return;
8683 t += (*mb_ptr2len)(t);
8685 rettv->vval.v_number = (varnumber_T)(t - str);
8686 #else
8687 if ((size_t)idx <= STRLEN(str))
8688 rettv->vval.v_number = idx;
8689 #endif
8693 * "call(func, arglist)" function
8695 static void
8696 f_call(argvars, rettv)
8697 typval_T *argvars;
8698 typval_T *rettv;
8700 char_u *func;
8701 typval_T argv[MAX_FUNC_ARGS + 1];
8702 int argc = 0;
8703 listitem_T *item;
8704 int dummy;
8705 dict_T *selfdict = NULL;
8707 rettv->vval.v_number = 0;
8708 if (argvars[1].v_type != VAR_LIST)
8710 EMSG(_(e_listreq));
8711 return;
8713 if (argvars[1].vval.v_list == NULL)
8714 return;
8716 if (argvars[0].v_type == VAR_FUNC)
8717 func = argvars[0].vval.v_string;
8718 else
8719 func = get_tv_string(&argvars[0]);
8720 if (*func == NUL)
8721 return; /* type error or empty name */
8723 if (argvars[2].v_type != VAR_UNKNOWN)
8725 if (argvars[2].v_type != VAR_DICT)
8727 EMSG(_(e_dictreq));
8728 return;
8730 selfdict = argvars[2].vval.v_dict;
8733 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8734 item = item->li_next)
8736 if (argc == MAX_FUNC_ARGS)
8738 EMSG(_("E699: Too many arguments"));
8739 break;
8741 /* Make a copy of each argument. This is needed to be able to set
8742 * v_lock to VAR_FIXED in the copy without changing the original list.
8744 copy_tv(&item->li_tv, &argv[argc++]);
8747 if (item == NULL)
8748 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8749 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8750 &dummy, TRUE, selfdict);
8752 /* Free the arguments. */
8753 while (argc > 0)
8754 clear_tv(&argv[--argc]);
8757 #ifdef FEAT_FLOAT
8759 * "ceil({float})" function
8761 static void
8762 f_ceil(argvars, rettv)
8763 typval_T *argvars;
8764 typval_T *rettv;
8766 float_T f;
8768 rettv->v_type = VAR_FLOAT;
8769 if (get_float_arg(argvars, &f) == OK)
8770 rettv->vval.v_float = ceil(f);
8771 else
8772 rettv->vval.v_float = 0.0;
8774 #endif
8777 * "changenr()" function
8779 /*ARGSUSED*/
8780 static void
8781 f_changenr(argvars, rettv)
8782 typval_T *argvars;
8783 typval_T *rettv;
8785 rettv->vval.v_number = curbuf->b_u_seq_cur;
8789 * "char2nr(string)" function
8791 static void
8792 f_char2nr(argvars, rettv)
8793 typval_T *argvars;
8794 typval_T *rettv;
8796 #ifdef FEAT_MBYTE
8797 if (has_mbyte)
8798 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8799 else
8800 #endif
8801 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8805 * "cindent(lnum)" function
8807 static void
8808 f_cindent(argvars, rettv)
8809 typval_T *argvars;
8810 typval_T *rettv;
8812 #ifdef FEAT_CINDENT
8813 pos_T pos;
8814 linenr_T lnum;
8816 pos = curwin->w_cursor;
8817 lnum = get_tv_lnum(argvars);
8818 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8820 curwin->w_cursor.lnum = lnum;
8821 rettv->vval.v_number = get_c_indent();
8822 curwin->w_cursor = pos;
8824 else
8825 #endif
8826 rettv->vval.v_number = -1;
8830 * "clearmatches()" function
8832 /*ARGSUSED*/
8833 static void
8834 f_clearmatches(argvars, rettv)
8835 typval_T *argvars;
8836 typval_T *rettv;
8838 #ifdef FEAT_SEARCH_EXTRA
8839 clear_matches(curwin);
8840 #endif
8844 * "col(string)" function
8846 static void
8847 f_col(argvars, rettv)
8848 typval_T *argvars;
8849 typval_T *rettv;
8851 colnr_T col = 0;
8852 pos_T *fp;
8853 int fnum = curbuf->b_fnum;
8855 fp = var2fpos(&argvars[0], FALSE, &fnum);
8856 if (fp != NULL && fnum == curbuf->b_fnum)
8858 if (fp->col == MAXCOL)
8860 /* '> can be MAXCOL, get the length of the line then */
8861 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8862 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8863 else
8864 col = MAXCOL;
8866 else
8868 col = fp->col + 1;
8869 #ifdef FEAT_VIRTUALEDIT
8870 /* col(".") when the cursor is on the NUL at the end of the line
8871 * because of "coladd" can be seen as an extra column. */
8872 if (virtual_active() && fp == &curwin->w_cursor)
8874 char_u *p = ml_get_cursor();
8876 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8877 curwin->w_virtcol - curwin->w_cursor.coladd))
8879 # ifdef FEAT_MBYTE
8880 int l;
8882 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8883 col += l;
8884 # else
8885 if (*p != NUL && p[1] == NUL)
8886 ++col;
8887 # endif
8890 #endif
8893 rettv->vval.v_number = col;
8896 #if defined(FEAT_INS_EXPAND)
8898 * "complete()" function
8900 /*ARGSUSED*/
8901 static void
8902 f_complete(argvars, rettv)
8903 typval_T *argvars;
8904 typval_T *rettv;
8906 int startcol;
8908 if ((State & INSERT) == 0)
8910 EMSG(_("E785: complete() can only be used in Insert mode"));
8911 return;
8914 /* Check for undo allowed here, because if something was already inserted
8915 * the line was already saved for undo and this check isn't done. */
8916 if (!undo_allowed())
8917 return;
8919 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8921 EMSG(_(e_invarg));
8922 return;
8925 startcol = get_tv_number_chk(&argvars[0], NULL);
8926 if (startcol <= 0)
8927 return;
8929 set_completion(startcol - 1, argvars[1].vval.v_list);
8933 * "complete_add()" function
8935 /*ARGSUSED*/
8936 static void
8937 f_complete_add(argvars, rettv)
8938 typval_T *argvars;
8939 typval_T *rettv;
8941 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
8945 * "complete_check()" function
8947 /*ARGSUSED*/
8948 static void
8949 f_complete_check(argvars, rettv)
8950 typval_T *argvars;
8951 typval_T *rettv;
8953 int saved = RedrawingDisabled;
8955 RedrawingDisabled = 0;
8956 ins_compl_check_keys(0);
8957 rettv->vval.v_number = compl_interrupted;
8958 RedrawingDisabled = saved;
8960 #endif
8963 * "confirm(message, buttons[, default [, type]])" function
8965 /*ARGSUSED*/
8966 static void
8967 f_confirm(argvars, rettv)
8968 typval_T *argvars;
8969 typval_T *rettv;
8971 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
8972 char_u *message;
8973 char_u *buttons = NULL;
8974 char_u buf[NUMBUFLEN];
8975 char_u buf2[NUMBUFLEN];
8976 int def = 1;
8977 int type = VIM_GENERIC;
8978 char_u *typestr;
8979 int error = FALSE;
8981 message = get_tv_string_chk(&argvars[0]);
8982 if (message == NULL)
8983 error = TRUE;
8984 if (argvars[1].v_type != VAR_UNKNOWN)
8986 buttons = get_tv_string_buf_chk(&argvars[1], buf);
8987 if (buttons == NULL)
8988 error = TRUE;
8989 if (argvars[2].v_type != VAR_UNKNOWN)
8991 def = get_tv_number_chk(&argvars[2], &error);
8992 if (argvars[3].v_type != VAR_UNKNOWN)
8994 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
8995 if (typestr == NULL)
8996 error = TRUE;
8997 else
8999 switch (TOUPPER_ASC(*typestr))
9001 case 'E': type = VIM_ERROR; break;
9002 case 'Q': type = VIM_QUESTION; break;
9003 case 'I': type = VIM_INFO; break;
9004 case 'W': type = VIM_WARNING; break;
9005 case 'G': type = VIM_GENERIC; break;
9012 if (buttons == NULL || *buttons == NUL)
9013 buttons = (char_u *)_("&Ok");
9015 if (error)
9016 rettv->vval.v_number = 0;
9017 else
9018 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9019 def, NULL);
9020 #else
9021 rettv->vval.v_number = 0;
9022 #endif
9026 * "copy()" function
9028 static void
9029 f_copy(argvars, rettv)
9030 typval_T *argvars;
9031 typval_T *rettv;
9033 item_copy(&argvars[0], rettv, FALSE, 0);
9036 #ifdef FEAT_FLOAT
9038 * "cos()" function
9040 static void
9041 f_cos(argvars, rettv)
9042 typval_T *argvars;
9043 typval_T *rettv;
9045 float_T f;
9047 rettv->v_type = VAR_FLOAT;
9048 if (get_float_arg(argvars, &f) == OK)
9049 rettv->vval.v_float = cos(f);
9050 else
9051 rettv->vval.v_float = 0.0;
9053 #endif
9056 * "count()" function
9058 static void
9059 f_count(argvars, rettv)
9060 typval_T *argvars;
9061 typval_T *rettv;
9063 long n = 0;
9064 int ic = FALSE;
9066 if (argvars[0].v_type == VAR_LIST)
9068 listitem_T *li;
9069 list_T *l;
9070 long idx;
9072 if ((l = argvars[0].vval.v_list) != NULL)
9074 li = l->lv_first;
9075 if (argvars[2].v_type != VAR_UNKNOWN)
9077 int error = FALSE;
9079 ic = get_tv_number_chk(&argvars[2], &error);
9080 if (argvars[3].v_type != VAR_UNKNOWN)
9082 idx = get_tv_number_chk(&argvars[3], &error);
9083 if (!error)
9085 li = list_find(l, idx);
9086 if (li == NULL)
9087 EMSGN(_(e_listidx), idx);
9090 if (error)
9091 li = NULL;
9094 for ( ; li != NULL; li = li->li_next)
9095 if (tv_equal(&li->li_tv, &argvars[1], ic))
9096 ++n;
9099 else if (argvars[0].v_type == VAR_DICT)
9101 int todo;
9102 dict_T *d;
9103 hashitem_T *hi;
9105 if ((d = argvars[0].vval.v_dict) != NULL)
9107 int error = FALSE;
9109 if (argvars[2].v_type != VAR_UNKNOWN)
9111 ic = get_tv_number_chk(&argvars[2], &error);
9112 if (argvars[3].v_type != VAR_UNKNOWN)
9113 EMSG(_(e_invarg));
9116 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9117 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9119 if (!HASHITEM_EMPTY(hi))
9121 --todo;
9122 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9123 ++n;
9128 else
9129 EMSG2(_(e_listdictarg), "count()");
9130 rettv->vval.v_number = n;
9134 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9136 * Checks the existence of a cscope connection.
9138 /*ARGSUSED*/
9139 static void
9140 f_cscope_connection(argvars, rettv)
9141 typval_T *argvars;
9142 typval_T *rettv;
9144 #ifdef FEAT_CSCOPE
9145 int num = 0;
9146 char_u *dbpath = NULL;
9147 char_u *prepend = NULL;
9148 char_u buf[NUMBUFLEN];
9150 if (argvars[0].v_type != VAR_UNKNOWN
9151 && argvars[1].v_type != VAR_UNKNOWN)
9153 num = (int)get_tv_number(&argvars[0]);
9154 dbpath = get_tv_string(&argvars[1]);
9155 if (argvars[2].v_type != VAR_UNKNOWN)
9156 prepend = get_tv_string_buf(&argvars[2], buf);
9159 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9160 #else
9161 rettv->vval.v_number = 0;
9162 #endif
9166 * "cursor(lnum, col)" function
9168 * Moves the cursor to the specified line and column
9170 /*ARGSUSED*/
9171 static void
9172 f_cursor(argvars, rettv)
9173 typval_T *argvars;
9174 typval_T *rettv;
9176 long line, col;
9177 #ifdef FEAT_VIRTUALEDIT
9178 long coladd = 0;
9179 #endif
9181 if (argvars[1].v_type == VAR_UNKNOWN)
9183 pos_T pos;
9185 if (list2fpos(argvars, &pos, NULL) == FAIL)
9186 return;
9187 line = pos.lnum;
9188 col = pos.col;
9189 #ifdef FEAT_VIRTUALEDIT
9190 coladd = pos.coladd;
9191 #endif
9193 else
9195 line = get_tv_lnum(argvars);
9196 col = get_tv_number_chk(&argvars[1], NULL);
9197 #ifdef FEAT_VIRTUALEDIT
9198 if (argvars[2].v_type != VAR_UNKNOWN)
9199 coladd = get_tv_number_chk(&argvars[2], NULL);
9200 #endif
9202 if (line < 0 || col < 0
9203 #ifdef FEAT_VIRTUALEDIT
9204 || coladd < 0
9205 #endif
9207 return; /* type error; errmsg already given */
9208 if (line > 0)
9209 curwin->w_cursor.lnum = line;
9210 if (col > 0)
9211 curwin->w_cursor.col = col - 1;
9212 #ifdef FEAT_VIRTUALEDIT
9213 curwin->w_cursor.coladd = coladd;
9214 #endif
9216 /* Make sure the cursor is in a valid position. */
9217 check_cursor();
9218 #ifdef FEAT_MBYTE
9219 /* Correct cursor for multi-byte character. */
9220 if (has_mbyte)
9221 mb_adjust_cursor();
9222 #endif
9224 curwin->w_set_curswant = TRUE;
9228 * "deepcopy()" function
9230 static void
9231 f_deepcopy(argvars, rettv)
9232 typval_T *argvars;
9233 typval_T *rettv;
9235 int noref = 0;
9237 if (argvars[1].v_type != VAR_UNKNOWN)
9238 noref = get_tv_number_chk(&argvars[1], NULL);
9239 if (noref < 0 || noref > 1)
9240 EMSG(_(e_invarg));
9241 else
9242 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? ++current_copyID : 0);
9246 * "delete()" function
9248 static void
9249 f_delete(argvars, rettv)
9250 typval_T *argvars;
9251 typval_T *rettv;
9253 if (check_restricted() || check_secure())
9254 rettv->vval.v_number = -1;
9255 else
9256 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9260 * "did_filetype()" function
9262 /*ARGSUSED*/
9263 static void
9264 f_did_filetype(argvars, rettv)
9265 typval_T *argvars;
9266 typval_T *rettv;
9268 #ifdef FEAT_AUTOCMD
9269 rettv->vval.v_number = did_filetype;
9270 #else
9271 rettv->vval.v_number = 0;
9272 #endif
9276 * "diff_filler()" function
9278 /*ARGSUSED*/
9279 static void
9280 f_diff_filler(argvars, rettv)
9281 typval_T *argvars;
9282 typval_T *rettv;
9284 #ifdef FEAT_DIFF
9285 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9286 #endif
9290 * "diff_hlID()" function
9292 /*ARGSUSED*/
9293 static void
9294 f_diff_hlID(argvars, rettv)
9295 typval_T *argvars;
9296 typval_T *rettv;
9298 #ifdef FEAT_DIFF
9299 linenr_T lnum = get_tv_lnum(argvars);
9300 static linenr_T prev_lnum = 0;
9301 static int changedtick = 0;
9302 static int fnum = 0;
9303 static int change_start = 0;
9304 static int change_end = 0;
9305 static hlf_T hlID = (hlf_T)0;
9306 int filler_lines;
9307 int col;
9309 if (lnum < 0) /* ignore type error in {lnum} arg */
9310 lnum = 0;
9311 if (lnum != prev_lnum
9312 || changedtick != curbuf->b_changedtick
9313 || fnum != curbuf->b_fnum)
9315 /* New line, buffer, change: need to get the values. */
9316 filler_lines = diff_check(curwin, lnum);
9317 if (filler_lines < 0)
9319 if (filler_lines == -1)
9321 change_start = MAXCOL;
9322 change_end = -1;
9323 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9324 hlID = HLF_ADD; /* added line */
9325 else
9326 hlID = HLF_CHD; /* changed line */
9328 else
9329 hlID = HLF_ADD; /* added line */
9331 else
9332 hlID = (hlf_T)0;
9333 prev_lnum = lnum;
9334 changedtick = curbuf->b_changedtick;
9335 fnum = curbuf->b_fnum;
9338 if (hlID == HLF_CHD || hlID == HLF_TXD)
9340 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9341 if (col >= change_start && col <= change_end)
9342 hlID = HLF_TXD; /* changed text */
9343 else
9344 hlID = HLF_CHD; /* changed line */
9346 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9347 #endif
9351 * "empty({expr})" function
9353 static void
9354 f_empty(argvars, rettv)
9355 typval_T *argvars;
9356 typval_T *rettv;
9358 int n;
9360 switch (argvars[0].v_type)
9362 case VAR_STRING:
9363 case VAR_FUNC:
9364 n = argvars[0].vval.v_string == NULL
9365 || *argvars[0].vval.v_string == NUL;
9366 break;
9367 case VAR_NUMBER:
9368 n = argvars[0].vval.v_number == 0;
9369 break;
9370 #ifdef FEAT_FLOAT
9371 case VAR_FLOAT:
9372 n = argvars[0].vval.v_float == 0.0;
9373 break;
9374 #endif
9375 case VAR_LIST:
9376 n = argvars[0].vval.v_list == NULL
9377 || argvars[0].vval.v_list->lv_first == NULL;
9378 break;
9379 case VAR_DICT:
9380 n = argvars[0].vval.v_dict == NULL
9381 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9382 break;
9383 default:
9384 EMSG2(_(e_intern2), "f_empty()");
9385 n = 0;
9388 rettv->vval.v_number = n;
9392 * "escape({string}, {chars})" function
9394 static void
9395 f_escape(argvars, rettv)
9396 typval_T *argvars;
9397 typval_T *rettv;
9399 char_u buf[NUMBUFLEN];
9401 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9402 get_tv_string_buf(&argvars[1], buf));
9403 rettv->v_type = VAR_STRING;
9407 * "eval()" function
9409 /*ARGSUSED*/
9410 static void
9411 f_eval(argvars, rettv)
9412 typval_T *argvars;
9413 typval_T *rettv;
9415 char_u *s;
9417 s = get_tv_string_chk(&argvars[0]);
9418 if (s != NULL)
9419 s = skipwhite(s);
9421 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9423 rettv->v_type = VAR_NUMBER;
9424 rettv->vval.v_number = 0;
9426 else if (*s != NUL)
9427 EMSG(_(e_trailing));
9431 * "eventhandler()" function
9433 /*ARGSUSED*/
9434 static void
9435 f_eventhandler(argvars, rettv)
9436 typval_T *argvars;
9437 typval_T *rettv;
9439 rettv->vval.v_number = vgetc_busy;
9443 * "executable()" function
9445 static void
9446 f_executable(argvars, rettv)
9447 typval_T *argvars;
9448 typval_T *rettv;
9450 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9454 * "exists()" function
9456 static void
9457 f_exists(argvars, rettv)
9458 typval_T *argvars;
9459 typval_T *rettv;
9461 char_u *p;
9462 char_u *name;
9463 int n = FALSE;
9464 int len = 0;
9466 p = get_tv_string(&argvars[0]);
9467 if (*p == '$') /* environment variable */
9469 /* first try "normal" environment variables (fast) */
9470 if (mch_getenv(p + 1) != NULL)
9471 n = TRUE;
9472 else
9474 /* try expanding things like $VIM and ${HOME} */
9475 p = expand_env_save(p);
9476 if (p != NULL && *p != '$')
9477 n = TRUE;
9478 vim_free(p);
9481 else if (*p == '&' || *p == '+') /* option */
9483 n = (get_option_tv(&p, NULL, TRUE) == OK);
9484 if (*skipwhite(p) != NUL)
9485 n = FALSE; /* trailing garbage */
9487 else if (*p == '*') /* internal or user defined function */
9489 n = function_exists(p + 1);
9491 else if (*p == ':')
9493 n = cmd_exists(p + 1);
9495 else if (*p == '#')
9497 #ifdef FEAT_AUTOCMD
9498 if (p[1] == '#')
9499 n = autocmd_supported(p + 2);
9500 else
9501 n = au_exists(p + 1);
9502 #endif
9504 else /* internal variable */
9506 char_u *tofree;
9507 typval_T tv;
9509 /* get_name_len() takes care of expanding curly braces */
9510 name = p;
9511 len = get_name_len(&p, &tofree, TRUE, FALSE);
9512 if (len > 0)
9514 if (tofree != NULL)
9515 name = tofree;
9516 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9517 if (n)
9519 /* handle d.key, l[idx], f(expr) */
9520 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9521 if (n)
9522 clear_tv(&tv);
9525 if (*p != NUL)
9526 n = FALSE;
9528 vim_free(tofree);
9531 rettv->vval.v_number = n;
9535 * "expand()" function
9537 static void
9538 f_expand(argvars, rettv)
9539 typval_T *argvars;
9540 typval_T *rettv;
9542 char_u *s;
9543 int len;
9544 char_u *errormsg;
9545 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9546 expand_T xpc;
9547 int error = FALSE;
9549 rettv->v_type = VAR_STRING;
9550 s = get_tv_string(&argvars[0]);
9551 if (*s == '%' || *s == '#' || *s == '<')
9553 ++emsg_off;
9554 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9555 --emsg_off;
9557 else
9559 /* When the optional second argument is non-zero, don't remove matches
9560 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9561 if (argvars[1].v_type != VAR_UNKNOWN
9562 && get_tv_number_chk(&argvars[1], &error))
9563 flags |= WILD_KEEP_ALL;
9564 if (!error)
9566 ExpandInit(&xpc);
9567 xpc.xp_context = EXPAND_FILES;
9568 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9570 else
9571 rettv->vval.v_string = NULL;
9576 * "extend(list, list [, idx])" function
9577 * "extend(dict, dict [, action])" function
9579 static void
9580 f_extend(argvars, rettv)
9581 typval_T *argvars;
9582 typval_T *rettv;
9584 rettv->vval.v_number = 0;
9585 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9587 list_T *l1, *l2;
9588 listitem_T *item;
9589 long before;
9590 int error = FALSE;
9592 l1 = argvars[0].vval.v_list;
9593 l2 = argvars[1].vval.v_list;
9594 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9595 && l2 != NULL)
9597 if (argvars[2].v_type != VAR_UNKNOWN)
9599 before = get_tv_number_chk(&argvars[2], &error);
9600 if (error)
9601 return; /* type error; errmsg already given */
9603 if (before == l1->lv_len)
9604 item = NULL;
9605 else
9607 item = list_find(l1, before);
9608 if (item == NULL)
9610 EMSGN(_(e_listidx), before);
9611 return;
9615 else
9616 item = NULL;
9617 list_extend(l1, l2, item);
9619 copy_tv(&argvars[0], rettv);
9622 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9624 dict_T *d1, *d2;
9625 dictitem_T *di1;
9626 char_u *action;
9627 int i;
9628 hashitem_T *hi2;
9629 int todo;
9631 d1 = argvars[0].vval.v_dict;
9632 d2 = argvars[1].vval.v_dict;
9633 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9634 && d2 != NULL)
9636 /* Check the third argument. */
9637 if (argvars[2].v_type != VAR_UNKNOWN)
9639 static char *(av[]) = {"keep", "force", "error"};
9641 action = get_tv_string_chk(&argvars[2]);
9642 if (action == NULL)
9643 return; /* type error; errmsg already given */
9644 for (i = 0; i < 3; ++i)
9645 if (STRCMP(action, av[i]) == 0)
9646 break;
9647 if (i == 3)
9649 EMSG2(_(e_invarg2), action);
9650 return;
9653 else
9654 action = (char_u *)"force";
9656 /* Go over all entries in the second dict and add them to the
9657 * first dict. */
9658 todo = (int)d2->dv_hashtab.ht_used;
9659 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9661 if (!HASHITEM_EMPTY(hi2))
9663 --todo;
9664 di1 = dict_find(d1, hi2->hi_key, -1);
9665 if (di1 == NULL)
9667 di1 = dictitem_copy(HI2DI(hi2));
9668 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9669 dictitem_free(di1);
9671 else if (*action == 'e')
9673 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9674 break;
9676 else if (*action == 'f')
9678 clear_tv(&di1->di_tv);
9679 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9684 copy_tv(&argvars[0], rettv);
9687 else
9688 EMSG2(_(e_listdictarg), "extend()");
9692 * "feedkeys()" function
9694 /*ARGSUSED*/
9695 static void
9696 f_feedkeys(argvars, rettv)
9697 typval_T *argvars;
9698 typval_T *rettv;
9700 int remap = TRUE;
9701 char_u *keys, *flags;
9702 char_u nbuf[NUMBUFLEN];
9703 int typed = FALSE;
9704 char_u *keys_esc;
9706 /* This is not allowed in the sandbox. If the commands would still be
9707 * executed in the sandbox it would be OK, but it probably happens later,
9708 * when "sandbox" is no longer set. */
9709 if (check_secure())
9710 return;
9712 rettv->vval.v_number = 0;
9713 keys = get_tv_string(&argvars[0]);
9714 if (*keys != NUL)
9716 if (argvars[1].v_type != VAR_UNKNOWN)
9718 flags = get_tv_string_buf(&argvars[1], nbuf);
9719 for ( ; *flags != NUL; ++flags)
9721 switch (*flags)
9723 case 'n': remap = FALSE; break;
9724 case 'm': remap = TRUE; break;
9725 case 't': typed = TRUE; break;
9730 /* Need to escape K_SPECIAL and CSI before putting the string in the
9731 * typeahead buffer. */
9732 keys_esc = vim_strsave_escape_csi(keys);
9733 if (keys_esc != NULL)
9735 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9736 typebuf.tb_len, !typed, FALSE);
9737 vim_free(keys_esc);
9738 if (vgetc_busy)
9739 typebuf_was_filled = TRUE;
9745 * "filereadable()" function
9747 static void
9748 f_filereadable(argvars, rettv)
9749 typval_T *argvars;
9750 typval_T *rettv;
9752 int fd;
9753 char_u *p;
9754 int n;
9756 #ifndef O_NONBLOCK
9757 # define O_NONBLOCK 0
9758 #endif
9759 p = get_tv_string(&argvars[0]);
9760 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9761 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9763 n = TRUE;
9764 close(fd);
9766 else
9767 n = FALSE;
9769 rettv->vval.v_number = n;
9773 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9774 * rights to write into.
9776 static void
9777 f_filewritable(argvars, rettv)
9778 typval_T *argvars;
9779 typval_T *rettv;
9781 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9784 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9786 static void
9787 findfilendir(argvars, rettv, find_what)
9788 typval_T *argvars;
9789 typval_T *rettv;
9790 int find_what;
9792 #ifdef FEAT_SEARCHPATH
9793 char_u *fname;
9794 char_u *fresult = NULL;
9795 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9796 char_u *p;
9797 char_u pathbuf[NUMBUFLEN];
9798 int count = 1;
9799 int first = TRUE;
9800 int error = FALSE;
9801 #endif
9803 rettv->vval.v_string = NULL;
9804 rettv->v_type = VAR_STRING;
9806 #ifdef FEAT_SEARCHPATH
9807 fname = get_tv_string(&argvars[0]);
9809 if (argvars[1].v_type != VAR_UNKNOWN)
9811 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9812 if (p == NULL)
9813 error = TRUE;
9814 else
9816 if (*p != NUL)
9817 path = p;
9819 if (argvars[2].v_type != VAR_UNKNOWN)
9820 count = get_tv_number_chk(&argvars[2], &error);
9824 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9825 error = TRUE;
9827 if (*fname != NUL && !error)
9831 if (rettv->v_type == VAR_STRING)
9832 vim_free(fresult);
9833 fresult = find_file_in_path_option(first ? fname : NULL,
9834 first ? (int)STRLEN(fname) : 0,
9835 0, first, path,
9836 find_what,
9837 curbuf->b_ffname,
9838 find_what == FINDFILE_DIR
9839 ? (char_u *)"" : curbuf->b_p_sua);
9840 first = FALSE;
9842 if (fresult != NULL && rettv->v_type == VAR_LIST)
9843 list_append_string(rettv->vval.v_list, fresult, -1);
9845 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9848 if (rettv->v_type == VAR_STRING)
9849 rettv->vval.v_string = fresult;
9850 #endif
9853 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9854 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9857 * Implementation of map() and filter().
9859 static void
9860 filter_map(argvars, rettv, map)
9861 typval_T *argvars;
9862 typval_T *rettv;
9863 int map;
9865 char_u buf[NUMBUFLEN];
9866 char_u *expr;
9867 listitem_T *li, *nli;
9868 list_T *l = NULL;
9869 dictitem_T *di;
9870 hashtab_T *ht;
9871 hashitem_T *hi;
9872 dict_T *d = NULL;
9873 typval_T save_val;
9874 typval_T save_key;
9875 int rem;
9876 int todo;
9877 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9878 int save_did_emsg;
9880 rettv->vval.v_number = 0;
9881 if (argvars[0].v_type == VAR_LIST)
9883 if ((l = argvars[0].vval.v_list) == NULL
9884 || (map && tv_check_lock(l->lv_lock, ermsg)))
9885 return;
9887 else if (argvars[0].v_type == VAR_DICT)
9889 if ((d = argvars[0].vval.v_dict) == NULL
9890 || (map && tv_check_lock(d->dv_lock, ermsg)))
9891 return;
9893 else
9895 EMSG2(_(e_listdictarg), ermsg);
9896 return;
9899 expr = get_tv_string_buf_chk(&argvars[1], buf);
9900 /* On type errors, the preceding call has already displayed an error
9901 * message. Avoid a misleading error message for an empty string that
9902 * was not passed as argument. */
9903 if (expr != NULL)
9905 prepare_vimvar(VV_VAL, &save_val);
9906 expr = skipwhite(expr);
9908 /* We reset "did_emsg" to be able to detect whether an error
9909 * occurred during evaluation of the expression. */
9910 save_did_emsg = did_emsg;
9911 did_emsg = FALSE;
9913 if (argvars[0].v_type == VAR_DICT)
9915 prepare_vimvar(VV_KEY, &save_key);
9916 vimvars[VV_KEY].vv_type = VAR_STRING;
9918 ht = &d->dv_hashtab;
9919 hash_lock(ht);
9920 todo = (int)ht->ht_used;
9921 for (hi = ht->ht_array; todo > 0; ++hi)
9923 if (!HASHITEM_EMPTY(hi))
9925 --todo;
9926 di = HI2DI(hi);
9927 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9928 break;
9929 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9930 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9931 || did_emsg)
9932 break;
9933 if (!map && rem)
9934 dictitem_remove(d, di);
9935 clear_tv(&vimvars[VV_KEY].vv_tv);
9938 hash_unlock(ht);
9940 restore_vimvar(VV_KEY, &save_key);
9942 else
9944 for (li = l->lv_first; li != NULL; li = nli)
9946 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9947 break;
9948 nli = li->li_next;
9949 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9950 || did_emsg)
9951 break;
9952 if (!map && rem)
9953 listitem_remove(l, li);
9957 restore_vimvar(VV_VAL, &save_val);
9959 did_emsg |= save_did_emsg;
9962 copy_tv(&argvars[0], rettv);
9965 static int
9966 filter_map_one(tv, expr, map, remp)
9967 typval_T *tv;
9968 char_u *expr;
9969 int map;
9970 int *remp;
9972 typval_T rettv;
9973 char_u *s;
9974 int retval = FAIL;
9976 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
9977 s = expr;
9978 if (eval1(&s, &rettv, TRUE) == FAIL)
9979 goto theend;
9980 if (*s != NUL) /* check for trailing chars after expr */
9982 EMSG2(_(e_invexpr2), s);
9983 goto theend;
9985 if (map)
9987 /* map(): replace the list item value */
9988 clear_tv(tv);
9989 rettv.v_lock = 0;
9990 *tv = rettv;
9992 else
9994 int error = FALSE;
9996 /* filter(): when expr is zero remove the item */
9997 *remp = (get_tv_number_chk(&rettv, &error) == 0);
9998 clear_tv(&rettv);
9999 /* On type error, nothing has been removed; return FAIL to stop the
10000 * loop. The error message was given by get_tv_number_chk(). */
10001 if (error)
10002 goto theend;
10004 retval = OK;
10005 theend:
10006 clear_tv(&vimvars[VV_VAL].vv_tv);
10007 return retval;
10011 * "filter()" function
10013 static void
10014 f_filter(argvars, rettv)
10015 typval_T *argvars;
10016 typval_T *rettv;
10018 filter_map(argvars, rettv, FALSE);
10022 * "finddir({fname}[, {path}[, {count}]])" function
10024 static void
10025 f_finddir(argvars, rettv)
10026 typval_T *argvars;
10027 typval_T *rettv;
10029 findfilendir(argvars, rettv, FINDFILE_DIR);
10033 * "findfile({fname}[, {path}[, {count}]])" function
10035 static void
10036 f_findfile(argvars, rettv)
10037 typval_T *argvars;
10038 typval_T *rettv;
10040 findfilendir(argvars, rettv, FINDFILE_FILE);
10043 #ifdef FEAT_FLOAT
10045 * "float2nr({float})" function
10047 static void
10048 f_float2nr(argvars, rettv)
10049 typval_T *argvars;
10050 typval_T *rettv;
10052 float_T f;
10054 if (get_float_arg(argvars, &f) == OK)
10056 if (f < -0x7fffffff)
10057 rettv->vval.v_number = -0x7fffffff;
10058 else if (f > 0x7fffffff)
10059 rettv->vval.v_number = 0x7fffffff;
10060 else
10061 rettv->vval.v_number = (varnumber_T)f;
10063 else
10064 rettv->vval.v_number = 0;
10068 * "floor({float})" function
10070 static void
10071 f_floor(argvars, rettv)
10072 typval_T *argvars;
10073 typval_T *rettv;
10075 float_T f;
10077 rettv->v_type = VAR_FLOAT;
10078 if (get_float_arg(argvars, &f) == OK)
10079 rettv->vval.v_float = floor(f);
10080 else
10081 rettv->vval.v_float = 0.0;
10083 #endif
10086 * "fnameescape({string})" function
10088 static void
10089 f_fnameescape(argvars, rettv)
10090 typval_T *argvars;
10091 typval_T *rettv;
10093 rettv->vval.v_string = vim_strsave_fnameescape(
10094 get_tv_string(&argvars[0]), FALSE);
10095 rettv->v_type = VAR_STRING;
10099 * "fnamemodify({fname}, {mods})" function
10101 static void
10102 f_fnamemodify(argvars, rettv)
10103 typval_T *argvars;
10104 typval_T *rettv;
10106 char_u *fname;
10107 char_u *mods;
10108 int usedlen = 0;
10109 int len;
10110 char_u *fbuf = NULL;
10111 char_u buf[NUMBUFLEN];
10113 fname = get_tv_string_chk(&argvars[0]);
10114 mods = get_tv_string_buf_chk(&argvars[1], buf);
10115 if (fname == NULL || mods == NULL)
10116 fname = NULL;
10117 else
10119 len = (int)STRLEN(fname);
10120 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10123 rettv->v_type = VAR_STRING;
10124 if (fname == NULL)
10125 rettv->vval.v_string = NULL;
10126 else
10127 rettv->vval.v_string = vim_strnsave(fname, len);
10128 vim_free(fbuf);
10131 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10134 * "foldclosed()" function
10136 static void
10137 foldclosed_both(argvars, rettv, end)
10138 typval_T *argvars;
10139 typval_T *rettv;
10140 int end;
10142 #ifdef FEAT_FOLDING
10143 linenr_T lnum;
10144 linenr_T first, last;
10146 lnum = get_tv_lnum(argvars);
10147 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10149 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10151 if (end)
10152 rettv->vval.v_number = (varnumber_T)last;
10153 else
10154 rettv->vval.v_number = (varnumber_T)first;
10155 return;
10158 #endif
10159 rettv->vval.v_number = -1;
10163 * "foldclosed()" function
10165 static void
10166 f_foldclosed(argvars, rettv)
10167 typval_T *argvars;
10168 typval_T *rettv;
10170 foldclosed_both(argvars, rettv, FALSE);
10174 * "foldclosedend()" function
10176 static void
10177 f_foldclosedend(argvars, rettv)
10178 typval_T *argvars;
10179 typval_T *rettv;
10181 foldclosed_both(argvars, rettv, TRUE);
10185 * "foldlevel()" function
10187 static void
10188 f_foldlevel(argvars, rettv)
10189 typval_T *argvars;
10190 typval_T *rettv;
10192 #ifdef FEAT_FOLDING
10193 linenr_T lnum;
10195 lnum = get_tv_lnum(argvars);
10196 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10197 rettv->vval.v_number = foldLevel(lnum);
10198 else
10199 #endif
10200 rettv->vval.v_number = 0;
10204 * "foldtext()" function
10206 /*ARGSUSED*/
10207 static void
10208 f_foldtext(argvars, rettv)
10209 typval_T *argvars;
10210 typval_T *rettv;
10212 #ifdef FEAT_FOLDING
10213 linenr_T lnum;
10214 char_u *s;
10215 char_u *r;
10216 int len;
10217 char *txt;
10218 #endif
10220 rettv->v_type = VAR_STRING;
10221 rettv->vval.v_string = NULL;
10222 #ifdef FEAT_FOLDING
10223 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10224 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10225 <= curbuf->b_ml.ml_line_count
10226 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10228 /* Find first non-empty line in the fold. */
10229 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10230 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10232 if (!linewhite(lnum))
10233 break;
10234 ++lnum;
10237 /* Find interesting text in this line. */
10238 s = skipwhite(ml_get(lnum));
10239 /* skip C comment-start */
10240 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10242 s = skipwhite(s + 2);
10243 if (*skipwhite(s) == NUL
10244 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10246 s = skipwhite(ml_get(lnum + 1));
10247 if (*s == '*')
10248 s = skipwhite(s + 1);
10251 txt = _("+-%s%3ld lines: ");
10252 r = alloc((unsigned)(STRLEN(txt)
10253 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10254 + 20 /* for %3ld */
10255 + STRLEN(s))); /* concatenated */
10256 if (r != NULL)
10258 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10259 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10260 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10261 len = (int)STRLEN(r);
10262 STRCAT(r, s);
10263 /* remove 'foldmarker' and 'commentstring' */
10264 foldtext_cleanup(r + len);
10265 rettv->vval.v_string = r;
10268 #endif
10272 * "foldtextresult(lnum)" function
10274 /*ARGSUSED*/
10275 static void
10276 f_foldtextresult(argvars, rettv)
10277 typval_T *argvars;
10278 typval_T *rettv;
10280 #ifdef FEAT_FOLDING
10281 linenr_T lnum;
10282 char_u *text;
10283 char_u buf[51];
10284 foldinfo_T foldinfo;
10285 int fold_count;
10286 #endif
10288 rettv->v_type = VAR_STRING;
10289 rettv->vval.v_string = NULL;
10290 #ifdef FEAT_FOLDING
10291 lnum = get_tv_lnum(argvars);
10292 /* treat illegal types and illegal string values for {lnum} the same */
10293 if (lnum < 0)
10294 lnum = 0;
10295 fold_count = foldedCount(curwin, lnum, &foldinfo);
10296 if (fold_count > 0)
10298 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10299 &foldinfo, buf);
10300 if (text == buf)
10301 text = vim_strsave(text);
10302 rettv->vval.v_string = text;
10304 #endif
10308 * "foreground()" function
10310 /*ARGSUSED*/
10311 static void
10312 f_foreground(argvars, rettv)
10313 typval_T *argvars;
10314 typval_T *rettv;
10316 rettv->vval.v_number = 0;
10317 #ifdef FEAT_GUI
10318 if (gui.in_use)
10319 gui_mch_set_foreground();
10320 #else
10321 # ifdef WIN32
10322 win32_set_foreground();
10323 # endif
10324 #endif
10328 * "function()" function
10330 /*ARGSUSED*/
10331 static void
10332 f_function(argvars, rettv)
10333 typval_T *argvars;
10334 typval_T *rettv;
10336 char_u *s;
10338 rettv->vval.v_number = 0;
10339 s = get_tv_string(&argvars[0]);
10340 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10341 EMSG2(_(e_invarg2), s);
10342 /* Don't check an autoload name for existence here. */
10343 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10344 EMSG2(_("E700: Unknown function: %s"), s);
10345 else
10347 rettv->vval.v_string = vim_strsave(s);
10348 rettv->v_type = VAR_FUNC;
10353 * "garbagecollect()" function
10355 /*ARGSUSED*/
10356 static void
10357 f_garbagecollect(argvars, rettv)
10358 typval_T *argvars;
10359 typval_T *rettv;
10361 /* This is postponed until we are back at the toplevel, because we may be
10362 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10363 want_garbage_collect = TRUE;
10365 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10366 garbage_collect_at_exit = TRUE;
10370 * "get()" function
10372 static void
10373 f_get(argvars, rettv)
10374 typval_T *argvars;
10375 typval_T *rettv;
10377 listitem_T *li;
10378 list_T *l;
10379 dictitem_T *di;
10380 dict_T *d;
10381 typval_T *tv = NULL;
10383 if (argvars[0].v_type == VAR_LIST)
10385 if ((l = argvars[0].vval.v_list) != NULL)
10387 int error = FALSE;
10389 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10390 if (!error && li != NULL)
10391 tv = &li->li_tv;
10394 else if (argvars[0].v_type == VAR_DICT)
10396 if ((d = argvars[0].vval.v_dict) != NULL)
10398 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10399 if (di != NULL)
10400 tv = &di->di_tv;
10403 else
10404 EMSG2(_(e_listdictarg), "get()");
10406 if (tv == NULL)
10408 if (argvars[2].v_type == VAR_UNKNOWN)
10409 rettv->vval.v_number = 0;
10410 else
10411 copy_tv(&argvars[2], rettv);
10413 else
10414 copy_tv(tv, rettv);
10417 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10420 * Get line or list of lines from buffer "buf" into "rettv".
10421 * Return a range (from start to end) of lines in rettv from the specified
10422 * buffer.
10423 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10425 static void
10426 get_buffer_lines(buf, start, end, retlist, rettv)
10427 buf_T *buf;
10428 linenr_T start;
10429 linenr_T end;
10430 int retlist;
10431 typval_T *rettv;
10433 char_u *p;
10435 if (retlist)
10437 if (rettv_list_alloc(rettv) == FAIL)
10438 return;
10440 else
10441 rettv->vval.v_number = 0;
10443 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10444 return;
10446 if (!retlist)
10448 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10449 p = ml_get_buf(buf, start, FALSE);
10450 else
10451 p = (char_u *)"";
10453 rettv->v_type = VAR_STRING;
10454 rettv->vval.v_string = vim_strsave(p);
10456 else
10458 if (end < start)
10459 return;
10461 if (start < 1)
10462 start = 1;
10463 if (end > buf->b_ml.ml_line_count)
10464 end = buf->b_ml.ml_line_count;
10465 while (start <= end)
10466 if (list_append_string(rettv->vval.v_list,
10467 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10468 break;
10473 * "getbufline()" function
10475 static void
10476 f_getbufline(argvars, rettv)
10477 typval_T *argvars;
10478 typval_T *rettv;
10480 linenr_T lnum;
10481 linenr_T end;
10482 buf_T *buf;
10484 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10485 ++emsg_off;
10486 buf = get_buf_tv(&argvars[0]);
10487 --emsg_off;
10489 lnum = get_tv_lnum_buf(&argvars[1], buf);
10490 if (argvars[2].v_type == VAR_UNKNOWN)
10491 end = lnum;
10492 else
10493 end = get_tv_lnum_buf(&argvars[2], buf);
10495 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10499 * "getbufvar()" function
10501 static void
10502 f_getbufvar(argvars, rettv)
10503 typval_T *argvars;
10504 typval_T *rettv;
10506 buf_T *buf;
10507 buf_T *save_curbuf;
10508 char_u *varname;
10509 dictitem_T *v;
10511 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10512 varname = get_tv_string_chk(&argvars[1]);
10513 ++emsg_off;
10514 buf = get_buf_tv(&argvars[0]);
10516 rettv->v_type = VAR_STRING;
10517 rettv->vval.v_string = NULL;
10519 if (buf != NULL && varname != NULL)
10521 /* set curbuf to be our buf, temporarily */
10522 save_curbuf = curbuf;
10523 curbuf = buf;
10525 if (*varname == '&') /* buffer-local-option */
10526 get_option_tv(&varname, rettv, TRUE);
10527 else
10529 if (*varname == NUL)
10530 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10531 * scope prefix before the NUL byte is required by
10532 * find_var_in_ht(). */
10533 varname = (char_u *)"b:" + 2;
10534 /* look up the variable */
10535 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10536 if (v != NULL)
10537 copy_tv(&v->di_tv, rettv);
10540 /* restore previous notion of curbuf */
10541 curbuf = save_curbuf;
10544 --emsg_off;
10548 * "getchar()" function
10550 static void
10551 f_getchar(argvars, rettv)
10552 typval_T *argvars;
10553 typval_T *rettv;
10555 varnumber_T n;
10556 int error = FALSE;
10558 /* Position the cursor. Needed after a message that ends in a space. */
10559 windgoto(msg_row, msg_col);
10561 ++no_mapping;
10562 ++allow_keys;
10563 for (;;)
10565 if (argvars[0].v_type == VAR_UNKNOWN)
10566 /* getchar(): blocking wait. */
10567 n = safe_vgetc();
10568 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10569 /* getchar(1): only check if char avail */
10570 n = vpeekc();
10571 else if (error || vpeekc() == NUL)
10572 /* illegal argument or getchar(0) and no char avail: return zero */
10573 n = 0;
10574 else
10575 /* getchar(0) and char avail: return char */
10576 n = safe_vgetc();
10577 if (n == K_IGNORE)
10578 continue;
10579 break;
10581 --no_mapping;
10582 --allow_keys;
10584 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10585 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10586 vimvars[VV_MOUSE_COL].vv_nr = 0;
10588 rettv->vval.v_number = n;
10589 if (IS_SPECIAL(n) || mod_mask != 0)
10591 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10592 int i = 0;
10594 /* Turn a special key into three bytes, plus modifier. */
10595 if (mod_mask != 0)
10597 temp[i++] = K_SPECIAL;
10598 temp[i++] = KS_MODIFIER;
10599 temp[i++] = mod_mask;
10601 if (IS_SPECIAL(n))
10603 temp[i++] = K_SPECIAL;
10604 temp[i++] = K_SECOND(n);
10605 temp[i++] = K_THIRD(n);
10607 #ifdef FEAT_MBYTE
10608 else if (has_mbyte)
10609 i += (*mb_char2bytes)(n, temp + i);
10610 #endif
10611 else
10612 temp[i++] = n;
10613 temp[i++] = NUL;
10614 rettv->v_type = VAR_STRING;
10615 rettv->vval.v_string = vim_strsave(temp);
10617 #ifdef FEAT_MOUSE
10618 if (n == K_LEFTMOUSE
10619 || n == K_LEFTMOUSE_NM
10620 || n == K_LEFTDRAG
10621 || n == K_LEFTRELEASE
10622 || n == K_LEFTRELEASE_NM
10623 || n == K_MIDDLEMOUSE
10624 || n == K_MIDDLEDRAG
10625 || n == K_MIDDLERELEASE
10626 || n == K_RIGHTMOUSE
10627 || n == K_RIGHTDRAG
10628 || n == K_RIGHTRELEASE
10629 || n == K_X1MOUSE
10630 || n == K_X1DRAG
10631 || n == K_X1RELEASE
10632 || n == K_X2MOUSE
10633 || n == K_X2DRAG
10634 || n == K_X2RELEASE
10635 || n == K_MOUSEDOWN
10636 || n == K_MOUSEUP)
10638 int row = mouse_row;
10639 int col = mouse_col;
10640 win_T *win;
10641 linenr_T lnum;
10642 # ifdef FEAT_WINDOWS
10643 win_T *wp;
10644 # endif
10645 int winnr = 1;
10647 if (row >= 0 && col >= 0)
10649 /* Find the window at the mouse coordinates and compute the
10650 * text position. */
10651 win = mouse_find_win(&row, &col);
10652 (void)mouse_comp_pos(win, &row, &col, &lnum);
10653 # ifdef FEAT_WINDOWS
10654 for (wp = firstwin; wp != win; wp = wp->w_next)
10655 ++winnr;
10656 # endif
10657 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10658 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10659 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10662 #endif
10667 * "getcharmod()" function
10669 /*ARGSUSED*/
10670 static void
10671 f_getcharmod(argvars, rettv)
10672 typval_T *argvars;
10673 typval_T *rettv;
10675 rettv->vval.v_number = mod_mask;
10679 * "getcmdline()" function
10681 /*ARGSUSED*/
10682 static void
10683 f_getcmdline(argvars, rettv)
10684 typval_T *argvars;
10685 typval_T *rettv;
10687 rettv->v_type = VAR_STRING;
10688 rettv->vval.v_string = get_cmdline_str();
10692 * "getcmdpos()" function
10694 /*ARGSUSED*/
10695 static void
10696 f_getcmdpos(argvars, rettv)
10697 typval_T *argvars;
10698 typval_T *rettv;
10700 rettv->vval.v_number = get_cmdline_pos() + 1;
10704 * "getcmdtype()" function
10706 /*ARGSUSED*/
10707 static void
10708 f_getcmdtype(argvars, rettv)
10709 typval_T *argvars;
10710 typval_T *rettv;
10712 rettv->v_type = VAR_STRING;
10713 rettv->vval.v_string = alloc(2);
10714 if (rettv->vval.v_string != NULL)
10716 rettv->vval.v_string[0] = get_cmdline_type();
10717 rettv->vval.v_string[1] = NUL;
10722 * "getcwd()" function
10724 /*ARGSUSED*/
10725 static void
10726 f_getcwd(argvars, rettv)
10727 typval_T *argvars;
10728 typval_T *rettv;
10730 char_u cwd[MAXPATHL];
10732 rettv->v_type = VAR_STRING;
10733 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10734 rettv->vval.v_string = NULL;
10735 else
10737 rettv->vval.v_string = vim_strsave(cwd);
10738 #ifdef BACKSLASH_IN_FILENAME
10739 if (rettv->vval.v_string != NULL)
10740 slash_adjust(rettv->vval.v_string);
10741 #endif
10746 * "getfontname()" function
10748 /*ARGSUSED*/
10749 static void
10750 f_getfontname(argvars, rettv)
10751 typval_T *argvars;
10752 typval_T *rettv;
10754 rettv->v_type = VAR_STRING;
10755 rettv->vval.v_string = NULL;
10756 #ifdef FEAT_GUI
10757 if (gui.in_use)
10759 GuiFont font;
10760 char_u *name = NULL;
10762 if (argvars[0].v_type == VAR_UNKNOWN)
10764 /* Get the "Normal" font. Either the name saved by
10765 * hl_set_font_name() or from the font ID. */
10766 font = gui.norm_font;
10767 name = hl_get_font_name();
10769 else
10771 name = get_tv_string(&argvars[0]);
10772 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10773 return;
10774 font = gui_mch_get_font(name, FALSE);
10775 if (font == NOFONT)
10776 return; /* Invalid font name, return empty string. */
10778 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10779 if (argvars[0].v_type != VAR_UNKNOWN)
10780 gui_mch_free_font(font);
10782 #endif
10786 * "getfperm({fname})" function
10788 static void
10789 f_getfperm(argvars, rettv)
10790 typval_T *argvars;
10791 typval_T *rettv;
10793 char_u *fname;
10794 struct stat st;
10795 char_u *perm = NULL;
10796 char_u flags[] = "rwx";
10797 int i;
10799 fname = get_tv_string(&argvars[0]);
10801 rettv->v_type = VAR_STRING;
10802 if (mch_stat((char *)fname, &st) >= 0)
10804 perm = vim_strsave((char_u *)"---------");
10805 if (perm != NULL)
10807 for (i = 0; i < 9; i++)
10809 if (st.st_mode & (1 << (8 - i)))
10810 perm[i] = flags[i % 3];
10814 rettv->vval.v_string = perm;
10818 * "getfsize({fname})" function
10820 static void
10821 f_getfsize(argvars, rettv)
10822 typval_T *argvars;
10823 typval_T *rettv;
10825 char_u *fname;
10826 struct stat st;
10828 fname = get_tv_string(&argvars[0]);
10830 rettv->v_type = VAR_NUMBER;
10832 if (mch_stat((char *)fname, &st) >= 0)
10834 if (mch_isdir(fname))
10835 rettv->vval.v_number = 0;
10836 else
10838 rettv->vval.v_number = (varnumber_T)st.st_size;
10840 /* non-perfect check for overflow */
10841 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10842 rettv->vval.v_number = -2;
10845 else
10846 rettv->vval.v_number = -1;
10850 * "getftime({fname})" function
10852 static void
10853 f_getftime(argvars, rettv)
10854 typval_T *argvars;
10855 typval_T *rettv;
10857 char_u *fname;
10858 struct stat st;
10860 fname = get_tv_string(&argvars[0]);
10862 if (mch_stat((char *)fname, &st) >= 0)
10863 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10864 else
10865 rettv->vval.v_number = -1;
10869 * "getftype({fname})" function
10871 static void
10872 f_getftype(argvars, rettv)
10873 typval_T *argvars;
10874 typval_T *rettv;
10876 char_u *fname;
10877 struct stat st;
10878 char_u *type = NULL;
10879 char *t;
10881 fname = get_tv_string(&argvars[0]);
10883 rettv->v_type = VAR_STRING;
10884 if (mch_lstat((char *)fname, &st) >= 0)
10886 #ifdef S_ISREG
10887 if (S_ISREG(st.st_mode))
10888 t = "file";
10889 else if (S_ISDIR(st.st_mode))
10890 t = "dir";
10891 # ifdef S_ISLNK
10892 else if (S_ISLNK(st.st_mode))
10893 t = "link";
10894 # endif
10895 # ifdef S_ISBLK
10896 else if (S_ISBLK(st.st_mode))
10897 t = "bdev";
10898 # endif
10899 # ifdef S_ISCHR
10900 else if (S_ISCHR(st.st_mode))
10901 t = "cdev";
10902 # endif
10903 # ifdef S_ISFIFO
10904 else if (S_ISFIFO(st.st_mode))
10905 t = "fifo";
10906 # endif
10907 # ifdef S_ISSOCK
10908 else if (S_ISSOCK(st.st_mode))
10909 t = "fifo";
10910 # endif
10911 else
10912 t = "other";
10913 #else
10914 # ifdef S_IFMT
10915 switch (st.st_mode & S_IFMT)
10917 case S_IFREG: t = "file"; break;
10918 case S_IFDIR: t = "dir"; break;
10919 # ifdef S_IFLNK
10920 case S_IFLNK: t = "link"; break;
10921 # endif
10922 # ifdef S_IFBLK
10923 case S_IFBLK: t = "bdev"; break;
10924 # endif
10925 # ifdef S_IFCHR
10926 case S_IFCHR: t = "cdev"; break;
10927 # endif
10928 # ifdef S_IFIFO
10929 case S_IFIFO: t = "fifo"; break;
10930 # endif
10931 # ifdef S_IFSOCK
10932 case S_IFSOCK: t = "socket"; break;
10933 # endif
10934 default: t = "other";
10936 # else
10937 if (mch_isdir(fname))
10938 t = "dir";
10939 else
10940 t = "file";
10941 # endif
10942 #endif
10943 type = vim_strsave((char_u *)t);
10945 rettv->vval.v_string = type;
10949 * "getline(lnum, [end])" function
10951 static void
10952 f_getline(argvars, rettv)
10953 typval_T *argvars;
10954 typval_T *rettv;
10956 linenr_T lnum;
10957 linenr_T end;
10958 int retlist;
10960 lnum = get_tv_lnum(argvars);
10961 if (argvars[1].v_type == VAR_UNKNOWN)
10963 end = 0;
10964 retlist = FALSE;
10966 else
10968 end = get_tv_lnum(&argvars[1]);
10969 retlist = TRUE;
10972 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10976 * "getmatches()" function
10978 /*ARGSUSED*/
10979 static void
10980 f_getmatches(argvars, rettv)
10981 typval_T *argvars;
10982 typval_T *rettv;
10984 #ifdef FEAT_SEARCH_EXTRA
10985 dict_T *dict;
10986 matchitem_T *cur = curwin->w_match_head;
10988 rettv->vval.v_number = 0;
10990 if (rettv_list_alloc(rettv) == OK)
10992 while (cur != NULL)
10994 dict = dict_alloc();
10995 if (dict == NULL)
10996 return;
10997 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
10998 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
10999 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11000 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11001 list_append_dict(rettv->vval.v_list, dict);
11002 cur = cur->next;
11005 #endif
11009 * "getpid()" function
11011 /*ARGSUSED*/
11012 static void
11013 f_getpid(argvars, rettv)
11014 typval_T *argvars;
11015 typval_T *rettv;
11017 rettv->vval.v_number = mch_get_pid();
11021 * "getpos(string)" function
11023 static void
11024 f_getpos(argvars, rettv)
11025 typval_T *argvars;
11026 typval_T *rettv;
11028 pos_T *fp;
11029 list_T *l;
11030 int fnum = -1;
11032 if (rettv_list_alloc(rettv) == OK)
11034 l = rettv->vval.v_list;
11035 fp = var2fpos(&argvars[0], TRUE, &fnum);
11036 if (fnum != -1)
11037 list_append_number(l, (varnumber_T)fnum);
11038 else
11039 list_append_number(l, (varnumber_T)0);
11040 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11041 : (varnumber_T)0);
11042 list_append_number(l, (fp != NULL)
11043 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11044 : (varnumber_T)0);
11045 list_append_number(l,
11046 #ifdef FEAT_VIRTUALEDIT
11047 (fp != NULL) ? (varnumber_T)fp->coladd :
11048 #endif
11049 (varnumber_T)0);
11051 else
11052 rettv->vval.v_number = FALSE;
11056 * "getqflist()" and "getloclist()" functions
11058 /*ARGSUSED*/
11059 static void
11060 f_getqflist(argvars, rettv)
11061 typval_T *argvars;
11062 typval_T *rettv;
11064 #ifdef FEAT_QUICKFIX
11065 win_T *wp;
11066 #endif
11068 rettv->vval.v_number = 0;
11069 #ifdef FEAT_QUICKFIX
11070 if (rettv_list_alloc(rettv) == OK)
11072 wp = NULL;
11073 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11075 wp = find_win_by_nr(&argvars[0], NULL);
11076 if (wp == NULL)
11077 return;
11080 (void)get_errorlist(wp, rettv->vval.v_list);
11082 #endif
11086 * "getreg()" function
11088 static void
11089 f_getreg(argvars, rettv)
11090 typval_T *argvars;
11091 typval_T *rettv;
11093 char_u *strregname;
11094 int regname;
11095 int arg2 = FALSE;
11096 int error = FALSE;
11098 if (argvars[0].v_type != VAR_UNKNOWN)
11100 strregname = get_tv_string_chk(&argvars[0]);
11101 error = strregname == NULL;
11102 if (argvars[1].v_type != VAR_UNKNOWN)
11103 arg2 = get_tv_number_chk(&argvars[1], &error);
11105 else
11106 strregname = vimvars[VV_REG].vv_str;
11107 regname = (strregname == NULL ? '"' : *strregname);
11108 if (regname == 0)
11109 regname = '"';
11111 rettv->v_type = VAR_STRING;
11112 rettv->vval.v_string = error ? NULL :
11113 get_reg_contents(regname, TRUE, arg2);
11117 * "getregtype()" function
11119 static void
11120 f_getregtype(argvars, rettv)
11121 typval_T *argvars;
11122 typval_T *rettv;
11124 char_u *strregname;
11125 int regname;
11126 char_u buf[NUMBUFLEN + 2];
11127 long reglen = 0;
11129 if (argvars[0].v_type != VAR_UNKNOWN)
11131 strregname = get_tv_string_chk(&argvars[0]);
11132 if (strregname == NULL) /* type error; errmsg already given */
11134 rettv->v_type = VAR_STRING;
11135 rettv->vval.v_string = NULL;
11136 return;
11139 else
11140 /* Default to v:register */
11141 strregname = vimvars[VV_REG].vv_str;
11143 regname = (strregname == NULL ? '"' : *strregname);
11144 if (regname == 0)
11145 regname = '"';
11147 buf[0] = NUL;
11148 buf[1] = NUL;
11149 switch (get_reg_type(regname, &reglen))
11151 case MLINE: buf[0] = 'V'; break;
11152 case MCHAR: buf[0] = 'v'; break;
11153 #ifdef FEAT_VISUAL
11154 case MBLOCK:
11155 buf[0] = Ctrl_V;
11156 sprintf((char *)buf + 1, "%ld", reglen + 1);
11157 break;
11158 #endif
11160 rettv->v_type = VAR_STRING;
11161 rettv->vval.v_string = vim_strsave(buf);
11165 * "gettabwinvar()" function
11167 static void
11168 f_gettabwinvar(argvars, rettv)
11169 typval_T *argvars;
11170 typval_T *rettv;
11172 getwinvar(argvars, rettv, 1);
11176 * "getwinposx()" function
11178 /*ARGSUSED*/
11179 static void
11180 f_getwinposx(argvars, rettv)
11181 typval_T *argvars;
11182 typval_T *rettv;
11184 rettv->vval.v_number = -1;
11185 #ifdef FEAT_GUI
11186 if (gui.in_use)
11188 int x, y;
11190 if (gui_mch_get_winpos(&x, &y) == OK)
11191 rettv->vval.v_number = x;
11193 #endif
11197 * "getwinposy()" function
11199 /*ARGSUSED*/
11200 static void
11201 f_getwinposy(argvars, rettv)
11202 typval_T *argvars;
11203 typval_T *rettv;
11205 rettv->vval.v_number = -1;
11206 #ifdef FEAT_GUI
11207 if (gui.in_use)
11209 int x, y;
11211 if (gui_mch_get_winpos(&x, &y) == OK)
11212 rettv->vval.v_number = y;
11214 #endif
11218 * Find window specified by "vp" in tabpage "tp".
11220 static win_T *
11221 find_win_by_nr(vp, tp)
11222 typval_T *vp;
11223 tabpage_T *tp; /* NULL for current tab page */
11225 #ifdef FEAT_WINDOWS
11226 win_T *wp;
11227 #endif
11228 int nr;
11230 nr = get_tv_number_chk(vp, NULL);
11232 #ifdef FEAT_WINDOWS
11233 if (nr < 0)
11234 return NULL;
11235 if (nr == 0)
11236 return curwin;
11238 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11239 wp != NULL; wp = wp->w_next)
11240 if (--nr <= 0)
11241 break;
11242 return wp;
11243 #else
11244 if (nr == 0 || nr == 1)
11245 return curwin;
11246 return NULL;
11247 #endif
11251 * "getwinvar()" function
11253 static void
11254 f_getwinvar(argvars, rettv)
11255 typval_T *argvars;
11256 typval_T *rettv;
11258 getwinvar(argvars, rettv, 0);
11262 * getwinvar() and gettabwinvar()
11264 static void
11265 getwinvar(argvars, rettv, off)
11266 typval_T *argvars;
11267 typval_T *rettv;
11268 int off; /* 1 for gettabwinvar() */
11270 win_T *win, *oldcurwin;
11271 char_u *varname;
11272 dictitem_T *v;
11273 tabpage_T *tp;
11275 #ifdef FEAT_WINDOWS
11276 if (off == 1)
11277 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11278 else
11279 tp = curtab;
11280 #endif
11281 win = find_win_by_nr(&argvars[off], tp);
11282 varname = get_tv_string_chk(&argvars[off + 1]);
11283 ++emsg_off;
11285 rettv->v_type = VAR_STRING;
11286 rettv->vval.v_string = NULL;
11288 if (win != NULL && varname != NULL)
11290 /* Set curwin to be our win, temporarily. Also set curbuf, so
11291 * that we can get buffer-local options. */
11292 oldcurwin = curwin;
11293 curwin = win;
11294 curbuf = win->w_buffer;
11296 if (*varname == '&') /* window-local-option */
11297 get_option_tv(&varname, rettv, 1);
11298 else
11300 if (*varname == NUL)
11301 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11302 * scope prefix before the NUL byte is required by
11303 * find_var_in_ht(). */
11304 varname = (char_u *)"w:" + 2;
11305 /* look up the variable */
11306 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11307 if (v != NULL)
11308 copy_tv(&v->di_tv, rettv);
11311 /* restore previous notion of curwin */
11312 curwin = oldcurwin;
11313 curbuf = curwin->w_buffer;
11316 --emsg_off;
11320 * "glob()" function
11322 static void
11323 f_glob(argvars, rettv)
11324 typval_T *argvars;
11325 typval_T *rettv;
11327 int flags = WILD_SILENT|WILD_USE_NL;
11328 expand_T xpc;
11329 int error = FALSE;
11331 /* When the optional second argument is non-zero, don't remove matches
11332 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11333 if (argvars[1].v_type != VAR_UNKNOWN
11334 && get_tv_number_chk(&argvars[1], &error))
11335 flags |= WILD_KEEP_ALL;
11336 rettv->v_type = VAR_STRING;
11337 if (!error)
11339 ExpandInit(&xpc);
11340 xpc.xp_context = EXPAND_FILES;
11341 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11342 NULL, flags, WILD_ALL);
11344 else
11345 rettv->vval.v_string = NULL;
11349 * "globpath()" function
11351 static void
11352 f_globpath(argvars, rettv)
11353 typval_T *argvars;
11354 typval_T *rettv;
11356 int flags = 0;
11357 char_u buf1[NUMBUFLEN];
11358 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11359 int error = FALSE;
11361 /* When the optional second argument is non-zero, don't remove matches
11362 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11363 if (argvars[2].v_type != VAR_UNKNOWN
11364 && get_tv_number_chk(&argvars[2], &error))
11365 flags |= WILD_KEEP_ALL;
11366 rettv->v_type = VAR_STRING;
11367 if (file == NULL || error)
11368 rettv->vval.v_string = NULL;
11369 else
11370 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11371 flags);
11375 * "has()" function
11377 static void
11378 f_has(argvars, rettv)
11379 typval_T *argvars;
11380 typval_T *rettv;
11382 int i;
11383 char_u *name;
11384 int n = FALSE;
11385 static char *(has_list[]) =
11387 #ifdef AMIGA
11388 "amiga",
11389 # ifdef FEAT_ARP
11390 "arp",
11391 # endif
11392 #endif
11393 #ifdef __BEOS__
11394 "beos",
11395 #endif
11396 #ifdef MSDOS
11397 # ifdef DJGPP
11398 "dos32",
11399 # else
11400 "dos16",
11401 # endif
11402 #endif
11403 #ifdef MACOS
11404 "mac",
11405 #endif
11406 #if defined(MACOS_X_UNIX)
11407 "macunix",
11408 #endif
11409 #ifdef OS2
11410 "os2",
11411 #endif
11412 #ifdef __QNX__
11413 "qnx",
11414 #endif
11415 #ifdef RISCOS
11416 "riscos",
11417 #endif
11418 #ifdef UNIX
11419 "unix",
11420 #endif
11421 #ifdef VMS
11422 "vms",
11423 #endif
11424 #ifdef WIN16
11425 "win16",
11426 #endif
11427 #ifdef WIN32
11428 "win32",
11429 #endif
11430 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11431 "win32unix",
11432 #endif
11433 #ifdef WIN64
11434 "win64",
11435 #endif
11436 #ifdef EBCDIC
11437 "ebcdic",
11438 #endif
11439 #ifndef CASE_INSENSITIVE_FILENAME
11440 "fname_case",
11441 #endif
11442 #ifdef FEAT_ARABIC
11443 "arabic",
11444 #endif
11445 #ifdef FEAT_AUTOCMD
11446 "autocmd",
11447 #endif
11448 #ifdef FEAT_BEVAL
11449 "balloon_eval",
11450 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11451 "balloon_multiline",
11452 # endif
11453 #endif
11454 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11455 "builtin_terms",
11456 # ifdef ALL_BUILTIN_TCAPS
11457 "all_builtin_terms",
11458 # endif
11459 #endif
11460 #ifdef FEAT_BYTEOFF
11461 "byte_offset",
11462 #endif
11463 #ifdef FEAT_CINDENT
11464 "cindent",
11465 #endif
11466 #ifdef FEAT_CLIENTSERVER
11467 "clientserver",
11468 #endif
11469 #ifdef FEAT_CLIPBOARD
11470 "clipboard",
11471 #endif
11472 #ifdef FEAT_CMDL_COMPL
11473 "cmdline_compl",
11474 #endif
11475 #ifdef FEAT_CMDHIST
11476 "cmdline_hist",
11477 #endif
11478 #ifdef FEAT_COMMENTS
11479 "comments",
11480 #endif
11481 #ifdef FEAT_CRYPT
11482 "cryptv",
11483 #endif
11484 #ifdef FEAT_CSCOPE
11485 "cscope",
11486 #endif
11487 #ifdef CURSOR_SHAPE
11488 "cursorshape",
11489 #endif
11490 #ifdef DEBUG
11491 "debug",
11492 #endif
11493 #ifdef FEAT_CON_DIALOG
11494 "dialog_con",
11495 #endif
11496 #ifdef FEAT_GUI_DIALOG
11497 "dialog_gui",
11498 #endif
11499 #ifdef FEAT_DIFF
11500 "diff",
11501 #endif
11502 #ifdef FEAT_DIGRAPHS
11503 "digraphs",
11504 #endif
11505 #ifdef FEAT_DND
11506 "dnd",
11507 #endif
11508 #ifdef FEAT_EMACS_TAGS
11509 "emacs_tags",
11510 #endif
11511 "eval", /* always present, of course! */
11512 #ifdef FEAT_EX_EXTRA
11513 "ex_extra",
11514 #endif
11515 #ifdef FEAT_SEARCH_EXTRA
11516 "extra_search",
11517 #endif
11518 #ifdef FEAT_FKMAP
11519 "farsi",
11520 #endif
11521 #ifdef FEAT_SEARCHPATH
11522 "file_in_path",
11523 #endif
11524 #if defined(UNIX) && !defined(USE_SYSTEM)
11525 "filterpipe",
11526 #endif
11527 #ifdef FEAT_FIND_ID
11528 "find_in_path",
11529 #endif
11530 #ifdef FEAT_FLOAT
11531 "float",
11532 #endif
11533 #ifdef FEAT_FOLDING
11534 "folding",
11535 #endif
11536 #ifdef FEAT_FOOTER
11537 "footer",
11538 #endif
11539 #if !defined(USE_SYSTEM) && defined(UNIX)
11540 "fork",
11541 #endif
11542 #ifdef FEAT_GETTEXT
11543 "gettext",
11544 #endif
11545 #ifdef FEAT_GUI
11546 "gui",
11547 #endif
11548 #ifdef FEAT_GUI_ATHENA
11549 # ifdef FEAT_GUI_NEXTAW
11550 "gui_neXtaw",
11551 # else
11552 "gui_athena",
11553 # endif
11554 #endif
11555 #ifdef FEAT_GUI_GTK
11556 "gui_gtk",
11557 # ifdef HAVE_GTK2
11558 "gui_gtk2",
11559 # endif
11560 #endif
11561 #ifdef FEAT_GUI_GNOME
11562 "gui_gnome",
11563 #endif
11564 #ifdef FEAT_GUI_MAC
11565 "gui_mac",
11566 #endif
11567 #ifdef FEAT_GUI_MOTIF
11568 "gui_motif",
11569 #endif
11570 #ifdef FEAT_GUI_PHOTON
11571 "gui_photon",
11572 #endif
11573 #ifdef FEAT_GUI_W16
11574 "gui_win16",
11575 #endif
11576 #ifdef FEAT_GUI_W32
11577 "gui_win32",
11578 #endif
11579 #ifdef FEAT_HANGULIN
11580 "hangul_input",
11581 #endif
11582 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11583 "iconv",
11584 #endif
11585 #ifdef FEAT_INS_EXPAND
11586 "insert_expand",
11587 #endif
11588 #ifdef FEAT_JUMPLIST
11589 "jumplist",
11590 #endif
11591 #ifdef FEAT_KEYMAP
11592 "keymap",
11593 #endif
11594 #ifdef FEAT_LANGMAP
11595 "langmap",
11596 #endif
11597 #ifdef FEAT_LIBCALL
11598 "libcall",
11599 #endif
11600 #ifdef FEAT_LINEBREAK
11601 "linebreak",
11602 #endif
11603 #ifdef FEAT_LISP
11604 "lispindent",
11605 #endif
11606 #ifdef FEAT_LISTCMDS
11607 "listcmds",
11608 #endif
11609 #ifdef FEAT_LOCALMAP
11610 "localmap",
11611 #endif
11612 #ifdef FEAT_MENU
11613 "menu",
11614 #endif
11615 #ifdef FEAT_SESSION
11616 "mksession",
11617 #endif
11618 #ifdef FEAT_MODIFY_FNAME
11619 "modify_fname",
11620 #endif
11621 #ifdef FEAT_MOUSE
11622 "mouse",
11623 #endif
11624 #ifdef FEAT_MOUSESHAPE
11625 "mouseshape",
11626 #endif
11627 #if defined(UNIX) || defined(VMS)
11628 # ifdef FEAT_MOUSE_DEC
11629 "mouse_dec",
11630 # endif
11631 # ifdef FEAT_MOUSE_GPM
11632 "mouse_gpm",
11633 # endif
11634 # ifdef FEAT_MOUSE_JSB
11635 "mouse_jsbterm",
11636 # endif
11637 # ifdef FEAT_MOUSE_NET
11638 "mouse_netterm",
11639 # endif
11640 # ifdef FEAT_MOUSE_PTERM
11641 "mouse_pterm",
11642 # endif
11643 # ifdef FEAT_SYSMOUSE
11644 "mouse_sysmouse",
11645 # endif
11646 # ifdef FEAT_MOUSE_XTERM
11647 "mouse_xterm",
11648 # endif
11649 #endif
11650 #ifdef FEAT_MBYTE
11651 "multi_byte",
11652 #endif
11653 #ifdef FEAT_MBYTE_IME
11654 "multi_byte_ime",
11655 #endif
11656 #ifdef FEAT_MULTI_LANG
11657 "multi_lang",
11658 #endif
11659 #ifdef FEAT_MZSCHEME
11660 #ifndef DYNAMIC_MZSCHEME
11661 "mzscheme",
11662 #endif
11663 #endif
11664 #ifdef FEAT_OLE
11665 "ole",
11666 #endif
11667 #ifdef FEAT_OSFILETYPE
11668 "osfiletype",
11669 #endif
11670 #ifdef FEAT_PATH_EXTRA
11671 "path_extra",
11672 #endif
11673 #ifdef FEAT_PERL
11674 #ifndef DYNAMIC_PERL
11675 "perl",
11676 #endif
11677 #endif
11678 #ifdef FEAT_PYTHON
11679 #ifndef DYNAMIC_PYTHON
11680 "python",
11681 #endif
11682 #endif
11683 #ifdef FEAT_POSTSCRIPT
11684 "postscript",
11685 #endif
11686 #ifdef FEAT_PRINTER
11687 "printer",
11688 #endif
11689 #ifdef FEAT_PROFILE
11690 "profile",
11691 #endif
11692 #ifdef FEAT_RELTIME
11693 "reltime",
11694 #endif
11695 #ifdef FEAT_QUICKFIX
11696 "quickfix",
11697 #endif
11698 #ifdef FEAT_RIGHTLEFT
11699 "rightleft",
11700 #endif
11701 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11702 "ruby",
11703 #endif
11704 #ifdef FEAT_SCROLLBIND
11705 "scrollbind",
11706 #endif
11707 #ifdef FEAT_CMDL_INFO
11708 "showcmd",
11709 "cmdline_info",
11710 #endif
11711 #ifdef FEAT_SIGNS
11712 "signs",
11713 #endif
11714 #ifdef FEAT_SMARTINDENT
11715 "smartindent",
11716 #endif
11717 #ifdef FEAT_SNIFF
11718 "sniff",
11719 #endif
11720 #ifdef FEAT_STL_OPT
11721 "statusline",
11722 #endif
11723 #ifdef FEAT_SUN_WORKSHOP
11724 "sun_workshop",
11725 #endif
11726 #ifdef FEAT_NETBEANS_INTG
11727 "netbeans_intg",
11728 #endif
11729 #ifdef FEAT_SPELL
11730 "spell",
11731 #endif
11732 #ifdef FEAT_SYN_HL
11733 "syntax",
11734 #endif
11735 #if defined(USE_SYSTEM) || !defined(UNIX)
11736 "system",
11737 #endif
11738 #ifdef FEAT_TAG_BINS
11739 "tag_binary",
11740 #endif
11741 #ifdef FEAT_TAG_OLDSTATIC
11742 "tag_old_static",
11743 #endif
11744 #ifdef FEAT_TAG_ANYWHITE
11745 "tag_any_white",
11746 #endif
11747 #ifdef FEAT_TCL
11748 # ifndef DYNAMIC_TCL
11749 "tcl",
11750 # endif
11751 #endif
11752 #ifdef TERMINFO
11753 "terminfo",
11754 #endif
11755 #ifdef FEAT_TERMRESPONSE
11756 "termresponse",
11757 #endif
11758 #ifdef FEAT_TEXTOBJ
11759 "textobjects",
11760 #endif
11761 #ifdef HAVE_TGETENT
11762 "tgetent",
11763 #endif
11764 #ifdef FEAT_TITLE
11765 "title",
11766 #endif
11767 #ifdef FEAT_TOOLBAR
11768 "toolbar",
11769 #endif
11770 #ifdef FEAT_USR_CMDS
11771 "user-commands", /* was accidentally included in 5.4 */
11772 "user_commands",
11773 #endif
11774 #ifdef FEAT_VIMINFO
11775 "viminfo",
11776 #endif
11777 #ifdef FEAT_VERTSPLIT
11778 "vertsplit",
11779 #endif
11780 #ifdef FEAT_VIRTUALEDIT
11781 "virtualedit",
11782 #endif
11783 #ifdef FEAT_VISUAL
11784 "visual",
11785 #endif
11786 #ifdef FEAT_VISUALEXTRA
11787 "visualextra",
11788 #endif
11789 #ifdef FEAT_VREPLACE
11790 "vreplace",
11791 #endif
11792 #ifdef FEAT_WILDIGN
11793 "wildignore",
11794 #endif
11795 #ifdef FEAT_WILDMENU
11796 "wildmenu",
11797 #endif
11798 #ifdef FEAT_WINDOWS
11799 "windows",
11800 #endif
11801 #ifdef FEAT_WAK
11802 "winaltkeys",
11803 #endif
11804 #ifdef FEAT_WRITEBACKUP
11805 "writebackup",
11806 #endif
11807 #ifdef FEAT_XIM
11808 "xim",
11809 #endif
11810 #ifdef FEAT_XFONTSET
11811 "xfontset",
11812 #endif
11813 #ifdef USE_XSMP
11814 "xsmp",
11815 #endif
11816 #ifdef USE_XSMP_INTERACT
11817 "xsmp_interact",
11818 #endif
11819 #ifdef FEAT_XCLIPBOARD
11820 "xterm_clipboard",
11821 #endif
11822 #ifdef FEAT_XTERM_SAVE
11823 "xterm_save",
11824 #endif
11825 #if defined(UNIX) && defined(FEAT_X11)
11826 "X11",
11827 #endif
11828 NULL
11831 name = get_tv_string(&argvars[0]);
11832 for (i = 0; has_list[i] != NULL; ++i)
11833 if (STRICMP(name, has_list[i]) == 0)
11835 n = TRUE;
11836 break;
11839 if (n == FALSE)
11841 if (STRNICMP(name, "patch", 5) == 0)
11842 n = has_patch(atoi((char *)name + 5));
11843 else if (STRICMP(name, "vim_starting") == 0)
11844 n = (starting != 0);
11845 #ifdef FEAT_MBYTE
11846 else if (STRICMP(name, "multi_byte_encoding") == 0)
11847 n = has_mbyte;
11848 #endif
11849 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11850 else if (STRICMP(name, "balloon_multiline") == 0)
11851 n = multiline_balloon_available();
11852 #endif
11853 #ifdef DYNAMIC_TCL
11854 else if (STRICMP(name, "tcl") == 0)
11855 n = tcl_enabled(FALSE);
11856 #endif
11857 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11858 else if (STRICMP(name, "iconv") == 0)
11859 n = iconv_enabled(FALSE);
11860 #endif
11861 #ifdef DYNAMIC_MZSCHEME
11862 else if (STRICMP(name, "mzscheme") == 0)
11863 n = mzscheme_enabled(FALSE);
11864 #endif
11865 #ifdef DYNAMIC_RUBY
11866 else if (STRICMP(name, "ruby") == 0)
11867 n = ruby_enabled(FALSE);
11868 #endif
11869 #ifdef DYNAMIC_PYTHON
11870 else if (STRICMP(name, "python") == 0)
11871 n = python_enabled(FALSE);
11872 #endif
11873 #ifdef DYNAMIC_PERL
11874 else if (STRICMP(name, "perl") == 0)
11875 n = perl_enabled(FALSE);
11876 #endif
11877 #ifdef FEAT_GUI
11878 else if (STRICMP(name, "gui_running") == 0)
11879 n = (gui.in_use || gui.starting);
11880 # ifdef FEAT_GUI_W32
11881 else if (STRICMP(name, "gui_win32s") == 0)
11882 n = gui_is_win32s();
11883 # endif
11884 # ifdef FEAT_BROWSE
11885 else if (STRICMP(name, "browse") == 0)
11886 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11887 # endif
11888 #endif
11889 #ifdef FEAT_SYN_HL
11890 else if (STRICMP(name, "syntax_items") == 0)
11891 n = syntax_present(curbuf);
11892 #endif
11893 #if defined(WIN3264)
11894 else if (STRICMP(name, "win95") == 0)
11895 n = mch_windows95();
11896 #endif
11897 #ifdef FEAT_NETBEANS_INTG
11898 else if (STRICMP(name, "netbeans_enabled") == 0)
11899 n = usingNetbeans;
11900 #endif
11903 rettv->vval.v_number = n;
11907 * "has_key()" function
11909 static void
11910 f_has_key(argvars, rettv)
11911 typval_T *argvars;
11912 typval_T *rettv;
11914 rettv->vval.v_number = 0;
11915 if (argvars[0].v_type != VAR_DICT)
11917 EMSG(_(e_dictreq));
11918 return;
11920 if (argvars[0].vval.v_dict == NULL)
11921 return;
11923 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11924 get_tv_string(&argvars[1]), -1) != NULL;
11928 * "haslocaldir()" function
11930 /*ARGSUSED*/
11931 static void
11932 f_haslocaldir(argvars, rettv)
11933 typval_T *argvars;
11934 typval_T *rettv;
11936 rettv->vval.v_number = (curwin->w_localdir != NULL);
11940 * "hasmapto()" function
11942 static void
11943 f_hasmapto(argvars, rettv)
11944 typval_T *argvars;
11945 typval_T *rettv;
11947 char_u *name;
11948 char_u *mode;
11949 char_u buf[NUMBUFLEN];
11950 int abbr = FALSE;
11952 name = get_tv_string(&argvars[0]);
11953 if (argvars[1].v_type == VAR_UNKNOWN)
11954 mode = (char_u *)"nvo";
11955 else
11957 mode = get_tv_string_buf(&argvars[1], buf);
11958 if (argvars[2].v_type != VAR_UNKNOWN)
11959 abbr = get_tv_number(&argvars[2]);
11962 if (map_to_exists(name, mode, abbr))
11963 rettv->vval.v_number = TRUE;
11964 else
11965 rettv->vval.v_number = FALSE;
11969 * "histadd()" function
11971 /*ARGSUSED*/
11972 static void
11973 f_histadd(argvars, rettv)
11974 typval_T *argvars;
11975 typval_T *rettv;
11977 #ifdef FEAT_CMDHIST
11978 int histype;
11979 char_u *str;
11980 char_u buf[NUMBUFLEN];
11981 #endif
11983 rettv->vval.v_number = FALSE;
11984 if (check_restricted() || check_secure())
11985 return;
11986 #ifdef FEAT_CMDHIST
11987 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
11988 histype = str != NULL ? get_histtype(str) : -1;
11989 if (histype >= 0)
11991 str = get_tv_string_buf(&argvars[1], buf);
11992 if (*str != NUL)
11994 add_to_history(histype, str, FALSE, NUL);
11995 rettv->vval.v_number = TRUE;
11996 return;
11999 #endif
12003 * "histdel()" function
12005 /*ARGSUSED*/
12006 static void
12007 f_histdel(argvars, rettv)
12008 typval_T *argvars;
12009 typval_T *rettv;
12011 #ifdef FEAT_CMDHIST
12012 int n;
12013 char_u buf[NUMBUFLEN];
12014 char_u *str;
12016 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12017 if (str == NULL)
12018 n = 0;
12019 else if (argvars[1].v_type == VAR_UNKNOWN)
12020 /* only one argument: clear entire history */
12021 n = clr_history(get_histtype(str));
12022 else if (argvars[1].v_type == VAR_NUMBER)
12023 /* index given: remove that entry */
12024 n = del_history_idx(get_histtype(str),
12025 (int)get_tv_number(&argvars[1]));
12026 else
12027 /* string given: remove all matching entries */
12028 n = del_history_entry(get_histtype(str),
12029 get_tv_string_buf(&argvars[1], buf));
12030 rettv->vval.v_number = n;
12031 #else
12032 rettv->vval.v_number = 0;
12033 #endif
12037 * "histget()" function
12039 /*ARGSUSED*/
12040 static void
12041 f_histget(argvars, rettv)
12042 typval_T *argvars;
12043 typval_T *rettv;
12045 #ifdef FEAT_CMDHIST
12046 int type;
12047 int idx;
12048 char_u *str;
12050 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12051 if (str == NULL)
12052 rettv->vval.v_string = NULL;
12053 else
12055 type = get_histtype(str);
12056 if (argvars[1].v_type == VAR_UNKNOWN)
12057 idx = get_history_idx(type);
12058 else
12059 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12060 /* -1 on type error */
12061 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12063 #else
12064 rettv->vval.v_string = NULL;
12065 #endif
12066 rettv->v_type = VAR_STRING;
12070 * "histnr()" function
12072 /*ARGSUSED*/
12073 static void
12074 f_histnr(argvars, rettv)
12075 typval_T *argvars;
12076 typval_T *rettv;
12078 int i;
12080 #ifdef FEAT_CMDHIST
12081 char_u *history = get_tv_string_chk(&argvars[0]);
12083 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12084 if (i >= HIST_CMD && i < HIST_COUNT)
12085 i = get_history_idx(i);
12086 else
12087 #endif
12088 i = -1;
12089 rettv->vval.v_number = i;
12093 * "highlightID(name)" function
12095 static void
12096 f_hlID(argvars, rettv)
12097 typval_T *argvars;
12098 typval_T *rettv;
12100 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12104 * "highlight_exists()" function
12106 static void
12107 f_hlexists(argvars, rettv)
12108 typval_T *argvars;
12109 typval_T *rettv;
12111 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12115 * "hostname()" function
12117 /*ARGSUSED*/
12118 static void
12119 f_hostname(argvars, rettv)
12120 typval_T *argvars;
12121 typval_T *rettv;
12123 char_u hostname[256];
12125 mch_get_host_name(hostname, 256);
12126 rettv->v_type = VAR_STRING;
12127 rettv->vval.v_string = vim_strsave(hostname);
12131 * iconv() function
12133 /*ARGSUSED*/
12134 static void
12135 f_iconv(argvars, rettv)
12136 typval_T *argvars;
12137 typval_T *rettv;
12139 #ifdef FEAT_MBYTE
12140 char_u buf1[NUMBUFLEN];
12141 char_u buf2[NUMBUFLEN];
12142 char_u *from, *to, *str;
12143 vimconv_T vimconv;
12144 #endif
12146 rettv->v_type = VAR_STRING;
12147 rettv->vval.v_string = NULL;
12149 #ifdef FEAT_MBYTE
12150 str = get_tv_string(&argvars[0]);
12151 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12152 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12153 vimconv.vc_type = CONV_NONE;
12154 convert_setup(&vimconv, from, to);
12156 /* If the encodings are equal, no conversion needed. */
12157 if (vimconv.vc_type == CONV_NONE)
12158 rettv->vval.v_string = vim_strsave(str);
12159 else
12160 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12162 convert_setup(&vimconv, NULL, NULL);
12163 vim_free(from);
12164 vim_free(to);
12165 #endif
12169 * "indent()" function
12171 static void
12172 f_indent(argvars, rettv)
12173 typval_T *argvars;
12174 typval_T *rettv;
12176 linenr_T lnum;
12178 lnum = get_tv_lnum(argvars);
12179 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12180 rettv->vval.v_number = get_indent_lnum(lnum);
12181 else
12182 rettv->vval.v_number = -1;
12186 * "index()" function
12188 static void
12189 f_index(argvars, rettv)
12190 typval_T *argvars;
12191 typval_T *rettv;
12193 list_T *l;
12194 listitem_T *item;
12195 long idx = 0;
12196 int ic = FALSE;
12198 rettv->vval.v_number = -1;
12199 if (argvars[0].v_type != VAR_LIST)
12201 EMSG(_(e_listreq));
12202 return;
12204 l = argvars[0].vval.v_list;
12205 if (l != NULL)
12207 item = l->lv_first;
12208 if (argvars[2].v_type != VAR_UNKNOWN)
12210 int error = FALSE;
12212 /* Start at specified item. Use the cached index that list_find()
12213 * sets, so that a negative number also works. */
12214 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12215 idx = l->lv_idx;
12216 if (argvars[3].v_type != VAR_UNKNOWN)
12217 ic = get_tv_number_chk(&argvars[3], &error);
12218 if (error)
12219 item = NULL;
12222 for ( ; item != NULL; item = item->li_next, ++idx)
12223 if (tv_equal(&item->li_tv, &argvars[1], ic))
12225 rettv->vval.v_number = idx;
12226 break;
12231 static int inputsecret_flag = 0;
12233 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12236 * This function is used by f_input() and f_inputdialog() functions. The third
12237 * argument to f_input() specifies the type of completion to use at the
12238 * prompt. The third argument to f_inputdialog() specifies the value to return
12239 * when the user cancels the prompt.
12241 static void
12242 get_user_input(argvars, rettv, inputdialog)
12243 typval_T *argvars;
12244 typval_T *rettv;
12245 int inputdialog;
12247 char_u *prompt = get_tv_string_chk(&argvars[0]);
12248 char_u *p = NULL;
12249 int c;
12250 char_u buf[NUMBUFLEN];
12251 int cmd_silent_save = cmd_silent;
12252 char_u *defstr = (char_u *)"";
12253 int xp_type = EXPAND_NOTHING;
12254 char_u *xp_arg = NULL;
12256 rettv->v_type = VAR_STRING;
12257 rettv->vval.v_string = NULL;
12259 #ifdef NO_CONSOLE_INPUT
12260 /* While starting up, there is no place to enter text. */
12261 if (no_console_input())
12262 return;
12263 #endif
12265 cmd_silent = FALSE; /* Want to see the prompt. */
12266 if (prompt != NULL)
12268 /* Only the part of the message after the last NL is considered as
12269 * prompt for the command line */
12270 p = vim_strrchr(prompt, '\n');
12271 if (p == NULL)
12272 p = prompt;
12273 else
12275 ++p;
12276 c = *p;
12277 *p = NUL;
12278 msg_start();
12279 msg_clr_eos();
12280 msg_puts_attr(prompt, echo_attr);
12281 msg_didout = FALSE;
12282 msg_starthere();
12283 *p = c;
12285 cmdline_row = msg_row;
12287 if (argvars[1].v_type != VAR_UNKNOWN)
12289 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12290 if (defstr != NULL)
12291 stuffReadbuffSpec(defstr);
12293 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12295 char_u *xp_name;
12296 int xp_namelen;
12297 long argt;
12299 rettv->vval.v_string = NULL;
12301 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12302 if (xp_name == NULL)
12303 return;
12305 xp_namelen = (int)STRLEN(xp_name);
12307 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12308 &xp_arg) == FAIL)
12309 return;
12313 if (defstr != NULL)
12314 rettv->vval.v_string =
12315 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12316 xp_type, xp_arg);
12318 vim_free(xp_arg);
12320 /* since the user typed this, no need to wait for return */
12321 need_wait_return = FALSE;
12322 msg_didout = FALSE;
12324 cmd_silent = cmd_silent_save;
12328 * "input()" function
12329 * Also handles inputsecret() when inputsecret is set.
12331 static void
12332 f_input(argvars, rettv)
12333 typval_T *argvars;
12334 typval_T *rettv;
12336 get_user_input(argvars, rettv, FALSE);
12340 * "inputdialog()" function
12342 static void
12343 f_inputdialog(argvars, rettv)
12344 typval_T *argvars;
12345 typval_T *rettv;
12347 #if defined(FEAT_GUI_TEXTDIALOG)
12348 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12349 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12351 char_u *message;
12352 char_u buf[NUMBUFLEN];
12353 char_u *defstr = (char_u *)"";
12355 message = get_tv_string_chk(&argvars[0]);
12356 if (argvars[1].v_type != VAR_UNKNOWN
12357 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12358 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12359 else
12360 IObuff[0] = NUL;
12361 if (message != NULL && defstr != NULL
12362 && do_dialog(VIM_QUESTION, NULL, message,
12363 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12364 rettv->vval.v_string = vim_strsave(IObuff);
12365 else
12367 if (message != NULL && defstr != NULL
12368 && argvars[1].v_type != VAR_UNKNOWN
12369 && argvars[2].v_type != VAR_UNKNOWN)
12370 rettv->vval.v_string = vim_strsave(
12371 get_tv_string_buf(&argvars[2], buf));
12372 else
12373 rettv->vval.v_string = NULL;
12375 rettv->v_type = VAR_STRING;
12377 else
12378 #endif
12379 get_user_input(argvars, rettv, TRUE);
12383 * "inputlist()" function
12385 static void
12386 f_inputlist(argvars, rettv)
12387 typval_T *argvars;
12388 typval_T *rettv;
12390 listitem_T *li;
12391 int selected;
12392 int mouse_used;
12394 rettv->vval.v_number = 0;
12395 #ifdef NO_CONSOLE_INPUT
12396 /* While starting up, there is no place to enter text. */
12397 if (no_console_input())
12398 return;
12399 #endif
12400 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12402 EMSG2(_(e_listarg), "inputlist()");
12403 return;
12406 msg_start();
12407 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12408 lines_left = Rows; /* avoid more prompt */
12409 msg_scroll = TRUE;
12410 msg_clr_eos();
12412 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12414 msg_puts(get_tv_string(&li->li_tv));
12415 msg_putchar('\n');
12418 /* Ask for choice. */
12419 selected = prompt_for_number(&mouse_used);
12420 if (mouse_used)
12421 selected -= lines_left;
12423 rettv->vval.v_number = selected;
12427 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12430 * "inputrestore()" function
12432 /*ARGSUSED*/
12433 static void
12434 f_inputrestore(argvars, rettv)
12435 typval_T *argvars;
12436 typval_T *rettv;
12438 if (ga_userinput.ga_len > 0)
12440 --ga_userinput.ga_len;
12441 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12442 + ga_userinput.ga_len);
12443 rettv->vval.v_number = 0; /* OK */
12445 else if (p_verbose > 1)
12447 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12448 rettv->vval.v_number = 1; /* Failed */
12453 * "inputsave()" function
12455 /*ARGSUSED*/
12456 static void
12457 f_inputsave(argvars, rettv)
12458 typval_T *argvars;
12459 typval_T *rettv;
12461 /* Add an entry to the stack of typeahead storage. */
12462 if (ga_grow(&ga_userinput, 1) == OK)
12464 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12465 + ga_userinput.ga_len);
12466 ++ga_userinput.ga_len;
12467 rettv->vval.v_number = 0; /* OK */
12469 else
12470 rettv->vval.v_number = 1; /* Failed */
12474 * "inputsecret()" function
12476 static void
12477 f_inputsecret(argvars, rettv)
12478 typval_T *argvars;
12479 typval_T *rettv;
12481 ++cmdline_star;
12482 ++inputsecret_flag;
12483 f_input(argvars, rettv);
12484 --cmdline_star;
12485 --inputsecret_flag;
12489 * "insert()" function
12491 static void
12492 f_insert(argvars, rettv)
12493 typval_T *argvars;
12494 typval_T *rettv;
12496 long before = 0;
12497 listitem_T *item;
12498 list_T *l;
12499 int error = FALSE;
12501 rettv->vval.v_number = 0;
12502 if (argvars[0].v_type != VAR_LIST)
12503 EMSG2(_(e_listarg), "insert()");
12504 else if ((l = argvars[0].vval.v_list) != NULL
12505 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12507 if (argvars[2].v_type != VAR_UNKNOWN)
12508 before = get_tv_number_chk(&argvars[2], &error);
12509 if (error)
12510 return; /* type error; errmsg already given */
12512 if (before == l->lv_len)
12513 item = NULL;
12514 else
12516 item = list_find(l, before);
12517 if (item == NULL)
12519 EMSGN(_(e_listidx), before);
12520 l = NULL;
12523 if (l != NULL)
12525 list_insert_tv(l, &argvars[1], item);
12526 copy_tv(&argvars[0], rettv);
12532 * "isdirectory()" function
12534 static void
12535 f_isdirectory(argvars, rettv)
12536 typval_T *argvars;
12537 typval_T *rettv;
12539 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12543 * "islocked()" function
12545 static void
12546 f_islocked(argvars, rettv)
12547 typval_T *argvars;
12548 typval_T *rettv;
12550 lval_T lv;
12551 char_u *end;
12552 dictitem_T *di;
12554 rettv->vval.v_number = -1;
12555 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12556 FNE_CHECK_START);
12557 if (end != NULL && lv.ll_name != NULL)
12559 if (*end != NUL)
12560 EMSG(_(e_trailing));
12561 else
12563 if (lv.ll_tv == NULL)
12565 if (check_changedtick(lv.ll_name))
12566 rettv->vval.v_number = 1; /* always locked */
12567 else
12569 di = find_var(lv.ll_name, NULL);
12570 if (di != NULL)
12572 /* Consider a variable locked when:
12573 * 1. the variable itself is locked
12574 * 2. the value of the variable is locked.
12575 * 3. the List or Dict value is locked.
12577 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12578 || tv_islocked(&di->di_tv));
12582 else if (lv.ll_range)
12583 EMSG(_("E786: Range not allowed"));
12584 else if (lv.ll_newkey != NULL)
12585 EMSG2(_(e_dictkey), lv.ll_newkey);
12586 else if (lv.ll_list != NULL)
12587 /* List item. */
12588 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12589 else
12590 /* Dictionary item. */
12591 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12595 clear_lval(&lv);
12598 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12601 * Turn a dict into a list:
12602 * "what" == 0: list of keys
12603 * "what" == 1: list of values
12604 * "what" == 2: list of items
12606 static void
12607 dict_list(argvars, rettv, what)
12608 typval_T *argvars;
12609 typval_T *rettv;
12610 int what;
12612 list_T *l2;
12613 dictitem_T *di;
12614 hashitem_T *hi;
12615 listitem_T *li;
12616 listitem_T *li2;
12617 dict_T *d;
12618 int todo;
12620 rettv->vval.v_number = 0;
12621 if (argvars[0].v_type != VAR_DICT)
12623 EMSG(_(e_dictreq));
12624 return;
12626 if ((d = argvars[0].vval.v_dict) == NULL)
12627 return;
12629 if (rettv_list_alloc(rettv) == FAIL)
12630 return;
12632 todo = (int)d->dv_hashtab.ht_used;
12633 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12635 if (!HASHITEM_EMPTY(hi))
12637 --todo;
12638 di = HI2DI(hi);
12640 li = listitem_alloc();
12641 if (li == NULL)
12642 break;
12643 list_append(rettv->vval.v_list, li);
12645 if (what == 0)
12647 /* keys() */
12648 li->li_tv.v_type = VAR_STRING;
12649 li->li_tv.v_lock = 0;
12650 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12652 else if (what == 1)
12654 /* values() */
12655 copy_tv(&di->di_tv, &li->li_tv);
12657 else
12659 /* items() */
12660 l2 = list_alloc();
12661 li->li_tv.v_type = VAR_LIST;
12662 li->li_tv.v_lock = 0;
12663 li->li_tv.vval.v_list = l2;
12664 if (l2 == NULL)
12665 break;
12666 ++l2->lv_refcount;
12668 li2 = listitem_alloc();
12669 if (li2 == NULL)
12670 break;
12671 list_append(l2, li2);
12672 li2->li_tv.v_type = VAR_STRING;
12673 li2->li_tv.v_lock = 0;
12674 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12676 li2 = listitem_alloc();
12677 if (li2 == NULL)
12678 break;
12679 list_append(l2, li2);
12680 copy_tv(&di->di_tv, &li2->li_tv);
12687 * "items(dict)" function
12689 static void
12690 f_items(argvars, rettv)
12691 typval_T *argvars;
12692 typval_T *rettv;
12694 dict_list(argvars, rettv, 2);
12698 * "join()" function
12700 static void
12701 f_join(argvars, rettv)
12702 typval_T *argvars;
12703 typval_T *rettv;
12705 garray_T ga;
12706 char_u *sep;
12708 rettv->vval.v_number = 0;
12709 if (argvars[0].v_type != VAR_LIST)
12711 EMSG(_(e_listreq));
12712 return;
12714 if (argvars[0].vval.v_list == NULL)
12715 return;
12716 if (argvars[1].v_type == VAR_UNKNOWN)
12717 sep = (char_u *)" ";
12718 else
12719 sep = get_tv_string_chk(&argvars[1]);
12721 rettv->v_type = VAR_STRING;
12723 if (sep != NULL)
12725 ga_init2(&ga, (int)sizeof(char), 80);
12726 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12727 ga_append(&ga, NUL);
12728 rettv->vval.v_string = (char_u *)ga.ga_data;
12730 else
12731 rettv->vval.v_string = NULL;
12735 * "keys()" function
12737 static void
12738 f_keys(argvars, rettv)
12739 typval_T *argvars;
12740 typval_T *rettv;
12742 dict_list(argvars, rettv, 0);
12746 * "last_buffer_nr()" function.
12748 /*ARGSUSED*/
12749 static void
12750 f_last_buffer_nr(argvars, rettv)
12751 typval_T *argvars;
12752 typval_T *rettv;
12754 int n = 0;
12755 buf_T *buf;
12757 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12758 if (n < buf->b_fnum)
12759 n = buf->b_fnum;
12761 rettv->vval.v_number = n;
12765 * "len()" function
12767 static void
12768 f_len(argvars, rettv)
12769 typval_T *argvars;
12770 typval_T *rettv;
12772 switch (argvars[0].v_type)
12774 case VAR_STRING:
12775 case VAR_NUMBER:
12776 rettv->vval.v_number = (varnumber_T)STRLEN(
12777 get_tv_string(&argvars[0]));
12778 break;
12779 case VAR_LIST:
12780 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12781 break;
12782 case VAR_DICT:
12783 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12784 break;
12785 default:
12786 EMSG(_("E701: Invalid type for len()"));
12787 break;
12791 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12793 static void
12794 libcall_common(argvars, rettv, type)
12795 typval_T *argvars;
12796 typval_T *rettv;
12797 int type;
12799 #ifdef FEAT_LIBCALL
12800 char_u *string_in;
12801 char_u **string_result;
12802 int nr_result;
12803 #endif
12805 rettv->v_type = type;
12806 if (type == VAR_NUMBER)
12807 rettv->vval.v_number = 0;
12808 else
12809 rettv->vval.v_string = NULL;
12811 if (check_restricted() || check_secure())
12812 return;
12814 #ifdef FEAT_LIBCALL
12815 /* The first two args must be strings, otherwise its meaningless */
12816 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12818 string_in = NULL;
12819 if (argvars[2].v_type == VAR_STRING)
12820 string_in = argvars[2].vval.v_string;
12821 if (type == VAR_NUMBER)
12822 string_result = NULL;
12823 else
12824 string_result = &rettv->vval.v_string;
12825 if (mch_libcall(argvars[0].vval.v_string,
12826 argvars[1].vval.v_string,
12827 string_in,
12828 argvars[2].vval.v_number,
12829 string_result,
12830 &nr_result) == OK
12831 && type == VAR_NUMBER)
12832 rettv->vval.v_number = nr_result;
12834 #endif
12838 * "libcall()" function
12840 static void
12841 f_libcall(argvars, rettv)
12842 typval_T *argvars;
12843 typval_T *rettv;
12845 libcall_common(argvars, rettv, VAR_STRING);
12849 * "libcallnr()" function
12851 static void
12852 f_libcallnr(argvars, rettv)
12853 typval_T *argvars;
12854 typval_T *rettv;
12856 libcall_common(argvars, rettv, VAR_NUMBER);
12860 * "line(string)" function
12862 static void
12863 f_line(argvars, rettv)
12864 typval_T *argvars;
12865 typval_T *rettv;
12867 linenr_T lnum = 0;
12868 pos_T *fp;
12869 int fnum;
12871 fp = var2fpos(&argvars[0], TRUE, &fnum);
12872 if (fp != NULL)
12873 lnum = fp->lnum;
12874 rettv->vval.v_number = lnum;
12878 * "line2byte(lnum)" function
12880 /*ARGSUSED*/
12881 static void
12882 f_line2byte(argvars, rettv)
12883 typval_T *argvars;
12884 typval_T *rettv;
12886 #ifndef FEAT_BYTEOFF
12887 rettv->vval.v_number = -1;
12888 #else
12889 linenr_T lnum;
12891 lnum = get_tv_lnum(argvars);
12892 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12893 rettv->vval.v_number = -1;
12894 else
12895 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12896 if (rettv->vval.v_number >= 0)
12897 ++rettv->vval.v_number;
12898 #endif
12902 * "lispindent(lnum)" function
12904 static void
12905 f_lispindent(argvars, rettv)
12906 typval_T *argvars;
12907 typval_T *rettv;
12909 #ifdef FEAT_LISP
12910 pos_T pos;
12911 linenr_T lnum;
12913 pos = curwin->w_cursor;
12914 lnum = get_tv_lnum(argvars);
12915 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12917 curwin->w_cursor.lnum = lnum;
12918 rettv->vval.v_number = get_lisp_indent();
12919 curwin->w_cursor = pos;
12921 else
12922 #endif
12923 rettv->vval.v_number = -1;
12927 * "localtime()" function
12929 /*ARGSUSED*/
12930 static void
12931 f_localtime(argvars, rettv)
12932 typval_T *argvars;
12933 typval_T *rettv;
12935 rettv->vval.v_number = (varnumber_T)time(NULL);
12938 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12940 static void
12941 get_maparg(argvars, rettv, exact)
12942 typval_T *argvars;
12943 typval_T *rettv;
12944 int exact;
12946 char_u *keys;
12947 char_u *which;
12948 char_u buf[NUMBUFLEN];
12949 char_u *keys_buf = NULL;
12950 char_u *rhs;
12951 int mode;
12952 garray_T ga;
12953 int abbr = FALSE;
12955 /* return empty string for failure */
12956 rettv->v_type = VAR_STRING;
12957 rettv->vval.v_string = NULL;
12959 keys = get_tv_string(&argvars[0]);
12960 if (*keys == NUL)
12961 return;
12963 if (argvars[1].v_type != VAR_UNKNOWN)
12965 which = get_tv_string_buf_chk(&argvars[1], buf);
12966 if (argvars[2].v_type != VAR_UNKNOWN)
12967 abbr = get_tv_number(&argvars[2]);
12969 else
12970 which = (char_u *)"";
12971 if (which == NULL)
12972 return;
12974 mode = get_map_mode(&which, 0);
12976 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12977 rhs = check_map(keys, mode, exact, FALSE, abbr);
12978 vim_free(keys_buf);
12979 if (rhs != NULL)
12981 ga_init(&ga);
12982 ga.ga_itemsize = 1;
12983 ga.ga_growsize = 40;
12985 while (*rhs != NUL)
12986 ga_concat(&ga, str2special(&rhs, FALSE));
12988 ga_append(&ga, NUL);
12989 rettv->vval.v_string = (char_u *)ga.ga_data;
12993 #ifdef FEAT_FLOAT
12995 * "log10()" function
12997 static void
12998 f_log10(argvars, rettv)
12999 typval_T *argvars;
13000 typval_T *rettv;
13002 float_T f;
13004 rettv->v_type = VAR_FLOAT;
13005 if (get_float_arg(argvars, &f) == OK)
13006 rettv->vval.v_float = log10(f);
13007 else
13008 rettv->vval.v_float = 0.0;
13010 #endif
13013 * "map()" function
13015 static void
13016 f_map(argvars, rettv)
13017 typval_T *argvars;
13018 typval_T *rettv;
13020 filter_map(argvars, rettv, TRUE);
13024 * "maparg()" function
13026 static void
13027 f_maparg(argvars, rettv)
13028 typval_T *argvars;
13029 typval_T *rettv;
13031 get_maparg(argvars, rettv, TRUE);
13035 * "mapcheck()" function
13037 static void
13038 f_mapcheck(argvars, rettv)
13039 typval_T *argvars;
13040 typval_T *rettv;
13042 get_maparg(argvars, rettv, FALSE);
13045 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13047 static void
13048 find_some_match(argvars, rettv, type)
13049 typval_T *argvars;
13050 typval_T *rettv;
13051 int type;
13053 char_u *str = NULL;
13054 char_u *expr = NULL;
13055 char_u *pat;
13056 regmatch_T regmatch;
13057 char_u patbuf[NUMBUFLEN];
13058 char_u strbuf[NUMBUFLEN];
13059 char_u *save_cpo;
13060 long start = 0;
13061 long nth = 1;
13062 colnr_T startcol = 0;
13063 int match = 0;
13064 list_T *l = NULL;
13065 listitem_T *li = NULL;
13066 long idx = 0;
13067 char_u *tofree = NULL;
13069 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13070 save_cpo = p_cpo;
13071 p_cpo = (char_u *)"";
13073 rettv->vval.v_number = -1;
13074 if (type == 3)
13076 /* return empty list when there are no matches */
13077 if (rettv_list_alloc(rettv) == FAIL)
13078 goto theend;
13080 else if (type == 2)
13082 rettv->v_type = VAR_STRING;
13083 rettv->vval.v_string = NULL;
13086 if (argvars[0].v_type == VAR_LIST)
13088 if ((l = argvars[0].vval.v_list) == NULL)
13089 goto theend;
13090 li = l->lv_first;
13092 else
13093 expr = str = get_tv_string(&argvars[0]);
13095 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13096 if (pat == NULL)
13097 goto theend;
13099 if (argvars[2].v_type != VAR_UNKNOWN)
13101 int error = FALSE;
13103 start = get_tv_number_chk(&argvars[2], &error);
13104 if (error)
13105 goto theend;
13106 if (l != NULL)
13108 li = list_find(l, start);
13109 if (li == NULL)
13110 goto theend;
13111 idx = l->lv_idx; /* use the cached index */
13113 else
13115 if (start < 0)
13116 start = 0;
13117 if (start > (long)STRLEN(str))
13118 goto theend;
13119 /* When "count" argument is there ignore matches before "start",
13120 * otherwise skip part of the string. Differs when pattern is "^"
13121 * or "\<". */
13122 if (argvars[3].v_type != VAR_UNKNOWN)
13123 startcol = start;
13124 else
13125 str += start;
13128 if (argvars[3].v_type != VAR_UNKNOWN)
13129 nth = get_tv_number_chk(&argvars[3], &error);
13130 if (error)
13131 goto theend;
13134 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13135 if (regmatch.regprog != NULL)
13137 regmatch.rm_ic = p_ic;
13139 for (;;)
13141 if (l != NULL)
13143 if (li == NULL)
13145 match = FALSE;
13146 break;
13148 vim_free(tofree);
13149 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13150 if (str == NULL)
13151 break;
13154 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13156 if (match && --nth <= 0)
13157 break;
13158 if (l == NULL && !match)
13159 break;
13161 /* Advance to just after the match. */
13162 if (l != NULL)
13164 li = li->li_next;
13165 ++idx;
13167 else
13169 #ifdef FEAT_MBYTE
13170 startcol = (colnr_T)(regmatch.startp[0]
13171 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13172 #else
13173 startcol = regmatch.startp[0] + 1 - str;
13174 #endif
13178 if (match)
13180 if (type == 3)
13182 int i;
13184 /* return list with matched string and submatches */
13185 for (i = 0; i < NSUBEXP; ++i)
13187 if (regmatch.endp[i] == NULL)
13189 if (list_append_string(rettv->vval.v_list,
13190 (char_u *)"", 0) == FAIL)
13191 break;
13193 else if (list_append_string(rettv->vval.v_list,
13194 regmatch.startp[i],
13195 (int)(regmatch.endp[i] - regmatch.startp[i]))
13196 == FAIL)
13197 break;
13200 else if (type == 2)
13202 /* return matched string */
13203 if (l != NULL)
13204 copy_tv(&li->li_tv, rettv);
13205 else
13206 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13207 (int)(regmatch.endp[0] - regmatch.startp[0]));
13209 else if (l != NULL)
13210 rettv->vval.v_number = idx;
13211 else
13213 if (type != 0)
13214 rettv->vval.v_number =
13215 (varnumber_T)(regmatch.startp[0] - str);
13216 else
13217 rettv->vval.v_number =
13218 (varnumber_T)(regmatch.endp[0] - str);
13219 rettv->vval.v_number += (varnumber_T)(str - expr);
13222 vim_free(regmatch.regprog);
13225 theend:
13226 vim_free(tofree);
13227 p_cpo = save_cpo;
13231 * "match()" function
13233 static void
13234 f_match(argvars, rettv)
13235 typval_T *argvars;
13236 typval_T *rettv;
13238 find_some_match(argvars, rettv, 1);
13242 * "matchadd()" function
13244 static void
13245 f_matchadd(argvars, rettv)
13246 typval_T *argvars;
13247 typval_T *rettv;
13249 #ifdef FEAT_SEARCH_EXTRA
13250 char_u buf[NUMBUFLEN];
13251 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13252 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13253 int prio = 10; /* default priority */
13254 int id = -1;
13255 int error = FALSE;
13257 rettv->vval.v_number = -1;
13259 if (grp == NULL || pat == NULL)
13260 return;
13261 if (argvars[2].v_type != VAR_UNKNOWN)
13263 prio = get_tv_number_chk(&argvars[2], &error);
13264 if (argvars[3].v_type != VAR_UNKNOWN)
13265 id = get_tv_number_chk(&argvars[3], &error);
13267 if (error == TRUE)
13268 return;
13269 if (id >= 1 && id <= 3)
13271 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13272 return;
13275 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13276 #endif
13280 * "matcharg()" function
13282 static void
13283 f_matcharg(argvars, rettv)
13284 typval_T *argvars;
13285 typval_T *rettv;
13287 if (rettv_list_alloc(rettv) == OK)
13289 #ifdef FEAT_SEARCH_EXTRA
13290 int id = get_tv_number(&argvars[0]);
13291 matchitem_T *m;
13293 if (id >= 1 && id <= 3)
13295 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13297 list_append_string(rettv->vval.v_list,
13298 syn_id2name(m->hlg_id), -1);
13299 list_append_string(rettv->vval.v_list, m->pattern, -1);
13301 else
13303 list_append_string(rettv->vval.v_list, NUL, -1);
13304 list_append_string(rettv->vval.v_list, NUL, -1);
13307 #endif
13312 * "matchdelete()" function
13314 static void
13315 f_matchdelete(argvars, rettv)
13316 typval_T *argvars;
13317 typval_T *rettv;
13319 #ifdef FEAT_SEARCH_EXTRA
13320 rettv->vval.v_number = match_delete(curwin,
13321 (int)get_tv_number(&argvars[0]), TRUE);
13322 #endif
13326 * "matchend()" function
13328 static void
13329 f_matchend(argvars, rettv)
13330 typval_T *argvars;
13331 typval_T *rettv;
13333 find_some_match(argvars, rettv, 0);
13337 * "matchlist()" function
13339 static void
13340 f_matchlist(argvars, rettv)
13341 typval_T *argvars;
13342 typval_T *rettv;
13344 find_some_match(argvars, rettv, 3);
13348 * "matchstr()" function
13350 static void
13351 f_matchstr(argvars, rettv)
13352 typval_T *argvars;
13353 typval_T *rettv;
13355 find_some_match(argvars, rettv, 2);
13358 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13360 static void
13361 max_min(argvars, rettv, domax)
13362 typval_T *argvars;
13363 typval_T *rettv;
13364 int domax;
13366 long n = 0;
13367 long i;
13368 int error = FALSE;
13370 if (argvars[0].v_type == VAR_LIST)
13372 list_T *l;
13373 listitem_T *li;
13375 l = argvars[0].vval.v_list;
13376 if (l != NULL)
13378 li = l->lv_first;
13379 if (li != NULL)
13381 n = get_tv_number_chk(&li->li_tv, &error);
13382 for (;;)
13384 li = li->li_next;
13385 if (li == NULL)
13386 break;
13387 i = get_tv_number_chk(&li->li_tv, &error);
13388 if (domax ? i > n : i < n)
13389 n = i;
13394 else if (argvars[0].v_type == VAR_DICT)
13396 dict_T *d;
13397 int first = TRUE;
13398 hashitem_T *hi;
13399 int todo;
13401 d = argvars[0].vval.v_dict;
13402 if (d != NULL)
13404 todo = (int)d->dv_hashtab.ht_used;
13405 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13407 if (!HASHITEM_EMPTY(hi))
13409 --todo;
13410 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13411 if (first)
13413 n = i;
13414 first = FALSE;
13416 else if (domax ? i > n : i < n)
13417 n = i;
13422 else
13423 EMSG(_(e_listdictarg));
13424 rettv->vval.v_number = error ? 0 : n;
13428 * "max()" function
13430 static void
13431 f_max(argvars, rettv)
13432 typval_T *argvars;
13433 typval_T *rettv;
13435 max_min(argvars, rettv, TRUE);
13439 * "min()" function
13441 static void
13442 f_min(argvars, rettv)
13443 typval_T *argvars;
13444 typval_T *rettv;
13446 max_min(argvars, rettv, FALSE);
13449 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13452 * Create the directory in which "dir" is located, and higher levels when
13453 * needed.
13455 static int
13456 mkdir_recurse(dir, prot)
13457 char_u *dir;
13458 int prot;
13460 char_u *p;
13461 char_u *updir;
13462 int r = FAIL;
13464 /* Get end of directory name in "dir".
13465 * We're done when it's "/" or "c:/". */
13466 p = gettail_sep(dir);
13467 if (p <= get_past_head(dir))
13468 return OK;
13470 /* If the directory exists we're done. Otherwise: create it.*/
13471 updir = vim_strnsave(dir, (int)(p - dir));
13472 if (updir == NULL)
13473 return FAIL;
13474 if (mch_isdir(updir))
13475 r = OK;
13476 else if (mkdir_recurse(updir, prot) == OK)
13477 r = vim_mkdir_emsg(updir, prot);
13478 vim_free(updir);
13479 return r;
13482 #ifdef vim_mkdir
13484 * "mkdir()" function
13486 static void
13487 f_mkdir(argvars, rettv)
13488 typval_T *argvars;
13489 typval_T *rettv;
13491 char_u *dir;
13492 char_u buf[NUMBUFLEN];
13493 int prot = 0755;
13495 rettv->vval.v_number = FAIL;
13496 if (check_restricted() || check_secure())
13497 return;
13499 dir = get_tv_string_buf(&argvars[0], buf);
13500 if (argvars[1].v_type != VAR_UNKNOWN)
13502 if (argvars[2].v_type != VAR_UNKNOWN)
13503 prot = get_tv_number_chk(&argvars[2], NULL);
13504 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13505 mkdir_recurse(dir, prot);
13507 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13509 #endif
13512 * "mode()" function
13514 /*ARGSUSED*/
13515 static void
13516 f_mode(argvars, rettv)
13517 typval_T *argvars;
13518 typval_T *rettv;
13520 char_u buf[3];
13522 buf[1] = NUL;
13523 buf[2] = NUL;
13525 #ifdef FEAT_VISUAL
13526 if (VIsual_active)
13528 if (VIsual_select)
13529 buf[0] = VIsual_mode + 's' - 'v';
13530 else
13531 buf[0] = VIsual_mode;
13533 else
13534 #endif
13535 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13536 || State == CONFIRM)
13538 buf[0] = 'r';
13539 if (State == ASKMORE)
13540 buf[1] = 'm';
13541 else if (State == CONFIRM)
13542 buf[1] = '?';
13544 else if (State == EXTERNCMD)
13545 buf[0] = '!';
13546 else if (State & INSERT)
13548 #ifdef FEAT_VREPLACE
13549 if (State & VREPLACE_FLAG)
13551 buf[0] = 'R';
13552 buf[1] = 'v';
13554 else
13555 #endif
13556 if (State & REPLACE_FLAG)
13557 buf[0] = 'R';
13558 else
13559 buf[0] = 'i';
13561 else if (State & CMDLINE)
13563 buf[0] = 'c';
13564 if (exmode_active)
13565 buf[1] = 'v';
13567 else if (exmode_active)
13569 buf[0] = 'c';
13570 buf[1] = 'e';
13572 else
13574 buf[0] = 'n';
13575 if (finish_op)
13576 buf[1] = 'o';
13579 /* Clear out the minor mode when the argument is not a non-zero number or
13580 * non-empty string. */
13581 if (!non_zero_arg(&argvars[0]))
13582 buf[1] = NUL;
13584 rettv->vval.v_string = vim_strsave(buf);
13585 rettv->v_type = VAR_STRING;
13589 * "nextnonblank()" function
13591 static void
13592 f_nextnonblank(argvars, rettv)
13593 typval_T *argvars;
13594 typval_T *rettv;
13596 linenr_T lnum;
13598 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13600 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13602 lnum = 0;
13603 break;
13605 if (*skipwhite(ml_get(lnum)) != NUL)
13606 break;
13608 rettv->vval.v_number = lnum;
13612 * "nr2char()" function
13614 static void
13615 f_nr2char(argvars, rettv)
13616 typval_T *argvars;
13617 typval_T *rettv;
13619 char_u buf[NUMBUFLEN];
13621 #ifdef FEAT_MBYTE
13622 if (has_mbyte)
13623 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13624 else
13625 #endif
13627 buf[0] = (char_u)get_tv_number(&argvars[0]);
13628 buf[1] = NUL;
13630 rettv->v_type = VAR_STRING;
13631 rettv->vval.v_string = vim_strsave(buf);
13635 * "pathshorten()" function
13637 static void
13638 f_pathshorten(argvars, rettv)
13639 typval_T *argvars;
13640 typval_T *rettv;
13642 char_u *p;
13644 rettv->v_type = VAR_STRING;
13645 p = get_tv_string_chk(&argvars[0]);
13646 if (p == NULL)
13647 rettv->vval.v_string = NULL;
13648 else
13650 p = vim_strsave(p);
13651 rettv->vval.v_string = p;
13652 if (p != NULL)
13653 shorten_dir(p);
13657 #ifdef FEAT_FLOAT
13659 * "pow()" function
13661 static void
13662 f_pow(argvars, rettv)
13663 typval_T *argvars;
13664 typval_T *rettv;
13666 float_T fx, fy;
13668 rettv->v_type = VAR_FLOAT;
13669 if (get_float_arg(argvars, &fx) == OK
13670 && get_float_arg(&argvars[1], &fy) == OK)
13671 rettv->vval.v_float = pow(fx, fy);
13672 else
13673 rettv->vval.v_float = 0.0;
13675 #endif
13678 * "prevnonblank()" function
13680 static void
13681 f_prevnonblank(argvars, rettv)
13682 typval_T *argvars;
13683 typval_T *rettv;
13685 linenr_T lnum;
13687 lnum = get_tv_lnum(argvars);
13688 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13689 lnum = 0;
13690 else
13691 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13692 --lnum;
13693 rettv->vval.v_number = lnum;
13696 #ifdef HAVE_STDARG_H
13697 /* This dummy va_list is here because:
13698 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13699 * - locally in the function results in a "used before set" warning
13700 * - using va_start() to initialize it gives "function with fixed args" error */
13701 static va_list ap;
13702 #endif
13705 * "printf()" function
13707 static void
13708 f_printf(argvars, rettv)
13709 typval_T *argvars;
13710 typval_T *rettv;
13712 rettv->v_type = VAR_STRING;
13713 rettv->vval.v_string = NULL;
13714 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13716 char_u buf[NUMBUFLEN];
13717 int len;
13718 char_u *s;
13719 int saved_did_emsg = did_emsg;
13720 char *fmt;
13722 /* Get the required length, allocate the buffer and do it for real. */
13723 did_emsg = FALSE;
13724 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13725 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13726 if (!did_emsg)
13728 s = alloc(len + 1);
13729 if (s != NULL)
13731 rettv->vval.v_string = s;
13732 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13735 did_emsg |= saved_did_emsg;
13737 #endif
13741 * "pumvisible()" function
13743 /*ARGSUSED*/
13744 static void
13745 f_pumvisible(argvars, rettv)
13746 typval_T *argvars;
13747 typval_T *rettv;
13749 rettv->vval.v_number = 0;
13750 #ifdef FEAT_INS_EXPAND
13751 if (pum_visible())
13752 rettv->vval.v_number = 1;
13753 #endif
13757 * "range()" function
13759 static void
13760 f_range(argvars, rettv)
13761 typval_T *argvars;
13762 typval_T *rettv;
13764 long start;
13765 long end;
13766 long stride = 1;
13767 long i;
13768 int error = FALSE;
13770 start = get_tv_number_chk(&argvars[0], &error);
13771 if (argvars[1].v_type == VAR_UNKNOWN)
13773 end = start - 1;
13774 start = 0;
13776 else
13778 end = get_tv_number_chk(&argvars[1], &error);
13779 if (argvars[2].v_type != VAR_UNKNOWN)
13780 stride = get_tv_number_chk(&argvars[2], &error);
13783 rettv->vval.v_number = 0;
13784 if (error)
13785 return; /* type error; errmsg already given */
13786 if (stride == 0)
13787 EMSG(_("E726: Stride is zero"));
13788 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13789 EMSG(_("E727: Start past end"));
13790 else
13792 if (rettv_list_alloc(rettv) == OK)
13793 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13794 if (list_append_number(rettv->vval.v_list,
13795 (varnumber_T)i) == FAIL)
13796 break;
13801 * "readfile()" function
13803 static void
13804 f_readfile(argvars, rettv)
13805 typval_T *argvars;
13806 typval_T *rettv;
13808 int binary = FALSE;
13809 char_u *fname;
13810 FILE *fd;
13811 listitem_T *li;
13812 #define FREAD_SIZE 200 /* optimized for text lines */
13813 char_u buf[FREAD_SIZE];
13814 int readlen; /* size of last fread() */
13815 int buflen; /* nr of valid chars in buf[] */
13816 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13817 int tolist; /* first byte in buf[] still to be put in list */
13818 int chop; /* how many CR to chop off */
13819 char_u *prev = NULL; /* previously read bytes, if any */
13820 int prevlen = 0; /* length of "prev" if not NULL */
13821 char_u *s;
13822 int len;
13823 long maxline = MAXLNUM;
13824 long cnt = 0;
13826 if (argvars[1].v_type != VAR_UNKNOWN)
13828 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13829 binary = TRUE;
13830 if (argvars[2].v_type != VAR_UNKNOWN)
13831 maxline = get_tv_number(&argvars[2]);
13834 if (rettv_list_alloc(rettv) == FAIL)
13835 return;
13837 /* Always open the file in binary mode, library functions have a mind of
13838 * their own about CR-LF conversion. */
13839 fname = get_tv_string(&argvars[0]);
13840 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13842 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13843 return;
13846 filtd = 0;
13847 while (cnt < maxline || maxline < 0)
13849 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13850 buflen = filtd + readlen;
13851 tolist = 0;
13852 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13854 if (buf[filtd] == '\n' || readlen <= 0)
13856 /* Only when in binary mode add an empty list item when the
13857 * last line ends in a '\n'. */
13858 if (!binary && readlen == 0 && filtd == 0)
13859 break;
13861 /* Found end-of-line or end-of-file: add a text line to the
13862 * list. */
13863 chop = 0;
13864 if (!binary)
13865 while (filtd - chop - 1 >= tolist
13866 && buf[filtd - chop - 1] == '\r')
13867 ++chop;
13868 len = filtd - tolist - chop;
13869 if (prev == NULL)
13870 s = vim_strnsave(buf + tolist, len);
13871 else
13873 s = alloc((unsigned)(prevlen + len + 1));
13874 if (s != NULL)
13876 mch_memmove(s, prev, prevlen);
13877 vim_free(prev);
13878 prev = NULL;
13879 mch_memmove(s + prevlen, buf + tolist, len);
13880 s[prevlen + len] = NUL;
13883 tolist = filtd + 1;
13885 li = listitem_alloc();
13886 if (li == NULL)
13888 vim_free(s);
13889 break;
13891 li->li_tv.v_type = VAR_STRING;
13892 li->li_tv.v_lock = 0;
13893 li->li_tv.vval.v_string = s;
13894 list_append(rettv->vval.v_list, li);
13896 if (++cnt >= maxline && maxline >= 0)
13897 break;
13898 if (readlen <= 0)
13899 break;
13901 else if (buf[filtd] == NUL)
13902 buf[filtd] = '\n';
13904 if (readlen <= 0)
13905 break;
13907 if (tolist == 0)
13909 /* "buf" is full, need to move text to an allocated buffer */
13910 if (prev == NULL)
13912 prev = vim_strnsave(buf, buflen);
13913 prevlen = buflen;
13915 else
13917 s = alloc((unsigned)(prevlen + buflen));
13918 if (s != NULL)
13920 mch_memmove(s, prev, prevlen);
13921 mch_memmove(s + prevlen, buf, buflen);
13922 vim_free(prev);
13923 prev = s;
13924 prevlen += buflen;
13927 filtd = 0;
13929 else
13931 mch_memmove(buf, buf + tolist, buflen - tolist);
13932 filtd -= tolist;
13937 * For a negative line count use only the lines at the end of the file,
13938 * free the rest.
13940 if (maxline < 0)
13941 while (cnt > -maxline)
13943 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13944 --cnt;
13947 vim_free(prev);
13948 fclose(fd);
13951 #if defined(FEAT_RELTIME)
13952 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13955 * Convert a List to proftime_T.
13956 * Return FAIL when there is something wrong.
13958 static int
13959 list2proftime(arg, tm)
13960 typval_T *arg;
13961 proftime_T *tm;
13963 long n1, n2;
13964 int error = FALSE;
13966 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13967 || arg->vval.v_list->lv_len != 2)
13968 return FAIL;
13969 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13970 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13971 # ifdef WIN3264
13972 tm->HighPart = n1;
13973 tm->LowPart = n2;
13974 # else
13975 tm->tv_sec = n1;
13976 tm->tv_usec = n2;
13977 # endif
13978 return error ? FAIL : OK;
13980 #endif /* FEAT_RELTIME */
13983 * "reltime()" function
13985 static void
13986 f_reltime(argvars, rettv)
13987 typval_T *argvars;
13988 typval_T *rettv;
13990 #ifdef FEAT_RELTIME
13991 proftime_T res;
13992 proftime_T start;
13994 if (argvars[0].v_type == VAR_UNKNOWN)
13996 /* No arguments: get current time. */
13997 profile_start(&res);
13999 else if (argvars[1].v_type == VAR_UNKNOWN)
14001 if (list2proftime(&argvars[0], &res) == FAIL)
14002 return;
14003 profile_end(&res);
14005 else
14007 /* Two arguments: compute the difference. */
14008 if (list2proftime(&argvars[0], &start) == FAIL
14009 || list2proftime(&argvars[1], &res) == FAIL)
14010 return;
14011 profile_sub(&res, &start);
14014 if (rettv_list_alloc(rettv) == OK)
14016 long n1, n2;
14018 # ifdef WIN3264
14019 n1 = res.HighPart;
14020 n2 = res.LowPart;
14021 # else
14022 n1 = res.tv_sec;
14023 n2 = res.tv_usec;
14024 # endif
14025 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14026 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14028 #endif
14032 * "reltimestr()" function
14034 static void
14035 f_reltimestr(argvars, rettv)
14036 typval_T *argvars;
14037 typval_T *rettv;
14039 #ifdef FEAT_RELTIME
14040 proftime_T tm;
14041 #endif
14043 rettv->v_type = VAR_STRING;
14044 rettv->vval.v_string = NULL;
14045 #ifdef FEAT_RELTIME
14046 if (list2proftime(&argvars[0], &tm) == OK)
14047 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14048 #endif
14051 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14052 static void make_connection __ARGS((void));
14053 static int check_connection __ARGS((void));
14055 static void
14056 make_connection()
14058 if (X_DISPLAY == NULL
14059 # ifdef FEAT_GUI
14060 && !gui.in_use
14061 # endif
14064 x_force_connect = TRUE;
14065 setup_term_clip();
14066 x_force_connect = FALSE;
14070 static int
14071 check_connection()
14073 make_connection();
14074 if (X_DISPLAY == NULL)
14076 EMSG(_("E240: No connection to Vim server"));
14077 return FAIL;
14079 return OK;
14081 #endif
14083 #ifdef FEAT_CLIENTSERVER
14084 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14086 static void
14087 remote_common(argvars, rettv, expr)
14088 typval_T *argvars;
14089 typval_T *rettv;
14090 int expr;
14092 char_u *server_name;
14093 char_u *keys;
14094 char_u *r = NULL;
14095 char_u buf[NUMBUFLEN];
14096 # ifdef WIN32
14097 HWND w;
14098 # else
14099 Window w;
14100 # endif
14102 if (check_restricted() || check_secure())
14103 return;
14105 # ifdef FEAT_X11
14106 if (check_connection() == FAIL)
14107 return;
14108 # endif
14110 server_name = get_tv_string_chk(&argvars[0]);
14111 if (server_name == NULL)
14112 return; /* type error; errmsg already given */
14113 keys = get_tv_string_buf(&argvars[1], buf);
14114 # ifdef WIN32
14115 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14116 # else
14117 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14118 < 0)
14119 # endif
14121 if (r != NULL)
14122 EMSG(r); /* sending worked but evaluation failed */
14123 else
14124 EMSG2(_("E241: Unable to send to %s"), server_name);
14125 return;
14128 rettv->vval.v_string = r;
14130 if (argvars[2].v_type != VAR_UNKNOWN)
14132 dictitem_T v;
14133 char_u str[30];
14134 char_u *idvar;
14136 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14137 v.di_tv.v_type = VAR_STRING;
14138 v.di_tv.vval.v_string = vim_strsave(str);
14139 idvar = get_tv_string_chk(&argvars[2]);
14140 if (idvar != NULL)
14141 set_var(idvar, &v.di_tv, FALSE);
14142 vim_free(v.di_tv.vval.v_string);
14145 #endif
14148 * "remote_expr()" function
14150 /*ARGSUSED*/
14151 static void
14152 f_remote_expr(argvars, rettv)
14153 typval_T *argvars;
14154 typval_T *rettv;
14156 rettv->v_type = VAR_STRING;
14157 rettv->vval.v_string = NULL;
14158 #ifdef FEAT_CLIENTSERVER
14159 remote_common(argvars, rettv, TRUE);
14160 #endif
14164 * "remote_foreground()" function
14166 /*ARGSUSED*/
14167 static void
14168 f_remote_foreground(argvars, rettv)
14169 typval_T *argvars;
14170 typval_T *rettv;
14172 rettv->vval.v_number = 0;
14173 #ifdef FEAT_CLIENTSERVER
14174 # ifdef WIN32
14175 /* On Win32 it's done in this application. */
14177 char_u *server_name = get_tv_string_chk(&argvars[0]);
14179 if (server_name != NULL)
14180 serverForeground(server_name);
14182 # else
14183 /* Send a foreground() expression to the server. */
14184 argvars[1].v_type = VAR_STRING;
14185 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14186 argvars[2].v_type = VAR_UNKNOWN;
14187 remote_common(argvars, rettv, TRUE);
14188 vim_free(argvars[1].vval.v_string);
14189 # endif
14190 #endif
14193 /*ARGSUSED*/
14194 static void
14195 f_remote_peek(argvars, rettv)
14196 typval_T *argvars;
14197 typval_T *rettv;
14199 #ifdef FEAT_CLIENTSERVER
14200 dictitem_T v;
14201 char_u *s = NULL;
14202 # ifdef WIN32
14203 long_u n = 0;
14204 # endif
14205 char_u *serverid;
14207 if (check_restricted() || check_secure())
14209 rettv->vval.v_number = -1;
14210 return;
14212 serverid = get_tv_string_chk(&argvars[0]);
14213 if (serverid == NULL)
14215 rettv->vval.v_number = -1;
14216 return; /* type error; errmsg already given */
14218 # ifdef WIN32
14219 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14220 if (n == 0)
14221 rettv->vval.v_number = -1;
14222 else
14224 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14225 rettv->vval.v_number = (s != NULL);
14227 # else
14228 rettv->vval.v_number = 0;
14229 if (check_connection() == FAIL)
14230 return;
14232 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14233 serverStrToWin(serverid), &s);
14234 # endif
14236 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14238 char_u *retvar;
14240 v.di_tv.v_type = VAR_STRING;
14241 v.di_tv.vval.v_string = vim_strsave(s);
14242 retvar = get_tv_string_chk(&argvars[1]);
14243 if (retvar != NULL)
14244 set_var(retvar, &v.di_tv, FALSE);
14245 vim_free(v.di_tv.vval.v_string);
14247 #else
14248 rettv->vval.v_number = -1;
14249 #endif
14252 /*ARGSUSED*/
14253 static void
14254 f_remote_read(argvars, rettv)
14255 typval_T *argvars;
14256 typval_T *rettv;
14258 char_u *r = NULL;
14260 #ifdef FEAT_CLIENTSERVER
14261 char_u *serverid = get_tv_string_chk(&argvars[0]);
14263 if (serverid != NULL && !check_restricted() && !check_secure())
14265 # ifdef WIN32
14266 /* The server's HWND is encoded in the 'id' parameter */
14267 long_u n = 0;
14269 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14270 if (n != 0)
14271 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14272 if (r == NULL)
14273 # else
14274 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14275 serverStrToWin(serverid), &r, FALSE) < 0)
14276 # endif
14277 EMSG(_("E277: Unable to read a server reply"));
14279 #endif
14280 rettv->v_type = VAR_STRING;
14281 rettv->vval.v_string = r;
14285 * "remote_send()" function
14287 /*ARGSUSED*/
14288 static void
14289 f_remote_send(argvars, rettv)
14290 typval_T *argvars;
14291 typval_T *rettv;
14293 rettv->v_type = VAR_STRING;
14294 rettv->vval.v_string = NULL;
14295 #ifdef FEAT_CLIENTSERVER
14296 remote_common(argvars, rettv, FALSE);
14297 #endif
14301 * "remove()" function
14303 static void
14304 f_remove(argvars, rettv)
14305 typval_T *argvars;
14306 typval_T *rettv;
14308 list_T *l;
14309 listitem_T *item, *item2;
14310 listitem_T *li;
14311 long idx;
14312 long end;
14313 char_u *key;
14314 dict_T *d;
14315 dictitem_T *di;
14317 rettv->vval.v_number = 0;
14318 if (argvars[0].v_type == VAR_DICT)
14320 if (argvars[2].v_type != VAR_UNKNOWN)
14321 EMSG2(_(e_toomanyarg), "remove()");
14322 else if ((d = argvars[0].vval.v_dict) != NULL
14323 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14325 key = get_tv_string_chk(&argvars[1]);
14326 if (key != NULL)
14328 di = dict_find(d, key, -1);
14329 if (di == NULL)
14330 EMSG2(_(e_dictkey), key);
14331 else
14333 *rettv = di->di_tv;
14334 init_tv(&di->di_tv);
14335 dictitem_remove(d, di);
14340 else if (argvars[0].v_type != VAR_LIST)
14341 EMSG2(_(e_listdictarg), "remove()");
14342 else if ((l = argvars[0].vval.v_list) != NULL
14343 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14345 int error = FALSE;
14347 idx = get_tv_number_chk(&argvars[1], &error);
14348 if (error)
14349 ; /* type error: do nothing, errmsg already given */
14350 else if ((item = list_find(l, idx)) == NULL)
14351 EMSGN(_(e_listidx), idx);
14352 else
14354 if (argvars[2].v_type == VAR_UNKNOWN)
14356 /* Remove one item, return its value. */
14357 list_remove(l, item, item);
14358 *rettv = item->li_tv;
14359 vim_free(item);
14361 else
14363 /* Remove range of items, return list with values. */
14364 end = get_tv_number_chk(&argvars[2], &error);
14365 if (error)
14366 ; /* type error: do nothing */
14367 else if ((item2 = list_find(l, end)) == NULL)
14368 EMSGN(_(e_listidx), end);
14369 else
14371 int cnt = 0;
14373 for (li = item; li != NULL; li = li->li_next)
14375 ++cnt;
14376 if (li == item2)
14377 break;
14379 if (li == NULL) /* didn't find "item2" after "item" */
14380 EMSG(_(e_invrange));
14381 else
14383 list_remove(l, item, item2);
14384 if (rettv_list_alloc(rettv) == OK)
14386 l = rettv->vval.v_list;
14387 l->lv_first = item;
14388 l->lv_last = item2;
14389 item->li_prev = NULL;
14390 item2->li_next = NULL;
14391 l->lv_len = cnt;
14401 * "rename({from}, {to})" function
14403 static void
14404 f_rename(argvars, rettv)
14405 typval_T *argvars;
14406 typval_T *rettv;
14408 char_u buf[NUMBUFLEN];
14410 if (check_restricted() || check_secure())
14411 rettv->vval.v_number = -1;
14412 else
14413 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14414 get_tv_string_buf(&argvars[1], buf));
14418 * "repeat()" function
14420 /*ARGSUSED*/
14421 static void
14422 f_repeat(argvars, rettv)
14423 typval_T *argvars;
14424 typval_T *rettv;
14426 char_u *p;
14427 int n;
14428 int slen;
14429 int len;
14430 char_u *r;
14431 int i;
14433 n = get_tv_number(&argvars[1]);
14434 if (argvars[0].v_type == VAR_LIST)
14436 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14437 while (n-- > 0)
14438 if (list_extend(rettv->vval.v_list,
14439 argvars[0].vval.v_list, NULL) == FAIL)
14440 break;
14442 else
14444 p = get_tv_string(&argvars[0]);
14445 rettv->v_type = VAR_STRING;
14446 rettv->vval.v_string = NULL;
14448 slen = (int)STRLEN(p);
14449 len = slen * n;
14450 if (len <= 0)
14451 return;
14453 r = alloc(len + 1);
14454 if (r != NULL)
14456 for (i = 0; i < n; i++)
14457 mch_memmove(r + i * slen, p, (size_t)slen);
14458 r[len] = NUL;
14461 rettv->vval.v_string = r;
14466 * "resolve()" function
14468 static void
14469 f_resolve(argvars, rettv)
14470 typval_T *argvars;
14471 typval_T *rettv;
14473 char_u *p;
14475 p = get_tv_string(&argvars[0]);
14476 #ifdef FEAT_SHORTCUT
14478 char_u *v = NULL;
14480 v = mch_resolve_shortcut(p);
14481 if (v != NULL)
14482 rettv->vval.v_string = v;
14483 else
14484 rettv->vval.v_string = vim_strsave(p);
14486 #else
14487 # ifdef HAVE_READLINK
14489 char_u buf[MAXPATHL + 1];
14490 char_u *cpy;
14491 int len;
14492 char_u *remain = NULL;
14493 char_u *q;
14494 int is_relative_to_current = FALSE;
14495 int has_trailing_pathsep = FALSE;
14496 int limit = 100;
14498 p = vim_strsave(p);
14500 if (p[0] == '.' && (vim_ispathsep(p[1])
14501 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14502 is_relative_to_current = TRUE;
14504 len = STRLEN(p);
14505 if (len > 0 && after_pathsep(p, p + len))
14506 has_trailing_pathsep = TRUE;
14508 q = getnextcomp(p);
14509 if (*q != NUL)
14511 /* Separate the first path component in "p", and keep the
14512 * remainder (beginning with the path separator). */
14513 remain = vim_strsave(q - 1);
14514 q[-1] = NUL;
14517 for (;;)
14519 for (;;)
14521 len = readlink((char *)p, (char *)buf, MAXPATHL);
14522 if (len <= 0)
14523 break;
14524 buf[len] = NUL;
14526 if (limit-- == 0)
14528 vim_free(p);
14529 vim_free(remain);
14530 EMSG(_("E655: Too many symbolic links (cycle?)"));
14531 rettv->vval.v_string = NULL;
14532 goto fail;
14535 /* Ensure that the result will have a trailing path separator
14536 * if the argument has one. */
14537 if (remain == NULL && has_trailing_pathsep)
14538 add_pathsep(buf);
14540 /* Separate the first path component in the link value and
14541 * concatenate the remainders. */
14542 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14543 if (*q != NUL)
14545 if (remain == NULL)
14546 remain = vim_strsave(q - 1);
14547 else
14549 cpy = concat_str(q - 1, remain);
14550 if (cpy != NULL)
14552 vim_free(remain);
14553 remain = cpy;
14556 q[-1] = NUL;
14559 q = gettail(p);
14560 if (q > p && *q == NUL)
14562 /* Ignore trailing path separator. */
14563 q[-1] = NUL;
14564 q = gettail(p);
14566 if (q > p && !mch_isFullName(buf))
14568 /* symlink is relative to directory of argument */
14569 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14570 if (cpy != NULL)
14572 STRCPY(cpy, p);
14573 STRCPY(gettail(cpy), buf);
14574 vim_free(p);
14575 p = cpy;
14578 else
14580 vim_free(p);
14581 p = vim_strsave(buf);
14585 if (remain == NULL)
14586 break;
14588 /* Append the first path component of "remain" to "p". */
14589 q = getnextcomp(remain + 1);
14590 len = q - remain - (*q != NUL);
14591 cpy = vim_strnsave(p, STRLEN(p) + len);
14592 if (cpy != NULL)
14594 STRNCAT(cpy, remain, len);
14595 vim_free(p);
14596 p = cpy;
14598 /* Shorten "remain". */
14599 if (*q != NUL)
14600 STRMOVE(remain, q - 1);
14601 else
14603 vim_free(remain);
14604 remain = NULL;
14608 /* If the result is a relative path name, make it explicitly relative to
14609 * the current directory if and only if the argument had this form. */
14610 if (!vim_ispathsep(*p))
14612 if (is_relative_to_current
14613 && *p != NUL
14614 && !(p[0] == '.'
14615 && (p[1] == NUL
14616 || vim_ispathsep(p[1])
14617 || (p[1] == '.'
14618 && (p[2] == NUL
14619 || vim_ispathsep(p[2]))))))
14621 /* Prepend "./". */
14622 cpy = concat_str((char_u *)"./", p);
14623 if (cpy != NULL)
14625 vim_free(p);
14626 p = cpy;
14629 else if (!is_relative_to_current)
14631 /* Strip leading "./". */
14632 q = p;
14633 while (q[0] == '.' && vim_ispathsep(q[1]))
14634 q += 2;
14635 if (q > p)
14636 STRMOVE(p, p + 2);
14640 /* Ensure that the result will have no trailing path separator
14641 * if the argument had none. But keep "/" or "//". */
14642 if (!has_trailing_pathsep)
14644 q = p + STRLEN(p);
14645 if (after_pathsep(p, q))
14646 *gettail_sep(p) = NUL;
14649 rettv->vval.v_string = p;
14651 # else
14652 rettv->vval.v_string = vim_strsave(p);
14653 # endif
14654 #endif
14656 simplify_filename(rettv->vval.v_string);
14658 #ifdef HAVE_READLINK
14659 fail:
14660 #endif
14661 rettv->v_type = VAR_STRING;
14665 * "reverse({list})" function
14667 static void
14668 f_reverse(argvars, rettv)
14669 typval_T *argvars;
14670 typval_T *rettv;
14672 list_T *l;
14673 listitem_T *li, *ni;
14675 rettv->vval.v_number = 0;
14676 if (argvars[0].v_type != VAR_LIST)
14677 EMSG2(_(e_listarg), "reverse()");
14678 else if ((l = argvars[0].vval.v_list) != NULL
14679 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14681 li = l->lv_last;
14682 l->lv_first = l->lv_last = NULL;
14683 l->lv_len = 0;
14684 while (li != NULL)
14686 ni = li->li_prev;
14687 list_append(l, li);
14688 li = ni;
14690 rettv->vval.v_list = l;
14691 rettv->v_type = VAR_LIST;
14692 ++l->lv_refcount;
14693 l->lv_idx = l->lv_len - l->lv_idx - 1;
14697 #define SP_NOMOVE 0x01 /* don't move cursor */
14698 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14699 #define SP_RETCOUNT 0x04 /* return matchcount */
14700 #define SP_SETPCMARK 0x08 /* set previous context mark */
14701 #define SP_START 0x10 /* accept match at start position */
14702 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14703 #define SP_END 0x40 /* leave cursor at end of match */
14705 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14708 * Get flags for a search function.
14709 * Possibly sets "p_ws".
14710 * Returns BACKWARD, FORWARD or zero (for an error).
14712 static int
14713 get_search_arg(varp, flagsp)
14714 typval_T *varp;
14715 int *flagsp;
14717 int dir = FORWARD;
14718 char_u *flags;
14719 char_u nbuf[NUMBUFLEN];
14720 int mask;
14722 if (varp->v_type != VAR_UNKNOWN)
14724 flags = get_tv_string_buf_chk(varp, nbuf);
14725 if (flags == NULL)
14726 return 0; /* type error; errmsg already given */
14727 while (*flags != NUL)
14729 switch (*flags)
14731 case 'b': dir = BACKWARD; break;
14732 case 'w': p_ws = TRUE; break;
14733 case 'W': p_ws = FALSE; break;
14734 default: mask = 0;
14735 if (flagsp != NULL)
14736 switch (*flags)
14738 case 'c': mask = SP_START; break;
14739 case 'e': mask = SP_END; break;
14740 case 'm': mask = SP_RETCOUNT; break;
14741 case 'n': mask = SP_NOMOVE; break;
14742 case 'p': mask = SP_SUBPAT; break;
14743 case 'r': mask = SP_REPEAT; break;
14744 case 's': mask = SP_SETPCMARK; break;
14746 if (mask == 0)
14748 EMSG2(_(e_invarg2), flags);
14749 dir = 0;
14751 else
14752 *flagsp |= mask;
14754 if (dir == 0)
14755 break;
14756 ++flags;
14759 return dir;
14763 * Shared by search() and searchpos() functions
14765 static int
14766 search_cmn(argvars, match_pos, flagsp)
14767 typval_T *argvars;
14768 pos_T *match_pos;
14769 int *flagsp;
14771 int flags;
14772 char_u *pat;
14773 pos_T pos;
14774 pos_T save_cursor;
14775 int save_p_ws = p_ws;
14776 int dir;
14777 int retval = 0; /* default: FAIL */
14778 long lnum_stop = 0;
14779 proftime_T tm;
14780 #ifdef FEAT_RELTIME
14781 long time_limit = 0;
14782 #endif
14783 int options = SEARCH_KEEP;
14784 int subpatnum;
14786 pat = get_tv_string(&argvars[0]);
14787 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14788 if (dir == 0)
14789 goto theend;
14790 flags = *flagsp;
14791 if (flags & SP_START)
14792 options |= SEARCH_START;
14793 if (flags & SP_END)
14794 options |= SEARCH_END;
14796 /* Optional arguments: line number to stop searching and timeout. */
14797 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14799 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14800 if (lnum_stop < 0)
14801 goto theend;
14802 #ifdef FEAT_RELTIME
14803 if (argvars[3].v_type != VAR_UNKNOWN)
14805 time_limit = get_tv_number_chk(&argvars[3], NULL);
14806 if (time_limit < 0)
14807 goto theend;
14809 #endif
14812 #ifdef FEAT_RELTIME
14813 /* Set the time limit, if there is one. */
14814 profile_setlimit(time_limit, &tm);
14815 #endif
14818 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14819 * Check to make sure only those flags are set.
14820 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14821 * flags cannot be set. Check for that condition also.
14823 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14824 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14826 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14827 goto theend;
14830 pos = save_cursor = curwin->w_cursor;
14831 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14832 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14833 if (subpatnum != FAIL)
14835 if (flags & SP_SUBPAT)
14836 retval = subpatnum;
14837 else
14838 retval = pos.lnum;
14839 if (flags & SP_SETPCMARK)
14840 setpcmark();
14841 curwin->w_cursor = pos;
14842 if (match_pos != NULL)
14844 /* Store the match cursor position */
14845 match_pos->lnum = pos.lnum;
14846 match_pos->col = pos.col + 1;
14848 /* "/$" will put the cursor after the end of the line, may need to
14849 * correct that here */
14850 check_cursor();
14853 /* If 'n' flag is used: restore cursor position. */
14854 if (flags & SP_NOMOVE)
14855 curwin->w_cursor = save_cursor;
14856 else
14857 curwin->w_set_curswant = TRUE;
14858 theend:
14859 p_ws = save_p_ws;
14861 return retval;
14864 #ifdef FEAT_FLOAT
14866 * "round({float})" function
14868 static void
14869 f_round(argvars, rettv)
14870 typval_T *argvars;
14871 typval_T *rettv;
14873 float_T f;
14875 rettv->v_type = VAR_FLOAT;
14876 if (get_float_arg(argvars, &f) == OK)
14877 /* round() is not in C90, use ceil() or floor() instead. */
14878 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14879 else
14880 rettv->vval.v_float = 0.0;
14882 #endif
14885 * "search()" function
14887 static void
14888 f_search(argvars, rettv)
14889 typval_T *argvars;
14890 typval_T *rettv;
14892 int flags = 0;
14894 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14898 * "searchdecl()" function
14900 static void
14901 f_searchdecl(argvars, rettv)
14902 typval_T *argvars;
14903 typval_T *rettv;
14905 int locally = 1;
14906 int thisblock = 0;
14907 int error = FALSE;
14908 char_u *name;
14910 rettv->vval.v_number = 1; /* default: FAIL */
14912 name = get_tv_string_chk(&argvars[0]);
14913 if (argvars[1].v_type != VAR_UNKNOWN)
14915 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14916 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14917 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14919 if (!error && name != NULL)
14920 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14921 locally, thisblock, SEARCH_KEEP) == FAIL;
14925 * Used by searchpair() and searchpairpos()
14927 static int
14928 searchpair_cmn(argvars, match_pos)
14929 typval_T *argvars;
14930 pos_T *match_pos;
14932 char_u *spat, *mpat, *epat;
14933 char_u *skip;
14934 int save_p_ws = p_ws;
14935 int dir;
14936 int flags = 0;
14937 char_u nbuf1[NUMBUFLEN];
14938 char_u nbuf2[NUMBUFLEN];
14939 char_u nbuf3[NUMBUFLEN];
14940 int retval = 0; /* default: FAIL */
14941 long lnum_stop = 0;
14942 long time_limit = 0;
14944 /* Get the three pattern arguments: start, middle, end. */
14945 spat = get_tv_string_chk(&argvars[0]);
14946 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14947 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14948 if (spat == NULL || mpat == NULL || epat == NULL)
14949 goto theend; /* type error */
14951 /* Handle the optional fourth argument: flags */
14952 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14953 if (dir == 0)
14954 goto theend;
14956 /* Don't accept SP_END or SP_SUBPAT.
14957 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14959 if ((flags & (SP_END | SP_SUBPAT)) != 0
14960 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14962 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14963 goto theend;
14966 /* Using 'r' implies 'W', otherwise it doesn't work. */
14967 if (flags & SP_REPEAT)
14968 p_ws = FALSE;
14970 /* Optional fifth argument: skip expression */
14971 if (argvars[3].v_type == VAR_UNKNOWN
14972 || argvars[4].v_type == VAR_UNKNOWN)
14973 skip = (char_u *)"";
14974 else
14976 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14977 if (argvars[5].v_type != VAR_UNKNOWN)
14979 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14980 if (lnum_stop < 0)
14981 goto theend;
14982 #ifdef FEAT_RELTIME
14983 if (argvars[6].v_type != VAR_UNKNOWN)
14985 time_limit = get_tv_number_chk(&argvars[6], NULL);
14986 if (time_limit < 0)
14987 goto theend;
14989 #endif
14992 if (skip == NULL)
14993 goto theend; /* type error */
14995 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14996 match_pos, lnum_stop, time_limit);
14998 theend:
14999 p_ws = save_p_ws;
15001 return retval;
15005 * "searchpair()" function
15007 static void
15008 f_searchpair(argvars, rettv)
15009 typval_T *argvars;
15010 typval_T *rettv;
15012 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15016 * "searchpairpos()" function
15018 static void
15019 f_searchpairpos(argvars, rettv)
15020 typval_T *argvars;
15021 typval_T *rettv;
15023 pos_T match_pos;
15024 int lnum = 0;
15025 int col = 0;
15027 rettv->vval.v_number = 0;
15029 if (rettv_list_alloc(rettv) == FAIL)
15030 return;
15032 if (searchpair_cmn(argvars, &match_pos) > 0)
15034 lnum = match_pos.lnum;
15035 col = match_pos.col;
15038 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15039 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15043 * Search for a start/middle/end thing.
15044 * Used by searchpair(), see its documentation for the details.
15045 * Returns 0 or -1 for no match,
15047 long
15048 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15049 lnum_stop, time_limit)
15050 char_u *spat; /* start pattern */
15051 char_u *mpat; /* middle pattern */
15052 char_u *epat; /* end pattern */
15053 int dir; /* BACKWARD or FORWARD */
15054 char_u *skip; /* skip expression */
15055 int flags; /* SP_SETPCMARK and other SP_ values */
15056 pos_T *match_pos;
15057 linenr_T lnum_stop; /* stop at this line if not zero */
15058 long time_limit; /* stop after this many msec */
15060 char_u *save_cpo;
15061 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15062 long retval = 0;
15063 pos_T pos;
15064 pos_T firstpos;
15065 pos_T foundpos;
15066 pos_T save_cursor;
15067 pos_T save_pos;
15068 int n;
15069 int r;
15070 int nest = 1;
15071 int err;
15072 int options = SEARCH_KEEP;
15073 proftime_T tm;
15075 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15076 save_cpo = p_cpo;
15077 p_cpo = empty_option;
15079 #ifdef FEAT_RELTIME
15080 /* Set the time limit, if there is one. */
15081 profile_setlimit(time_limit, &tm);
15082 #endif
15084 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15085 * start/middle/end (pat3, for the top pair). */
15086 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15087 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15088 if (pat2 == NULL || pat3 == NULL)
15089 goto theend;
15090 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15091 if (*mpat == NUL)
15092 STRCPY(pat3, pat2);
15093 else
15094 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15095 spat, epat, mpat);
15096 if (flags & SP_START)
15097 options |= SEARCH_START;
15099 save_cursor = curwin->w_cursor;
15100 pos = curwin->w_cursor;
15101 clearpos(&firstpos);
15102 clearpos(&foundpos);
15103 pat = pat3;
15104 for (;;)
15106 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15107 options, RE_SEARCH, lnum_stop, &tm);
15108 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15109 /* didn't find it or found the first match again: FAIL */
15110 break;
15112 if (firstpos.lnum == 0)
15113 firstpos = pos;
15114 if (equalpos(pos, foundpos))
15116 /* Found the same position again. Can happen with a pattern that
15117 * has "\zs" at the end and searching backwards. Advance one
15118 * character and try again. */
15119 if (dir == BACKWARD)
15120 decl(&pos);
15121 else
15122 incl(&pos);
15124 foundpos = pos;
15126 /* clear the start flag to avoid getting stuck here */
15127 options &= ~SEARCH_START;
15129 /* If the skip pattern matches, ignore this match. */
15130 if (*skip != NUL)
15132 save_pos = curwin->w_cursor;
15133 curwin->w_cursor = pos;
15134 r = eval_to_bool(skip, &err, NULL, FALSE);
15135 curwin->w_cursor = save_pos;
15136 if (err)
15138 /* Evaluating {skip} caused an error, break here. */
15139 curwin->w_cursor = save_cursor;
15140 retval = -1;
15141 break;
15143 if (r)
15144 continue;
15147 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15149 /* Found end when searching backwards or start when searching
15150 * forward: nested pair. */
15151 ++nest;
15152 pat = pat2; /* nested, don't search for middle */
15154 else
15156 /* Found end when searching forward or start when searching
15157 * backward: end of (nested) pair; or found middle in outer pair. */
15158 if (--nest == 1)
15159 pat = pat3; /* outer level, search for middle */
15162 if (nest == 0)
15164 /* Found the match: return matchcount or line number. */
15165 if (flags & SP_RETCOUNT)
15166 ++retval;
15167 else
15168 retval = pos.lnum;
15169 if (flags & SP_SETPCMARK)
15170 setpcmark();
15171 curwin->w_cursor = pos;
15172 if (!(flags & SP_REPEAT))
15173 break;
15174 nest = 1; /* search for next unmatched */
15178 if (match_pos != NULL)
15180 /* Store the match cursor position */
15181 match_pos->lnum = curwin->w_cursor.lnum;
15182 match_pos->col = curwin->w_cursor.col + 1;
15185 /* If 'n' flag is used or search failed: restore cursor position. */
15186 if ((flags & SP_NOMOVE) || retval == 0)
15187 curwin->w_cursor = save_cursor;
15189 theend:
15190 vim_free(pat2);
15191 vim_free(pat3);
15192 if (p_cpo == empty_option)
15193 p_cpo = save_cpo;
15194 else
15195 /* Darn, evaluating the {skip} expression changed the value. */
15196 free_string_option(save_cpo);
15198 return retval;
15202 * "searchpos()" function
15204 static void
15205 f_searchpos(argvars, rettv)
15206 typval_T *argvars;
15207 typval_T *rettv;
15209 pos_T match_pos;
15210 int lnum = 0;
15211 int col = 0;
15212 int n;
15213 int flags = 0;
15215 rettv->vval.v_number = 0;
15217 if (rettv_list_alloc(rettv) == FAIL)
15218 return;
15220 n = search_cmn(argvars, &match_pos, &flags);
15221 if (n > 0)
15223 lnum = match_pos.lnum;
15224 col = match_pos.col;
15227 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15228 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15229 if (flags & SP_SUBPAT)
15230 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15234 /*ARGSUSED*/
15235 static void
15236 f_server2client(argvars, rettv)
15237 typval_T *argvars;
15238 typval_T *rettv;
15240 #ifdef FEAT_CLIENTSERVER
15241 char_u buf[NUMBUFLEN];
15242 char_u *server = get_tv_string_chk(&argvars[0]);
15243 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15245 rettv->vval.v_number = -1;
15246 if (server == NULL || reply == NULL)
15247 return;
15248 if (check_restricted() || check_secure())
15249 return;
15250 # ifdef FEAT_X11
15251 if (check_connection() == FAIL)
15252 return;
15253 # endif
15255 if (serverSendReply(server, reply) < 0)
15257 EMSG(_("E258: Unable to send to client"));
15258 return;
15260 rettv->vval.v_number = 0;
15261 #else
15262 rettv->vval.v_number = -1;
15263 #endif
15266 /*ARGSUSED*/
15267 static void
15268 f_serverlist(argvars, rettv)
15269 typval_T *argvars;
15270 typval_T *rettv;
15272 char_u *r = NULL;
15274 #ifdef FEAT_CLIENTSERVER
15275 # ifdef WIN32
15276 r = serverGetVimNames();
15277 # else
15278 make_connection();
15279 if (X_DISPLAY != NULL)
15280 r = serverGetVimNames(X_DISPLAY);
15281 # endif
15282 #endif
15283 rettv->v_type = VAR_STRING;
15284 rettv->vval.v_string = r;
15288 * "setbufvar()" function
15290 /*ARGSUSED*/
15291 static void
15292 f_setbufvar(argvars, rettv)
15293 typval_T *argvars;
15294 typval_T *rettv;
15296 buf_T *buf;
15297 aco_save_T aco;
15298 char_u *varname, *bufvarname;
15299 typval_T *varp;
15300 char_u nbuf[NUMBUFLEN];
15302 rettv->vval.v_number = 0;
15304 if (check_restricted() || check_secure())
15305 return;
15306 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15307 varname = get_tv_string_chk(&argvars[1]);
15308 buf = get_buf_tv(&argvars[0]);
15309 varp = &argvars[2];
15311 if (buf != NULL && varname != NULL && varp != NULL)
15313 /* set curbuf to be our buf, temporarily */
15314 aucmd_prepbuf(&aco, buf);
15316 if (*varname == '&')
15318 long numval;
15319 char_u *strval;
15320 int error = FALSE;
15322 ++varname;
15323 numval = get_tv_number_chk(varp, &error);
15324 strval = get_tv_string_buf_chk(varp, nbuf);
15325 if (!error && strval != NULL)
15326 set_option_value(varname, numval, strval, OPT_LOCAL);
15328 else
15330 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15331 if (bufvarname != NULL)
15333 STRCPY(bufvarname, "b:");
15334 STRCPY(bufvarname + 2, varname);
15335 set_var(bufvarname, varp, TRUE);
15336 vim_free(bufvarname);
15340 /* reset notion of buffer */
15341 aucmd_restbuf(&aco);
15346 * "setcmdpos()" function
15348 static void
15349 f_setcmdpos(argvars, rettv)
15350 typval_T *argvars;
15351 typval_T *rettv;
15353 int pos = (int)get_tv_number(&argvars[0]) - 1;
15355 if (pos >= 0)
15356 rettv->vval.v_number = set_cmdline_pos(pos);
15360 * "setline()" function
15362 static void
15363 f_setline(argvars, rettv)
15364 typval_T *argvars;
15365 typval_T *rettv;
15367 linenr_T lnum;
15368 char_u *line = NULL;
15369 list_T *l = NULL;
15370 listitem_T *li = NULL;
15371 long added = 0;
15372 linenr_T lcount = curbuf->b_ml.ml_line_count;
15374 lnum = get_tv_lnum(&argvars[0]);
15375 if (argvars[1].v_type == VAR_LIST)
15377 l = argvars[1].vval.v_list;
15378 li = l->lv_first;
15380 else
15381 line = get_tv_string_chk(&argvars[1]);
15383 rettv->vval.v_number = 0; /* OK */
15384 for (;;)
15386 if (l != NULL)
15388 /* list argument, get next string */
15389 if (li == NULL)
15390 break;
15391 line = get_tv_string_chk(&li->li_tv);
15392 li = li->li_next;
15395 rettv->vval.v_number = 1; /* FAIL */
15396 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15397 break;
15398 if (lnum <= curbuf->b_ml.ml_line_count)
15400 /* existing line, replace it */
15401 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15403 changed_bytes(lnum, 0);
15404 if (lnum == curwin->w_cursor.lnum)
15405 check_cursor_col();
15406 rettv->vval.v_number = 0; /* OK */
15409 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15411 /* lnum is one past the last line, append the line */
15412 ++added;
15413 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15414 rettv->vval.v_number = 0; /* OK */
15417 if (l == NULL) /* only one string argument */
15418 break;
15419 ++lnum;
15422 if (added > 0)
15423 appended_lines_mark(lcount, added);
15426 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15429 * Used by "setqflist()" and "setloclist()" functions
15431 /*ARGSUSED*/
15432 static void
15433 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15434 win_T *wp;
15435 typval_T *list_arg;
15436 typval_T *action_arg;
15437 typval_T *rettv;
15439 #ifdef FEAT_QUICKFIX
15440 char_u *act;
15441 int action = ' ';
15442 #endif
15444 rettv->vval.v_number = -1;
15446 #ifdef FEAT_QUICKFIX
15447 if (list_arg->v_type != VAR_LIST)
15448 EMSG(_(e_listreq));
15449 else
15451 list_T *l = list_arg->vval.v_list;
15453 if (action_arg->v_type == VAR_STRING)
15455 act = get_tv_string_chk(action_arg);
15456 if (act == NULL)
15457 return; /* type error; errmsg already given */
15458 if (*act == 'a' || *act == 'r')
15459 action = *act;
15462 if (l != NULL && set_errorlist(wp, l, action) == OK)
15463 rettv->vval.v_number = 0;
15465 #endif
15469 * "setloclist()" function
15471 /*ARGSUSED*/
15472 static void
15473 f_setloclist(argvars, rettv)
15474 typval_T *argvars;
15475 typval_T *rettv;
15477 win_T *win;
15479 rettv->vval.v_number = -1;
15481 win = find_win_by_nr(&argvars[0], NULL);
15482 if (win != NULL)
15483 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15487 * "setmatches()" function
15489 static void
15490 f_setmatches(argvars, rettv)
15491 typval_T *argvars;
15492 typval_T *rettv;
15494 #ifdef FEAT_SEARCH_EXTRA
15495 list_T *l;
15496 listitem_T *li;
15497 dict_T *d;
15499 rettv->vval.v_number = -1;
15500 if (argvars[0].v_type != VAR_LIST)
15502 EMSG(_(e_listreq));
15503 return;
15505 if ((l = argvars[0].vval.v_list) != NULL)
15508 /* To some extent make sure that we are dealing with a list from
15509 * "getmatches()". */
15510 li = l->lv_first;
15511 while (li != NULL)
15513 if (li->li_tv.v_type != VAR_DICT
15514 || (d = li->li_tv.vval.v_dict) == NULL)
15516 EMSG(_(e_invarg));
15517 return;
15519 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15520 && dict_find(d, (char_u *)"pattern", -1) != NULL
15521 && dict_find(d, (char_u *)"priority", -1) != NULL
15522 && dict_find(d, (char_u *)"id", -1) != NULL))
15524 EMSG(_(e_invarg));
15525 return;
15527 li = li->li_next;
15530 clear_matches(curwin);
15531 li = l->lv_first;
15532 while (li != NULL)
15534 d = li->li_tv.vval.v_dict;
15535 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15536 get_dict_string(d, (char_u *)"pattern", FALSE),
15537 (int)get_dict_number(d, (char_u *)"priority"),
15538 (int)get_dict_number(d, (char_u *)"id"));
15539 li = li->li_next;
15541 rettv->vval.v_number = 0;
15543 #endif
15547 * "setpos()" function
15549 /*ARGSUSED*/
15550 static void
15551 f_setpos(argvars, rettv)
15552 typval_T *argvars;
15553 typval_T *rettv;
15555 pos_T pos;
15556 int fnum;
15557 char_u *name;
15559 rettv->vval.v_number = -1;
15560 name = get_tv_string_chk(argvars);
15561 if (name != NULL)
15563 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15565 --pos.col;
15566 if (name[0] == '.' && name[1] == NUL)
15568 /* set cursor */
15569 if (fnum == curbuf->b_fnum)
15571 curwin->w_cursor = pos;
15572 check_cursor();
15573 rettv->vval.v_number = 0;
15575 else
15576 EMSG(_(e_invarg));
15578 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15580 /* set mark */
15581 if (setmark_pos(name[1], &pos, fnum) == OK)
15582 rettv->vval.v_number = 0;
15584 else
15585 EMSG(_(e_invarg));
15591 * "setqflist()" function
15593 /*ARGSUSED*/
15594 static void
15595 f_setqflist(argvars, rettv)
15596 typval_T *argvars;
15597 typval_T *rettv;
15599 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15603 * "setreg()" function
15605 static void
15606 f_setreg(argvars, rettv)
15607 typval_T *argvars;
15608 typval_T *rettv;
15610 int regname;
15611 char_u *strregname;
15612 char_u *stropt;
15613 char_u *strval;
15614 int append;
15615 char_u yank_type;
15616 long block_len;
15618 block_len = -1;
15619 yank_type = MAUTO;
15620 append = FALSE;
15622 strregname = get_tv_string_chk(argvars);
15623 rettv->vval.v_number = 1; /* FAIL is default */
15625 if (strregname == NULL)
15626 return; /* type error; errmsg already given */
15627 regname = *strregname;
15628 if (regname == 0 || regname == '@')
15629 regname = '"';
15630 else if (regname == '=')
15631 return;
15633 if (argvars[2].v_type != VAR_UNKNOWN)
15635 stropt = get_tv_string_chk(&argvars[2]);
15636 if (stropt == NULL)
15637 return; /* type error */
15638 for (; *stropt != NUL; ++stropt)
15639 switch (*stropt)
15641 case 'a': case 'A': /* append */
15642 append = TRUE;
15643 break;
15644 case 'v': case 'c': /* character-wise selection */
15645 yank_type = MCHAR;
15646 break;
15647 case 'V': case 'l': /* line-wise selection */
15648 yank_type = MLINE;
15649 break;
15650 #ifdef FEAT_VISUAL
15651 case 'b': case Ctrl_V: /* block-wise selection */
15652 yank_type = MBLOCK;
15653 if (VIM_ISDIGIT(stropt[1]))
15655 ++stropt;
15656 block_len = getdigits(&stropt) - 1;
15657 --stropt;
15659 break;
15660 #endif
15664 strval = get_tv_string_chk(&argvars[1]);
15665 if (strval != NULL)
15666 write_reg_contents_ex(regname, strval, -1,
15667 append, yank_type, block_len);
15668 rettv->vval.v_number = 0;
15672 * "settabwinvar()" function
15674 static void
15675 f_settabwinvar(argvars, rettv)
15676 typval_T *argvars;
15677 typval_T *rettv;
15679 setwinvar(argvars, rettv, 1);
15683 * "setwinvar()" function
15685 static void
15686 f_setwinvar(argvars, rettv)
15687 typval_T *argvars;
15688 typval_T *rettv;
15690 setwinvar(argvars, rettv, 0);
15694 * "setwinvar()" and "settabwinvar()" functions
15696 static void
15697 setwinvar(argvars, rettv, off)
15698 typval_T *argvars;
15699 typval_T *rettv;
15700 int off;
15702 win_T *win;
15703 #ifdef FEAT_WINDOWS
15704 win_T *save_curwin;
15705 tabpage_T *save_curtab;
15706 #endif
15707 char_u *varname, *winvarname;
15708 typval_T *varp;
15709 char_u nbuf[NUMBUFLEN];
15710 tabpage_T *tp;
15712 rettv->vval.v_number = 0;
15714 if (check_restricted() || check_secure())
15715 return;
15717 #ifdef FEAT_WINDOWS
15718 if (off == 1)
15719 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15720 else
15721 tp = curtab;
15722 #endif
15723 win = find_win_by_nr(&argvars[off], tp);
15724 varname = get_tv_string_chk(&argvars[off + 1]);
15725 varp = &argvars[off + 2];
15727 if (win != NULL && varname != NULL && varp != NULL)
15729 #ifdef FEAT_WINDOWS
15730 /* set curwin to be our win, temporarily */
15731 save_curwin = curwin;
15732 save_curtab = curtab;
15733 goto_tabpage_tp(tp);
15734 if (!win_valid(win))
15735 return;
15736 curwin = win;
15737 curbuf = curwin->w_buffer;
15738 #endif
15740 if (*varname == '&')
15742 long numval;
15743 char_u *strval;
15744 int error = FALSE;
15746 ++varname;
15747 numval = get_tv_number_chk(varp, &error);
15748 strval = get_tv_string_buf_chk(varp, nbuf);
15749 if (!error && strval != NULL)
15750 set_option_value(varname, numval, strval, OPT_LOCAL);
15752 else
15754 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15755 if (winvarname != NULL)
15757 STRCPY(winvarname, "w:");
15758 STRCPY(winvarname + 2, varname);
15759 set_var(winvarname, varp, TRUE);
15760 vim_free(winvarname);
15764 #ifdef FEAT_WINDOWS
15765 /* Restore current tabpage and window, if still valid (autocomands can
15766 * make them invalid). */
15767 if (valid_tabpage(save_curtab))
15768 goto_tabpage_tp(save_curtab);
15769 if (win_valid(save_curwin))
15771 curwin = save_curwin;
15772 curbuf = curwin->w_buffer;
15774 #endif
15779 * "shellescape({string})" function
15781 static void
15782 f_shellescape(argvars, rettv)
15783 typval_T *argvars;
15784 typval_T *rettv;
15786 rettv->vval.v_string = vim_strsave_shellescape(
15787 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15788 rettv->v_type = VAR_STRING;
15792 * "simplify()" function
15794 static void
15795 f_simplify(argvars, rettv)
15796 typval_T *argvars;
15797 typval_T *rettv;
15799 char_u *p;
15801 p = get_tv_string(&argvars[0]);
15802 rettv->vval.v_string = vim_strsave(p);
15803 simplify_filename(rettv->vval.v_string); /* simplify in place */
15804 rettv->v_type = VAR_STRING;
15807 #ifdef FEAT_FLOAT
15809 * "sin()" function
15811 static void
15812 f_sin(argvars, rettv)
15813 typval_T *argvars;
15814 typval_T *rettv;
15816 float_T f;
15818 rettv->v_type = VAR_FLOAT;
15819 if (get_float_arg(argvars, &f) == OK)
15820 rettv->vval.v_float = sin(f);
15821 else
15822 rettv->vval.v_float = 0.0;
15824 #endif
15826 static int
15827 #ifdef __BORLANDC__
15828 _RTLENTRYF
15829 #endif
15830 item_compare __ARGS((const void *s1, const void *s2));
15831 static int
15832 #ifdef __BORLANDC__
15833 _RTLENTRYF
15834 #endif
15835 item_compare2 __ARGS((const void *s1, const void *s2));
15837 static int item_compare_ic;
15838 static char_u *item_compare_func;
15839 static int item_compare_func_err;
15840 #define ITEM_COMPARE_FAIL 999
15843 * Compare functions for f_sort() below.
15845 static int
15846 #ifdef __BORLANDC__
15847 _RTLENTRYF
15848 #endif
15849 item_compare(s1, s2)
15850 const void *s1;
15851 const void *s2;
15853 char_u *p1, *p2;
15854 char_u *tofree1, *tofree2;
15855 int res;
15856 char_u numbuf1[NUMBUFLEN];
15857 char_u numbuf2[NUMBUFLEN];
15859 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15860 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15861 if (p1 == NULL)
15862 p1 = (char_u *)"";
15863 if (p2 == NULL)
15864 p2 = (char_u *)"";
15865 if (item_compare_ic)
15866 res = STRICMP(p1, p2);
15867 else
15868 res = STRCMP(p1, p2);
15869 vim_free(tofree1);
15870 vim_free(tofree2);
15871 return res;
15874 static int
15875 #ifdef __BORLANDC__
15876 _RTLENTRYF
15877 #endif
15878 item_compare2(s1, s2)
15879 const void *s1;
15880 const void *s2;
15882 int res;
15883 typval_T rettv;
15884 typval_T argv[3];
15885 int dummy;
15887 /* shortcut after failure in previous call; compare all items equal */
15888 if (item_compare_func_err)
15889 return 0;
15891 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15892 * in the copy without changing the original list items. */
15893 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15894 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15896 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15897 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15898 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15899 clear_tv(&argv[0]);
15900 clear_tv(&argv[1]);
15902 if (res == FAIL)
15903 res = ITEM_COMPARE_FAIL;
15904 else
15905 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15906 if (item_compare_func_err)
15907 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15908 clear_tv(&rettv);
15909 return res;
15913 * "sort({list})" function
15915 static void
15916 f_sort(argvars, rettv)
15917 typval_T *argvars;
15918 typval_T *rettv;
15920 list_T *l;
15921 listitem_T *li;
15922 listitem_T **ptrs;
15923 long len;
15924 long i;
15926 rettv->vval.v_number = 0;
15927 if (argvars[0].v_type != VAR_LIST)
15928 EMSG2(_(e_listarg), "sort()");
15929 else
15931 l = argvars[0].vval.v_list;
15932 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15933 return;
15934 rettv->vval.v_list = l;
15935 rettv->v_type = VAR_LIST;
15936 ++l->lv_refcount;
15938 len = list_len(l);
15939 if (len <= 1)
15940 return; /* short list sorts pretty quickly */
15942 item_compare_ic = FALSE;
15943 item_compare_func = NULL;
15944 if (argvars[1].v_type != VAR_UNKNOWN)
15946 if (argvars[1].v_type == VAR_FUNC)
15947 item_compare_func = argvars[1].vval.v_string;
15948 else
15950 int error = FALSE;
15952 i = get_tv_number_chk(&argvars[1], &error);
15953 if (error)
15954 return; /* type error; errmsg already given */
15955 if (i == 1)
15956 item_compare_ic = TRUE;
15957 else
15958 item_compare_func = get_tv_string(&argvars[1]);
15962 /* Make an array with each entry pointing to an item in the List. */
15963 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15964 if (ptrs == NULL)
15965 return;
15966 i = 0;
15967 for (li = l->lv_first; li != NULL; li = li->li_next)
15968 ptrs[i++] = li;
15970 item_compare_func_err = FALSE;
15971 /* test the compare function */
15972 if (item_compare_func != NULL
15973 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15974 == ITEM_COMPARE_FAIL)
15975 EMSG(_("E702: Sort compare function failed"));
15976 else
15978 /* Sort the array with item pointers. */
15979 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15980 item_compare_func == NULL ? item_compare : item_compare2);
15982 if (!item_compare_func_err)
15984 /* Clear the List and append the items in the sorted order. */
15985 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15986 l->lv_len = 0;
15987 for (i = 0; i < len; ++i)
15988 list_append(l, ptrs[i]);
15992 vim_free(ptrs);
15997 * "soundfold({word})" function
15999 static void
16000 f_soundfold(argvars, rettv)
16001 typval_T *argvars;
16002 typval_T *rettv;
16004 char_u *s;
16006 rettv->v_type = VAR_STRING;
16007 s = get_tv_string(&argvars[0]);
16008 #ifdef FEAT_SPELL
16009 rettv->vval.v_string = eval_soundfold(s);
16010 #else
16011 rettv->vval.v_string = vim_strsave(s);
16012 #endif
16016 * "spellbadword()" function
16018 /* ARGSUSED */
16019 static void
16020 f_spellbadword(argvars, rettv)
16021 typval_T *argvars;
16022 typval_T *rettv;
16024 char_u *word = (char_u *)"";
16025 hlf_T attr = HLF_COUNT;
16026 int len = 0;
16028 if (rettv_list_alloc(rettv) == FAIL)
16029 return;
16031 #ifdef FEAT_SPELL
16032 if (argvars[0].v_type == VAR_UNKNOWN)
16034 /* Find the start and length of the badly spelled word. */
16035 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16036 if (len != 0)
16037 word = ml_get_cursor();
16039 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16041 char_u *str = get_tv_string_chk(&argvars[0]);
16042 int capcol = -1;
16044 if (str != NULL)
16046 /* Check the argument for spelling. */
16047 while (*str != NUL)
16049 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16050 if (attr != HLF_COUNT)
16052 word = str;
16053 break;
16055 str += len;
16059 #endif
16061 list_append_string(rettv->vval.v_list, word, len);
16062 list_append_string(rettv->vval.v_list, (char_u *)(
16063 attr == HLF_SPB ? "bad" :
16064 attr == HLF_SPR ? "rare" :
16065 attr == HLF_SPL ? "local" :
16066 attr == HLF_SPC ? "caps" :
16067 ""), -1);
16071 * "spellsuggest()" function
16073 /*ARGSUSED*/
16074 static void
16075 f_spellsuggest(argvars, rettv)
16076 typval_T *argvars;
16077 typval_T *rettv;
16079 #ifdef FEAT_SPELL
16080 char_u *str;
16081 int typeerr = FALSE;
16082 int maxcount;
16083 garray_T ga;
16084 int i;
16085 listitem_T *li;
16086 int need_capital = FALSE;
16087 #endif
16089 if (rettv_list_alloc(rettv) == FAIL)
16090 return;
16092 #ifdef FEAT_SPELL
16093 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16095 str = get_tv_string(&argvars[0]);
16096 if (argvars[1].v_type != VAR_UNKNOWN)
16098 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16099 if (maxcount <= 0)
16100 return;
16101 if (argvars[2].v_type != VAR_UNKNOWN)
16103 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16104 if (typeerr)
16105 return;
16108 else
16109 maxcount = 25;
16111 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16113 for (i = 0; i < ga.ga_len; ++i)
16115 str = ((char_u **)ga.ga_data)[i];
16117 li = listitem_alloc();
16118 if (li == NULL)
16119 vim_free(str);
16120 else
16122 li->li_tv.v_type = VAR_STRING;
16123 li->li_tv.v_lock = 0;
16124 li->li_tv.vval.v_string = str;
16125 list_append(rettv->vval.v_list, li);
16128 ga_clear(&ga);
16130 #endif
16133 static void
16134 f_split(argvars, rettv)
16135 typval_T *argvars;
16136 typval_T *rettv;
16138 char_u *str;
16139 char_u *end;
16140 char_u *pat = NULL;
16141 regmatch_T regmatch;
16142 char_u patbuf[NUMBUFLEN];
16143 char_u *save_cpo;
16144 int match;
16145 colnr_T col = 0;
16146 int keepempty = FALSE;
16147 int typeerr = FALSE;
16149 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16150 save_cpo = p_cpo;
16151 p_cpo = (char_u *)"";
16153 str = get_tv_string(&argvars[0]);
16154 if (argvars[1].v_type != VAR_UNKNOWN)
16156 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16157 if (pat == NULL)
16158 typeerr = TRUE;
16159 if (argvars[2].v_type != VAR_UNKNOWN)
16160 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16162 if (pat == NULL || *pat == NUL)
16163 pat = (char_u *)"[\\x01- ]\\+";
16165 if (rettv_list_alloc(rettv) == FAIL)
16166 return;
16167 if (typeerr)
16168 return;
16170 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16171 if (regmatch.regprog != NULL)
16173 regmatch.rm_ic = FALSE;
16174 while (*str != NUL || keepempty)
16176 if (*str == NUL)
16177 match = FALSE; /* empty item at the end */
16178 else
16179 match = vim_regexec_nl(&regmatch, str, col);
16180 if (match)
16181 end = regmatch.startp[0];
16182 else
16183 end = str + STRLEN(str);
16184 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16185 && *str != NUL && match && end < regmatch.endp[0]))
16187 if (list_append_string(rettv->vval.v_list, str,
16188 (int)(end - str)) == FAIL)
16189 break;
16191 if (!match)
16192 break;
16193 /* Advance to just after the match. */
16194 if (regmatch.endp[0] > str)
16195 col = 0;
16196 else
16198 /* Don't get stuck at the same match. */
16199 #ifdef FEAT_MBYTE
16200 col = (*mb_ptr2len)(regmatch.endp[0]);
16201 #else
16202 col = 1;
16203 #endif
16205 str = regmatch.endp[0];
16208 vim_free(regmatch.regprog);
16211 p_cpo = save_cpo;
16214 #ifdef FEAT_FLOAT
16216 * "sqrt()" function
16218 static void
16219 f_sqrt(argvars, rettv)
16220 typval_T *argvars;
16221 typval_T *rettv;
16223 float_T f;
16225 rettv->v_type = VAR_FLOAT;
16226 if (get_float_arg(argvars, &f) == OK)
16227 rettv->vval.v_float = sqrt(f);
16228 else
16229 rettv->vval.v_float = 0.0;
16233 * "str2float()" function
16235 static void
16236 f_str2float(argvars, rettv)
16237 typval_T *argvars;
16238 typval_T *rettv;
16240 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16242 if (*p == '+')
16243 p = skipwhite(p + 1);
16244 (void)string2float(p, &rettv->vval.v_float);
16245 rettv->v_type = VAR_FLOAT;
16247 #endif
16250 * "str2nr()" function
16252 static void
16253 f_str2nr(argvars, rettv)
16254 typval_T *argvars;
16255 typval_T *rettv;
16257 int base = 10;
16258 char_u *p;
16259 long n;
16261 if (argvars[1].v_type != VAR_UNKNOWN)
16263 base = get_tv_number(&argvars[1]);
16264 if (base != 8 && base != 10 && base != 16)
16266 EMSG(_(e_invarg));
16267 return;
16271 p = skipwhite(get_tv_string(&argvars[0]));
16272 if (*p == '+')
16273 p = skipwhite(p + 1);
16274 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16275 rettv->vval.v_number = n;
16278 #ifdef HAVE_STRFTIME
16280 * "strftime({format}[, {time}])" function
16282 static void
16283 f_strftime(argvars, rettv)
16284 typval_T *argvars;
16285 typval_T *rettv;
16287 char_u result_buf[256];
16288 struct tm *curtime;
16289 time_t seconds;
16290 char_u *p;
16292 rettv->v_type = VAR_STRING;
16294 p = get_tv_string(&argvars[0]);
16295 if (argvars[1].v_type == VAR_UNKNOWN)
16296 seconds = time(NULL);
16297 else
16298 seconds = (time_t)get_tv_number(&argvars[1]);
16299 curtime = localtime(&seconds);
16300 /* MSVC returns NULL for an invalid value of seconds. */
16301 if (curtime == NULL)
16302 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16303 else
16305 # ifdef FEAT_MBYTE
16306 vimconv_T conv;
16307 char_u *enc;
16309 conv.vc_type = CONV_NONE;
16310 enc = enc_locale();
16311 convert_setup(&conv, p_enc, enc);
16312 if (conv.vc_type != CONV_NONE)
16313 p = string_convert(&conv, p, NULL);
16314 # endif
16315 if (p != NULL)
16316 (void)strftime((char *)result_buf, sizeof(result_buf),
16317 (char *)p, curtime);
16318 else
16319 result_buf[0] = NUL;
16321 # ifdef FEAT_MBYTE
16322 if (conv.vc_type != CONV_NONE)
16323 vim_free(p);
16324 convert_setup(&conv, enc, p_enc);
16325 if (conv.vc_type != CONV_NONE)
16326 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16327 else
16328 # endif
16329 rettv->vval.v_string = vim_strsave(result_buf);
16331 # ifdef FEAT_MBYTE
16332 /* Release conversion descriptors */
16333 convert_setup(&conv, NULL, NULL);
16334 vim_free(enc);
16335 # endif
16338 #endif
16341 * "stridx()" function
16343 static void
16344 f_stridx(argvars, rettv)
16345 typval_T *argvars;
16346 typval_T *rettv;
16348 char_u buf[NUMBUFLEN];
16349 char_u *needle;
16350 char_u *haystack;
16351 char_u *save_haystack;
16352 char_u *pos;
16353 int start_idx;
16355 needle = get_tv_string_chk(&argvars[1]);
16356 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16357 rettv->vval.v_number = -1;
16358 if (needle == NULL || haystack == NULL)
16359 return; /* type error; errmsg already given */
16361 if (argvars[2].v_type != VAR_UNKNOWN)
16363 int error = FALSE;
16365 start_idx = get_tv_number_chk(&argvars[2], &error);
16366 if (error || start_idx >= (int)STRLEN(haystack))
16367 return;
16368 if (start_idx >= 0)
16369 haystack += start_idx;
16372 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16373 if (pos != NULL)
16374 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16378 * "string()" function
16380 static void
16381 f_string(argvars, rettv)
16382 typval_T *argvars;
16383 typval_T *rettv;
16385 char_u *tofree;
16386 char_u numbuf[NUMBUFLEN];
16388 rettv->v_type = VAR_STRING;
16389 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16390 /* Make a copy if we have a value but it's not in allocated memory. */
16391 if (rettv->vval.v_string != NULL && tofree == NULL)
16392 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16396 * "strlen()" function
16398 static void
16399 f_strlen(argvars, rettv)
16400 typval_T *argvars;
16401 typval_T *rettv;
16403 rettv->vval.v_number = (varnumber_T)(STRLEN(
16404 get_tv_string(&argvars[0])));
16408 * "strpart()" function
16410 static void
16411 f_strpart(argvars, rettv)
16412 typval_T *argvars;
16413 typval_T *rettv;
16415 char_u *p;
16416 int n;
16417 int len;
16418 int slen;
16419 int error = FALSE;
16421 p = get_tv_string(&argvars[0]);
16422 slen = (int)STRLEN(p);
16424 n = get_tv_number_chk(&argvars[1], &error);
16425 if (error)
16426 len = 0;
16427 else if (argvars[2].v_type != VAR_UNKNOWN)
16428 len = get_tv_number(&argvars[2]);
16429 else
16430 len = slen - n; /* default len: all bytes that are available. */
16433 * Only return the overlap between the specified part and the actual
16434 * string.
16436 if (n < 0)
16438 len += n;
16439 n = 0;
16441 else if (n > slen)
16442 n = slen;
16443 if (len < 0)
16444 len = 0;
16445 else if (n + len > slen)
16446 len = slen - n;
16448 rettv->v_type = VAR_STRING;
16449 rettv->vval.v_string = vim_strnsave(p + n, len);
16453 * "strridx()" function
16455 static void
16456 f_strridx(argvars, rettv)
16457 typval_T *argvars;
16458 typval_T *rettv;
16460 char_u buf[NUMBUFLEN];
16461 char_u *needle;
16462 char_u *haystack;
16463 char_u *rest;
16464 char_u *lastmatch = NULL;
16465 int haystack_len, end_idx;
16467 needle = get_tv_string_chk(&argvars[1]);
16468 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16470 rettv->vval.v_number = -1;
16471 if (needle == NULL || haystack == NULL)
16472 return; /* type error; errmsg already given */
16474 haystack_len = (int)STRLEN(haystack);
16475 if (argvars[2].v_type != VAR_UNKNOWN)
16477 /* Third argument: upper limit for index */
16478 end_idx = get_tv_number_chk(&argvars[2], NULL);
16479 if (end_idx < 0)
16480 return; /* can never find a match */
16482 else
16483 end_idx = haystack_len;
16485 if (*needle == NUL)
16487 /* Empty string matches past the end. */
16488 lastmatch = haystack + end_idx;
16490 else
16492 for (rest = haystack; *rest != '\0'; ++rest)
16494 rest = (char_u *)strstr((char *)rest, (char *)needle);
16495 if (rest == NULL || rest > haystack + end_idx)
16496 break;
16497 lastmatch = rest;
16501 if (lastmatch == NULL)
16502 rettv->vval.v_number = -1;
16503 else
16504 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16508 * "strtrans()" function
16510 static void
16511 f_strtrans(argvars, rettv)
16512 typval_T *argvars;
16513 typval_T *rettv;
16515 rettv->v_type = VAR_STRING;
16516 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16520 * "submatch()" function
16522 static void
16523 f_submatch(argvars, rettv)
16524 typval_T *argvars;
16525 typval_T *rettv;
16527 rettv->v_type = VAR_STRING;
16528 rettv->vval.v_string =
16529 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16533 * "substitute()" function
16535 static void
16536 f_substitute(argvars, rettv)
16537 typval_T *argvars;
16538 typval_T *rettv;
16540 char_u patbuf[NUMBUFLEN];
16541 char_u subbuf[NUMBUFLEN];
16542 char_u flagsbuf[NUMBUFLEN];
16544 char_u *str = get_tv_string_chk(&argvars[0]);
16545 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16546 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16547 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16549 rettv->v_type = VAR_STRING;
16550 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16551 rettv->vval.v_string = NULL;
16552 else
16553 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16557 * "synID(lnum, col, trans)" function
16559 /*ARGSUSED*/
16560 static void
16561 f_synID(argvars, rettv)
16562 typval_T *argvars;
16563 typval_T *rettv;
16565 int id = 0;
16566 #ifdef FEAT_SYN_HL
16567 long lnum;
16568 long col;
16569 int trans;
16570 int transerr = FALSE;
16572 lnum = get_tv_lnum(argvars); /* -1 on type error */
16573 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16574 trans = get_tv_number_chk(&argvars[2], &transerr);
16576 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16577 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16578 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16579 #endif
16581 rettv->vval.v_number = id;
16585 * "synIDattr(id, what [, mode])" function
16587 /*ARGSUSED*/
16588 static void
16589 f_synIDattr(argvars, rettv)
16590 typval_T *argvars;
16591 typval_T *rettv;
16593 char_u *p = NULL;
16594 #ifdef FEAT_SYN_HL
16595 int id;
16596 char_u *what;
16597 char_u *mode;
16598 char_u modebuf[NUMBUFLEN];
16599 int modec;
16601 id = get_tv_number(&argvars[0]);
16602 what = get_tv_string(&argvars[1]);
16603 if (argvars[2].v_type != VAR_UNKNOWN)
16605 mode = get_tv_string_buf(&argvars[2], modebuf);
16606 modec = TOLOWER_ASC(mode[0]);
16607 if (modec != 't' && modec != 'c'
16608 #ifdef FEAT_GUI
16609 && modec != 'g'
16610 #endif
16612 modec = 0; /* replace invalid with current */
16614 else
16616 #ifdef FEAT_GUI
16617 if (gui.in_use)
16618 modec = 'g';
16619 else
16620 #endif
16621 if (t_colors > 1)
16622 modec = 'c';
16623 else
16624 modec = 't';
16628 switch (TOLOWER_ASC(what[0]))
16630 case 'b':
16631 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16632 p = highlight_color(id, what, modec);
16633 else /* bold */
16634 p = highlight_has_attr(id, HL_BOLD, modec);
16635 break;
16637 case 'f': /* fg[#] */
16638 p = highlight_color(id, what, modec);
16639 break;
16641 case 'i':
16642 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16643 p = highlight_has_attr(id, HL_INVERSE, modec);
16644 else /* italic */
16645 p = highlight_has_attr(id, HL_ITALIC, modec);
16646 break;
16648 case 'n': /* name */
16649 p = get_highlight_name(NULL, id - 1);
16650 break;
16652 case 'r': /* reverse */
16653 p = highlight_has_attr(id, HL_INVERSE, modec);
16654 break;
16656 case 's':
16657 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16658 p = highlight_color(id, what, modec);
16659 else /* standout */
16660 p = highlight_has_attr(id, HL_STANDOUT, modec);
16661 break;
16663 case 'u':
16664 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16665 /* underline */
16666 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16667 else
16668 /* undercurl */
16669 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16670 break;
16673 if (p != NULL)
16674 p = vim_strsave(p);
16675 #endif
16676 rettv->v_type = VAR_STRING;
16677 rettv->vval.v_string = p;
16681 * "synIDtrans(id)" function
16683 /*ARGSUSED*/
16684 static void
16685 f_synIDtrans(argvars, rettv)
16686 typval_T *argvars;
16687 typval_T *rettv;
16689 int id;
16691 #ifdef FEAT_SYN_HL
16692 id = get_tv_number(&argvars[0]);
16694 if (id > 0)
16695 id = syn_get_final_id(id);
16696 else
16697 #endif
16698 id = 0;
16700 rettv->vval.v_number = id;
16704 * "synstack(lnum, col)" function
16706 /*ARGSUSED*/
16707 static void
16708 f_synstack(argvars, rettv)
16709 typval_T *argvars;
16710 typval_T *rettv;
16712 #ifdef FEAT_SYN_HL
16713 long lnum;
16714 long col;
16715 int i;
16716 int id;
16717 #endif
16719 rettv->v_type = VAR_LIST;
16720 rettv->vval.v_list = NULL;
16722 #ifdef FEAT_SYN_HL
16723 lnum = get_tv_lnum(argvars); /* -1 on type error */
16724 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16726 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16727 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16728 && rettv_list_alloc(rettv) != FAIL)
16730 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16731 for (i = 0; ; ++i)
16733 id = syn_get_stack_item(i);
16734 if (id < 0)
16735 break;
16736 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16737 break;
16740 #endif
16744 * "system()" function
16746 static void
16747 f_system(argvars, rettv)
16748 typval_T *argvars;
16749 typval_T *rettv;
16751 char_u *res = NULL;
16752 char_u *p;
16753 char_u *infile = NULL;
16754 char_u buf[NUMBUFLEN];
16755 int err = FALSE;
16756 FILE *fd;
16758 if (check_restricted() || check_secure())
16759 goto done;
16761 if (argvars[1].v_type != VAR_UNKNOWN)
16764 * Write the string to a temp file, to be used for input of the shell
16765 * command.
16767 if ((infile = vim_tempname('i')) == NULL)
16769 EMSG(_(e_notmp));
16770 goto done;
16773 fd = mch_fopen((char *)infile, WRITEBIN);
16774 if (fd == NULL)
16776 EMSG2(_(e_notopen), infile);
16777 goto done;
16779 p = get_tv_string_buf_chk(&argvars[1], buf);
16780 if (p == NULL)
16782 fclose(fd);
16783 goto done; /* type error; errmsg already given */
16785 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16786 err = TRUE;
16787 if (fclose(fd) != 0)
16788 err = TRUE;
16789 if (err)
16791 EMSG(_("E677: Error writing temp file"));
16792 goto done;
16796 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16797 SHELL_SILENT | SHELL_COOKED);
16799 #ifdef USE_CR
16800 /* translate <CR> into <NL> */
16801 if (res != NULL)
16803 char_u *s;
16805 for (s = res; *s; ++s)
16807 if (*s == CAR)
16808 *s = NL;
16811 #else
16812 # ifdef USE_CRNL
16813 /* translate <CR><NL> into <NL> */
16814 if (res != NULL)
16816 char_u *s, *d;
16818 d = res;
16819 for (s = res; *s; ++s)
16821 if (s[0] == CAR && s[1] == NL)
16822 ++s;
16823 *d++ = *s;
16825 *d = NUL;
16827 # endif
16828 #endif
16830 done:
16831 if (infile != NULL)
16833 mch_remove(infile);
16834 vim_free(infile);
16836 rettv->v_type = VAR_STRING;
16837 rettv->vval.v_string = res;
16841 * "tabpagebuflist()" function
16843 /* ARGSUSED */
16844 static void
16845 f_tabpagebuflist(argvars, rettv)
16846 typval_T *argvars;
16847 typval_T *rettv;
16849 #ifndef FEAT_WINDOWS
16850 rettv->vval.v_number = 0;
16851 #else
16852 tabpage_T *tp;
16853 win_T *wp = NULL;
16855 if (argvars[0].v_type == VAR_UNKNOWN)
16856 wp = firstwin;
16857 else
16859 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16860 if (tp != NULL)
16861 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16863 if (wp == NULL)
16864 rettv->vval.v_number = 0;
16865 else
16867 if (rettv_list_alloc(rettv) == FAIL)
16868 rettv->vval.v_number = 0;
16869 else
16871 for (; wp != NULL; wp = wp->w_next)
16872 if (list_append_number(rettv->vval.v_list,
16873 wp->w_buffer->b_fnum) == FAIL)
16874 break;
16877 #endif
16882 * "tabpagenr()" function
16884 /* ARGSUSED */
16885 static void
16886 f_tabpagenr(argvars, rettv)
16887 typval_T *argvars;
16888 typval_T *rettv;
16890 int nr = 1;
16891 #ifdef FEAT_WINDOWS
16892 char_u *arg;
16894 if (argvars[0].v_type != VAR_UNKNOWN)
16896 arg = get_tv_string_chk(&argvars[0]);
16897 nr = 0;
16898 if (arg != NULL)
16900 if (STRCMP(arg, "$") == 0)
16901 nr = tabpage_index(NULL) - 1;
16902 else
16903 EMSG2(_(e_invexpr2), arg);
16906 else
16907 nr = tabpage_index(curtab);
16908 #endif
16909 rettv->vval.v_number = nr;
16913 #ifdef FEAT_WINDOWS
16914 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16917 * Common code for tabpagewinnr() and winnr().
16919 static int
16920 get_winnr(tp, argvar)
16921 tabpage_T *tp;
16922 typval_T *argvar;
16924 win_T *twin;
16925 int nr = 1;
16926 win_T *wp;
16927 char_u *arg;
16929 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16930 if (argvar->v_type != VAR_UNKNOWN)
16932 arg = get_tv_string_chk(argvar);
16933 if (arg == NULL)
16934 nr = 0; /* type error; errmsg already given */
16935 else if (STRCMP(arg, "$") == 0)
16936 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16937 else if (STRCMP(arg, "#") == 0)
16939 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16940 if (twin == NULL)
16941 nr = 0;
16943 else
16945 EMSG2(_(e_invexpr2), arg);
16946 nr = 0;
16950 if (nr > 0)
16951 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16952 wp != twin; wp = wp->w_next)
16954 if (wp == NULL)
16956 /* didn't find it in this tabpage */
16957 nr = 0;
16958 break;
16960 ++nr;
16962 return nr;
16964 #endif
16967 * "tabpagewinnr()" function
16969 /* ARGSUSED */
16970 static void
16971 f_tabpagewinnr(argvars, rettv)
16972 typval_T *argvars;
16973 typval_T *rettv;
16975 int nr = 1;
16976 #ifdef FEAT_WINDOWS
16977 tabpage_T *tp;
16979 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16980 if (tp == NULL)
16981 nr = 0;
16982 else
16983 nr = get_winnr(tp, &argvars[1]);
16984 #endif
16985 rettv->vval.v_number = nr;
16990 * "tagfiles()" function
16992 /*ARGSUSED*/
16993 static void
16994 f_tagfiles(argvars, rettv)
16995 typval_T *argvars;
16996 typval_T *rettv;
16998 char_u fname[MAXPATHL + 1];
16999 tagname_T tn;
17000 int first;
17002 if (rettv_list_alloc(rettv) == FAIL)
17004 rettv->vval.v_number = 0;
17005 return;
17008 for (first = TRUE; ; first = FALSE)
17009 if (get_tagfname(&tn, first, fname) == FAIL
17010 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17011 break;
17012 tagname_free(&tn);
17016 * "taglist()" function
17018 static void
17019 f_taglist(argvars, rettv)
17020 typval_T *argvars;
17021 typval_T *rettv;
17023 char_u *tag_pattern;
17025 tag_pattern = get_tv_string(&argvars[0]);
17027 rettv->vval.v_number = FALSE;
17028 if (*tag_pattern == NUL)
17029 return;
17031 if (rettv_list_alloc(rettv) == OK)
17032 (void)get_tags(rettv->vval.v_list, tag_pattern);
17036 * "tempname()" function
17038 /*ARGSUSED*/
17039 static void
17040 f_tempname(argvars, rettv)
17041 typval_T *argvars;
17042 typval_T *rettv;
17044 static int x = 'A';
17046 rettv->v_type = VAR_STRING;
17047 rettv->vval.v_string = vim_tempname(x);
17049 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17050 * names. Skip 'I' and 'O', they are used for shell redirection. */
17053 if (x == 'Z')
17054 x = '0';
17055 else if (x == '9')
17056 x = 'A';
17057 else
17059 #ifdef EBCDIC
17060 if (x == 'I')
17061 x = 'J';
17062 else if (x == 'R')
17063 x = 'S';
17064 else
17065 #endif
17066 ++x;
17068 } while (x == 'I' || x == 'O');
17072 * "test(list)" function: Just checking the walls...
17074 /*ARGSUSED*/
17075 static void
17076 f_test(argvars, rettv)
17077 typval_T *argvars;
17078 typval_T *rettv;
17080 /* Used for unit testing. Change the code below to your liking. */
17081 #if 0
17082 listitem_T *li;
17083 list_T *l;
17084 char_u *bad, *good;
17086 if (argvars[0].v_type != VAR_LIST)
17087 return;
17088 l = argvars[0].vval.v_list;
17089 if (l == NULL)
17090 return;
17091 li = l->lv_first;
17092 if (li == NULL)
17093 return;
17094 bad = get_tv_string(&li->li_tv);
17095 li = li->li_next;
17096 if (li == NULL)
17097 return;
17098 good = get_tv_string(&li->li_tv);
17099 rettv->vval.v_number = test_edit_score(bad, good);
17100 #endif
17104 * "tolower(string)" function
17106 static void
17107 f_tolower(argvars, rettv)
17108 typval_T *argvars;
17109 typval_T *rettv;
17111 char_u *p;
17113 p = vim_strsave(get_tv_string(&argvars[0]));
17114 rettv->v_type = VAR_STRING;
17115 rettv->vval.v_string = p;
17117 if (p != NULL)
17118 while (*p != NUL)
17120 #ifdef FEAT_MBYTE
17121 int l;
17123 if (enc_utf8)
17125 int c, lc;
17127 c = utf_ptr2char(p);
17128 lc = utf_tolower(c);
17129 l = utf_ptr2len(p);
17130 /* TODO: reallocate string when byte count changes. */
17131 if (utf_char2len(lc) == l)
17132 utf_char2bytes(lc, p);
17133 p += l;
17135 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17136 p += l; /* skip multi-byte character */
17137 else
17138 #endif
17140 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17141 ++p;
17147 * "toupper(string)" function
17149 static void
17150 f_toupper(argvars, rettv)
17151 typval_T *argvars;
17152 typval_T *rettv;
17154 rettv->v_type = VAR_STRING;
17155 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17159 * "tr(string, fromstr, tostr)" function
17161 static void
17162 f_tr(argvars, rettv)
17163 typval_T *argvars;
17164 typval_T *rettv;
17166 char_u *instr;
17167 char_u *fromstr;
17168 char_u *tostr;
17169 char_u *p;
17170 #ifdef FEAT_MBYTE
17171 int inlen;
17172 int fromlen;
17173 int tolen;
17174 int idx;
17175 char_u *cpstr;
17176 int cplen;
17177 int first = TRUE;
17178 #endif
17179 char_u buf[NUMBUFLEN];
17180 char_u buf2[NUMBUFLEN];
17181 garray_T ga;
17183 instr = get_tv_string(&argvars[0]);
17184 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17185 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17187 /* Default return value: empty string. */
17188 rettv->v_type = VAR_STRING;
17189 rettv->vval.v_string = NULL;
17190 if (fromstr == NULL || tostr == NULL)
17191 return; /* type error; errmsg already given */
17192 ga_init2(&ga, (int)sizeof(char), 80);
17194 #ifdef FEAT_MBYTE
17195 if (!has_mbyte)
17196 #endif
17197 /* not multi-byte: fromstr and tostr must be the same length */
17198 if (STRLEN(fromstr) != STRLEN(tostr))
17200 #ifdef FEAT_MBYTE
17201 error:
17202 #endif
17203 EMSG2(_(e_invarg2), fromstr);
17204 ga_clear(&ga);
17205 return;
17208 /* fromstr and tostr have to contain the same number of chars */
17209 while (*instr != NUL)
17211 #ifdef FEAT_MBYTE
17212 if (has_mbyte)
17214 inlen = (*mb_ptr2len)(instr);
17215 cpstr = instr;
17216 cplen = inlen;
17217 idx = 0;
17218 for (p = fromstr; *p != NUL; p += fromlen)
17220 fromlen = (*mb_ptr2len)(p);
17221 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17223 for (p = tostr; *p != NUL; p += tolen)
17225 tolen = (*mb_ptr2len)(p);
17226 if (idx-- == 0)
17228 cplen = tolen;
17229 cpstr = p;
17230 break;
17233 if (*p == NUL) /* tostr is shorter than fromstr */
17234 goto error;
17235 break;
17237 ++idx;
17240 if (first && cpstr == instr)
17242 /* Check that fromstr and tostr have the same number of
17243 * (multi-byte) characters. Done only once when a character
17244 * of instr doesn't appear in fromstr. */
17245 first = FALSE;
17246 for (p = tostr; *p != NUL; p += tolen)
17248 tolen = (*mb_ptr2len)(p);
17249 --idx;
17251 if (idx != 0)
17252 goto error;
17255 ga_grow(&ga, cplen);
17256 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17257 ga.ga_len += cplen;
17259 instr += inlen;
17261 else
17262 #endif
17264 /* When not using multi-byte chars we can do it faster. */
17265 p = vim_strchr(fromstr, *instr);
17266 if (p != NULL)
17267 ga_append(&ga, tostr[p - fromstr]);
17268 else
17269 ga_append(&ga, *instr);
17270 ++instr;
17274 /* add a terminating NUL */
17275 ga_grow(&ga, 1);
17276 ga_append(&ga, NUL);
17278 rettv->vval.v_string = ga.ga_data;
17281 #ifdef FEAT_FLOAT
17283 * "trunc({float})" function
17285 static void
17286 f_trunc(argvars, rettv)
17287 typval_T *argvars;
17288 typval_T *rettv;
17290 float_T f;
17292 rettv->v_type = VAR_FLOAT;
17293 if (get_float_arg(argvars, &f) == OK)
17294 /* trunc() is not in C90, use floor() or ceil() instead. */
17295 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17296 else
17297 rettv->vval.v_float = 0.0;
17299 #endif
17302 * "type(expr)" function
17304 static void
17305 f_type(argvars, rettv)
17306 typval_T *argvars;
17307 typval_T *rettv;
17309 int n;
17311 switch (argvars[0].v_type)
17313 case VAR_NUMBER: n = 0; break;
17314 case VAR_STRING: n = 1; break;
17315 case VAR_FUNC: n = 2; break;
17316 case VAR_LIST: n = 3; break;
17317 case VAR_DICT: n = 4; break;
17318 #ifdef FEAT_FLOAT
17319 case VAR_FLOAT: n = 5; break;
17320 #endif
17321 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17323 rettv->vval.v_number = n;
17327 * "values(dict)" function
17329 static void
17330 f_values(argvars, rettv)
17331 typval_T *argvars;
17332 typval_T *rettv;
17334 dict_list(argvars, rettv, 1);
17338 * "virtcol(string)" function
17340 static void
17341 f_virtcol(argvars, rettv)
17342 typval_T *argvars;
17343 typval_T *rettv;
17345 colnr_T vcol = 0;
17346 pos_T *fp;
17347 int fnum = curbuf->b_fnum;
17349 fp = var2fpos(&argvars[0], FALSE, &fnum);
17350 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17351 && fnum == curbuf->b_fnum)
17353 getvvcol(curwin, fp, NULL, NULL, &vcol);
17354 ++vcol;
17357 rettv->vval.v_number = vcol;
17361 * "visualmode()" function
17363 /*ARGSUSED*/
17364 static void
17365 f_visualmode(argvars, rettv)
17366 typval_T *argvars;
17367 typval_T *rettv;
17369 #ifdef FEAT_VISUAL
17370 char_u str[2];
17372 rettv->v_type = VAR_STRING;
17373 str[0] = curbuf->b_visual_mode_eval;
17374 str[1] = NUL;
17375 rettv->vval.v_string = vim_strsave(str);
17377 /* A non-zero number or non-empty string argument: reset mode. */
17378 if (non_zero_arg(&argvars[0]))
17379 curbuf->b_visual_mode_eval = NUL;
17380 #else
17381 rettv->vval.v_number = 0; /* return anything, it won't work anyway */
17382 #endif
17386 * "winbufnr(nr)" function
17388 static void
17389 f_winbufnr(argvars, rettv)
17390 typval_T *argvars;
17391 typval_T *rettv;
17393 win_T *wp;
17395 wp = find_win_by_nr(&argvars[0], NULL);
17396 if (wp == NULL)
17397 rettv->vval.v_number = -1;
17398 else
17399 rettv->vval.v_number = wp->w_buffer->b_fnum;
17403 * "wincol()" function
17405 /*ARGSUSED*/
17406 static void
17407 f_wincol(argvars, rettv)
17408 typval_T *argvars;
17409 typval_T *rettv;
17411 validate_cursor();
17412 rettv->vval.v_number = curwin->w_wcol + 1;
17416 * "winheight(nr)" function
17418 static void
17419 f_winheight(argvars, rettv)
17420 typval_T *argvars;
17421 typval_T *rettv;
17423 win_T *wp;
17425 wp = find_win_by_nr(&argvars[0], NULL);
17426 if (wp == NULL)
17427 rettv->vval.v_number = -1;
17428 else
17429 rettv->vval.v_number = wp->w_height;
17433 * "winline()" function
17435 /*ARGSUSED*/
17436 static void
17437 f_winline(argvars, rettv)
17438 typval_T *argvars;
17439 typval_T *rettv;
17441 validate_cursor();
17442 rettv->vval.v_number = curwin->w_wrow + 1;
17446 * "winnr()" function
17448 /* ARGSUSED */
17449 static void
17450 f_winnr(argvars, rettv)
17451 typval_T *argvars;
17452 typval_T *rettv;
17454 int nr = 1;
17456 #ifdef FEAT_WINDOWS
17457 nr = get_winnr(curtab, &argvars[0]);
17458 #endif
17459 rettv->vval.v_number = nr;
17463 * "winrestcmd()" function
17465 /* ARGSUSED */
17466 static void
17467 f_winrestcmd(argvars, rettv)
17468 typval_T *argvars;
17469 typval_T *rettv;
17471 #ifdef FEAT_WINDOWS
17472 win_T *wp;
17473 int winnr = 1;
17474 garray_T ga;
17475 char_u buf[50];
17477 ga_init2(&ga, (int)sizeof(char), 70);
17478 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17480 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17481 ga_concat(&ga, buf);
17482 # ifdef FEAT_VERTSPLIT
17483 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17484 ga_concat(&ga, buf);
17485 # endif
17486 ++winnr;
17488 ga_append(&ga, NUL);
17490 rettv->vval.v_string = ga.ga_data;
17491 #else
17492 rettv->vval.v_string = NULL;
17493 #endif
17494 rettv->v_type = VAR_STRING;
17498 * "winrestview()" function
17500 /* ARGSUSED */
17501 static void
17502 f_winrestview(argvars, rettv)
17503 typval_T *argvars;
17504 typval_T *rettv;
17506 dict_T *dict;
17508 if (argvars[0].v_type != VAR_DICT
17509 || (dict = argvars[0].vval.v_dict) == NULL)
17510 EMSG(_(e_invarg));
17511 else
17513 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17514 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17515 #ifdef FEAT_VIRTUALEDIT
17516 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17517 #endif
17518 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17519 curwin->w_set_curswant = FALSE;
17521 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17522 #ifdef FEAT_DIFF
17523 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17524 #endif
17525 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17526 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17528 check_cursor();
17529 changed_cline_bef_curs();
17530 invalidate_botline();
17531 redraw_later(VALID);
17533 if (curwin->w_topline == 0)
17534 curwin->w_topline = 1;
17535 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17536 curwin->w_topline = curbuf->b_ml.ml_line_count;
17537 #ifdef FEAT_DIFF
17538 check_topfill(curwin, TRUE);
17539 #endif
17544 * "winsaveview()" function
17546 /* ARGSUSED */
17547 static void
17548 f_winsaveview(argvars, rettv)
17549 typval_T *argvars;
17550 typval_T *rettv;
17552 dict_T *dict;
17554 dict = dict_alloc();
17555 if (dict == NULL)
17556 return;
17557 rettv->v_type = VAR_DICT;
17558 rettv->vval.v_dict = dict;
17559 ++dict->dv_refcount;
17561 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17562 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17563 #ifdef FEAT_VIRTUALEDIT
17564 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17565 #endif
17566 update_curswant();
17567 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17569 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17570 #ifdef FEAT_DIFF
17571 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17572 #endif
17573 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17574 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17578 * "winwidth(nr)" function
17580 static void
17581 f_winwidth(argvars, rettv)
17582 typval_T *argvars;
17583 typval_T *rettv;
17585 win_T *wp;
17587 wp = find_win_by_nr(&argvars[0], NULL);
17588 if (wp == NULL)
17589 rettv->vval.v_number = -1;
17590 else
17591 #ifdef FEAT_VERTSPLIT
17592 rettv->vval.v_number = wp->w_width;
17593 #else
17594 rettv->vval.v_number = Columns;
17595 #endif
17599 * "writefile()" function
17601 static void
17602 f_writefile(argvars, rettv)
17603 typval_T *argvars;
17604 typval_T *rettv;
17606 int binary = FALSE;
17607 char_u *fname;
17608 FILE *fd;
17609 listitem_T *li;
17610 char_u *s;
17611 int ret = 0;
17612 int c;
17614 if (check_restricted() || check_secure())
17615 return;
17617 if (argvars[0].v_type != VAR_LIST)
17619 EMSG2(_(e_listarg), "writefile()");
17620 return;
17622 if (argvars[0].vval.v_list == NULL)
17623 return;
17625 if (argvars[2].v_type != VAR_UNKNOWN
17626 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17627 binary = TRUE;
17629 /* Always open the file in binary mode, library functions have a mind of
17630 * their own about CR-LF conversion. */
17631 fname = get_tv_string(&argvars[1]);
17632 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17634 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17635 ret = -1;
17637 else
17639 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17640 li = li->li_next)
17642 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17644 if (*s == '\n')
17645 c = putc(NUL, fd);
17646 else
17647 c = putc(*s, fd);
17648 if (c == EOF)
17650 ret = -1;
17651 break;
17654 if (!binary || li->li_next != NULL)
17655 if (putc('\n', fd) == EOF)
17657 ret = -1;
17658 break;
17660 if (ret < 0)
17662 EMSG(_(e_write));
17663 break;
17666 fclose(fd);
17669 rettv->vval.v_number = ret;
17673 * Translate a String variable into a position.
17674 * Returns NULL when there is an error.
17676 static pos_T *
17677 var2fpos(varp, dollar_lnum, fnum)
17678 typval_T *varp;
17679 int dollar_lnum; /* TRUE when $ is last line */
17680 int *fnum; /* set to fnum for '0, 'A, etc. */
17682 char_u *name;
17683 static pos_T pos;
17684 pos_T *pp;
17686 /* Argument can be [lnum, col, coladd]. */
17687 if (varp->v_type == VAR_LIST)
17689 list_T *l;
17690 int len;
17691 int error = FALSE;
17692 listitem_T *li;
17694 l = varp->vval.v_list;
17695 if (l == NULL)
17696 return NULL;
17698 /* Get the line number */
17699 pos.lnum = list_find_nr(l, 0L, &error);
17700 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17701 return NULL; /* invalid line number */
17703 /* Get the column number */
17704 pos.col = list_find_nr(l, 1L, &error);
17705 if (error)
17706 return NULL;
17707 len = (long)STRLEN(ml_get(pos.lnum));
17709 /* We accept "$" for the column number: last column. */
17710 li = list_find(l, 1L);
17711 if (li != NULL && li->li_tv.v_type == VAR_STRING
17712 && li->li_tv.vval.v_string != NULL
17713 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17714 pos.col = len + 1;
17716 /* Accept a position up to the NUL after the line. */
17717 if (pos.col == 0 || (int)pos.col > len + 1)
17718 return NULL; /* invalid column number */
17719 --pos.col;
17721 #ifdef FEAT_VIRTUALEDIT
17722 /* Get the virtual offset. Defaults to zero. */
17723 pos.coladd = list_find_nr(l, 2L, &error);
17724 if (error)
17725 pos.coladd = 0;
17726 #endif
17728 return &pos;
17731 name = get_tv_string_chk(varp);
17732 if (name == NULL)
17733 return NULL;
17734 if (name[0] == '.') /* cursor */
17735 return &curwin->w_cursor;
17736 #ifdef FEAT_VISUAL
17737 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17739 if (VIsual_active)
17740 return &VIsual;
17741 return &curwin->w_cursor;
17743 #endif
17744 if (name[0] == '\'') /* mark */
17746 pp = getmark_fnum(name[1], FALSE, fnum);
17747 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17748 return NULL;
17749 return pp;
17752 #ifdef FEAT_VIRTUALEDIT
17753 pos.coladd = 0;
17754 #endif
17756 if (name[0] == 'w' && dollar_lnum)
17758 pos.col = 0;
17759 if (name[1] == '0') /* "w0": first visible line */
17761 update_topline();
17762 pos.lnum = curwin->w_topline;
17763 return &pos;
17765 else if (name[1] == '$') /* "w$": last visible line */
17767 validate_botline();
17768 pos.lnum = curwin->w_botline - 1;
17769 return &pos;
17772 else if (name[0] == '$') /* last column or line */
17774 if (dollar_lnum)
17776 pos.lnum = curbuf->b_ml.ml_line_count;
17777 pos.col = 0;
17779 else
17781 pos.lnum = curwin->w_cursor.lnum;
17782 pos.col = (colnr_T)STRLEN(ml_get_curline());
17784 return &pos;
17786 return NULL;
17790 * Convert list in "arg" into a position and optional file number.
17791 * When "fnump" is NULL there is no file number, only 3 items.
17792 * Note that the column is passed on as-is, the caller may want to decrement
17793 * it to use 1 for the first column.
17794 * Return FAIL when conversion is not possible, doesn't check the position for
17795 * validity.
17797 static int
17798 list2fpos(arg, posp, fnump)
17799 typval_T *arg;
17800 pos_T *posp;
17801 int *fnump;
17803 list_T *l = arg->vval.v_list;
17804 long i = 0;
17805 long n;
17807 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17808 * when "fnump" isn't NULL and "coladd" is optional. */
17809 if (arg->v_type != VAR_LIST
17810 || l == NULL
17811 || l->lv_len < (fnump == NULL ? 2 : 3)
17812 || l->lv_len > (fnump == NULL ? 3 : 4))
17813 return FAIL;
17815 if (fnump != NULL)
17817 n = list_find_nr(l, i++, NULL); /* fnum */
17818 if (n < 0)
17819 return FAIL;
17820 if (n == 0)
17821 n = curbuf->b_fnum; /* current buffer */
17822 *fnump = n;
17825 n = list_find_nr(l, i++, NULL); /* lnum */
17826 if (n < 0)
17827 return FAIL;
17828 posp->lnum = n;
17830 n = list_find_nr(l, i++, NULL); /* col */
17831 if (n < 0)
17832 return FAIL;
17833 posp->col = n;
17835 #ifdef FEAT_VIRTUALEDIT
17836 n = list_find_nr(l, i, NULL);
17837 if (n < 0)
17838 posp->coladd = 0;
17839 else
17840 posp->coladd = n;
17841 #endif
17843 return OK;
17847 * Get the length of an environment variable name.
17848 * Advance "arg" to the first character after the name.
17849 * Return 0 for error.
17851 static int
17852 get_env_len(arg)
17853 char_u **arg;
17855 char_u *p;
17856 int len;
17858 for (p = *arg; vim_isIDc(*p); ++p)
17860 if (p == *arg) /* no name found */
17861 return 0;
17863 len = (int)(p - *arg);
17864 *arg = p;
17865 return len;
17869 * Get the length of the name of a function or internal variable.
17870 * "arg" is advanced to the first non-white character after the name.
17871 * Return 0 if something is wrong.
17873 static int
17874 get_id_len(arg)
17875 char_u **arg;
17877 char_u *p;
17878 int len;
17880 /* Find the end of the name. */
17881 for (p = *arg; eval_isnamec(*p); ++p)
17883 if (p == *arg) /* no name found */
17884 return 0;
17886 len = (int)(p - *arg);
17887 *arg = skipwhite(p);
17889 return len;
17893 * Get the length of the name of a variable or function.
17894 * Only the name is recognized, does not handle ".key" or "[idx]".
17895 * "arg" is advanced to the first non-white character after the name.
17896 * Return -1 if curly braces expansion failed.
17897 * Return 0 if something else is wrong.
17898 * If the name contains 'magic' {}'s, expand them and return the
17899 * expanded name in an allocated string via 'alias' - caller must free.
17901 static int
17902 get_name_len(arg, alias, evaluate, verbose)
17903 char_u **arg;
17904 char_u **alias;
17905 int evaluate;
17906 int verbose;
17908 int len;
17909 char_u *p;
17910 char_u *expr_start;
17911 char_u *expr_end;
17913 *alias = NULL; /* default to no alias */
17915 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17916 && (*arg)[2] == (int)KE_SNR)
17918 /* hard coded <SNR>, already translated */
17919 *arg += 3;
17920 return get_id_len(arg) + 3;
17922 len = eval_fname_script(*arg);
17923 if (len > 0)
17925 /* literal "<SID>", "s:" or "<SNR>" */
17926 *arg += len;
17930 * Find the end of the name; check for {} construction.
17932 p = find_name_end(*arg, &expr_start, &expr_end,
17933 len > 0 ? 0 : FNE_CHECK_START);
17934 if (expr_start != NULL)
17936 char_u *temp_string;
17938 if (!evaluate)
17940 len += (int)(p - *arg);
17941 *arg = skipwhite(p);
17942 return len;
17946 * Include any <SID> etc in the expanded string:
17947 * Thus the -len here.
17949 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17950 if (temp_string == NULL)
17951 return -1;
17952 *alias = temp_string;
17953 *arg = skipwhite(p);
17954 return (int)STRLEN(temp_string);
17957 len += get_id_len(arg);
17958 if (len == 0 && verbose)
17959 EMSG2(_(e_invexpr2), *arg);
17961 return len;
17965 * Find the end of a variable or function name, taking care of magic braces.
17966 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17967 * start and end of the first magic braces item.
17968 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17969 * Return a pointer to just after the name. Equal to "arg" if there is no
17970 * valid name.
17972 static char_u *
17973 find_name_end(arg, expr_start, expr_end, flags)
17974 char_u *arg;
17975 char_u **expr_start;
17976 char_u **expr_end;
17977 int flags;
17979 int mb_nest = 0;
17980 int br_nest = 0;
17981 char_u *p;
17983 if (expr_start != NULL)
17985 *expr_start = NULL;
17986 *expr_end = NULL;
17989 /* Quick check for valid starting character. */
17990 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17991 return arg;
17993 for (p = arg; *p != NUL
17994 && (eval_isnamec(*p)
17995 || *p == '{'
17996 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17997 || mb_nest != 0
17998 || br_nest != 0); mb_ptr_adv(p))
18000 if (*p == '\'')
18002 /* skip over 'string' to avoid counting [ and ] inside it. */
18003 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18005 if (*p == NUL)
18006 break;
18008 else if (*p == '"')
18010 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18011 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18012 if (*p == '\\' && p[1] != NUL)
18013 ++p;
18014 if (*p == NUL)
18015 break;
18018 if (mb_nest == 0)
18020 if (*p == '[')
18021 ++br_nest;
18022 else if (*p == ']')
18023 --br_nest;
18026 if (br_nest == 0)
18028 if (*p == '{')
18030 mb_nest++;
18031 if (expr_start != NULL && *expr_start == NULL)
18032 *expr_start = p;
18034 else if (*p == '}')
18036 mb_nest--;
18037 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18038 *expr_end = p;
18043 return p;
18047 * Expands out the 'magic' {}'s in a variable/function name.
18048 * Note that this can call itself recursively, to deal with
18049 * constructs like foo{bar}{baz}{bam}
18050 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18051 * "in_start" ^
18052 * "expr_start" ^
18053 * "expr_end" ^
18054 * "in_end" ^
18056 * Returns a new allocated string, which the caller must free.
18057 * Returns NULL for failure.
18059 static char_u *
18060 make_expanded_name(in_start, expr_start, expr_end, in_end)
18061 char_u *in_start;
18062 char_u *expr_start;
18063 char_u *expr_end;
18064 char_u *in_end;
18066 char_u c1;
18067 char_u *retval = NULL;
18068 char_u *temp_result;
18069 char_u *nextcmd = NULL;
18071 if (expr_end == NULL || in_end == NULL)
18072 return NULL;
18073 *expr_start = NUL;
18074 *expr_end = NUL;
18075 c1 = *in_end;
18076 *in_end = NUL;
18078 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18079 if (temp_result != NULL && nextcmd == NULL)
18081 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18082 + (in_end - expr_end) + 1));
18083 if (retval != NULL)
18085 STRCPY(retval, in_start);
18086 STRCAT(retval, temp_result);
18087 STRCAT(retval, expr_end + 1);
18090 vim_free(temp_result);
18092 *in_end = c1; /* put char back for error messages */
18093 *expr_start = '{';
18094 *expr_end = '}';
18096 if (retval != NULL)
18098 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18099 if (expr_start != NULL)
18101 /* Further expansion! */
18102 temp_result = make_expanded_name(retval, expr_start,
18103 expr_end, temp_result);
18104 vim_free(retval);
18105 retval = temp_result;
18109 return retval;
18113 * Return TRUE if character "c" can be used in a variable or function name.
18114 * Does not include '{' or '}' for magic braces.
18116 static int
18117 eval_isnamec(c)
18118 int c;
18120 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18124 * Return TRUE if character "c" can be used as the first character in a
18125 * variable or function name (excluding '{' and '}').
18127 static int
18128 eval_isnamec1(c)
18129 int c;
18131 return (ASCII_ISALPHA(c) || c == '_');
18135 * Set number v: variable to "val".
18137 void
18138 set_vim_var_nr(idx, val)
18139 int idx;
18140 long val;
18142 vimvars[idx].vv_nr = val;
18146 * Get number v: variable value.
18148 long
18149 get_vim_var_nr(idx)
18150 int idx;
18152 return vimvars[idx].vv_nr;
18156 * Get string v: variable value. Uses a static buffer, can only be used once.
18158 char_u *
18159 get_vim_var_str(idx)
18160 int idx;
18162 return get_tv_string(&vimvars[idx].vv_tv);
18166 * Get List v: variable value. Caller must take care of reference count when
18167 * needed.
18169 list_T *
18170 get_vim_var_list(idx)
18171 int idx;
18173 return vimvars[idx].vv_list;
18177 * Set v:count to "count" and v:count1 to "count1".
18178 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18180 void
18181 set_vcount(count, count1, set_prevcount)
18182 long count;
18183 long count1;
18184 int set_prevcount;
18186 if (set_prevcount)
18187 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18188 vimvars[VV_COUNT].vv_nr = count;
18189 vimvars[VV_COUNT1].vv_nr = count1;
18193 * Set string v: variable to a copy of "val".
18195 void
18196 set_vim_var_string(idx, val, len)
18197 int idx;
18198 char_u *val;
18199 int len; /* length of "val" to use or -1 (whole string) */
18201 /* Need to do this (at least) once, since we can't initialize a union.
18202 * Will always be invoked when "v:progname" is set. */
18203 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18205 vim_free(vimvars[idx].vv_str);
18206 if (val == NULL)
18207 vimvars[idx].vv_str = NULL;
18208 else if (len == -1)
18209 vimvars[idx].vv_str = vim_strsave(val);
18210 else
18211 vimvars[idx].vv_str = vim_strnsave(val, len);
18215 * Set List v: variable to "val".
18217 void
18218 set_vim_var_list(idx, val)
18219 int idx;
18220 list_T *val;
18222 list_unref(vimvars[idx].vv_list);
18223 vimvars[idx].vv_list = val;
18224 if (val != NULL)
18225 ++val->lv_refcount;
18229 * Set v:register if needed.
18231 void
18232 set_reg_var(c)
18233 int c;
18235 char_u regname;
18237 if (c == 0 || c == ' ')
18238 regname = '"';
18239 else
18240 regname = c;
18241 /* Avoid free/alloc when the value is already right. */
18242 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18243 set_vim_var_string(VV_REG, &regname, 1);
18247 * Get or set v:exception. If "oldval" == NULL, return the current value.
18248 * Otherwise, restore the value to "oldval" and return NULL.
18249 * Must always be called in pairs to save and restore v:exception! Does not
18250 * take care of memory allocations.
18252 char_u *
18253 v_exception(oldval)
18254 char_u *oldval;
18256 if (oldval == NULL)
18257 return vimvars[VV_EXCEPTION].vv_str;
18259 vimvars[VV_EXCEPTION].vv_str = oldval;
18260 return NULL;
18264 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18265 * Otherwise, restore the value to "oldval" and return NULL.
18266 * Must always be called in pairs to save and restore v:throwpoint! Does not
18267 * take care of memory allocations.
18269 char_u *
18270 v_throwpoint(oldval)
18271 char_u *oldval;
18273 if (oldval == NULL)
18274 return vimvars[VV_THROWPOINT].vv_str;
18276 vimvars[VV_THROWPOINT].vv_str = oldval;
18277 return NULL;
18280 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18282 * Set v:cmdarg.
18283 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18284 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18285 * Must always be called in pairs!
18287 char_u *
18288 set_cmdarg(eap, oldarg)
18289 exarg_T *eap;
18290 char_u *oldarg;
18292 char_u *oldval;
18293 char_u *newval;
18294 unsigned len;
18296 oldval = vimvars[VV_CMDARG].vv_str;
18297 if (eap == NULL)
18299 vim_free(oldval);
18300 vimvars[VV_CMDARG].vv_str = oldarg;
18301 return NULL;
18304 if (eap->force_bin == FORCE_BIN)
18305 len = 6;
18306 else if (eap->force_bin == FORCE_NOBIN)
18307 len = 8;
18308 else
18309 len = 0;
18311 if (eap->read_edit)
18312 len += 7;
18314 if (eap->force_ff != 0)
18315 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18316 # ifdef FEAT_MBYTE
18317 if (eap->force_enc != 0)
18318 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18319 if (eap->bad_char != 0)
18320 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18321 # endif
18323 newval = alloc(len + 1);
18324 if (newval == NULL)
18325 return NULL;
18327 if (eap->force_bin == FORCE_BIN)
18328 sprintf((char *)newval, " ++bin");
18329 else if (eap->force_bin == FORCE_NOBIN)
18330 sprintf((char *)newval, " ++nobin");
18331 else
18332 *newval = NUL;
18334 if (eap->read_edit)
18335 STRCAT(newval, " ++edit");
18337 if (eap->force_ff != 0)
18338 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18339 eap->cmd + eap->force_ff);
18340 # ifdef FEAT_MBYTE
18341 if (eap->force_enc != 0)
18342 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18343 eap->cmd + eap->force_enc);
18344 if (eap->bad_char != 0)
18345 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18346 eap->cmd + eap->bad_char);
18347 # endif
18348 vimvars[VV_CMDARG].vv_str = newval;
18349 return oldval;
18351 #endif
18354 * Get the value of internal variable "name".
18355 * Return OK or FAIL.
18357 static int
18358 get_var_tv(name, len, rettv, verbose)
18359 char_u *name;
18360 int len; /* length of "name" */
18361 typval_T *rettv; /* NULL when only checking existence */
18362 int verbose; /* may give error message */
18364 int ret = OK;
18365 typval_T *tv = NULL;
18366 typval_T atv;
18367 dictitem_T *v;
18368 int cc;
18370 /* truncate the name, so that we can use strcmp() */
18371 cc = name[len];
18372 name[len] = NUL;
18375 * Check for "b:changedtick".
18377 if (STRCMP(name, "b:changedtick") == 0)
18379 atv.v_type = VAR_NUMBER;
18380 atv.vval.v_number = curbuf->b_changedtick;
18381 tv = &atv;
18385 * Check for user-defined variables.
18387 else
18389 v = find_var(name, NULL);
18390 if (v != NULL)
18391 tv = &v->di_tv;
18394 if (tv == NULL)
18396 if (rettv != NULL && verbose)
18397 EMSG2(_(e_undefvar), name);
18398 ret = FAIL;
18400 else if (rettv != NULL)
18401 copy_tv(tv, rettv);
18403 name[len] = cc;
18405 return ret;
18409 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18410 * Also handle function call with Funcref variable: func(expr)
18411 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18413 static int
18414 handle_subscript(arg, rettv, evaluate, verbose)
18415 char_u **arg;
18416 typval_T *rettv;
18417 int evaluate; /* do more than finding the end */
18418 int verbose; /* give error messages */
18420 int ret = OK;
18421 dict_T *selfdict = NULL;
18422 char_u *s;
18423 int len;
18424 typval_T functv;
18426 while (ret == OK
18427 && (**arg == '['
18428 || (**arg == '.' && rettv->v_type == VAR_DICT)
18429 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18430 && !vim_iswhite(*(*arg - 1)))
18432 if (**arg == '(')
18434 /* need to copy the funcref so that we can clear rettv */
18435 functv = *rettv;
18436 rettv->v_type = VAR_UNKNOWN;
18438 /* Invoke the function. Recursive! */
18439 s = functv.vval.v_string;
18440 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18441 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18442 &len, evaluate, selfdict);
18444 /* Clear the funcref afterwards, so that deleting it while
18445 * evaluating the arguments is possible (see test55). */
18446 clear_tv(&functv);
18448 /* Stop the expression evaluation when immediately aborting on
18449 * error, or when an interrupt occurred or an exception was thrown
18450 * but not caught. */
18451 if (aborting())
18453 if (ret == OK)
18454 clear_tv(rettv);
18455 ret = FAIL;
18457 dict_unref(selfdict);
18458 selfdict = NULL;
18460 else /* **arg == '[' || **arg == '.' */
18462 dict_unref(selfdict);
18463 if (rettv->v_type == VAR_DICT)
18465 selfdict = rettv->vval.v_dict;
18466 if (selfdict != NULL)
18467 ++selfdict->dv_refcount;
18469 else
18470 selfdict = NULL;
18471 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18473 clear_tv(rettv);
18474 ret = FAIL;
18478 dict_unref(selfdict);
18479 return ret;
18483 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18484 * value).
18486 static typval_T *
18487 alloc_tv()
18489 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18493 * Allocate memory for a variable type-value, and assign a string to it.
18494 * The string "s" must have been allocated, it is consumed.
18495 * Return NULL for out of memory, the variable otherwise.
18497 static typval_T *
18498 alloc_string_tv(s)
18499 char_u *s;
18501 typval_T *rettv;
18503 rettv = alloc_tv();
18504 if (rettv != NULL)
18506 rettv->v_type = VAR_STRING;
18507 rettv->vval.v_string = s;
18509 else
18510 vim_free(s);
18511 return rettv;
18515 * Free the memory for a variable type-value.
18517 void
18518 free_tv(varp)
18519 typval_T *varp;
18521 if (varp != NULL)
18523 switch (varp->v_type)
18525 case VAR_FUNC:
18526 func_unref(varp->vval.v_string);
18527 /*FALLTHROUGH*/
18528 case VAR_STRING:
18529 vim_free(varp->vval.v_string);
18530 break;
18531 case VAR_LIST:
18532 list_unref(varp->vval.v_list);
18533 break;
18534 case VAR_DICT:
18535 dict_unref(varp->vval.v_dict);
18536 break;
18537 case VAR_NUMBER:
18538 #ifdef FEAT_FLOAT
18539 case VAR_FLOAT:
18540 #endif
18541 case VAR_UNKNOWN:
18542 break;
18543 default:
18544 EMSG2(_(e_intern2), "free_tv()");
18545 break;
18547 vim_free(varp);
18552 * Free the memory for a variable value and set the value to NULL or 0.
18554 void
18555 clear_tv(varp)
18556 typval_T *varp;
18558 if (varp != NULL)
18560 switch (varp->v_type)
18562 case VAR_FUNC:
18563 func_unref(varp->vval.v_string);
18564 /*FALLTHROUGH*/
18565 case VAR_STRING:
18566 vim_free(varp->vval.v_string);
18567 varp->vval.v_string = NULL;
18568 break;
18569 case VAR_LIST:
18570 list_unref(varp->vval.v_list);
18571 varp->vval.v_list = NULL;
18572 break;
18573 case VAR_DICT:
18574 dict_unref(varp->vval.v_dict);
18575 varp->vval.v_dict = NULL;
18576 break;
18577 case VAR_NUMBER:
18578 varp->vval.v_number = 0;
18579 break;
18580 #ifdef FEAT_FLOAT
18581 case VAR_FLOAT:
18582 varp->vval.v_float = 0.0;
18583 break;
18584 #endif
18585 case VAR_UNKNOWN:
18586 break;
18587 default:
18588 EMSG2(_(e_intern2), "clear_tv()");
18590 varp->v_lock = 0;
18595 * Set the value of a variable to NULL without freeing items.
18597 static void
18598 init_tv(varp)
18599 typval_T *varp;
18601 if (varp != NULL)
18602 vim_memset(varp, 0, sizeof(typval_T));
18606 * Get the number value of a variable.
18607 * If it is a String variable, uses vim_str2nr().
18608 * For incompatible types, return 0.
18609 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18610 * caller of incompatible types: it sets *denote to TRUE if "denote"
18611 * is not NULL or returns -1 otherwise.
18613 static long
18614 get_tv_number(varp)
18615 typval_T *varp;
18617 int error = FALSE;
18619 return get_tv_number_chk(varp, &error); /* return 0L on error */
18622 long
18623 get_tv_number_chk(varp, denote)
18624 typval_T *varp;
18625 int *denote;
18627 long n = 0L;
18629 switch (varp->v_type)
18631 case VAR_NUMBER:
18632 return (long)(varp->vval.v_number);
18633 #ifdef FEAT_FLOAT
18634 case VAR_FLOAT:
18635 EMSG(_("E805: Using a Float as a Number"));
18636 break;
18637 #endif
18638 case VAR_FUNC:
18639 EMSG(_("E703: Using a Funcref as a Number"));
18640 break;
18641 case VAR_STRING:
18642 if (varp->vval.v_string != NULL)
18643 vim_str2nr(varp->vval.v_string, NULL, NULL,
18644 TRUE, TRUE, &n, NULL);
18645 return n;
18646 case VAR_LIST:
18647 EMSG(_("E745: Using a List as a Number"));
18648 break;
18649 case VAR_DICT:
18650 EMSG(_("E728: Using a Dictionary as a Number"));
18651 break;
18652 default:
18653 EMSG2(_(e_intern2), "get_tv_number()");
18654 break;
18656 if (denote == NULL) /* useful for values that must be unsigned */
18657 n = -1;
18658 else
18659 *denote = TRUE;
18660 return n;
18664 * Get the lnum from the first argument.
18665 * Also accepts ".", "$", etc., but that only works for the current buffer.
18666 * Returns -1 on error.
18668 static linenr_T
18669 get_tv_lnum(argvars)
18670 typval_T *argvars;
18672 typval_T rettv;
18673 linenr_T lnum;
18675 lnum = get_tv_number_chk(&argvars[0], NULL);
18676 if (lnum == 0) /* no valid number, try using line() */
18678 rettv.v_type = VAR_NUMBER;
18679 f_line(argvars, &rettv);
18680 lnum = rettv.vval.v_number;
18681 clear_tv(&rettv);
18683 return lnum;
18687 * Get the lnum from the first argument.
18688 * Also accepts "$", then "buf" is used.
18689 * Returns 0 on error.
18691 static linenr_T
18692 get_tv_lnum_buf(argvars, buf)
18693 typval_T *argvars;
18694 buf_T *buf;
18696 if (argvars[0].v_type == VAR_STRING
18697 && argvars[0].vval.v_string != NULL
18698 && argvars[0].vval.v_string[0] == '$'
18699 && buf != NULL)
18700 return buf->b_ml.ml_line_count;
18701 return get_tv_number_chk(&argvars[0], NULL);
18705 * Get the string value of a variable.
18706 * If it is a Number variable, the number is converted into a string.
18707 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18708 * get_tv_string_buf() uses a given buffer.
18709 * If the String variable has never been set, return an empty string.
18710 * Never returns NULL;
18711 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18712 * NULL on error.
18714 static char_u *
18715 get_tv_string(varp)
18716 typval_T *varp;
18718 static char_u mybuf[NUMBUFLEN];
18720 return get_tv_string_buf(varp, mybuf);
18723 static char_u *
18724 get_tv_string_buf(varp, buf)
18725 typval_T *varp;
18726 char_u *buf;
18728 char_u *res = get_tv_string_buf_chk(varp, buf);
18730 return res != NULL ? res : (char_u *)"";
18733 char_u *
18734 get_tv_string_chk(varp)
18735 typval_T *varp;
18737 static char_u mybuf[NUMBUFLEN];
18739 return get_tv_string_buf_chk(varp, mybuf);
18742 static char_u *
18743 get_tv_string_buf_chk(varp, buf)
18744 typval_T *varp;
18745 char_u *buf;
18747 switch (varp->v_type)
18749 case VAR_NUMBER:
18750 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18751 return buf;
18752 case VAR_FUNC:
18753 EMSG(_("E729: using Funcref as a String"));
18754 break;
18755 case VAR_LIST:
18756 EMSG(_("E730: using List as a String"));
18757 break;
18758 case VAR_DICT:
18759 EMSG(_("E731: using Dictionary as a String"));
18760 break;
18761 #ifdef FEAT_FLOAT
18762 case VAR_FLOAT:
18763 EMSG(_("E806: using Float as a String"));
18764 break;
18765 #endif
18766 case VAR_STRING:
18767 if (varp->vval.v_string != NULL)
18768 return varp->vval.v_string;
18769 return (char_u *)"";
18770 default:
18771 EMSG2(_(e_intern2), "get_tv_string_buf()");
18772 break;
18774 return NULL;
18778 * Find variable "name" in the list of variables.
18779 * Return a pointer to it if found, NULL if not found.
18780 * Careful: "a:0" variables don't have a name.
18781 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18782 * hashtab_T used.
18784 static dictitem_T *
18785 find_var(name, htp)
18786 char_u *name;
18787 hashtab_T **htp;
18789 char_u *varname;
18790 hashtab_T *ht;
18792 ht = find_var_ht(name, &varname);
18793 if (htp != NULL)
18794 *htp = ht;
18795 if (ht == NULL)
18796 return NULL;
18797 return find_var_in_ht(ht, varname, htp != NULL);
18801 * Find variable "varname" in hashtab "ht".
18802 * Returns NULL if not found.
18804 static dictitem_T *
18805 find_var_in_ht(ht, varname, writing)
18806 hashtab_T *ht;
18807 char_u *varname;
18808 int writing;
18810 hashitem_T *hi;
18812 if (*varname == NUL)
18814 /* Must be something like "s:", otherwise "ht" would be NULL. */
18815 switch (varname[-2])
18817 case 's': return &SCRIPT_SV(current_SID).sv_var;
18818 case 'g': return &globvars_var;
18819 case 'v': return &vimvars_var;
18820 case 'b': return &curbuf->b_bufvar;
18821 case 'w': return &curwin->w_winvar;
18822 #ifdef FEAT_WINDOWS
18823 case 't': return &curtab->tp_winvar;
18824 #endif
18825 case 'l': return current_funccal == NULL
18826 ? NULL : &current_funccal->l_vars_var;
18827 case 'a': return current_funccal == NULL
18828 ? NULL : &current_funccal->l_avars_var;
18830 return NULL;
18833 hi = hash_find(ht, varname);
18834 if (HASHITEM_EMPTY(hi))
18836 /* For global variables we may try auto-loading the script. If it
18837 * worked find the variable again. Don't auto-load a script if it was
18838 * loaded already, otherwise it would be loaded every time when
18839 * checking if a function name is a Funcref variable. */
18840 if (ht == &globvarht && !writing
18841 && script_autoload(varname, FALSE) && !aborting())
18842 hi = hash_find(ht, varname);
18843 if (HASHITEM_EMPTY(hi))
18844 return NULL;
18846 return HI2DI(hi);
18850 * Find the hashtab used for a variable name.
18851 * Set "varname" to the start of name without ':'.
18853 static hashtab_T *
18854 find_var_ht(name, varname)
18855 char_u *name;
18856 char_u **varname;
18858 hashitem_T *hi;
18860 if (name[1] != ':')
18862 /* The name must not start with a colon or #. */
18863 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18864 return NULL;
18865 *varname = name;
18867 /* "version" is "v:version" in all scopes */
18868 hi = hash_find(&compat_hashtab, name);
18869 if (!HASHITEM_EMPTY(hi))
18870 return &compat_hashtab;
18872 if (current_funccal == NULL)
18873 return &globvarht; /* global variable */
18874 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18876 *varname = name + 2;
18877 if (*name == 'g') /* global variable */
18878 return &globvarht;
18879 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18881 if (vim_strchr(name + 2, ':') != NULL
18882 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18883 return NULL;
18884 if (*name == 'b') /* buffer variable */
18885 return &curbuf->b_vars.dv_hashtab;
18886 if (*name == 'w') /* window variable */
18887 return &curwin->w_vars.dv_hashtab;
18888 #ifdef FEAT_WINDOWS
18889 if (*name == 't') /* tab page variable */
18890 return &curtab->tp_vars.dv_hashtab;
18891 #endif
18892 if (*name == 'v') /* v: variable */
18893 return &vimvarht;
18894 if (*name == 'a' && current_funccal != NULL) /* function argument */
18895 return &current_funccal->l_avars.dv_hashtab;
18896 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18897 return &current_funccal->l_vars.dv_hashtab;
18898 if (*name == 's' /* script variable */
18899 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18900 return &SCRIPT_VARS(current_SID);
18901 return NULL;
18905 * Get the string value of a (global/local) variable.
18906 * Returns NULL when it doesn't exist.
18908 char_u *
18909 get_var_value(name)
18910 char_u *name;
18912 dictitem_T *v;
18914 v = find_var(name, NULL);
18915 if (v == NULL)
18916 return NULL;
18917 return get_tv_string(&v->di_tv);
18921 * Allocate a new hashtab for a sourced script. It will be used while
18922 * sourcing this script and when executing functions defined in the script.
18924 void
18925 new_script_vars(id)
18926 scid_T id;
18928 int i;
18929 hashtab_T *ht;
18930 scriptvar_T *sv;
18932 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18934 /* Re-allocating ga_data means that an ht_array pointing to
18935 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18936 * at its init value. Also reset "v_dict", it's always the same. */
18937 for (i = 1; i <= ga_scripts.ga_len; ++i)
18939 ht = &SCRIPT_VARS(i);
18940 if (ht->ht_mask == HT_INIT_SIZE - 1)
18941 ht->ht_array = ht->ht_smallarray;
18942 sv = &SCRIPT_SV(i);
18943 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18946 while (ga_scripts.ga_len < id)
18948 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18949 init_var_dict(&sv->sv_dict, &sv->sv_var);
18950 ++ga_scripts.ga_len;
18956 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18957 * point to it.
18959 void
18960 init_var_dict(dict, dict_var)
18961 dict_T *dict;
18962 dictitem_T *dict_var;
18964 hash_init(&dict->dv_hashtab);
18965 dict->dv_refcount = 99999;
18966 dict_var->di_tv.vval.v_dict = dict;
18967 dict_var->di_tv.v_type = VAR_DICT;
18968 dict_var->di_tv.v_lock = VAR_FIXED;
18969 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18970 dict_var->di_key[0] = NUL;
18974 * Clean up a list of internal variables.
18975 * Frees all allocated variables and the value they contain.
18976 * Clears hashtab "ht", does not free it.
18978 void
18979 vars_clear(ht)
18980 hashtab_T *ht;
18982 vars_clear_ext(ht, TRUE);
18986 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18988 static void
18989 vars_clear_ext(ht, free_val)
18990 hashtab_T *ht;
18991 int free_val;
18993 int todo;
18994 hashitem_T *hi;
18995 dictitem_T *v;
18997 hash_lock(ht);
18998 todo = (int)ht->ht_used;
18999 for (hi = ht->ht_array; todo > 0; ++hi)
19001 if (!HASHITEM_EMPTY(hi))
19003 --todo;
19005 /* Free the variable. Don't remove it from the hashtab,
19006 * ht_array might change then. hash_clear() takes care of it
19007 * later. */
19008 v = HI2DI(hi);
19009 if (free_val)
19010 clear_tv(&v->di_tv);
19011 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19012 vim_free(v);
19015 hash_clear(ht);
19016 ht->ht_used = 0;
19020 * Delete a variable from hashtab "ht" at item "hi".
19021 * Clear the variable value and free the dictitem.
19023 static void
19024 delete_var(ht, hi)
19025 hashtab_T *ht;
19026 hashitem_T *hi;
19028 dictitem_T *di = HI2DI(hi);
19030 hash_remove(ht, hi);
19031 clear_tv(&di->di_tv);
19032 vim_free(di);
19036 * List the value of one internal variable.
19038 static void
19039 list_one_var(v, prefix, first)
19040 dictitem_T *v;
19041 char_u *prefix;
19042 int *first;
19044 char_u *tofree;
19045 char_u *s;
19046 char_u numbuf[NUMBUFLEN];
19048 s = echo_string(&v->di_tv, &tofree, numbuf, ++current_copyID);
19049 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19050 s == NULL ? (char_u *)"" : s, first);
19051 vim_free(tofree);
19054 static void
19055 list_one_var_a(prefix, name, type, string, first)
19056 char_u *prefix;
19057 char_u *name;
19058 int type;
19059 char_u *string;
19060 int *first; /* when TRUE clear rest of screen and set to FALSE */
19062 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19063 msg_start();
19064 msg_puts(prefix);
19065 if (name != NULL) /* "a:" vars don't have a name stored */
19066 msg_puts(name);
19067 msg_putchar(' ');
19068 msg_advance(22);
19069 if (type == VAR_NUMBER)
19070 msg_putchar('#');
19071 else if (type == VAR_FUNC)
19072 msg_putchar('*');
19073 else if (type == VAR_LIST)
19075 msg_putchar('[');
19076 if (*string == '[')
19077 ++string;
19079 else if (type == VAR_DICT)
19081 msg_putchar('{');
19082 if (*string == '{')
19083 ++string;
19085 else
19086 msg_putchar(' ');
19088 msg_outtrans(string);
19090 if (type == VAR_FUNC)
19091 msg_puts((char_u *)"()");
19092 if (*first)
19094 msg_clr_eos();
19095 *first = FALSE;
19100 * Set variable "name" to value in "tv".
19101 * If the variable already exists, the value is updated.
19102 * Otherwise the variable is created.
19104 static void
19105 set_var(name, tv, copy)
19106 char_u *name;
19107 typval_T *tv;
19108 int copy; /* make copy of value in "tv" */
19110 dictitem_T *v;
19111 char_u *varname;
19112 hashtab_T *ht;
19113 char_u *p;
19115 if (tv->v_type == VAR_FUNC)
19117 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19118 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19119 ? name[2] : name[0]))
19121 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19122 return;
19124 if (function_exists(name))
19126 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19127 name);
19128 return;
19132 ht = find_var_ht(name, &varname);
19133 if (ht == NULL || *varname == NUL)
19135 EMSG2(_(e_illvar), name);
19136 return;
19139 v = find_var_in_ht(ht, varname, TRUE);
19140 if (v != NULL)
19142 /* existing variable, need to clear the value */
19143 if (var_check_ro(v->di_flags, name)
19144 || tv_check_lock(v->di_tv.v_lock, name))
19145 return;
19146 if (v->di_tv.v_type != tv->v_type
19147 && !((v->di_tv.v_type == VAR_STRING
19148 || v->di_tv.v_type == VAR_NUMBER)
19149 && (tv->v_type == VAR_STRING
19150 || tv->v_type == VAR_NUMBER))
19151 #ifdef FEAT_FLOAT
19152 && !((v->di_tv.v_type == VAR_NUMBER
19153 || v->di_tv.v_type == VAR_FLOAT)
19154 && (tv->v_type == VAR_NUMBER
19155 || tv->v_type == VAR_FLOAT))
19156 #endif
19159 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19160 return;
19164 * Handle setting internal v: variables separately: we don't change
19165 * the type.
19167 if (ht == &vimvarht)
19169 if (v->di_tv.v_type == VAR_STRING)
19171 vim_free(v->di_tv.vval.v_string);
19172 if (copy || tv->v_type != VAR_STRING)
19173 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19174 else
19176 /* Take over the string to avoid an extra alloc/free. */
19177 v->di_tv.vval.v_string = tv->vval.v_string;
19178 tv->vval.v_string = NULL;
19181 else if (v->di_tv.v_type != VAR_NUMBER)
19182 EMSG2(_(e_intern2), "set_var()");
19183 else
19185 v->di_tv.vval.v_number = get_tv_number(tv);
19186 if (STRCMP(varname, "searchforward") == 0)
19187 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19189 return;
19192 clear_tv(&v->di_tv);
19194 else /* add a new variable */
19196 /* Can't add "v:" variable. */
19197 if (ht == &vimvarht)
19199 EMSG2(_(e_illvar), name);
19200 return;
19203 /* Make sure the variable name is valid. */
19204 for (p = varname; *p != NUL; ++p)
19205 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19206 && *p != AUTOLOAD_CHAR)
19208 EMSG2(_(e_illvar), varname);
19209 return;
19212 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19213 + STRLEN(varname)));
19214 if (v == NULL)
19215 return;
19216 STRCPY(v->di_key, varname);
19217 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19219 vim_free(v);
19220 return;
19222 v->di_flags = 0;
19225 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19226 copy_tv(tv, &v->di_tv);
19227 else
19229 v->di_tv = *tv;
19230 v->di_tv.v_lock = 0;
19231 init_tv(tv);
19236 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19237 * Also give an error message.
19239 static int
19240 var_check_ro(flags, name)
19241 int flags;
19242 char_u *name;
19244 if (flags & DI_FLAGS_RO)
19246 EMSG2(_(e_readonlyvar), name);
19247 return TRUE;
19249 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19251 EMSG2(_(e_readonlysbx), name);
19252 return TRUE;
19254 return FALSE;
19258 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19259 * Also give an error message.
19261 static int
19262 var_check_fixed(flags, name)
19263 int flags;
19264 char_u *name;
19266 if (flags & DI_FLAGS_FIX)
19268 EMSG2(_("E795: Cannot delete variable %s"), name);
19269 return TRUE;
19271 return FALSE;
19275 * Return TRUE if typeval "tv" is set to be locked (immutable).
19276 * Also give an error message, using "name".
19278 static int
19279 tv_check_lock(lock, name)
19280 int lock;
19281 char_u *name;
19283 if (lock & VAR_LOCKED)
19285 EMSG2(_("E741: Value is locked: %s"),
19286 name == NULL ? (char_u *)_("Unknown") : name);
19287 return TRUE;
19289 if (lock & VAR_FIXED)
19291 EMSG2(_("E742: Cannot change value of %s"),
19292 name == NULL ? (char_u *)_("Unknown") : name);
19293 return TRUE;
19295 return FALSE;
19299 * Copy the values from typval_T "from" to typval_T "to".
19300 * When needed allocates string or increases reference count.
19301 * Does not make a copy of a list or dict but copies the reference!
19303 static void
19304 copy_tv(from, to)
19305 typval_T *from;
19306 typval_T *to;
19308 to->v_type = from->v_type;
19309 to->v_lock = 0;
19310 switch (from->v_type)
19312 case VAR_NUMBER:
19313 to->vval.v_number = from->vval.v_number;
19314 break;
19315 #ifdef FEAT_FLOAT
19316 case VAR_FLOAT:
19317 to->vval.v_float = from->vval.v_float;
19318 break;
19319 #endif
19320 case VAR_STRING:
19321 case VAR_FUNC:
19322 if (from->vval.v_string == NULL)
19323 to->vval.v_string = NULL;
19324 else
19326 to->vval.v_string = vim_strsave(from->vval.v_string);
19327 if (from->v_type == VAR_FUNC)
19328 func_ref(to->vval.v_string);
19330 break;
19331 case VAR_LIST:
19332 if (from->vval.v_list == NULL)
19333 to->vval.v_list = NULL;
19334 else
19336 to->vval.v_list = from->vval.v_list;
19337 ++to->vval.v_list->lv_refcount;
19339 break;
19340 case VAR_DICT:
19341 if (from->vval.v_dict == NULL)
19342 to->vval.v_dict = NULL;
19343 else
19345 to->vval.v_dict = from->vval.v_dict;
19346 ++to->vval.v_dict->dv_refcount;
19348 break;
19349 default:
19350 EMSG2(_(e_intern2), "copy_tv()");
19351 break;
19356 * Make a copy of an item.
19357 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19358 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19359 * reference to an already copied list/dict can be used.
19360 * Returns FAIL or OK.
19362 static int
19363 item_copy(from, to, deep, copyID)
19364 typval_T *from;
19365 typval_T *to;
19366 int deep;
19367 int copyID;
19369 static int recurse = 0;
19370 int ret = OK;
19372 if (recurse >= DICT_MAXNEST)
19374 EMSG(_("E698: variable nested too deep for making a copy"));
19375 return FAIL;
19377 ++recurse;
19379 switch (from->v_type)
19381 case VAR_NUMBER:
19382 #ifdef FEAT_FLOAT
19383 case VAR_FLOAT:
19384 #endif
19385 case VAR_STRING:
19386 case VAR_FUNC:
19387 copy_tv(from, to);
19388 break;
19389 case VAR_LIST:
19390 to->v_type = VAR_LIST;
19391 to->v_lock = 0;
19392 if (from->vval.v_list == NULL)
19393 to->vval.v_list = NULL;
19394 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19396 /* use the copy made earlier */
19397 to->vval.v_list = from->vval.v_list->lv_copylist;
19398 ++to->vval.v_list->lv_refcount;
19400 else
19401 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19402 if (to->vval.v_list == NULL)
19403 ret = FAIL;
19404 break;
19405 case VAR_DICT:
19406 to->v_type = VAR_DICT;
19407 to->v_lock = 0;
19408 if (from->vval.v_dict == NULL)
19409 to->vval.v_dict = NULL;
19410 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19412 /* use the copy made earlier */
19413 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19414 ++to->vval.v_dict->dv_refcount;
19416 else
19417 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19418 if (to->vval.v_dict == NULL)
19419 ret = FAIL;
19420 break;
19421 default:
19422 EMSG2(_(e_intern2), "item_copy()");
19423 ret = FAIL;
19425 --recurse;
19426 return ret;
19430 * ":echo expr1 ..." print each argument separated with a space, add a
19431 * newline at the end.
19432 * ":echon expr1 ..." print each argument plain.
19434 void
19435 ex_echo(eap)
19436 exarg_T *eap;
19438 char_u *arg = eap->arg;
19439 typval_T rettv;
19440 char_u *tofree;
19441 char_u *p;
19442 int needclr = TRUE;
19443 int atstart = TRUE;
19444 char_u numbuf[NUMBUFLEN];
19446 if (eap->skip)
19447 ++emsg_skip;
19448 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19450 /* If eval1() causes an error message the text from the command may
19451 * still need to be cleared. E.g., "echo 22,44". */
19452 need_clr_eos = needclr;
19454 p = arg;
19455 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19458 * Report the invalid expression unless the expression evaluation
19459 * has been cancelled due to an aborting error, an interrupt, or an
19460 * exception.
19462 if (!aborting())
19463 EMSG2(_(e_invexpr2), p);
19464 need_clr_eos = FALSE;
19465 break;
19467 need_clr_eos = FALSE;
19469 if (!eap->skip)
19471 if (atstart)
19473 atstart = FALSE;
19474 /* Call msg_start() after eval1(), evaluating the expression
19475 * may cause a message to appear. */
19476 if (eap->cmdidx == CMD_echo)
19477 msg_start();
19479 else if (eap->cmdidx == CMD_echo)
19480 msg_puts_attr((char_u *)" ", echo_attr);
19481 p = echo_string(&rettv, &tofree, numbuf, ++current_copyID);
19482 if (p != NULL)
19483 for ( ; *p != NUL && !got_int; ++p)
19485 if (*p == '\n' || *p == '\r' || *p == TAB)
19487 if (*p != TAB && needclr)
19489 /* remove any text still there from the command */
19490 msg_clr_eos();
19491 needclr = FALSE;
19493 msg_putchar_attr(*p, echo_attr);
19495 else
19497 #ifdef FEAT_MBYTE
19498 if (has_mbyte)
19500 int i = (*mb_ptr2len)(p);
19502 (void)msg_outtrans_len_attr(p, i, echo_attr);
19503 p += i - 1;
19505 else
19506 #endif
19507 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19510 vim_free(tofree);
19512 clear_tv(&rettv);
19513 arg = skipwhite(arg);
19515 eap->nextcmd = check_nextcmd(arg);
19517 if (eap->skip)
19518 --emsg_skip;
19519 else
19521 /* remove text that may still be there from the command */
19522 if (needclr)
19523 msg_clr_eos();
19524 if (eap->cmdidx == CMD_echo)
19525 msg_end();
19530 * ":echohl {name}".
19532 void
19533 ex_echohl(eap)
19534 exarg_T *eap;
19536 int id;
19538 id = syn_name2id(eap->arg);
19539 if (id == 0)
19540 echo_attr = 0;
19541 else
19542 echo_attr = syn_id2attr(id);
19546 * ":execute expr1 ..." execute the result of an expression.
19547 * ":echomsg expr1 ..." Print a message
19548 * ":echoerr expr1 ..." Print an error
19549 * Each gets spaces around each argument and a newline at the end for
19550 * echo commands
19552 void
19553 ex_execute(eap)
19554 exarg_T *eap;
19556 char_u *arg = eap->arg;
19557 typval_T rettv;
19558 int ret = OK;
19559 char_u *p;
19560 garray_T ga;
19561 int len;
19562 int save_did_emsg;
19564 ga_init2(&ga, 1, 80);
19566 if (eap->skip)
19567 ++emsg_skip;
19568 while (*arg != NUL && *arg != '|' && *arg != '\n')
19570 p = arg;
19571 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19574 * Report the invalid expression unless the expression evaluation
19575 * has been cancelled due to an aborting error, an interrupt, or an
19576 * exception.
19578 if (!aborting())
19579 EMSG2(_(e_invexpr2), p);
19580 ret = FAIL;
19581 break;
19584 if (!eap->skip)
19586 p = get_tv_string(&rettv);
19587 len = (int)STRLEN(p);
19588 if (ga_grow(&ga, len + 2) == FAIL)
19590 clear_tv(&rettv);
19591 ret = FAIL;
19592 break;
19594 if (ga.ga_len)
19595 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19596 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19597 ga.ga_len += len;
19600 clear_tv(&rettv);
19601 arg = skipwhite(arg);
19604 if (ret != FAIL && ga.ga_data != NULL)
19606 if (eap->cmdidx == CMD_echomsg)
19608 MSG_ATTR(ga.ga_data, echo_attr);
19609 out_flush();
19611 else if (eap->cmdidx == CMD_echoerr)
19613 /* We don't want to abort following commands, restore did_emsg. */
19614 save_did_emsg = did_emsg;
19615 EMSG((char_u *)ga.ga_data);
19616 if (!force_abort)
19617 did_emsg = save_did_emsg;
19619 else if (eap->cmdidx == CMD_execute)
19620 do_cmdline((char_u *)ga.ga_data,
19621 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19624 ga_clear(&ga);
19626 if (eap->skip)
19627 --emsg_skip;
19629 eap->nextcmd = check_nextcmd(arg);
19633 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19634 * "arg" points to the "&" or '+' when called, to "option" when returning.
19635 * Returns NULL when no option name found. Otherwise pointer to the char
19636 * after the option name.
19638 static char_u *
19639 find_option_end(arg, opt_flags)
19640 char_u **arg;
19641 int *opt_flags;
19643 char_u *p = *arg;
19645 ++p;
19646 if (*p == 'g' && p[1] == ':')
19648 *opt_flags = OPT_GLOBAL;
19649 p += 2;
19651 else if (*p == 'l' && p[1] == ':')
19653 *opt_flags = OPT_LOCAL;
19654 p += 2;
19656 else
19657 *opt_flags = 0;
19659 if (!ASCII_ISALPHA(*p))
19660 return NULL;
19661 *arg = p;
19663 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19664 p += 4; /* termcap option */
19665 else
19666 while (ASCII_ISALPHA(*p))
19667 ++p;
19668 return p;
19672 * ":function"
19674 void
19675 ex_function(eap)
19676 exarg_T *eap;
19678 char_u *theline;
19679 int j;
19680 int c;
19681 int saved_did_emsg;
19682 char_u *name = NULL;
19683 char_u *p;
19684 char_u *arg;
19685 char_u *line_arg = NULL;
19686 garray_T newargs;
19687 garray_T newlines;
19688 int varargs = FALSE;
19689 int mustend = FALSE;
19690 int flags = 0;
19691 ufunc_T *fp;
19692 int indent;
19693 int nesting;
19694 char_u *skip_until = NULL;
19695 dictitem_T *v;
19696 funcdict_T fudi;
19697 static int func_nr = 0; /* number for nameless function */
19698 int paren;
19699 hashtab_T *ht;
19700 int todo;
19701 hashitem_T *hi;
19702 int sourcing_lnum_off;
19705 * ":function" without argument: list functions.
19707 if (ends_excmd(*eap->arg))
19709 if (!eap->skip)
19711 todo = (int)func_hashtab.ht_used;
19712 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19714 if (!HASHITEM_EMPTY(hi))
19716 --todo;
19717 fp = HI2UF(hi);
19718 if (!isdigit(*fp->uf_name))
19719 list_func_head(fp, FALSE);
19723 eap->nextcmd = check_nextcmd(eap->arg);
19724 return;
19728 * ":function /pat": list functions matching pattern.
19730 if (*eap->arg == '/')
19732 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19733 if (!eap->skip)
19735 regmatch_T regmatch;
19737 c = *p;
19738 *p = NUL;
19739 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19740 *p = c;
19741 if (regmatch.regprog != NULL)
19743 regmatch.rm_ic = p_ic;
19745 todo = (int)func_hashtab.ht_used;
19746 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19748 if (!HASHITEM_EMPTY(hi))
19750 --todo;
19751 fp = HI2UF(hi);
19752 if (!isdigit(*fp->uf_name)
19753 && vim_regexec(&regmatch, fp->uf_name, 0))
19754 list_func_head(fp, FALSE);
19759 if (*p == '/')
19760 ++p;
19761 eap->nextcmd = check_nextcmd(p);
19762 return;
19766 * Get the function name. There are these situations:
19767 * func normal function name
19768 * "name" == func, "fudi.fd_dict" == NULL
19769 * dict.func new dictionary entry
19770 * "name" == NULL, "fudi.fd_dict" set,
19771 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19772 * dict.func existing dict entry with a Funcref
19773 * "name" == func, "fudi.fd_dict" set,
19774 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19775 * dict.func existing dict entry that's not a Funcref
19776 * "name" == NULL, "fudi.fd_dict" set,
19777 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19779 p = eap->arg;
19780 name = trans_function_name(&p, eap->skip, 0, &fudi);
19781 paren = (vim_strchr(p, '(') != NULL);
19782 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19785 * Return on an invalid expression in braces, unless the expression
19786 * evaluation has been cancelled due to an aborting error, an
19787 * interrupt, or an exception.
19789 if (!aborting())
19791 if (!eap->skip && fudi.fd_newkey != NULL)
19792 EMSG2(_(e_dictkey), fudi.fd_newkey);
19793 vim_free(fudi.fd_newkey);
19794 return;
19796 else
19797 eap->skip = TRUE;
19800 /* An error in a function call during evaluation of an expression in magic
19801 * braces should not cause the function not to be defined. */
19802 saved_did_emsg = did_emsg;
19803 did_emsg = FALSE;
19806 * ":function func" with only function name: list function.
19808 if (!paren)
19810 if (!ends_excmd(*skipwhite(p)))
19812 EMSG(_(e_trailing));
19813 goto ret_free;
19815 eap->nextcmd = check_nextcmd(p);
19816 if (eap->nextcmd != NULL)
19817 *p = NUL;
19818 if (!eap->skip && !got_int)
19820 fp = find_func(name);
19821 if (fp != NULL)
19823 list_func_head(fp, TRUE);
19824 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19826 if (FUNCLINE(fp, j) == NULL)
19827 continue;
19828 msg_putchar('\n');
19829 msg_outnum((long)(j + 1));
19830 if (j < 9)
19831 msg_putchar(' ');
19832 if (j < 99)
19833 msg_putchar(' ');
19834 msg_prt_line(FUNCLINE(fp, j), FALSE);
19835 out_flush(); /* show a line at a time */
19836 ui_breakcheck();
19838 if (!got_int)
19840 msg_putchar('\n');
19841 msg_puts((char_u *)" endfunction");
19844 else
19845 emsg_funcname("E123: Undefined function: %s", name);
19847 goto ret_free;
19851 * ":function name(arg1, arg2)" Define function.
19853 p = skipwhite(p);
19854 if (*p != '(')
19856 if (!eap->skip)
19858 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19859 goto ret_free;
19861 /* attempt to continue by skipping some text */
19862 if (vim_strchr(p, '(') != NULL)
19863 p = vim_strchr(p, '(');
19865 p = skipwhite(p + 1);
19867 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19868 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19870 if (!eap->skip)
19872 /* Check the name of the function. Unless it's a dictionary function
19873 * (that we are overwriting). */
19874 if (name != NULL)
19875 arg = name;
19876 else
19877 arg = fudi.fd_newkey;
19878 if (arg != NULL && (fudi.fd_di == NULL
19879 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19881 if (*arg == K_SPECIAL)
19882 j = 3;
19883 else
19884 j = 0;
19885 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19886 : eval_isnamec(arg[j])))
19887 ++j;
19888 if (arg[j] != NUL)
19889 emsg_funcname(_(e_invarg2), arg);
19894 * Isolate the arguments: "arg1, arg2, ...)"
19896 while (*p != ')')
19898 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19900 varargs = TRUE;
19901 p += 3;
19902 mustend = TRUE;
19904 else
19906 arg = p;
19907 while (ASCII_ISALNUM(*p) || *p == '_')
19908 ++p;
19909 if (arg == p || isdigit(*arg)
19910 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19911 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19913 if (!eap->skip)
19914 EMSG2(_("E125: Illegal argument: %s"), arg);
19915 break;
19917 if (ga_grow(&newargs, 1) == FAIL)
19918 goto erret;
19919 c = *p;
19920 *p = NUL;
19921 arg = vim_strsave(arg);
19922 if (arg == NULL)
19923 goto erret;
19924 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19925 *p = c;
19926 newargs.ga_len++;
19927 if (*p == ',')
19928 ++p;
19929 else
19930 mustend = TRUE;
19932 p = skipwhite(p);
19933 if (mustend && *p != ')')
19935 if (!eap->skip)
19936 EMSG2(_(e_invarg2), eap->arg);
19937 break;
19940 ++p; /* skip the ')' */
19942 /* find extra arguments "range", "dict" and "abort" */
19943 for (;;)
19945 p = skipwhite(p);
19946 if (STRNCMP(p, "range", 5) == 0)
19948 flags |= FC_RANGE;
19949 p += 5;
19951 else if (STRNCMP(p, "dict", 4) == 0)
19953 flags |= FC_DICT;
19954 p += 4;
19956 else if (STRNCMP(p, "abort", 5) == 0)
19958 flags |= FC_ABORT;
19959 p += 5;
19961 else
19962 break;
19965 /* When there is a line break use what follows for the function body.
19966 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19967 if (*p == '\n')
19968 line_arg = p + 1;
19969 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19970 EMSG(_(e_trailing));
19973 * Read the body of the function, until ":endfunction" is found.
19975 if (KeyTyped)
19977 /* Check if the function already exists, don't let the user type the
19978 * whole function before telling him it doesn't work! For a script we
19979 * need to skip the body to be able to find what follows. */
19980 if (!eap->skip && !eap->forceit)
19982 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19983 EMSG(_(e_funcdict));
19984 else if (name != NULL && find_func(name) != NULL)
19985 emsg_funcname(e_funcexts, name);
19988 if (!eap->skip && did_emsg)
19989 goto erret;
19991 msg_putchar('\n'); /* don't overwrite the function name */
19992 cmdline_row = msg_row;
19995 indent = 2;
19996 nesting = 0;
19997 for (;;)
19999 msg_scroll = TRUE;
20000 need_wait_return = FALSE;
20001 sourcing_lnum_off = sourcing_lnum;
20003 if (line_arg != NULL)
20005 /* Use eap->arg, split up in parts by line breaks. */
20006 theline = line_arg;
20007 p = vim_strchr(theline, '\n');
20008 if (p == NULL)
20009 line_arg += STRLEN(line_arg);
20010 else
20012 *p = NUL;
20013 line_arg = p + 1;
20016 else if (eap->getline == NULL)
20017 theline = getcmdline(':', 0L, indent);
20018 else
20019 theline = eap->getline(':', eap->cookie, indent);
20020 if (KeyTyped)
20021 lines_left = Rows - 1;
20022 if (theline == NULL)
20024 EMSG(_("E126: Missing :endfunction"));
20025 goto erret;
20028 /* Detect line continuation: sourcing_lnum increased more than one. */
20029 if (sourcing_lnum > sourcing_lnum_off + 1)
20030 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20031 else
20032 sourcing_lnum_off = 0;
20034 if (skip_until != NULL)
20036 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20037 * don't check for ":endfunc". */
20038 if (STRCMP(theline, skip_until) == 0)
20040 vim_free(skip_until);
20041 skip_until = NULL;
20044 else
20046 /* skip ':' and blanks*/
20047 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20050 /* Check for "endfunction". */
20051 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20053 if (line_arg == NULL)
20054 vim_free(theline);
20055 break;
20058 /* Increase indent inside "if", "while", "for" and "try", decrease
20059 * at "end". */
20060 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20061 indent -= 2;
20062 else if (STRNCMP(p, "if", 2) == 0
20063 || STRNCMP(p, "wh", 2) == 0
20064 || STRNCMP(p, "for", 3) == 0
20065 || STRNCMP(p, "try", 3) == 0)
20066 indent += 2;
20068 /* Check for defining a function inside this function. */
20069 if (checkforcmd(&p, "function", 2))
20071 if (*p == '!')
20072 p = skipwhite(p + 1);
20073 p += eval_fname_script(p);
20074 if (ASCII_ISALPHA(*p))
20076 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20077 if (*skipwhite(p) == '(')
20079 ++nesting;
20080 indent += 2;
20085 /* Check for ":append" or ":insert". */
20086 p = skip_range(p, NULL);
20087 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20088 || (p[0] == 'i'
20089 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20090 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20091 skip_until = vim_strsave((char_u *)".");
20093 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20094 arg = skipwhite(skiptowhite(p));
20095 if (arg[0] == '<' && arg[1] =='<'
20096 && ((p[0] == 'p' && p[1] == 'y'
20097 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20098 || (p[0] == 'p' && p[1] == 'e'
20099 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20100 || (p[0] == 't' && p[1] == 'c'
20101 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20102 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20103 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20104 || (p[0] == 'm' && p[1] == 'z'
20105 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20108 /* ":python <<" continues until a dot, like ":append" */
20109 p = skipwhite(arg + 2);
20110 if (*p == NUL)
20111 skip_until = vim_strsave((char_u *)".");
20112 else
20113 skip_until = vim_strsave(p);
20117 /* Add the line to the function. */
20118 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20120 if (line_arg == NULL)
20121 vim_free(theline);
20122 goto erret;
20125 /* Copy the line to newly allocated memory. get_one_sourceline()
20126 * allocates 250 bytes per line, this saves 80% on average. The cost
20127 * is an extra alloc/free. */
20128 p = vim_strsave(theline);
20129 if (p != NULL)
20131 if (line_arg == NULL)
20132 vim_free(theline);
20133 theline = p;
20136 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20138 /* Add NULL lines for continuation lines, so that the line count is
20139 * equal to the index in the growarray. */
20140 while (sourcing_lnum_off-- > 0)
20141 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20143 /* Check for end of eap->arg. */
20144 if (line_arg != NULL && *line_arg == NUL)
20145 line_arg = NULL;
20148 /* Don't define the function when skipping commands or when an error was
20149 * detected. */
20150 if (eap->skip || did_emsg)
20151 goto erret;
20154 * If there are no errors, add the function
20156 if (fudi.fd_dict == NULL)
20158 v = find_var(name, &ht);
20159 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20161 emsg_funcname("E707: Function name conflicts with variable: %s",
20162 name);
20163 goto erret;
20166 fp = find_func(name);
20167 if (fp != NULL)
20169 if (!eap->forceit)
20171 emsg_funcname(e_funcexts, name);
20172 goto erret;
20174 if (fp->uf_calls > 0)
20176 emsg_funcname("E127: Cannot redefine function %s: It is in use",
20177 name);
20178 goto erret;
20180 /* redefine existing function */
20181 ga_clear_strings(&(fp->uf_args));
20182 ga_clear_strings(&(fp->uf_lines));
20183 vim_free(name);
20184 name = NULL;
20187 else
20189 char numbuf[20];
20191 fp = NULL;
20192 if (fudi.fd_newkey == NULL && !eap->forceit)
20194 EMSG(_(e_funcdict));
20195 goto erret;
20197 if (fudi.fd_di == NULL)
20199 /* Can't add a function to a locked dictionary */
20200 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20201 goto erret;
20203 /* Can't change an existing function if it is locked */
20204 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20205 goto erret;
20207 /* Give the function a sequential number. Can only be used with a
20208 * Funcref! */
20209 vim_free(name);
20210 sprintf(numbuf, "%d", ++func_nr);
20211 name = vim_strsave((char_u *)numbuf);
20212 if (name == NULL)
20213 goto erret;
20216 if (fp == NULL)
20218 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20220 int slen, plen;
20221 char_u *scriptname;
20223 /* Check that the autoload name matches the script name. */
20224 j = FAIL;
20225 if (sourcing_name != NULL)
20227 scriptname = autoload_name(name);
20228 if (scriptname != NULL)
20230 p = vim_strchr(scriptname, '/');
20231 plen = (int)STRLEN(p);
20232 slen = (int)STRLEN(sourcing_name);
20233 if (slen > plen && fnamecmp(p,
20234 sourcing_name + slen - plen) == 0)
20235 j = OK;
20236 vim_free(scriptname);
20239 if (j == FAIL)
20241 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20242 goto erret;
20246 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20247 if (fp == NULL)
20248 goto erret;
20250 if (fudi.fd_dict != NULL)
20252 if (fudi.fd_di == NULL)
20254 /* add new dict entry */
20255 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20256 if (fudi.fd_di == NULL)
20258 vim_free(fp);
20259 goto erret;
20261 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20263 vim_free(fudi.fd_di);
20264 vim_free(fp);
20265 goto erret;
20268 else
20269 /* overwrite existing dict entry */
20270 clear_tv(&fudi.fd_di->di_tv);
20271 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20272 fudi.fd_di->di_tv.v_lock = 0;
20273 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20274 fp->uf_refcount = 1;
20276 /* behave like "dict" was used */
20277 flags |= FC_DICT;
20280 /* insert the new function in the function list */
20281 STRCPY(fp->uf_name, name);
20282 hash_add(&func_hashtab, UF2HIKEY(fp));
20284 fp->uf_args = newargs;
20285 fp->uf_lines = newlines;
20286 #ifdef FEAT_PROFILE
20287 fp->uf_tml_count = NULL;
20288 fp->uf_tml_total = NULL;
20289 fp->uf_tml_self = NULL;
20290 fp->uf_profiling = FALSE;
20291 if (prof_def_func())
20292 func_do_profile(fp);
20293 #endif
20294 fp->uf_varargs = varargs;
20295 fp->uf_flags = flags;
20296 fp->uf_calls = 0;
20297 fp->uf_script_ID = current_SID;
20298 goto ret_free;
20300 erret:
20301 ga_clear_strings(&newargs);
20302 ga_clear_strings(&newlines);
20303 ret_free:
20304 vim_free(skip_until);
20305 vim_free(fudi.fd_newkey);
20306 vim_free(name);
20307 did_emsg |= saved_did_emsg;
20311 * Get a function name, translating "<SID>" and "<SNR>".
20312 * Also handles a Funcref in a List or Dictionary.
20313 * Returns the function name in allocated memory, or NULL for failure.
20314 * flags:
20315 * TFN_INT: internal function name OK
20316 * TFN_QUIET: be quiet
20317 * Advances "pp" to just after the function name (if no error).
20319 static char_u *
20320 trans_function_name(pp, skip, flags, fdp)
20321 char_u **pp;
20322 int skip; /* only find the end, don't evaluate */
20323 int flags;
20324 funcdict_T *fdp; /* return: info about dictionary used */
20326 char_u *name = NULL;
20327 char_u *start;
20328 char_u *end;
20329 int lead;
20330 char_u sid_buf[20];
20331 int len;
20332 lval_T lv;
20334 if (fdp != NULL)
20335 vim_memset(fdp, 0, sizeof(funcdict_T));
20336 start = *pp;
20338 /* Check for hard coded <SNR>: already translated function ID (from a user
20339 * command). */
20340 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20341 && (*pp)[2] == (int)KE_SNR)
20343 *pp += 3;
20344 len = get_id_len(pp) + 3;
20345 return vim_strnsave(start, len);
20348 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20349 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20350 lead = eval_fname_script(start);
20351 if (lead > 2)
20352 start += lead;
20354 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20355 lead > 2 ? 0 : FNE_CHECK_START);
20356 if (end == start)
20358 if (!skip)
20359 EMSG(_("E129: Function name required"));
20360 goto theend;
20362 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20365 * Report an invalid expression in braces, unless the expression
20366 * evaluation has been cancelled due to an aborting error, an
20367 * interrupt, or an exception.
20369 if (!aborting())
20371 if (end != NULL)
20372 EMSG2(_(e_invarg2), start);
20374 else
20375 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20376 goto theend;
20379 if (lv.ll_tv != NULL)
20381 if (fdp != NULL)
20383 fdp->fd_dict = lv.ll_dict;
20384 fdp->fd_newkey = lv.ll_newkey;
20385 lv.ll_newkey = NULL;
20386 fdp->fd_di = lv.ll_di;
20388 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20390 name = vim_strsave(lv.ll_tv->vval.v_string);
20391 *pp = end;
20393 else
20395 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20396 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20397 EMSG(_(e_funcref));
20398 else
20399 *pp = end;
20400 name = NULL;
20402 goto theend;
20405 if (lv.ll_name == NULL)
20407 /* Error found, but continue after the function name. */
20408 *pp = end;
20409 goto theend;
20412 /* Check if the name is a Funcref. If so, use the value. */
20413 if (lv.ll_exp_name != NULL)
20415 len = (int)STRLEN(lv.ll_exp_name);
20416 name = deref_func_name(lv.ll_exp_name, &len);
20417 if (name == lv.ll_exp_name)
20418 name = NULL;
20420 else
20422 len = (int)(end - *pp);
20423 name = deref_func_name(*pp, &len);
20424 if (name == *pp)
20425 name = NULL;
20427 if (name != NULL)
20429 name = vim_strsave(name);
20430 *pp = end;
20431 goto theend;
20434 if (lv.ll_exp_name != NULL)
20436 len = (int)STRLEN(lv.ll_exp_name);
20437 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20438 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20440 /* When there was "s:" already or the name expanded to get a
20441 * leading "s:" then remove it. */
20442 lv.ll_name += 2;
20443 len -= 2;
20444 lead = 2;
20447 else
20449 if (lead == 2) /* skip over "s:" */
20450 lv.ll_name += 2;
20451 len = (int)(end - lv.ll_name);
20455 * Copy the function name to allocated memory.
20456 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20457 * Accept <SNR>123_name() outside a script.
20459 if (skip)
20460 lead = 0; /* do nothing */
20461 else if (lead > 0)
20463 lead = 3;
20464 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20465 || eval_fname_sid(*pp))
20467 /* It's "s:" or "<SID>" */
20468 if (current_SID <= 0)
20470 EMSG(_(e_usingsid));
20471 goto theend;
20473 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20474 lead += (int)STRLEN(sid_buf);
20477 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20479 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20480 goto theend;
20482 name = alloc((unsigned)(len + lead + 1));
20483 if (name != NULL)
20485 if (lead > 0)
20487 name[0] = K_SPECIAL;
20488 name[1] = KS_EXTRA;
20489 name[2] = (int)KE_SNR;
20490 if (lead > 3) /* If it's "<SID>" */
20491 STRCPY(name + 3, sid_buf);
20493 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20494 name[len + lead] = NUL;
20496 *pp = end;
20498 theend:
20499 clear_lval(&lv);
20500 return name;
20504 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20505 * Return 2 if "p" starts with "s:".
20506 * Return 0 otherwise.
20508 static int
20509 eval_fname_script(p)
20510 char_u *p;
20512 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20513 || STRNICMP(p + 1, "SNR>", 4) == 0))
20514 return 5;
20515 if (p[0] == 's' && p[1] == ':')
20516 return 2;
20517 return 0;
20521 * Return TRUE if "p" starts with "<SID>" or "s:".
20522 * Only works if eval_fname_script() returned non-zero for "p"!
20524 static int
20525 eval_fname_sid(p)
20526 char_u *p;
20528 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20532 * List the head of the function: "name(arg1, arg2)".
20534 static void
20535 list_func_head(fp, indent)
20536 ufunc_T *fp;
20537 int indent;
20539 int j;
20541 msg_start();
20542 if (indent)
20543 MSG_PUTS(" ");
20544 MSG_PUTS("function ");
20545 if (fp->uf_name[0] == K_SPECIAL)
20547 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20548 msg_puts(fp->uf_name + 3);
20550 else
20551 msg_puts(fp->uf_name);
20552 msg_putchar('(');
20553 for (j = 0; j < fp->uf_args.ga_len; ++j)
20555 if (j)
20556 MSG_PUTS(", ");
20557 msg_puts(FUNCARG(fp, j));
20559 if (fp->uf_varargs)
20561 if (j)
20562 MSG_PUTS(", ");
20563 MSG_PUTS("...");
20565 msg_putchar(')');
20566 msg_clr_eos();
20567 if (p_verbose > 0)
20568 last_set_msg(fp->uf_script_ID);
20572 * Find a function by name, return pointer to it in ufuncs.
20573 * Return NULL for unknown function.
20575 static ufunc_T *
20576 find_func(name)
20577 char_u *name;
20579 hashitem_T *hi;
20581 hi = hash_find(&func_hashtab, name);
20582 if (!HASHITEM_EMPTY(hi))
20583 return HI2UF(hi);
20584 return NULL;
20587 #if defined(EXITFREE) || defined(PROTO)
20588 void
20589 free_all_functions()
20591 hashitem_T *hi;
20593 /* Need to start all over every time, because func_free() may change the
20594 * hash table. */
20595 while (func_hashtab.ht_used > 0)
20596 for (hi = func_hashtab.ht_array; ; ++hi)
20597 if (!HASHITEM_EMPTY(hi))
20599 func_free(HI2UF(hi));
20600 break;
20603 #endif
20606 * Return TRUE if a function "name" exists.
20608 static int
20609 function_exists(name)
20610 char_u *name;
20612 char_u *nm = name;
20613 char_u *p;
20614 int n = FALSE;
20616 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20617 nm = skipwhite(nm);
20619 /* Only accept "funcname", "funcname ", "funcname (..." and
20620 * "funcname(...", not "funcname!...". */
20621 if (p != NULL && (*nm == NUL || *nm == '('))
20623 if (builtin_function(p))
20624 n = (find_internal_func(p) >= 0);
20625 else
20626 n = (find_func(p) != NULL);
20628 vim_free(p);
20629 return n;
20633 * Return TRUE if "name" looks like a builtin function name: starts with a
20634 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20636 static int
20637 builtin_function(name)
20638 char_u *name;
20640 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20641 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20644 #if defined(FEAT_PROFILE) || defined(PROTO)
20646 * Start profiling function "fp".
20648 static void
20649 func_do_profile(fp)
20650 ufunc_T *fp;
20652 fp->uf_tm_count = 0;
20653 profile_zero(&fp->uf_tm_self);
20654 profile_zero(&fp->uf_tm_total);
20655 if (fp->uf_tml_count == NULL)
20656 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20657 (sizeof(int) * fp->uf_lines.ga_len));
20658 if (fp->uf_tml_total == NULL)
20659 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20660 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20661 if (fp->uf_tml_self == NULL)
20662 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20663 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20664 fp->uf_tml_idx = -1;
20665 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20666 || fp->uf_tml_self == NULL)
20667 return; /* out of memory */
20669 fp->uf_profiling = TRUE;
20673 * Dump the profiling results for all functions in file "fd".
20675 void
20676 func_dump_profile(fd)
20677 FILE *fd;
20679 hashitem_T *hi;
20680 int todo;
20681 ufunc_T *fp;
20682 int i;
20683 ufunc_T **sorttab;
20684 int st_len = 0;
20686 todo = (int)func_hashtab.ht_used;
20687 if (todo == 0)
20688 return; /* nothing to dump */
20690 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20692 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20694 if (!HASHITEM_EMPTY(hi))
20696 --todo;
20697 fp = HI2UF(hi);
20698 if (fp->uf_profiling)
20700 if (sorttab != NULL)
20701 sorttab[st_len++] = fp;
20703 if (fp->uf_name[0] == K_SPECIAL)
20704 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20705 else
20706 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20707 if (fp->uf_tm_count == 1)
20708 fprintf(fd, "Called 1 time\n");
20709 else
20710 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20711 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20712 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20713 fprintf(fd, "\n");
20714 fprintf(fd, "count total (s) self (s)\n");
20716 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20718 if (FUNCLINE(fp, i) == NULL)
20719 continue;
20720 prof_func_line(fd, fp->uf_tml_count[i],
20721 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20722 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20724 fprintf(fd, "\n");
20729 if (sorttab != NULL && st_len > 0)
20731 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20732 prof_total_cmp);
20733 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20734 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20735 prof_self_cmp);
20736 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20739 vim_free(sorttab);
20742 static void
20743 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20744 FILE *fd;
20745 ufunc_T **sorttab;
20746 int st_len;
20747 char *title;
20748 int prefer_self; /* when equal print only self time */
20750 int i;
20751 ufunc_T *fp;
20753 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20754 fprintf(fd, "count total (s) self (s) function\n");
20755 for (i = 0; i < 20 && i < st_len; ++i)
20757 fp = sorttab[i];
20758 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20759 prefer_self);
20760 if (fp->uf_name[0] == K_SPECIAL)
20761 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20762 else
20763 fprintf(fd, " %s()\n", fp->uf_name);
20765 fprintf(fd, "\n");
20769 * Print the count and times for one function or function line.
20771 static void
20772 prof_func_line(fd, count, total, self, prefer_self)
20773 FILE *fd;
20774 int count;
20775 proftime_T *total;
20776 proftime_T *self;
20777 int prefer_self; /* when equal print only self time */
20779 if (count > 0)
20781 fprintf(fd, "%5d ", count);
20782 if (prefer_self && profile_equal(total, self))
20783 fprintf(fd, " ");
20784 else
20785 fprintf(fd, "%s ", profile_msg(total));
20786 if (!prefer_self && profile_equal(total, self))
20787 fprintf(fd, " ");
20788 else
20789 fprintf(fd, "%s ", profile_msg(self));
20791 else
20792 fprintf(fd, " ");
20796 * Compare function for total time sorting.
20798 static int
20799 #ifdef __BORLANDC__
20800 _RTLENTRYF
20801 #endif
20802 prof_total_cmp(s1, s2)
20803 const void *s1;
20804 const void *s2;
20806 ufunc_T *p1, *p2;
20808 p1 = *(ufunc_T **)s1;
20809 p2 = *(ufunc_T **)s2;
20810 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20814 * Compare function for self time sorting.
20816 static int
20817 #ifdef __BORLANDC__
20818 _RTLENTRYF
20819 #endif
20820 prof_self_cmp(s1, s2)
20821 const void *s1;
20822 const void *s2;
20824 ufunc_T *p1, *p2;
20826 p1 = *(ufunc_T **)s1;
20827 p2 = *(ufunc_T **)s2;
20828 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20831 #endif
20834 * If "name" has a package name try autoloading the script for it.
20835 * Return TRUE if a package was loaded.
20837 static int
20838 script_autoload(name, reload)
20839 char_u *name;
20840 int reload; /* load script again when already loaded */
20842 char_u *p;
20843 char_u *scriptname, *tofree;
20844 int ret = FALSE;
20845 int i;
20847 /* If there is no '#' after name[0] there is no package name. */
20848 p = vim_strchr(name, AUTOLOAD_CHAR);
20849 if (p == NULL || p == name)
20850 return FALSE;
20852 tofree = scriptname = autoload_name(name);
20854 /* Find the name in the list of previously loaded package names. Skip
20855 * "autoload/", it's always the same. */
20856 for (i = 0; i < ga_loaded.ga_len; ++i)
20857 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20858 break;
20859 if (!reload && i < ga_loaded.ga_len)
20860 ret = FALSE; /* was loaded already */
20861 else
20863 /* Remember the name if it wasn't loaded already. */
20864 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20866 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20867 tofree = NULL;
20870 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20871 if (source_runtime(scriptname, FALSE) == OK)
20872 ret = TRUE;
20875 vim_free(tofree);
20876 return ret;
20880 * Return the autoload script name for a function or variable name.
20881 * Returns NULL when out of memory.
20883 static char_u *
20884 autoload_name(name)
20885 char_u *name;
20887 char_u *p;
20888 char_u *scriptname;
20890 /* Get the script file name: replace '#' with '/', append ".vim". */
20891 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20892 if (scriptname == NULL)
20893 return FALSE;
20894 STRCPY(scriptname, "autoload/");
20895 STRCAT(scriptname, name);
20896 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20897 STRCAT(scriptname, ".vim");
20898 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20899 *p = '/';
20900 return scriptname;
20903 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20906 * Function given to ExpandGeneric() to obtain the list of user defined
20907 * function names.
20909 char_u *
20910 get_user_func_name(xp, idx)
20911 expand_T *xp;
20912 int idx;
20914 static long_u done;
20915 static hashitem_T *hi;
20916 ufunc_T *fp;
20918 if (idx == 0)
20920 done = 0;
20921 hi = func_hashtab.ht_array;
20923 if (done < func_hashtab.ht_used)
20925 if (done++ > 0)
20926 ++hi;
20927 while (HASHITEM_EMPTY(hi))
20928 ++hi;
20929 fp = HI2UF(hi);
20931 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20932 return fp->uf_name; /* prevents overflow */
20934 cat_func_name(IObuff, fp);
20935 if (xp->xp_context != EXPAND_USER_FUNC)
20937 STRCAT(IObuff, "(");
20938 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20939 STRCAT(IObuff, ")");
20941 return IObuff;
20943 return NULL;
20946 #endif /* FEAT_CMDL_COMPL */
20949 * Copy the function name of "fp" to buffer "buf".
20950 * "buf" must be able to hold the function name plus three bytes.
20951 * Takes care of script-local function names.
20953 static void
20954 cat_func_name(buf, fp)
20955 char_u *buf;
20956 ufunc_T *fp;
20958 if (fp->uf_name[0] == K_SPECIAL)
20960 STRCPY(buf, "<SNR>");
20961 STRCAT(buf, fp->uf_name + 3);
20963 else
20964 STRCPY(buf, fp->uf_name);
20968 * ":delfunction {name}"
20970 void
20971 ex_delfunction(eap)
20972 exarg_T *eap;
20974 ufunc_T *fp = NULL;
20975 char_u *p;
20976 char_u *name;
20977 funcdict_T fudi;
20979 p = eap->arg;
20980 name = trans_function_name(&p, eap->skip, 0, &fudi);
20981 vim_free(fudi.fd_newkey);
20982 if (name == NULL)
20984 if (fudi.fd_dict != NULL && !eap->skip)
20985 EMSG(_(e_funcref));
20986 return;
20988 if (!ends_excmd(*skipwhite(p)))
20990 vim_free(name);
20991 EMSG(_(e_trailing));
20992 return;
20994 eap->nextcmd = check_nextcmd(p);
20995 if (eap->nextcmd != NULL)
20996 *p = NUL;
20998 if (!eap->skip)
20999 fp = find_func(name);
21000 vim_free(name);
21002 if (!eap->skip)
21004 if (fp == NULL)
21006 EMSG2(_(e_nofunc), eap->arg);
21007 return;
21009 if (fp->uf_calls > 0)
21011 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21012 return;
21015 if (fudi.fd_dict != NULL)
21017 /* Delete the dict item that refers to the function, it will
21018 * invoke func_unref() and possibly delete the function. */
21019 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21021 else
21022 func_free(fp);
21027 * Free a function and remove it from the list of functions.
21029 static void
21030 func_free(fp)
21031 ufunc_T *fp;
21033 hashitem_T *hi;
21035 /* clear this function */
21036 ga_clear_strings(&(fp->uf_args));
21037 ga_clear_strings(&(fp->uf_lines));
21038 #ifdef FEAT_PROFILE
21039 vim_free(fp->uf_tml_count);
21040 vim_free(fp->uf_tml_total);
21041 vim_free(fp->uf_tml_self);
21042 #endif
21044 /* remove the function from the function hashtable */
21045 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21046 if (HASHITEM_EMPTY(hi))
21047 EMSG2(_(e_intern2), "func_free()");
21048 else
21049 hash_remove(&func_hashtab, hi);
21051 vim_free(fp);
21055 * Unreference a Function: decrement the reference count and free it when it
21056 * becomes zero. Only for numbered functions.
21058 static void
21059 func_unref(name)
21060 char_u *name;
21062 ufunc_T *fp;
21064 if (name != NULL && isdigit(*name))
21066 fp = find_func(name);
21067 if (fp == NULL)
21068 EMSG2(_(e_intern2), "func_unref()");
21069 else if (--fp->uf_refcount <= 0)
21071 /* Only delete it when it's not being used. Otherwise it's done
21072 * when "uf_calls" becomes zero. */
21073 if (fp->uf_calls == 0)
21074 func_free(fp);
21080 * Count a reference to a Function.
21082 static void
21083 func_ref(name)
21084 char_u *name;
21086 ufunc_T *fp;
21088 if (name != NULL && isdigit(*name))
21090 fp = find_func(name);
21091 if (fp == NULL)
21092 EMSG2(_(e_intern2), "func_ref()");
21093 else
21094 ++fp->uf_refcount;
21099 * Call a user function.
21101 static void
21102 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21103 ufunc_T *fp; /* pointer to function */
21104 int argcount; /* nr of args */
21105 typval_T *argvars; /* arguments */
21106 typval_T *rettv; /* return value */
21107 linenr_T firstline; /* first line of range */
21108 linenr_T lastline; /* last line of range */
21109 dict_T *selfdict; /* Dictionary for "self" */
21111 char_u *save_sourcing_name;
21112 linenr_T save_sourcing_lnum;
21113 scid_T save_current_SID;
21114 funccall_T fc;
21115 int save_did_emsg;
21116 static int depth = 0;
21117 dictitem_T *v;
21118 int fixvar_idx = 0; /* index in fixvar[] */
21119 int i;
21120 int ai;
21121 char_u numbuf[NUMBUFLEN];
21122 char_u *name;
21123 #ifdef FEAT_PROFILE
21124 proftime_T wait_start;
21125 proftime_T call_start;
21126 #endif
21128 /* If depth of calling is getting too high, don't execute the function */
21129 if (depth >= p_mfd)
21131 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21132 rettv->v_type = VAR_NUMBER;
21133 rettv->vval.v_number = -1;
21134 return;
21136 ++depth;
21138 line_breakcheck(); /* check for CTRL-C hit */
21140 fc.caller = current_funccal;
21141 current_funccal = &fc;
21142 fc.func = fp;
21143 fc.rettv = rettv;
21144 rettv->vval.v_number = 0;
21145 fc.linenr = 0;
21146 fc.returned = FALSE;
21147 fc.level = ex_nesting_level;
21148 /* Check if this function has a breakpoint. */
21149 fc.breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21150 fc.dbg_tick = debug_tick;
21153 * Note about using fc.fixvar[]: This is an array of FIXVAR_CNT variables
21154 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21155 * each argument variable and saves a lot of time.
21158 * Init l: variables.
21160 init_var_dict(&fc.l_vars, &fc.l_vars_var);
21161 if (selfdict != NULL)
21163 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21164 * some compiler that checks the destination size. */
21165 v = &fc.fixvar[fixvar_idx++].var;
21166 name = v->di_key;
21167 STRCPY(name, "self");
21168 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21169 hash_add(&fc.l_vars.dv_hashtab, DI2HIKEY(v));
21170 v->di_tv.v_type = VAR_DICT;
21171 v->di_tv.v_lock = 0;
21172 v->di_tv.vval.v_dict = selfdict;
21173 ++selfdict->dv_refcount;
21177 * Init a: variables.
21178 * Set a:0 to "argcount".
21179 * Set a:000 to a list with room for the "..." arguments.
21181 init_var_dict(&fc.l_avars, &fc.l_avars_var);
21182 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "0",
21183 (varnumber_T)(argcount - fp->uf_args.ga_len));
21184 /* Use "name" to avoid a warning from some compiler that checks the
21185 * destination size. */
21186 v = &fc.fixvar[fixvar_idx++].var;
21187 name = v->di_key;
21188 STRCPY(name, "000");
21189 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21190 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21191 v->di_tv.v_type = VAR_LIST;
21192 v->di_tv.v_lock = VAR_FIXED;
21193 v->di_tv.vval.v_list = &fc.l_varlist;
21194 vim_memset(&fc.l_varlist, 0, sizeof(list_T));
21195 fc.l_varlist.lv_refcount = 99999;
21196 fc.l_varlist.lv_lock = VAR_FIXED;
21199 * Set a:firstline to "firstline" and a:lastline to "lastline".
21200 * Set a:name to named arguments.
21201 * Set a:N to the "..." arguments.
21203 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "firstline",
21204 (varnumber_T)firstline);
21205 add_nr_var(&fc.l_avars, &fc.fixvar[fixvar_idx++].var, "lastline",
21206 (varnumber_T)lastline);
21207 for (i = 0; i < argcount; ++i)
21209 ai = i - fp->uf_args.ga_len;
21210 if (ai < 0)
21211 /* named argument a:name */
21212 name = FUNCARG(fp, i);
21213 else
21215 /* "..." argument a:1, a:2, etc. */
21216 sprintf((char *)numbuf, "%d", ai + 1);
21217 name = numbuf;
21219 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21221 v = &fc.fixvar[fixvar_idx++].var;
21222 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21224 else
21226 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21227 + STRLEN(name)));
21228 if (v == NULL)
21229 break;
21230 v->di_flags = DI_FLAGS_RO;
21232 STRCPY(v->di_key, name);
21233 hash_add(&fc.l_avars.dv_hashtab, DI2HIKEY(v));
21235 /* Note: the values are copied directly to avoid alloc/free.
21236 * "argvars" must have VAR_FIXED for v_lock. */
21237 v->di_tv = argvars[i];
21238 v->di_tv.v_lock = VAR_FIXED;
21240 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21242 list_append(&fc.l_varlist, &fc.l_listitems[ai]);
21243 fc.l_listitems[ai].li_tv = argvars[i];
21244 fc.l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21248 /* Don't redraw while executing the function. */
21249 ++RedrawingDisabled;
21250 save_sourcing_name = sourcing_name;
21251 save_sourcing_lnum = sourcing_lnum;
21252 sourcing_lnum = 1;
21253 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21254 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21255 if (sourcing_name != NULL)
21257 if (save_sourcing_name != NULL
21258 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21259 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21260 else
21261 STRCPY(sourcing_name, "function ");
21262 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21264 if (p_verbose >= 12)
21266 ++no_wait_return;
21267 verbose_enter_scroll();
21269 smsg((char_u *)_("calling %s"), sourcing_name);
21270 if (p_verbose >= 14)
21272 char_u buf[MSG_BUF_LEN];
21273 char_u numbuf2[NUMBUFLEN];
21274 char_u *tofree;
21275 char_u *s;
21277 msg_puts((char_u *)"(");
21278 for (i = 0; i < argcount; ++i)
21280 if (i > 0)
21281 msg_puts((char_u *)", ");
21282 if (argvars[i].v_type == VAR_NUMBER)
21283 msg_outnum((long)argvars[i].vval.v_number);
21284 else
21286 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21287 if (s != NULL)
21289 trunc_string(s, buf, MSG_BUF_CLEN);
21290 msg_puts(buf);
21291 vim_free(tofree);
21295 msg_puts((char_u *)")");
21297 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21299 verbose_leave_scroll();
21300 --no_wait_return;
21303 #ifdef FEAT_PROFILE
21304 if (do_profiling == PROF_YES)
21306 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21307 func_do_profile(fp);
21308 if (fp->uf_profiling
21309 || (fc.caller != NULL && fc.caller->func->uf_profiling))
21311 ++fp->uf_tm_count;
21312 profile_start(&call_start);
21313 profile_zero(&fp->uf_tm_children);
21315 script_prof_save(&wait_start);
21317 #endif
21319 save_current_SID = current_SID;
21320 current_SID = fp->uf_script_ID;
21321 save_did_emsg = did_emsg;
21322 did_emsg = FALSE;
21324 /* call do_cmdline() to execute the lines */
21325 do_cmdline(NULL, get_func_line, (void *)&fc,
21326 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21328 --RedrawingDisabled;
21330 /* when the function was aborted because of an error, return -1 */
21331 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21333 clear_tv(rettv);
21334 rettv->v_type = VAR_NUMBER;
21335 rettv->vval.v_number = -1;
21338 #ifdef FEAT_PROFILE
21339 if (do_profiling == PROF_YES && (fp->uf_profiling
21340 || (fc.caller != NULL && fc.caller->func->uf_profiling)))
21342 profile_end(&call_start);
21343 profile_sub_wait(&wait_start, &call_start);
21344 profile_add(&fp->uf_tm_total, &call_start);
21345 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21346 if (fc.caller != NULL && fc.caller->func->uf_profiling)
21348 profile_add(&fc.caller->func->uf_tm_children, &call_start);
21349 profile_add(&fc.caller->func->uf_tml_children, &call_start);
21352 #endif
21354 /* when being verbose, mention the return value */
21355 if (p_verbose >= 12)
21357 ++no_wait_return;
21358 verbose_enter_scroll();
21360 if (aborting())
21361 smsg((char_u *)_("%s aborted"), sourcing_name);
21362 else if (fc.rettv->v_type == VAR_NUMBER)
21363 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21364 (long)fc.rettv->vval.v_number);
21365 else
21367 char_u buf[MSG_BUF_LEN];
21368 char_u numbuf2[NUMBUFLEN];
21369 char_u *tofree;
21370 char_u *s;
21372 /* The value may be very long. Skip the middle part, so that we
21373 * have some idea how it starts and ends. smsg() would always
21374 * truncate it at the end. */
21375 s = tv2string(fc.rettv, &tofree, numbuf2, 0);
21376 if (s != NULL)
21378 trunc_string(s, buf, MSG_BUF_CLEN);
21379 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21380 vim_free(tofree);
21383 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21385 verbose_leave_scroll();
21386 --no_wait_return;
21389 vim_free(sourcing_name);
21390 sourcing_name = save_sourcing_name;
21391 sourcing_lnum = save_sourcing_lnum;
21392 current_SID = save_current_SID;
21393 #ifdef FEAT_PROFILE
21394 if (do_profiling == PROF_YES)
21395 script_prof_restore(&wait_start);
21396 #endif
21398 if (p_verbose >= 12 && sourcing_name != NULL)
21400 ++no_wait_return;
21401 verbose_enter_scroll();
21403 smsg((char_u *)_("continuing in %s"), sourcing_name);
21404 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21406 verbose_leave_scroll();
21407 --no_wait_return;
21410 did_emsg |= save_did_emsg;
21411 current_funccal = fc.caller;
21413 /* The a: variables typevals were not allocated, only free the allocated
21414 * variables. */
21415 vars_clear_ext(&fc.l_avars.dv_hashtab, FALSE);
21417 vars_clear(&fc.l_vars.dv_hashtab); /* free all l: variables */
21418 --depth;
21422 * Add a number variable "name" to dict "dp" with value "nr".
21424 static void
21425 add_nr_var(dp, v, name, nr)
21426 dict_T *dp;
21427 dictitem_T *v;
21428 char *name;
21429 varnumber_T nr;
21431 STRCPY(v->di_key, name);
21432 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21433 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21434 v->di_tv.v_type = VAR_NUMBER;
21435 v->di_tv.v_lock = VAR_FIXED;
21436 v->di_tv.vval.v_number = nr;
21440 * ":return [expr]"
21442 void
21443 ex_return(eap)
21444 exarg_T *eap;
21446 char_u *arg = eap->arg;
21447 typval_T rettv;
21448 int returning = FALSE;
21450 if (current_funccal == NULL)
21452 EMSG(_("E133: :return not inside a function"));
21453 return;
21456 if (eap->skip)
21457 ++emsg_skip;
21459 eap->nextcmd = NULL;
21460 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21461 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21463 if (!eap->skip)
21464 returning = do_return(eap, FALSE, TRUE, &rettv);
21465 else
21466 clear_tv(&rettv);
21468 /* It's safer to return also on error. */
21469 else if (!eap->skip)
21472 * Return unless the expression evaluation has been cancelled due to an
21473 * aborting error, an interrupt, or an exception.
21475 if (!aborting())
21476 returning = do_return(eap, FALSE, TRUE, NULL);
21479 /* When skipping or the return gets pending, advance to the next command
21480 * in this line (!returning). Otherwise, ignore the rest of the line.
21481 * Following lines will be ignored by get_func_line(). */
21482 if (returning)
21483 eap->nextcmd = NULL;
21484 else if (eap->nextcmd == NULL) /* no argument */
21485 eap->nextcmd = check_nextcmd(arg);
21487 if (eap->skip)
21488 --emsg_skip;
21492 * Return from a function. Possibly makes the return pending. Also called
21493 * for a pending return at the ":endtry" or after returning from an extra
21494 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21495 * when called due to a ":return" command. "rettv" may point to a typval_T
21496 * with the return rettv. Returns TRUE when the return can be carried out,
21497 * FALSE when the return gets pending.
21500 do_return(eap, reanimate, is_cmd, rettv)
21501 exarg_T *eap;
21502 int reanimate;
21503 int is_cmd;
21504 void *rettv;
21506 int idx;
21507 struct condstack *cstack = eap->cstack;
21509 if (reanimate)
21510 /* Undo the return. */
21511 current_funccal->returned = FALSE;
21514 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21515 * not in its finally clause (which then is to be executed next) is found.
21516 * In this case, make the ":return" pending for execution at the ":endtry".
21517 * Otherwise, return normally.
21519 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21520 if (idx >= 0)
21522 cstack->cs_pending[idx] = CSTP_RETURN;
21524 if (!is_cmd && !reanimate)
21525 /* A pending return again gets pending. "rettv" points to an
21526 * allocated variable with the rettv of the original ":return"'s
21527 * argument if present or is NULL else. */
21528 cstack->cs_rettv[idx] = rettv;
21529 else
21531 /* When undoing a return in order to make it pending, get the stored
21532 * return rettv. */
21533 if (reanimate)
21534 rettv = current_funccal->rettv;
21536 if (rettv != NULL)
21538 /* Store the value of the pending return. */
21539 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21540 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21541 else
21542 EMSG(_(e_outofmem));
21544 else
21545 cstack->cs_rettv[idx] = NULL;
21547 if (reanimate)
21549 /* The pending return value could be overwritten by a ":return"
21550 * without argument in a finally clause; reset the default
21551 * return value. */
21552 current_funccal->rettv->v_type = VAR_NUMBER;
21553 current_funccal->rettv->vval.v_number = 0;
21556 report_make_pending(CSTP_RETURN, rettv);
21558 else
21560 current_funccal->returned = TRUE;
21562 /* If the return is carried out now, store the return value. For
21563 * a return immediately after reanimation, the value is already
21564 * there. */
21565 if (!reanimate && rettv != NULL)
21567 clear_tv(current_funccal->rettv);
21568 *current_funccal->rettv = *(typval_T *)rettv;
21569 if (!is_cmd)
21570 vim_free(rettv);
21574 return idx < 0;
21578 * Free the variable with a pending return value.
21580 void
21581 discard_pending_return(rettv)
21582 void *rettv;
21584 free_tv((typval_T *)rettv);
21588 * Generate a return command for producing the value of "rettv". The result
21589 * is an allocated string. Used by report_pending() for verbose messages.
21591 char_u *
21592 get_return_cmd(rettv)
21593 void *rettv;
21595 char_u *s = NULL;
21596 char_u *tofree = NULL;
21597 char_u numbuf[NUMBUFLEN];
21599 if (rettv != NULL)
21600 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21601 if (s == NULL)
21602 s = (char_u *)"";
21604 STRCPY(IObuff, ":return ");
21605 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21606 if (STRLEN(s) + 8 >= IOSIZE)
21607 STRCPY(IObuff + IOSIZE - 4, "...");
21608 vim_free(tofree);
21609 return vim_strsave(IObuff);
21613 * Get next function line.
21614 * Called by do_cmdline() to get the next line.
21615 * Returns allocated string, or NULL for end of function.
21617 /* ARGSUSED */
21618 char_u *
21619 get_func_line(c, cookie, indent)
21620 int c; /* not used */
21621 void *cookie;
21622 int indent; /* not used */
21624 funccall_T *fcp = (funccall_T *)cookie;
21625 ufunc_T *fp = fcp->func;
21626 char_u *retval;
21627 garray_T *gap; /* growarray with function lines */
21629 /* If breakpoints have been added/deleted need to check for it. */
21630 if (fcp->dbg_tick != debug_tick)
21632 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21633 sourcing_lnum);
21634 fcp->dbg_tick = debug_tick;
21636 #ifdef FEAT_PROFILE
21637 if (do_profiling == PROF_YES)
21638 func_line_end(cookie);
21639 #endif
21641 gap = &fp->uf_lines;
21642 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21643 || fcp->returned)
21644 retval = NULL;
21645 else
21647 /* Skip NULL lines (continuation lines). */
21648 while (fcp->linenr < gap->ga_len
21649 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21650 ++fcp->linenr;
21651 if (fcp->linenr >= gap->ga_len)
21652 retval = NULL;
21653 else
21655 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21656 sourcing_lnum = fcp->linenr;
21657 #ifdef FEAT_PROFILE
21658 if (do_profiling == PROF_YES)
21659 func_line_start(cookie);
21660 #endif
21664 /* Did we encounter a breakpoint? */
21665 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21667 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21668 /* Find next breakpoint. */
21669 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21670 sourcing_lnum);
21671 fcp->dbg_tick = debug_tick;
21674 return retval;
21677 #if defined(FEAT_PROFILE) || defined(PROTO)
21679 * Called when starting to read a function line.
21680 * "sourcing_lnum" must be correct!
21681 * When skipping lines it may not actually be executed, but we won't find out
21682 * until later and we need to store the time now.
21684 void
21685 func_line_start(cookie)
21686 void *cookie;
21688 funccall_T *fcp = (funccall_T *)cookie;
21689 ufunc_T *fp = fcp->func;
21691 if (fp->uf_profiling && sourcing_lnum >= 1
21692 && sourcing_lnum <= fp->uf_lines.ga_len)
21694 fp->uf_tml_idx = sourcing_lnum - 1;
21695 /* Skip continuation lines. */
21696 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21697 --fp->uf_tml_idx;
21698 fp->uf_tml_execed = FALSE;
21699 profile_start(&fp->uf_tml_start);
21700 profile_zero(&fp->uf_tml_children);
21701 profile_get_wait(&fp->uf_tml_wait);
21706 * Called when actually executing a function line.
21708 void
21709 func_line_exec(cookie)
21710 void *cookie;
21712 funccall_T *fcp = (funccall_T *)cookie;
21713 ufunc_T *fp = fcp->func;
21715 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21716 fp->uf_tml_execed = TRUE;
21720 * Called when done with a function line.
21722 void
21723 func_line_end(cookie)
21724 void *cookie;
21726 funccall_T *fcp = (funccall_T *)cookie;
21727 ufunc_T *fp = fcp->func;
21729 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21731 if (fp->uf_tml_execed)
21733 ++fp->uf_tml_count[fp->uf_tml_idx];
21734 profile_end(&fp->uf_tml_start);
21735 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21736 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21737 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21738 &fp->uf_tml_children);
21740 fp->uf_tml_idx = -1;
21743 #endif
21746 * Return TRUE if the currently active function should be ended, because a
21747 * return was encountered or an error occurred. Used inside a ":while".
21750 func_has_ended(cookie)
21751 void *cookie;
21753 funccall_T *fcp = (funccall_T *)cookie;
21755 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21756 * an error inside a try conditional. */
21757 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21758 || fcp->returned);
21762 * return TRUE if cookie indicates a function which "abort"s on errors.
21765 func_has_abort(cookie)
21766 void *cookie;
21768 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21771 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21772 typedef enum
21774 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21775 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21776 VAR_FLAVOUR_VIMINFO /* all uppercase */
21777 } var_flavour_T;
21779 static var_flavour_T var_flavour __ARGS((char_u *varname));
21781 static var_flavour_T
21782 var_flavour(varname)
21783 char_u *varname;
21785 char_u *p = varname;
21787 if (ASCII_ISUPPER(*p))
21789 while (*(++p))
21790 if (ASCII_ISLOWER(*p))
21791 return VAR_FLAVOUR_SESSION;
21792 return VAR_FLAVOUR_VIMINFO;
21794 else
21795 return VAR_FLAVOUR_DEFAULT;
21797 #endif
21799 #if defined(FEAT_VIMINFO) || defined(PROTO)
21801 * Restore global vars that start with a capital from the viminfo file
21804 read_viminfo_varlist(virp, writing)
21805 vir_T *virp;
21806 int writing;
21808 char_u *tab;
21809 int type = VAR_NUMBER;
21810 typval_T tv;
21812 if (!writing && (find_viminfo_parameter('!') != NULL))
21814 tab = vim_strchr(virp->vir_line + 1, '\t');
21815 if (tab != NULL)
21817 *tab++ = '\0'; /* isolate the variable name */
21818 if (*tab == 'S') /* string var */
21819 type = VAR_STRING;
21820 #ifdef FEAT_FLOAT
21821 else if (*tab == 'F')
21822 type = VAR_FLOAT;
21823 #endif
21825 tab = vim_strchr(tab, '\t');
21826 if (tab != NULL)
21828 tv.v_type = type;
21829 if (type == VAR_STRING)
21830 tv.vval.v_string = viminfo_readstring(virp,
21831 (int)(tab - virp->vir_line + 1), TRUE);
21832 #ifdef FEAT_FLOAT
21833 else if (type == VAR_FLOAT)
21834 (void)string2float(tab + 1, &tv.vval.v_float);
21835 #endif
21836 else
21837 tv.vval.v_number = atol((char *)tab + 1);
21838 set_var(virp->vir_line + 1, &tv, FALSE);
21839 if (type == VAR_STRING)
21840 vim_free(tv.vval.v_string);
21845 return viminfo_readline(virp);
21849 * Write global vars that start with a capital to the viminfo file
21851 void
21852 write_viminfo_varlist(fp)
21853 FILE *fp;
21855 hashitem_T *hi;
21856 dictitem_T *this_var;
21857 int todo;
21858 char *s;
21859 char_u *p;
21860 char_u *tofree;
21861 char_u numbuf[NUMBUFLEN];
21863 if (find_viminfo_parameter('!') == NULL)
21864 return;
21866 fprintf(fp, _("\n# global variables:\n"));
21868 todo = (int)globvarht.ht_used;
21869 for (hi = globvarht.ht_array; todo > 0; ++hi)
21871 if (!HASHITEM_EMPTY(hi))
21873 --todo;
21874 this_var = HI2DI(hi);
21875 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21877 switch (this_var->di_tv.v_type)
21879 case VAR_STRING: s = "STR"; break;
21880 case VAR_NUMBER: s = "NUM"; break;
21881 #ifdef FEAT_FLOAT
21882 case VAR_FLOAT: s = "FLO"; break;
21883 #endif
21884 default: continue;
21886 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21887 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21888 if (p != NULL)
21889 viminfo_writestring(fp, p);
21890 vim_free(tofree);
21895 #endif
21897 #if defined(FEAT_SESSION) || defined(PROTO)
21899 store_session_globals(fd)
21900 FILE *fd;
21902 hashitem_T *hi;
21903 dictitem_T *this_var;
21904 int todo;
21905 char_u *p, *t;
21907 todo = (int)globvarht.ht_used;
21908 for (hi = globvarht.ht_array; todo > 0; ++hi)
21910 if (!HASHITEM_EMPTY(hi))
21912 --todo;
21913 this_var = HI2DI(hi);
21914 if ((this_var->di_tv.v_type == VAR_NUMBER
21915 || this_var->di_tv.v_type == VAR_STRING)
21916 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21918 /* Escape special characters with a backslash. Turn a LF and
21919 * CR into \n and \r. */
21920 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21921 (char_u *)"\\\"\n\r");
21922 if (p == NULL) /* out of memory */
21923 break;
21924 for (t = p; *t != NUL; ++t)
21925 if (*t == '\n')
21926 *t = 'n';
21927 else if (*t == '\r')
21928 *t = 'r';
21929 if ((fprintf(fd, "let %s = %c%s%c",
21930 this_var->di_key,
21931 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21932 : ' ',
21934 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21935 : ' ') < 0)
21936 || put_eol(fd) == FAIL)
21938 vim_free(p);
21939 return FAIL;
21941 vim_free(p);
21943 #ifdef FEAT_FLOAT
21944 else if (this_var->di_tv.v_type == VAR_FLOAT
21945 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21947 float_T f = this_var->di_tv.vval.v_float;
21948 int sign = ' ';
21950 if (f < 0)
21952 f = -f;
21953 sign = '-';
21955 if ((fprintf(fd, "let %s = %c&%f",
21956 this_var->di_key, sign, f) < 0)
21957 || put_eol(fd) == FAIL)
21958 return FAIL;
21960 #endif
21963 return OK;
21965 #endif
21968 * Display script name where an item was last set.
21969 * Should only be invoked when 'verbose' is non-zero.
21971 void
21972 last_set_msg(scriptID)
21973 scid_T scriptID;
21975 char_u *p;
21977 if (scriptID != 0)
21979 p = home_replace_save(NULL, get_scriptname(scriptID));
21980 if (p != NULL)
21982 verbose_enter();
21983 MSG_PUTS(_("\n\tLast set from "));
21984 MSG_PUTS(p);
21985 vim_free(p);
21986 verbose_leave();
21992 * List v:oldfiles in a nice way.
21994 /*ARGSUSED*/
21995 void
21996 ex_oldfiles(eap)
21997 exarg_T *eap;
21999 list_T *l = vimvars[VV_OLDFILES].vv_list;
22000 listitem_T *li;
22001 int nr = 0;
22003 if (l == NULL)
22004 msg((char_u *)_("No old files"));
22005 else
22007 msg_start();
22008 msg_scroll = TRUE;
22009 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22011 msg_outnum((long)++nr);
22012 MSG_PUTS(": ");
22013 msg_outtrans(get_tv_string(&li->li_tv));
22014 msg_putchar('\n');
22015 out_flush(); /* output one line at a time */
22016 ui_breakcheck();
22018 /* Assume "got_int" was set to truncate the listing. */
22019 got_int = FALSE;
22021 #ifdef FEAT_BROWSE_CMD
22022 if (cmdmod.browse)
22024 quit_more = FALSE;
22025 nr = prompt_for_number(FALSE);
22026 msg_starthere();
22027 if (nr > 0)
22029 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22030 (long)nr);
22032 if (p != NULL)
22034 p = expand_env_save(p);
22035 eap->arg = p;
22036 eap->cmdidx = CMD_edit;
22037 cmdmod.browse = FALSE;
22038 do_exedit(eap, NULL);
22039 vim_free(p);
22043 #endif
22047 #endif /* FEAT_EVAL */
22050 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22052 #ifdef WIN3264
22054 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22056 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22057 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22058 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22061 * Get the short path (8.3) for the filename in "fnamep".
22062 * Only works for a valid file name.
22063 * When the path gets longer "fnamep" is changed and the allocated buffer
22064 * is put in "bufp".
22065 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22066 * Returns OK on success, FAIL on failure.
22068 static int
22069 get_short_pathname(fnamep, bufp, fnamelen)
22070 char_u **fnamep;
22071 char_u **bufp;
22072 int *fnamelen;
22074 int l, len;
22075 char_u *newbuf;
22077 len = *fnamelen;
22078 l = GetShortPathName(*fnamep, *fnamep, len);
22079 if (l > len - 1)
22081 /* If that doesn't work (not enough space), then save the string
22082 * and try again with a new buffer big enough. */
22083 newbuf = vim_strnsave(*fnamep, l);
22084 if (newbuf == NULL)
22085 return FAIL;
22087 vim_free(*bufp);
22088 *fnamep = *bufp = newbuf;
22090 /* Really should always succeed, as the buffer is big enough. */
22091 l = GetShortPathName(*fnamep, *fnamep, l+1);
22094 *fnamelen = l;
22095 return OK;
22099 * Get the short path (8.3) for the filename in "fname". The converted
22100 * path is returned in "bufp".
22102 * Some of the directories specified in "fname" may not exist. This function
22103 * will shorten the existing directories at the beginning of the path and then
22104 * append the remaining non-existing path.
22106 * fname - Pointer to the filename to shorten. On return, contains the
22107 * pointer to the shortened pathname
22108 * bufp - Pointer to an allocated buffer for the filename.
22109 * fnamelen - Length of the filename pointed to by fname
22111 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22113 static int
22114 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22115 char_u **fname;
22116 char_u **bufp;
22117 int *fnamelen;
22119 char_u *short_fname, *save_fname, *pbuf_unused;
22120 char_u *endp, *save_endp;
22121 char_u ch;
22122 int old_len, len;
22123 int new_len, sfx_len;
22124 int retval = OK;
22126 /* Make a copy */
22127 old_len = *fnamelen;
22128 save_fname = vim_strnsave(*fname, old_len);
22129 pbuf_unused = NULL;
22130 short_fname = NULL;
22132 endp = save_fname + old_len - 1; /* Find the end of the copy */
22133 save_endp = endp;
22136 * Try shortening the supplied path till it succeeds by removing one
22137 * directory at a time from the tail of the path.
22139 len = 0;
22140 for (;;)
22142 /* go back one path-separator */
22143 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22144 --endp;
22145 if (endp <= save_fname)
22146 break; /* processed the complete path */
22149 * Replace the path separator with a NUL and try to shorten the
22150 * resulting path.
22152 ch = *endp;
22153 *endp = 0;
22154 short_fname = save_fname;
22155 len = (int)STRLEN(short_fname) + 1;
22156 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22158 retval = FAIL;
22159 goto theend;
22161 *endp = ch; /* preserve the string */
22163 if (len > 0)
22164 break; /* successfully shortened the path */
22166 /* failed to shorten the path. Skip the path separator */
22167 --endp;
22170 if (len > 0)
22173 * Succeeded in shortening the path. Now concatenate the shortened
22174 * path with the remaining path at the tail.
22177 /* Compute the length of the new path. */
22178 sfx_len = (int)(save_endp - endp) + 1;
22179 new_len = len + sfx_len;
22181 *fnamelen = new_len;
22182 vim_free(*bufp);
22183 if (new_len > old_len)
22185 /* There is not enough space in the currently allocated string,
22186 * copy it to a buffer big enough. */
22187 *fname = *bufp = vim_strnsave(short_fname, new_len);
22188 if (*fname == NULL)
22190 retval = FAIL;
22191 goto theend;
22194 else
22196 /* Transfer short_fname to the main buffer (it's big enough),
22197 * unless get_short_pathname() did its work in-place. */
22198 *fname = *bufp = save_fname;
22199 if (short_fname != save_fname)
22200 vim_strncpy(save_fname, short_fname, len);
22201 save_fname = NULL;
22204 /* concat the not-shortened part of the path */
22205 vim_strncpy(*fname + len, endp, sfx_len);
22206 (*fname)[new_len] = NUL;
22209 theend:
22210 vim_free(pbuf_unused);
22211 vim_free(save_fname);
22213 return retval;
22217 * Get a pathname for a partial path.
22218 * Returns OK for success, FAIL for failure.
22220 static int
22221 shortpath_for_partial(fnamep, bufp, fnamelen)
22222 char_u **fnamep;
22223 char_u **bufp;
22224 int *fnamelen;
22226 int sepcount, len, tflen;
22227 char_u *p;
22228 char_u *pbuf, *tfname;
22229 int hasTilde;
22231 /* Count up the path separators from the RHS.. so we know which part
22232 * of the path to return. */
22233 sepcount = 0;
22234 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22235 if (vim_ispathsep(*p))
22236 ++sepcount;
22238 /* Need full path first (use expand_env() to remove a "~/") */
22239 hasTilde = (**fnamep == '~');
22240 if (hasTilde)
22241 pbuf = tfname = expand_env_save(*fnamep);
22242 else
22243 pbuf = tfname = FullName_save(*fnamep, FALSE);
22245 len = tflen = (int)STRLEN(tfname);
22247 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22248 return FAIL;
22250 if (len == 0)
22252 /* Don't have a valid filename, so shorten the rest of the
22253 * path if we can. This CAN give us invalid 8.3 filenames, but
22254 * there's not a lot of point in guessing what it might be.
22256 len = tflen;
22257 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22258 return FAIL;
22261 /* Count the paths backward to find the beginning of the desired string. */
22262 for (p = tfname + len - 1; p >= tfname; --p)
22264 #ifdef FEAT_MBYTE
22265 if (has_mbyte)
22266 p -= mb_head_off(tfname, p);
22267 #endif
22268 if (vim_ispathsep(*p))
22270 if (sepcount == 0 || (hasTilde && sepcount == 1))
22271 break;
22272 else
22273 sepcount --;
22276 if (hasTilde)
22278 --p;
22279 if (p >= tfname)
22280 *p = '~';
22281 else
22282 return FAIL;
22284 else
22285 ++p;
22287 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22288 vim_free(*bufp);
22289 *fnamelen = (int)STRLEN(p);
22290 *bufp = pbuf;
22291 *fnamep = p;
22293 return OK;
22295 #endif /* WIN3264 */
22298 * Adjust a filename, according to a string of modifiers.
22299 * *fnamep must be NUL terminated when called. When returning, the length is
22300 * determined by *fnamelen.
22301 * Returns VALID_ flags or -1 for failure.
22302 * When there is an error, *fnamep is set to NULL.
22305 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22306 char_u *src; /* string with modifiers */
22307 int *usedlen; /* characters after src that are used */
22308 char_u **fnamep; /* file name so far */
22309 char_u **bufp; /* buffer for allocated file name or NULL */
22310 int *fnamelen; /* length of fnamep */
22312 int valid = 0;
22313 char_u *tail;
22314 char_u *s, *p, *pbuf;
22315 char_u dirname[MAXPATHL];
22316 int c;
22317 int has_fullname = 0;
22318 #ifdef WIN3264
22319 int has_shortname = 0;
22320 #endif
22322 repeat:
22323 /* ":p" - full path/file_name */
22324 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22326 has_fullname = 1;
22328 valid |= VALID_PATH;
22329 *usedlen += 2;
22331 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22332 if ((*fnamep)[0] == '~'
22333 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22334 && ((*fnamep)[1] == '/'
22335 # ifdef BACKSLASH_IN_FILENAME
22336 || (*fnamep)[1] == '\\'
22337 # endif
22338 || (*fnamep)[1] == NUL)
22340 #endif
22343 *fnamep = expand_env_save(*fnamep);
22344 vim_free(*bufp); /* free any allocated file name */
22345 *bufp = *fnamep;
22346 if (*fnamep == NULL)
22347 return -1;
22350 /* When "/." or "/.." is used: force expansion to get rid of it. */
22351 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22353 if (vim_ispathsep(*p)
22354 && p[1] == '.'
22355 && (p[2] == NUL
22356 || vim_ispathsep(p[2])
22357 || (p[2] == '.'
22358 && (p[3] == NUL || vim_ispathsep(p[3])))))
22359 break;
22362 /* FullName_save() is slow, don't use it when not needed. */
22363 if (*p != NUL || !vim_isAbsName(*fnamep))
22365 *fnamep = FullName_save(*fnamep, *p != NUL);
22366 vim_free(*bufp); /* free any allocated file name */
22367 *bufp = *fnamep;
22368 if (*fnamep == NULL)
22369 return -1;
22372 /* Append a path separator to a directory. */
22373 if (mch_isdir(*fnamep))
22375 /* Make room for one or two extra characters. */
22376 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22377 vim_free(*bufp); /* free any allocated file name */
22378 *bufp = *fnamep;
22379 if (*fnamep == NULL)
22380 return -1;
22381 add_pathsep(*fnamep);
22385 /* ":." - path relative to the current directory */
22386 /* ":~" - path relative to the home directory */
22387 /* ":8" - shortname path - postponed till after */
22388 while (src[*usedlen] == ':'
22389 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22391 *usedlen += 2;
22392 if (c == '8')
22394 #ifdef WIN3264
22395 has_shortname = 1; /* Postpone this. */
22396 #endif
22397 continue;
22399 pbuf = NULL;
22400 /* Need full path first (use expand_env() to remove a "~/") */
22401 if (!has_fullname)
22403 if (c == '.' && **fnamep == '~')
22404 p = pbuf = expand_env_save(*fnamep);
22405 else
22406 p = pbuf = FullName_save(*fnamep, FALSE);
22408 else
22409 p = *fnamep;
22411 has_fullname = 0;
22413 if (p != NULL)
22415 if (c == '.')
22417 mch_dirname(dirname, MAXPATHL);
22418 s = shorten_fname(p, dirname);
22419 if (s != NULL)
22421 *fnamep = s;
22422 if (pbuf != NULL)
22424 vim_free(*bufp); /* free any allocated file name */
22425 *bufp = pbuf;
22426 pbuf = NULL;
22430 else
22432 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22433 /* Only replace it when it starts with '~' */
22434 if (*dirname == '~')
22436 s = vim_strsave(dirname);
22437 if (s != NULL)
22439 *fnamep = s;
22440 vim_free(*bufp);
22441 *bufp = s;
22445 vim_free(pbuf);
22449 tail = gettail(*fnamep);
22450 *fnamelen = (int)STRLEN(*fnamep);
22452 /* ":h" - head, remove "/file_name", can be repeated */
22453 /* Don't remove the first "/" or "c:\" */
22454 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22456 valid |= VALID_HEAD;
22457 *usedlen += 2;
22458 s = get_past_head(*fnamep);
22459 while (tail > s && after_pathsep(s, tail))
22460 mb_ptr_back(*fnamep, tail);
22461 *fnamelen = (int)(tail - *fnamep);
22462 #ifdef VMS
22463 if (*fnamelen > 0)
22464 *fnamelen += 1; /* the path separator is part of the path */
22465 #endif
22466 if (*fnamelen == 0)
22468 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22469 p = vim_strsave((char_u *)".");
22470 if (p == NULL)
22471 return -1;
22472 vim_free(*bufp);
22473 *bufp = *fnamep = tail = p;
22474 *fnamelen = 1;
22476 else
22478 while (tail > s && !after_pathsep(s, tail))
22479 mb_ptr_back(*fnamep, tail);
22483 /* ":8" - shortname */
22484 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22486 *usedlen += 2;
22487 #ifdef WIN3264
22488 has_shortname = 1;
22489 #endif
22492 #ifdef WIN3264
22493 /* Check shortname after we have done 'heads' and before we do 'tails'
22495 if (has_shortname)
22497 pbuf = NULL;
22498 /* Copy the string if it is shortened by :h */
22499 if (*fnamelen < (int)STRLEN(*fnamep))
22501 p = vim_strnsave(*fnamep, *fnamelen);
22502 if (p == 0)
22503 return -1;
22504 vim_free(*bufp);
22505 *bufp = *fnamep = p;
22508 /* Split into two implementations - makes it easier. First is where
22509 * there isn't a full name already, second is where there is.
22511 if (!has_fullname && !vim_isAbsName(*fnamep))
22513 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22514 return -1;
22516 else
22518 int l;
22520 /* Simple case, already have the full-name
22521 * Nearly always shorter, so try first time. */
22522 l = *fnamelen;
22523 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22524 return -1;
22526 if (l == 0)
22528 /* Couldn't find the filename.. search the paths.
22530 l = *fnamelen;
22531 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22532 return -1;
22534 *fnamelen = l;
22537 #endif /* WIN3264 */
22539 /* ":t" - tail, just the basename */
22540 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22542 *usedlen += 2;
22543 *fnamelen -= (int)(tail - *fnamep);
22544 *fnamep = tail;
22547 /* ":e" - extension, can be repeated */
22548 /* ":r" - root, without extension, can be repeated */
22549 while (src[*usedlen] == ':'
22550 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22552 /* find a '.' in the tail:
22553 * - for second :e: before the current fname
22554 * - otherwise: The last '.'
22556 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22557 s = *fnamep - 2;
22558 else
22559 s = *fnamep + *fnamelen - 1;
22560 for ( ; s > tail; --s)
22561 if (s[0] == '.')
22562 break;
22563 if (src[*usedlen + 1] == 'e') /* :e */
22565 if (s > tail)
22567 *fnamelen += (int)(*fnamep - (s + 1));
22568 *fnamep = s + 1;
22569 #ifdef VMS
22570 /* cut version from the extension */
22571 s = *fnamep + *fnamelen - 1;
22572 for ( ; s > *fnamep; --s)
22573 if (s[0] == ';')
22574 break;
22575 if (s > *fnamep)
22576 *fnamelen = s - *fnamep;
22577 #endif
22579 else if (*fnamep <= tail)
22580 *fnamelen = 0;
22582 else /* :r */
22584 if (s > tail) /* remove one extension */
22585 *fnamelen = (int)(s - *fnamep);
22587 *usedlen += 2;
22590 /* ":s?pat?foo?" - substitute */
22591 /* ":gs?pat?foo?" - global substitute */
22592 if (src[*usedlen] == ':'
22593 && (src[*usedlen + 1] == 's'
22594 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22596 char_u *str;
22597 char_u *pat;
22598 char_u *sub;
22599 int sep;
22600 char_u *flags;
22601 int didit = FALSE;
22603 flags = (char_u *)"";
22604 s = src + *usedlen + 2;
22605 if (src[*usedlen + 1] == 'g')
22607 flags = (char_u *)"g";
22608 ++s;
22611 sep = *s++;
22612 if (sep)
22614 /* find end of pattern */
22615 p = vim_strchr(s, sep);
22616 if (p != NULL)
22618 pat = vim_strnsave(s, (int)(p - s));
22619 if (pat != NULL)
22621 s = p + 1;
22622 /* find end of substitution */
22623 p = vim_strchr(s, sep);
22624 if (p != NULL)
22626 sub = vim_strnsave(s, (int)(p - s));
22627 str = vim_strnsave(*fnamep, *fnamelen);
22628 if (sub != NULL && str != NULL)
22630 *usedlen = (int)(p + 1 - src);
22631 s = do_string_sub(str, pat, sub, flags);
22632 if (s != NULL)
22634 *fnamep = s;
22635 *fnamelen = (int)STRLEN(s);
22636 vim_free(*bufp);
22637 *bufp = s;
22638 didit = TRUE;
22641 vim_free(sub);
22642 vim_free(str);
22644 vim_free(pat);
22647 /* after using ":s", repeat all the modifiers */
22648 if (didit)
22649 goto repeat;
22653 return valid;
22657 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22658 * "flags" can be "g" to do a global substitute.
22659 * Returns an allocated string, NULL for error.
22661 char_u *
22662 do_string_sub(str, pat, sub, flags)
22663 char_u *str;
22664 char_u *pat;
22665 char_u *sub;
22666 char_u *flags;
22668 int sublen;
22669 regmatch_T regmatch;
22670 int i;
22671 int do_all;
22672 char_u *tail;
22673 garray_T ga;
22674 char_u *ret;
22675 char_u *save_cpo;
22677 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22678 save_cpo = p_cpo;
22679 p_cpo = empty_option;
22681 ga_init2(&ga, 1, 200);
22683 do_all = (flags[0] == 'g');
22685 regmatch.rm_ic = p_ic;
22686 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22687 if (regmatch.regprog != NULL)
22689 tail = str;
22690 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22693 * Get some space for a temporary buffer to do the substitution
22694 * into. It will contain:
22695 * - The text up to where the match is.
22696 * - The substituted text.
22697 * - The text after the match.
22699 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22700 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22701 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22703 ga_clear(&ga);
22704 break;
22707 /* copy the text up to where the match is */
22708 i = (int)(regmatch.startp[0] - tail);
22709 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22710 /* add the substituted text */
22711 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22712 + ga.ga_len + i, TRUE, TRUE, FALSE);
22713 ga.ga_len += i + sublen - 1;
22714 /* avoid getting stuck on a match with an empty string */
22715 if (tail == regmatch.endp[0])
22717 if (*tail == NUL)
22718 break;
22719 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22720 ++ga.ga_len;
22722 else
22724 tail = regmatch.endp[0];
22725 if (*tail == NUL)
22726 break;
22728 if (!do_all)
22729 break;
22732 if (ga.ga_data != NULL)
22733 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22735 vim_free(regmatch.regprog);
22738 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22739 ga_clear(&ga);
22740 if (p_cpo == empty_option)
22741 p_cpo = save_cpo;
22742 else
22743 /* Darn, evaluating {sub} expression changed the value. */
22744 free_string_option(save_cpo);
22746 return ret;
22749 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */