Merge branch 'vim'
[vim_extended.git] / src / eval.c
blobf4f3c7a1d823ca70e0a1f5f5eb2480a3fd588215
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 */
35 #define DO_NOT_FREE_CNT 99999 /* refcount for dict or list that should not
36 be freed. */
39 * In a hashtab item "hi_key" points to "di_key" in a dictitem.
40 * This avoids adding a pointer to the hashtab item.
41 * DI2HIKEY() converts a dictitem pointer to a hashitem key pointer.
42 * HIKEY2DI() converts a hashitem key pointer to a dictitem pointer.
43 * HI2DI() converts a hashitem pointer to a dictitem pointer.
45 static dictitem_T dumdi;
46 #define DI2HIKEY(di) ((di)->di_key)
47 #define HIKEY2DI(p) ((dictitem_T *)(p - (dumdi.di_key - (char_u *)&dumdi)))
48 #define HI2DI(hi) HIKEY2DI((hi)->hi_key)
51 * Structure returned by get_lval() and used by set_var_lval().
52 * For a plain name:
53 * "name" points to the variable name.
54 * "exp_name" is NULL.
55 * "tv" is NULL
56 * For a magic braces name:
57 * "name" points to the expanded variable name.
58 * "exp_name" is non-NULL, to be freed later.
59 * "tv" is NULL
60 * For an index in a list:
61 * "name" points to the (expanded) variable name.
62 * "exp_name" NULL or non-NULL, to be freed later.
63 * "tv" points to the (first) list item value
64 * "li" points to the (first) list item
65 * "range", "n1", "n2" and "empty2" indicate what items are used.
66 * For an existing Dict item:
67 * "name" points to the (expanded) variable name.
68 * "exp_name" NULL or non-NULL, to be freed later.
69 * "tv" points to the dict item value
70 * "newkey" is NULL
71 * For a non-existing Dict item:
72 * "name" points to the (expanded) variable name.
73 * "exp_name" NULL or non-NULL, to be freed later.
74 * "tv" points to the Dictionary typval_T
75 * "newkey" is the key for the new item.
77 typedef struct lval_S
79 char_u *ll_name; /* start of variable name (can be NULL) */
80 char_u *ll_exp_name; /* NULL or expanded name in allocated memory. */
81 typval_T *ll_tv; /* Typeval of item being used. If "newkey"
82 isn't NULL it's the Dict to which to add
83 the item. */
84 listitem_T *ll_li; /* The list item or NULL. */
85 list_T *ll_list; /* The list or NULL. */
86 int ll_range; /* TRUE when a [i:j] range was used */
87 long ll_n1; /* First index for list */
88 long ll_n2; /* Second index for list range */
89 int ll_empty2; /* Second index is empty: [i:] */
90 dict_T *ll_dict; /* The Dictionary or NULL */
91 dictitem_T *ll_di; /* The dictitem or NULL */
92 char_u *ll_newkey; /* New key for Dict in alloc. mem or NULL. */
93 } lval_T;
96 static char *e_letunexp = N_("E18: Unexpected characters in :let");
97 static char *e_listidx = N_("E684: list index out of range: %ld");
98 static char *e_undefvar = N_("E121: Undefined variable: %s");
99 static char *e_missbrac = N_("E111: Missing ']'");
100 static char *e_listarg = N_("E686: Argument of %s must be a List");
101 static char *e_listdictarg = N_("E712: Argument of %s must be a List or Dictionary");
102 static char *e_emptykey = N_("E713: Cannot use empty key for Dictionary");
103 static char *e_listreq = N_("E714: List required");
104 static char *e_dictreq = N_("E715: Dictionary required");
105 static char *e_toomanyarg = N_("E118: Too many arguments for function: %s");
106 static char *e_dictkey = N_("E716: Key not present in Dictionary: %s");
107 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
108 static char *e_funcdict = N_("E717: Dictionary entry already exists");
109 static char *e_funcref = N_("E718: Funcref required");
110 static char *e_dictrange = N_("E719: Cannot use [:] with a Dictionary");
111 static char *e_letwrong = N_("E734: Wrong variable type for %s=");
112 static char *e_nofunc = N_("E130: Unknown function: %s");
113 static char *e_illvar = N_("E461: Illegal variable name: %s");
116 * All user-defined global variables are stored in dictionary "globvardict".
117 * "globvars_var" is the variable that is used for "g:".
119 static dict_T globvardict;
120 static dictitem_T globvars_var;
121 #define globvarht globvardict.dv_hashtab
124 * Old Vim variables such as "v:version" are also available without the "v:".
125 * Also in functions. We need a special hashtable for them.
127 static hashtab_T compat_hashtab;
130 * When recursively copying lists and dicts we need to remember which ones we
131 * have done to avoid endless recursiveness. This unique ID is used for that.
132 * The last bit is used for previous_funccal, ignored when comparing.
134 static int current_copyID = 0;
135 #define COPYID_INC 2
136 #define COPYID_MASK (~0x1)
139 * Array to hold the hashtab with variables local to each sourced script.
140 * Each item holds a variable (nameless) that points to the dict_T.
142 typedef struct
144 dictitem_T sv_var;
145 dict_T sv_dict;
146 } scriptvar_T;
148 static garray_T ga_scripts = {0, 0, sizeof(scriptvar_T), 4, NULL};
149 #define SCRIPT_SV(id) (((scriptvar_T *)ga_scripts.ga_data)[(id) - 1])
150 #define SCRIPT_VARS(id) (SCRIPT_SV(id).sv_dict.dv_hashtab)
152 static int echo_attr = 0; /* attributes used for ":echo" */
154 /* Values for trans_function_name() argument: */
155 #define TFN_INT 1 /* internal function name OK */
156 #define TFN_QUIET 2 /* no error messages */
159 * Structure to hold info for a user function.
161 typedef struct ufunc ufunc_T;
163 struct ufunc
165 int uf_varargs; /* variable nr of arguments */
166 int uf_flags;
167 int uf_calls; /* nr of active calls */
168 garray_T uf_args; /* arguments */
169 garray_T uf_lines; /* function lines */
170 #ifdef FEAT_PROFILE
171 int uf_profiling; /* TRUE when func is being profiled */
172 /* profiling the function as a whole */
173 int uf_tm_count; /* nr of calls */
174 proftime_T uf_tm_total; /* time spent in function + children */
175 proftime_T uf_tm_self; /* time spent in function itself */
176 proftime_T uf_tm_children; /* time spent in children this call */
177 /* profiling the function per line */
178 int *uf_tml_count; /* nr of times line was executed */
179 proftime_T *uf_tml_total; /* time spent in a line + children */
180 proftime_T *uf_tml_self; /* time spent in a line itself */
181 proftime_T uf_tml_start; /* start time for current line */
182 proftime_T uf_tml_children; /* time spent in children for this line */
183 proftime_T uf_tml_wait; /* start wait time for current line */
184 int uf_tml_idx; /* index of line being timed; -1 if none */
185 int uf_tml_execed; /* line being timed was executed */
186 #endif
187 scid_T uf_script_ID; /* ID of script where function was defined,
188 used for s: variables */
189 int uf_refcount; /* for numbered function: reference count */
190 char_u uf_name[1]; /* name of function (actually longer); can
191 start with <SNR>123_ (<SNR> is K_SPECIAL
192 KS_EXTRA KE_SNR) */
195 /* function flags */
196 #define FC_ABORT 1 /* abort function on error */
197 #define FC_RANGE 2 /* function accepts range */
198 #define FC_DICT 4 /* Dict function, uses "self" */
201 * All user-defined functions are found in this hashtable.
203 static hashtab_T func_hashtab;
205 /* The names of packages that once were loaded are remembered. */
206 static garray_T ga_loaded = {0, 0, sizeof(char_u *), 4, NULL};
208 /* list heads for garbage collection */
209 static dict_T *first_dict = NULL; /* list of all dicts */
210 static list_T *first_list = NULL; /* list of all lists */
212 /* From user function to hashitem and back. */
213 static ufunc_T dumuf;
214 #define UF2HIKEY(fp) ((fp)->uf_name)
215 #define HIKEY2UF(p) ((ufunc_T *)(p - (dumuf.uf_name - (char_u *)&dumuf)))
216 #define HI2UF(hi) HIKEY2UF((hi)->hi_key)
218 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
219 #define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
221 #define MAX_FUNC_ARGS 20 /* maximum number of function arguments */
222 #define VAR_SHORT_LEN 20 /* short variable name length */
223 #define FIXVAR_CNT 12 /* number of fixed variables */
225 /* structure to hold info for a function that is currently being executed. */
226 typedef struct funccall_S funccall_T;
228 struct funccall_S
230 ufunc_T *func; /* function being called */
231 int linenr; /* next line to be executed */
232 int returned; /* ":return" used */
233 struct /* fixed variables for arguments */
235 dictitem_T var; /* variable (without room for name) */
236 char_u room[VAR_SHORT_LEN]; /* room for the name */
237 } fixvar[FIXVAR_CNT];
238 dict_T l_vars; /* l: local function variables */
239 dictitem_T l_vars_var; /* variable for l: scope */
240 dict_T l_avars; /* a: argument variables */
241 dictitem_T l_avars_var; /* variable for a: scope */
242 list_T l_varlist; /* list for a:000 */
243 listitem_T l_listitems[MAX_FUNC_ARGS]; /* listitems for a:000 */
244 typval_T *rettv; /* return value */
245 linenr_T breakpoint; /* next line with breakpoint or zero */
246 int dbg_tick; /* debug_tick when breakpoint was set */
247 int level; /* top nesting level of executed function */
248 #ifdef FEAT_PROFILE
249 proftime_T prof_child; /* time spent in a child */
250 #endif
251 funccall_T *caller; /* calling function or NULL */
255 * Info used by a ":for" loop.
257 typedef struct
259 int fi_semicolon; /* TRUE if ending in '; var]' */
260 int fi_varcount; /* nr of variables in the list */
261 listwatch_T fi_lw; /* keep an eye on the item used. */
262 list_T *fi_list; /* list being used */
263 } forinfo_T;
266 * Struct used by trans_function_name()
268 typedef struct
270 dict_T *fd_dict; /* Dictionary used */
271 char_u *fd_newkey; /* new key in "dict" in allocated memory */
272 dictitem_T *fd_di; /* Dictionary item used */
273 } funcdict_T;
277 * Array to hold the value of v: variables.
278 * The value is in a dictitem, so that it can also be used in the v: scope.
279 * The reason to use this table anyway is for very quick access to the
280 * variables with the VV_ defines.
282 #include "version.h"
284 /* values for vv_flags: */
285 #define VV_COMPAT 1 /* compatible, also used without "v:" */
286 #define VV_RO 2 /* read-only */
287 #define VV_RO_SBX 4 /* read-only in the sandbox */
289 #define VV_NAME(s, t) s, {{t, 0, {0}}, 0, {0}}, {0}
291 static struct vimvar
293 char *vv_name; /* name of variable, without v: */
294 dictitem_T vv_di; /* value and name for key */
295 char vv_filler[16]; /* space for LONGEST name below!!! */
296 char vv_flags; /* VV_COMPAT, VV_RO, VV_RO_SBX */
297 } vimvars[VV_LEN] =
300 * The order here must match the VV_ defines in vim.h!
301 * Initializing a union does not work, leave tv.vval empty to get zero's.
303 {VV_NAME("count", VAR_NUMBER), VV_COMPAT+VV_RO},
304 {VV_NAME("count1", VAR_NUMBER), VV_RO},
305 {VV_NAME("prevcount", VAR_NUMBER), VV_RO},
306 {VV_NAME("errmsg", VAR_STRING), VV_COMPAT},
307 {VV_NAME("warningmsg", VAR_STRING), 0},
308 {VV_NAME("statusmsg", VAR_STRING), 0},
309 {VV_NAME("shell_error", VAR_NUMBER), VV_COMPAT+VV_RO},
310 {VV_NAME("this_session", VAR_STRING), VV_COMPAT},
311 {VV_NAME("version", VAR_NUMBER), VV_COMPAT+VV_RO},
312 {VV_NAME("lnum", VAR_NUMBER), VV_RO_SBX},
313 {VV_NAME("termresponse", VAR_STRING), VV_RO},
314 {VV_NAME("fname", VAR_STRING), VV_RO},
315 {VV_NAME("lang", VAR_STRING), VV_RO},
316 {VV_NAME("lc_time", VAR_STRING), VV_RO},
317 {VV_NAME("ctype", VAR_STRING), VV_RO},
318 {VV_NAME("charconvert_from", VAR_STRING), VV_RO},
319 {VV_NAME("charconvert_to", VAR_STRING), VV_RO},
320 {VV_NAME("fname_in", VAR_STRING), VV_RO},
321 {VV_NAME("fname_out", VAR_STRING), VV_RO},
322 {VV_NAME("fname_new", VAR_STRING), VV_RO},
323 {VV_NAME("fname_diff", VAR_STRING), VV_RO},
324 {VV_NAME("cmdarg", VAR_STRING), VV_RO},
325 {VV_NAME("foldstart", VAR_NUMBER), VV_RO_SBX},
326 {VV_NAME("foldend", VAR_NUMBER), VV_RO_SBX},
327 {VV_NAME("folddashes", VAR_STRING), VV_RO_SBX},
328 {VV_NAME("foldlevel", VAR_NUMBER), VV_RO_SBX},
329 {VV_NAME("progname", VAR_STRING), VV_RO},
330 {VV_NAME("servername", VAR_STRING), VV_RO},
331 {VV_NAME("dying", VAR_NUMBER), VV_RO},
332 {VV_NAME("exception", VAR_STRING), VV_RO},
333 {VV_NAME("throwpoint", VAR_STRING), VV_RO},
334 {VV_NAME("register", VAR_STRING), VV_RO},
335 {VV_NAME("cmdbang", VAR_NUMBER), VV_RO},
336 {VV_NAME("insertmode", VAR_STRING), VV_RO},
337 {VV_NAME("val", VAR_UNKNOWN), VV_RO},
338 {VV_NAME("key", VAR_UNKNOWN), VV_RO},
339 {VV_NAME("profiling", VAR_NUMBER), VV_RO},
340 {VV_NAME("fcs_reason", VAR_STRING), VV_RO},
341 {VV_NAME("fcs_choice", VAR_STRING), 0},
342 {VV_NAME("beval_bufnr", VAR_NUMBER), VV_RO},
343 {VV_NAME("beval_winnr", VAR_NUMBER), VV_RO},
344 {VV_NAME("beval_lnum", VAR_NUMBER), VV_RO},
345 {VV_NAME("beval_col", VAR_NUMBER), VV_RO},
346 {VV_NAME("beval_text", VAR_STRING), VV_RO},
347 {VV_NAME("scrollstart", VAR_STRING), 0},
348 {VV_NAME("swapname", VAR_STRING), VV_RO},
349 {VV_NAME("swapchoice", VAR_STRING), 0},
350 {VV_NAME("swapcommand", VAR_STRING), VV_RO},
351 {VV_NAME("char", VAR_STRING), VV_RO},
352 {VV_NAME("mouse_win", VAR_NUMBER), 0},
353 {VV_NAME("mouse_lnum", VAR_NUMBER), 0},
354 {VV_NAME("mouse_col", VAR_NUMBER), 0},
355 {VV_NAME("operator", VAR_STRING), VV_RO},
356 {VV_NAME("searchforward", VAR_NUMBER), 0},
357 {VV_NAME("oldfiles", VAR_LIST), 0},
360 /* shorthand */
361 #define vv_type vv_di.di_tv.v_type
362 #define vv_nr vv_di.di_tv.vval.v_number
363 #define vv_float vv_di.di_tv.vval.v_float
364 #define vv_str vv_di.di_tv.vval.v_string
365 #define vv_list vv_di.di_tv.vval.v_list
366 #define vv_tv vv_di.di_tv
369 * The v: variables are stored in dictionary "vimvardict".
370 * "vimvars_var" is the variable that is used for the "l:" scope.
372 static dict_T vimvardict;
373 static dictitem_T vimvars_var;
374 #define vimvarht vimvardict.dv_hashtab
376 static void prepare_vimvar __ARGS((int idx, typval_T *save_tv));
377 static void restore_vimvar __ARGS((int idx, typval_T *save_tv));
378 #if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
379 static int call_vim_function __ARGS((char_u *func, int argc, char_u **argv, int safe, typval_T *rettv));
380 #endif
381 static int ex_let_vars __ARGS((char_u *arg, typval_T *tv, int copy, int semicolon, int var_count, char_u *nextchars));
382 static char_u *skip_var_list __ARGS((char_u *arg, int *var_count, int *semicolon));
383 static char_u *skip_var_one __ARGS((char_u *arg));
384 static void list_hashtable_vars __ARGS((hashtab_T *ht, char_u *prefix, int empty, int *first));
385 static void list_glob_vars __ARGS((int *first));
386 static void list_buf_vars __ARGS((int *first));
387 static void list_win_vars __ARGS((int *first));
388 #ifdef FEAT_WINDOWS
389 static void list_tab_vars __ARGS((int *first));
390 #endif
391 static void list_vim_vars __ARGS((int *first));
392 static void list_script_vars __ARGS((int *first));
393 static void list_func_vars __ARGS((int *first));
394 static char_u *list_arg_vars __ARGS((exarg_T *eap, char_u *arg, int *first));
395 static char_u *ex_let_one __ARGS((char_u *arg, typval_T *tv, int copy, char_u *endchars, char_u *op));
396 static int check_changedtick __ARGS((char_u *arg));
397 static char_u *get_lval __ARGS((char_u *name, typval_T *rettv, lval_T *lp, int unlet, int skip, int quiet, int fne_flags));
398 static void clear_lval __ARGS((lval_T *lp));
399 static void set_var_lval __ARGS((lval_T *lp, char_u *endp, typval_T *rettv, int copy, char_u *op));
400 static int tv_op __ARGS((typval_T *tv1, typval_T *tv2, char_u *op));
401 static void list_add_watch __ARGS((list_T *l, listwatch_T *lw));
402 static void list_rem_watch __ARGS((list_T *l, listwatch_T *lwrem));
403 static void list_fix_watch __ARGS((list_T *l, listitem_T *item));
404 static void ex_unletlock __ARGS((exarg_T *eap, char_u *argstart, int deep));
405 static int do_unlet_var __ARGS((lval_T *lp, char_u *name_end, int forceit));
406 static int do_lock_var __ARGS((lval_T *lp, char_u *name_end, int deep, int lock));
407 static void item_lock __ARGS((typval_T *tv, int deep, int lock));
408 static int tv_islocked __ARGS((typval_T *tv));
410 static int eval0 __ARGS((char_u *arg, typval_T *rettv, char_u **nextcmd, int evaluate));
411 static int eval1 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
412 static int eval2 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
413 static int eval3 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
414 static int eval4 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
415 static int eval5 __ARGS((char_u **arg, typval_T *rettv, int evaluate));
416 static int eval6 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
417 static int eval7 __ARGS((char_u **arg, typval_T *rettv, int evaluate, int want_string));
419 static int eval_index __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
420 static int get_option_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
421 static int get_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
422 static int get_lit_string_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
423 static int get_list_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
424 static int rettv_list_alloc __ARGS((typval_T *rettv));
425 static listitem_T *listitem_alloc __ARGS((void));
426 static void listitem_free __ARGS((listitem_T *item));
427 static void listitem_remove __ARGS((list_T *l, listitem_T *item));
428 static long list_len __ARGS((list_T *l));
429 static int list_equal __ARGS((list_T *l1, list_T *l2, int ic));
430 static int dict_equal __ARGS((dict_T *d1, dict_T *d2, int ic));
431 static int tv_equal __ARGS((typval_T *tv1, typval_T *tv2, int ic));
432 static listitem_T *list_find __ARGS((list_T *l, long n));
433 static long list_find_nr __ARGS((list_T *l, long idx, int *errorp));
434 static long list_idx_of_item __ARGS((list_T *l, listitem_T *item));
435 static void list_append __ARGS((list_T *l, listitem_T *item));
436 static int list_append_number __ARGS((list_T *l, varnumber_T n));
437 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
438 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
439 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
440 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
441 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
442 static char_u *list2string __ARGS((typval_T *tv, int copyID));
443 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
444 static int free_unref_items __ARGS((int copyID));
445 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
446 static void set_ref_in_list __ARGS((list_T *l, int copyID));
447 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
448 static void dict_unref __ARGS((dict_T *d));
449 static void dict_free __ARGS((dict_T *d, int recurse));
450 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
451 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
452 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
453 static long dict_len __ARGS((dict_T *d));
454 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
455 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
456 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
457 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
458 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
459 static char_u *string_quote __ARGS((char_u *str, int function));
460 #ifdef FEAT_FLOAT
461 static int string2float __ARGS((char_u *text, float_T *value));
462 #endif
463 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
464 static int find_internal_func __ARGS((char_u *name));
465 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
466 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));
467 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));
468 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
469 static int non_zero_arg __ARGS((typval_T *argvars));
471 #ifdef FEAT_FLOAT
472 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
473 #endif
474 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
475 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
476 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
477 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
478 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
479 #ifdef FEAT_FLOAT
480 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
481 #endif
482 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
485 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
491 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
492 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
493 #ifdef FEAT_FLOAT
494 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
495 #endif
496 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
497 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
498 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
499 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
500 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
501 #if defined(FEAT_INS_EXPAND)
502 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
505 #endif
506 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
507 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
508 #ifdef FEAT_FLOAT
509 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
510 #endif
511 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
512 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
513 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
514 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
515 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
530 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
533 #ifdef FEAT_FLOAT
534 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
536 #endif
537 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
608 #ifdef FEAT_FLOAT
609 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
610 #endif
611 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
620 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
621 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
622 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
623 #ifdef vim_mkdir
624 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
625 #endif
626 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
627 #ifdef FEAT_MZSCHEME
628 static void f_mzeval __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
633 #ifdef FEAT_FLOAT
634 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
635 #endif
636 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
653 #ifdef FEAT_FLOAT
654 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
655 #endif
656 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
675 #ifdef FEAT_FLOAT
676 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
677 #endif
678 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
683 #ifdef FEAT_FLOAT
684 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
685 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
686 #endif
687 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
688 #ifdef HAVE_STRFTIME
689 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
690 #endif
691 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
692 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
714 #ifdef FEAT_FLOAT
715 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
716 #endif
717 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
730 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
732 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
733 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
734 static int get_env_len __ARGS((char_u **arg));
735 static int get_id_len __ARGS((char_u **arg));
736 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
737 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
738 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
739 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
740 valid character */
741 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
742 static int eval_isnamec __ARGS((int c));
743 static int eval_isnamec1 __ARGS((int c));
744 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
745 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
746 static typval_T *alloc_tv __ARGS((void));
747 static typval_T *alloc_string_tv __ARGS((char_u *string));
748 static void init_tv __ARGS((typval_T *varp));
749 static long get_tv_number __ARGS((typval_T *varp));
750 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
751 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
752 static char_u *get_tv_string __ARGS((typval_T *varp));
753 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
754 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
755 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
756 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
757 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
758 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
759 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
760 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
761 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
762 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
763 static int var_check_ro __ARGS((int flags, char_u *name));
764 static int var_check_fixed __ARGS((int flags, char_u *name));
765 static int tv_check_lock __ARGS((int lock, char_u *name));
766 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
767 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
768 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
769 static int eval_fname_script __ARGS((char_u *p));
770 static int eval_fname_sid __ARGS((char_u *p));
771 static void list_func_head __ARGS((ufunc_T *fp, int indent));
772 static ufunc_T *find_func __ARGS((char_u *name));
773 static int function_exists __ARGS((char_u *name));
774 static int builtin_function __ARGS((char_u *name));
775 #ifdef FEAT_PROFILE
776 static void func_do_profile __ARGS((ufunc_T *fp));
777 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
778 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
779 static int
780 # ifdef __BORLANDC__
781 _RTLENTRYF
782 # endif
783 prof_total_cmp __ARGS((const void *s1, const void *s2));
784 static int
785 # ifdef __BORLANDC__
786 _RTLENTRYF
787 # endif
788 prof_self_cmp __ARGS((const void *s1, const void *s2));
789 #endif
790 static int script_autoload __ARGS((char_u *name, int reload));
791 static char_u *autoload_name __ARGS((char_u *name));
792 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
793 static void func_free __ARGS((ufunc_T *fp));
794 static void func_unref __ARGS((char_u *name));
795 static void func_ref __ARGS((char_u *name));
796 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));
797 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
798 static void free_funccal __ARGS((funccall_T *fc, int free_val));
799 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
800 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
801 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
802 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
803 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
804 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
806 /* Character used as separated in autoload function/variable names. */
807 #define AUTOLOAD_CHAR '#'
810 * Initialize the global and v: variables.
812 void
813 eval_init()
815 int i;
816 struct vimvar *p;
818 init_var_dict(&globvardict, &globvars_var);
819 init_var_dict(&vimvardict, &vimvars_var);
820 hash_init(&compat_hashtab);
821 hash_init(&func_hashtab);
823 for (i = 0; i < VV_LEN; ++i)
825 p = &vimvars[i];
826 STRCPY(p->vv_di.di_key, p->vv_name);
827 if (p->vv_flags & VV_RO)
828 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
829 else if (p->vv_flags & VV_RO_SBX)
830 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
831 else
832 p->vv_di.di_flags = DI_FLAGS_FIX;
834 /* add to v: scope dict, unless the value is not always available */
835 if (p->vv_type != VAR_UNKNOWN)
836 hash_add(&vimvarht, p->vv_di.di_key);
837 if (p->vv_flags & VV_COMPAT)
838 /* add to compat scope dict */
839 hash_add(&compat_hashtab, p->vv_di.di_key);
841 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
844 #if defined(EXITFREE) || defined(PROTO)
845 void
846 eval_clear()
848 int i;
849 struct vimvar *p;
851 for (i = 0; i < VV_LEN; ++i)
853 p = &vimvars[i];
854 if (p->vv_di.di_tv.v_type == VAR_STRING)
856 vim_free(p->vv_str);
857 p->vv_str = NULL;
859 else if (p->vv_di.di_tv.v_type == VAR_LIST)
861 list_unref(p->vv_list);
862 p->vv_list = NULL;
865 hash_clear(&vimvarht);
866 hash_init(&vimvarht); /* garbage_collect() will access it */
867 hash_clear(&compat_hashtab);
869 /* script-local variables */
870 for (i = 1; i <= ga_scripts.ga_len; ++i)
871 vars_clear(&SCRIPT_VARS(i));
872 ga_clear(&ga_scripts);
873 free_scriptnames();
875 /* global variables */
876 vars_clear(&globvarht);
878 /* autoloaded script names */
879 ga_clear_strings(&ga_loaded);
881 /* unreferenced lists and dicts */
882 (void)garbage_collect();
884 /* functions */
885 free_all_functions();
886 hash_clear(&func_hashtab);
888 #endif
891 * Return the name of the executed function.
893 char_u *
894 func_name(cookie)
895 void *cookie;
897 return ((funccall_T *)cookie)->func->uf_name;
901 * Return the address holding the next breakpoint line for a funccall cookie.
903 linenr_T *
904 func_breakpoint(cookie)
905 void *cookie;
907 return &((funccall_T *)cookie)->breakpoint;
911 * Return the address holding the debug tick for a funccall cookie.
913 int *
914 func_dbg_tick(cookie)
915 void *cookie;
917 return &((funccall_T *)cookie)->dbg_tick;
921 * Return the nesting level for a funccall cookie.
924 func_level(cookie)
925 void *cookie;
927 return ((funccall_T *)cookie)->level;
930 /* pointer to funccal for currently active function */
931 funccall_T *current_funccal = NULL;
933 /* pointer to list of previously used funccal, still around because some
934 * item in it is still being used. */
935 funccall_T *previous_funccal = NULL;
938 * Return TRUE when a function was ended by a ":return" command.
941 current_func_returned()
943 return current_funccal->returned;
948 * Set an internal variable to a string value. Creates the variable if it does
949 * not already exist.
951 void
952 set_internal_string_var(name, value)
953 char_u *name;
954 char_u *value;
956 char_u *val;
957 typval_T *tvp;
959 val = vim_strsave(value);
960 if (val != NULL)
962 tvp = alloc_string_tv(val);
963 if (tvp != NULL)
965 set_var(name, tvp, FALSE);
966 free_tv(tvp);
971 static lval_T *redir_lval = NULL;
972 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
973 static char_u *redir_endp = NULL;
974 static char_u *redir_varname = NULL;
977 * Start recording command output to a variable
978 * Returns OK if successfully completed the setup. FAIL otherwise.
981 var_redir_start(name, append)
982 char_u *name;
983 int append; /* append to an existing variable */
985 int save_emsg;
986 int err;
987 typval_T tv;
989 /* Catch a bad name early. */
990 if (!eval_isnamec1(*name))
992 EMSG(_(e_invarg));
993 return FAIL;
996 /* Make a copy of the name, it is used in redir_lval until redir ends. */
997 redir_varname = vim_strsave(name);
998 if (redir_varname == NULL)
999 return FAIL;
1001 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1002 if (redir_lval == NULL)
1004 var_redir_stop();
1005 return FAIL;
1008 /* The output is stored in growarray "redir_ga" until redirection ends. */
1009 ga_init2(&redir_ga, (int)sizeof(char), 500);
1011 /* Parse the variable name (can be a dict or list entry). */
1012 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1013 FNE_CHECK_START);
1014 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1016 if (redir_endp != NULL && *redir_endp != NUL)
1017 /* Trailing characters are present after the variable name */
1018 EMSG(_(e_trailing));
1019 else
1020 EMSG(_(e_invarg));
1021 redir_endp = NULL; /* don't store a value, only cleanup */
1022 var_redir_stop();
1023 return FAIL;
1026 /* check if we can write to the variable: set it to or append an empty
1027 * string */
1028 save_emsg = did_emsg;
1029 did_emsg = FALSE;
1030 tv.v_type = VAR_STRING;
1031 tv.vval.v_string = (char_u *)"";
1032 if (append)
1033 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1034 else
1035 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1036 err = did_emsg;
1037 did_emsg |= save_emsg;
1038 if (err)
1040 redir_endp = NULL; /* don't store a value, only cleanup */
1041 var_redir_stop();
1042 return FAIL;
1044 if (redir_lval->ll_newkey != NULL)
1046 /* Dictionary item was created, don't do it again. */
1047 vim_free(redir_lval->ll_newkey);
1048 redir_lval->ll_newkey = NULL;
1051 return OK;
1055 * Append "value[value_len]" to the variable set by var_redir_start().
1056 * The actual appending is postponed until redirection ends, because the value
1057 * appended may in fact be the string we write to, changing it may cause freed
1058 * memory to be used:
1059 * :redir => foo
1060 * :let foo
1061 * :redir END
1063 void
1064 var_redir_str(value, value_len)
1065 char_u *value;
1066 int value_len;
1068 int len;
1070 if (redir_lval == NULL)
1071 return;
1073 if (value_len == -1)
1074 len = (int)STRLEN(value); /* Append the entire string */
1075 else
1076 len = value_len; /* Append only "value_len" characters */
1078 if (ga_grow(&redir_ga, len) == OK)
1080 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1081 redir_ga.ga_len += len;
1083 else
1084 var_redir_stop();
1088 * Stop redirecting command output to a variable.
1089 * Frees the allocated memory.
1091 void
1092 var_redir_stop()
1094 typval_T tv;
1096 if (redir_lval != NULL)
1098 /* If there was no error: assign the text to the variable. */
1099 if (redir_endp != NULL)
1101 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
1102 tv.v_type = VAR_STRING;
1103 tv.vval.v_string = redir_ga.ga_data;
1104 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1107 /* free the collected output */
1108 vim_free(redir_ga.ga_data);
1109 redir_ga.ga_data = NULL;
1111 clear_lval(redir_lval);
1112 vim_free(redir_lval);
1113 redir_lval = NULL;
1115 vim_free(redir_varname);
1116 redir_varname = NULL;
1119 # if defined(FEAT_MBYTE) || defined(PROTO)
1121 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1122 char_u *enc_from;
1123 char_u *enc_to;
1124 char_u *fname_from;
1125 char_u *fname_to;
1127 int err = FALSE;
1129 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1130 set_vim_var_string(VV_CC_TO, enc_to, -1);
1131 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1132 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1133 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1134 err = TRUE;
1135 set_vim_var_string(VV_CC_FROM, NULL, -1);
1136 set_vim_var_string(VV_CC_TO, NULL, -1);
1137 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1138 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1140 if (err)
1141 return FAIL;
1142 return OK;
1144 # endif
1146 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1148 eval_printexpr(fname, args)
1149 char_u *fname;
1150 char_u *args;
1152 int err = FALSE;
1154 set_vim_var_string(VV_FNAME_IN, fname, -1);
1155 set_vim_var_string(VV_CMDARG, args, -1);
1156 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1157 err = TRUE;
1158 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1159 set_vim_var_string(VV_CMDARG, NULL, -1);
1161 if (err)
1163 mch_remove(fname);
1164 return FAIL;
1166 return OK;
1168 # endif
1170 # if defined(FEAT_DIFF) || defined(PROTO)
1171 void
1172 eval_diff(origfile, newfile, outfile)
1173 char_u *origfile;
1174 char_u *newfile;
1175 char_u *outfile;
1177 int err = FALSE;
1179 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1180 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1181 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1182 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1183 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1184 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1185 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1188 void
1189 eval_patch(origfile, difffile, outfile)
1190 char_u *origfile;
1191 char_u *difffile;
1192 char_u *outfile;
1194 int err;
1196 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1197 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1198 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1199 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1200 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1201 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1202 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1204 # endif
1207 * Top level evaluation function, returning a boolean.
1208 * Sets "error" to TRUE if there was an error.
1209 * Return TRUE or FALSE.
1212 eval_to_bool(arg, error, nextcmd, skip)
1213 char_u *arg;
1214 int *error;
1215 char_u **nextcmd;
1216 int skip; /* only parse, don't execute */
1218 typval_T tv;
1219 int retval = FALSE;
1221 if (skip)
1222 ++emsg_skip;
1223 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1224 *error = TRUE;
1225 else
1227 *error = FALSE;
1228 if (!skip)
1230 retval = (get_tv_number_chk(&tv, error) != 0);
1231 clear_tv(&tv);
1234 if (skip)
1235 --emsg_skip;
1237 return retval;
1241 * Top level evaluation function, returning a string. If "skip" is TRUE,
1242 * only parsing to "nextcmd" is done, without reporting errors. Return
1243 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1245 char_u *
1246 eval_to_string_skip(arg, nextcmd, skip)
1247 char_u *arg;
1248 char_u **nextcmd;
1249 int skip; /* only parse, don't execute */
1251 typval_T tv;
1252 char_u *retval;
1254 if (skip)
1255 ++emsg_skip;
1256 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1257 retval = NULL;
1258 else
1260 retval = vim_strsave(get_tv_string(&tv));
1261 clear_tv(&tv);
1263 if (skip)
1264 --emsg_skip;
1266 return retval;
1270 * Skip over an expression at "*pp".
1271 * Return FAIL for an error, OK otherwise.
1274 skip_expr(pp)
1275 char_u **pp;
1277 typval_T rettv;
1279 *pp = skipwhite(*pp);
1280 return eval1(pp, &rettv, FALSE);
1284 * Top level evaluation function, returning a string.
1285 * When "convert" is TRUE convert a List into a sequence of lines and convert
1286 * a Float to a String.
1287 * Return pointer to allocated memory, or NULL for failure.
1289 char_u *
1290 eval_to_string(arg, nextcmd, convert)
1291 char_u *arg;
1292 char_u **nextcmd;
1293 int convert;
1295 typval_T tv;
1296 char_u *retval;
1297 garray_T ga;
1298 #ifdef FEAT_FLOAT
1299 char_u numbuf[NUMBUFLEN];
1300 #endif
1302 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1303 retval = NULL;
1304 else
1306 if (convert && tv.v_type == VAR_LIST)
1308 ga_init2(&ga, (int)sizeof(char), 80);
1309 if (tv.vval.v_list != NULL)
1310 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1311 ga_append(&ga, NUL);
1312 retval = (char_u *)ga.ga_data;
1314 #ifdef FEAT_FLOAT
1315 else if (convert && tv.v_type == VAR_FLOAT)
1317 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1318 retval = vim_strsave(numbuf);
1320 #endif
1321 else
1322 retval = vim_strsave(get_tv_string(&tv));
1323 clear_tv(&tv);
1326 return retval;
1330 * Call eval_to_string() without using current local variables and using
1331 * textlock. When "use_sandbox" is TRUE use the sandbox.
1333 char_u *
1334 eval_to_string_safe(arg, nextcmd, use_sandbox)
1335 char_u *arg;
1336 char_u **nextcmd;
1337 int use_sandbox;
1339 char_u *retval;
1340 void *save_funccalp;
1342 save_funccalp = save_funccal();
1343 if (use_sandbox)
1344 ++sandbox;
1345 ++textlock;
1346 retval = eval_to_string(arg, nextcmd, FALSE);
1347 if (use_sandbox)
1348 --sandbox;
1349 --textlock;
1350 restore_funccal(save_funccalp);
1351 return retval;
1355 * Top level evaluation function, returning a number.
1356 * Evaluates "expr" silently.
1357 * Returns -1 for an error.
1360 eval_to_number(expr)
1361 char_u *expr;
1363 typval_T rettv;
1364 int retval;
1365 char_u *p = skipwhite(expr);
1367 ++emsg_off;
1369 if (eval1(&p, &rettv, TRUE) == FAIL)
1370 retval = -1;
1371 else
1373 retval = get_tv_number_chk(&rettv, NULL);
1374 clear_tv(&rettv);
1376 --emsg_off;
1378 return retval;
1382 * Prepare v: variable "idx" to be used.
1383 * Save the current typeval in "save_tv".
1384 * When not used yet add the variable to the v: hashtable.
1386 static void
1387 prepare_vimvar(idx, save_tv)
1388 int idx;
1389 typval_T *save_tv;
1391 *save_tv = vimvars[idx].vv_tv;
1392 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1393 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1397 * Restore v: variable "idx" to typeval "save_tv".
1398 * When no longer defined, remove the variable from the v: hashtable.
1400 static void
1401 restore_vimvar(idx, save_tv)
1402 int idx;
1403 typval_T *save_tv;
1405 hashitem_T *hi;
1407 vimvars[idx].vv_tv = *save_tv;
1408 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1410 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1411 if (HASHITEM_EMPTY(hi))
1412 EMSG2(_(e_intern2), "restore_vimvar()");
1413 else
1414 hash_remove(&vimvarht, hi);
1418 #if defined(FEAT_SPELL) || defined(PROTO)
1420 * Evaluate an expression to a list with suggestions.
1421 * For the "expr:" part of 'spellsuggest'.
1422 * Returns NULL when there is an error.
1424 list_T *
1425 eval_spell_expr(badword, expr)
1426 char_u *badword;
1427 char_u *expr;
1429 typval_T save_val;
1430 typval_T rettv;
1431 list_T *list = NULL;
1432 char_u *p = skipwhite(expr);
1434 /* Set "v:val" to the bad word. */
1435 prepare_vimvar(VV_VAL, &save_val);
1436 vimvars[VV_VAL].vv_type = VAR_STRING;
1437 vimvars[VV_VAL].vv_str = badword;
1438 if (p_verbose == 0)
1439 ++emsg_off;
1441 if (eval1(&p, &rettv, TRUE) == OK)
1443 if (rettv.v_type != VAR_LIST)
1444 clear_tv(&rettv);
1445 else
1446 list = rettv.vval.v_list;
1449 if (p_verbose == 0)
1450 --emsg_off;
1451 restore_vimvar(VV_VAL, &save_val);
1453 return list;
1457 * "list" is supposed to contain two items: a word and a number. Return the
1458 * word in "pp" and the number as the return value.
1459 * Return -1 if anything isn't right.
1460 * Used to get the good word and score from the eval_spell_expr() result.
1463 get_spellword(list, pp)
1464 list_T *list;
1465 char_u **pp;
1467 listitem_T *li;
1469 li = list->lv_first;
1470 if (li == NULL)
1471 return -1;
1472 *pp = get_tv_string(&li->li_tv);
1474 li = li->li_next;
1475 if (li == NULL)
1476 return -1;
1477 return get_tv_number(&li->li_tv);
1479 #endif
1482 * Top level evaluation function.
1483 * Returns an allocated typval_T with the result.
1484 * Returns NULL when there is an error.
1486 typval_T *
1487 eval_expr(arg, nextcmd)
1488 char_u *arg;
1489 char_u **nextcmd;
1491 typval_T *tv;
1493 tv = (typval_T *)alloc(sizeof(typval_T));
1494 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1496 vim_free(tv);
1497 tv = NULL;
1500 return tv;
1504 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1505 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1507 * Call some vimL function and return the result in "*rettv".
1508 * Uses argv[argc] for the function arguments. Only Number and String
1509 * arguments are currently supported.
1510 * Returns OK or FAIL.
1512 static int
1513 call_vim_function(func, argc, argv, safe, rettv)
1514 char_u *func;
1515 int argc;
1516 char_u **argv;
1517 int safe; /* use the sandbox */
1518 typval_T *rettv;
1520 typval_T *argvars;
1521 long n;
1522 int len;
1523 int i;
1524 int doesrange;
1525 void *save_funccalp = NULL;
1526 int ret;
1528 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1529 if (argvars == NULL)
1530 return FAIL;
1532 for (i = 0; i < argc; i++)
1534 /* Pass a NULL or empty argument as an empty string */
1535 if (argv[i] == NULL || *argv[i] == NUL)
1537 argvars[i].v_type = VAR_STRING;
1538 argvars[i].vval.v_string = (char_u *)"";
1539 continue;
1542 /* Recognize a number argument, the others must be strings. */
1543 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1544 if (len != 0 && len == (int)STRLEN(argv[i]))
1546 argvars[i].v_type = VAR_NUMBER;
1547 argvars[i].vval.v_number = n;
1549 else
1551 argvars[i].v_type = VAR_STRING;
1552 argvars[i].vval.v_string = argv[i];
1556 if (safe)
1558 save_funccalp = save_funccal();
1559 ++sandbox;
1562 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1563 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1564 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1565 &doesrange, TRUE, NULL);
1566 if (safe)
1568 --sandbox;
1569 restore_funccal(save_funccalp);
1571 vim_free(argvars);
1573 if (ret == FAIL)
1574 clear_tv(rettv);
1576 return ret;
1579 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1581 * Call vimL function "func" and return the result as a string.
1582 * Returns NULL when calling the function fails.
1583 * Uses argv[argc] for the function arguments.
1585 void *
1586 call_func_retstr(func, argc, argv, safe)
1587 char_u *func;
1588 int argc;
1589 char_u **argv;
1590 int safe; /* use the sandbox */
1592 typval_T rettv;
1593 char_u *retval;
1595 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1596 return NULL;
1598 retval = vim_strsave(get_tv_string(&rettv));
1599 clear_tv(&rettv);
1600 return retval;
1602 # endif
1604 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1606 * Call vimL function "func" and return the result as a number.
1607 * Returns -1 when calling the function fails.
1608 * Uses argv[argc] for the function arguments.
1610 long
1611 call_func_retnr(func, argc, argv, safe)
1612 char_u *func;
1613 int argc;
1614 char_u **argv;
1615 int safe; /* use the sandbox */
1617 typval_T rettv;
1618 long retval;
1620 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1621 return -1;
1623 retval = get_tv_number_chk(&rettv, NULL);
1624 clear_tv(&rettv);
1625 return retval;
1627 # endif
1630 * Call vimL function "func" and return the result as a List.
1631 * Uses argv[argc] for the function arguments.
1632 * Returns NULL when there is something wrong.
1634 void *
1635 call_func_retlist(func, argc, argv, safe)
1636 char_u *func;
1637 int argc;
1638 char_u **argv;
1639 int safe; /* use the sandbox */
1641 typval_T rettv;
1643 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1644 return NULL;
1646 if (rettv.v_type != VAR_LIST)
1648 clear_tv(&rettv);
1649 return NULL;
1652 return rettv.vval.v_list;
1654 #endif
1658 * Save the current function call pointer, and set it to NULL.
1659 * Used when executing autocommands and for ":source".
1661 void *
1662 save_funccal()
1664 funccall_T *fc = current_funccal;
1666 current_funccal = NULL;
1667 return (void *)fc;
1670 void
1671 restore_funccal(vfc)
1672 void *vfc;
1674 funccall_T *fc = (funccall_T *)vfc;
1676 current_funccal = fc;
1679 #if defined(FEAT_PROFILE) || defined(PROTO)
1681 * Prepare profiling for entering a child or something else that is not
1682 * counted for the script/function itself.
1683 * Should always be called in pair with prof_child_exit().
1685 void
1686 prof_child_enter(tm)
1687 proftime_T *tm; /* place to store waittime */
1689 funccall_T *fc = current_funccal;
1691 if (fc != NULL && fc->func->uf_profiling)
1692 profile_start(&fc->prof_child);
1693 script_prof_save(tm);
1697 * Take care of time spent in a child.
1698 * Should always be called after prof_child_enter().
1700 void
1701 prof_child_exit(tm)
1702 proftime_T *tm; /* where waittime was stored */
1704 funccall_T *fc = current_funccal;
1706 if (fc != NULL && fc->func->uf_profiling)
1708 profile_end(&fc->prof_child);
1709 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1710 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1711 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1713 script_prof_restore(tm);
1715 #endif
1718 #ifdef FEAT_FOLDING
1720 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1721 * it in "*cp". Doesn't give error messages.
1724 eval_foldexpr(arg, cp)
1725 char_u *arg;
1726 int *cp;
1728 typval_T tv;
1729 int retval;
1730 char_u *s;
1731 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1732 OPT_LOCAL);
1734 ++emsg_off;
1735 if (use_sandbox)
1736 ++sandbox;
1737 ++textlock;
1738 *cp = NUL;
1739 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1740 retval = 0;
1741 else
1743 /* If the result is a number, just return the number. */
1744 if (tv.v_type == VAR_NUMBER)
1745 retval = tv.vval.v_number;
1746 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1747 retval = 0;
1748 else
1750 /* If the result is a string, check if there is a non-digit before
1751 * the number. */
1752 s = tv.vval.v_string;
1753 if (!VIM_ISDIGIT(*s) && *s != '-')
1754 *cp = *s++;
1755 retval = atol((char *)s);
1757 clear_tv(&tv);
1759 --emsg_off;
1760 if (use_sandbox)
1761 --sandbox;
1762 --textlock;
1764 return retval;
1766 #endif
1769 * ":let" list all variable values
1770 * ":let var1 var2" list variable values
1771 * ":let var = expr" assignment command.
1772 * ":let var += expr" assignment command.
1773 * ":let var -= expr" assignment command.
1774 * ":let var .= expr" assignment command.
1775 * ":let [var1, var2] = expr" unpack list.
1777 void
1778 ex_let(eap)
1779 exarg_T *eap;
1781 char_u *arg = eap->arg;
1782 char_u *expr = NULL;
1783 typval_T rettv;
1784 int i;
1785 int var_count = 0;
1786 int semicolon = 0;
1787 char_u op[2];
1788 char_u *argend;
1789 int first = TRUE;
1791 argend = skip_var_list(arg, &var_count, &semicolon);
1792 if (argend == NULL)
1793 return;
1794 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1795 --argend;
1796 expr = vim_strchr(argend, '=');
1797 if (expr == NULL)
1800 * ":let" without "=": list variables
1802 if (*arg == '[')
1803 EMSG(_(e_invarg));
1804 else if (!ends_excmd(*arg))
1805 /* ":let var1 var2" */
1806 arg = list_arg_vars(eap, arg, &first);
1807 else if (!eap->skip)
1809 /* ":let" */
1810 list_glob_vars(&first);
1811 list_buf_vars(&first);
1812 list_win_vars(&first);
1813 #ifdef FEAT_WINDOWS
1814 list_tab_vars(&first);
1815 #endif
1816 list_script_vars(&first);
1817 list_func_vars(&first);
1818 list_vim_vars(&first);
1820 eap->nextcmd = check_nextcmd(arg);
1822 else
1824 op[0] = '=';
1825 op[1] = NUL;
1826 if (expr > argend)
1828 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1829 op[0] = expr[-1]; /* +=, -= or .= */
1831 expr = skipwhite(expr + 1);
1833 if (eap->skip)
1834 ++emsg_skip;
1835 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1836 if (eap->skip)
1838 if (i != FAIL)
1839 clear_tv(&rettv);
1840 --emsg_skip;
1842 else if (i != FAIL)
1844 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1845 op);
1846 clear_tv(&rettv);
1852 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1853 * Handles both "var" with any type and "[var, var; var]" with a list type.
1854 * When "nextchars" is not NULL it points to a string with characters that
1855 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1856 * or concatenate.
1857 * Returns OK or FAIL;
1859 static int
1860 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1861 char_u *arg_start;
1862 typval_T *tv;
1863 int copy; /* copy values from "tv", don't move */
1864 int semicolon; /* from skip_var_list() */
1865 int var_count; /* from skip_var_list() */
1866 char_u *nextchars;
1868 char_u *arg = arg_start;
1869 list_T *l;
1870 int i;
1871 listitem_T *item;
1872 typval_T ltv;
1874 if (*arg != '[')
1877 * ":let var = expr" or ":for var in list"
1879 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1880 return FAIL;
1881 return OK;
1885 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1887 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1889 EMSG(_(e_listreq));
1890 return FAIL;
1893 i = list_len(l);
1894 if (semicolon == 0 && var_count < i)
1896 EMSG(_("E687: Less targets than List items"));
1897 return FAIL;
1899 if (var_count - semicolon > i)
1901 EMSG(_("E688: More targets than List items"));
1902 return FAIL;
1905 item = l->lv_first;
1906 while (*arg != ']')
1908 arg = skipwhite(arg + 1);
1909 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1910 item = item->li_next;
1911 if (arg == NULL)
1912 return FAIL;
1914 arg = skipwhite(arg);
1915 if (*arg == ';')
1917 /* Put the rest of the list (may be empty) in the var after ';'.
1918 * Create a new list for this. */
1919 l = list_alloc();
1920 if (l == NULL)
1921 return FAIL;
1922 while (item != NULL)
1924 list_append_tv(l, &item->li_tv);
1925 item = item->li_next;
1928 ltv.v_type = VAR_LIST;
1929 ltv.v_lock = 0;
1930 ltv.vval.v_list = l;
1931 l->lv_refcount = 1;
1933 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1934 (char_u *)"]", nextchars);
1935 clear_tv(&ltv);
1936 if (arg == NULL)
1937 return FAIL;
1938 break;
1940 else if (*arg != ',' && *arg != ']')
1942 EMSG2(_(e_intern2), "ex_let_vars()");
1943 return FAIL;
1947 return OK;
1951 * Skip over assignable variable "var" or list of variables "[var, var]".
1952 * Used for ":let varvar = expr" and ":for varvar in expr".
1953 * For "[var, var]" increment "*var_count" for each variable.
1954 * for "[var, var; var]" set "semicolon".
1955 * Return NULL for an error.
1957 static char_u *
1958 skip_var_list(arg, var_count, semicolon)
1959 char_u *arg;
1960 int *var_count;
1961 int *semicolon;
1963 char_u *p, *s;
1965 if (*arg == '[')
1967 /* "[var, var]": find the matching ']'. */
1968 p = arg;
1969 for (;;)
1971 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1972 s = skip_var_one(p);
1973 if (s == p)
1975 EMSG2(_(e_invarg2), p);
1976 return NULL;
1978 ++*var_count;
1980 p = skipwhite(s);
1981 if (*p == ']')
1982 break;
1983 else if (*p == ';')
1985 if (*semicolon == 1)
1987 EMSG(_("Double ; in list of variables"));
1988 return NULL;
1990 *semicolon = 1;
1992 else if (*p != ',')
1994 EMSG2(_(e_invarg2), p);
1995 return NULL;
1998 return p + 1;
2000 else
2001 return skip_var_one(arg);
2005 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2006 * l[idx].
2008 static char_u *
2009 skip_var_one(arg)
2010 char_u *arg;
2012 if (*arg == '@' && arg[1] != NUL)
2013 return arg + 2;
2014 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2015 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2019 * List variables for hashtab "ht" with prefix "prefix".
2020 * If "empty" is TRUE also list NULL strings as empty strings.
2022 static void
2023 list_hashtable_vars(ht, prefix, empty, first)
2024 hashtab_T *ht;
2025 char_u *prefix;
2026 int empty;
2027 int *first;
2029 hashitem_T *hi;
2030 dictitem_T *di;
2031 int todo;
2033 todo = (int)ht->ht_used;
2034 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2036 if (!HASHITEM_EMPTY(hi))
2038 --todo;
2039 di = HI2DI(hi);
2040 if (empty || di->di_tv.v_type != VAR_STRING
2041 || di->di_tv.vval.v_string != NULL)
2042 list_one_var(di, prefix, first);
2048 * List global variables.
2050 static void
2051 list_glob_vars(first)
2052 int *first;
2054 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2058 * List buffer variables.
2060 static void
2061 list_buf_vars(first)
2062 int *first;
2064 char_u numbuf[NUMBUFLEN];
2066 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2067 TRUE, first);
2069 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2070 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2071 numbuf, first);
2075 * List window variables.
2077 static void
2078 list_win_vars(first)
2079 int *first;
2081 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2082 (char_u *)"w:", TRUE, first);
2085 #ifdef FEAT_WINDOWS
2087 * List tab page variables.
2089 static void
2090 list_tab_vars(first)
2091 int *first;
2093 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2094 (char_u *)"t:", TRUE, first);
2096 #endif
2099 * List Vim variables.
2101 static void
2102 list_vim_vars(first)
2103 int *first;
2105 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2109 * List script-local variables, if there is a script.
2111 static void
2112 list_script_vars(first)
2113 int *first;
2115 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2116 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2117 (char_u *)"s:", FALSE, first);
2121 * List function variables, if there is a function.
2123 static void
2124 list_func_vars(first)
2125 int *first;
2127 if (current_funccal != NULL)
2128 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2129 (char_u *)"l:", FALSE, first);
2133 * List variables in "arg".
2135 static char_u *
2136 list_arg_vars(eap, arg, first)
2137 exarg_T *eap;
2138 char_u *arg;
2139 int *first;
2141 int error = FALSE;
2142 int len;
2143 char_u *name;
2144 char_u *name_start;
2145 char_u *arg_subsc;
2146 char_u *tofree;
2147 typval_T tv;
2149 while (!ends_excmd(*arg) && !got_int)
2151 if (error || eap->skip)
2153 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2154 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2156 emsg_severe = TRUE;
2157 EMSG(_(e_trailing));
2158 break;
2161 else
2163 /* get_name_len() takes care of expanding curly braces */
2164 name_start = name = arg;
2165 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2166 if (len <= 0)
2168 /* This is mainly to keep test 49 working: when expanding
2169 * curly braces fails overrule the exception error message. */
2170 if (len < 0 && !aborting())
2172 emsg_severe = TRUE;
2173 EMSG2(_(e_invarg2), arg);
2174 break;
2176 error = TRUE;
2178 else
2180 if (tofree != NULL)
2181 name = tofree;
2182 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2183 error = TRUE;
2184 else
2186 /* handle d.key, l[idx], f(expr) */
2187 arg_subsc = arg;
2188 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2189 error = TRUE;
2190 else
2192 if (arg == arg_subsc && len == 2 && name[1] == ':')
2194 switch (*name)
2196 case 'g': list_glob_vars(first); break;
2197 case 'b': list_buf_vars(first); break;
2198 case 'w': list_win_vars(first); break;
2199 #ifdef FEAT_WINDOWS
2200 case 't': list_tab_vars(first); break;
2201 #endif
2202 case 'v': list_vim_vars(first); break;
2203 case 's': list_script_vars(first); break;
2204 case 'l': list_func_vars(first); break;
2205 default:
2206 EMSG2(_("E738: Can't list variables for %s"), name);
2209 else
2211 char_u numbuf[NUMBUFLEN];
2212 char_u *tf;
2213 int c;
2214 char_u *s;
2216 s = echo_string(&tv, &tf, numbuf, 0);
2217 c = *arg;
2218 *arg = NUL;
2219 list_one_var_a((char_u *)"",
2220 arg == arg_subsc ? name : name_start,
2221 tv.v_type,
2222 s == NULL ? (char_u *)"" : s,
2223 first);
2224 *arg = c;
2225 vim_free(tf);
2227 clear_tv(&tv);
2232 vim_free(tofree);
2235 arg = skipwhite(arg);
2238 return arg;
2242 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2243 * Returns a pointer to the char just after the var name.
2244 * Returns NULL if there is an error.
2246 static char_u *
2247 ex_let_one(arg, tv, copy, endchars, op)
2248 char_u *arg; /* points to variable name */
2249 typval_T *tv; /* value to assign to variable */
2250 int copy; /* copy value from "tv" */
2251 char_u *endchars; /* valid chars after variable name or NULL */
2252 char_u *op; /* "+", "-", "." or NULL*/
2254 int c1;
2255 char_u *name;
2256 char_u *p;
2257 char_u *arg_end = NULL;
2258 int len;
2259 int opt_flags;
2260 char_u *tofree = NULL;
2263 * ":let $VAR = expr": Set environment variable.
2265 if (*arg == '$')
2267 /* Find the end of the name. */
2268 ++arg;
2269 name = arg;
2270 len = get_env_len(&arg);
2271 if (len == 0)
2272 EMSG2(_(e_invarg2), name - 1);
2273 else
2275 if (op != NULL && (*op == '+' || *op == '-'))
2276 EMSG2(_(e_letwrong), op);
2277 else if (endchars != NULL
2278 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2279 EMSG(_(e_letunexp));
2280 else
2282 c1 = name[len];
2283 name[len] = NUL;
2284 p = get_tv_string_chk(tv);
2285 if (p != NULL && op != NULL && *op == '.')
2287 int mustfree = FALSE;
2288 char_u *s = vim_getenv(name, &mustfree);
2290 if (s != NULL)
2292 p = tofree = concat_str(s, p);
2293 if (mustfree)
2294 vim_free(s);
2297 if (p != NULL)
2299 vim_setenv(name, p);
2300 if (STRICMP(name, "HOME") == 0)
2301 init_homedir();
2302 else if (didset_vim && STRICMP(name, "VIM") == 0)
2303 didset_vim = FALSE;
2304 else if (didset_vimruntime
2305 && STRICMP(name, "VIMRUNTIME") == 0)
2306 didset_vimruntime = FALSE;
2307 arg_end = arg;
2309 name[len] = c1;
2310 vim_free(tofree);
2316 * ":let &option = expr": Set option value.
2317 * ":let &l:option = expr": Set local option value.
2318 * ":let &g:option = expr": Set global option value.
2320 else if (*arg == '&')
2322 /* Find the end of the name. */
2323 p = find_option_end(&arg, &opt_flags);
2324 if (p == NULL || (endchars != NULL
2325 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2326 EMSG(_(e_letunexp));
2327 else
2329 long n;
2330 int opt_type;
2331 long numval;
2332 char_u *stringval = NULL;
2333 char_u *s;
2335 c1 = *p;
2336 *p = NUL;
2338 n = get_tv_number(tv);
2339 s = get_tv_string_chk(tv); /* != NULL if number or string */
2340 if (s != NULL && op != NULL && *op != '=')
2342 opt_type = get_option_value(arg, &numval,
2343 &stringval, opt_flags);
2344 if ((opt_type == 1 && *op == '.')
2345 || (opt_type == 0 && *op != '.'))
2346 EMSG2(_(e_letwrong), op);
2347 else
2349 if (opt_type == 1) /* number */
2351 if (*op == '+')
2352 n = numval + n;
2353 else
2354 n = numval - n;
2356 else if (opt_type == 0 && stringval != NULL) /* string */
2358 s = concat_str(stringval, s);
2359 vim_free(stringval);
2360 stringval = s;
2364 if (s != NULL)
2366 set_option_value(arg, n, s, opt_flags);
2367 arg_end = p;
2369 *p = c1;
2370 vim_free(stringval);
2375 * ":let @r = expr": Set register contents.
2377 else if (*arg == '@')
2379 ++arg;
2380 if (op != NULL && (*op == '+' || *op == '-'))
2381 EMSG2(_(e_letwrong), op);
2382 else if (endchars != NULL
2383 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2384 EMSG(_(e_letunexp));
2385 else
2387 char_u *ptofree = NULL;
2388 char_u *s;
2390 p = get_tv_string_chk(tv);
2391 if (p != NULL && op != NULL && *op == '.')
2393 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2394 if (s != NULL)
2396 p = ptofree = concat_str(s, p);
2397 vim_free(s);
2400 if (p != NULL)
2402 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2403 arg_end = arg + 1;
2405 vim_free(ptofree);
2410 * ":let var = expr": Set internal variable.
2411 * ":let {expr} = expr": Idem, name made with curly braces
2413 else if (eval_isnamec1(*arg) || *arg == '{')
2415 lval_T lv;
2417 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2418 if (p != NULL && lv.ll_name != NULL)
2420 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2421 EMSG(_(e_letunexp));
2422 else
2424 set_var_lval(&lv, p, tv, copy, op);
2425 arg_end = p;
2428 clear_lval(&lv);
2431 else
2432 EMSG2(_(e_invarg2), arg);
2434 return arg_end;
2438 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2440 static int
2441 check_changedtick(arg)
2442 char_u *arg;
2444 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2446 EMSG2(_(e_readonlyvar), arg);
2447 return TRUE;
2449 return FALSE;
2453 * Get an lval: variable, Dict item or List item that can be assigned a value
2454 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2455 * "name.key", "name.key[expr]" etc.
2456 * Indexing only works if "name" is an existing List or Dictionary.
2457 * "name" points to the start of the name.
2458 * If "rettv" is not NULL it points to the value to be assigned.
2459 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2460 * wrong; must end in space or cmd separator.
2462 * Returns a pointer to just after the name, including indexes.
2463 * When an evaluation error occurs "lp->ll_name" is NULL;
2464 * Returns NULL for a parsing error. Still need to free items in "lp"!
2466 static char_u *
2467 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2468 char_u *name;
2469 typval_T *rettv;
2470 lval_T *lp;
2471 int unlet;
2472 int skip;
2473 int quiet; /* don't give error messages */
2474 int fne_flags; /* flags for find_name_end() */
2476 char_u *p;
2477 char_u *expr_start, *expr_end;
2478 int cc;
2479 dictitem_T *v;
2480 typval_T var1;
2481 typval_T var2;
2482 int empty1 = FALSE;
2483 listitem_T *ni;
2484 char_u *key = NULL;
2485 int len;
2486 hashtab_T *ht;
2488 /* Clear everything in "lp". */
2489 vim_memset(lp, 0, sizeof(lval_T));
2491 if (skip)
2493 /* When skipping just find the end of the name. */
2494 lp->ll_name = name;
2495 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2498 /* Find the end of the name. */
2499 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2500 if (expr_start != NULL)
2502 /* Don't expand the name when we already know there is an error. */
2503 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2504 && *p != '[' && *p != '.')
2506 EMSG(_(e_trailing));
2507 return NULL;
2510 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2511 if (lp->ll_exp_name == NULL)
2513 /* Report an invalid expression in braces, unless the
2514 * expression evaluation has been cancelled due to an
2515 * aborting error, an interrupt, or an exception. */
2516 if (!aborting() && !quiet)
2518 emsg_severe = TRUE;
2519 EMSG2(_(e_invarg2), name);
2520 return NULL;
2523 lp->ll_name = lp->ll_exp_name;
2525 else
2526 lp->ll_name = name;
2528 /* Without [idx] or .key we are done. */
2529 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2530 return p;
2532 cc = *p;
2533 *p = NUL;
2534 v = find_var(lp->ll_name, &ht);
2535 if (v == NULL && !quiet)
2536 EMSG2(_(e_undefvar), lp->ll_name);
2537 *p = cc;
2538 if (v == NULL)
2539 return NULL;
2542 * Loop until no more [idx] or .key is following.
2544 lp->ll_tv = &v->di_tv;
2545 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2547 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2548 && !(lp->ll_tv->v_type == VAR_DICT
2549 && lp->ll_tv->vval.v_dict != NULL))
2551 if (!quiet)
2552 EMSG(_("E689: Can only index a List or Dictionary"));
2553 return NULL;
2555 if (lp->ll_range)
2557 if (!quiet)
2558 EMSG(_("E708: [:] must come last"));
2559 return NULL;
2562 len = -1;
2563 if (*p == '.')
2565 key = p + 1;
2566 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2568 if (len == 0)
2570 if (!quiet)
2571 EMSG(_(e_emptykey));
2572 return NULL;
2574 p = key + len;
2576 else
2578 /* Get the index [expr] or the first index [expr: ]. */
2579 p = skipwhite(p + 1);
2580 if (*p == ':')
2581 empty1 = TRUE;
2582 else
2584 empty1 = FALSE;
2585 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2586 return NULL;
2587 if (get_tv_string_chk(&var1) == NULL)
2589 /* not a number or string */
2590 clear_tv(&var1);
2591 return NULL;
2595 /* Optionally get the second index [ :expr]. */
2596 if (*p == ':')
2598 if (lp->ll_tv->v_type == VAR_DICT)
2600 if (!quiet)
2601 EMSG(_(e_dictrange));
2602 if (!empty1)
2603 clear_tv(&var1);
2604 return NULL;
2606 if (rettv != NULL && (rettv->v_type != VAR_LIST
2607 || rettv->vval.v_list == NULL))
2609 if (!quiet)
2610 EMSG(_("E709: [:] requires a List value"));
2611 if (!empty1)
2612 clear_tv(&var1);
2613 return NULL;
2615 p = skipwhite(p + 1);
2616 if (*p == ']')
2617 lp->ll_empty2 = TRUE;
2618 else
2620 lp->ll_empty2 = FALSE;
2621 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2623 if (!empty1)
2624 clear_tv(&var1);
2625 return NULL;
2627 if (get_tv_string_chk(&var2) == NULL)
2629 /* not a number or string */
2630 if (!empty1)
2631 clear_tv(&var1);
2632 clear_tv(&var2);
2633 return NULL;
2636 lp->ll_range = TRUE;
2638 else
2639 lp->ll_range = FALSE;
2641 if (*p != ']')
2643 if (!quiet)
2644 EMSG(_(e_missbrac));
2645 if (!empty1)
2646 clear_tv(&var1);
2647 if (lp->ll_range && !lp->ll_empty2)
2648 clear_tv(&var2);
2649 return NULL;
2652 /* Skip to past ']'. */
2653 ++p;
2656 if (lp->ll_tv->v_type == VAR_DICT)
2658 if (len == -1)
2660 /* "[key]": get key from "var1" */
2661 key = get_tv_string(&var1); /* is number or string */
2662 if (*key == NUL)
2664 if (!quiet)
2665 EMSG(_(e_emptykey));
2666 clear_tv(&var1);
2667 return NULL;
2670 lp->ll_list = NULL;
2671 lp->ll_dict = lp->ll_tv->vval.v_dict;
2672 lp->ll_di = dict_find(lp->ll_dict, key, len);
2673 if (lp->ll_di == NULL)
2675 /* Key does not exist in dict: may need to add it. */
2676 if (*p == '[' || *p == '.' || unlet)
2678 if (!quiet)
2679 EMSG2(_(e_dictkey), key);
2680 if (len == -1)
2681 clear_tv(&var1);
2682 return NULL;
2684 if (len == -1)
2685 lp->ll_newkey = vim_strsave(key);
2686 else
2687 lp->ll_newkey = vim_strnsave(key, len);
2688 if (len == -1)
2689 clear_tv(&var1);
2690 if (lp->ll_newkey == NULL)
2691 p = NULL;
2692 break;
2694 if (len == -1)
2695 clear_tv(&var1);
2696 lp->ll_tv = &lp->ll_di->di_tv;
2698 else
2701 * Get the number and item for the only or first index of the List.
2703 if (empty1)
2704 lp->ll_n1 = 0;
2705 else
2707 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2708 clear_tv(&var1);
2710 lp->ll_dict = NULL;
2711 lp->ll_list = lp->ll_tv->vval.v_list;
2712 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2713 if (lp->ll_li == NULL)
2715 if (lp->ll_n1 < 0)
2717 lp->ll_n1 = 0;
2718 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2721 if (lp->ll_li == NULL)
2723 if (lp->ll_range && !lp->ll_empty2)
2724 clear_tv(&var2);
2725 return NULL;
2729 * May need to find the item or absolute index for the second
2730 * index of a range.
2731 * When no index given: "lp->ll_empty2" is TRUE.
2732 * Otherwise "lp->ll_n2" is set to the second index.
2734 if (lp->ll_range && !lp->ll_empty2)
2736 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2737 clear_tv(&var2);
2738 if (lp->ll_n2 < 0)
2740 ni = list_find(lp->ll_list, lp->ll_n2);
2741 if (ni == NULL)
2742 return NULL;
2743 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2746 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2747 if (lp->ll_n1 < 0)
2748 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2749 if (lp->ll_n2 < lp->ll_n1)
2750 return NULL;
2753 lp->ll_tv = &lp->ll_li->li_tv;
2757 return p;
2761 * Clear lval "lp" that was filled by get_lval().
2763 static void
2764 clear_lval(lp)
2765 lval_T *lp;
2767 vim_free(lp->ll_exp_name);
2768 vim_free(lp->ll_newkey);
2772 * Set a variable that was parsed by get_lval() to "rettv".
2773 * "endp" points to just after the parsed name.
2774 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2776 static void
2777 set_var_lval(lp, endp, rettv, copy, op)
2778 lval_T *lp;
2779 char_u *endp;
2780 typval_T *rettv;
2781 int copy;
2782 char_u *op;
2784 int cc;
2785 listitem_T *ri;
2786 dictitem_T *di;
2788 if (lp->ll_tv == NULL)
2790 if (!check_changedtick(lp->ll_name))
2792 cc = *endp;
2793 *endp = NUL;
2794 if (op != NULL && *op != '=')
2796 typval_T tv;
2798 /* handle +=, -= and .= */
2799 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2800 &tv, TRUE) == OK)
2802 if (tv_op(&tv, rettv, op) == OK)
2803 set_var(lp->ll_name, &tv, FALSE);
2804 clear_tv(&tv);
2807 else
2808 set_var(lp->ll_name, rettv, copy);
2809 *endp = cc;
2812 else if (tv_check_lock(lp->ll_newkey == NULL
2813 ? lp->ll_tv->v_lock
2814 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2816 else if (lp->ll_range)
2819 * Assign the List values to the list items.
2821 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2823 if (op != NULL && *op != '=')
2824 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2825 else
2827 clear_tv(&lp->ll_li->li_tv);
2828 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2830 ri = ri->li_next;
2831 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2832 break;
2833 if (lp->ll_li->li_next == NULL)
2835 /* Need to add an empty item. */
2836 if (list_append_number(lp->ll_list, 0) == FAIL)
2838 ri = NULL;
2839 break;
2842 lp->ll_li = lp->ll_li->li_next;
2843 ++lp->ll_n1;
2845 if (ri != NULL)
2846 EMSG(_("E710: List value has more items than target"));
2847 else if (lp->ll_empty2
2848 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2849 : lp->ll_n1 != lp->ll_n2)
2850 EMSG(_("E711: List value has not enough items"));
2852 else
2855 * Assign to a List or Dictionary item.
2857 if (lp->ll_newkey != NULL)
2859 if (op != NULL && *op != '=')
2861 EMSG2(_(e_letwrong), op);
2862 return;
2865 /* Need to add an item to the Dictionary. */
2866 di = dictitem_alloc(lp->ll_newkey);
2867 if (di == NULL)
2868 return;
2869 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2871 vim_free(di);
2872 return;
2874 lp->ll_tv = &di->di_tv;
2876 else if (op != NULL && *op != '=')
2878 tv_op(lp->ll_tv, rettv, op);
2879 return;
2881 else
2882 clear_tv(lp->ll_tv);
2885 * Assign the value to the variable or list item.
2887 if (copy)
2888 copy_tv(rettv, lp->ll_tv);
2889 else
2891 *lp->ll_tv = *rettv;
2892 lp->ll_tv->v_lock = 0;
2893 init_tv(rettv);
2899 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2900 * Returns OK or FAIL.
2902 static int
2903 tv_op(tv1, tv2, op)
2904 typval_T *tv1;
2905 typval_T *tv2;
2906 char_u *op;
2908 long n;
2909 char_u numbuf[NUMBUFLEN];
2910 char_u *s;
2912 /* Can't do anything with a Funcref or a Dict on the right. */
2913 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2915 switch (tv1->v_type)
2917 case VAR_DICT:
2918 case VAR_FUNC:
2919 break;
2921 case VAR_LIST:
2922 if (*op != '+' || tv2->v_type != VAR_LIST)
2923 break;
2924 /* List += List */
2925 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2926 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2927 return OK;
2929 case VAR_NUMBER:
2930 case VAR_STRING:
2931 if (tv2->v_type == VAR_LIST)
2932 break;
2933 if (*op == '+' || *op == '-')
2935 /* nr += nr or nr -= nr*/
2936 n = get_tv_number(tv1);
2937 #ifdef FEAT_FLOAT
2938 if (tv2->v_type == VAR_FLOAT)
2940 float_T f = n;
2942 if (*op == '+')
2943 f += tv2->vval.v_float;
2944 else
2945 f -= tv2->vval.v_float;
2946 clear_tv(tv1);
2947 tv1->v_type = VAR_FLOAT;
2948 tv1->vval.v_float = f;
2950 else
2951 #endif
2953 if (*op == '+')
2954 n += get_tv_number(tv2);
2955 else
2956 n -= get_tv_number(tv2);
2957 clear_tv(tv1);
2958 tv1->v_type = VAR_NUMBER;
2959 tv1->vval.v_number = n;
2962 else
2964 if (tv2->v_type == VAR_FLOAT)
2965 break;
2967 /* str .= str */
2968 s = get_tv_string(tv1);
2969 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2970 clear_tv(tv1);
2971 tv1->v_type = VAR_STRING;
2972 tv1->vval.v_string = s;
2974 return OK;
2976 #ifdef FEAT_FLOAT
2977 case VAR_FLOAT:
2979 float_T f;
2981 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2982 && tv2->v_type != VAR_NUMBER
2983 && tv2->v_type != VAR_STRING))
2984 break;
2985 if (tv2->v_type == VAR_FLOAT)
2986 f = tv2->vval.v_float;
2987 else
2988 f = get_tv_number(tv2);
2989 if (*op == '+')
2990 tv1->vval.v_float += f;
2991 else
2992 tv1->vval.v_float -= f;
2994 return OK;
2995 #endif
2999 EMSG2(_(e_letwrong), op);
3000 return FAIL;
3004 * Add a watcher to a list.
3006 static void
3007 list_add_watch(l, lw)
3008 list_T *l;
3009 listwatch_T *lw;
3011 lw->lw_next = l->lv_watch;
3012 l->lv_watch = lw;
3016 * Remove a watcher from a list.
3017 * No warning when it isn't found...
3019 static void
3020 list_rem_watch(l, lwrem)
3021 list_T *l;
3022 listwatch_T *lwrem;
3024 listwatch_T *lw, **lwp;
3026 lwp = &l->lv_watch;
3027 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3029 if (lw == lwrem)
3031 *lwp = lw->lw_next;
3032 break;
3034 lwp = &lw->lw_next;
3039 * Just before removing an item from a list: advance watchers to the next
3040 * item.
3042 static void
3043 list_fix_watch(l, item)
3044 list_T *l;
3045 listitem_T *item;
3047 listwatch_T *lw;
3049 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3050 if (lw->lw_item == item)
3051 lw->lw_item = item->li_next;
3055 * Evaluate the expression used in a ":for var in expr" command.
3056 * "arg" points to "var".
3057 * Set "*errp" to TRUE for an error, FALSE otherwise;
3058 * Return a pointer that holds the info. Null when there is an error.
3060 void *
3061 eval_for_line(arg, errp, nextcmdp, skip)
3062 char_u *arg;
3063 int *errp;
3064 char_u **nextcmdp;
3065 int skip;
3067 forinfo_T *fi;
3068 char_u *expr;
3069 typval_T tv;
3070 list_T *l;
3072 *errp = TRUE; /* default: there is an error */
3074 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3075 if (fi == NULL)
3076 return NULL;
3078 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3079 if (expr == NULL)
3080 return fi;
3082 expr = skipwhite(expr);
3083 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3085 EMSG(_("E690: Missing \"in\" after :for"));
3086 return fi;
3089 if (skip)
3090 ++emsg_skip;
3091 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3093 *errp = FALSE;
3094 if (!skip)
3096 l = tv.vval.v_list;
3097 if (tv.v_type != VAR_LIST || l == NULL)
3099 EMSG(_(e_listreq));
3100 clear_tv(&tv);
3102 else
3104 /* No need to increment the refcount, it's already set for the
3105 * list being used in "tv". */
3106 fi->fi_list = l;
3107 list_add_watch(l, &fi->fi_lw);
3108 fi->fi_lw.lw_item = l->lv_first;
3112 if (skip)
3113 --emsg_skip;
3115 return fi;
3119 * Use the first item in a ":for" list. Advance to the next.
3120 * Assign the values to the variable (list). "arg" points to the first one.
3121 * Return TRUE when a valid item was found, FALSE when at end of list or
3122 * something wrong.
3125 next_for_item(fi_void, arg)
3126 void *fi_void;
3127 char_u *arg;
3129 forinfo_T *fi = (forinfo_T *)fi_void;
3130 int result;
3131 listitem_T *item;
3133 item = fi->fi_lw.lw_item;
3134 if (item == NULL)
3135 result = FALSE;
3136 else
3138 fi->fi_lw.lw_item = item->li_next;
3139 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3140 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3142 return result;
3146 * Free the structure used to store info used by ":for".
3148 void
3149 free_for_info(fi_void)
3150 void *fi_void;
3152 forinfo_T *fi = (forinfo_T *)fi_void;
3154 if (fi != NULL && fi->fi_list != NULL)
3156 list_rem_watch(fi->fi_list, &fi->fi_lw);
3157 list_unref(fi->fi_list);
3159 vim_free(fi);
3162 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3164 void
3165 set_context_for_expression(xp, arg, cmdidx)
3166 expand_T *xp;
3167 char_u *arg;
3168 cmdidx_T cmdidx;
3170 int got_eq = FALSE;
3171 int c;
3172 char_u *p;
3174 if (cmdidx == CMD_let)
3176 xp->xp_context = EXPAND_USER_VARS;
3177 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3179 /* ":let var1 var2 ...": find last space. */
3180 for (p = arg + STRLEN(arg); p >= arg; )
3182 xp->xp_pattern = p;
3183 mb_ptr_back(arg, p);
3184 if (vim_iswhite(*p))
3185 break;
3187 return;
3190 else
3191 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3192 : EXPAND_EXPRESSION;
3193 while ((xp->xp_pattern = vim_strpbrk(arg,
3194 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3196 c = *xp->xp_pattern;
3197 if (c == '&')
3199 c = xp->xp_pattern[1];
3200 if (c == '&')
3202 ++xp->xp_pattern;
3203 xp->xp_context = cmdidx != CMD_let || got_eq
3204 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3206 else if (c != ' ')
3208 xp->xp_context = EXPAND_SETTINGS;
3209 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3210 xp->xp_pattern += 2;
3214 else if (c == '$')
3216 /* environment variable */
3217 xp->xp_context = EXPAND_ENV_VARS;
3219 else if (c == '=')
3221 got_eq = TRUE;
3222 xp->xp_context = EXPAND_EXPRESSION;
3224 else if (c == '<'
3225 && xp->xp_context == EXPAND_FUNCTIONS
3226 && vim_strchr(xp->xp_pattern, '(') == NULL)
3228 /* Function name can start with "<SNR>" */
3229 break;
3231 else if (cmdidx != CMD_let || got_eq)
3233 if (c == '"') /* string */
3235 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3236 if (c == '\\' && xp->xp_pattern[1] != NUL)
3237 ++xp->xp_pattern;
3238 xp->xp_context = EXPAND_NOTHING;
3240 else if (c == '\'') /* literal string */
3242 /* Trick: '' is like stopping and starting a literal string. */
3243 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3244 /* skip */ ;
3245 xp->xp_context = EXPAND_NOTHING;
3247 else if (c == '|')
3249 if (xp->xp_pattern[1] == '|')
3251 ++xp->xp_pattern;
3252 xp->xp_context = EXPAND_EXPRESSION;
3254 else
3255 xp->xp_context = EXPAND_COMMANDS;
3257 else
3258 xp->xp_context = EXPAND_EXPRESSION;
3260 else
3261 /* Doesn't look like something valid, expand as an expression
3262 * anyway. */
3263 xp->xp_context = EXPAND_EXPRESSION;
3264 arg = xp->xp_pattern;
3265 if (*arg != NUL)
3266 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3267 /* skip */ ;
3269 xp->xp_pattern = arg;
3272 #endif /* FEAT_CMDL_COMPL */
3275 * ":1,25call func(arg1, arg2)" function call.
3277 void
3278 ex_call(eap)
3279 exarg_T *eap;
3281 char_u *arg = eap->arg;
3282 char_u *startarg;
3283 char_u *name;
3284 char_u *tofree;
3285 int len;
3286 typval_T rettv;
3287 linenr_T lnum;
3288 int doesrange;
3289 int failed = FALSE;
3290 funcdict_T fudi;
3292 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3293 if (fudi.fd_newkey != NULL)
3295 /* Still need to give an error message for missing key. */
3296 EMSG2(_(e_dictkey), fudi.fd_newkey);
3297 vim_free(fudi.fd_newkey);
3299 if (tofree == NULL)
3300 return;
3302 /* Increase refcount on dictionary, it could get deleted when evaluating
3303 * the arguments. */
3304 if (fudi.fd_dict != NULL)
3305 ++fudi.fd_dict->dv_refcount;
3307 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3308 len = (int)STRLEN(tofree);
3309 name = deref_func_name(tofree, &len);
3311 /* Skip white space to allow ":call func ()". Not good, but required for
3312 * backward compatibility. */
3313 startarg = skipwhite(arg);
3314 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3316 if (*startarg != '(')
3318 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3319 goto end;
3323 * When skipping, evaluate the function once, to find the end of the
3324 * arguments.
3325 * When the function takes a range, this is discovered after the first
3326 * call, and the loop is broken.
3328 if (eap->skip)
3330 ++emsg_skip;
3331 lnum = eap->line2; /* do it once, also with an invalid range */
3333 else
3334 lnum = eap->line1;
3335 for ( ; lnum <= eap->line2; ++lnum)
3337 if (!eap->skip && eap->addr_count > 0)
3339 curwin->w_cursor.lnum = lnum;
3340 curwin->w_cursor.col = 0;
3342 arg = startarg;
3343 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3344 eap->line1, eap->line2, &doesrange,
3345 !eap->skip, fudi.fd_dict) == FAIL)
3347 failed = TRUE;
3348 break;
3351 /* Handle a function returning a Funcref, Dictionary or List. */
3352 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3354 failed = TRUE;
3355 break;
3358 clear_tv(&rettv);
3359 if (doesrange || eap->skip)
3360 break;
3362 /* Stop when immediately aborting on error, or when an interrupt
3363 * occurred or an exception was thrown but not caught.
3364 * get_func_tv() returned OK, so that the check for trailing
3365 * characters below is executed. */
3366 if (aborting())
3367 break;
3369 if (eap->skip)
3370 --emsg_skip;
3372 if (!failed)
3374 /* Check for trailing illegal characters and a following command. */
3375 if (!ends_excmd(*arg))
3377 emsg_severe = TRUE;
3378 EMSG(_(e_trailing));
3380 else
3381 eap->nextcmd = check_nextcmd(arg);
3384 end:
3385 dict_unref(fudi.fd_dict);
3386 vim_free(tofree);
3390 * ":unlet[!] var1 ... " command.
3392 void
3393 ex_unlet(eap)
3394 exarg_T *eap;
3396 ex_unletlock(eap, eap->arg, 0);
3400 * ":lockvar" and ":unlockvar" commands
3402 void
3403 ex_lockvar(eap)
3404 exarg_T *eap;
3406 char_u *arg = eap->arg;
3407 int deep = 2;
3409 if (eap->forceit)
3410 deep = -1;
3411 else if (vim_isdigit(*arg))
3413 deep = getdigits(&arg);
3414 arg = skipwhite(arg);
3417 ex_unletlock(eap, arg, deep);
3421 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3423 static void
3424 ex_unletlock(eap, argstart, deep)
3425 exarg_T *eap;
3426 char_u *argstart;
3427 int deep;
3429 char_u *arg = argstart;
3430 char_u *name_end;
3431 int error = FALSE;
3432 lval_T lv;
3436 /* Parse the name and find the end. */
3437 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3438 FNE_CHECK_START);
3439 if (lv.ll_name == NULL)
3440 error = TRUE; /* error but continue parsing */
3441 if (name_end == NULL || (!vim_iswhite(*name_end)
3442 && !ends_excmd(*name_end)))
3444 if (name_end != NULL)
3446 emsg_severe = TRUE;
3447 EMSG(_(e_trailing));
3449 if (!(eap->skip || error))
3450 clear_lval(&lv);
3451 break;
3454 if (!error && !eap->skip)
3456 if (eap->cmdidx == CMD_unlet)
3458 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3459 error = TRUE;
3461 else
3463 if (do_lock_var(&lv, name_end, deep,
3464 eap->cmdidx == CMD_lockvar) == FAIL)
3465 error = TRUE;
3469 if (!eap->skip)
3470 clear_lval(&lv);
3472 arg = skipwhite(name_end);
3473 } while (!ends_excmd(*arg));
3475 eap->nextcmd = check_nextcmd(arg);
3478 static int
3479 do_unlet_var(lp, name_end, forceit)
3480 lval_T *lp;
3481 char_u *name_end;
3482 int forceit;
3484 int ret = OK;
3485 int cc;
3487 if (lp->ll_tv == NULL)
3489 cc = *name_end;
3490 *name_end = NUL;
3492 /* Normal name or expanded name. */
3493 if (check_changedtick(lp->ll_name))
3494 ret = FAIL;
3495 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3496 ret = FAIL;
3497 *name_end = cc;
3499 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3500 return FAIL;
3501 else if (lp->ll_range)
3503 listitem_T *li;
3505 /* Delete a range of List items. */
3506 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3508 li = lp->ll_li->li_next;
3509 listitem_remove(lp->ll_list, lp->ll_li);
3510 lp->ll_li = li;
3511 ++lp->ll_n1;
3514 else
3516 if (lp->ll_list != NULL)
3517 /* unlet a List item. */
3518 listitem_remove(lp->ll_list, lp->ll_li);
3519 else
3520 /* unlet a Dictionary item. */
3521 dictitem_remove(lp->ll_dict, lp->ll_di);
3524 return ret;
3528 * "unlet" a variable. Return OK if it existed, FAIL if not.
3529 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3532 do_unlet(name, forceit)
3533 char_u *name;
3534 int forceit;
3536 hashtab_T *ht;
3537 hashitem_T *hi;
3538 char_u *varname;
3539 dictitem_T *di;
3541 ht = find_var_ht(name, &varname);
3542 if (ht != NULL && *varname != NUL)
3544 hi = hash_find(ht, varname);
3545 if (!HASHITEM_EMPTY(hi))
3547 di = HI2DI(hi);
3548 if (var_check_fixed(di->di_flags, name)
3549 || var_check_ro(di->di_flags, name))
3550 return FAIL;
3551 delete_var(ht, hi);
3552 return OK;
3555 if (forceit)
3556 return OK;
3557 EMSG2(_("E108: No such variable: \"%s\""), name);
3558 return FAIL;
3562 * Lock or unlock variable indicated by "lp".
3563 * "deep" is the levels to go (-1 for unlimited);
3564 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3566 static int
3567 do_lock_var(lp, name_end, deep, lock)
3568 lval_T *lp;
3569 char_u *name_end;
3570 int deep;
3571 int lock;
3573 int ret = OK;
3574 int cc;
3575 dictitem_T *di;
3577 if (deep == 0) /* nothing to do */
3578 return OK;
3580 if (lp->ll_tv == NULL)
3582 cc = *name_end;
3583 *name_end = NUL;
3585 /* Normal name or expanded name. */
3586 if (check_changedtick(lp->ll_name))
3587 ret = FAIL;
3588 else
3590 di = find_var(lp->ll_name, NULL);
3591 if (di == NULL)
3592 ret = FAIL;
3593 else
3595 if (lock)
3596 di->di_flags |= DI_FLAGS_LOCK;
3597 else
3598 di->di_flags &= ~DI_FLAGS_LOCK;
3599 item_lock(&di->di_tv, deep, lock);
3602 *name_end = cc;
3604 else if (lp->ll_range)
3606 listitem_T *li = lp->ll_li;
3608 /* (un)lock a range of List items. */
3609 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3611 item_lock(&li->li_tv, deep, lock);
3612 li = li->li_next;
3613 ++lp->ll_n1;
3616 else if (lp->ll_list != NULL)
3617 /* (un)lock a List item. */
3618 item_lock(&lp->ll_li->li_tv, deep, lock);
3619 else
3620 /* un(lock) a Dictionary item. */
3621 item_lock(&lp->ll_di->di_tv, deep, lock);
3623 return ret;
3627 * Lock or unlock an item. "deep" is nr of levels to go.
3629 static void
3630 item_lock(tv, deep, lock)
3631 typval_T *tv;
3632 int deep;
3633 int lock;
3635 static int recurse = 0;
3636 list_T *l;
3637 listitem_T *li;
3638 dict_T *d;
3639 hashitem_T *hi;
3640 int todo;
3642 if (recurse >= DICT_MAXNEST)
3644 EMSG(_("E743: variable nested too deep for (un)lock"));
3645 return;
3647 if (deep == 0)
3648 return;
3649 ++recurse;
3651 /* lock/unlock the item itself */
3652 if (lock)
3653 tv->v_lock |= VAR_LOCKED;
3654 else
3655 tv->v_lock &= ~VAR_LOCKED;
3657 switch (tv->v_type)
3659 case VAR_LIST:
3660 if ((l = tv->vval.v_list) != NULL)
3662 if (lock)
3663 l->lv_lock |= VAR_LOCKED;
3664 else
3665 l->lv_lock &= ~VAR_LOCKED;
3666 if (deep < 0 || deep > 1)
3667 /* recursive: lock/unlock the items the List contains */
3668 for (li = l->lv_first; li != NULL; li = li->li_next)
3669 item_lock(&li->li_tv, deep - 1, lock);
3671 break;
3672 case VAR_DICT:
3673 if ((d = tv->vval.v_dict) != NULL)
3675 if (lock)
3676 d->dv_lock |= VAR_LOCKED;
3677 else
3678 d->dv_lock &= ~VAR_LOCKED;
3679 if (deep < 0 || deep > 1)
3681 /* recursive: lock/unlock the items the List contains */
3682 todo = (int)d->dv_hashtab.ht_used;
3683 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3685 if (!HASHITEM_EMPTY(hi))
3687 --todo;
3688 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3694 --recurse;
3698 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3699 * or it refers to a List or Dictionary that is locked.
3701 static int
3702 tv_islocked(tv)
3703 typval_T *tv;
3705 return (tv->v_lock & VAR_LOCKED)
3706 || (tv->v_type == VAR_LIST
3707 && tv->vval.v_list != NULL
3708 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3709 || (tv->v_type == VAR_DICT
3710 && tv->vval.v_dict != NULL
3711 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3714 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3716 * Delete all "menutrans_" variables.
3718 void
3719 del_menutrans_vars()
3721 hashitem_T *hi;
3722 int todo;
3724 hash_lock(&globvarht);
3725 todo = (int)globvarht.ht_used;
3726 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3728 if (!HASHITEM_EMPTY(hi))
3730 --todo;
3731 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3732 delete_var(&globvarht, hi);
3735 hash_unlock(&globvarht);
3737 #endif
3739 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3742 * Local string buffer for the next two functions to store a variable name
3743 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3744 * get_user_var_name().
3747 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3749 static char_u *varnamebuf = NULL;
3750 static int varnamebuflen = 0;
3753 * Function to concatenate a prefix and a variable name.
3755 static char_u *
3756 cat_prefix_varname(prefix, name)
3757 int prefix;
3758 char_u *name;
3760 int len;
3762 len = (int)STRLEN(name) + 3;
3763 if (len > varnamebuflen)
3765 vim_free(varnamebuf);
3766 len += 10; /* some additional space */
3767 varnamebuf = alloc(len);
3768 if (varnamebuf == NULL)
3770 varnamebuflen = 0;
3771 return NULL;
3773 varnamebuflen = len;
3775 *varnamebuf = prefix;
3776 varnamebuf[1] = ':';
3777 STRCPY(varnamebuf + 2, name);
3778 return varnamebuf;
3782 * Function given to ExpandGeneric() to obtain the list of user defined
3783 * (global/buffer/window/built-in) variable names.
3785 char_u *
3786 get_user_var_name(xp, idx)
3787 expand_T *xp;
3788 int idx;
3790 static long_u gdone;
3791 static long_u bdone;
3792 static long_u wdone;
3793 #ifdef FEAT_WINDOWS
3794 static long_u tdone;
3795 #endif
3796 static int vidx;
3797 static hashitem_T *hi;
3798 hashtab_T *ht;
3800 if (idx == 0)
3802 gdone = bdone = wdone = vidx = 0;
3803 #ifdef FEAT_WINDOWS
3804 tdone = 0;
3805 #endif
3808 /* Global variables */
3809 if (gdone < globvarht.ht_used)
3811 if (gdone++ == 0)
3812 hi = globvarht.ht_array;
3813 else
3814 ++hi;
3815 while (HASHITEM_EMPTY(hi))
3816 ++hi;
3817 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3818 return cat_prefix_varname('g', hi->hi_key);
3819 return hi->hi_key;
3822 /* b: variables */
3823 ht = &curbuf->b_vars.dv_hashtab;
3824 if (bdone < ht->ht_used)
3826 if (bdone++ == 0)
3827 hi = ht->ht_array;
3828 else
3829 ++hi;
3830 while (HASHITEM_EMPTY(hi))
3831 ++hi;
3832 return cat_prefix_varname('b', hi->hi_key);
3834 if (bdone == ht->ht_used)
3836 ++bdone;
3837 return (char_u *)"b:changedtick";
3840 /* w: variables */
3841 ht = &curwin->w_vars.dv_hashtab;
3842 if (wdone < ht->ht_used)
3844 if (wdone++ == 0)
3845 hi = ht->ht_array;
3846 else
3847 ++hi;
3848 while (HASHITEM_EMPTY(hi))
3849 ++hi;
3850 return cat_prefix_varname('w', hi->hi_key);
3853 #ifdef FEAT_WINDOWS
3854 /* t: variables */
3855 ht = &curtab->tp_vars.dv_hashtab;
3856 if (tdone < ht->ht_used)
3858 if (tdone++ == 0)
3859 hi = ht->ht_array;
3860 else
3861 ++hi;
3862 while (HASHITEM_EMPTY(hi))
3863 ++hi;
3864 return cat_prefix_varname('t', hi->hi_key);
3866 #endif
3868 /* v: variables */
3869 if (vidx < VV_LEN)
3870 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3872 vim_free(varnamebuf);
3873 varnamebuf = NULL;
3874 varnamebuflen = 0;
3875 return NULL;
3878 #endif /* FEAT_CMDL_COMPL */
3881 * types for expressions.
3883 typedef enum
3885 TYPE_UNKNOWN = 0
3886 , TYPE_EQUAL /* == */
3887 , TYPE_NEQUAL /* != */
3888 , TYPE_GREATER /* > */
3889 , TYPE_GEQUAL /* >= */
3890 , TYPE_SMALLER /* < */
3891 , TYPE_SEQUAL /* <= */
3892 , TYPE_MATCH /* =~ */
3893 , TYPE_NOMATCH /* !~ */
3894 } exptype_T;
3897 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3898 * executed. The function may return OK, but the rettv will be of type
3899 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3903 * Handle zero level expression.
3904 * This calls eval1() and handles error message and nextcmd.
3905 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3906 * Note: "rettv.v_lock" is not set.
3907 * Return OK or FAIL.
3909 static int
3910 eval0(arg, rettv, nextcmd, evaluate)
3911 char_u *arg;
3912 typval_T *rettv;
3913 char_u **nextcmd;
3914 int evaluate;
3916 int ret;
3917 char_u *p;
3919 p = skipwhite(arg);
3920 ret = eval1(&p, rettv, evaluate);
3921 if (ret == FAIL || !ends_excmd(*p))
3923 if (ret != FAIL)
3924 clear_tv(rettv);
3926 * Report the invalid expression unless the expression evaluation has
3927 * been cancelled due to an aborting error, an interrupt, or an
3928 * exception.
3930 if (!aborting())
3931 EMSG2(_(e_invexpr2), arg);
3932 ret = FAIL;
3934 if (nextcmd != NULL)
3935 *nextcmd = check_nextcmd(p);
3937 return ret;
3941 * Handle top level expression:
3942 * expr2 ? expr1 : expr1
3944 * "arg" must point to the first non-white of the expression.
3945 * "arg" is advanced to the next non-white after the recognized expression.
3947 * Note: "rettv.v_lock" is not set.
3949 * Return OK or FAIL.
3951 static int
3952 eval1(arg, rettv, evaluate)
3953 char_u **arg;
3954 typval_T *rettv;
3955 int evaluate;
3957 int result;
3958 typval_T var2;
3961 * Get the first variable.
3963 if (eval2(arg, rettv, evaluate) == FAIL)
3964 return FAIL;
3966 if ((*arg)[0] == '?')
3968 result = FALSE;
3969 if (evaluate)
3971 int error = FALSE;
3973 if (get_tv_number_chk(rettv, &error) != 0)
3974 result = TRUE;
3975 clear_tv(rettv);
3976 if (error)
3977 return FAIL;
3981 * Get the second variable.
3983 *arg = skipwhite(*arg + 1);
3984 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3985 return FAIL;
3988 * Check for the ":".
3990 if ((*arg)[0] != ':')
3992 EMSG(_("E109: Missing ':' after '?'"));
3993 if (evaluate && result)
3994 clear_tv(rettv);
3995 return FAIL;
3999 * Get the third variable.
4001 *arg = skipwhite(*arg + 1);
4002 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
4004 if (evaluate && result)
4005 clear_tv(rettv);
4006 return FAIL;
4008 if (evaluate && !result)
4009 *rettv = var2;
4012 return OK;
4016 * Handle first level expression:
4017 * expr2 || expr2 || expr2 logical OR
4019 * "arg" must point to the first non-white of the expression.
4020 * "arg" is advanced to the next non-white after the recognized expression.
4022 * Return OK or FAIL.
4024 static int
4025 eval2(arg, rettv, evaluate)
4026 char_u **arg;
4027 typval_T *rettv;
4028 int evaluate;
4030 typval_T var2;
4031 long result;
4032 int first;
4033 int error = FALSE;
4036 * Get the first variable.
4038 if (eval3(arg, rettv, evaluate) == FAIL)
4039 return FAIL;
4042 * Repeat until there is no following "||".
4044 first = TRUE;
4045 result = FALSE;
4046 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4048 if (evaluate && first)
4050 if (get_tv_number_chk(rettv, &error) != 0)
4051 result = TRUE;
4052 clear_tv(rettv);
4053 if (error)
4054 return FAIL;
4055 first = FALSE;
4059 * Get the second variable.
4061 *arg = skipwhite(*arg + 2);
4062 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4063 return FAIL;
4066 * Compute the result.
4068 if (evaluate && !result)
4070 if (get_tv_number_chk(&var2, &error) != 0)
4071 result = TRUE;
4072 clear_tv(&var2);
4073 if (error)
4074 return FAIL;
4076 if (evaluate)
4078 rettv->v_type = VAR_NUMBER;
4079 rettv->vval.v_number = result;
4083 return OK;
4087 * Handle second level expression:
4088 * expr3 && expr3 && expr3 logical AND
4090 * "arg" must point to the first non-white of the expression.
4091 * "arg" is advanced to the next non-white after the recognized expression.
4093 * Return OK or FAIL.
4095 static int
4096 eval3(arg, rettv, evaluate)
4097 char_u **arg;
4098 typval_T *rettv;
4099 int evaluate;
4101 typval_T var2;
4102 long result;
4103 int first;
4104 int error = FALSE;
4107 * Get the first variable.
4109 if (eval4(arg, rettv, evaluate) == FAIL)
4110 return FAIL;
4113 * Repeat until there is no following "&&".
4115 first = TRUE;
4116 result = TRUE;
4117 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4119 if (evaluate && first)
4121 if (get_tv_number_chk(rettv, &error) == 0)
4122 result = FALSE;
4123 clear_tv(rettv);
4124 if (error)
4125 return FAIL;
4126 first = FALSE;
4130 * Get the second variable.
4132 *arg = skipwhite(*arg + 2);
4133 if (eval4(arg, &var2, evaluate && result) == FAIL)
4134 return FAIL;
4137 * Compute the result.
4139 if (evaluate && result)
4141 if (get_tv_number_chk(&var2, &error) == 0)
4142 result = FALSE;
4143 clear_tv(&var2);
4144 if (error)
4145 return FAIL;
4147 if (evaluate)
4149 rettv->v_type = VAR_NUMBER;
4150 rettv->vval.v_number = result;
4154 return OK;
4158 * Handle third level expression:
4159 * var1 == var2
4160 * var1 =~ var2
4161 * var1 != var2
4162 * var1 !~ var2
4163 * var1 > var2
4164 * var1 >= var2
4165 * var1 < var2
4166 * var1 <= var2
4167 * var1 is var2
4168 * var1 isnot var2
4170 * "arg" must point to the first non-white of the expression.
4171 * "arg" is advanced to the next non-white after the recognized expression.
4173 * Return OK or FAIL.
4175 static int
4176 eval4(arg, rettv, evaluate)
4177 char_u **arg;
4178 typval_T *rettv;
4179 int evaluate;
4181 typval_T var2;
4182 char_u *p;
4183 int i;
4184 exptype_T type = TYPE_UNKNOWN;
4185 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4186 int len = 2;
4187 long n1, n2;
4188 char_u *s1, *s2;
4189 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4190 regmatch_T regmatch;
4191 int ic;
4192 char_u *save_cpo;
4195 * Get the first variable.
4197 if (eval5(arg, rettv, evaluate) == FAIL)
4198 return FAIL;
4200 p = *arg;
4201 switch (p[0])
4203 case '=': if (p[1] == '=')
4204 type = TYPE_EQUAL;
4205 else if (p[1] == '~')
4206 type = TYPE_MATCH;
4207 break;
4208 case '!': if (p[1] == '=')
4209 type = TYPE_NEQUAL;
4210 else if (p[1] == '~')
4211 type = TYPE_NOMATCH;
4212 break;
4213 case '>': if (p[1] != '=')
4215 type = TYPE_GREATER;
4216 len = 1;
4218 else
4219 type = TYPE_GEQUAL;
4220 break;
4221 case '<': if (p[1] != '=')
4223 type = TYPE_SMALLER;
4224 len = 1;
4226 else
4227 type = TYPE_SEQUAL;
4228 break;
4229 case 'i': if (p[1] == 's')
4231 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4232 len = 5;
4233 if (!vim_isIDc(p[len]))
4235 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4236 type_is = TRUE;
4239 break;
4243 * If there is a comparative operator, use it.
4245 if (type != TYPE_UNKNOWN)
4247 /* extra question mark appended: ignore case */
4248 if (p[len] == '?')
4250 ic = TRUE;
4251 ++len;
4253 /* extra '#' appended: match case */
4254 else if (p[len] == '#')
4256 ic = FALSE;
4257 ++len;
4259 /* nothing appended: use 'ignorecase' */
4260 else
4261 ic = p_ic;
4264 * Get the second variable.
4266 *arg = skipwhite(p + len);
4267 if (eval5(arg, &var2, evaluate) == FAIL)
4269 clear_tv(rettv);
4270 return FAIL;
4273 if (evaluate)
4275 if (type_is && rettv->v_type != var2.v_type)
4277 /* For "is" a different type always means FALSE, for "notis"
4278 * it means TRUE. */
4279 n1 = (type == TYPE_NEQUAL);
4281 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4283 if (type_is)
4285 n1 = (rettv->v_type == var2.v_type
4286 && rettv->vval.v_list == var2.vval.v_list);
4287 if (type == TYPE_NEQUAL)
4288 n1 = !n1;
4290 else if (rettv->v_type != var2.v_type
4291 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4293 if (rettv->v_type != var2.v_type)
4294 EMSG(_("E691: Can only compare List with List"));
4295 else
4296 EMSG(_("E692: Invalid operation for Lists"));
4297 clear_tv(rettv);
4298 clear_tv(&var2);
4299 return FAIL;
4301 else
4303 /* Compare two Lists for being equal or unequal. */
4304 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4305 if (type == TYPE_NEQUAL)
4306 n1 = !n1;
4310 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4312 if (type_is)
4314 n1 = (rettv->v_type == var2.v_type
4315 && rettv->vval.v_dict == var2.vval.v_dict);
4316 if (type == TYPE_NEQUAL)
4317 n1 = !n1;
4319 else if (rettv->v_type != var2.v_type
4320 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4322 if (rettv->v_type != var2.v_type)
4323 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4324 else
4325 EMSG(_("E736: Invalid operation for Dictionary"));
4326 clear_tv(rettv);
4327 clear_tv(&var2);
4328 return FAIL;
4330 else
4332 /* Compare two Dictionaries for being equal or unequal. */
4333 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4334 if (type == TYPE_NEQUAL)
4335 n1 = !n1;
4339 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4341 if (rettv->v_type != var2.v_type
4342 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4344 if (rettv->v_type != var2.v_type)
4345 EMSG(_("E693: Can only compare Funcref with Funcref"));
4346 else
4347 EMSG(_("E694: Invalid operation for Funcrefs"));
4348 clear_tv(rettv);
4349 clear_tv(&var2);
4350 return FAIL;
4352 else
4354 /* Compare two Funcrefs for being equal or unequal. */
4355 if (rettv->vval.v_string == NULL
4356 || var2.vval.v_string == NULL)
4357 n1 = FALSE;
4358 else
4359 n1 = STRCMP(rettv->vval.v_string,
4360 var2.vval.v_string) == 0;
4361 if (type == TYPE_NEQUAL)
4362 n1 = !n1;
4366 #ifdef FEAT_FLOAT
4368 * If one of the two variables is a float, compare as a float.
4369 * When using "=~" or "!~", always compare as string.
4371 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4372 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4374 float_T f1, f2;
4376 if (rettv->v_type == VAR_FLOAT)
4377 f1 = rettv->vval.v_float;
4378 else
4379 f1 = get_tv_number(rettv);
4380 if (var2.v_type == VAR_FLOAT)
4381 f2 = var2.vval.v_float;
4382 else
4383 f2 = get_tv_number(&var2);
4384 n1 = FALSE;
4385 switch (type)
4387 case TYPE_EQUAL: n1 = (f1 == f2); break;
4388 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4389 case TYPE_GREATER: n1 = (f1 > f2); break;
4390 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4391 case TYPE_SMALLER: n1 = (f1 < f2); break;
4392 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4393 case TYPE_UNKNOWN:
4394 case TYPE_MATCH:
4395 case TYPE_NOMATCH: break; /* avoid gcc warning */
4398 #endif
4401 * If one of the two variables is a number, compare as a number.
4402 * When using "=~" or "!~", always compare as string.
4404 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4405 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4407 n1 = get_tv_number(rettv);
4408 n2 = get_tv_number(&var2);
4409 switch (type)
4411 case TYPE_EQUAL: n1 = (n1 == n2); break;
4412 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4413 case TYPE_GREATER: n1 = (n1 > n2); break;
4414 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4415 case TYPE_SMALLER: n1 = (n1 < n2); break;
4416 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4417 case TYPE_UNKNOWN:
4418 case TYPE_MATCH:
4419 case TYPE_NOMATCH: break; /* avoid gcc warning */
4422 else
4424 s1 = get_tv_string_buf(rettv, buf1);
4425 s2 = get_tv_string_buf(&var2, buf2);
4426 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4427 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4428 else
4429 i = 0;
4430 n1 = FALSE;
4431 switch (type)
4433 case TYPE_EQUAL: n1 = (i == 0); break;
4434 case TYPE_NEQUAL: n1 = (i != 0); break;
4435 case TYPE_GREATER: n1 = (i > 0); break;
4436 case TYPE_GEQUAL: n1 = (i >= 0); break;
4437 case TYPE_SMALLER: n1 = (i < 0); break;
4438 case TYPE_SEQUAL: n1 = (i <= 0); break;
4440 case TYPE_MATCH:
4441 case TYPE_NOMATCH:
4442 /* avoid 'l' flag in 'cpoptions' */
4443 save_cpo = p_cpo;
4444 p_cpo = (char_u *)"";
4445 regmatch.regprog = vim_regcomp(s2,
4446 RE_MAGIC + RE_STRING);
4447 regmatch.rm_ic = ic;
4448 if (regmatch.regprog != NULL)
4450 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4451 vim_free(regmatch.regprog);
4452 if (type == TYPE_NOMATCH)
4453 n1 = !n1;
4455 p_cpo = save_cpo;
4456 break;
4458 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4461 clear_tv(rettv);
4462 clear_tv(&var2);
4463 rettv->v_type = VAR_NUMBER;
4464 rettv->vval.v_number = n1;
4468 return OK;
4472 * Handle fourth level expression:
4473 * + number addition
4474 * - number subtraction
4475 * . string concatenation
4477 * "arg" must point to the first non-white of the expression.
4478 * "arg" is advanced to the next non-white after the recognized expression.
4480 * Return OK or FAIL.
4482 static int
4483 eval5(arg, rettv, evaluate)
4484 char_u **arg;
4485 typval_T *rettv;
4486 int evaluate;
4488 typval_T var2;
4489 typval_T var3;
4490 int op;
4491 long n1, n2;
4492 #ifdef FEAT_FLOAT
4493 float_T f1 = 0, f2 = 0;
4494 #endif
4495 char_u *s1, *s2;
4496 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4497 char_u *p;
4500 * Get the first variable.
4502 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4503 return FAIL;
4506 * Repeat computing, until no '+', '-' or '.' is following.
4508 for (;;)
4510 op = **arg;
4511 if (op != '+' && op != '-' && op != '.')
4512 break;
4514 if ((op != '+' || rettv->v_type != VAR_LIST)
4515 #ifdef FEAT_FLOAT
4516 && (op == '.' || rettv->v_type != VAR_FLOAT)
4517 #endif
4520 /* For "list + ...", an illegal use of the first operand as
4521 * a number cannot be determined before evaluating the 2nd
4522 * operand: if this is also a list, all is ok.
4523 * For "something . ...", "something - ..." or "non-list + ...",
4524 * we know that the first operand needs to be a string or number
4525 * without evaluating the 2nd operand. So check before to avoid
4526 * side effects after an error. */
4527 if (evaluate && get_tv_string_chk(rettv) == NULL)
4529 clear_tv(rettv);
4530 return FAIL;
4535 * Get the second variable.
4537 *arg = skipwhite(*arg + 1);
4538 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4540 clear_tv(rettv);
4541 return FAIL;
4544 if (evaluate)
4547 * Compute the result.
4549 if (op == '.')
4551 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4552 s2 = get_tv_string_buf_chk(&var2, buf2);
4553 if (s2 == NULL) /* type error ? */
4555 clear_tv(rettv);
4556 clear_tv(&var2);
4557 return FAIL;
4559 p = concat_str(s1, s2);
4560 clear_tv(rettv);
4561 rettv->v_type = VAR_STRING;
4562 rettv->vval.v_string = p;
4564 else if (op == '+' && rettv->v_type == VAR_LIST
4565 && var2.v_type == VAR_LIST)
4567 /* concatenate Lists */
4568 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4569 &var3) == FAIL)
4571 clear_tv(rettv);
4572 clear_tv(&var2);
4573 return FAIL;
4575 clear_tv(rettv);
4576 *rettv = var3;
4578 else
4580 int error = FALSE;
4582 #ifdef FEAT_FLOAT
4583 if (rettv->v_type == VAR_FLOAT)
4585 f1 = rettv->vval.v_float;
4586 n1 = 0;
4588 else
4589 #endif
4591 n1 = get_tv_number_chk(rettv, &error);
4592 if (error)
4594 /* This can only happen for "list + non-list". For
4595 * "non-list + ..." or "something - ...", we returned
4596 * before evaluating the 2nd operand. */
4597 clear_tv(rettv);
4598 return FAIL;
4600 #ifdef FEAT_FLOAT
4601 if (var2.v_type == VAR_FLOAT)
4602 f1 = n1;
4603 #endif
4605 #ifdef FEAT_FLOAT
4606 if (var2.v_type == VAR_FLOAT)
4608 f2 = var2.vval.v_float;
4609 n2 = 0;
4611 else
4612 #endif
4614 n2 = get_tv_number_chk(&var2, &error);
4615 if (error)
4617 clear_tv(rettv);
4618 clear_tv(&var2);
4619 return FAIL;
4621 #ifdef FEAT_FLOAT
4622 if (rettv->v_type == VAR_FLOAT)
4623 f2 = n2;
4624 #endif
4626 clear_tv(rettv);
4628 #ifdef FEAT_FLOAT
4629 /* If there is a float on either side the result is a float. */
4630 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4632 if (op == '+')
4633 f1 = f1 + f2;
4634 else
4635 f1 = f1 - f2;
4636 rettv->v_type = VAR_FLOAT;
4637 rettv->vval.v_float = f1;
4639 else
4640 #endif
4642 if (op == '+')
4643 n1 = n1 + n2;
4644 else
4645 n1 = n1 - n2;
4646 rettv->v_type = VAR_NUMBER;
4647 rettv->vval.v_number = n1;
4650 clear_tv(&var2);
4653 return OK;
4657 * Handle fifth level expression:
4658 * * number multiplication
4659 * / number division
4660 * % number modulo
4662 * "arg" must point to the first non-white of the expression.
4663 * "arg" is advanced to the next non-white after the recognized expression.
4665 * Return OK or FAIL.
4667 static int
4668 eval6(arg, rettv, evaluate, want_string)
4669 char_u **arg;
4670 typval_T *rettv;
4671 int evaluate;
4672 int want_string; /* after "." operator */
4674 typval_T var2;
4675 int op;
4676 long n1, n2;
4677 #ifdef FEAT_FLOAT
4678 int use_float = FALSE;
4679 float_T f1 = 0, f2;
4680 #endif
4681 int error = FALSE;
4684 * Get the first variable.
4686 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4687 return FAIL;
4690 * Repeat computing, until no '*', '/' or '%' is following.
4692 for (;;)
4694 op = **arg;
4695 if (op != '*' && op != '/' && op != '%')
4696 break;
4698 if (evaluate)
4700 #ifdef FEAT_FLOAT
4701 if (rettv->v_type == VAR_FLOAT)
4703 f1 = rettv->vval.v_float;
4704 use_float = TRUE;
4705 n1 = 0;
4707 else
4708 #endif
4709 n1 = get_tv_number_chk(rettv, &error);
4710 clear_tv(rettv);
4711 if (error)
4712 return FAIL;
4714 else
4715 n1 = 0;
4718 * Get the second variable.
4720 *arg = skipwhite(*arg + 1);
4721 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4722 return FAIL;
4724 if (evaluate)
4726 #ifdef FEAT_FLOAT
4727 if (var2.v_type == VAR_FLOAT)
4729 if (!use_float)
4731 f1 = n1;
4732 use_float = TRUE;
4734 f2 = var2.vval.v_float;
4735 n2 = 0;
4737 else
4738 #endif
4740 n2 = get_tv_number_chk(&var2, &error);
4741 clear_tv(&var2);
4742 if (error)
4743 return FAIL;
4744 #ifdef FEAT_FLOAT
4745 if (use_float)
4746 f2 = n2;
4747 #endif
4751 * Compute the result.
4752 * When either side is a float the result is a float.
4754 #ifdef FEAT_FLOAT
4755 if (use_float)
4757 if (op == '*')
4758 f1 = f1 * f2;
4759 else if (op == '/')
4761 /* We rely on the floating point library to handle divide
4762 * by zero to result in "inf" and not a crash. */
4763 f1 = f1 / f2;
4765 else
4767 EMSG(_("E804: Cannot use '%' with Float"));
4768 return FAIL;
4770 rettv->v_type = VAR_FLOAT;
4771 rettv->vval.v_float = f1;
4773 else
4774 #endif
4776 if (op == '*')
4777 n1 = n1 * n2;
4778 else if (op == '/')
4780 if (n2 == 0) /* give an error message? */
4782 if (n1 == 0)
4783 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4784 else if (n1 < 0)
4785 n1 = -0x7fffffffL;
4786 else
4787 n1 = 0x7fffffffL;
4789 else
4790 n1 = n1 / n2;
4792 else
4794 if (n2 == 0) /* give an error message? */
4795 n1 = 0;
4796 else
4797 n1 = n1 % n2;
4799 rettv->v_type = VAR_NUMBER;
4800 rettv->vval.v_number = n1;
4805 return OK;
4809 * Handle sixth level expression:
4810 * number number constant
4811 * "string" string constant
4812 * 'string' literal string constant
4813 * &option-name option value
4814 * @r register contents
4815 * identifier variable value
4816 * function() function call
4817 * $VAR environment variable
4818 * (expression) nested expression
4819 * [expr, expr] List
4820 * {key: val, key: val} Dictionary
4822 * Also handle:
4823 * ! in front logical NOT
4824 * - in front unary minus
4825 * + in front unary plus (ignored)
4826 * trailing [] subscript in String or List
4827 * trailing .name entry in Dictionary
4829 * "arg" must point to the first non-white of the expression.
4830 * "arg" is advanced to the next non-white after the recognized expression.
4832 * Return OK or FAIL.
4834 static int
4835 eval7(arg, rettv, evaluate, want_string)
4836 char_u **arg;
4837 typval_T *rettv;
4838 int evaluate;
4839 int want_string; /* after "." operator */
4841 long n;
4842 int len;
4843 char_u *s;
4844 char_u *start_leader, *end_leader;
4845 int ret = OK;
4846 char_u *alias;
4849 * Initialise variable so that clear_tv() can't mistake this for a
4850 * string and free a string that isn't there.
4852 rettv->v_type = VAR_UNKNOWN;
4855 * Skip '!' and '-' characters. They are handled later.
4857 start_leader = *arg;
4858 while (**arg == '!' || **arg == '-' || **arg == '+')
4859 *arg = skipwhite(*arg + 1);
4860 end_leader = *arg;
4862 switch (**arg)
4865 * Number constant.
4867 case '0':
4868 case '1':
4869 case '2':
4870 case '3':
4871 case '4':
4872 case '5':
4873 case '6':
4874 case '7':
4875 case '8':
4876 case '9':
4878 #ifdef FEAT_FLOAT
4879 char_u *p = skipdigits(*arg + 1);
4880 int get_float = FALSE;
4882 /* We accept a float when the format matches
4883 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4884 * strict to avoid backwards compatibility problems.
4885 * Don't look for a float after the "." operator, so that
4886 * ":let vers = 1.2.3" doesn't fail. */
4887 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4889 get_float = TRUE;
4890 p = skipdigits(p + 2);
4891 if (*p == 'e' || *p == 'E')
4893 ++p;
4894 if (*p == '-' || *p == '+')
4895 ++p;
4896 if (!vim_isdigit(*p))
4897 get_float = FALSE;
4898 else
4899 p = skipdigits(p + 1);
4901 if (ASCII_ISALPHA(*p) || *p == '.')
4902 get_float = FALSE;
4904 if (get_float)
4906 float_T f;
4908 *arg += string2float(*arg, &f);
4909 if (evaluate)
4911 rettv->v_type = VAR_FLOAT;
4912 rettv->vval.v_float = f;
4915 else
4916 #endif
4918 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4919 *arg += len;
4920 if (evaluate)
4922 rettv->v_type = VAR_NUMBER;
4923 rettv->vval.v_number = n;
4926 break;
4930 * String constant: "string".
4932 case '"': ret = get_string_tv(arg, rettv, evaluate);
4933 break;
4936 * Literal string constant: 'str''ing'.
4938 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4939 break;
4942 * List: [expr, expr]
4944 case '[': ret = get_list_tv(arg, rettv, evaluate);
4945 break;
4948 * Dictionary: {key: val, key: val}
4950 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4951 break;
4954 * Option value: &name
4956 case '&': ret = get_option_tv(arg, rettv, evaluate);
4957 break;
4960 * Environment variable: $VAR.
4962 case '$': ret = get_env_tv(arg, rettv, evaluate);
4963 break;
4966 * Register contents: @r.
4968 case '@': ++*arg;
4969 if (evaluate)
4971 rettv->v_type = VAR_STRING;
4972 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4974 if (**arg != NUL)
4975 ++*arg;
4976 break;
4979 * nested expression: (expression).
4981 case '(': *arg = skipwhite(*arg + 1);
4982 ret = eval1(arg, rettv, evaluate); /* recursive! */
4983 if (**arg == ')')
4984 ++*arg;
4985 else if (ret == OK)
4987 EMSG(_("E110: Missing ')'"));
4988 clear_tv(rettv);
4989 ret = FAIL;
4991 break;
4993 default: ret = NOTDONE;
4994 break;
4997 if (ret == NOTDONE)
5000 * Must be a variable or function name.
5001 * Can also be a curly-braces kind of name: {expr}.
5003 s = *arg;
5004 len = get_name_len(arg, &alias, evaluate, TRUE);
5005 if (alias != NULL)
5006 s = alias;
5008 if (len <= 0)
5009 ret = FAIL;
5010 else
5012 if (**arg == '(') /* recursive! */
5014 /* If "s" is the name of a variable of type VAR_FUNC
5015 * use its contents. */
5016 s = deref_func_name(s, &len);
5018 /* Invoke the function. */
5019 ret = get_func_tv(s, len, rettv, arg,
5020 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5021 &len, evaluate, NULL);
5022 /* Stop the expression evaluation when immediately
5023 * aborting on error, or when an interrupt occurred or
5024 * an exception was thrown but not caught. */
5025 if (aborting())
5027 if (ret == OK)
5028 clear_tv(rettv);
5029 ret = FAIL;
5032 else if (evaluate)
5033 ret = get_var_tv(s, len, rettv, TRUE);
5034 else
5035 ret = OK;
5038 if (alias != NULL)
5039 vim_free(alias);
5042 *arg = skipwhite(*arg);
5044 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5045 * expr(expr). */
5046 if (ret == OK)
5047 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5050 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5052 if (ret == OK && evaluate && end_leader > start_leader)
5054 int error = FALSE;
5055 int val = 0;
5056 #ifdef FEAT_FLOAT
5057 float_T f = 0.0;
5059 if (rettv->v_type == VAR_FLOAT)
5060 f = rettv->vval.v_float;
5061 else
5062 #endif
5063 val = get_tv_number_chk(rettv, &error);
5064 if (error)
5066 clear_tv(rettv);
5067 ret = FAIL;
5069 else
5071 while (end_leader > start_leader)
5073 --end_leader;
5074 if (*end_leader == '!')
5076 #ifdef FEAT_FLOAT
5077 if (rettv->v_type == VAR_FLOAT)
5078 f = !f;
5079 else
5080 #endif
5081 val = !val;
5083 else if (*end_leader == '-')
5085 #ifdef FEAT_FLOAT
5086 if (rettv->v_type == VAR_FLOAT)
5087 f = -f;
5088 else
5089 #endif
5090 val = -val;
5093 #ifdef FEAT_FLOAT
5094 if (rettv->v_type == VAR_FLOAT)
5096 clear_tv(rettv);
5097 rettv->vval.v_float = f;
5099 else
5100 #endif
5102 clear_tv(rettv);
5103 rettv->v_type = VAR_NUMBER;
5104 rettv->vval.v_number = val;
5109 return ret;
5113 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5114 * "*arg" points to the '[' or '.'.
5115 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5117 static int
5118 eval_index(arg, rettv, evaluate, verbose)
5119 char_u **arg;
5120 typval_T *rettv;
5121 int evaluate;
5122 int verbose; /* give error messages */
5124 int empty1 = FALSE, empty2 = FALSE;
5125 typval_T var1, var2;
5126 long n1, n2 = 0;
5127 long len = -1;
5128 int range = FALSE;
5129 char_u *s;
5130 char_u *key = NULL;
5132 if (rettv->v_type == VAR_FUNC
5133 #ifdef FEAT_FLOAT
5134 || rettv->v_type == VAR_FLOAT
5135 #endif
5138 if (verbose)
5139 EMSG(_("E695: Cannot index a Funcref"));
5140 return FAIL;
5143 if (**arg == '.')
5146 * dict.name
5148 key = *arg + 1;
5149 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5151 if (len == 0)
5152 return FAIL;
5153 *arg = skipwhite(key + len);
5155 else
5158 * something[idx]
5160 * Get the (first) variable from inside the [].
5162 *arg = skipwhite(*arg + 1);
5163 if (**arg == ':')
5164 empty1 = TRUE;
5165 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5166 return FAIL;
5167 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5169 /* not a number or string */
5170 clear_tv(&var1);
5171 return FAIL;
5175 * Get the second variable from inside the [:].
5177 if (**arg == ':')
5179 range = TRUE;
5180 *arg = skipwhite(*arg + 1);
5181 if (**arg == ']')
5182 empty2 = TRUE;
5183 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5185 if (!empty1)
5186 clear_tv(&var1);
5187 return FAIL;
5189 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5191 /* not a number or string */
5192 if (!empty1)
5193 clear_tv(&var1);
5194 clear_tv(&var2);
5195 return FAIL;
5199 /* Check for the ']'. */
5200 if (**arg != ']')
5202 if (verbose)
5203 EMSG(_(e_missbrac));
5204 clear_tv(&var1);
5205 if (range)
5206 clear_tv(&var2);
5207 return FAIL;
5209 *arg = skipwhite(*arg + 1); /* skip the ']' */
5212 if (evaluate)
5214 n1 = 0;
5215 if (!empty1 && rettv->v_type != VAR_DICT)
5217 n1 = get_tv_number(&var1);
5218 clear_tv(&var1);
5220 if (range)
5222 if (empty2)
5223 n2 = -1;
5224 else
5226 n2 = get_tv_number(&var2);
5227 clear_tv(&var2);
5231 switch (rettv->v_type)
5233 case VAR_NUMBER:
5234 case VAR_STRING:
5235 s = get_tv_string(rettv);
5236 len = (long)STRLEN(s);
5237 if (range)
5239 /* The resulting variable is a substring. If the indexes
5240 * are out of range the result is empty. */
5241 if (n1 < 0)
5243 n1 = len + n1;
5244 if (n1 < 0)
5245 n1 = 0;
5247 if (n2 < 0)
5248 n2 = len + n2;
5249 else if (n2 >= len)
5250 n2 = len;
5251 if (n1 >= len || n2 < 0 || n1 > n2)
5252 s = NULL;
5253 else
5254 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5256 else
5258 /* The resulting variable is a string of a single
5259 * character. If the index is too big or negative the
5260 * result is empty. */
5261 if (n1 >= len || n1 < 0)
5262 s = NULL;
5263 else
5264 s = vim_strnsave(s + n1, 1);
5266 clear_tv(rettv);
5267 rettv->v_type = VAR_STRING;
5268 rettv->vval.v_string = s;
5269 break;
5271 case VAR_LIST:
5272 len = list_len(rettv->vval.v_list);
5273 if (n1 < 0)
5274 n1 = len + n1;
5275 if (!empty1 && (n1 < 0 || n1 >= len))
5277 /* For a range we allow invalid values and return an empty
5278 * list. A list index out of range is an error. */
5279 if (!range)
5281 if (verbose)
5282 EMSGN(_(e_listidx), n1);
5283 return FAIL;
5285 n1 = len;
5287 if (range)
5289 list_T *l;
5290 listitem_T *item;
5292 if (n2 < 0)
5293 n2 = len + n2;
5294 else if (n2 >= len)
5295 n2 = len - 1;
5296 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5297 n2 = -1;
5298 l = list_alloc();
5299 if (l == NULL)
5300 return FAIL;
5301 for (item = list_find(rettv->vval.v_list, n1);
5302 n1 <= n2; ++n1)
5304 if (list_append_tv(l, &item->li_tv) == FAIL)
5306 list_free(l, TRUE);
5307 return FAIL;
5309 item = item->li_next;
5311 clear_tv(rettv);
5312 rettv->v_type = VAR_LIST;
5313 rettv->vval.v_list = l;
5314 ++l->lv_refcount;
5316 else
5318 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5319 clear_tv(rettv);
5320 *rettv = var1;
5322 break;
5324 case VAR_DICT:
5325 if (range)
5327 if (verbose)
5328 EMSG(_(e_dictrange));
5329 if (len == -1)
5330 clear_tv(&var1);
5331 return FAIL;
5334 dictitem_T *item;
5336 if (len == -1)
5338 key = get_tv_string(&var1);
5339 if (*key == NUL)
5341 if (verbose)
5342 EMSG(_(e_emptykey));
5343 clear_tv(&var1);
5344 return FAIL;
5348 item = dict_find(rettv->vval.v_dict, key, (int)len);
5350 if (item == NULL && verbose)
5351 EMSG2(_(e_dictkey), key);
5352 if (len == -1)
5353 clear_tv(&var1);
5354 if (item == NULL)
5355 return FAIL;
5357 copy_tv(&item->di_tv, &var1);
5358 clear_tv(rettv);
5359 *rettv = var1;
5361 break;
5365 return OK;
5369 * Get an option value.
5370 * "arg" points to the '&' or '+' before the option name.
5371 * "arg" is advanced to character after the option name.
5372 * Return OK or FAIL.
5374 static int
5375 get_option_tv(arg, rettv, evaluate)
5376 char_u **arg;
5377 typval_T *rettv; /* when NULL, only check if option exists */
5378 int evaluate;
5380 char_u *option_end;
5381 long numval;
5382 char_u *stringval;
5383 int opt_type;
5384 int c;
5385 int working = (**arg == '+'); /* has("+option") */
5386 int ret = OK;
5387 int opt_flags;
5390 * Isolate the option name and find its value.
5392 option_end = find_option_end(arg, &opt_flags);
5393 if (option_end == NULL)
5395 if (rettv != NULL)
5396 EMSG2(_("E112: Option name missing: %s"), *arg);
5397 return FAIL;
5400 if (!evaluate)
5402 *arg = option_end;
5403 return OK;
5406 c = *option_end;
5407 *option_end = NUL;
5408 opt_type = get_option_value(*arg, &numval,
5409 rettv == NULL ? NULL : &stringval, opt_flags);
5411 if (opt_type == -3) /* invalid name */
5413 if (rettv != NULL)
5414 EMSG2(_("E113: Unknown option: %s"), *arg);
5415 ret = FAIL;
5417 else if (rettv != NULL)
5419 if (opt_type == -2) /* hidden string option */
5421 rettv->v_type = VAR_STRING;
5422 rettv->vval.v_string = NULL;
5424 else if (opt_type == -1) /* hidden number option */
5426 rettv->v_type = VAR_NUMBER;
5427 rettv->vval.v_number = 0;
5429 else if (opt_type == 1) /* number option */
5431 rettv->v_type = VAR_NUMBER;
5432 rettv->vval.v_number = numval;
5434 else /* string option */
5436 rettv->v_type = VAR_STRING;
5437 rettv->vval.v_string = stringval;
5440 else if (working && (opt_type == -2 || opt_type == -1))
5441 ret = FAIL;
5443 *option_end = c; /* put back for error messages */
5444 *arg = option_end;
5446 return ret;
5450 * Allocate a variable for a string constant.
5451 * Return OK or FAIL.
5453 static int
5454 get_string_tv(arg, rettv, evaluate)
5455 char_u **arg;
5456 typval_T *rettv;
5457 int evaluate;
5459 char_u *p;
5460 char_u *name;
5461 int extra = 0;
5464 * Find the end of the string, skipping backslashed characters.
5466 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5468 if (*p == '\\' && p[1] != NUL)
5470 ++p;
5471 /* A "\<x>" form occupies at least 4 characters, and produces up
5472 * to 6 characters: reserve space for 2 extra */
5473 if (*p == '<')
5474 extra += 2;
5478 if (*p != '"')
5480 EMSG2(_("E114: Missing quote: %s"), *arg);
5481 return FAIL;
5484 /* If only parsing, set *arg and return here */
5485 if (!evaluate)
5487 *arg = p + 1;
5488 return OK;
5492 * Copy the string into allocated memory, handling backslashed
5493 * characters.
5495 name = alloc((unsigned)(p - *arg + extra));
5496 if (name == NULL)
5497 return FAIL;
5498 rettv->v_type = VAR_STRING;
5499 rettv->vval.v_string = name;
5501 for (p = *arg + 1; *p != NUL && *p != '"'; )
5503 if (*p == '\\')
5505 switch (*++p)
5507 case 'b': *name++ = BS; ++p; break;
5508 case 'e': *name++ = ESC; ++p; break;
5509 case 'f': *name++ = FF; ++p; break;
5510 case 'n': *name++ = NL; ++p; break;
5511 case 'r': *name++ = CAR; ++p; break;
5512 case 't': *name++ = TAB; ++p; break;
5514 case 'X': /* hex: "\x1", "\x12" */
5515 case 'x':
5516 case 'u': /* Unicode: "\u0023" */
5517 case 'U':
5518 if (vim_isxdigit(p[1]))
5520 int n, nr;
5521 int c = toupper(*p);
5523 if (c == 'X')
5524 n = 2;
5525 else
5526 n = 4;
5527 nr = 0;
5528 while (--n >= 0 && vim_isxdigit(p[1]))
5530 ++p;
5531 nr = (nr << 4) + hex2nr(*p);
5533 ++p;
5534 #ifdef FEAT_MBYTE
5535 /* For "\u" store the number according to
5536 * 'encoding'. */
5537 if (c != 'X')
5538 name += (*mb_char2bytes)(nr, name);
5539 else
5540 #endif
5541 *name++ = nr;
5543 break;
5545 /* octal: "\1", "\12", "\123" */
5546 case '0':
5547 case '1':
5548 case '2':
5549 case '3':
5550 case '4':
5551 case '5':
5552 case '6':
5553 case '7': *name = *p++ - '0';
5554 if (*p >= '0' && *p <= '7')
5556 *name = (*name << 3) + *p++ - '0';
5557 if (*p >= '0' && *p <= '7')
5558 *name = (*name << 3) + *p++ - '0';
5560 ++name;
5561 break;
5563 /* Special key, e.g.: "\<C-W>" */
5564 case '<': extra = trans_special(&p, name, TRUE);
5565 if (extra != 0)
5567 name += extra;
5568 break;
5570 /* FALLTHROUGH */
5572 default: MB_COPY_CHAR(p, name);
5573 break;
5576 else
5577 MB_COPY_CHAR(p, name);
5580 *name = NUL;
5581 *arg = p + 1;
5583 return OK;
5587 * Allocate a variable for a 'str''ing' constant.
5588 * Return OK or FAIL.
5590 static int
5591 get_lit_string_tv(arg, rettv, evaluate)
5592 char_u **arg;
5593 typval_T *rettv;
5594 int evaluate;
5596 char_u *p;
5597 char_u *str;
5598 int reduce = 0;
5601 * Find the end of the string, skipping ''.
5603 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5605 if (*p == '\'')
5607 if (p[1] != '\'')
5608 break;
5609 ++reduce;
5610 ++p;
5614 if (*p != '\'')
5616 EMSG2(_("E115: Missing quote: %s"), *arg);
5617 return FAIL;
5620 /* If only parsing return after setting "*arg" */
5621 if (!evaluate)
5623 *arg = p + 1;
5624 return OK;
5628 * Copy the string into allocated memory, handling '' to ' reduction.
5630 str = alloc((unsigned)((p - *arg) - reduce));
5631 if (str == NULL)
5632 return FAIL;
5633 rettv->v_type = VAR_STRING;
5634 rettv->vval.v_string = str;
5636 for (p = *arg + 1; *p != NUL; )
5638 if (*p == '\'')
5640 if (p[1] != '\'')
5641 break;
5642 ++p;
5644 MB_COPY_CHAR(p, str);
5646 *str = NUL;
5647 *arg = p + 1;
5649 return OK;
5653 * Allocate a variable for a List and fill it from "*arg".
5654 * Return OK or FAIL.
5656 static int
5657 get_list_tv(arg, rettv, evaluate)
5658 char_u **arg;
5659 typval_T *rettv;
5660 int evaluate;
5662 list_T *l = NULL;
5663 typval_T tv;
5664 listitem_T *item;
5666 if (evaluate)
5668 l = list_alloc();
5669 if (l == NULL)
5670 return FAIL;
5673 *arg = skipwhite(*arg + 1);
5674 while (**arg != ']' && **arg != NUL)
5676 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5677 goto failret;
5678 if (evaluate)
5680 item = listitem_alloc();
5681 if (item != NULL)
5683 item->li_tv = tv;
5684 item->li_tv.v_lock = 0;
5685 list_append(l, item);
5687 else
5688 clear_tv(&tv);
5691 if (**arg == ']')
5692 break;
5693 if (**arg != ',')
5695 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5696 goto failret;
5698 *arg = skipwhite(*arg + 1);
5701 if (**arg != ']')
5703 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5704 failret:
5705 if (evaluate)
5706 list_free(l, TRUE);
5707 return FAIL;
5710 *arg = skipwhite(*arg + 1);
5711 if (evaluate)
5713 rettv->v_type = VAR_LIST;
5714 rettv->vval.v_list = l;
5715 ++l->lv_refcount;
5718 return OK;
5722 * Allocate an empty header for a list.
5723 * Caller should take care of the reference count.
5725 list_T *
5726 list_alloc()
5728 list_T *l;
5730 l = (list_T *)alloc_clear(sizeof(list_T));
5731 if (l != NULL)
5733 /* Prepend the list to the list of lists for garbage collection. */
5734 if (first_list != NULL)
5735 first_list->lv_used_prev = l;
5736 l->lv_used_prev = NULL;
5737 l->lv_used_next = first_list;
5738 first_list = l;
5740 return l;
5744 * Allocate an empty list for a return value.
5745 * Returns OK or FAIL.
5747 static int
5748 rettv_list_alloc(rettv)
5749 typval_T *rettv;
5751 list_T *l = list_alloc();
5753 if (l == NULL)
5754 return FAIL;
5756 rettv->vval.v_list = l;
5757 rettv->v_type = VAR_LIST;
5758 ++l->lv_refcount;
5759 return OK;
5763 * Unreference a list: decrement the reference count and free it when it
5764 * becomes zero.
5766 void
5767 list_unref(l)
5768 list_T *l;
5770 if (l != NULL && --l->lv_refcount <= 0)
5771 list_free(l, TRUE);
5775 * Free a list, including all items it points to.
5776 * Ignores the reference count.
5778 void
5779 list_free(l, recurse)
5780 list_T *l;
5781 int recurse; /* Free Lists and Dictionaries recursively. */
5783 listitem_T *item;
5785 /* Remove the list from the list of lists for garbage collection. */
5786 if (l->lv_used_prev == NULL)
5787 first_list = l->lv_used_next;
5788 else
5789 l->lv_used_prev->lv_used_next = l->lv_used_next;
5790 if (l->lv_used_next != NULL)
5791 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5793 for (item = l->lv_first; item != NULL; item = l->lv_first)
5795 /* Remove the item before deleting it. */
5796 l->lv_first = item->li_next;
5797 if (recurse || (item->li_tv.v_type != VAR_LIST
5798 && item->li_tv.v_type != VAR_DICT))
5799 clear_tv(&item->li_tv);
5800 vim_free(item);
5802 vim_free(l);
5806 * Allocate a list item.
5808 static listitem_T *
5809 listitem_alloc()
5811 return (listitem_T *)alloc(sizeof(listitem_T));
5815 * Free a list item. Also clears the value. Does not notify watchers.
5817 static void
5818 listitem_free(item)
5819 listitem_T *item;
5821 clear_tv(&item->li_tv);
5822 vim_free(item);
5826 * Remove a list item from a List and free it. Also clears the value.
5828 static void
5829 listitem_remove(l, item)
5830 list_T *l;
5831 listitem_T *item;
5833 list_remove(l, item, item);
5834 listitem_free(item);
5838 * Get the number of items in a list.
5840 static long
5841 list_len(l)
5842 list_T *l;
5844 if (l == NULL)
5845 return 0L;
5846 return l->lv_len;
5850 * Return TRUE when two lists have exactly the same values.
5852 static int
5853 list_equal(l1, l2, ic)
5854 list_T *l1;
5855 list_T *l2;
5856 int ic; /* ignore case for strings */
5858 listitem_T *item1, *item2;
5860 if (l1 == NULL || l2 == NULL)
5861 return FALSE;
5862 if (l1 == l2)
5863 return TRUE;
5864 if (list_len(l1) != list_len(l2))
5865 return FALSE;
5867 for (item1 = l1->lv_first, item2 = l2->lv_first;
5868 item1 != NULL && item2 != NULL;
5869 item1 = item1->li_next, item2 = item2->li_next)
5870 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5871 return FALSE;
5872 return item1 == NULL && item2 == NULL;
5875 #if defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) || defined(PROTO)
5877 * Return the dictitem that an entry in a hashtable points to.
5879 dictitem_T *
5880 dict_lookup(hi)
5881 hashitem_T *hi;
5883 return HI2DI(hi);
5885 #endif
5888 * Return TRUE when two dictionaries have exactly the same key/values.
5890 static int
5891 dict_equal(d1, d2, ic)
5892 dict_T *d1;
5893 dict_T *d2;
5894 int ic; /* ignore case for strings */
5896 hashitem_T *hi;
5897 dictitem_T *item2;
5898 int todo;
5900 if (d1 == NULL || d2 == NULL)
5901 return FALSE;
5902 if (d1 == d2)
5903 return TRUE;
5904 if (dict_len(d1) != dict_len(d2))
5905 return FALSE;
5907 todo = (int)d1->dv_hashtab.ht_used;
5908 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5910 if (!HASHITEM_EMPTY(hi))
5912 item2 = dict_find(d2, hi->hi_key, -1);
5913 if (item2 == NULL)
5914 return FALSE;
5915 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5916 return FALSE;
5917 --todo;
5920 return TRUE;
5924 * Return TRUE if "tv1" and "tv2" have the same value.
5925 * Compares the items just like "==" would compare them, but strings and
5926 * numbers are different. Floats and numbers are also different.
5928 static int
5929 tv_equal(tv1, tv2, ic)
5930 typval_T *tv1;
5931 typval_T *tv2;
5932 int ic; /* ignore case */
5934 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5935 char_u *s1, *s2;
5936 static int recursive = 0; /* cach recursive loops */
5937 int r;
5939 if (tv1->v_type != tv2->v_type)
5940 return FALSE;
5941 /* Catch lists and dicts that have an endless loop by limiting
5942 * recursiveness to 1000. We guess they are equal then. */
5943 if (recursive >= 1000)
5944 return TRUE;
5946 switch (tv1->v_type)
5948 case VAR_LIST:
5949 ++recursive;
5950 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5951 --recursive;
5952 return r;
5954 case VAR_DICT:
5955 ++recursive;
5956 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5957 --recursive;
5958 return r;
5960 case VAR_FUNC:
5961 return (tv1->vval.v_string != NULL
5962 && tv2->vval.v_string != NULL
5963 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5965 case VAR_NUMBER:
5966 return tv1->vval.v_number == tv2->vval.v_number;
5968 #ifdef FEAT_FLOAT
5969 case VAR_FLOAT:
5970 return tv1->vval.v_float == tv2->vval.v_float;
5971 #endif
5973 case VAR_STRING:
5974 s1 = get_tv_string_buf(tv1, buf1);
5975 s2 = get_tv_string_buf(tv2, buf2);
5976 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5979 EMSG2(_(e_intern2), "tv_equal()");
5980 return TRUE;
5984 * Locate item with index "n" in list "l" and return it.
5985 * A negative index is counted from the end; -1 is the last item.
5986 * Returns NULL when "n" is out of range.
5988 static listitem_T *
5989 list_find(l, n)
5990 list_T *l;
5991 long n;
5993 listitem_T *item;
5994 long idx;
5996 if (l == NULL)
5997 return NULL;
5999 /* Negative index is relative to the end. */
6000 if (n < 0)
6001 n = l->lv_len + n;
6003 /* Check for index out of range. */
6004 if (n < 0 || n >= l->lv_len)
6005 return NULL;
6007 /* When there is a cached index may start search from there. */
6008 if (l->lv_idx_item != NULL)
6010 if (n < l->lv_idx / 2)
6012 /* closest to the start of the list */
6013 item = l->lv_first;
6014 idx = 0;
6016 else if (n > (l->lv_idx + l->lv_len) / 2)
6018 /* closest to the end of the list */
6019 item = l->lv_last;
6020 idx = l->lv_len - 1;
6022 else
6024 /* closest to the cached index */
6025 item = l->lv_idx_item;
6026 idx = l->lv_idx;
6029 else
6031 if (n < l->lv_len / 2)
6033 /* closest to the start of the list */
6034 item = l->lv_first;
6035 idx = 0;
6037 else
6039 /* closest to the end of the list */
6040 item = l->lv_last;
6041 idx = l->lv_len - 1;
6045 while (n > idx)
6047 /* search forward */
6048 item = item->li_next;
6049 ++idx;
6051 while (n < idx)
6053 /* search backward */
6054 item = item->li_prev;
6055 --idx;
6058 /* cache the used index */
6059 l->lv_idx = idx;
6060 l->lv_idx_item = item;
6062 return item;
6066 * Get list item "l[idx]" as a number.
6068 static long
6069 list_find_nr(l, idx, errorp)
6070 list_T *l;
6071 long idx;
6072 int *errorp; /* set to TRUE when something wrong */
6074 listitem_T *li;
6076 li = list_find(l, idx);
6077 if (li == NULL)
6079 if (errorp != NULL)
6080 *errorp = TRUE;
6081 return -1L;
6083 return get_tv_number_chk(&li->li_tv, errorp);
6087 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6089 char_u *
6090 list_find_str(l, idx)
6091 list_T *l;
6092 long idx;
6094 listitem_T *li;
6096 li = list_find(l, idx - 1);
6097 if (li == NULL)
6099 EMSGN(_(e_listidx), idx);
6100 return NULL;
6102 return get_tv_string(&li->li_tv);
6106 * Locate "item" list "l" and return its index.
6107 * Returns -1 when "item" is not in the list.
6109 static long
6110 list_idx_of_item(l, item)
6111 list_T *l;
6112 listitem_T *item;
6114 long idx = 0;
6115 listitem_T *li;
6117 if (l == NULL)
6118 return -1;
6119 idx = 0;
6120 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6121 ++idx;
6122 if (li == NULL)
6123 return -1;
6124 return idx;
6128 * Append item "item" to the end of list "l".
6130 static void
6131 list_append(l, item)
6132 list_T *l;
6133 listitem_T *item;
6135 if (l->lv_last == NULL)
6137 /* empty list */
6138 l->lv_first = item;
6139 l->lv_last = item;
6140 item->li_prev = NULL;
6142 else
6144 l->lv_last->li_next = item;
6145 item->li_prev = l->lv_last;
6146 l->lv_last = item;
6148 ++l->lv_len;
6149 item->li_next = NULL;
6153 * Append typval_T "tv" to the end of list "l".
6154 * Return FAIL when out of memory.
6157 list_append_tv(l, tv)
6158 list_T *l;
6159 typval_T *tv;
6161 listitem_T *li = listitem_alloc();
6163 if (li == NULL)
6164 return FAIL;
6165 copy_tv(tv, &li->li_tv);
6166 list_append(l, li);
6167 return OK;
6171 * Add a dictionary to a list. Used by getqflist().
6172 * Return FAIL when out of memory.
6175 list_append_dict(list, dict)
6176 list_T *list;
6177 dict_T *dict;
6179 listitem_T *li = listitem_alloc();
6181 if (li == NULL)
6182 return FAIL;
6183 li->li_tv.v_type = VAR_DICT;
6184 li->li_tv.v_lock = 0;
6185 li->li_tv.vval.v_dict = dict;
6186 list_append(list, li);
6187 ++dict->dv_refcount;
6188 return OK;
6192 * Make a copy of "str" and append it as an item to list "l".
6193 * When "len" >= 0 use "str[len]".
6194 * Returns FAIL when out of memory.
6197 list_append_string(l, str, len)
6198 list_T *l;
6199 char_u *str;
6200 int len;
6202 listitem_T *li = listitem_alloc();
6204 if (li == NULL)
6205 return FAIL;
6206 list_append(l, li);
6207 li->li_tv.v_type = VAR_STRING;
6208 li->li_tv.v_lock = 0;
6209 if (str == NULL)
6210 li->li_tv.vval.v_string = NULL;
6211 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6212 : vim_strsave(str))) == NULL)
6213 return FAIL;
6214 return OK;
6218 * Append "n" to list "l".
6219 * Returns FAIL when out of memory.
6221 static int
6222 list_append_number(l, n)
6223 list_T *l;
6224 varnumber_T n;
6226 listitem_T *li;
6228 li = listitem_alloc();
6229 if (li == NULL)
6230 return FAIL;
6231 li->li_tv.v_type = VAR_NUMBER;
6232 li->li_tv.v_lock = 0;
6233 li->li_tv.vval.v_number = n;
6234 list_append(l, li);
6235 return OK;
6239 * Insert typval_T "tv" in list "l" before "item".
6240 * If "item" is NULL append at the end.
6241 * Return FAIL when out of memory.
6243 static int
6244 list_insert_tv(l, tv, item)
6245 list_T *l;
6246 typval_T *tv;
6247 listitem_T *item;
6249 listitem_T *ni = listitem_alloc();
6251 if (ni == NULL)
6252 return FAIL;
6253 copy_tv(tv, &ni->li_tv);
6254 if (item == NULL)
6255 /* Append new item at end of list. */
6256 list_append(l, ni);
6257 else
6259 /* Insert new item before existing item. */
6260 ni->li_prev = item->li_prev;
6261 ni->li_next = item;
6262 if (item->li_prev == NULL)
6264 l->lv_first = ni;
6265 ++l->lv_idx;
6267 else
6269 item->li_prev->li_next = ni;
6270 l->lv_idx_item = NULL;
6272 item->li_prev = ni;
6273 ++l->lv_len;
6275 return OK;
6279 * Extend "l1" with "l2".
6280 * If "bef" is NULL append at the end, otherwise insert before this item.
6281 * Returns FAIL when out of memory.
6283 static int
6284 list_extend(l1, l2, bef)
6285 list_T *l1;
6286 list_T *l2;
6287 listitem_T *bef;
6289 listitem_T *item;
6290 int todo = l2->lv_len;
6292 /* We also quit the loop when we have inserted the original item count of
6293 * the list, avoid a hang when we extend a list with itself. */
6294 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6295 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6296 return FAIL;
6297 return OK;
6301 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6302 * Return FAIL when out of memory.
6304 static int
6305 list_concat(l1, l2, tv)
6306 list_T *l1;
6307 list_T *l2;
6308 typval_T *tv;
6310 list_T *l;
6312 if (l1 == NULL || l2 == NULL)
6313 return FAIL;
6315 /* make a copy of the first list. */
6316 l = list_copy(l1, FALSE, 0);
6317 if (l == NULL)
6318 return FAIL;
6319 tv->v_type = VAR_LIST;
6320 tv->vval.v_list = l;
6322 /* append all items from the second list */
6323 return list_extend(l, l2, NULL);
6327 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6328 * The refcount of the new list is set to 1.
6329 * See item_copy() for "copyID".
6330 * Returns NULL when out of memory.
6332 static list_T *
6333 list_copy(orig, deep, copyID)
6334 list_T *orig;
6335 int deep;
6336 int copyID;
6338 list_T *copy;
6339 listitem_T *item;
6340 listitem_T *ni;
6342 if (orig == NULL)
6343 return NULL;
6345 copy = list_alloc();
6346 if (copy != NULL)
6348 if (copyID != 0)
6350 /* Do this before adding the items, because one of the items may
6351 * refer back to this list. */
6352 orig->lv_copyID = copyID;
6353 orig->lv_copylist = copy;
6355 for (item = orig->lv_first; item != NULL && !got_int;
6356 item = item->li_next)
6358 ni = listitem_alloc();
6359 if (ni == NULL)
6360 break;
6361 if (deep)
6363 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6365 vim_free(ni);
6366 break;
6369 else
6370 copy_tv(&item->li_tv, &ni->li_tv);
6371 list_append(copy, ni);
6373 ++copy->lv_refcount;
6374 if (item != NULL)
6376 list_unref(copy);
6377 copy = NULL;
6381 return copy;
6385 * Remove items "item" to "item2" from list "l".
6386 * Does not free the listitem or the value!
6388 static void
6389 list_remove(l, item, item2)
6390 list_T *l;
6391 listitem_T *item;
6392 listitem_T *item2;
6394 listitem_T *ip;
6396 /* notify watchers */
6397 for (ip = item; ip != NULL; ip = ip->li_next)
6399 --l->lv_len;
6400 list_fix_watch(l, ip);
6401 if (ip == item2)
6402 break;
6405 if (item2->li_next == NULL)
6406 l->lv_last = item->li_prev;
6407 else
6408 item2->li_next->li_prev = item->li_prev;
6409 if (item->li_prev == NULL)
6410 l->lv_first = item2->li_next;
6411 else
6412 item->li_prev->li_next = item2->li_next;
6413 l->lv_idx_item = NULL;
6417 * Return an allocated string with the string representation of a list.
6418 * May return NULL.
6420 static char_u *
6421 list2string(tv, copyID)
6422 typval_T *tv;
6423 int copyID;
6425 garray_T ga;
6427 if (tv->vval.v_list == NULL)
6428 return NULL;
6429 ga_init2(&ga, (int)sizeof(char), 80);
6430 ga_append(&ga, '[');
6431 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6433 vim_free(ga.ga_data);
6434 return NULL;
6436 ga_append(&ga, ']');
6437 ga_append(&ga, NUL);
6438 return (char_u *)ga.ga_data;
6442 * Join list "l" into a string in "*gap", using separator "sep".
6443 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6444 * Return FAIL or OK.
6446 static int
6447 list_join(gap, l, sep, echo, copyID)
6448 garray_T *gap;
6449 list_T *l;
6450 char_u *sep;
6451 int echo;
6452 int copyID;
6454 int first = TRUE;
6455 char_u *tofree;
6456 char_u numbuf[NUMBUFLEN];
6457 listitem_T *item;
6458 char_u *s;
6460 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6462 if (first)
6463 first = FALSE;
6464 else
6465 ga_concat(gap, sep);
6467 if (echo)
6468 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6469 else
6470 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6471 if (s != NULL)
6472 ga_concat(gap, s);
6473 vim_free(tofree);
6474 if (s == NULL)
6475 return FAIL;
6476 line_breakcheck();
6478 return OK;
6482 * Garbage collection for lists and dictionaries.
6484 * We use reference counts to be able to free most items right away when they
6485 * are no longer used. But for composite items it's possible that it becomes
6486 * unused while the reference count is > 0: When there is a recursive
6487 * reference. Example:
6488 * :let l = [1, 2, 3]
6489 * :let d = {9: l}
6490 * :let l[1] = d
6492 * Since this is quite unusual we handle this with garbage collection: every
6493 * once in a while find out which lists and dicts are not referenced from any
6494 * variable.
6496 * Here is a good reference text about garbage collection (refers to Python
6497 * but it applies to all reference-counting mechanisms):
6498 * http://python.ca/nas/python/gc/
6502 * Do garbage collection for lists and dicts.
6503 * Return TRUE if some memory was freed.
6506 garbage_collect()
6508 int copyID;
6509 buf_T *buf;
6510 win_T *wp;
6511 int i;
6512 funccall_T *fc, **pfc;
6513 int did_free;
6514 int did_free_funccal = FALSE;
6515 #ifdef FEAT_WINDOWS
6516 tabpage_T *tp;
6517 #endif
6519 /* Only do this once. */
6520 want_garbage_collect = FALSE;
6521 may_garbage_collect = FALSE;
6522 garbage_collect_at_exit = FALSE;
6524 /* We advance by two because we add one for items referenced through
6525 * previous_funccal. */
6526 current_copyID += COPYID_INC;
6527 copyID = current_copyID;
6530 * 1. Go through all accessible variables and mark all lists and dicts
6531 * with copyID.
6534 /* Don't free variables in the previous_funccal list unless they are only
6535 * referenced through previous_funccal. This must be first, because if
6536 * the item is referenced elsewhere the funccal must not be freed. */
6537 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6539 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6540 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6543 /* script-local variables */
6544 for (i = 1; i <= ga_scripts.ga_len; ++i)
6545 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6547 /* buffer-local variables */
6548 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6549 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6551 /* window-local variables */
6552 FOR_ALL_TAB_WINDOWS(tp, wp)
6553 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6555 #ifdef FEAT_WINDOWS
6556 /* tabpage-local variables */
6557 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6558 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6559 #endif
6561 /* global variables */
6562 set_ref_in_ht(&globvarht, copyID);
6564 /* function-local variables */
6565 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6567 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6568 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6571 /* v: vars */
6572 set_ref_in_ht(&vimvarht, copyID);
6575 * 2. Free lists and dictionaries that are not referenced.
6577 did_free = free_unref_items(copyID);
6580 * 3. Check if any funccal can be freed now.
6582 for (pfc = &previous_funccal; *pfc != NULL; )
6584 if (can_free_funccal(*pfc, copyID))
6586 fc = *pfc;
6587 *pfc = fc->caller;
6588 free_funccal(fc, TRUE);
6589 did_free = TRUE;
6590 did_free_funccal = TRUE;
6592 else
6593 pfc = &(*pfc)->caller;
6595 if (did_free_funccal)
6596 /* When a funccal was freed some more items might be garbage
6597 * collected, so run again. */
6598 (void)garbage_collect();
6600 return did_free;
6604 * Free lists and dictionaries that are no longer referenced.
6606 static int
6607 free_unref_items(copyID)
6608 int copyID;
6610 dict_T *dd;
6611 list_T *ll;
6612 int did_free = FALSE;
6615 * Go through the list of dicts and free items without the copyID.
6617 for (dd = first_dict; dd != NULL; )
6618 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6620 /* Free the Dictionary and ordinary items it contains, but don't
6621 * recurse into Lists and Dictionaries, they will be in the list
6622 * of dicts or list of lists. */
6623 dict_free(dd, FALSE);
6624 did_free = TRUE;
6626 /* restart, next dict may also have been freed */
6627 dd = first_dict;
6629 else
6630 dd = dd->dv_used_next;
6633 * Go through the list of lists and free items without the copyID.
6634 * But don't free a list that has a watcher (used in a for loop), these
6635 * are not referenced anywhere.
6637 for (ll = first_list; ll != NULL; )
6638 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6639 && ll->lv_watch == NULL)
6641 /* Free the List and ordinary items it contains, but don't recurse
6642 * into Lists and Dictionaries, they will be in the list of dicts
6643 * or list of lists. */
6644 list_free(ll, FALSE);
6645 did_free = TRUE;
6647 /* restart, next list may also have been freed */
6648 ll = first_list;
6650 else
6651 ll = ll->lv_used_next;
6653 return did_free;
6657 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6659 static void
6660 set_ref_in_ht(ht, copyID)
6661 hashtab_T *ht;
6662 int copyID;
6664 int todo;
6665 hashitem_T *hi;
6667 todo = (int)ht->ht_used;
6668 for (hi = ht->ht_array; todo > 0; ++hi)
6669 if (!HASHITEM_EMPTY(hi))
6671 --todo;
6672 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6677 * Mark all lists and dicts referenced through list "l" with "copyID".
6679 static void
6680 set_ref_in_list(l, copyID)
6681 list_T *l;
6682 int copyID;
6684 listitem_T *li;
6686 for (li = l->lv_first; li != NULL; li = li->li_next)
6687 set_ref_in_item(&li->li_tv, copyID);
6691 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6693 static void
6694 set_ref_in_item(tv, copyID)
6695 typval_T *tv;
6696 int copyID;
6698 dict_T *dd;
6699 list_T *ll;
6701 switch (tv->v_type)
6703 case VAR_DICT:
6704 dd = tv->vval.v_dict;
6705 if (dd != NULL && dd->dv_copyID != copyID)
6707 /* Didn't see this dict yet. */
6708 dd->dv_copyID = copyID;
6709 set_ref_in_ht(&dd->dv_hashtab, copyID);
6711 break;
6713 case VAR_LIST:
6714 ll = tv->vval.v_list;
6715 if (ll != NULL && ll->lv_copyID != copyID)
6717 /* Didn't see this list yet. */
6718 ll->lv_copyID = copyID;
6719 set_ref_in_list(ll, copyID);
6721 break;
6723 return;
6727 * Allocate an empty header for a dictionary.
6729 dict_T *
6730 dict_alloc()
6732 dict_T *d;
6734 d = (dict_T *)alloc(sizeof(dict_T));
6735 if (d != NULL)
6737 /* Add the list to the list of dicts for garbage collection. */
6738 if (first_dict != NULL)
6739 first_dict->dv_used_prev = d;
6740 d->dv_used_next = first_dict;
6741 d->dv_used_prev = NULL;
6742 first_dict = d;
6744 hash_init(&d->dv_hashtab);
6745 d->dv_lock = 0;
6746 d->dv_refcount = 0;
6747 d->dv_copyID = 0;
6749 return d;
6753 * Unreference a Dictionary: decrement the reference count and free it when it
6754 * becomes zero.
6756 static void
6757 dict_unref(d)
6758 dict_T *d;
6760 if (d != NULL && --d->dv_refcount <= 0)
6761 dict_free(d, TRUE);
6765 * Free a Dictionary, including all items it contains.
6766 * Ignores the reference count.
6768 static void
6769 dict_free(d, recurse)
6770 dict_T *d;
6771 int recurse; /* Free Lists and Dictionaries recursively. */
6773 int todo;
6774 hashitem_T *hi;
6775 dictitem_T *di;
6777 /* Remove the dict from the list of dicts for garbage collection. */
6778 if (d->dv_used_prev == NULL)
6779 first_dict = d->dv_used_next;
6780 else
6781 d->dv_used_prev->dv_used_next = d->dv_used_next;
6782 if (d->dv_used_next != NULL)
6783 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6785 /* Lock the hashtab, we don't want it to resize while freeing items. */
6786 hash_lock(&d->dv_hashtab);
6787 todo = (int)d->dv_hashtab.ht_used;
6788 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6790 if (!HASHITEM_EMPTY(hi))
6792 /* Remove the item before deleting it, just in case there is
6793 * something recursive causing trouble. */
6794 di = HI2DI(hi);
6795 hash_remove(&d->dv_hashtab, hi);
6796 if (recurse || (di->di_tv.v_type != VAR_LIST
6797 && di->di_tv.v_type != VAR_DICT))
6798 clear_tv(&di->di_tv);
6799 vim_free(di);
6800 --todo;
6803 hash_clear(&d->dv_hashtab);
6804 vim_free(d);
6808 * Allocate a Dictionary item.
6809 * The "key" is copied to the new item.
6810 * Note that the value of the item "di_tv" still needs to be initialized!
6811 * Returns NULL when out of memory.
6813 dictitem_T *
6814 dictitem_alloc(key)
6815 char_u *key;
6817 dictitem_T *di;
6819 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6820 if (di != NULL)
6822 STRCPY(di->di_key, key);
6823 di->di_flags = 0;
6825 return di;
6829 * Make a copy of a Dictionary item.
6831 static dictitem_T *
6832 dictitem_copy(org)
6833 dictitem_T *org;
6835 dictitem_T *di;
6837 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6838 + STRLEN(org->di_key)));
6839 if (di != NULL)
6841 STRCPY(di->di_key, org->di_key);
6842 di->di_flags = 0;
6843 copy_tv(&org->di_tv, &di->di_tv);
6845 return di;
6849 * Remove item "item" from Dictionary "dict" and free it.
6851 static void
6852 dictitem_remove(dict, item)
6853 dict_T *dict;
6854 dictitem_T *item;
6856 hashitem_T *hi;
6858 hi = hash_find(&dict->dv_hashtab, item->di_key);
6859 if (HASHITEM_EMPTY(hi))
6860 EMSG2(_(e_intern2), "dictitem_remove()");
6861 else
6862 hash_remove(&dict->dv_hashtab, hi);
6863 dictitem_free(item);
6867 * Free a dict item. Also clears the value.
6869 void
6870 dictitem_free(item)
6871 dictitem_T *item;
6873 clear_tv(&item->di_tv);
6874 vim_free(item);
6878 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6879 * The refcount of the new dict is set to 1.
6880 * See item_copy() for "copyID".
6881 * Returns NULL when out of memory.
6883 static dict_T *
6884 dict_copy(orig, deep, copyID)
6885 dict_T *orig;
6886 int deep;
6887 int copyID;
6889 dict_T *copy;
6890 dictitem_T *di;
6891 int todo;
6892 hashitem_T *hi;
6894 if (orig == NULL)
6895 return NULL;
6897 copy = dict_alloc();
6898 if (copy != NULL)
6900 if (copyID != 0)
6902 orig->dv_copyID = copyID;
6903 orig->dv_copydict = copy;
6905 todo = (int)orig->dv_hashtab.ht_used;
6906 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6908 if (!HASHITEM_EMPTY(hi))
6910 --todo;
6912 di = dictitem_alloc(hi->hi_key);
6913 if (di == NULL)
6914 break;
6915 if (deep)
6917 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6918 copyID) == FAIL)
6920 vim_free(di);
6921 break;
6924 else
6925 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6926 if (dict_add(copy, di) == FAIL)
6928 dictitem_free(di);
6929 break;
6934 ++copy->dv_refcount;
6935 if (todo > 0)
6937 dict_unref(copy);
6938 copy = NULL;
6942 return copy;
6946 * Add item "item" to Dictionary "d".
6947 * Returns FAIL when out of memory and when key already existed.
6950 dict_add(d, item)
6951 dict_T *d;
6952 dictitem_T *item;
6954 return hash_add(&d->dv_hashtab, item->di_key);
6958 * Add a number or string entry to dictionary "d".
6959 * When "str" is NULL use number "nr", otherwise use "str".
6960 * Returns FAIL when out of memory and when key already exists.
6963 dict_add_nr_str(d, key, nr, str)
6964 dict_T *d;
6965 char *key;
6966 long nr;
6967 char_u *str;
6969 dictitem_T *item;
6971 item = dictitem_alloc((char_u *)key);
6972 if (item == NULL)
6973 return FAIL;
6974 item->di_tv.v_lock = 0;
6975 if (str == NULL)
6977 item->di_tv.v_type = VAR_NUMBER;
6978 item->di_tv.vval.v_number = nr;
6980 else
6982 item->di_tv.v_type = VAR_STRING;
6983 item->di_tv.vval.v_string = vim_strsave(str);
6985 if (dict_add(d, item) == FAIL)
6987 dictitem_free(item);
6988 return FAIL;
6990 return OK;
6994 * Get the number of items in a Dictionary.
6996 static long
6997 dict_len(d)
6998 dict_T *d;
7000 if (d == NULL)
7001 return 0L;
7002 return (long)d->dv_hashtab.ht_used;
7006 * Find item "key[len]" in Dictionary "d".
7007 * If "len" is negative use strlen(key).
7008 * Returns NULL when not found.
7010 static dictitem_T *
7011 dict_find(d, key, len)
7012 dict_T *d;
7013 char_u *key;
7014 int len;
7016 #define AKEYLEN 200
7017 char_u buf[AKEYLEN];
7018 char_u *akey;
7019 char_u *tofree = NULL;
7020 hashitem_T *hi;
7022 if (len < 0)
7023 akey = key;
7024 else if (len >= AKEYLEN)
7026 tofree = akey = vim_strnsave(key, len);
7027 if (akey == NULL)
7028 return NULL;
7030 else
7032 /* Avoid a malloc/free by using buf[]. */
7033 vim_strncpy(buf, key, len);
7034 akey = buf;
7037 hi = hash_find(&d->dv_hashtab, akey);
7038 vim_free(tofree);
7039 if (HASHITEM_EMPTY(hi))
7040 return NULL;
7041 return HI2DI(hi);
7045 * Get a string item from a dictionary.
7046 * When "save" is TRUE allocate memory for it.
7047 * Returns NULL if the entry doesn't exist or out of memory.
7049 char_u *
7050 get_dict_string(d, key, save)
7051 dict_T *d;
7052 char_u *key;
7053 int save;
7055 dictitem_T *di;
7056 char_u *s;
7058 di = dict_find(d, key, -1);
7059 if (di == NULL)
7060 return NULL;
7061 s = get_tv_string(&di->di_tv);
7062 if (save && s != NULL)
7063 s = vim_strsave(s);
7064 return s;
7068 * Get a number item from a dictionary.
7069 * Returns 0 if the entry doesn't exist or out of memory.
7071 long
7072 get_dict_number(d, key)
7073 dict_T *d;
7074 char_u *key;
7076 dictitem_T *di;
7078 di = dict_find(d, key, -1);
7079 if (di == NULL)
7080 return 0;
7081 return get_tv_number(&di->di_tv);
7085 * Return an allocated string with the string representation of a Dictionary.
7086 * May return NULL.
7088 static char_u *
7089 dict2string(tv, copyID)
7090 typval_T *tv;
7091 int copyID;
7093 garray_T ga;
7094 int first = TRUE;
7095 char_u *tofree;
7096 char_u numbuf[NUMBUFLEN];
7097 hashitem_T *hi;
7098 char_u *s;
7099 dict_T *d;
7100 int todo;
7102 if ((d = tv->vval.v_dict) == NULL)
7103 return NULL;
7104 ga_init2(&ga, (int)sizeof(char), 80);
7105 ga_append(&ga, '{');
7107 todo = (int)d->dv_hashtab.ht_used;
7108 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7110 if (!HASHITEM_EMPTY(hi))
7112 --todo;
7114 if (first)
7115 first = FALSE;
7116 else
7117 ga_concat(&ga, (char_u *)", ");
7119 tofree = string_quote(hi->hi_key, FALSE);
7120 if (tofree != NULL)
7122 ga_concat(&ga, tofree);
7123 vim_free(tofree);
7125 ga_concat(&ga, (char_u *)": ");
7126 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7127 if (s != NULL)
7128 ga_concat(&ga, s);
7129 vim_free(tofree);
7130 if (s == NULL)
7131 break;
7134 if (todo > 0)
7136 vim_free(ga.ga_data);
7137 return NULL;
7140 ga_append(&ga, '}');
7141 ga_append(&ga, NUL);
7142 return (char_u *)ga.ga_data;
7146 * Allocate a variable for a Dictionary and fill it from "*arg".
7147 * Return OK or FAIL. Returns NOTDONE for {expr}.
7149 static int
7150 get_dict_tv(arg, rettv, evaluate)
7151 char_u **arg;
7152 typval_T *rettv;
7153 int evaluate;
7155 dict_T *d = NULL;
7156 typval_T tvkey;
7157 typval_T tv;
7158 char_u *key = NULL;
7159 dictitem_T *item;
7160 char_u *start = skipwhite(*arg + 1);
7161 char_u buf[NUMBUFLEN];
7164 * First check if it's not a curly-braces thing: {expr}.
7165 * Must do this without evaluating, otherwise a function may be called
7166 * twice. Unfortunately this means we need to call eval1() twice for the
7167 * first item.
7168 * But {} is an empty Dictionary.
7170 if (*start != '}')
7172 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7173 return FAIL;
7174 if (*start == '}')
7175 return NOTDONE;
7178 if (evaluate)
7180 d = dict_alloc();
7181 if (d == NULL)
7182 return FAIL;
7184 tvkey.v_type = VAR_UNKNOWN;
7185 tv.v_type = VAR_UNKNOWN;
7187 *arg = skipwhite(*arg + 1);
7188 while (**arg != '}' && **arg != NUL)
7190 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7191 goto failret;
7192 if (**arg != ':')
7194 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7195 clear_tv(&tvkey);
7196 goto failret;
7198 if (evaluate)
7200 key = get_tv_string_buf_chk(&tvkey, buf);
7201 if (key == NULL || *key == NUL)
7203 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7204 if (key != NULL)
7205 EMSG(_(e_emptykey));
7206 clear_tv(&tvkey);
7207 goto failret;
7211 *arg = skipwhite(*arg + 1);
7212 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7214 if (evaluate)
7215 clear_tv(&tvkey);
7216 goto failret;
7218 if (evaluate)
7220 item = dict_find(d, key, -1);
7221 if (item != NULL)
7223 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7224 clear_tv(&tvkey);
7225 clear_tv(&tv);
7226 goto failret;
7228 item = dictitem_alloc(key);
7229 clear_tv(&tvkey);
7230 if (item != NULL)
7232 item->di_tv = tv;
7233 item->di_tv.v_lock = 0;
7234 if (dict_add(d, item) == FAIL)
7235 dictitem_free(item);
7239 if (**arg == '}')
7240 break;
7241 if (**arg != ',')
7243 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7244 goto failret;
7246 *arg = skipwhite(*arg + 1);
7249 if (**arg != '}')
7251 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7252 failret:
7253 if (evaluate)
7254 dict_free(d, TRUE);
7255 return FAIL;
7258 *arg = skipwhite(*arg + 1);
7259 if (evaluate)
7261 rettv->v_type = VAR_DICT;
7262 rettv->vval.v_dict = d;
7263 ++d->dv_refcount;
7266 return OK;
7270 * Return a string with the string representation of a variable.
7271 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7272 * "numbuf" is used for a number.
7273 * Does not put quotes around strings, as ":echo" displays values.
7274 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7275 * May return NULL.
7277 static char_u *
7278 echo_string(tv, tofree, numbuf, copyID)
7279 typval_T *tv;
7280 char_u **tofree;
7281 char_u *numbuf;
7282 int copyID;
7284 static int recurse = 0;
7285 char_u *r = NULL;
7287 if (recurse >= DICT_MAXNEST)
7289 EMSG(_("E724: variable nested too deep for displaying"));
7290 *tofree = NULL;
7291 return NULL;
7293 ++recurse;
7295 switch (tv->v_type)
7297 case VAR_FUNC:
7298 *tofree = NULL;
7299 r = tv->vval.v_string;
7300 break;
7302 case VAR_LIST:
7303 if (tv->vval.v_list == NULL)
7305 *tofree = NULL;
7306 r = NULL;
7308 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7310 *tofree = NULL;
7311 r = (char_u *)"[...]";
7313 else
7315 tv->vval.v_list->lv_copyID = copyID;
7316 *tofree = list2string(tv, copyID);
7317 r = *tofree;
7319 break;
7321 case VAR_DICT:
7322 if (tv->vval.v_dict == NULL)
7324 *tofree = NULL;
7325 r = NULL;
7327 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7329 *tofree = NULL;
7330 r = (char_u *)"{...}";
7332 else
7334 tv->vval.v_dict->dv_copyID = copyID;
7335 *tofree = dict2string(tv, copyID);
7336 r = *tofree;
7338 break;
7340 case VAR_STRING:
7341 case VAR_NUMBER:
7342 *tofree = NULL;
7343 r = get_tv_string_buf(tv, numbuf);
7344 break;
7346 #ifdef FEAT_FLOAT
7347 case VAR_FLOAT:
7348 *tofree = NULL;
7349 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7350 r = numbuf;
7351 break;
7352 #endif
7354 default:
7355 EMSG2(_(e_intern2), "echo_string()");
7356 *tofree = NULL;
7359 --recurse;
7360 return r;
7364 * Return a string with the string representation of a variable.
7365 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7366 * "numbuf" is used for a number.
7367 * Puts quotes around strings, so that they can be parsed back by eval().
7368 * May return NULL.
7370 static char_u *
7371 tv2string(tv, tofree, numbuf, copyID)
7372 typval_T *tv;
7373 char_u **tofree;
7374 char_u *numbuf;
7375 int copyID;
7377 switch (tv->v_type)
7379 case VAR_FUNC:
7380 *tofree = string_quote(tv->vval.v_string, TRUE);
7381 return *tofree;
7382 case VAR_STRING:
7383 *tofree = string_quote(tv->vval.v_string, FALSE);
7384 return *tofree;
7385 #ifdef FEAT_FLOAT
7386 case VAR_FLOAT:
7387 *tofree = NULL;
7388 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7389 return numbuf;
7390 #endif
7391 case VAR_NUMBER:
7392 case VAR_LIST:
7393 case VAR_DICT:
7394 break;
7395 default:
7396 EMSG2(_(e_intern2), "tv2string()");
7398 return echo_string(tv, tofree, numbuf, copyID);
7402 * Return string "str" in ' quotes, doubling ' characters.
7403 * If "str" is NULL an empty string is assumed.
7404 * If "function" is TRUE make it function('string').
7406 static char_u *
7407 string_quote(str, function)
7408 char_u *str;
7409 int function;
7411 unsigned len;
7412 char_u *p, *r, *s;
7414 len = (function ? 13 : 3);
7415 if (str != NULL)
7417 len += (unsigned)STRLEN(str);
7418 for (p = str; *p != NUL; mb_ptr_adv(p))
7419 if (*p == '\'')
7420 ++len;
7422 s = r = alloc(len);
7423 if (r != NULL)
7425 if (function)
7427 STRCPY(r, "function('");
7428 r += 10;
7430 else
7431 *r++ = '\'';
7432 if (str != NULL)
7433 for (p = str; *p != NUL; )
7435 if (*p == '\'')
7436 *r++ = '\'';
7437 MB_COPY_CHAR(p, r);
7439 *r++ = '\'';
7440 if (function)
7441 *r++ = ')';
7442 *r++ = NUL;
7444 return s;
7447 #ifdef FEAT_FLOAT
7449 * Convert the string "text" to a floating point number.
7450 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7451 * this always uses a decimal point.
7452 * Returns the length of the text that was consumed.
7454 static int
7455 string2float(text, value)
7456 char_u *text;
7457 float_T *value; /* result stored here */
7459 char *s = (char *)text;
7460 float_T f;
7462 f = strtod(s, &s);
7463 *value = f;
7464 return (int)((char_u *)s - text);
7466 #endif
7469 * Get the value of an environment variable.
7470 * "arg" is pointing to the '$'. It is advanced to after the name.
7471 * If the environment variable was not set, silently assume it is empty.
7472 * Always return OK.
7474 static int
7475 get_env_tv(arg, rettv, evaluate)
7476 char_u **arg;
7477 typval_T *rettv;
7478 int evaluate;
7480 char_u *string = NULL;
7481 int len;
7482 int cc;
7483 char_u *name;
7484 int mustfree = FALSE;
7486 ++*arg;
7487 name = *arg;
7488 len = get_env_len(arg);
7489 if (evaluate)
7491 if (len != 0)
7493 cc = name[len];
7494 name[len] = NUL;
7495 /* first try vim_getenv(), fast for normal environment vars */
7496 string = vim_getenv(name, &mustfree);
7497 if (string != NULL && *string != NUL)
7499 if (!mustfree)
7500 string = vim_strsave(string);
7502 else
7504 if (mustfree)
7505 vim_free(string);
7507 /* next try expanding things like $VIM and ${HOME} */
7508 string = expand_env_save(name - 1);
7509 if (string != NULL && *string == '$')
7511 vim_free(string);
7512 string = NULL;
7515 name[len] = cc;
7517 rettv->v_type = VAR_STRING;
7518 rettv->vval.v_string = string;
7521 return OK;
7525 * Array with names and number of arguments of all internal functions
7526 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7528 static struct fst
7530 char *f_name; /* function name */
7531 char f_min_argc; /* minimal number of arguments */
7532 char f_max_argc; /* maximal number of arguments */
7533 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7534 /* implementation of function */
7535 } functions[] =
7537 #ifdef FEAT_FLOAT
7538 {"abs", 1, 1, f_abs},
7539 #endif
7540 {"add", 2, 2, f_add},
7541 {"append", 2, 2, f_append},
7542 {"argc", 0, 0, f_argc},
7543 {"argidx", 0, 0, f_argidx},
7544 {"argv", 0, 1, f_argv},
7545 #ifdef FEAT_FLOAT
7546 {"atan", 1, 1, f_atan},
7547 #endif
7548 {"browse", 4, 4, f_browse},
7549 {"browsedir", 2, 2, f_browsedir},
7550 {"bufexists", 1, 1, f_bufexists},
7551 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7552 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7553 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7554 {"buflisted", 1, 1, f_buflisted},
7555 {"bufloaded", 1, 1, f_bufloaded},
7556 {"bufname", 1, 1, f_bufname},
7557 {"bufnr", 1, 2, f_bufnr},
7558 {"bufwinnr", 1, 1, f_bufwinnr},
7559 {"byte2line", 1, 1, f_byte2line},
7560 {"byteidx", 2, 2, f_byteidx},
7561 {"call", 2, 3, f_call},
7562 #ifdef FEAT_FLOAT
7563 {"ceil", 1, 1, f_ceil},
7564 #endif
7565 {"changenr", 0, 0, f_changenr},
7566 {"char2nr", 1, 1, f_char2nr},
7567 {"cindent", 1, 1, f_cindent},
7568 {"clearmatches", 0, 0, f_clearmatches},
7569 {"col", 1, 1, f_col},
7570 #if defined(FEAT_INS_EXPAND)
7571 {"complete", 2, 2, f_complete},
7572 {"complete_add", 1, 1, f_complete_add},
7573 {"complete_check", 0, 0, f_complete_check},
7574 #endif
7575 {"confirm", 1, 4, f_confirm},
7576 {"copy", 1, 1, f_copy},
7577 #ifdef FEAT_FLOAT
7578 {"cos", 1, 1, f_cos},
7579 #endif
7580 {"count", 2, 4, f_count},
7581 {"cscope_connection",0,3, f_cscope_connection},
7582 {"cursor", 1, 3, f_cursor},
7583 {"deepcopy", 1, 2, f_deepcopy},
7584 {"delete", 1, 1, f_delete},
7585 {"did_filetype", 0, 0, f_did_filetype},
7586 {"diff_filler", 1, 1, f_diff_filler},
7587 {"diff_hlID", 2, 2, f_diff_hlID},
7588 {"empty", 1, 1, f_empty},
7589 {"escape", 2, 2, f_escape},
7590 {"eval", 1, 1, f_eval},
7591 {"eventhandler", 0, 0, f_eventhandler},
7592 {"executable", 1, 1, f_executable},
7593 {"exists", 1, 1, f_exists},
7594 {"expand", 1, 2, f_expand},
7595 {"extend", 2, 3, f_extend},
7596 {"feedkeys", 1, 2, f_feedkeys},
7597 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7598 {"filereadable", 1, 1, f_filereadable},
7599 {"filewritable", 1, 1, f_filewritable},
7600 {"filter", 2, 2, f_filter},
7601 {"finddir", 1, 3, f_finddir},
7602 {"findfile", 1, 3, f_findfile},
7603 #ifdef FEAT_FLOAT
7604 {"float2nr", 1, 1, f_float2nr},
7605 {"floor", 1, 1, f_floor},
7606 #endif
7607 {"fnameescape", 1, 1, f_fnameescape},
7608 {"fnamemodify", 2, 2, f_fnamemodify},
7609 {"foldclosed", 1, 1, f_foldclosed},
7610 {"foldclosedend", 1, 1, f_foldclosedend},
7611 {"foldlevel", 1, 1, f_foldlevel},
7612 {"foldtext", 0, 0, f_foldtext},
7613 {"foldtextresult", 1, 1, f_foldtextresult},
7614 {"foreground", 0, 0, f_foreground},
7615 {"function", 1, 1, f_function},
7616 {"garbagecollect", 0, 1, f_garbagecollect},
7617 {"get", 2, 3, f_get},
7618 {"getbufline", 2, 3, f_getbufline},
7619 {"getbufvar", 2, 2, f_getbufvar},
7620 {"getchar", 0, 1, f_getchar},
7621 {"getcharmod", 0, 0, f_getcharmod},
7622 {"getcmdline", 0, 0, f_getcmdline},
7623 {"getcmdpos", 0, 0, f_getcmdpos},
7624 {"getcmdtype", 0, 0, f_getcmdtype},
7625 {"getcwd", 0, 0, f_getcwd},
7626 {"getfontname", 0, 1, f_getfontname},
7627 {"getfperm", 1, 1, f_getfperm},
7628 {"getfsize", 1, 1, f_getfsize},
7629 {"getftime", 1, 1, f_getftime},
7630 {"getftype", 1, 1, f_getftype},
7631 {"getline", 1, 2, f_getline},
7632 {"getloclist", 1, 1, f_getqflist},
7633 {"getmatches", 0, 0, f_getmatches},
7634 {"getpid", 0, 0, f_getpid},
7635 {"getpos", 1, 1, f_getpos},
7636 {"getqflist", 0, 0, f_getqflist},
7637 {"getreg", 0, 2, f_getreg},
7638 {"getregtype", 0, 1, f_getregtype},
7639 {"gettabwinvar", 3, 3, f_gettabwinvar},
7640 {"getwinposx", 0, 0, f_getwinposx},
7641 {"getwinposy", 0, 0, f_getwinposy},
7642 {"getwinvar", 2, 2, f_getwinvar},
7643 {"glob", 1, 2, f_glob},
7644 {"globpath", 2, 3, f_globpath},
7645 {"has", 1, 1, f_has},
7646 {"has_key", 2, 2, f_has_key},
7647 {"haslocaldir", 0, 0, f_haslocaldir},
7648 {"hasmapto", 1, 3, f_hasmapto},
7649 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7650 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7651 {"histadd", 2, 2, f_histadd},
7652 {"histdel", 1, 2, f_histdel},
7653 {"histget", 1, 2, f_histget},
7654 {"histnr", 1, 1, f_histnr},
7655 {"hlID", 1, 1, f_hlID},
7656 {"hlexists", 1, 1, f_hlexists},
7657 {"hostname", 0, 0, f_hostname},
7658 {"iconv", 3, 3, f_iconv},
7659 {"indent", 1, 1, f_indent},
7660 {"index", 2, 4, f_index},
7661 {"input", 1, 3, f_input},
7662 {"inputdialog", 1, 3, f_inputdialog},
7663 {"inputlist", 1, 1, f_inputlist},
7664 {"inputrestore", 0, 0, f_inputrestore},
7665 {"inputsave", 0, 0, f_inputsave},
7666 {"inputsecret", 1, 2, f_inputsecret},
7667 {"insert", 2, 3, f_insert},
7668 {"isdirectory", 1, 1, f_isdirectory},
7669 {"islocked", 1, 1, f_islocked},
7670 {"items", 1, 1, f_items},
7671 {"join", 1, 2, f_join},
7672 {"keys", 1, 1, f_keys},
7673 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7674 {"len", 1, 1, f_len},
7675 {"libcall", 3, 3, f_libcall},
7676 {"libcallnr", 3, 3, f_libcallnr},
7677 {"line", 1, 1, f_line},
7678 {"line2byte", 1, 1, f_line2byte},
7679 {"lispindent", 1, 1, f_lispindent},
7680 {"localtime", 0, 0, f_localtime},
7681 #ifdef FEAT_FLOAT
7682 {"log10", 1, 1, f_log10},
7683 #endif
7684 {"map", 2, 2, f_map},
7685 {"maparg", 1, 3, f_maparg},
7686 {"mapcheck", 1, 3, f_mapcheck},
7687 {"match", 2, 4, f_match},
7688 {"matchadd", 2, 4, f_matchadd},
7689 {"matcharg", 1, 1, f_matcharg},
7690 {"matchdelete", 1, 1, f_matchdelete},
7691 {"matchend", 2, 4, f_matchend},
7692 {"matchlist", 2, 4, f_matchlist},
7693 {"matchstr", 2, 4, f_matchstr},
7694 {"max", 1, 1, f_max},
7695 {"min", 1, 1, f_min},
7696 #ifdef vim_mkdir
7697 {"mkdir", 1, 3, f_mkdir},
7698 #endif
7699 {"mode", 0, 1, f_mode},
7700 #ifdef FEAT_MZSCHEME
7701 {"mzeval", 1, 1, f_mzeval},
7702 #endif
7703 {"nextnonblank", 1, 1, f_nextnonblank},
7704 {"nr2char", 1, 1, f_nr2char},
7705 {"pathshorten", 1, 1, f_pathshorten},
7706 #ifdef FEAT_FLOAT
7707 {"pow", 2, 2, f_pow},
7708 #endif
7709 {"prevnonblank", 1, 1, f_prevnonblank},
7710 {"printf", 2, 19, f_printf},
7711 {"pumvisible", 0, 0, f_pumvisible},
7712 {"range", 1, 3, f_range},
7713 {"readfile", 1, 3, f_readfile},
7714 {"reltime", 0, 2, f_reltime},
7715 {"reltimestr", 1, 1, f_reltimestr},
7716 {"remote_expr", 2, 3, f_remote_expr},
7717 {"remote_foreground", 1, 1, f_remote_foreground},
7718 {"remote_peek", 1, 2, f_remote_peek},
7719 {"remote_read", 1, 1, f_remote_read},
7720 {"remote_send", 2, 3, f_remote_send},
7721 {"remove", 2, 3, f_remove},
7722 {"rename", 2, 2, f_rename},
7723 {"repeat", 2, 2, f_repeat},
7724 {"resolve", 1, 1, f_resolve},
7725 {"reverse", 1, 1, f_reverse},
7726 #ifdef FEAT_FLOAT
7727 {"round", 1, 1, f_round},
7728 #endif
7729 {"search", 1, 4, f_search},
7730 {"searchdecl", 1, 3, f_searchdecl},
7731 {"searchpair", 3, 7, f_searchpair},
7732 {"searchpairpos", 3, 7, f_searchpairpos},
7733 {"searchpos", 1, 4, f_searchpos},
7734 {"server2client", 2, 2, f_server2client},
7735 {"serverlist", 0, 0, f_serverlist},
7736 {"setbufvar", 3, 3, f_setbufvar},
7737 {"setcmdpos", 1, 1, f_setcmdpos},
7738 {"setline", 2, 2, f_setline},
7739 {"setloclist", 2, 3, f_setloclist},
7740 {"setmatches", 1, 1, f_setmatches},
7741 {"setpos", 2, 2, f_setpos},
7742 {"setqflist", 1, 2, f_setqflist},
7743 {"setreg", 2, 3, f_setreg},
7744 {"settabwinvar", 4, 4, f_settabwinvar},
7745 {"setwinvar", 3, 3, f_setwinvar},
7746 {"shellescape", 1, 2, f_shellescape},
7747 {"simplify", 1, 1, f_simplify},
7748 #ifdef FEAT_FLOAT
7749 {"sin", 1, 1, f_sin},
7750 #endif
7751 {"sort", 1, 2, f_sort},
7752 {"soundfold", 1, 1, f_soundfold},
7753 {"spellbadword", 0, 1, f_spellbadword},
7754 {"spellsuggest", 1, 3, f_spellsuggest},
7755 {"split", 1, 3, f_split},
7756 #ifdef FEAT_FLOAT
7757 {"sqrt", 1, 1, f_sqrt},
7758 {"str2float", 1, 1, f_str2float},
7759 #endif
7760 {"str2nr", 1, 2, f_str2nr},
7761 #ifdef HAVE_STRFTIME
7762 {"strftime", 1, 2, f_strftime},
7763 #endif
7764 {"stridx", 2, 3, f_stridx},
7765 {"string", 1, 1, f_string},
7766 {"strlen", 1, 1, f_strlen},
7767 {"strpart", 2, 3, f_strpart},
7768 {"strridx", 2, 3, f_strridx},
7769 {"strtrans", 1, 1, f_strtrans},
7770 {"submatch", 1, 1, f_submatch},
7771 {"substitute", 4, 4, f_substitute},
7772 {"synID", 3, 3, f_synID},
7773 {"synIDattr", 2, 3, f_synIDattr},
7774 {"synIDtrans", 1, 1, f_synIDtrans},
7775 {"synstack", 2, 2, f_synstack},
7776 {"system", 1, 2, f_system},
7777 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7778 {"tabpagenr", 0, 1, f_tabpagenr},
7779 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7780 {"tagfiles", 0, 0, f_tagfiles},
7781 {"taglist", 1, 1, f_taglist},
7782 {"tempname", 0, 0, f_tempname},
7783 {"test", 1, 1, f_test},
7784 {"tolower", 1, 1, f_tolower},
7785 {"toupper", 1, 1, f_toupper},
7786 {"tr", 3, 3, f_tr},
7787 #ifdef FEAT_FLOAT
7788 {"trunc", 1, 1, f_trunc},
7789 #endif
7790 {"type", 1, 1, f_type},
7791 {"values", 1, 1, f_values},
7792 {"virtcol", 1, 1, f_virtcol},
7793 {"visualmode", 0, 1, f_visualmode},
7794 {"winbufnr", 1, 1, f_winbufnr},
7795 {"wincol", 0, 0, f_wincol},
7796 {"winheight", 1, 1, f_winheight},
7797 {"winline", 0, 0, f_winline},
7798 {"winnr", 0, 1, f_winnr},
7799 {"winrestcmd", 0, 0, f_winrestcmd},
7800 {"winrestview", 1, 1, f_winrestview},
7801 {"winsaveview", 0, 0, f_winsaveview},
7802 {"winwidth", 1, 1, f_winwidth},
7803 {"writefile", 2, 3, f_writefile},
7806 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7809 * Function given to ExpandGeneric() to obtain the list of internal
7810 * or user defined function names.
7812 char_u *
7813 get_function_name(xp, idx)
7814 expand_T *xp;
7815 int idx;
7817 static int intidx = -1;
7818 char_u *name;
7820 if (idx == 0)
7821 intidx = -1;
7822 if (intidx < 0)
7824 name = get_user_func_name(xp, idx);
7825 if (name != NULL)
7826 return name;
7828 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7830 STRCPY(IObuff, functions[intidx].f_name);
7831 STRCAT(IObuff, "(");
7832 if (functions[intidx].f_max_argc == 0)
7833 STRCAT(IObuff, ")");
7834 return IObuff;
7837 return NULL;
7841 * Function given to ExpandGeneric() to obtain the list of internal or
7842 * user defined variable or function names.
7844 char_u *
7845 get_expr_name(xp, idx)
7846 expand_T *xp;
7847 int idx;
7849 static int intidx = -1;
7850 char_u *name;
7852 if (idx == 0)
7853 intidx = -1;
7854 if (intidx < 0)
7856 name = get_function_name(xp, idx);
7857 if (name != NULL)
7858 return name;
7860 return get_user_var_name(xp, ++intidx);
7863 #endif /* FEAT_CMDL_COMPL */
7866 * Find internal function in table above.
7867 * Return index, or -1 if not found
7869 static int
7870 find_internal_func(name)
7871 char_u *name; /* name of the function */
7873 int first = 0;
7874 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7875 int cmp;
7876 int x;
7879 * Find the function name in the table. Binary search.
7881 while (first <= last)
7883 x = first + ((unsigned)(last - first) >> 1);
7884 cmp = STRCMP(name, functions[x].f_name);
7885 if (cmp < 0)
7886 last = x - 1;
7887 else if (cmp > 0)
7888 first = x + 1;
7889 else
7890 return x;
7892 return -1;
7896 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7897 * name it contains, otherwise return "name".
7899 static char_u *
7900 deref_func_name(name, lenp)
7901 char_u *name;
7902 int *lenp;
7904 dictitem_T *v;
7905 int cc;
7907 cc = name[*lenp];
7908 name[*lenp] = NUL;
7909 v = find_var(name, NULL);
7910 name[*lenp] = cc;
7911 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7913 if (v->di_tv.vval.v_string == NULL)
7915 *lenp = 0;
7916 return (char_u *)""; /* just in case */
7918 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7919 return v->di_tv.vval.v_string;
7922 return name;
7926 * Allocate a variable for the result of a function.
7927 * Return OK or FAIL.
7929 static int
7930 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7931 evaluate, selfdict)
7932 char_u *name; /* name of the function */
7933 int len; /* length of "name" */
7934 typval_T *rettv;
7935 char_u **arg; /* argument, pointing to the '(' */
7936 linenr_T firstline; /* first line of range */
7937 linenr_T lastline; /* last line of range */
7938 int *doesrange; /* return: function handled range */
7939 int evaluate;
7940 dict_T *selfdict; /* Dictionary for "self" */
7942 char_u *argp;
7943 int ret = OK;
7944 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7945 int argcount = 0; /* number of arguments found */
7948 * Get the arguments.
7950 argp = *arg;
7951 while (argcount < MAX_FUNC_ARGS)
7953 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7954 if (*argp == ')' || *argp == ',' || *argp == NUL)
7955 break;
7956 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7958 ret = FAIL;
7959 break;
7961 ++argcount;
7962 if (*argp != ',')
7963 break;
7965 if (*argp == ')')
7966 ++argp;
7967 else
7968 ret = FAIL;
7970 if (ret == OK)
7971 ret = call_func(name, len, rettv, argcount, argvars,
7972 firstline, lastline, doesrange, evaluate, selfdict);
7973 else if (!aborting())
7975 if (argcount == MAX_FUNC_ARGS)
7976 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7977 else
7978 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7981 while (--argcount >= 0)
7982 clear_tv(&argvars[argcount]);
7984 *arg = skipwhite(argp);
7985 return ret;
7990 * Call a function with its resolved parameters
7991 * Return OK when the function can't be called, FAIL otherwise.
7992 * Also returns OK when an error was encountered while executing the function.
7994 static int
7995 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7996 doesrange, evaluate, selfdict)
7997 char_u *name; /* name of the function */
7998 int len; /* length of "name" */
7999 typval_T *rettv; /* return value goes here */
8000 int argcount; /* number of "argvars" */
8001 typval_T *argvars; /* vars for arguments, must have "argcount"
8002 PLUS ONE elements! */
8003 linenr_T firstline; /* first line of range */
8004 linenr_T lastline; /* last line of range */
8005 int *doesrange; /* return: function handled range */
8006 int evaluate;
8007 dict_T *selfdict; /* Dictionary for "self" */
8009 int ret = FAIL;
8010 #define ERROR_UNKNOWN 0
8011 #define ERROR_TOOMANY 1
8012 #define ERROR_TOOFEW 2
8013 #define ERROR_SCRIPT 3
8014 #define ERROR_DICT 4
8015 #define ERROR_NONE 5
8016 #define ERROR_OTHER 6
8017 int error = ERROR_NONE;
8018 int i;
8019 int llen;
8020 ufunc_T *fp;
8021 int cc;
8022 #define FLEN_FIXED 40
8023 char_u fname_buf[FLEN_FIXED + 1];
8024 char_u *fname;
8027 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8028 * Change <SNR>123_name() to K_SNR 123_name().
8029 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8031 cc = name[len];
8032 name[len] = NUL;
8033 llen = eval_fname_script(name);
8034 if (llen > 0)
8036 fname_buf[0] = K_SPECIAL;
8037 fname_buf[1] = KS_EXTRA;
8038 fname_buf[2] = (int)KE_SNR;
8039 i = 3;
8040 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8042 if (current_SID <= 0)
8043 error = ERROR_SCRIPT;
8044 else
8046 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8047 i = (int)STRLEN(fname_buf);
8050 if (i + STRLEN(name + llen) < FLEN_FIXED)
8052 STRCPY(fname_buf + i, name + llen);
8053 fname = fname_buf;
8055 else
8057 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8058 if (fname == NULL)
8059 error = ERROR_OTHER;
8060 else
8062 mch_memmove(fname, fname_buf, (size_t)i);
8063 STRCPY(fname + i, name + llen);
8067 else
8068 fname = name;
8070 *doesrange = FALSE;
8073 /* execute the function if no errors detected and executing */
8074 if (evaluate && error == ERROR_NONE)
8076 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8077 rettv->vval.v_number = 0;
8078 error = ERROR_UNKNOWN;
8080 if (!builtin_function(fname))
8083 * User defined function.
8085 fp = find_func(fname);
8087 #ifdef FEAT_AUTOCMD
8088 /* Trigger FuncUndefined event, may load the function. */
8089 if (fp == NULL
8090 && apply_autocmds(EVENT_FUNCUNDEFINED,
8091 fname, fname, TRUE, NULL)
8092 && !aborting())
8094 /* executed an autocommand, search for the function again */
8095 fp = find_func(fname);
8097 #endif
8098 /* Try loading a package. */
8099 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8101 /* loaded a package, search for the function again */
8102 fp = find_func(fname);
8105 if (fp != NULL)
8107 if (fp->uf_flags & FC_RANGE)
8108 *doesrange = TRUE;
8109 if (argcount < fp->uf_args.ga_len)
8110 error = ERROR_TOOFEW;
8111 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8112 error = ERROR_TOOMANY;
8113 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8114 error = ERROR_DICT;
8115 else
8118 * Call the user function.
8119 * Save and restore search patterns, script variables and
8120 * redo buffer.
8122 save_search_patterns();
8123 saveRedobuff();
8124 ++fp->uf_calls;
8125 call_user_func(fp, argcount, argvars, rettv,
8126 firstline, lastline,
8127 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8128 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8129 && fp->uf_refcount <= 0)
8130 /* Function was unreferenced while being used, free it
8131 * now. */
8132 func_free(fp);
8133 restoreRedobuff();
8134 restore_search_patterns();
8135 error = ERROR_NONE;
8139 else
8142 * Find the function name in the table, call its implementation.
8144 i = find_internal_func(fname);
8145 if (i >= 0)
8147 if (argcount < functions[i].f_min_argc)
8148 error = ERROR_TOOFEW;
8149 else if (argcount > functions[i].f_max_argc)
8150 error = ERROR_TOOMANY;
8151 else
8153 argvars[argcount].v_type = VAR_UNKNOWN;
8154 functions[i].f_func(argvars, rettv);
8155 error = ERROR_NONE;
8160 * The function call (or "FuncUndefined" autocommand sequence) might
8161 * have been aborted by an error, an interrupt, or an explicitly thrown
8162 * exception that has not been caught so far. This situation can be
8163 * tested for by calling aborting(). For an error in an internal
8164 * function or for the "E132" error in call_user_func(), however, the
8165 * throw point at which the "force_abort" flag (temporarily reset by
8166 * emsg()) is normally updated has not been reached yet. We need to
8167 * update that flag first to make aborting() reliable.
8169 update_force_abort();
8171 if (error == ERROR_NONE)
8172 ret = OK;
8175 * Report an error unless the argument evaluation or function call has been
8176 * cancelled due to an aborting error, an interrupt, or an exception.
8178 if (!aborting())
8180 switch (error)
8182 case ERROR_UNKNOWN:
8183 emsg_funcname(N_("E117: Unknown function: %s"), name);
8184 break;
8185 case ERROR_TOOMANY:
8186 emsg_funcname(e_toomanyarg, name);
8187 break;
8188 case ERROR_TOOFEW:
8189 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8190 name);
8191 break;
8192 case ERROR_SCRIPT:
8193 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8194 name);
8195 break;
8196 case ERROR_DICT:
8197 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8198 name);
8199 break;
8203 name[len] = cc;
8204 if (fname != name && fname != fname_buf)
8205 vim_free(fname);
8207 return ret;
8211 * Give an error message with a function name. Handle <SNR> things.
8212 * "ermsg" is to be passed without translation, use N_() instead of _().
8214 static void
8215 emsg_funcname(ermsg, name)
8216 char *ermsg;
8217 char_u *name;
8219 char_u *p;
8221 if (*name == K_SPECIAL)
8222 p = concat_str((char_u *)"<SNR>", name + 3);
8223 else
8224 p = name;
8225 EMSG2(_(ermsg), p);
8226 if (p != name)
8227 vim_free(p);
8231 * Return TRUE for a non-zero Number and a non-empty String.
8233 static int
8234 non_zero_arg(argvars)
8235 typval_T *argvars;
8237 return ((argvars[0].v_type == VAR_NUMBER
8238 && argvars[0].vval.v_number != 0)
8239 || (argvars[0].v_type == VAR_STRING
8240 && argvars[0].vval.v_string != NULL
8241 && *argvars[0].vval.v_string != NUL));
8244 /*********************************************
8245 * Implementation of the built-in functions
8248 #ifdef FEAT_FLOAT
8250 * "abs(expr)" function
8252 static void
8253 f_abs(argvars, rettv)
8254 typval_T *argvars;
8255 typval_T *rettv;
8257 if (argvars[0].v_type == VAR_FLOAT)
8259 rettv->v_type = VAR_FLOAT;
8260 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8262 else
8264 varnumber_T n;
8265 int error = FALSE;
8267 n = get_tv_number_chk(&argvars[0], &error);
8268 if (error)
8269 rettv->vval.v_number = -1;
8270 else if (n > 0)
8271 rettv->vval.v_number = n;
8272 else
8273 rettv->vval.v_number = -n;
8276 #endif
8279 * "add(list, item)" function
8281 static void
8282 f_add(argvars, rettv)
8283 typval_T *argvars;
8284 typval_T *rettv;
8286 list_T *l;
8288 rettv->vval.v_number = 1; /* Default: Failed */
8289 if (argvars[0].v_type == VAR_LIST)
8291 if ((l = argvars[0].vval.v_list) != NULL
8292 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8293 && list_append_tv(l, &argvars[1]) == OK)
8294 copy_tv(&argvars[0], rettv);
8296 else
8297 EMSG(_(e_listreq));
8301 * "append(lnum, string/list)" function
8303 static void
8304 f_append(argvars, rettv)
8305 typval_T *argvars;
8306 typval_T *rettv;
8308 long lnum;
8309 char_u *line;
8310 list_T *l = NULL;
8311 listitem_T *li = NULL;
8312 typval_T *tv;
8313 long added = 0;
8315 lnum = get_tv_lnum(argvars);
8316 if (lnum >= 0
8317 && lnum <= curbuf->b_ml.ml_line_count
8318 && u_save(lnum, lnum + 1) == OK)
8320 if (argvars[1].v_type == VAR_LIST)
8322 l = argvars[1].vval.v_list;
8323 if (l == NULL)
8324 return;
8325 li = l->lv_first;
8327 for (;;)
8329 if (l == NULL)
8330 tv = &argvars[1]; /* append a string */
8331 else if (li == NULL)
8332 break; /* end of list */
8333 else
8334 tv = &li->li_tv; /* append item from list */
8335 line = get_tv_string_chk(tv);
8336 if (line == NULL) /* type error */
8338 rettv->vval.v_number = 1; /* Failed */
8339 break;
8341 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8342 ++added;
8343 if (l == NULL)
8344 break;
8345 li = li->li_next;
8348 appended_lines_mark(lnum, added);
8349 if (curwin->w_cursor.lnum > lnum)
8350 curwin->w_cursor.lnum += added;
8352 else
8353 rettv->vval.v_number = 1; /* Failed */
8357 * "argc()" function
8359 static void
8360 f_argc(argvars, rettv)
8361 typval_T *argvars UNUSED;
8362 typval_T *rettv;
8364 rettv->vval.v_number = ARGCOUNT;
8368 * "argidx()" function
8370 static void
8371 f_argidx(argvars, rettv)
8372 typval_T *argvars UNUSED;
8373 typval_T *rettv;
8375 rettv->vval.v_number = curwin->w_arg_idx;
8379 * "argv(nr)" function
8381 static void
8382 f_argv(argvars, rettv)
8383 typval_T *argvars;
8384 typval_T *rettv;
8386 int idx;
8388 if (argvars[0].v_type != VAR_UNKNOWN)
8390 idx = get_tv_number_chk(&argvars[0], NULL);
8391 if (idx >= 0 && idx < ARGCOUNT)
8392 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8393 else
8394 rettv->vval.v_string = NULL;
8395 rettv->v_type = VAR_STRING;
8397 else if (rettv_list_alloc(rettv) == OK)
8398 for (idx = 0; idx < ARGCOUNT; ++idx)
8399 list_append_string(rettv->vval.v_list,
8400 alist_name(&ARGLIST[idx]), -1);
8403 #ifdef FEAT_FLOAT
8404 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8407 * Get the float value of "argvars[0]" into "f".
8408 * Returns FAIL when the argument is not a Number or Float.
8410 static int
8411 get_float_arg(argvars, f)
8412 typval_T *argvars;
8413 float_T *f;
8415 if (argvars[0].v_type == VAR_FLOAT)
8417 *f = argvars[0].vval.v_float;
8418 return OK;
8420 if (argvars[0].v_type == VAR_NUMBER)
8422 *f = (float_T)argvars[0].vval.v_number;
8423 return OK;
8425 EMSG(_("E808: Number or Float required"));
8426 return FAIL;
8430 * "atan()" function
8432 static void
8433 f_atan(argvars, rettv)
8434 typval_T *argvars;
8435 typval_T *rettv;
8437 float_T f;
8439 rettv->v_type = VAR_FLOAT;
8440 if (get_float_arg(argvars, &f) == OK)
8441 rettv->vval.v_float = atan(f);
8442 else
8443 rettv->vval.v_float = 0.0;
8445 #endif
8448 * "browse(save, title, initdir, default)" function
8450 static void
8451 f_browse(argvars, rettv)
8452 typval_T *argvars UNUSED;
8453 typval_T *rettv;
8455 #ifdef FEAT_BROWSE
8456 int save;
8457 char_u *title;
8458 char_u *initdir;
8459 char_u *defname;
8460 char_u buf[NUMBUFLEN];
8461 char_u buf2[NUMBUFLEN];
8462 int error = FALSE;
8464 save = get_tv_number_chk(&argvars[0], &error);
8465 title = get_tv_string_chk(&argvars[1]);
8466 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8467 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8469 if (error || title == NULL || initdir == NULL || defname == NULL)
8470 rettv->vval.v_string = NULL;
8471 else
8472 rettv->vval.v_string =
8473 do_browse(save ? BROWSE_SAVE : 0,
8474 title, defname, NULL, initdir, NULL, curbuf);
8475 #else
8476 rettv->vval.v_string = NULL;
8477 #endif
8478 rettv->v_type = VAR_STRING;
8482 * "browsedir(title, initdir)" function
8484 static void
8485 f_browsedir(argvars, rettv)
8486 typval_T *argvars UNUSED;
8487 typval_T *rettv;
8489 #ifdef FEAT_BROWSE
8490 char_u *title;
8491 char_u *initdir;
8492 char_u buf[NUMBUFLEN];
8494 title = get_tv_string_chk(&argvars[0]);
8495 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8497 if (title == NULL || initdir == NULL)
8498 rettv->vval.v_string = NULL;
8499 else
8500 rettv->vval.v_string = do_browse(BROWSE_DIR,
8501 title, NULL, NULL, initdir, NULL, curbuf);
8502 #else
8503 rettv->vval.v_string = NULL;
8504 #endif
8505 rettv->v_type = VAR_STRING;
8508 static buf_T *find_buffer __ARGS((typval_T *avar));
8511 * Find a buffer by number or exact name.
8513 static buf_T *
8514 find_buffer(avar)
8515 typval_T *avar;
8517 buf_T *buf = NULL;
8519 if (avar->v_type == VAR_NUMBER)
8520 buf = buflist_findnr((int)avar->vval.v_number);
8521 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8523 buf = buflist_findname_exp(avar->vval.v_string);
8524 if (buf == NULL)
8526 /* No full path name match, try a match with a URL or a "nofile"
8527 * buffer, these don't use the full path. */
8528 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8529 if (buf->b_fname != NULL
8530 && (path_with_url(buf->b_fname)
8531 #ifdef FEAT_QUICKFIX
8532 || bt_nofile(buf)
8533 #endif
8535 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8536 break;
8539 return buf;
8543 * "bufexists(expr)" function
8545 static void
8546 f_bufexists(argvars, rettv)
8547 typval_T *argvars;
8548 typval_T *rettv;
8550 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8554 * "buflisted(expr)" function
8556 static void
8557 f_buflisted(argvars, rettv)
8558 typval_T *argvars;
8559 typval_T *rettv;
8561 buf_T *buf;
8563 buf = find_buffer(&argvars[0]);
8564 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8568 * "bufloaded(expr)" function
8570 static void
8571 f_bufloaded(argvars, rettv)
8572 typval_T *argvars;
8573 typval_T *rettv;
8575 buf_T *buf;
8577 buf = find_buffer(&argvars[0]);
8578 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8581 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8584 * Get buffer by number or pattern.
8586 static buf_T *
8587 get_buf_tv(tv)
8588 typval_T *tv;
8590 char_u *name = tv->vval.v_string;
8591 int save_magic;
8592 char_u *save_cpo;
8593 buf_T *buf;
8595 if (tv->v_type == VAR_NUMBER)
8596 return buflist_findnr((int)tv->vval.v_number);
8597 if (tv->v_type != VAR_STRING)
8598 return NULL;
8599 if (name == NULL || *name == NUL)
8600 return curbuf;
8601 if (name[0] == '$' && name[1] == NUL)
8602 return lastbuf;
8604 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8605 save_magic = p_magic;
8606 p_magic = TRUE;
8607 save_cpo = p_cpo;
8608 p_cpo = (char_u *)"";
8610 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8611 TRUE, FALSE));
8613 p_magic = save_magic;
8614 p_cpo = save_cpo;
8616 /* If not found, try expanding the name, like done for bufexists(). */
8617 if (buf == NULL)
8618 buf = find_buffer(tv);
8620 return buf;
8624 * "bufname(expr)" function
8626 static void
8627 f_bufname(argvars, rettv)
8628 typval_T *argvars;
8629 typval_T *rettv;
8631 buf_T *buf;
8633 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8634 ++emsg_off;
8635 buf = get_buf_tv(&argvars[0]);
8636 rettv->v_type = VAR_STRING;
8637 if (buf != NULL && buf->b_fname != NULL)
8638 rettv->vval.v_string = vim_strsave(buf->b_fname);
8639 else
8640 rettv->vval.v_string = NULL;
8641 --emsg_off;
8645 * "bufnr(expr)" function
8647 static void
8648 f_bufnr(argvars, rettv)
8649 typval_T *argvars;
8650 typval_T *rettv;
8652 buf_T *buf;
8653 int error = FALSE;
8654 char_u *name;
8656 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8657 ++emsg_off;
8658 buf = get_buf_tv(&argvars[0]);
8659 --emsg_off;
8661 /* If the buffer isn't found and the second argument is not zero create a
8662 * new buffer. */
8663 if (buf == NULL
8664 && argvars[1].v_type != VAR_UNKNOWN
8665 && get_tv_number_chk(&argvars[1], &error) != 0
8666 && !error
8667 && (name = get_tv_string_chk(&argvars[0])) != NULL
8668 && !error)
8669 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8671 if (buf != NULL)
8672 rettv->vval.v_number = buf->b_fnum;
8673 else
8674 rettv->vval.v_number = -1;
8678 * "bufwinnr(nr)" function
8680 static void
8681 f_bufwinnr(argvars, rettv)
8682 typval_T *argvars;
8683 typval_T *rettv;
8685 #ifdef FEAT_WINDOWS
8686 win_T *wp;
8687 int winnr = 0;
8688 #endif
8689 buf_T *buf;
8691 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8692 ++emsg_off;
8693 buf = get_buf_tv(&argvars[0]);
8694 #ifdef FEAT_WINDOWS
8695 for (wp = firstwin; wp; wp = wp->w_next)
8697 ++winnr;
8698 if (wp->w_buffer == buf)
8699 break;
8701 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8702 #else
8703 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8704 #endif
8705 --emsg_off;
8709 * "byte2line(byte)" function
8711 static void
8712 f_byte2line(argvars, rettv)
8713 typval_T *argvars UNUSED;
8714 typval_T *rettv;
8716 #ifndef FEAT_BYTEOFF
8717 rettv->vval.v_number = -1;
8718 #else
8719 long boff = 0;
8721 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8722 if (boff < 0)
8723 rettv->vval.v_number = -1;
8724 else
8725 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8726 (linenr_T)0, &boff);
8727 #endif
8731 * "byteidx()" function
8733 static void
8734 f_byteidx(argvars, rettv)
8735 typval_T *argvars;
8736 typval_T *rettv;
8738 #ifdef FEAT_MBYTE
8739 char_u *t;
8740 #endif
8741 char_u *str;
8742 long idx;
8744 str = get_tv_string_chk(&argvars[0]);
8745 idx = get_tv_number_chk(&argvars[1], NULL);
8746 rettv->vval.v_number = -1;
8747 if (str == NULL || idx < 0)
8748 return;
8750 #ifdef FEAT_MBYTE
8751 t = str;
8752 for ( ; idx > 0; idx--)
8754 if (*t == NUL) /* EOL reached */
8755 return;
8756 t += (*mb_ptr2len)(t);
8758 rettv->vval.v_number = (varnumber_T)(t - str);
8759 #else
8760 if ((size_t)idx <= STRLEN(str))
8761 rettv->vval.v_number = idx;
8762 #endif
8766 * "call(func, arglist)" function
8768 static void
8769 f_call(argvars, rettv)
8770 typval_T *argvars;
8771 typval_T *rettv;
8773 char_u *func;
8774 typval_T argv[MAX_FUNC_ARGS + 1];
8775 int argc = 0;
8776 listitem_T *item;
8777 int dummy;
8778 dict_T *selfdict = NULL;
8780 if (argvars[1].v_type != VAR_LIST)
8782 EMSG(_(e_listreq));
8783 return;
8785 if (argvars[1].vval.v_list == NULL)
8786 return;
8788 if (argvars[0].v_type == VAR_FUNC)
8789 func = argvars[0].vval.v_string;
8790 else
8791 func = get_tv_string(&argvars[0]);
8792 if (*func == NUL)
8793 return; /* type error or empty name */
8795 if (argvars[2].v_type != VAR_UNKNOWN)
8797 if (argvars[2].v_type != VAR_DICT)
8799 EMSG(_(e_dictreq));
8800 return;
8802 selfdict = argvars[2].vval.v_dict;
8805 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8806 item = item->li_next)
8808 if (argc == MAX_FUNC_ARGS)
8810 EMSG(_("E699: Too many arguments"));
8811 break;
8813 /* Make a copy of each argument. This is needed to be able to set
8814 * v_lock to VAR_FIXED in the copy without changing the original list.
8816 copy_tv(&item->li_tv, &argv[argc++]);
8819 if (item == NULL)
8820 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8821 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8822 &dummy, TRUE, selfdict);
8824 /* Free the arguments. */
8825 while (argc > 0)
8826 clear_tv(&argv[--argc]);
8829 #ifdef FEAT_FLOAT
8831 * "ceil({float})" function
8833 static void
8834 f_ceil(argvars, rettv)
8835 typval_T *argvars;
8836 typval_T *rettv;
8838 float_T f;
8840 rettv->v_type = VAR_FLOAT;
8841 if (get_float_arg(argvars, &f) == OK)
8842 rettv->vval.v_float = ceil(f);
8843 else
8844 rettv->vval.v_float = 0.0;
8846 #endif
8849 * "changenr()" function
8851 static void
8852 f_changenr(argvars, rettv)
8853 typval_T *argvars UNUSED;
8854 typval_T *rettv;
8856 rettv->vval.v_number = curbuf->b_u_seq_cur;
8860 * "char2nr(string)" function
8862 static void
8863 f_char2nr(argvars, rettv)
8864 typval_T *argvars;
8865 typval_T *rettv;
8867 #ifdef FEAT_MBYTE
8868 if (has_mbyte)
8869 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8870 else
8871 #endif
8872 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8876 * "cindent(lnum)" function
8878 static void
8879 f_cindent(argvars, rettv)
8880 typval_T *argvars;
8881 typval_T *rettv;
8883 #ifdef FEAT_CINDENT
8884 pos_T pos;
8885 linenr_T lnum;
8887 pos = curwin->w_cursor;
8888 lnum = get_tv_lnum(argvars);
8889 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8891 curwin->w_cursor.lnum = lnum;
8892 rettv->vval.v_number = get_c_indent();
8893 curwin->w_cursor = pos;
8895 else
8896 #endif
8897 rettv->vval.v_number = -1;
8901 * "clearmatches()" function
8903 static void
8904 f_clearmatches(argvars, rettv)
8905 typval_T *argvars UNUSED;
8906 typval_T *rettv UNUSED;
8908 #ifdef FEAT_SEARCH_EXTRA
8909 clear_matches(curwin);
8910 #endif
8914 * "col(string)" function
8916 static void
8917 f_col(argvars, rettv)
8918 typval_T *argvars;
8919 typval_T *rettv;
8921 colnr_T col = 0;
8922 pos_T *fp;
8923 int fnum = curbuf->b_fnum;
8925 fp = var2fpos(&argvars[0], FALSE, &fnum);
8926 if (fp != NULL && fnum == curbuf->b_fnum)
8928 if (fp->col == MAXCOL)
8930 /* '> can be MAXCOL, get the length of the line then */
8931 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8932 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8933 else
8934 col = MAXCOL;
8936 else
8938 col = fp->col + 1;
8939 #ifdef FEAT_VIRTUALEDIT
8940 /* col(".") when the cursor is on the NUL at the end of the line
8941 * because of "coladd" can be seen as an extra column. */
8942 if (virtual_active() && fp == &curwin->w_cursor)
8944 char_u *p = ml_get_cursor();
8946 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8947 curwin->w_virtcol - curwin->w_cursor.coladd))
8949 # ifdef FEAT_MBYTE
8950 int l;
8952 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8953 col += l;
8954 # else
8955 if (*p != NUL && p[1] == NUL)
8956 ++col;
8957 # endif
8960 #endif
8963 rettv->vval.v_number = col;
8966 #if defined(FEAT_INS_EXPAND)
8968 * "complete()" function
8970 static void
8971 f_complete(argvars, rettv)
8972 typval_T *argvars;
8973 typval_T *rettv UNUSED;
8975 int startcol;
8977 if ((State & INSERT) == 0)
8979 EMSG(_("E785: complete() can only be used in Insert mode"));
8980 return;
8983 /* Check for undo allowed here, because if something was already inserted
8984 * the line was already saved for undo and this check isn't done. */
8985 if (!undo_allowed())
8986 return;
8988 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8990 EMSG(_(e_invarg));
8991 return;
8994 startcol = get_tv_number_chk(&argvars[0], NULL);
8995 if (startcol <= 0)
8996 return;
8998 set_completion(startcol - 1, argvars[1].vval.v_list);
9002 * "complete_add()" function
9004 static void
9005 f_complete_add(argvars, rettv)
9006 typval_T *argvars;
9007 typval_T *rettv;
9009 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9013 * "complete_check()" function
9015 static void
9016 f_complete_check(argvars, rettv)
9017 typval_T *argvars UNUSED;
9018 typval_T *rettv;
9020 int saved = RedrawingDisabled;
9022 RedrawingDisabled = 0;
9023 ins_compl_check_keys(0);
9024 rettv->vval.v_number = compl_interrupted;
9025 RedrawingDisabled = saved;
9027 #endif
9030 * "confirm(message, buttons[, default [, type]])" function
9032 static void
9033 f_confirm(argvars, rettv)
9034 typval_T *argvars UNUSED;
9035 typval_T *rettv UNUSED;
9037 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9038 char_u *message;
9039 char_u *buttons = NULL;
9040 char_u buf[NUMBUFLEN];
9041 char_u buf2[NUMBUFLEN];
9042 int def = 1;
9043 int type = VIM_GENERIC;
9044 char_u *typestr;
9045 int error = FALSE;
9047 message = get_tv_string_chk(&argvars[0]);
9048 if (message == NULL)
9049 error = TRUE;
9050 if (argvars[1].v_type != VAR_UNKNOWN)
9052 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9053 if (buttons == NULL)
9054 error = TRUE;
9055 if (argvars[2].v_type != VAR_UNKNOWN)
9057 def = get_tv_number_chk(&argvars[2], &error);
9058 if (argvars[3].v_type != VAR_UNKNOWN)
9060 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9061 if (typestr == NULL)
9062 error = TRUE;
9063 else
9065 switch (TOUPPER_ASC(*typestr))
9067 case 'E': type = VIM_ERROR; break;
9068 case 'Q': type = VIM_QUESTION; break;
9069 case 'I': type = VIM_INFO; break;
9070 case 'W': type = VIM_WARNING; break;
9071 case 'G': type = VIM_GENERIC; break;
9078 if (buttons == NULL || *buttons == NUL)
9079 buttons = (char_u *)_("&Ok");
9081 if (!error)
9082 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9083 def, NULL);
9084 #endif
9088 * "copy()" function
9090 static void
9091 f_copy(argvars, rettv)
9092 typval_T *argvars;
9093 typval_T *rettv;
9095 item_copy(&argvars[0], rettv, FALSE, 0);
9098 #ifdef FEAT_FLOAT
9100 * "cos()" function
9102 static void
9103 f_cos(argvars, rettv)
9104 typval_T *argvars;
9105 typval_T *rettv;
9107 float_T f;
9109 rettv->v_type = VAR_FLOAT;
9110 if (get_float_arg(argvars, &f) == OK)
9111 rettv->vval.v_float = cos(f);
9112 else
9113 rettv->vval.v_float = 0.0;
9115 #endif
9118 * "count()" function
9120 static void
9121 f_count(argvars, rettv)
9122 typval_T *argvars;
9123 typval_T *rettv;
9125 long n = 0;
9126 int ic = FALSE;
9128 if (argvars[0].v_type == VAR_LIST)
9130 listitem_T *li;
9131 list_T *l;
9132 long idx;
9134 if ((l = argvars[0].vval.v_list) != NULL)
9136 li = l->lv_first;
9137 if (argvars[2].v_type != VAR_UNKNOWN)
9139 int error = FALSE;
9141 ic = get_tv_number_chk(&argvars[2], &error);
9142 if (argvars[3].v_type != VAR_UNKNOWN)
9144 idx = get_tv_number_chk(&argvars[3], &error);
9145 if (!error)
9147 li = list_find(l, idx);
9148 if (li == NULL)
9149 EMSGN(_(e_listidx), idx);
9152 if (error)
9153 li = NULL;
9156 for ( ; li != NULL; li = li->li_next)
9157 if (tv_equal(&li->li_tv, &argvars[1], ic))
9158 ++n;
9161 else if (argvars[0].v_type == VAR_DICT)
9163 int todo;
9164 dict_T *d;
9165 hashitem_T *hi;
9167 if ((d = argvars[0].vval.v_dict) != NULL)
9169 int error = FALSE;
9171 if (argvars[2].v_type != VAR_UNKNOWN)
9173 ic = get_tv_number_chk(&argvars[2], &error);
9174 if (argvars[3].v_type != VAR_UNKNOWN)
9175 EMSG(_(e_invarg));
9178 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9179 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9181 if (!HASHITEM_EMPTY(hi))
9183 --todo;
9184 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9185 ++n;
9190 else
9191 EMSG2(_(e_listdictarg), "count()");
9192 rettv->vval.v_number = n;
9196 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9198 * Checks the existence of a cscope connection.
9200 static void
9201 f_cscope_connection(argvars, rettv)
9202 typval_T *argvars UNUSED;
9203 typval_T *rettv UNUSED;
9205 #ifdef FEAT_CSCOPE
9206 int num = 0;
9207 char_u *dbpath = NULL;
9208 char_u *prepend = NULL;
9209 char_u buf[NUMBUFLEN];
9211 if (argvars[0].v_type != VAR_UNKNOWN
9212 && argvars[1].v_type != VAR_UNKNOWN)
9214 num = (int)get_tv_number(&argvars[0]);
9215 dbpath = get_tv_string(&argvars[1]);
9216 if (argvars[2].v_type != VAR_UNKNOWN)
9217 prepend = get_tv_string_buf(&argvars[2], buf);
9220 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9221 #endif
9225 * "cursor(lnum, col)" function
9227 * Moves the cursor to the specified line and column.
9228 * Returns 0 when the position could be set, -1 otherwise.
9230 static void
9231 f_cursor(argvars, rettv)
9232 typval_T *argvars;
9233 typval_T *rettv;
9235 long line, col;
9236 #ifdef FEAT_VIRTUALEDIT
9237 long coladd = 0;
9238 #endif
9240 rettv->vval.v_number = -1;
9241 if (argvars[1].v_type == VAR_UNKNOWN)
9243 pos_T pos;
9245 if (list2fpos(argvars, &pos, NULL) == FAIL)
9246 return;
9247 line = pos.lnum;
9248 col = pos.col;
9249 #ifdef FEAT_VIRTUALEDIT
9250 coladd = pos.coladd;
9251 #endif
9253 else
9255 line = get_tv_lnum(argvars);
9256 col = get_tv_number_chk(&argvars[1], NULL);
9257 #ifdef FEAT_VIRTUALEDIT
9258 if (argvars[2].v_type != VAR_UNKNOWN)
9259 coladd = get_tv_number_chk(&argvars[2], NULL);
9260 #endif
9262 if (line < 0 || col < 0
9263 #ifdef FEAT_VIRTUALEDIT
9264 || coladd < 0
9265 #endif
9267 return; /* type error; errmsg already given */
9268 if (line > 0)
9269 curwin->w_cursor.lnum = line;
9270 if (col > 0)
9271 curwin->w_cursor.col = col - 1;
9272 #ifdef FEAT_VIRTUALEDIT
9273 curwin->w_cursor.coladd = coladd;
9274 #endif
9276 /* Make sure the cursor is in a valid position. */
9277 check_cursor();
9278 #ifdef FEAT_MBYTE
9279 /* Correct cursor for multi-byte character. */
9280 if (has_mbyte)
9281 mb_adjust_cursor();
9282 #endif
9284 curwin->w_set_curswant = TRUE;
9285 rettv->vval.v_number = 0;
9289 * "deepcopy()" function
9291 static void
9292 f_deepcopy(argvars, rettv)
9293 typval_T *argvars;
9294 typval_T *rettv;
9296 int noref = 0;
9298 if (argvars[1].v_type != VAR_UNKNOWN)
9299 noref = get_tv_number_chk(&argvars[1], NULL);
9300 if (noref < 0 || noref > 1)
9301 EMSG(_(e_invarg));
9302 else
9304 current_copyID += COPYID_INC;
9305 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9310 * "delete()" function
9312 static void
9313 f_delete(argvars, rettv)
9314 typval_T *argvars;
9315 typval_T *rettv;
9317 if (check_restricted() || check_secure())
9318 rettv->vval.v_number = -1;
9319 else
9320 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9324 * "did_filetype()" function
9326 static void
9327 f_did_filetype(argvars, rettv)
9328 typval_T *argvars UNUSED;
9329 typval_T *rettv UNUSED;
9331 #ifdef FEAT_AUTOCMD
9332 rettv->vval.v_number = did_filetype;
9333 #endif
9337 * "diff_filler()" function
9339 static void
9340 f_diff_filler(argvars, rettv)
9341 typval_T *argvars UNUSED;
9342 typval_T *rettv UNUSED;
9344 #ifdef FEAT_DIFF
9345 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9346 #endif
9350 * "diff_hlID()" function
9352 static void
9353 f_diff_hlID(argvars, rettv)
9354 typval_T *argvars UNUSED;
9355 typval_T *rettv UNUSED;
9357 #ifdef FEAT_DIFF
9358 linenr_T lnum = get_tv_lnum(argvars);
9359 static linenr_T prev_lnum = 0;
9360 static int changedtick = 0;
9361 static int fnum = 0;
9362 static int change_start = 0;
9363 static int change_end = 0;
9364 static hlf_T hlID = (hlf_T)0;
9365 int filler_lines;
9366 int col;
9368 if (lnum < 0) /* ignore type error in {lnum} arg */
9369 lnum = 0;
9370 if (lnum != prev_lnum
9371 || changedtick != curbuf->b_changedtick
9372 || fnum != curbuf->b_fnum)
9374 /* New line, buffer, change: need to get the values. */
9375 filler_lines = diff_check(curwin, lnum);
9376 if (filler_lines < 0)
9378 if (filler_lines == -1)
9380 change_start = MAXCOL;
9381 change_end = -1;
9382 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9383 hlID = HLF_ADD; /* added line */
9384 else
9385 hlID = HLF_CHD; /* changed line */
9387 else
9388 hlID = HLF_ADD; /* added line */
9390 else
9391 hlID = (hlf_T)0;
9392 prev_lnum = lnum;
9393 changedtick = curbuf->b_changedtick;
9394 fnum = curbuf->b_fnum;
9397 if (hlID == HLF_CHD || hlID == HLF_TXD)
9399 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9400 if (col >= change_start && col <= change_end)
9401 hlID = HLF_TXD; /* changed text */
9402 else
9403 hlID = HLF_CHD; /* changed line */
9405 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9406 #endif
9410 * "empty({expr})" function
9412 static void
9413 f_empty(argvars, rettv)
9414 typval_T *argvars;
9415 typval_T *rettv;
9417 int n;
9419 switch (argvars[0].v_type)
9421 case VAR_STRING:
9422 case VAR_FUNC:
9423 n = argvars[0].vval.v_string == NULL
9424 || *argvars[0].vval.v_string == NUL;
9425 break;
9426 case VAR_NUMBER:
9427 n = argvars[0].vval.v_number == 0;
9428 break;
9429 #ifdef FEAT_FLOAT
9430 case VAR_FLOAT:
9431 n = argvars[0].vval.v_float == 0.0;
9432 break;
9433 #endif
9434 case VAR_LIST:
9435 n = argvars[0].vval.v_list == NULL
9436 || argvars[0].vval.v_list->lv_first == NULL;
9437 break;
9438 case VAR_DICT:
9439 n = argvars[0].vval.v_dict == NULL
9440 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9441 break;
9442 default:
9443 EMSG2(_(e_intern2), "f_empty()");
9444 n = 0;
9447 rettv->vval.v_number = n;
9451 * "escape({string}, {chars})" function
9453 static void
9454 f_escape(argvars, rettv)
9455 typval_T *argvars;
9456 typval_T *rettv;
9458 char_u buf[NUMBUFLEN];
9460 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9461 get_tv_string_buf(&argvars[1], buf));
9462 rettv->v_type = VAR_STRING;
9466 * "eval()" function
9468 static void
9469 f_eval(argvars, rettv)
9470 typval_T *argvars;
9471 typval_T *rettv;
9473 char_u *s;
9475 s = get_tv_string_chk(&argvars[0]);
9476 if (s != NULL)
9477 s = skipwhite(s);
9479 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9481 rettv->v_type = VAR_NUMBER;
9482 rettv->vval.v_number = 0;
9484 else if (*s != NUL)
9485 EMSG(_(e_trailing));
9489 * "eventhandler()" function
9491 static void
9492 f_eventhandler(argvars, rettv)
9493 typval_T *argvars UNUSED;
9494 typval_T *rettv;
9496 rettv->vval.v_number = vgetc_busy;
9500 * "executable()" function
9502 static void
9503 f_executable(argvars, rettv)
9504 typval_T *argvars;
9505 typval_T *rettv;
9507 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9511 * "exists()" function
9513 static void
9514 f_exists(argvars, rettv)
9515 typval_T *argvars;
9516 typval_T *rettv;
9518 char_u *p;
9519 char_u *name;
9520 int n = FALSE;
9521 int len = 0;
9523 p = get_tv_string(&argvars[0]);
9524 if (*p == '$') /* environment variable */
9526 /* first try "normal" environment variables (fast) */
9527 if (mch_getenv(p + 1) != NULL)
9528 n = TRUE;
9529 else
9531 /* try expanding things like $VIM and ${HOME} */
9532 p = expand_env_save(p);
9533 if (p != NULL && *p != '$')
9534 n = TRUE;
9535 vim_free(p);
9538 else if (*p == '&' || *p == '+') /* option */
9540 n = (get_option_tv(&p, NULL, TRUE) == OK);
9541 if (*skipwhite(p) != NUL)
9542 n = FALSE; /* trailing garbage */
9544 else if (*p == '*') /* internal or user defined function */
9546 n = function_exists(p + 1);
9548 else if (*p == ':')
9550 n = cmd_exists(p + 1);
9552 else if (*p == '#')
9554 #ifdef FEAT_AUTOCMD
9555 if (p[1] == '#')
9556 n = autocmd_supported(p + 2);
9557 else
9558 n = au_exists(p + 1);
9559 #endif
9561 else /* internal variable */
9563 char_u *tofree;
9564 typval_T tv;
9566 /* get_name_len() takes care of expanding curly braces */
9567 name = p;
9568 len = get_name_len(&p, &tofree, TRUE, FALSE);
9569 if (len > 0)
9571 if (tofree != NULL)
9572 name = tofree;
9573 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9574 if (n)
9576 /* handle d.key, l[idx], f(expr) */
9577 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9578 if (n)
9579 clear_tv(&tv);
9582 if (*p != NUL)
9583 n = FALSE;
9585 vim_free(tofree);
9588 rettv->vval.v_number = n;
9592 * "expand()" function
9594 static void
9595 f_expand(argvars, rettv)
9596 typval_T *argvars;
9597 typval_T *rettv;
9599 char_u *s;
9600 int len;
9601 char_u *errormsg;
9602 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9603 expand_T xpc;
9604 int error = FALSE;
9606 rettv->v_type = VAR_STRING;
9607 s = get_tv_string(&argvars[0]);
9608 if (*s == '%' || *s == '#' || *s == '<')
9610 ++emsg_off;
9611 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9612 --emsg_off;
9614 else
9616 /* When the optional second argument is non-zero, don't remove matches
9617 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9618 if (argvars[1].v_type != VAR_UNKNOWN
9619 && get_tv_number_chk(&argvars[1], &error))
9620 flags |= WILD_KEEP_ALL;
9621 if (!error)
9623 ExpandInit(&xpc);
9624 xpc.xp_context = EXPAND_FILES;
9625 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9627 else
9628 rettv->vval.v_string = NULL;
9633 * "extend(list, list [, idx])" function
9634 * "extend(dict, dict [, action])" function
9636 static void
9637 f_extend(argvars, rettv)
9638 typval_T *argvars;
9639 typval_T *rettv;
9641 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9643 list_T *l1, *l2;
9644 listitem_T *item;
9645 long before;
9646 int error = FALSE;
9648 l1 = argvars[0].vval.v_list;
9649 l2 = argvars[1].vval.v_list;
9650 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9651 && l2 != NULL)
9653 if (argvars[2].v_type != VAR_UNKNOWN)
9655 before = get_tv_number_chk(&argvars[2], &error);
9656 if (error)
9657 return; /* type error; errmsg already given */
9659 if (before == l1->lv_len)
9660 item = NULL;
9661 else
9663 item = list_find(l1, before);
9664 if (item == NULL)
9666 EMSGN(_(e_listidx), before);
9667 return;
9671 else
9672 item = NULL;
9673 list_extend(l1, l2, item);
9675 copy_tv(&argvars[0], rettv);
9678 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9680 dict_T *d1, *d2;
9681 dictitem_T *di1;
9682 char_u *action;
9683 int i;
9684 hashitem_T *hi2;
9685 int todo;
9687 d1 = argvars[0].vval.v_dict;
9688 d2 = argvars[1].vval.v_dict;
9689 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9690 && d2 != NULL)
9692 /* Check the third argument. */
9693 if (argvars[2].v_type != VAR_UNKNOWN)
9695 static char *(av[]) = {"keep", "force", "error"};
9697 action = get_tv_string_chk(&argvars[2]);
9698 if (action == NULL)
9699 return; /* type error; errmsg already given */
9700 for (i = 0; i < 3; ++i)
9701 if (STRCMP(action, av[i]) == 0)
9702 break;
9703 if (i == 3)
9705 EMSG2(_(e_invarg2), action);
9706 return;
9709 else
9710 action = (char_u *)"force";
9712 /* Go over all entries in the second dict and add them to the
9713 * first dict. */
9714 todo = (int)d2->dv_hashtab.ht_used;
9715 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9717 if (!HASHITEM_EMPTY(hi2))
9719 --todo;
9720 di1 = dict_find(d1, hi2->hi_key, -1);
9721 if (di1 == NULL)
9723 di1 = dictitem_copy(HI2DI(hi2));
9724 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9725 dictitem_free(di1);
9727 else if (*action == 'e')
9729 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9730 break;
9732 else if (*action == 'f')
9734 clear_tv(&di1->di_tv);
9735 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9740 copy_tv(&argvars[0], rettv);
9743 else
9744 EMSG2(_(e_listdictarg), "extend()");
9748 * "feedkeys()" function
9750 static void
9751 f_feedkeys(argvars, rettv)
9752 typval_T *argvars;
9753 typval_T *rettv UNUSED;
9755 int remap = TRUE;
9756 char_u *keys, *flags;
9757 char_u nbuf[NUMBUFLEN];
9758 int typed = FALSE;
9759 char_u *keys_esc;
9761 /* This is not allowed in the sandbox. If the commands would still be
9762 * executed in the sandbox it would be OK, but it probably happens later,
9763 * when "sandbox" is no longer set. */
9764 if (check_secure())
9765 return;
9767 keys = get_tv_string(&argvars[0]);
9768 if (*keys != NUL)
9770 if (argvars[1].v_type != VAR_UNKNOWN)
9772 flags = get_tv_string_buf(&argvars[1], nbuf);
9773 for ( ; *flags != NUL; ++flags)
9775 switch (*flags)
9777 case 'n': remap = FALSE; break;
9778 case 'm': remap = TRUE; break;
9779 case 't': typed = TRUE; break;
9784 /* Need to escape K_SPECIAL and CSI before putting the string in the
9785 * typeahead buffer. */
9786 keys_esc = vim_strsave_escape_csi(keys);
9787 if (keys_esc != NULL)
9789 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9790 typebuf.tb_len, !typed, FALSE);
9791 vim_free(keys_esc);
9792 if (vgetc_busy)
9793 typebuf_was_filled = TRUE;
9799 * "filereadable()" function
9801 static void
9802 f_filereadable(argvars, rettv)
9803 typval_T *argvars;
9804 typval_T *rettv;
9806 int fd;
9807 char_u *p;
9808 int n;
9810 #ifndef O_NONBLOCK
9811 # define O_NONBLOCK 0
9812 #endif
9813 p = get_tv_string(&argvars[0]);
9814 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9815 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9817 n = TRUE;
9818 close(fd);
9820 else
9821 n = FALSE;
9823 rettv->vval.v_number = n;
9827 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9828 * rights to write into.
9830 static void
9831 f_filewritable(argvars, rettv)
9832 typval_T *argvars;
9833 typval_T *rettv;
9835 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9838 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9840 static void
9841 findfilendir(argvars, rettv, find_what)
9842 typval_T *argvars;
9843 typval_T *rettv;
9844 int find_what;
9846 #ifdef FEAT_SEARCHPATH
9847 char_u *fname;
9848 char_u *fresult = NULL;
9849 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9850 char_u *p;
9851 char_u pathbuf[NUMBUFLEN];
9852 int count = 1;
9853 int first = TRUE;
9854 int error = FALSE;
9855 #endif
9857 rettv->vval.v_string = NULL;
9858 rettv->v_type = VAR_STRING;
9860 #ifdef FEAT_SEARCHPATH
9861 fname = get_tv_string(&argvars[0]);
9863 if (argvars[1].v_type != VAR_UNKNOWN)
9865 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9866 if (p == NULL)
9867 error = TRUE;
9868 else
9870 if (*p != NUL)
9871 path = p;
9873 if (argvars[2].v_type != VAR_UNKNOWN)
9874 count = get_tv_number_chk(&argvars[2], &error);
9878 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9879 error = TRUE;
9881 if (*fname != NUL && !error)
9885 if (rettv->v_type == VAR_STRING)
9886 vim_free(fresult);
9887 fresult = find_file_in_path_option(first ? fname : NULL,
9888 first ? (int)STRLEN(fname) : 0,
9889 0, first, path,
9890 find_what,
9891 curbuf->b_ffname,
9892 find_what == FINDFILE_DIR
9893 ? (char_u *)"" : curbuf->b_p_sua);
9894 first = FALSE;
9896 if (fresult != NULL && rettv->v_type == VAR_LIST)
9897 list_append_string(rettv->vval.v_list, fresult, -1);
9899 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9902 if (rettv->v_type == VAR_STRING)
9903 rettv->vval.v_string = fresult;
9904 #endif
9907 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9908 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9911 * Implementation of map() and filter().
9913 static void
9914 filter_map(argvars, rettv, map)
9915 typval_T *argvars;
9916 typval_T *rettv;
9917 int map;
9919 char_u buf[NUMBUFLEN];
9920 char_u *expr;
9921 listitem_T *li, *nli;
9922 list_T *l = NULL;
9923 dictitem_T *di;
9924 hashtab_T *ht;
9925 hashitem_T *hi;
9926 dict_T *d = NULL;
9927 typval_T save_val;
9928 typval_T save_key;
9929 int rem;
9930 int todo;
9931 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9932 int save_did_emsg;
9933 int index = 0;
9935 if (argvars[0].v_type == VAR_LIST)
9937 if ((l = argvars[0].vval.v_list) == NULL
9938 || (map && tv_check_lock(l->lv_lock, ermsg)))
9939 return;
9941 else if (argvars[0].v_type == VAR_DICT)
9943 if ((d = argvars[0].vval.v_dict) == NULL
9944 || (map && tv_check_lock(d->dv_lock, ermsg)))
9945 return;
9947 else
9949 EMSG2(_(e_listdictarg), ermsg);
9950 return;
9953 expr = get_tv_string_buf_chk(&argvars[1], buf);
9954 /* On type errors, the preceding call has already displayed an error
9955 * message. Avoid a misleading error message for an empty string that
9956 * was not passed as argument. */
9957 if (expr != NULL)
9959 prepare_vimvar(VV_VAL, &save_val);
9960 expr = skipwhite(expr);
9962 /* We reset "did_emsg" to be able to detect whether an error
9963 * occurred during evaluation of the expression. */
9964 save_did_emsg = did_emsg;
9965 did_emsg = FALSE;
9967 prepare_vimvar(VV_KEY, &save_key);
9968 if (argvars[0].v_type == VAR_DICT)
9970 vimvars[VV_KEY].vv_type = VAR_STRING;
9972 ht = &d->dv_hashtab;
9973 hash_lock(ht);
9974 todo = (int)ht->ht_used;
9975 for (hi = ht->ht_array; todo > 0; ++hi)
9977 if (!HASHITEM_EMPTY(hi))
9979 --todo;
9980 di = HI2DI(hi);
9981 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9982 break;
9983 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9984 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9985 || did_emsg)
9986 break;
9987 if (!map && rem)
9988 dictitem_remove(d, di);
9989 clear_tv(&vimvars[VV_KEY].vv_tv);
9992 hash_unlock(ht);
9994 else
9996 vimvars[VV_KEY].vv_type = VAR_NUMBER;
9998 for (li = l->lv_first; li != NULL; li = nli)
10000 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10001 break;
10002 nli = li->li_next;
10003 vimvars[VV_KEY].vv_nr = index;
10004 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10005 || did_emsg)
10006 break;
10007 if (!map && rem)
10008 listitem_remove(l, li);
10009 ++index;
10013 restore_vimvar(VV_KEY, &save_key);
10014 restore_vimvar(VV_VAL, &save_val);
10016 did_emsg |= save_did_emsg;
10019 copy_tv(&argvars[0], rettv);
10022 static int
10023 filter_map_one(tv, expr, map, remp)
10024 typval_T *tv;
10025 char_u *expr;
10026 int map;
10027 int *remp;
10029 typval_T rettv;
10030 char_u *s;
10031 int retval = FAIL;
10033 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10034 s = expr;
10035 if (eval1(&s, &rettv, TRUE) == FAIL)
10036 goto theend;
10037 if (*s != NUL) /* check for trailing chars after expr */
10039 EMSG2(_(e_invexpr2), s);
10040 goto theend;
10042 if (map)
10044 /* map(): replace the list item value */
10045 clear_tv(tv);
10046 rettv.v_lock = 0;
10047 *tv = rettv;
10049 else
10051 int error = FALSE;
10053 /* filter(): when expr is zero remove the item */
10054 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10055 clear_tv(&rettv);
10056 /* On type error, nothing has been removed; return FAIL to stop the
10057 * loop. The error message was given by get_tv_number_chk(). */
10058 if (error)
10059 goto theend;
10061 retval = OK;
10062 theend:
10063 clear_tv(&vimvars[VV_VAL].vv_tv);
10064 return retval;
10068 * "filter()" function
10070 static void
10071 f_filter(argvars, rettv)
10072 typval_T *argvars;
10073 typval_T *rettv;
10075 filter_map(argvars, rettv, FALSE);
10079 * "finddir({fname}[, {path}[, {count}]])" function
10081 static void
10082 f_finddir(argvars, rettv)
10083 typval_T *argvars;
10084 typval_T *rettv;
10086 findfilendir(argvars, rettv, FINDFILE_DIR);
10090 * "findfile({fname}[, {path}[, {count}]])" function
10092 static void
10093 f_findfile(argvars, rettv)
10094 typval_T *argvars;
10095 typval_T *rettv;
10097 findfilendir(argvars, rettv, FINDFILE_FILE);
10100 #ifdef FEAT_FLOAT
10102 * "float2nr({float})" function
10104 static void
10105 f_float2nr(argvars, rettv)
10106 typval_T *argvars;
10107 typval_T *rettv;
10109 float_T f;
10111 if (get_float_arg(argvars, &f) == OK)
10113 if (f < -0x7fffffff)
10114 rettv->vval.v_number = -0x7fffffff;
10115 else if (f > 0x7fffffff)
10116 rettv->vval.v_number = 0x7fffffff;
10117 else
10118 rettv->vval.v_number = (varnumber_T)f;
10123 * "floor({float})" function
10125 static void
10126 f_floor(argvars, rettv)
10127 typval_T *argvars;
10128 typval_T *rettv;
10130 float_T f;
10132 rettv->v_type = VAR_FLOAT;
10133 if (get_float_arg(argvars, &f) == OK)
10134 rettv->vval.v_float = floor(f);
10135 else
10136 rettv->vval.v_float = 0.0;
10138 #endif
10141 * "fnameescape({string})" function
10143 static void
10144 f_fnameescape(argvars, rettv)
10145 typval_T *argvars;
10146 typval_T *rettv;
10148 rettv->vval.v_string = vim_strsave_fnameescape(
10149 get_tv_string(&argvars[0]), FALSE);
10150 rettv->v_type = VAR_STRING;
10154 * "fnamemodify({fname}, {mods})" function
10156 static void
10157 f_fnamemodify(argvars, rettv)
10158 typval_T *argvars;
10159 typval_T *rettv;
10161 char_u *fname;
10162 char_u *mods;
10163 int usedlen = 0;
10164 int len;
10165 char_u *fbuf = NULL;
10166 char_u buf[NUMBUFLEN];
10168 fname = get_tv_string_chk(&argvars[0]);
10169 mods = get_tv_string_buf_chk(&argvars[1], buf);
10170 if (fname == NULL || mods == NULL)
10171 fname = NULL;
10172 else
10174 len = (int)STRLEN(fname);
10175 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10178 rettv->v_type = VAR_STRING;
10179 if (fname == NULL)
10180 rettv->vval.v_string = NULL;
10181 else
10182 rettv->vval.v_string = vim_strnsave(fname, len);
10183 vim_free(fbuf);
10186 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10189 * "foldclosed()" function
10191 static void
10192 foldclosed_both(argvars, rettv, end)
10193 typval_T *argvars;
10194 typval_T *rettv;
10195 int end;
10197 #ifdef FEAT_FOLDING
10198 linenr_T lnum;
10199 linenr_T first, last;
10201 lnum = get_tv_lnum(argvars);
10202 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10204 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10206 if (end)
10207 rettv->vval.v_number = (varnumber_T)last;
10208 else
10209 rettv->vval.v_number = (varnumber_T)first;
10210 return;
10213 #endif
10214 rettv->vval.v_number = -1;
10218 * "foldclosed()" function
10220 static void
10221 f_foldclosed(argvars, rettv)
10222 typval_T *argvars;
10223 typval_T *rettv;
10225 foldclosed_both(argvars, rettv, FALSE);
10229 * "foldclosedend()" function
10231 static void
10232 f_foldclosedend(argvars, rettv)
10233 typval_T *argvars;
10234 typval_T *rettv;
10236 foldclosed_both(argvars, rettv, TRUE);
10240 * "foldlevel()" function
10242 static void
10243 f_foldlevel(argvars, rettv)
10244 typval_T *argvars;
10245 typval_T *rettv;
10247 #ifdef FEAT_FOLDING
10248 linenr_T lnum;
10250 lnum = get_tv_lnum(argvars);
10251 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10252 rettv->vval.v_number = foldLevel(lnum);
10253 #endif
10257 * "foldtext()" function
10259 static void
10260 f_foldtext(argvars, rettv)
10261 typval_T *argvars UNUSED;
10262 typval_T *rettv;
10264 #ifdef FEAT_FOLDING
10265 linenr_T lnum;
10266 char_u *s;
10267 char_u *r;
10268 int len;
10269 char *txt;
10270 #endif
10272 rettv->v_type = VAR_STRING;
10273 rettv->vval.v_string = NULL;
10274 #ifdef FEAT_FOLDING
10275 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10276 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10277 <= curbuf->b_ml.ml_line_count
10278 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10280 /* Find first non-empty line in the fold. */
10281 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10282 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10284 if (!linewhite(lnum))
10285 break;
10286 ++lnum;
10289 /* Find interesting text in this line. */
10290 s = skipwhite(ml_get(lnum));
10291 /* skip C comment-start */
10292 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10294 s = skipwhite(s + 2);
10295 if (*skipwhite(s) == NUL
10296 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10298 s = skipwhite(ml_get(lnum + 1));
10299 if (*s == '*')
10300 s = skipwhite(s + 1);
10303 txt = _("+-%s%3ld lines: ");
10304 r = alloc((unsigned)(STRLEN(txt)
10305 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10306 + 20 /* for %3ld */
10307 + STRLEN(s))); /* concatenated */
10308 if (r != NULL)
10310 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10311 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10312 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10313 len = (int)STRLEN(r);
10314 STRCAT(r, s);
10315 /* remove 'foldmarker' and 'commentstring' */
10316 foldtext_cleanup(r + len);
10317 rettv->vval.v_string = r;
10320 #endif
10324 * "foldtextresult(lnum)" function
10326 static void
10327 f_foldtextresult(argvars, rettv)
10328 typval_T *argvars UNUSED;
10329 typval_T *rettv;
10331 #ifdef FEAT_FOLDING
10332 linenr_T lnum;
10333 char_u *text;
10334 char_u buf[51];
10335 foldinfo_T foldinfo;
10336 int fold_count;
10337 #endif
10339 rettv->v_type = VAR_STRING;
10340 rettv->vval.v_string = NULL;
10341 #ifdef FEAT_FOLDING
10342 lnum = get_tv_lnum(argvars);
10343 /* treat illegal types and illegal string values for {lnum} the same */
10344 if (lnum < 0)
10345 lnum = 0;
10346 fold_count = foldedCount(curwin, lnum, &foldinfo);
10347 if (fold_count > 0)
10349 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10350 &foldinfo, buf);
10351 if (text == buf)
10352 text = vim_strsave(text);
10353 rettv->vval.v_string = text;
10355 #endif
10359 * "foreground()" function
10361 static void
10362 f_foreground(argvars, rettv)
10363 typval_T *argvars UNUSED;
10364 typval_T *rettv UNUSED;
10366 #ifdef FEAT_GUI
10367 if (gui.in_use)
10368 gui_mch_set_foreground();
10369 #else
10370 # ifdef WIN32
10371 win32_set_foreground();
10372 # endif
10373 #endif
10377 * "function()" function
10379 static void
10380 f_function(argvars, rettv)
10381 typval_T *argvars;
10382 typval_T *rettv;
10384 char_u *s;
10386 s = get_tv_string(&argvars[0]);
10387 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10388 EMSG2(_(e_invarg2), s);
10389 /* Don't check an autoload name for existence here. */
10390 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10391 EMSG2(_("E700: Unknown function: %s"), s);
10392 else
10394 rettv->vval.v_string = vim_strsave(s);
10395 rettv->v_type = VAR_FUNC;
10400 * "garbagecollect()" function
10402 static void
10403 f_garbagecollect(argvars, rettv)
10404 typval_T *argvars;
10405 typval_T *rettv UNUSED;
10407 /* This is postponed until we are back at the toplevel, because we may be
10408 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10409 want_garbage_collect = TRUE;
10411 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10412 garbage_collect_at_exit = TRUE;
10416 * "get()" function
10418 static void
10419 f_get(argvars, rettv)
10420 typval_T *argvars;
10421 typval_T *rettv;
10423 listitem_T *li;
10424 list_T *l;
10425 dictitem_T *di;
10426 dict_T *d;
10427 typval_T *tv = NULL;
10429 if (argvars[0].v_type == VAR_LIST)
10431 if ((l = argvars[0].vval.v_list) != NULL)
10433 int error = FALSE;
10435 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10436 if (!error && li != NULL)
10437 tv = &li->li_tv;
10440 else if (argvars[0].v_type == VAR_DICT)
10442 if ((d = argvars[0].vval.v_dict) != NULL)
10444 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10445 if (di != NULL)
10446 tv = &di->di_tv;
10449 else
10450 EMSG2(_(e_listdictarg), "get()");
10452 if (tv == NULL)
10454 if (argvars[2].v_type != VAR_UNKNOWN)
10455 copy_tv(&argvars[2], rettv);
10457 else
10458 copy_tv(tv, rettv);
10461 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10464 * Get line or list of lines from buffer "buf" into "rettv".
10465 * Return a range (from start to end) of lines in rettv from the specified
10466 * buffer.
10467 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10469 static void
10470 get_buffer_lines(buf, start, end, retlist, rettv)
10471 buf_T *buf;
10472 linenr_T start;
10473 linenr_T end;
10474 int retlist;
10475 typval_T *rettv;
10477 char_u *p;
10479 if (retlist && rettv_list_alloc(rettv) == FAIL)
10480 return;
10482 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10483 return;
10485 if (!retlist)
10487 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10488 p = ml_get_buf(buf, start, FALSE);
10489 else
10490 p = (char_u *)"";
10492 rettv->v_type = VAR_STRING;
10493 rettv->vval.v_string = vim_strsave(p);
10495 else
10497 if (end < start)
10498 return;
10500 if (start < 1)
10501 start = 1;
10502 if (end > buf->b_ml.ml_line_count)
10503 end = buf->b_ml.ml_line_count;
10504 while (start <= end)
10505 if (list_append_string(rettv->vval.v_list,
10506 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10507 break;
10512 * "getbufline()" function
10514 static void
10515 f_getbufline(argvars, rettv)
10516 typval_T *argvars;
10517 typval_T *rettv;
10519 linenr_T lnum;
10520 linenr_T end;
10521 buf_T *buf;
10523 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10524 ++emsg_off;
10525 buf = get_buf_tv(&argvars[0]);
10526 --emsg_off;
10528 lnum = get_tv_lnum_buf(&argvars[1], buf);
10529 if (argvars[2].v_type == VAR_UNKNOWN)
10530 end = lnum;
10531 else
10532 end = get_tv_lnum_buf(&argvars[2], buf);
10534 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10538 * "getbufvar()" function
10540 static void
10541 f_getbufvar(argvars, rettv)
10542 typval_T *argvars;
10543 typval_T *rettv;
10545 buf_T *buf;
10546 buf_T *save_curbuf;
10547 char_u *varname;
10548 dictitem_T *v;
10550 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10551 varname = get_tv_string_chk(&argvars[1]);
10552 ++emsg_off;
10553 buf = get_buf_tv(&argvars[0]);
10555 rettv->v_type = VAR_STRING;
10556 rettv->vval.v_string = NULL;
10558 if (buf != NULL && varname != NULL)
10560 /* set curbuf to be our buf, temporarily */
10561 save_curbuf = curbuf;
10562 curbuf = buf;
10564 if (*varname == '&') /* buffer-local-option */
10565 get_option_tv(&varname, rettv, TRUE);
10566 else
10568 if (*varname == NUL)
10569 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10570 * scope prefix before the NUL byte is required by
10571 * find_var_in_ht(). */
10572 varname = (char_u *)"b:" + 2;
10573 /* look up the variable */
10574 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10575 if (v != NULL)
10576 copy_tv(&v->di_tv, rettv);
10579 /* restore previous notion of curbuf */
10580 curbuf = save_curbuf;
10583 --emsg_off;
10587 * "getchar()" function
10589 static void
10590 f_getchar(argvars, rettv)
10591 typval_T *argvars;
10592 typval_T *rettv;
10594 varnumber_T n;
10595 int error = FALSE;
10597 /* Position the cursor. Needed after a message that ends in a space. */
10598 windgoto(msg_row, msg_col);
10600 ++no_mapping;
10601 ++allow_keys;
10602 for (;;)
10604 if (argvars[0].v_type == VAR_UNKNOWN)
10605 /* getchar(): blocking wait. */
10606 n = safe_vgetc();
10607 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10608 /* getchar(1): only check if char avail */
10609 n = vpeekc();
10610 else if (error || vpeekc() == NUL)
10611 /* illegal argument or getchar(0) and no char avail: return zero */
10612 n = 0;
10613 else
10614 /* getchar(0) and char avail: return char */
10615 n = safe_vgetc();
10616 if (n == K_IGNORE)
10617 continue;
10618 break;
10620 --no_mapping;
10621 --allow_keys;
10623 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10624 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10625 vimvars[VV_MOUSE_COL].vv_nr = 0;
10627 rettv->vval.v_number = n;
10628 if (IS_SPECIAL(n) || mod_mask != 0)
10630 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10631 int i = 0;
10633 /* Turn a special key into three bytes, plus modifier. */
10634 if (mod_mask != 0)
10636 temp[i++] = K_SPECIAL;
10637 temp[i++] = KS_MODIFIER;
10638 temp[i++] = mod_mask;
10640 if (IS_SPECIAL(n))
10642 temp[i++] = K_SPECIAL;
10643 temp[i++] = K_SECOND(n);
10644 temp[i++] = K_THIRD(n);
10646 #ifdef FEAT_MBYTE
10647 else if (has_mbyte)
10648 i += (*mb_char2bytes)(n, temp + i);
10649 #endif
10650 else
10651 temp[i++] = n;
10652 temp[i++] = NUL;
10653 rettv->v_type = VAR_STRING;
10654 rettv->vval.v_string = vim_strsave(temp);
10656 #ifdef FEAT_MOUSE
10657 if (n == K_LEFTMOUSE
10658 || n == K_LEFTMOUSE_NM
10659 || n == K_LEFTDRAG
10660 || n == K_LEFTRELEASE
10661 || n == K_LEFTRELEASE_NM
10662 || n == K_MIDDLEMOUSE
10663 || n == K_MIDDLEDRAG
10664 || n == K_MIDDLERELEASE
10665 || n == K_RIGHTMOUSE
10666 || n == K_RIGHTDRAG
10667 || n == K_RIGHTRELEASE
10668 || n == K_X1MOUSE
10669 || n == K_X1DRAG
10670 || n == K_X1RELEASE
10671 || n == K_X2MOUSE
10672 || n == K_X2DRAG
10673 || n == K_X2RELEASE
10674 || n == K_MOUSEDOWN
10675 || n == K_MOUSEUP)
10677 int row = mouse_row;
10678 int col = mouse_col;
10679 win_T *win;
10680 linenr_T lnum;
10681 # ifdef FEAT_WINDOWS
10682 win_T *wp;
10683 # endif
10684 int winnr = 1;
10686 if (row >= 0 && col >= 0)
10688 /* Find the window at the mouse coordinates and compute the
10689 * text position. */
10690 win = mouse_find_win(&row, &col);
10691 (void)mouse_comp_pos(win, &row, &col, &lnum);
10692 # ifdef FEAT_WINDOWS
10693 for (wp = firstwin; wp != win; wp = wp->w_next)
10694 ++winnr;
10695 # endif
10696 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10697 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10698 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10701 #endif
10706 * "getcharmod()" function
10708 static void
10709 f_getcharmod(argvars, rettv)
10710 typval_T *argvars UNUSED;
10711 typval_T *rettv;
10713 rettv->vval.v_number = mod_mask;
10717 * "getcmdline()" function
10719 static void
10720 f_getcmdline(argvars, rettv)
10721 typval_T *argvars UNUSED;
10722 typval_T *rettv;
10724 rettv->v_type = VAR_STRING;
10725 rettv->vval.v_string = get_cmdline_str();
10729 * "getcmdpos()" function
10731 static void
10732 f_getcmdpos(argvars, rettv)
10733 typval_T *argvars UNUSED;
10734 typval_T *rettv;
10736 rettv->vval.v_number = get_cmdline_pos() + 1;
10740 * "getcmdtype()" function
10742 static void
10743 f_getcmdtype(argvars, rettv)
10744 typval_T *argvars UNUSED;
10745 typval_T *rettv;
10747 rettv->v_type = VAR_STRING;
10748 rettv->vval.v_string = alloc(2);
10749 if (rettv->vval.v_string != NULL)
10751 rettv->vval.v_string[0] = get_cmdline_type();
10752 rettv->vval.v_string[1] = NUL;
10757 * "getcwd()" function
10759 static void
10760 f_getcwd(argvars, rettv)
10761 typval_T *argvars UNUSED;
10762 typval_T *rettv;
10764 char_u cwd[MAXPATHL];
10766 rettv->v_type = VAR_STRING;
10767 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10768 rettv->vval.v_string = NULL;
10769 else
10771 rettv->vval.v_string = vim_strsave(cwd);
10772 #ifdef BACKSLASH_IN_FILENAME
10773 if (rettv->vval.v_string != NULL)
10774 slash_adjust(rettv->vval.v_string);
10775 #endif
10780 * "getfontname()" function
10782 static void
10783 f_getfontname(argvars, rettv)
10784 typval_T *argvars UNUSED;
10785 typval_T *rettv;
10787 rettv->v_type = VAR_STRING;
10788 rettv->vval.v_string = NULL;
10789 #ifdef FEAT_GUI
10790 if (gui.in_use)
10792 GuiFont font;
10793 char_u *name = NULL;
10795 if (argvars[0].v_type == VAR_UNKNOWN)
10797 /* Get the "Normal" font. Either the name saved by
10798 * hl_set_font_name() or from the font ID. */
10799 font = gui.norm_font;
10800 name = hl_get_font_name();
10802 else
10804 name = get_tv_string(&argvars[0]);
10805 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10806 return;
10807 font = gui_mch_get_font(name, FALSE);
10808 if (font == NOFONT)
10809 return; /* Invalid font name, return empty string. */
10811 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10812 if (argvars[0].v_type != VAR_UNKNOWN)
10813 gui_mch_free_font(font);
10815 #endif
10819 * "getfperm({fname})" function
10821 static void
10822 f_getfperm(argvars, rettv)
10823 typval_T *argvars;
10824 typval_T *rettv;
10826 char_u *fname;
10827 struct stat st;
10828 char_u *perm = NULL;
10829 char_u flags[] = "rwx";
10830 int i;
10832 fname = get_tv_string(&argvars[0]);
10834 rettv->v_type = VAR_STRING;
10835 if (mch_stat((char *)fname, &st) >= 0)
10837 perm = vim_strsave((char_u *)"---------");
10838 if (perm != NULL)
10840 for (i = 0; i < 9; i++)
10842 if (st.st_mode & (1 << (8 - i)))
10843 perm[i] = flags[i % 3];
10847 rettv->vval.v_string = perm;
10851 * "getfsize({fname})" function
10853 static void
10854 f_getfsize(argvars, rettv)
10855 typval_T *argvars;
10856 typval_T *rettv;
10858 char_u *fname;
10859 struct stat st;
10861 fname = get_tv_string(&argvars[0]);
10863 rettv->v_type = VAR_NUMBER;
10865 if (mch_stat((char *)fname, &st) >= 0)
10867 if (mch_isdir(fname))
10868 rettv->vval.v_number = 0;
10869 else
10871 rettv->vval.v_number = (varnumber_T)st.st_size;
10873 /* non-perfect check for overflow */
10874 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10875 rettv->vval.v_number = -2;
10878 else
10879 rettv->vval.v_number = -1;
10883 * "getftime({fname})" function
10885 static void
10886 f_getftime(argvars, rettv)
10887 typval_T *argvars;
10888 typval_T *rettv;
10890 char_u *fname;
10891 struct stat st;
10893 fname = get_tv_string(&argvars[0]);
10895 if (mch_stat((char *)fname, &st) >= 0)
10896 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10897 else
10898 rettv->vval.v_number = -1;
10902 * "getftype({fname})" function
10904 static void
10905 f_getftype(argvars, rettv)
10906 typval_T *argvars;
10907 typval_T *rettv;
10909 char_u *fname;
10910 struct stat st;
10911 char_u *type = NULL;
10912 char *t;
10914 fname = get_tv_string(&argvars[0]);
10916 rettv->v_type = VAR_STRING;
10917 if (mch_lstat((char *)fname, &st) >= 0)
10919 #ifdef S_ISREG
10920 if (S_ISREG(st.st_mode))
10921 t = "file";
10922 else if (S_ISDIR(st.st_mode))
10923 t = "dir";
10924 # ifdef S_ISLNK
10925 else if (S_ISLNK(st.st_mode))
10926 t = "link";
10927 # endif
10928 # ifdef S_ISBLK
10929 else if (S_ISBLK(st.st_mode))
10930 t = "bdev";
10931 # endif
10932 # ifdef S_ISCHR
10933 else if (S_ISCHR(st.st_mode))
10934 t = "cdev";
10935 # endif
10936 # ifdef S_ISFIFO
10937 else if (S_ISFIFO(st.st_mode))
10938 t = "fifo";
10939 # endif
10940 # ifdef S_ISSOCK
10941 else if (S_ISSOCK(st.st_mode))
10942 t = "fifo";
10943 # endif
10944 else
10945 t = "other";
10946 #else
10947 # ifdef S_IFMT
10948 switch (st.st_mode & S_IFMT)
10950 case S_IFREG: t = "file"; break;
10951 case S_IFDIR: t = "dir"; break;
10952 # ifdef S_IFLNK
10953 case S_IFLNK: t = "link"; break;
10954 # endif
10955 # ifdef S_IFBLK
10956 case S_IFBLK: t = "bdev"; break;
10957 # endif
10958 # ifdef S_IFCHR
10959 case S_IFCHR: t = "cdev"; break;
10960 # endif
10961 # ifdef S_IFIFO
10962 case S_IFIFO: t = "fifo"; break;
10963 # endif
10964 # ifdef S_IFSOCK
10965 case S_IFSOCK: t = "socket"; break;
10966 # endif
10967 default: t = "other";
10969 # else
10970 if (mch_isdir(fname))
10971 t = "dir";
10972 else
10973 t = "file";
10974 # endif
10975 #endif
10976 type = vim_strsave((char_u *)t);
10978 rettv->vval.v_string = type;
10982 * "getline(lnum, [end])" function
10984 static void
10985 f_getline(argvars, rettv)
10986 typval_T *argvars;
10987 typval_T *rettv;
10989 linenr_T lnum;
10990 linenr_T end;
10991 int retlist;
10993 lnum = get_tv_lnum(argvars);
10994 if (argvars[1].v_type == VAR_UNKNOWN)
10996 end = 0;
10997 retlist = FALSE;
10999 else
11001 end = get_tv_lnum(&argvars[1]);
11002 retlist = TRUE;
11005 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11009 * "getmatches()" function
11011 static void
11012 f_getmatches(argvars, rettv)
11013 typval_T *argvars UNUSED;
11014 typval_T *rettv;
11016 #ifdef FEAT_SEARCH_EXTRA
11017 dict_T *dict;
11018 matchitem_T *cur = curwin->w_match_head;
11020 if (rettv_list_alloc(rettv) == OK)
11022 while (cur != NULL)
11024 dict = dict_alloc();
11025 if (dict == NULL)
11026 return;
11027 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11028 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11029 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11030 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11031 list_append_dict(rettv->vval.v_list, dict);
11032 cur = cur->next;
11035 #endif
11039 * "getpid()" function
11041 static void
11042 f_getpid(argvars, rettv)
11043 typval_T *argvars UNUSED;
11044 typval_T *rettv;
11046 rettv->vval.v_number = mch_get_pid();
11050 * "getpos(string)" function
11052 static void
11053 f_getpos(argvars, rettv)
11054 typval_T *argvars;
11055 typval_T *rettv;
11057 pos_T *fp;
11058 list_T *l;
11059 int fnum = -1;
11061 if (rettv_list_alloc(rettv) == OK)
11063 l = rettv->vval.v_list;
11064 fp = var2fpos(&argvars[0], TRUE, &fnum);
11065 if (fnum != -1)
11066 list_append_number(l, (varnumber_T)fnum);
11067 else
11068 list_append_number(l, (varnumber_T)0);
11069 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11070 : (varnumber_T)0);
11071 list_append_number(l, (fp != NULL)
11072 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11073 : (varnumber_T)0);
11074 list_append_number(l,
11075 #ifdef FEAT_VIRTUALEDIT
11076 (fp != NULL) ? (varnumber_T)fp->coladd :
11077 #endif
11078 (varnumber_T)0);
11080 else
11081 rettv->vval.v_number = FALSE;
11085 * "getqflist()" and "getloclist()" functions
11087 static void
11088 f_getqflist(argvars, rettv)
11089 typval_T *argvars UNUSED;
11090 typval_T *rettv UNUSED;
11092 #ifdef FEAT_QUICKFIX
11093 win_T *wp;
11094 #endif
11096 #ifdef FEAT_QUICKFIX
11097 if (rettv_list_alloc(rettv) == OK)
11099 wp = NULL;
11100 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11102 wp = find_win_by_nr(&argvars[0], NULL);
11103 if (wp == NULL)
11104 return;
11107 (void)get_errorlist(wp, rettv->vval.v_list);
11109 #endif
11113 * "getreg()" function
11115 static void
11116 f_getreg(argvars, rettv)
11117 typval_T *argvars;
11118 typval_T *rettv;
11120 char_u *strregname;
11121 int regname;
11122 int arg2 = FALSE;
11123 int error = FALSE;
11125 if (argvars[0].v_type != VAR_UNKNOWN)
11127 strregname = get_tv_string_chk(&argvars[0]);
11128 error = strregname == NULL;
11129 if (argvars[1].v_type != VAR_UNKNOWN)
11130 arg2 = get_tv_number_chk(&argvars[1], &error);
11132 else
11133 strregname = vimvars[VV_REG].vv_str;
11134 regname = (strregname == NULL ? '"' : *strregname);
11135 if (regname == 0)
11136 regname = '"';
11138 rettv->v_type = VAR_STRING;
11139 rettv->vval.v_string = error ? NULL :
11140 get_reg_contents(regname, TRUE, arg2);
11144 * "getregtype()" function
11146 static void
11147 f_getregtype(argvars, rettv)
11148 typval_T *argvars;
11149 typval_T *rettv;
11151 char_u *strregname;
11152 int regname;
11153 char_u buf[NUMBUFLEN + 2];
11154 long reglen = 0;
11156 if (argvars[0].v_type != VAR_UNKNOWN)
11158 strregname = get_tv_string_chk(&argvars[0]);
11159 if (strregname == NULL) /* type error; errmsg already given */
11161 rettv->v_type = VAR_STRING;
11162 rettv->vval.v_string = NULL;
11163 return;
11166 else
11167 /* Default to v:register */
11168 strregname = vimvars[VV_REG].vv_str;
11170 regname = (strregname == NULL ? '"' : *strregname);
11171 if (regname == 0)
11172 regname = '"';
11174 buf[0] = NUL;
11175 buf[1] = NUL;
11176 switch (get_reg_type(regname, &reglen))
11178 case MLINE: buf[0] = 'V'; break;
11179 case MCHAR: buf[0] = 'v'; break;
11180 #ifdef FEAT_VISUAL
11181 case MBLOCK:
11182 buf[0] = Ctrl_V;
11183 sprintf((char *)buf + 1, "%ld", reglen + 1);
11184 break;
11185 #endif
11187 rettv->v_type = VAR_STRING;
11188 rettv->vval.v_string = vim_strsave(buf);
11192 * "gettabwinvar()" function
11194 static void
11195 f_gettabwinvar(argvars, rettv)
11196 typval_T *argvars;
11197 typval_T *rettv;
11199 getwinvar(argvars, rettv, 1);
11203 * "getwinposx()" function
11205 static void
11206 f_getwinposx(argvars, rettv)
11207 typval_T *argvars UNUSED;
11208 typval_T *rettv;
11210 rettv->vval.v_number = -1;
11211 #ifdef FEAT_GUI
11212 if (gui.in_use)
11214 int x, y;
11216 if (gui_mch_get_winpos(&x, &y) == OK)
11217 rettv->vval.v_number = x;
11219 #endif
11223 * "getwinposy()" function
11225 static void
11226 f_getwinposy(argvars, rettv)
11227 typval_T *argvars UNUSED;
11228 typval_T *rettv;
11230 rettv->vval.v_number = -1;
11231 #ifdef FEAT_GUI
11232 if (gui.in_use)
11234 int x, y;
11236 if (gui_mch_get_winpos(&x, &y) == OK)
11237 rettv->vval.v_number = y;
11239 #endif
11243 * Find window specified by "vp" in tabpage "tp".
11245 static win_T *
11246 find_win_by_nr(vp, tp)
11247 typval_T *vp;
11248 tabpage_T *tp; /* NULL for current tab page */
11250 #ifdef FEAT_WINDOWS
11251 win_T *wp;
11252 #endif
11253 int nr;
11255 nr = get_tv_number_chk(vp, NULL);
11257 #ifdef FEAT_WINDOWS
11258 if (nr < 0)
11259 return NULL;
11260 if (nr == 0)
11261 return curwin;
11263 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11264 wp != NULL; wp = wp->w_next)
11265 if (--nr <= 0)
11266 break;
11267 return wp;
11268 #else
11269 if (nr == 0 || nr == 1)
11270 return curwin;
11271 return NULL;
11272 #endif
11276 * "getwinvar()" function
11278 static void
11279 f_getwinvar(argvars, rettv)
11280 typval_T *argvars;
11281 typval_T *rettv;
11283 getwinvar(argvars, rettv, 0);
11287 * getwinvar() and gettabwinvar()
11289 static void
11290 getwinvar(argvars, rettv, off)
11291 typval_T *argvars;
11292 typval_T *rettv;
11293 int off; /* 1 for gettabwinvar() */
11295 win_T *win, *oldcurwin;
11296 char_u *varname;
11297 dictitem_T *v;
11298 tabpage_T *tp;
11300 #ifdef FEAT_WINDOWS
11301 if (off == 1)
11302 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11303 else
11304 tp = curtab;
11305 #endif
11306 win = find_win_by_nr(&argvars[off], tp);
11307 varname = get_tv_string_chk(&argvars[off + 1]);
11308 ++emsg_off;
11310 rettv->v_type = VAR_STRING;
11311 rettv->vval.v_string = NULL;
11313 if (win != NULL && varname != NULL)
11315 /* Set curwin to be our win, temporarily. Also set curbuf, so
11316 * that we can get buffer-local options. */
11317 oldcurwin = curwin;
11318 curwin = win;
11319 curbuf = win->w_buffer;
11321 if (*varname == '&') /* window-local-option */
11322 get_option_tv(&varname, rettv, 1);
11323 else
11325 if (*varname == NUL)
11326 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11327 * scope prefix before the NUL byte is required by
11328 * find_var_in_ht(). */
11329 varname = (char_u *)"w:" + 2;
11330 /* look up the variable */
11331 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11332 if (v != NULL)
11333 copy_tv(&v->di_tv, rettv);
11336 /* restore previous notion of curwin */
11337 curwin = oldcurwin;
11338 curbuf = curwin->w_buffer;
11341 --emsg_off;
11345 * "glob()" function
11347 static void
11348 f_glob(argvars, rettv)
11349 typval_T *argvars;
11350 typval_T *rettv;
11352 int flags = WILD_SILENT|WILD_USE_NL;
11353 expand_T xpc;
11354 int error = FALSE;
11356 /* When the optional second argument is non-zero, don't remove matches
11357 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11358 if (argvars[1].v_type != VAR_UNKNOWN
11359 && get_tv_number_chk(&argvars[1], &error))
11360 flags |= WILD_KEEP_ALL;
11361 rettv->v_type = VAR_STRING;
11362 if (!error)
11364 ExpandInit(&xpc);
11365 xpc.xp_context = EXPAND_FILES;
11366 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11367 NULL, flags, WILD_ALL);
11369 else
11370 rettv->vval.v_string = NULL;
11374 * "globpath()" function
11376 static void
11377 f_globpath(argvars, rettv)
11378 typval_T *argvars;
11379 typval_T *rettv;
11381 int flags = 0;
11382 char_u buf1[NUMBUFLEN];
11383 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11384 int error = FALSE;
11386 /* When the optional second argument is non-zero, don't remove matches
11387 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11388 if (argvars[2].v_type != VAR_UNKNOWN
11389 && get_tv_number_chk(&argvars[2], &error))
11390 flags |= WILD_KEEP_ALL;
11391 rettv->v_type = VAR_STRING;
11392 if (file == NULL || error)
11393 rettv->vval.v_string = NULL;
11394 else
11395 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11396 flags);
11400 * "has()" function
11402 static void
11403 f_has(argvars, rettv)
11404 typval_T *argvars;
11405 typval_T *rettv;
11407 int i;
11408 char_u *name;
11409 int n = FALSE;
11410 static char *(has_list[]) =
11412 #ifdef AMIGA
11413 "amiga",
11414 # ifdef FEAT_ARP
11415 "arp",
11416 # endif
11417 #endif
11418 #ifdef __BEOS__
11419 "beos",
11420 #endif
11421 #ifdef MSDOS
11422 # ifdef DJGPP
11423 "dos32",
11424 # else
11425 "dos16",
11426 # endif
11427 #endif
11428 #ifdef MACOS
11429 "mac",
11430 #endif
11431 #if defined(MACOS_X_UNIX)
11432 "macunix",
11433 #endif
11434 #ifdef OS2
11435 "os2",
11436 #endif
11437 #ifdef __QNX__
11438 "qnx",
11439 #endif
11440 #ifdef RISCOS
11441 "riscos",
11442 #endif
11443 #ifdef UNIX
11444 "unix",
11445 #endif
11446 #ifdef VMS
11447 "vms",
11448 #endif
11449 #ifdef WIN16
11450 "win16",
11451 #endif
11452 #ifdef WIN32
11453 "win32",
11454 #endif
11455 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11456 "win32unix",
11457 #endif
11458 #if defined(WIN64) || defined(_WIN64)
11459 "win64",
11460 #endif
11461 #ifdef EBCDIC
11462 "ebcdic",
11463 #endif
11464 #ifndef CASE_INSENSITIVE_FILENAME
11465 "fname_case",
11466 #endif
11467 #ifdef FEAT_ARABIC
11468 "arabic",
11469 #endif
11470 #ifdef FEAT_AUTOCMD
11471 "autocmd",
11472 #endif
11473 #ifdef FEAT_BEVAL
11474 "balloon_eval",
11475 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11476 "balloon_multiline",
11477 # endif
11478 #endif
11479 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11480 "builtin_terms",
11481 # ifdef ALL_BUILTIN_TCAPS
11482 "all_builtin_terms",
11483 # endif
11484 #endif
11485 #ifdef FEAT_BYTEOFF
11486 "byte_offset",
11487 #endif
11488 #ifdef FEAT_CINDENT
11489 "cindent",
11490 #endif
11491 #ifdef FEAT_CLIENTSERVER
11492 "clientserver",
11493 #endif
11494 #ifdef FEAT_CLIPBOARD
11495 "clipboard",
11496 #endif
11497 #ifdef FEAT_CMDL_COMPL
11498 "cmdline_compl",
11499 #endif
11500 #ifdef FEAT_CMDHIST
11501 "cmdline_hist",
11502 #endif
11503 #ifdef FEAT_COMMENTS
11504 "comments",
11505 #endif
11506 #ifdef FEAT_CRYPT
11507 "cryptv",
11508 #endif
11509 #ifdef FEAT_CSCOPE
11510 "cscope",
11511 #endif
11512 #ifdef CURSOR_SHAPE
11513 "cursorshape",
11514 #endif
11515 #ifdef DEBUG
11516 "debug",
11517 #endif
11518 #ifdef FEAT_CON_DIALOG
11519 "dialog_con",
11520 #endif
11521 #ifdef FEAT_GUI_DIALOG
11522 "dialog_gui",
11523 #endif
11524 #ifdef FEAT_DIFF
11525 "diff",
11526 #endif
11527 #ifdef FEAT_DIGRAPHS
11528 "digraphs",
11529 #endif
11530 #ifdef FEAT_DND
11531 "dnd",
11532 #endif
11533 #ifdef FEAT_EMACS_TAGS
11534 "emacs_tags",
11535 #endif
11536 "eval", /* always present, of course! */
11537 #ifdef FEAT_EX_EXTRA
11538 "ex_extra",
11539 #endif
11540 #ifdef FEAT_SEARCH_EXTRA
11541 "extra_search",
11542 #endif
11543 #ifdef FEAT_FKMAP
11544 "farsi",
11545 #endif
11546 #ifdef FEAT_SEARCHPATH
11547 "file_in_path",
11548 #endif
11549 #if defined(UNIX) && !defined(USE_SYSTEM)
11550 "filterpipe",
11551 #endif
11552 #ifdef FEAT_FIND_ID
11553 "find_in_path",
11554 #endif
11555 #ifdef FEAT_FLOAT
11556 "float",
11557 #endif
11558 #ifdef FEAT_FOLDING
11559 "folding",
11560 #endif
11561 #ifdef FEAT_FOOTER
11562 "footer",
11563 #endif
11564 #if !defined(USE_SYSTEM) && defined(UNIX)
11565 "fork",
11566 #endif
11567 #ifdef FEAT_GETTEXT
11568 "gettext",
11569 #endif
11570 #ifdef FEAT_GUI
11571 "gui",
11572 #endif
11573 #ifdef FEAT_GUI_ATHENA
11574 # ifdef FEAT_GUI_NEXTAW
11575 "gui_neXtaw",
11576 # else
11577 "gui_athena",
11578 # endif
11579 #endif
11580 #ifdef FEAT_GUI_GTK
11581 "gui_gtk",
11582 # ifdef HAVE_GTK2
11583 "gui_gtk2",
11584 # endif
11585 #endif
11586 #ifdef FEAT_GUI_GNOME
11587 "gui_gnome",
11588 #endif
11589 #ifdef FEAT_GUI_MAC
11590 "gui_mac",
11591 #endif
11592 #ifdef FEAT_GUI_MOTIF
11593 "gui_motif",
11594 #endif
11595 #ifdef FEAT_GUI_PHOTON
11596 "gui_photon",
11597 #endif
11598 #ifdef FEAT_GUI_W16
11599 "gui_win16",
11600 #endif
11601 #ifdef FEAT_GUI_W32
11602 "gui_win32",
11603 #endif
11604 #ifdef FEAT_HANGULIN
11605 "hangul_input",
11606 #endif
11607 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11608 "iconv",
11609 #endif
11610 #ifdef FEAT_INS_EXPAND
11611 "insert_expand",
11612 #endif
11613 #ifdef FEAT_JUMPLIST
11614 "jumplist",
11615 #endif
11616 #ifdef FEAT_KEYMAP
11617 "keymap",
11618 #endif
11619 #ifdef FEAT_LANGMAP
11620 "langmap",
11621 #endif
11622 #ifdef FEAT_LIBCALL
11623 "libcall",
11624 #endif
11625 #ifdef FEAT_LINEBREAK
11626 "linebreak",
11627 #endif
11628 #ifdef FEAT_LISP
11629 "lispindent",
11630 #endif
11631 #ifdef FEAT_LISTCMDS
11632 "listcmds",
11633 #endif
11634 #ifdef FEAT_LOCALMAP
11635 "localmap",
11636 #endif
11637 #ifdef FEAT_MENU
11638 "menu",
11639 #endif
11640 #ifdef FEAT_SESSION
11641 "mksession",
11642 #endif
11643 #ifdef FEAT_MODIFY_FNAME
11644 "modify_fname",
11645 #endif
11646 #ifdef FEAT_MOUSE
11647 "mouse",
11648 #endif
11649 #ifdef FEAT_MOUSESHAPE
11650 "mouseshape",
11651 #endif
11652 #if defined(UNIX) || defined(VMS)
11653 # ifdef FEAT_MOUSE_DEC
11654 "mouse_dec",
11655 # endif
11656 # ifdef FEAT_MOUSE_GPM
11657 "mouse_gpm",
11658 # endif
11659 # ifdef FEAT_MOUSE_JSB
11660 "mouse_jsbterm",
11661 # endif
11662 # ifdef FEAT_MOUSE_NET
11663 "mouse_netterm",
11664 # endif
11665 # ifdef FEAT_MOUSE_PTERM
11666 "mouse_pterm",
11667 # endif
11668 # ifdef FEAT_SYSMOUSE
11669 "mouse_sysmouse",
11670 # endif
11671 # ifdef FEAT_MOUSE_XTERM
11672 "mouse_xterm",
11673 # endif
11674 #endif
11675 #ifdef FEAT_MBYTE
11676 "multi_byte",
11677 #endif
11678 #ifdef FEAT_MBYTE_IME
11679 "multi_byte_ime",
11680 #endif
11681 #ifdef FEAT_MULTI_LANG
11682 "multi_lang",
11683 #endif
11684 #ifdef FEAT_MZSCHEME
11685 #ifndef DYNAMIC_MZSCHEME
11686 "mzscheme",
11687 #endif
11688 #endif
11689 #ifdef FEAT_OLE
11690 "ole",
11691 #endif
11692 #ifdef FEAT_OSFILETYPE
11693 "osfiletype",
11694 #endif
11695 #ifdef FEAT_PATH_EXTRA
11696 "path_extra",
11697 #endif
11698 #ifdef FEAT_PERL
11699 #ifndef DYNAMIC_PERL
11700 "perl",
11701 #endif
11702 #endif
11703 #ifdef FEAT_PYTHON
11704 #ifndef DYNAMIC_PYTHON
11705 "python",
11706 #endif
11707 #endif
11708 #ifdef FEAT_POSTSCRIPT
11709 "postscript",
11710 #endif
11711 #ifdef FEAT_PRINTER
11712 "printer",
11713 #endif
11714 #ifdef FEAT_PROFILE
11715 "profile",
11716 #endif
11717 #ifdef FEAT_RELTIME
11718 "reltime",
11719 #endif
11720 #ifdef FEAT_QUICKFIX
11721 "quickfix",
11722 #endif
11723 #ifdef FEAT_RIGHTLEFT
11724 "rightleft",
11725 #endif
11726 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11727 "ruby",
11728 #endif
11729 #ifdef FEAT_SCROLLBIND
11730 "scrollbind",
11731 #endif
11732 #ifdef FEAT_CMDL_INFO
11733 "showcmd",
11734 "cmdline_info",
11735 #endif
11736 #ifdef FEAT_SIGNS
11737 "signs",
11738 #endif
11739 #ifdef FEAT_SMARTINDENT
11740 "smartindent",
11741 #endif
11742 #ifdef FEAT_SNIFF
11743 "sniff",
11744 #endif
11745 #ifdef STARTUPTIME
11746 "startuptime",
11747 #endif
11748 #ifdef FEAT_STL_OPT
11749 "statusline",
11750 #endif
11751 #ifdef FEAT_SUN_WORKSHOP
11752 "sun_workshop",
11753 #endif
11754 #ifdef FEAT_NETBEANS_INTG
11755 "netbeans_intg",
11756 #endif
11757 #ifdef FEAT_SPELL
11758 "spell",
11759 #endif
11760 #ifdef FEAT_SYN_HL
11761 "syntax",
11762 #endif
11763 #if defined(USE_SYSTEM) || !defined(UNIX)
11764 "system",
11765 #endif
11766 #ifdef FEAT_TAG_BINS
11767 "tag_binary",
11768 #endif
11769 #ifdef FEAT_TAG_OLDSTATIC
11770 "tag_old_static",
11771 #endif
11772 #ifdef FEAT_TAG_ANYWHITE
11773 "tag_any_white",
11774 #endif
11775 #ifdef FEAT_TCL
11776 # ifndef DYNAMIC_TCL
11777 "tcl",
11778 # endif
11779 #endif
11780 #ifdef TERMINFO
11781 "terminfo",
11782 #endif
11783 #ifdef FEAT_TERMRESPONSE
11784 "termresponse",
11785 #endif
11786 #ifdef FEAT_TEXTOBJ
11787 "textobjects",
11788 #endif
11789 #ifdef HAVE_TGETENT
11790 "tgetent",
11791 #endif
11792 #ifdef FEAT_TITLE
11793 "title",
11794 #endif
11795 #ifdef FEAT_TOOLBAR
11796 "toolbar",
11797 #endif
11798 #ifdef FEAT_USR_CMDS
11799 "user-commands", /* was accidentally included in 5.4 */
11800 "user_commands",
11801 #endif
11802 #ifdef FEAT_VIMINFO
11803 "viminfo",
11804 #endif
11805 #ifdef FEAT_VERTSPLIT
11806 "vertsplit",
11807 #endif
11808 #ifdef FEAT_VIRTUALEDIT
11809 "virtualedit",
11810 #endif
11811 #ifdef FEAT_VISUAL
11812 "visual",
11813 #endif
11814 #ifdef FEAT_VISUALEXTRA
11815 "visualextra",
11816 #endif
11817 #ifdef FEAT_VREPLACE
11818 "vreplace",
11819 #endif
11820 #ifdef FEAT_WILDIGN
11821 "wildignore",
11822 #endif
11823 #ifdef FEAT_WILDMENU
11824 "wildmenu",
11825 #endif
11826 #ifdef FEAT_WINDOWS
11827 "windows",
11828 #endif
11829 #ifdef FEAT_WAK
11830 "winaltkeys",
11831 #endif
11832 #ifdef FEAT_WRITEBACKUP
11833 "writebackup",
11834 #endif
11835 #ifdef FEAT_XIM
11836 "xim",
11837 #endif
11838 #ifdef FEAT_XFONTSET
11839 "xfontset",
11840 #endif
11841 #ifdef USE_XSMP
11842 "xsmp",
11843 #endif
11844 #ifdef USE_XSMP_INTERACT
11845 "xsmp_interact",
11846 #endif
11847 #ifdef FEAT_XCLIPBOARD
11848 "xterm_clipboard",
11849 #endif
11850 #ifdef FEAT_XTERM_SAVE
11851 "xterm_save",
11852 #endif
11853 #if defined(UNIX) && defined(FEAT_X11)
11854 "X11",
11855 #endif
11856 NULL
11859 name = get_tv_string(&argvars[0]);
11860 for (i = 0; has_list[i] != NULL; ++i)
11861 if (STRICMP(name, has_list[i]) == 0)
11863 n = TRUE;
11864 break;
11867 if (n == FALSE)
11869 if (STRNICMP(name, "patch", 5) == 0)
11870 n = has_patch(atoi((char *)name + 5));
11871 else if (STRICMP(name, "vim_starting") == 0)
11872 n = (starting != 0);
11873 #ifdef FEAT_MBYTE
11874 else if (STRICMP(name, "multi_byte_encoding") == 0)
11875 n = has_mbyte;
11876 #endif
11877 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11878 else if (STRICMP(name, "balloon_multiline") == 0)
11879 n = multiline_balloon_available();
11880 #endif
11881 #ifdef DYNAMIC_TCL
11882 else if (STRICMP(name, "tcl") == 0)
11883 n = tcl_enabled(FALSE);
11884 #endif
11885 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11886 else if (STRICMP(name, "iconv") == 0)
11887 n = iconv_enabled(FALSE);
11888 #endif
11889 #ifdef DYNAMIC_MZSCHEME
11890 else if (STRICMP(name, "mzscheme") == 0)
11891 n = mzscheme_enabled(FALSE);
11892 #endif
11893 #ifdef DYNAMIC_RUBY
11894 else if (STRICMP(name, "ruby") == 0)
11895 n = ruby_enabled(FALSE);
11896 #endif
11897 #ifdef DYNAMIC_PYTHON
11898 else if (STRICMP(name, "python") == 0)
11899 n = python_enabled(FALSE);
11900 #endif
11901 #ifdef DYNAMIC_PERL
11902 else if (STRICMP(name, "perl") == 0)
11903 n = perl_enabled(FALSE);
11904 #endif
11905 #ifdef FEAT_GUI
11906 else if (STRICMP(name, "gui_running") == 0)
11907 n = (gui.in_use || gui.starting);
11908 # ifdef FEAT_GUI_W32
11909 else if (STRICMP(name, "gui_win32s") == 0)
11910 n = gui_is_win32s();
11911 # endif
11912 # ifdef FEAT_BROWSE
11913 else if (STRICMP(name, "browse") == 0)
11914 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11915 # endif
11916 #endif
11917 #ifdef FEAT_SYN_HL
11918 else if (STRICMP(name, "syntax_items") == 0)
11919 n = syntax_present(curbuf);
11920 #endif
11921 #if defined(WIN3264)
11922 else if (STRICMP(name, "win95") == 0)
11923 n = mch_windows95();
11924 #endif
11925 #ifdef FEAT_NETBEANS_INTG
11926 else if (STRICMP(name, "netbeans_enabled") == 0)
11927 n = usingNetbeans;
11928 #endif
11931 rettv->vval.v_number = n;
11935 * "has_key()" function
11937 static void
11938 f_has_key(argvars, rettv)
11939 typval_T *argvars;
11940 typval_T *rettv;
11942 if (argvars[0].v_type != VAR_DICT)
11944 EMSG(_(e_dictreq));
11945 return;
11947 if (argvars[0].vval.v_dict == NULL)
11948 return;
11950 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11951 get_tv_string(&argvars[1]), -1) != NULL;
11955 * "haslocaldir()" function
11957 static void
11958 f_haslocaldir(argvars, rettv)
11959 typval_T *argvars UNUSED;
11960 typval_T *rettv;
11962 rettv->vval.v_number = (curwin->w_localdir != NULL);
11966 * "hasmapto()" function
11968 static void
11969 f_hasmapto(argvars, rettv)
11970 typval_T *argvars;
11971 typval_T *rettv;
11973 char_u *name;
11974 char_u *mode;
11975 char_u buf[NUMBUFLEN];
11976 int abbr = FALSE;
11978 name = get_tv_string(&argvars[0]);
11979 if (argvars[1].v_type == VAR_UNKNOWN)
11980 mode = (char_u *)"nvo";
11981 else
11983 mode = get_tv_string_buf(&argvars[1], buf);
11984 if (argvars[2].v_type != VAR_UNKNOWN)
11985 abbr = get_tv_number(&argvars[2]);
11988 if (map_to_exists(name, mode, abbr))
11989 rettv->vval.v_number = TRUE;
11990 else
11991 rettv->vval.v_number = FALSE;
11995 * "histadd()" function
11997 static void
11998 f_histadd(argvars, rettv)
11999 typval_T *argvars UNUSED;
12000 typval_T *rettv;
12002 #ifdef FEAT_CMDHIST
12003 int histype;
12004 char_u *str;
12005 char_u buf[NUMBUFLEN];
12006 #endif
12008 rettv->vval.v_number = FALSE;
12009 if (check_restricted() || check_secure())
12010 return;
12011 #ifdef FEAT_CMDHIST
12012 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12013 histype = str != NULL ? get_histtype(str) : -1;
12014 if (histype >= 0)
12016 str = get_tv_string_buf(&argvars[1], buf);
12017 if (*str != NUL)
12019 init_history();
12020 add_to_history(histype, str, FALSE, NUL);
12021 rettv->vval.v_number = TRUE;
12022 return;
12025 #endif
12029 * "histdel()" function
12031 static void
12032 f_histdel(argvars, rettv)
12033 typval_T *argvars UNUSED;
12034 typval_T *rettv UNUSED;
12036 #ifdef FEAT_CMDHIST
12037 int n;
12038 char_u buf[NUMBUFLEN];
12039 char_u *str;
12041 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12042 if (str == NULL)
12043 n = 0;
12044 else if (argvars[1].v_type == VAR_UNKNOWN)
12045 /* only one argument: clear entire history */
12046 n = clr_history(get_histtype(str));
12047 else if (argvars[1].v_type == VAR_NUMBER)
12048 /* index given: remove that entry */
12049 n = del_history_idx(get_histtype(str),
12050 (int)get_tv_number(&argvars[1]));
12051 else
12052 /* string given: remove all matching entries */
12053 n = del_history_entry(get_histtype(str),
12054 get_tv_string_buf(&argvars[1], buf));
12055 rettv->vval.v_number = n;
12056 #endif
12060 * "histget()" function
12062 static void
12063 f_histget(argvars, rettv)
12064 typval_T *argvars UNUSED;
12065 typval_T *rettv;
12067 #ifdef FEAT_CMDHIST
12068 int type;
12069 int idx;
12070 char_u *str;
12072 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12073 if (str == NULL)
12074 rettv->vval.v_string = NULL;
12075 else
12077 type = get_histtype(str);
12078 if (argvars[1].v_type == VAR_UNKNOWN)
12079 idx = get_history_idx(type);
12080 else
12081 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12082 /* -1 on type error */
12083 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12085 #else
12086 rettv->vval.v_string = NULL;
12087 #endif
12088 rettv->v_type = VAR_STRING;
12092 * "histnr()" function
12094 static void
12095 f_histnr(argvars, rettv)
12096 typval_T *argvars UNUSED;
12097 typval_T *rettv;
12099 int i;
12101 #ifdef FEAT_CMDHIST
12102 char_u *history = get_tv_string_chk(&argvars[0]);
12104 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12105 if (i >= HIST_CMD && i < HIST_COUNT)
12106 i = get_history_idx(i);
12107 else
12108 #endif
12109 i = -1;
12110 rettv->vval.v_number = i;
12114 * "highlightID(name)" function
12116 static void
12117 f_hlID(argvars, rettv)
12118 typval_T *argvars;
12119 typval_T *rettv;
12121 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12125 * "highlight_exists()" function
12127 static void
12128 f_hlexists(argvars, rettv)
12129 typval_T *argvars;
12130 typval_T *rettv;
12132 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12136 * "hostname()" function
12138 static void
12139 f_hostname(argvars, rettv)
12140 typval_T *argvars UNUSED;
12141 typval_T *rettv;
12143 char_u hostname[256];
12145 mch_get_host_name(hostname, 256);
12146 rettv->v_type = VAR_STRING;
12147 rettv->vval.v_string = vim_strsave(hostname);
12151 * iconv() function
12153 static void
12154 f_iconv(argvars, rettv)
12155 typval_T *argvars UNUSED;
12156 typval_T *rettv;
12158 #ifdef FEAT_MBYTE
12159 char_u buf1[NUMBUFLEN];
12160 char_u buf2[NUMBUFLEN];
12161 char_u *from, *to, *str;
12162 vimconv_T vimconv;
12163 #endif
12165 rettv->v_type = VAR_STRING;
12166 rettv->vval.v_string = NULL;
12168 #ifdef FEAT_MBYTE
12169 str = get_tv_string(&argvars[0]);
12170 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12171 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12172 vimconv.vc_type = CONV_NONE;
12173 convert_setup(&vimconv, from, to);
12175 /* If the encodings are equal, no conversion needed. */
12176 if (vimconv.vc_type == CONV_NONE)
12177 rettv->vval.v_string = vim_strsave(str);
12178 else
12179 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12181 convert_setup(&vimconv, NULL, NULL);
12182 vim_free(from);
12183 vim_free(to);
12184 #endif
12188 * "indent()" function
12190 static void
12191 f_indent(argvars, rettv)
12192 typval_T *argvars;
12193 typval_T *rettv;
12195 linenr_T lnum;
12197 lnum = get_tv_lnum(argvars);
12198 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12199 rettv->vval.v_number = get_indent_lnum(lnum);
12200 else
12201 rettv->vval.v_number = -1;
12205 * "index()" function
12207 static void
12208 f_index(argvars, rettv)
12209 typval_T *argvars;
12210 typval_T *rettv;
12212 list_T *l;
12213 listitem_T *item;
12214 long idx = 0;
12215 int ic = FALSE;
12217 rettv->vval.v_number = -1;
12218 if (argvars[0].v_type != VAR_LIST)
12220 EMSG(_(e_listreq));
12221 return;
12223 l = argvars[0].vval.v_list;
12224 if (l != NULL)
12226 item = l->lv_first;
12227 if (argvars[2].v_type != VAR_UNKNOWN)
12229 int error = FALSE;
12231 /* Start at specified item. Use the cached index that list_find()
12232 * sets, so that a negative number also works. */
12233 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12234 idx = l->lv_idx;
12235 if (argvars[3].v_type != VAR_UNKNOWN)
12236 ic = get_tv_number_chk(&argvars[3], &error);
12237 if (error)
12238 item = NULL;
12241 for ( ; item != NULL; item = item->li_next, ++idx)
12242 if (tv_equal(&item->li_tv, &argvars[1], ic))
12244 rettv->vval.v_number = idx;
12245 break;
12250 static int inputsecret_flag = 0;
12252 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12255 * This function is used by f_input() and f_inputdialog() functions. The third
12256 * argument to f_input() specifies the type of completion to use at the
12257 * prompt. The third argument to f_inputdialog() specifies the value to return
12258 * when the user cancels the prompt.
12260 static void
12261 get_user_input(argvars, rettv, inputdialog)
12262 typval_T *argvars;
12263 typval_T *rettv;
12264 int inputdialog;
12266 char_u *prompt = get_tv_string_chk(&argvars[0]);
12267 char_u *p = NULL;
12268 int c;
12269 char_u buf[NUMBUFLEN];
12270 int cmd_silent_save = cmd_silent;
12271 char_u *defstr = (char_u *)"";
12272 int xp_type = EXPAND_NOTHING;
12273 char_u *xp_arg = NULL;
12275 rettv->v_type = VAR_STRING;
12276 rettv->vval.v_string = NULL;
12278 #ifdef NO_CONSOLE_INPUT
12279 /* While starting up, there is no place to enter text. */
12280 if (no_console_input())
12281 return;
12282 #endif
12284 cmd_silent = FALSE; /* Want to see the prompt. */
12285 if (prompt != NULL)
12287 /* Only the part of the message after the last NL is considered as
12288 * prompt for the command line */
12289 p = vim_strrchr(prompt, '\n');
12290 if (p == NULL)
12291 p = prompt;
12292 else
12294 ++p;
12295 c = *p;
12296 *p = NUL;
12297 msg_start();
12298 msg_clr_eos();
12299 msg_puts_attr(prompt, echo_attr);
12300 msg_didout = FALSE;
12301 msg_starthere();
12302 *p = c;
12304 cmdline_row = msg_row;
12306 if (argvars[1].v_type != VAR_UNKNOWN)
12308 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12309 if (defstr != NULL)
12310 stuffReadbuffSpec(defstr);
12312 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12314 char_u *xp_name;
12315 int xp_namelen;
12316 long argt;
12318 rettv->vval.v_string = NULL;
12320 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12321 if (xp_name == NULL)
12322 return;
12324 xp_namelen = (int)STRLEN(xp_name);
12326 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12327 &xp_arg) == FAIL)
12328 return;
12332 if (defstr != NULL)
12333 rettv->vval.v_string =
12334 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12335 xp_type, xp_arg);
12337 vim_free(xp_arg);
12339 /* since the user typed this, no need to wait for return */
12340 need_wait_return = FALSE;
12341 msg_didout = FALSE;
12343 cmd_silent = cmd_silent_save;
12347 * "input()" function
12348 * Also handles inputsecret() when inputsecret is set.
12350 static void
12351 f_input(argvars, rettv)
12352 typval_T *argvars;
12353 typval_T *rettv;
12355 get_user_input(argvars, rettv, FALSE);
12359 * "inputdialog()" function
12361 static void
12362 f_inputdialog(argvars, rettv)
12363 typval_T *argvars;
12364 typval_T *rettv;
12366 #if defined(FEAT_GUI_TEXTDIALOG)
12367 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12368 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12370 char_u *message;
12371 char_u buf[NUMBUFLEN];
12372 char_u *defstr = (char_u *)"";
12374 message = get_tv_string_chk(&argvars[0]);
12375 if (argvars[1].v_type != VAR_UNKNOWN
12376 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12377 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12378 else
12379 IObuff[0] = NUL;
12380 if (message != NULL && defstr != NULL
12381 && do_dialog(VIM_QUESTION, NULL, message,
12382 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12383 rettv->vval.v_string = vim_strsave(IObuff);
12384 else
12386 if (message != NULL && defstr != NULL
12387 && argvars[1].v_type != VAR_UNKNOWN
12388 && argvars[2].v_type != VAR_UNKNOWN)
12389 rettv->vval.v_string = vim_strsave(
12390 get_tv_string_buf(&argvars[2], buf));
12391 else
12392 rettv->vval.v_string = NULL;
12394 rettv->v_type = VAR_STRING;
12396 else
12397 #endif
12398 get_user_input(argvars, rettv, TRUE);
12402 * "inputlist()" function
12404 static void
12405 f_inputlist(argvars, rettv)
12406 typval_T *argvars;
12407 typval_T *rettv;
12409 listitem_T *li;
12410 int selected;
12411 int mouse_used;
12413 #ifdef NO_CONSOLE_INPUT
12414 /* While starting up, there is no place to enter text. */
12415 if (no_console_input())
12416 return;
12417 #endif
12418 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12420 EMSG2(_(e_listarg), "inputlist()");
12421 return;
12424 msg_start();
12425 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12426 lines_left = Rows; /* avoid more prompt */
12427 msg_scroll = TRUE;
12428 msg_clr_eos();
12430 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12432 msg_puts(get_tv_string(&li->li_tv));
12433 msg_putchar('\n');
12436 /* Ask for choice. */
12437 selected = prompt_for_number(&mouse_used);
12438 if (mouse_used)
12439 selected -= lines_left;
12441 rettv->vval.v_number = selected;
12445 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12448 * "inputrestore()" function
12450 static void
12451 f_inputrestore(argvars, rettv)
12452 typval_T *argvars UNUSED;
12453 typval_T *rettv;
12455 if (ga_userinput.ga_len > 0)
12457 --ga_userinput.ga_len;
12458 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12459 + ga_userinput.ga_len);
12460 /* default return is zero == OK */
12462 else if (p_verbose > 1)
12464 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12465 rettv->vval.v_number = 1; /* Failed */
12470 * "inputsave()" function
12472 static void
12473 f_inputsave(argvars, rettv)
12474 typval_T *argvars UNUSED;
12475 typval_T *rettv;
12477 /* Add an entry to the stack of typeahead storage. */
12478 if (ga_grow(&ga_userinput, 1) == OK)
12480 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12481 + ga_userinput.ga_len);
12482 ++ga_userinput.ga_len;
12483 /* default return is zero == OK */
12485 else
12486 rettv->vval.v_number = 1; /* Failed */
12490 * "inputsecret()" function
12492 static void
12493 f_inputsecret(argvars, rettv)
12494 typval_T *argvars;
12495 typval_T *rettv;
12497 ++cmdline_star;
12498 ++inputsecret_flag;
12499 f_input(argvars, rettv);
12500 --cmdline_star;
12501 --inputsecret_flag;
12505 * "insert()" function
12507 static void
12508 f_insert(argvars, rettv)
12509 typval_T *argvars;
12510 typval_T *rettv;
12512 long before = 0;
12513 listitem_T *item;
12514 list_T *l;
12515 int error = FALSE;
12517 if (argvars[0].v_type != VAR_LIST)
12518 EMSG2(_(e_listarg), "insert()");
12519 else if ((l = argvars[0].vval.v_list) != NULL
12520 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12522 if (argvars[2].v_type != VAR_UNKNOWN)
12523 before = get_tv_number_chk(&argvars[2], &error);
12524 if (error)
12525 return; /* type error; errmsg already given */
12527 if (before == l->lv_len)
12528 item = NULL;
12529 else
12531 item = list_find(l, before);
12532 if (item == NULL)
12534 EMSGN(_(e_listidx), before);
12535 l = NULL;
12538 if (l != NULL)
12540 list_insert_tv(l, &argvars[1], item);
12541 copy_tv(&argvars[0], rettv);
12547 * "isdirectory()" function
12549 static void
12550 f_isdirectory(argvars, rettv)
12551 typval_T *argvars;
12552 typval_T *rettv;
12554 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12558 * "islocked()" function
12560 static void
12561 f_islocked(argvars, rettv)
12562 typval_T *argvars;
12563 typval_T *rettv;
12565 lval_T lv;
12566 char_u *end;
12567 dictitem_T *di;
12569 rettv->vval.v_number = -1;
12570 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12571 FNE_CHECK_START);
12572 if (end != NULL && lv.ll_name != NULL)
12574 if (*end != NUL)
12575 EMSG(_(e_trailing));
12576 else
12578 if (lv.ll_tv == NULL)
12580 if (check_changedtick(lv.ll_name))
12581 rettv->vval.v_number = 1; /* always locked */
12582 else
12584 di = find_var(lv.ll_name, NULL);
12585 if (di != NULL)
12587 /* Consider a variable locked when:
12588 * 1. the variable itself is locked
12589 * 2. the value of the variable is locked.
12590 * 3. the List or Dict value is locked.
12592 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12593 || tv_islocked(&di->di_tv));
12597 else if (lv.ll_range)
12598 EMSG(_("E786: Range not allowed"));
12599 else if (lv.ll_newkey != NULL)
12600 EMSG2(_(e_dictkey), lv.ll_newkey);
12601 else if (lv.ll_list != NULL)
12602 /* List item. */
12603 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12604 else
12605 /* Dictionary item. */
12606 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12610 clear_lval(&lv);
12613 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12616 * Turn a dict into a list:
12617 * "what" == 0: list of keys
12618 * "what" == 1: list of values
12619 * "what" == 2: list of items
12621 static void
12622 dict_list(argvars, rettv, what)
12623 typval_T *argvars;
12624 typval_T *rettv;
12625 int what;
12627 list_T *l2;
12628 dictitem_T *di;
12629 hashitem_T *hi;
12630 listitem_T *li;
12631 listitem_T *li2;
12632 dict_T *d;
12633 int todo;
12635 if (argvars[0].v_type != VAR_DICT)
12637 EMSG(_(e_dictreq));
12638 return;
12640 if ((d = argvars[0].vval.v_dict) == NULL)
12641 return;
12643 if (rettv_list_alloc(rettv) == FAIL)
12644 return;
12646 todo = (int)d->dv_hashtab.ht_used;
12647 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12649 if (!HASHITEM_EMPTY(hi))
12651 --todo;
12652 di = HI2DI(hi);
12654 li = listitem_alloc();
12655 if (li == NULL)
12656 break;
12657 list_append(rettv->vval.v_list, li);
12659 if (what == 0)
12661 /* keys() */
12662 li->li_tv.v_type = VAR_STRING;
12663 li->li_tv.v_lock = 0;
12664 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12666 else if (what == 1)
12668 /* values() */
12669 copy_tv(&di->di_tv, &li->li_tv);
12671 else
12673 /* items() */
12674 l2 = list_alloc();
12675 li->li_tv.v_type = VAR_LIST;
12676 li->li_tv.v_lock = 0;
12677 li->li_tv.vval.v_list = l2;
12678 if (l2 == NULL)
12679 break;
12680 ++l2->lv_refcount;
12682 li2 = listitem_alloc();
12683 if (li2 == NULL)
12684 break;
12685 list_append(l2, li2);
12686 li2->li_tv.v_type = VAR_STRING;
12687 li2->li_tv.v_lock = 0;
12688 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12690 li2 = listitem_alloc();
12691 if (li2 == NULL)
12692 break;
12693 list_append(l2, li2);
12694 copy_tv(&di->di_tv, &li2->li_tv);
12701 * "items(dict)" function
12703 static void
12704 f_items(argvars, rettv)
12705 typval_T *argvars;
12706 typval_T *rettv;
12708 dict_list(argvars, rettv, 2);
12712 * "join()" function
12714 static void
12715 f_join(argvars, rettv)
12716 typval_T *argvars;
12717 typval_T *rettv;
12719 garray_T ga;
12720 char_u *sep;
12722 if (argvars[0].v_type != VAR_LIST)
12724 EMSG(_(e_listreq));
12725 return;
12727 if (argvars[0].vval.v_list == NULL)
12728 return;
12729 if (argvars[1].v_type == VAR_UNKNOWN)
12730 sep = (char_u *)" ";
12731 else
12732 sep = get_tv_string_chk(&argvars[1]);
12734 rettv->v_type = VAR_STRING;
12736 if (sep != NULL)
12738 ga_init2(&ga, (int)sizeof(char), 80);
12739 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12740 ga_append(&ga, NUL);
12741 rettv->vval.v_string = (char_u *)ga.ga_data;
12743 else
12744 rettv->vval.v_string = NULL;
12748 * "keys()" function
12750 static void
12751 f_keys(argvars, rettv)
12752 typval_T *argvars;
12753 typval_T *rettv;
12755 dict_list(argvars, rettv, 0);
12759 * "last_buffer_nr()" function.
12761 static void
12762 f_last_buffer_nr(argvars, rettv)
12763 typval_T *argvars UNUSED;
12764 typval_T *rettv;
12766 int n = 0;
12767 buf_T *buf;
12769 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12770 if (n < buf->b_fnum)
12771 n = buf->b_fnum;
12773 rettv->vval.v_number = n;
12777 * "len()" function
12779 static void
12780 f_len(argvars, rettv)
12781 typval_T *argvars;
12782 typval_T *rettv;
12784 switch (argvars[0].v_type)
12786 case VAR_STRING:
12787 case VAR_NUMBER:
12788 rettv->vval.v_number = (varnumber_T)STRLEN(
12789 get_tv_string(&argvars[0]));
12790 break;
12791 case VAR_LIST:
12792 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12793 break;
12794 case VAR_DICT:
12795 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12796 break;
12797 default:
12798 EMSG(_("E701: Invalid type for len()"));
12799 break;
12803 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12805 static void
12806 libcall_common(argvars, rettv, type)
12807 typval_T *argvars;
12808 typval_T *rettv;
12809 int type;
12811 #ifdef FEAT_LIBCALL
12812 char_u *string_in;
12813 char_u **string_result;
12814 int nr_result;
12815 #endif
12817 rettv->v_type = type;
12818 if (type != VAR_NUMBER)
12819 rettv->vval.v_string = NULL;
12821 if (check_restricted() || check_secure())
12822 return;
12824 #ifdef FEAT_LIBCALL
12825 /* The first two args must be strings, otherwise its meaningless */
12826 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12828 string_in = NULL;
12829 if (argvars[2].v_type == VAR_STRING)
12830 string_in = argvars[2].vval.v_string;
12831 if (type == VAR_NUMBER)
12832 string_result = NULL;
12833 else
12834 string_result = &rettv->vval.v_string;
12835 if (mch_libcall(argvars[0].vval.v_string,
12836 argvars[1].vval.v_string,
12837 string_in,
12838 argvars[2].vval.v_number,
12839 string_result,
12840 &nr_result) == OK
12841 && type == VAR_NUMBER)
12842 rettv->vval.v_number = nr_result;
12844 #endif
12848 * "libcall()" function
12850 static void
12851 f_libcall(argvars, rettv)
12852 typval_T *argvars;
12853 typval_T *rettv;
12855 libcall_common(argvars, rettv, VAR_STRING);
12859 * "libcallnr()" function
12861 static void
12862 f_libcallnr(argvars, rettv)
12863 typval_T *argvars;
12864 typval_T *rettv;
12866 libcall_common(argvars, rettv, VAR_NUMBER);
12870 * "line(string)" function
12872 static void
12873 f_line(argvars, rettv)
12874 typval_T *argvars;
12875 typval_T *rettv;
12877 linenr_T lnum = 0;
12878 pos_T *fp;
12879 int fnum;
12881 fp = var2fpos(&argvars[0], TRUE, &fnum);
12882 if (fp != NULL)
12883 lnum = fp->lnum;
12884 rettv->vval.v_number = lnum;
12888 * "line2byte(lnum)" function
12890 static void
12891 f_line2byte(argvars, rettv)
12892 typval_T *argvars UNUSED;
12893 typval_T *rettv;
12895 #ifndef FEAT_BYTEOFF
12896 rettv->vval.v_number = -1;
12897 #else
12898 linenr_T lnum;
12900 lnum = get_tv_lnum(argvars);
12901 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12902 rettv->vval.v_number = -1;
12903 else
12904 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12905 if (rettv->vval.v_number >= 0)
12906 ++rettv->vval.v_number;
12907 #endif
12911 * "lispindent(lnum)" function
12913 static void
12914 f_lispindent(argvars, rettv)
12915 typval_T *argvars;
12916 typval_T *rettv;
12918 #ifdef FEAT_LISP
12919 pos_T pos;
12920 linenr_T lnum;
12922 pos = curwin->w_cursor;
12923 lnum = get_tv_lnum(argvars);
12924 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12926 curwin->w_cursor.lnum = lnum;
12927 rettv->vval.v_number = get_lisp_indent();
12928 curwin->w_cursor = pos;
12930 else
12931 #endif
12932 rettv->vval.v_number = -1;
12936 * "localtime()" function
12938 static void
12939 f_localtime(argvars, rettv)
12940 typval_T *argvars UNUSED;
12941 typval_T *rettv;
12943 rettv->vval.v_number = (varnumber_T)time(NULL);
12946 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12948 static void
12949 get_maparg(argvars, rettv, exact)
12950 typval_T *argvars;
12951 typval_T *rettv;
12952 int exact;
12954 char_u *keys;
12955 char_u *which;
12956 char_u buf[NUMBUFLEN];
12957 char_u *keys_buf = NULL;
12958 char_u *rhs;
12959 int mode;
12960 garray_T ga;
12961 int abbr = FALSE;
12963 /* return empty string for failure */
12964 rettv->v_type = VAR_STRING;
12965 rettv->vval.v_string = NULL;
12967 keys = get_tv_string(&argvars[0]);
12968 if (*keys == NUL)
12969 return;
12971 if (argvars[1].v_type != VAR_UNKNOWN)
12973 which = get_tv_string_buf_chk(&argvars[1], buf);
12974 if (argvars[2].v_type != VAR_UNKNOWN)
12975 abbr = get_tv_number(&argvars[2]);
12977 else
12978 which = (char_u *)"";
12979 if (which == NULL)
12980 return;
12982 mode = get_map_mode(&which, 0);
12984 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12985 rhs = check_map(keys, mode, exact, FALSE, abbr);
12986 vim_free(keys_buf);
12987 if (rhs != NULL)
12989 ga_init(&ga);
12990 ga.ga_itemsize = 1;
12991 ga.ga_growsize = 40;
12993 while (*rhs != NUL)
12994 ga_concat(&ga, str2special(&rhs, FALSE));
12996 ga_append(&ga, NUL);
12997 rettv->vval.v_string = (char_u *)ga.ga_data;
13001 #ifdef FEAT_FLOAT
13003 * "log10()" function
13005 static void
13006 f_log10(argvars, rettv)
13007 typval_T *argvars;
13008 typval_T *rettv;
13010 float_T f;
13012 rettv->v_type = VAR_FLOAT;
13013 if (get_float_arg(argvars, &f) == OK)
13014 rettv->vval.v_float = log10(f);
13015 else
13016 rettv->vval.v_float = 0.0;
13018 #endif
13021 * "map()" function
13023 static void
13024 f_map(argvars, rettv)
13025 typval_T *argvars;
13026 typval_T *rettv;
13028 filter_map(argvars, rettv, TRUE);
13032 * "maparg()" function
13034 static void
13035 f_maparg(argvars, rettv)
13036 typval_T *argvars;
13037 typval_T *rettv;
13039 get_maparg(argvars, rettv, TRUE);
13043 * "mapcheck()" function
13045 static void
13046 f_mapcheck(argvars, rettv)
13047 typval_T *argvars;
13048 typval_T *rettv;
13050 get_maparg(argvars, rettv, FALSE);
13053 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13055 static void
13056 find_some_match(argvars, rettv, type)
13057 typval_T *argvars;
13058 typval_T *rettv;
13059 int type;
13061 char_u *str = NULL;
13062 char_u *expr = NULL;
13063 char_u *pat;
13064 regmatch_T regmatch;
13065 char_u patbuf[NUMBUFLEN];
13066 char_u strbuf[NUMBUFLEN];
13067 char_u *save_cpo;
13068 long start = 0;
13069 long nth = 1;
13070 colnr_T startcol = 0;
13071 int match = 0;
13072 list_T *l = NULL;
13073 listitem_T *li = NULL;
13074 long idx = 0;
13075 char_u *tofree = NULL;
13077 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13078 save_cpo = p_cpo;
13079 p_cpo = (char_u *)"";
13081 rettv->vval.v_number = -1;
13082 if (type == 3)
13084 /* return empty list when there are no matches */
13085 if (rettv_list_alloc(rettv) == FAIL)
13086 goto theend;
13088 else if (type == 2)
13090 rettv->v_type = VAR_STRING;
13091 rettv->vval.v_string = NULL;
13094 if (argvars[0].v_type == VAR_LIST)
13096 if ((l = argvars[0].vval.v_list) == NULL)
13097 goto theend;
13098 li = l->lv_first;
13100 else
13101 expr = str = get_tv_string(&argvars[0]);
13103 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13104 if (pat == NULL)
13105 goto theend;
13107 if (argvars[2].v_type != VAR_UNKNOWN)
13109 int error = FALSE;
13111 start = get_tv_number_chk(&argvars[2], &error);
13112 if (error)
13113 goto theend;
13114 if (l != NULL)
13116 li = list_find(l, start);
13117 if (li == NULL)
13118 goto theend;
13119 idx = l->lv_idx; /* use the cached index */
13121 else
13123 if (start < 0)
13124 start = 0;
13125 if (start > (long)STRLEN(str))
13126 goto theend;
13127 /* When "count" argument is there ignore matches before "start",
13128 * otherwise skip part of the string. Differs when pattern is "^"
13129 * or "\<". */
13130 if (argvars[3].v_type != VAR_UNKNOWN)
13131 startcol = start;
13132 else
13133 str += start;
13136 if (argvars[3].v_type != VAR_UNKNOWN)
13137 nth = get_tv_number_chk(&argvars[3], &error);
13138 if (error)
13139 goto theend;
13142 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13143 if (regmatch.regprog != NULL)
13145 regmatch.rm_ic = p_ic;
13147 for (;;)
13149 if (l != NULL)
13151 if (li == NULL)
13153 match = FALSE;
13154 break;
13156 vim_free(tofree);
13157 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13158 if (str == NULL)
13159 break;
13162 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13164 if (match && --nth <= 0)
13165 break;
13166 if (l == NULL && !match)
13167 break;
13169 /* Advance to just after the match. */
13170 if (l != NULL)
13172 li = li->li_next;
13173 ++idx;
13175 else
13177 #ifdef FEAT_MBYTE
13178 startcol = (colnr_T)(regmatch.startp[0]
13179 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13180 #else
13181 startcol = regmatch.startp[0] + 1 - str;
13182 #endif
13186 if (match)
13188 if (type == 3)
13190 int i;
13192 /* return list with matched string and submatches */
13193 for (i = 0; i < NSUBEXP; ++i)
13195 if (regmatch.endp[i] == NULL)
13197 if (list_append_string(rettv->vval.v_list,
13198 (char_u *)"", 0) == FAIL)
13199 break;
13201 else if (list_append_string(rettv->vval.v_list,
13202 regmatch.startp[i],
13203 (int)(regmatch.endp[i] - regmatch.startp[i]))
13204 == FAIL)
13205 break;
13208 else if (type == 2)
13210 /* return matched string */
13211 if (l != NULL)
13212 copy_tv(&li->li_tv, rettv);
13213 else
13214 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13215 (int)(regmatch.endp[0] - regmatch.startp[0]));
13217 else if (l != NULL)
13218 rettv->vval.v_number = idx;
13219 else
13221 if (type != 0)
13222 rettv->vval.v_number =
13223 (varnumber_T)(regmatch.startp[0] - str);
13224 else
13225 rettv->vval.v_number =
13226 (varnumber_T)(regmatch.endp[0] - str);
13227 rettv->vval.v_number += (varnumber_T)(str - expr);
13230 vim_free(regmatch.regprog);
13233 theend:
13234 vim_free(tofree);
13235 p_cpo = save_cpo;
13239 * "match()" function
13241 static void
13242 f_match(argvars, rettv)
13243 typval_T *argvars;
13244 typval_T *rettv;
13246 find_some_match(argvars, rettv, 1);
13250 * "matchadd()" function
13252 static void
13253 f_matchadd(argvars, rettv)
13254 typval_T *argvars;
13255 typval_T *rettv;
13257 #ifdef FEAT_SEARCH_EXTRA
13258 char_u buf[NUMBUFLEN];
13259 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13260 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13261 int prio = 10; /* default priority */
13262 int id = -1;
13263 int error = FALSE;
13265 rettv->vval.v_number = -1;
13267 if (grp == NULL || pat == NULL)
13268 return;
13269 if (argvars[2].v_type != VAR_UNKNOWN)
13271 prio = get_tv_number_chk(&argvars[2], &error);
13272 if (argvars[3].v_type != VAR_UNKNOWN)
13273 id = get_tv_number_chk(&argvars[3], &error);
13275 if (error == TRUE)
13276 return;
13277 if (id >= 1 && id <= 3)
13279 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13280 return;
13283 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13284 #endif
13288 * "matcharg()" function
13290 static void
13291 f_matcharg(argvars, rettv)
13292 typval_T *argvars;
13293 typval_T *rettv;
13295 if (rettv_list_alloc(rettv) == OK)
13297 #ifdef FEAT_SEARCH_EXTRA
13298 int id = get_tv_number(&argvars[0]);
13299 matchitem_T *m;
13301 if (id >= 1 && id <= 3)
13303 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13305 list_append_string(rettv->vval.v_list,
13306 syn_id2name(m->hlg_id), -1);
13307 list_append_string(rettv->vval.v_list, m->pattern, -1);
13309 else
13311 list_append_string(rettv->vval.v_list, NUL, -1);
13312 list_append_string(rettv->vval.v_list, NUL, -1);
13315 #endif
13320 * "matchdelete()" function
13322 static void
13323 f_matchdelete(argvars, rettv)
13324 typval_T *argvars;
13325 typval_T *rettv;
13327 #ifdef FEAT_SEARCH_EXTRA
13328 rettv->vval.v_number = match_delete(curwin,
13329 (int)get_tv_number(&argvars[0]), TRUE);
13330 #endif
13334 * "matchend()" function
13336 static void
13337 f_matchend(argvars, rettv)
13338 typval_T *argvars;
13339 typval_T *rettv;
13341 find_some_match(argvars, rettv, 0);
13345 * "matchlist()" function
13347 static void
13348 f_matchlist(argvars, rettv)
13349 typval_T *argvars;
13350 typval_T *rettv;
13352 find_some_match(argvars, rettv, 3);
13356 * "matchstr()" function
13358 static void
13359 f_matchstr(argvars, rettv)
13360 typval_T *argvars;
13361 typval_T *rettv;
13363 find_some_match(argvars, rettv, 2);
13366 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13368 static void
13369 max_min(argvars, rettv, domax)
13370 typval_T *argvars;
13371 typval_T *rettv;
13372 int domax;
13374 long n = 0;
13375 long i;
13376 int error = FALSE;
13378 if (argvars[0].v_type == VAR_LIST)
13380 list_T *l;
13381 listitem_T *li;
13383 l = argvars[0].vval.v_list;
13384 if (l != NULL)
13386 li = l->lv_first;
13387 if (li != NULL)
13389 n = get_tv_number_chk(&li->li_tv, &error);
13390 for (;;)
13392 li = li->li_next;
13393 if (li == NULL)
13394 break;
13395 i = get_tv_number_chk(&li->li_tv, &error);
13396 if (domax ? i > n : i < n)
13397 n = i;
13402 else if (argvars[0].v_type == VAR_DICT)
13404 dict_T *d;
13405 int first = TRUE;
13406 hashitem_T *hi;
13407 int todo;
13409 d = argvars[0].vval.v_dict;
13410 if (d != NULL)
13412 todo = (int)d->dv_hashtab.ht_used;
13413 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13415 if (!HASHITEM_EMPTY(hi))
13417 --todo;
13418 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13419 if (first)
13421 n = i;
13422 first = FALSE;
13424 else if (domax ? i > n : i < n)
13425 n = i;
13430 else
13431 EMSG(_(e_listdictarg));
13432 rettv->vval.v_number = error ? 0 : n;
13436 * "max()" function
13438 static void
13439 f_max(argvars, rettv)
13440 typval_T *argvars;
13441 typval_T *rettv;
13443 max_min(argvars, rettv, TRUE);
13447 * "min()" function
13449 static void
13450 f_min(argvars, rettv)
13451 typval_T *argvars;
13452 typval_T *rettv;
13454 max_min(argvars, rettv, FALSE);
13457 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13460 * Create the directory in which "dir" is located, and higher levels when
13461 * needed.
13463 static int
13464 mkdir_recurse(dir, prot)
13465 char_u *dir;
13466 int prot;
13468 char_u *p;
13469 char_u *updir;
13470 int r = FAIL;
13472 /* Get end of directory name in "dir".
13473 * We're done when it's "/" or "c:/". */
13474 p = gettail_sep(dir);
13475 if (p <= get_past_head(dir))
13476 return OK;
13478 /* If the directory exists we're done. Otherwise: create it.*/
13479 updir = vim_strnsave(dir, (int)(p - dir));
13480 if (updir == NULL)
13481 return FAIL;
13482 if (mch_isdir(updir))
13483 r = OK;
13484 else if (mkdir_recurse(updir, prot) == OK)
13485 r = vim_mkdir_emsg(updir, prot);
13486 vim_free(updir);
13487 return r;
13490 #ifdef vim_mkdir
13492 * "mkdir()" function
13494 static void
13495 f_mkdir(argvars, rettv)
13496 typval_T *argvars;
13497 typval_T *rettv;
13499 char_u *dir;
13500 char_u buf[NUMBUFLEN];
13501 int prot = 0755;
13503 rettv->vval.v_number = FAIL;
13504 if (check_restricted() || check_secure())
13505 return;
13507 dir = get_tv_string_buf(&argvars[0], buf);
13508 if (argvars[1].v_type != VAR_UNKNOWN)
13510 if (argvars[2].v_type != VAR_UNKNOWN)
13511 prot = get_tv_number_chk(&argvars[2], NULL);
13512 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13513 mkdir_recurse(dir, prot);
13515 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13517 #endif
13520 * "mode()" function
13522 static void
13523 f_mode(argvars, rettv)
13524 typval_T *argvars;
13525 typval_T *rettv;
13527 char_u buf[3];
13529 buf[1] = NUL;
13530 buf[2] = NUL;
13532 #ifdef FEAT_VISUAL
13533 if (VIsual_active)
13535 if (VIsual_select)
13536 buf[0] = VIsual_mode + 's' - 'v';
13537 else
13538 buf[0] = VIsual_mode;
13540 else
13541 #endif
13542 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13543 || State == CONFIRM)
13545 buf[0] = 'r';
13546 if (State == ASKMORE)
13547 buf[1] = 'm';
13548 else if (State == CONFIRM)
13549 buf[1] = '?';
13551 else if (State == EXTERNCMD)
13552 buf[0] = '!';
13553 else if (State & INSERT)
13555 #ifdef FEAT_VREPLACE
13556 if (State & VREPLACE_FLAG)
13558 buf[0] = 'R';
13559 buf[1] = 'v';
13561 else
13562 #endif
13563 if (State & REPLACE_FLAG)
13564 buf[0] = 'R';
13565 else
13566 buf[0] = 'i';
13568 else if (State & CMDLINE)
13570 buf[0] = 'c';
13571 if (exmode_active)
13572 buf[1] = 'v';
13574 else if (exmode_active)
13576 buf[0] = 'c';
13577 buf[1] = 'e';
13579 else
13581 buf[0] = 'n';
13582 if (finish_op)
13583 buf[1] = 'o';
13586 /* Clear out the minor mode when the argument is not a non-zero number or
13587 * non-empty string. */
13588 if (!non_zero_arg(&argvars[0]))
13589 buf[1] = NUL;
13591 rettv->vval.v_string = vim_strsave(buf);
13592 rettv->v_type = VAR_STRING;
13595 #ifdef FEAT_MZSCHEME
13597 * "mzeval()" function
13599 static void
13600 f_mzeval(argvars, rettv)
13601 typval_T *argvars;
13602 typval_T *rettv;
13604 char_u *str;
13605 char_u buf[NUMBUFLEN];
13607 str = get_tv_string_buf(&argvars[0], buf);
13608 do_mzeval(str, rettv);
13610 #endif
13613 * "nextnonblank()" function
13615 static void
13616 f_nextnonblank(argvars, rettv)
13617 typval_T *argvars;
13618 typval_T *rettv;
13620 linenr_T lnum;
13622 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13624 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13626 lnum = 0;
13627 break;
13629 if (*skipwhite(ml_get(lnum)) != NUL)
13630 break;
13632 rettv->vval.v_number = lnum;
13636 * "nr2char()" function
13638 static void
13639 f_nr2char(argvars, rettv)
13640 typval_T *argvars;
13641 typval_T *rettv;
13643 char_u buf[NUMBUFLEN];
13645 #ifdef FEAT_MBYTE
13646 if (has_mbyte)
13647 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13648 else
13649 #endif
13651 buf[0] = (char_u)get_tv_number(&argvars[0]);
13652 buf[1] = NUL;
13654 rettv->v_type = VAR_STRING;
13655 rettv->vval.v_string = vim_strsave(buf);
13659 * "pathshorten()" function
13661 static void
13662 f_pathshorten(argvars, rettv)
13663 typval_T *argvars;
13664 typval_T *rettv;
13666 char_u *p;
13668 rettv->v_type = VAR_STRING;
13669 p = get_tv_string_chk(&argvars[0]);
13670 if (p == NULL)
13671 rettv->vval.v_string = NULL;
13672 else
13674 p = vim_strsave(p);
13675 rettv->vval.v_string = p;
13676 if (p != NULL)
13677 shorten_dir(p);
13681 #ifdef FEAT_FLOAT
13683 * "pow()" function
13685 static void
13686 f_pow(argvars, rettv)
13687 typval_T *argvars;
13688 typval_T *rettv;
13690 float_T fx, fy;
13692 rettv->v_type = VAR_FLOAT;
13693 if (get_float_arg(argvars, &fx) == OK
13694 && get_float_arg(&argvars[1], &fy) == OK)
13695 rettv->vval.v_float = pow(fx, fy);
13696 else
13697 rettv->vval.v_float = 0.0;
13699 #endif
13702 * "prevnonblank()" function
13704 static void
13705 f_prevnonblank(argvars, rettv)
13706 typval_T *argvars;
13707 typval_T *rettv;
13709 linenr_T lnum;
13711 lnum = get_tv_lnum(argvars);
13712 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13713 lnum = 0;
13714 else
13715 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13716 --lnum;
13717 rettv->vval.v_number = lnum;
13720 #ifdef HAVE_STDARG_H
13721 /* This dummy va_list is here because:
13722 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13723 * - locally in the function results in a "used before set" warning
13724 * - using va_start() to initialize it gives "function with fixed args" error */
13725 static va_list ap;
13726 #endif
13729 * "printf()" function
13731 static void
13732 f_printf(argvars, rettv)
13733 typval_T *argvars;
13734 typval_T *rettv;
13736 rettv->v_type = VAR_STRING;
13737 rettv->vval.v_string = NULL;
13738 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13740 char_u buf[NUMBUFLEN];
13741 int len;
13742 char_u *s;
13743 int saved_did_emsg = did_emsg;
13744 char *fmt;
13746 /* Get the required length, allocate the buffer and do it for real. */
13747 did_emsg = FALSE;
13748 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13749 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13750 if (!did_emsg)
13752 s = alloc(len + 1);
13753 if (s != NULL)
13755 rettv->vval.v_string = s;
13756 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13759 did_emsg |= saved_did_emsg;
13761 #endif
13765 * "pumvisible()" function
13767 static void
13768 f_pumvisible(argvars, rettv)
13769 typval_T *argvars UNUSED;
13770 typval_T *rettv UNUSED;
13772 #ifdef FEAT_INS_EXPAND
13773 if (pum_visible())
13774 rettv->vval.v_number = 1;
13775 #endif
13779 * "range()" function
13781 static void
13782 f_range(argvars, rettv)
13783 typval_T *argvars;
13784 typval_T *rettv;
13786 long start;
13787 long end;
13788 long stride = 1;
13789 long i;
13790 int error = FALSE;
13792 start = get_tv_number_chk(&argvars[0], &error);
13793 if (argvars[1].v_type == VAR_UNKNOWN)
13795 end = start - 1;
13796 start = 0;
13798 else
13800 end = get_tv_number_chk(&argvars[1], &error);
13801 if (argvars[2].v_type != VAR_UNKNOWN)
13802 stride = get_tv_number_chk(&argvars[2], &error);
13805 if (error)
13806 return; /* type error; errmsg already given */
13807 if (stride == 0)
13808 EMSG(_("E726: Stride is zero"));
13809 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13810 EMSG(_("E727: Start past end"));
13811 else
13813 if (rettv_list_alloc(rettv) == OK)
13814 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13815 if (list_append_number(rettv->vval.v_list,
13816 (varnumber_T)i) == FAIL)
13817 break;
13822 * "readfile()" function
13824 static void
13825 f_readfile(argvars, rettv)
13826 typval_T *argvars;
13827 typval_T *rettv;
13829 int binary = FALSE;
13830 char_u *fname;
13831 FILE *fd;
13832 listitem_T *li;
13833 #define FREAD_SIZE 200 /* optimized for text lines */
13834 char_u buf[FREAD_SIZE];
13835 int readlen; /* size of last fread() */
13836 int buflen; /* nr of valid chars in buf[] */
13837 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13838 int tolist; /* first byte in buf[] still to be put in list */
13839 int chop; /* how many CR to chop off */
13840 char_u *prev = NULL; /* previously read bytes, if any */
13841 int prevlen = 0; /* length of "prev" if not NULL */
13842 char_u *s;
13843 int len;
13844 long maxline = MAXLNUM;
13845 long cnt = 0;
13847 if (argvars[1].v_type != VAR_UNKNOWN)
13849 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13850 binary = TRUE;
13851 if (argvars[2].v_type != VAR_UNKNOWN)
13852 maxline = get_tv_number(&argvars[2]);
13855 if (rettv_list_alloc(rettv) == FAIL)
13856 return;
13858 /* Always open the file in binary mode, library functions have a mind of
13859 * their own about CR-LF conversion. */
13860 fname = get_tv_string(&argvars[0]);
13861 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13863 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13864 return;
13867 filtd = 0;
13868 while (cnt < maxline || maxline < 0)
13870 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13871 buflen = filtd + readlen;
13872 tolist = 0;
13873 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13875 if (buf[filtd] == '\n' || readlen <= 0)
13877 /* Only when in binary mode add an empty list item when the
13878 * last line ends in a '\n'. */
13879 if (!binary && readlen == 0 && filtd == 0)
13880 break;
13882 /* Found end-of-line or end-of-file: add a text line to the
13883 * list. */
13884 chop = 0;
13885 if (!binary)
13886 while (filtd - chop - 1 >= tolist
13887 && buf[filtd - chop - 1] == '\r')
13888 ++chop;
13889 len = filtd - tolist - chop;
13890 if (prev == NULL)
13891 s = vim_strnsave(buf + tolist, len);
13892 else
13894 s = alloc((unsigned)(prevlen + len + 1));
13895 if (s != NULL)
13897 mch_memmove(s, prev, prevlen);
13898 vim_free(prev);
13899 prev = NULL;
13900 mch_memmove(s + prevlen, buf + tolist, len);
13901 s[prevlen + len] = NUL;
13904 tolist = filtd + 1;
13906 li = listitem_alloc();
13907 if (li == NULL)
13909 vim_free(s);
13910 break;
13912 li->li_tv.v_type = VAR_STRING;
13913 li->li_tv.v_lock = 0;
13914 li->li_tv.vval.v_string = s;
13915 list_append(rettv->vval.v_list, li);
13917 if (++cnt >= maxline && maxline >= 0)
13918 break;
13919 if (readlen <= 0)
13920 break;
13922 else if (buf[filtd] == NUL)
13923 buf[filtd] = '\n';
13925 if (readlen <= 0)
13926 break;
13928 if (tolist == 0)
13930 /* "buf" is full, need to move text to an allocated buffer */
13931 if (prev == NULL)
13933 prev = vim_strnsave(buf, buflen);
13934 prevlen = buflen;
13936 else
13938 s = alloc((unsigned)(prevlen + buflen));
13939 if (s != NULL)
13941 mch_memmove(s, prev, prevlen);
13942 mch_memmove(s + prevlen, buf, buflen);
13943 vim_free(prev);
13944 prev = s;
13945 prevlen += buflen;
13948 filtd = 0;
13950 else
13952 mch_memmove(buf, buf + tolist, buflen - tolist);
13953 filtd -= tolist;
13958 * For a negative line count use only the lines at the end of the file,
13959 * free the rest.
13961 if (maxline < 0)
13962 while (cnt > -maxline)
13964 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13965 --cnt;
13968 vim_free(prev);
13969 fclose(fd);
13972 #if defined(FEAT_RELTIME)
13973 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13976 * Convert a List to proftime_T.
13977 * Return FAIL when there is something wrong.
13979 static int
13980 list2proftime(arg, tm)
13981 typval_T *arg;
13982 proftime_T *tm;
13984 long n1, n2;
13985 int error = FALSE;
13987 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13988 || arg->vval.v_list->lv_len != 2)
13989 return FAIL;
13990 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13991 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13992 # ifdef WIN3264
13993 tm->HighPart = n1;
13994 tm->LowPart = n2;
13995 # else
13996 tm->tv_sec = n1;
13997 tm->tv_usec = n2;
13998 # endif
13999 return error ? FAIL : OK;
14001 #endif /* FEAT_RELTIME */
14004 * "reltime()" function
14006 static void
14007 f_reltime(argvars, rettv)
14008 typval_T *argvars;
14009 typval_T *rettv;
14011 #ifdef FEAT_RELTIME
14012 proftime_T res;
14013 proftime_T start;
14015 if (argvars[0].v_type == VAR_UNKNOWN)
14017 /* No arguments: get current time. */
14018 profile_start(&res);
14020 else if (argvars[1].v_type == VAR_UNKNOWN)
14022 if (list2proftime(&argvars[0], &res) == FAIL)
14023 return;
14024 profile_end(&res);
14026 else
14028 /* Two arguments: compute the difference. */
14029 if (list2proftime(&argvars[0], &start) == FAIL
14030 || list2proftime(&argvars[1], &res) == FAIL)
14031 return;
14032 profile_sub(&res, &start);
14035 if (rettv_list_alloc(rettv) == OK)
14037 long n1, n2;
14039 # ifdef WIN3264
14040 n1 = res.HighPart;
14041 n2 = res.LowPart;
14042 # else
14043 n1 = res.tv_sec;
14044 n2 = res.tv_usec;
14045 # endif
14046 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14047 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14049 #endif
14053 * "reltimestr()" function
14055 static void
14056 f_reltimestr(argvars, rettv)
14057 typval_T *argvars;
14058 typval_T *rettv;
14060 #ifdef FEAT_RELTIME
14061 proftime_T tm;
14062 #endif
14064 rettv->v_type = VAR_STRING;
14065 rettv->vval.v_string = NULL;
14066 #ifdef FEAT_RELTIME
14067 if (list2proftime(&argvars[0], &tm) == OK)
14068 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14069 #endif
14072 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14073 static void make_connection __ARGS((void));
14074 static int check_connection __ARGS((void));
14076 static void
14077 make_connection()
14079 if (X_DISPLAY == NULL
14080 # ifdef FEAT_GUI
14081 && !gui.in_use
14082 # endif
14085 x_force_connect = TRUE;
14086 setup_term_clip();
14087 x_force_connect = FALSE;
14091 static int
14092 check_connection()
14094 make_connection();
14095 if (X_DISPLAY == NULL)
14097 EMSG(_("E240: No connection to Vim server"));
14098 return FAIL;
14100 return OK;
14102 #endif
14104 #ifdef FEAT_CLIENTSERVER
14105 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14107 static void
14108 remote_common(argvars, rettv, expr)
14109 typval_T *argvars;
14110 typval_T *rettv;
14111 int expr;
14113 char_u *server_name;
14114 char_u *keys;
14115 char_u *r = NULL;
14116 char_u buf[NUMBUFLEN];
14117 # ifdef WIN32
14118 HWND w;
14119 # else
14120 Window w;
14121 # endif
14123 if (check_restricted() || check_secure())
14124 return;
14126 # ifdef FEAT_X11
14127 if (check_connection() == FAIL)
14128 return;
14129 # endif
14131 server_name = get_tv_string_chk(&argvars[0]);
14132 if (server_name == NULL)
14133 return; /* type error; errmsg already given */
14134 keys = get_tv_string_buf(&argvars[1], buf);
14135 # ifdef WIN32
14136 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14137 # else
14138 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14139 < 0)
14140 # endif
14142 if (r != NULL)
14143 EMSG(r); /* sending worked but evaluation failed */
14144 else
14145 EMSG2(_("E241: Unable to send to %s"), server_name);
14146 return;
14149 rettv->vval.v_string = r;
14151 if (argvars[2].v_type != VAR_UNKNOWN)
14153 dictitem_T v;
14154 char_u str[30];
14155 char_u *idvar;
14157 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14158 v.di_tv.v_type = VAR_STRING;
14159 v.di_tv.vval.v_string = vim_strsave(str);
14160 idvar = get_tv_string_chk(&argvars[2]);
14161 if (idvar != NULL)
14162 set_var(idvar, &v.di_tv, FALSE);
14163 vim_free(v.di_tv.vval.v_string);
14166 #endif
14169 * "remote_expr()" function
14171 static void
14172 f_remote_expr(argvars, rettv)
14173 typval_T *argvars UNUSED;
14174 typval_T *rettv;
14176 rettv->v_type = VAR_STRING;
14177 rettv->vval.v_string = NULL;
14178 #ifdef FEAT_CLIENTSERVER
14179 remote_common(argvars, rettv, TRUE);
14180 #endif
14184 * "remote_foreground()" function
14186 static void
14187 f_remote_foreground(argvars, rettv)
14188 typval_T *argvars UNUSED;
14189 typval_T *rettv UNUSED;
14191 #ifdef FEAT_CLIENTSERVER
14192 # ifdef WIN32
14193 /* On Win32 it's done in this application. */
14195 char_u *server_name = get_tv_string_chk(&argvars[0]);
14197 if (server_name != NULL)
14198 serverForeground(server_name);
14200 # else
14201 /* Send a foreground() expression to the server. */
14202 argvars[1].v_type = VAR_STRING;
14203 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14204 argvars[2].v_type = VAR_UNKNOWN;
14205 remote_common(argvars, rettv, TRUE);
14206 vim_free(argvars[1].vval.v_string);
14207 # endif
14208 #endif
14211 static void
14212 f_remote_peek(argvars, rettv)
14213 typval_T *argvars UNUSED;
14214 typval_T *rettv;
14216 #ifdef FEAT_CLIENTSERVER
14217 dictitem_T v;
14218 char_u *s = NULL;
14219 # ifdef WIN32
14220 long_u n = 0;
14221 # endif
14222 char_u *serverid;
14224 if (check_restricted() || check_secure())
14226 rettv->vval.v_number = -1;
14227 return;
14229 serverid = get_tv_string_chk(&argvars[0]);
14230 if (serverid == NULL)
14232 rettv->vval.v_number = -1;
14233 return; /* type error; errmsg already given */
14235 # ifdef WIN32
14236 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14237 if (n == 0)
14238 rettv->vval.v_number = -1;
14239 else
14241 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14242 rettv->vval.v_number = (s != NULL);
14244 # else
14245 if (check_connection() == FAIL)
14246 return;
14248 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14249 serverStrToWin(serverid), &s);
14250 # endif
14252 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14254 char_u *retvar;
14256 v.di_tv.v_type = VAR_STRING;
14257 v.di_tv.vval.v_string = vim_strsave(s);
14258 retvar = get_tv_string_chk(&argvars[1]);
14259 if (retvar != NULL)
14260 set_var(retvar, &v.di_tv, FALSE);
14261 vim_free(v.di_tv.vval.v_string);
14263 #else
14264 rettv->vval.v_number = -1;
14265 #endif
14268 static void
14269 f_remote_read(argvars, rettv)
14270 typval_T *argvars UNUSED;
14271 typval_T *rettv;
14273 char_u *r = NULL;
14275 #ifdef FEAT_CLIENTSERVER
14276 char_u *serverid = get_tv_string_chk(&argvars[0]);
14278 if (serverid != NULL && !check_restricted() && !check_secure())
14280 # ifdef WIN32
14281 /* The server's HWND is encoded in the 'id' parameter */
14282 long_u n = 0;
14284 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14285 if (n != 0)
14286 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14287 if (r == NULL)
14288 # else
14289 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14290 serverStrToWin(serverid), &r, FALSE) < 0)
14291 # endif
14292 EMSG(_("E277: Unable to read a server reply"));
14294 #endif
14295 rettv->v_type = VAR_STRING;
14296 rettv->vval.v_string = r;
14300 * "remote_send()" function
14302 static void
14303 f_remote_send(argvars, rettv)
14304 typval_T *argvars UNUSED;
14305 typval_T *rettv;
14307 rettv->v_type = VAR_STRING;
14308 rettv->vval.v_string = NULL;
14309 #ifdef FEAT_CLIENTSERVER
14310 remote_common(argvars, rettv, FALSE);
14311 #endif
14315 * "remove()" function
14317 static void
14318 f_remove(argvars, rettv)
14319 typval_T *argvars;
14320 typval_T *rettv;
14322 list_T *l;
14323 listitem_T *item, *item2;
14324 listitem_T *li;
14325 long idx;
14326 long end;
14327 char_u *key;
14328 dict_T *d;
14329 dictitem_T *di;
14331 if (argvars[0].v_type == VAR_DICT)
14333 if (argvars[2].v_type != VAR_UNKNOWN)
14334 EMSG2(_(e_toomanyarg), "remove()");
14335 else if ((d = argvars[0].vval.v_dict) != NULL
14336 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14338 key = get_tv_string_chk(&argvars[1]);
14339 if (key != NULL)
14341 di = dict_find(d, key, -1);
14342 if (di == NULL)
14343 EMSG2(_(e_dictkey), key);
14344 else
14346 *rettv = di->di_tv;
14347 init_tv(&di->di_tv);
14348 dictitem_remove(d, di);
14353 else if (argvars[0].v_type != VAR_LIST)
14354 EMSG2(_(e_listdictarg), "remove()");
14355 else if ((l = argvars[0].vval.v_list) != NULL
14356 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14358 int error = FALSE;
14360 idx = get_tv_number_chk(&argvars[1], &error);
14361 if (error)
14362 ; /* type error: do nothing, errmsg already given */
14363 else if ((item = list_find(l, idx)) == NULL)
14364 EMSGN(_(e_listidx), idx);
14365 else
14367 if (argvars[2].v_type == VAR_UNKNOWN)
14369 /* Remove one item, return its value. */
14370 list_remove(l, item, item);
14371 *rettv = item->li_tv;
14372 vim_free(item);
14374 else
14376 /* Remove range of items, return list with values. */
14377 end = get_tv_number_chk(&argvars[2], &error);
14378 if (error)
14379 ; /* type error: do nothing */
14380 else if ((item2 = list_find(l, end)) == NULL)
14381 EMSGN(_(e_listidx), end);
14382 else
14384 int cnt = 0;
14386 for (li = item; li != NULL; li = li->li_next)
14388 ++cnt;
14389 if (li == item2)
14390 break;
14392 if (li == NULL) /* didn't find "item2" after "item" */
14393 EMSG(_(e_invrange));
14394 else
14396 list_remove(l, item, item2);
14397 if (rettv_list_alloc(rettv) == OK)
14399 l = rettv->vval.v_list;
14400 l->lv_first = item;
14401 l->lv_last = item2;
14402 item->li_prev = NULL;
14403 item2->li_next = NULL;
14404 l->lv_len = cnt;
14414 * "rename({from}, {to})" function
14416 static void
14417 f_rename(argvars, rettv)
14418 typval_T *argvars;
14419 typval_T *rettv;
14421 char_u buf[NUMBUFLEN];
14423 if (check_restricted() || check_secure())
14424 rettv->vval.v_number = -1;
14425 else
14426 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14427 get_tv_string_buf(&argvars[1], buf));
14431 * "repeat()" function
14433 static void
14434 f_repeat(argvars, rettv)
14435 typval_T *argvars;
14436 typval_T *rettv;
14438 char_u *p;
14439 int n;
14440 int slen;
14441 int len;
14442 char_u *r;
14443 int i;
14445 n = get_tv_number(&argvars[1]);
14446 if (argvars[0].v_type == VAR_LIST)
14448 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14449 while (n-- > 0)
14450 if (list_extend(rettv->vval.v_list,
14451 argvars[0].vval.v_list, NULL) == FAIL)
14452 break;
14454 else
14456 p = get_tv_string(&argvars[0]);
14457 rettv->v_type = VAR_STRING;
14458 rettv->vval.v_string = NULL;
14460 slen = (int)STRLEN(p);
14461 len = slen * n;
14462 if (len <= 0)
14463 return;
14465 r = alloc(len + 1);
14466 if (r != NULL)
14468 for (i = 0; i < n; i++)
14469 mch_memmove(r + i * slen, p, (size_t)slen);
14470 r[len] = NUL;
14473 rettv->vval.v_string = r;
14478 * "resolve()" function
14480 static void
14481 f_resolve(argvars, rettv)
14482 typval_T *argvars;
14483 typval_T *rettv;
14485 char_u *p;
14487 p = get_tv_string(&argvars[0]);
14488 #ifdef FEAT_SHORTCUT
14490 char_u *v = NULL;
14492 v = mch_resolve_shortcut(p);
14493 if (v != NULL)
14494 rettv->vval.v_string = v;
14495 else
14496 rettv->vval.v_string = vim_strsave(p);
14498 #else
14499 # ifdef HAVE_READLINK
14501 char_u buf[MAXPATHL + 1];
14502 char_u *cpy;
14503 int len;
14504 char_u *remain = NULL;
14505 char_u *q;
14506 int is_relative_to_current = FALSE;
14507 int has_trailing_pathsep = FALSE;
14508 int limit = 100;
14510 p = vim_strsave(p);
14512 if (p[0] == '.' && (vim_ispathsep(p[1])
14513 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14514 is_relative_to_current = TRUE;
14516 len = STRLEN(p);
14517 if (len > 0 && after_pathsep(p, p + len))
14518 has_trailing_pathsep = TRUE;
14520 q = getnextcomp(p);
14521 if (*q != NUL)
14523 /* Separate the first path component in "p", and keep the
14524 * remainder (beginning with the path separator). */
14525 remain = vim_strsave(q - 1);
14526 q[-1] = NUL;
14529 for (;;)
14531 for (;;)
14533 len = readlink((char *)p, (char *)buf, MAXPATHL);
14534 if (len <= 0)
14535 break;
14536 buf[len] = NUL;
14538 if (limit-- == 0)
14540 vim_free(p);
14541 vim_free(remain);
14542 EMSG(_("E655: Too many symbolic links (cycle?)"));
14543 rettv->vval.v_string = NULL;
14544 goto fail;
14547 /* Ensure that the result will have a trailing path separator
14548 * if the argument has one. */
14549 if (remain == NULL && has_trailing_pathsep)
14550 add_pathsep(buf);
14552 /* Separate the first path component in the link value and
14553 * concatenate the remainders. */
14554 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14555 if (*q != NUL)
14557 if (remain == NULL)
14558 remain = vim_strsave(q - 1);
14559 else
14561 cpy = concat_str(q - 1, remain);
14562 if (cpy != NULL)
14564 vim_free(remain);
14565 remain = cpy;
14568 q[-1] = NUL;
14571 q = gettail(p);
14572 if (q > p && *q == NUL)
14574 /* Ignore trailing path separator. */
14575 q[-1] = NUL;
14576 q = gettail(p);
14578 if (q > p && !mch_isFullName(buf))
14580 /* symlink is relative to directory of argument */
14581 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14582 if (cpy != NULL)
14584 STRCPY(cpy, p);
14585 STRCPY(gettail(cpy), buf);
14586 vim_free(p);
14587 p = cpy;
14590 else
14592 vim_free(p);
14593 p = vim_strsave(buf);
14597 if (remain == NULL)
14598 break;
14600 /* Append the first path component of "remain" to "p". */
14601 q = getnextcomp(remain + 1);
14602 len = q - remain - (*q != NUL);
14603 cpy = vim_strnsave(p, STRLEN(p) + len);
14604 if (cpy != NULL)
14606 STRNCAT(cpy, remain, len);
14607 vim_free(p);
14608 p = cpy;
14610 /* Shorten "remain". */
14611 if (*q != NUL)
14612 STRMOVE(remain, q - 1);
14613 else
14615 vim_free(remain);
14616 remain = NULL;
14620 /* If the result is a relative path name, make it explicitly relative to
14621 * the current directory if and only if the argument had this form. */
14622 if (!vim_ispathsep(*p))
14624 if (is_relative_to_current
14625 && *p != NUL
14626 && !(p[0] == '.'
14627 && (p[1] == NUL
14628 || vim_ispathsep(p[1])
14629 || (p[1] == '.'
14630 && (p[2] == NUL
14631 || vim_ispathsep(p[2]))))))
14633 /* Prepend "./". */
14634 cpy = concat_str((char_u *)"./", p);
14635 if (cpy != NULL)
14637 vim_free(p);
14638 p = cpy;
14641 else if (!is_relative_to_current)
14643 /* Strip leading "./". */
14644 q = p;
14645 while (q[0] == '.' && vim_ispathsep(q[1]))
14646 q += 2;
14647 if (q > p)
14648 STRMOVE(p, p + 2);
14652 /* Ensure that the result will have no trailing path separator
14653 * if the argument had none. But keep "/" or "//". */
14654 if (!has_trailing_pathsep)
14656 q = p + STRLEN(p);
14657 if (after_pathsep(p, q))
14658 *gettail_sep(p) = NUL;
14661 rettv->vval.v_string = p;
14663 # else
14664 rettv->vval.v_string = vim_strsave(p);
14665 # endif
14666 #endif
14668 simplify_filename(rettv->vval.v_string);
14670 #ifdef HAVE_READLINK
14671 fail:
14672 #endif
14673 rettv->v_type = VAR_STRING;
14677 * "reverse({list})" function
14679 static void
14680 f_reverse(argvars, rettv)
14681 typval_T *argvars;
14682 typval_T *rettv;
14684 list_T *l;
14685 listitem_T *li, *ni;
14687 if (argvars[0].v_type != VAR_LIST)
14688 EMSG2(_(e_listarg), "reverse()");
14689 else if ((l = argvars[0].vval.v_list) != NULL
14690 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14692 li = l->lv_last;
14693 l->lv_first = l->lv_last = NULL;
14694 l->lv_len = 0;
14695 while (li != NULL)
14697 ni = li->li_prev;
14698 list_append(l, li);
14699 li = ni;
14701 rettv->vval.v_list = l;
14702 rettv->v_type = VAR_LIST;
14703 ++l->lv_refcount;
14704 l->lv_idx = l->lv_len - l->lv_idx - 1;
14708 #define SP_NOMOVE 0x01 /* don't move cursor */
14709 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14710 #define SP_RETCOUNT 0x04 /* return matchcount */
14711 #define SP_SETPCMARK 0x08 /* set previous context mark */
14712 #define SP_START 0x10 /* accept match at start position */
14713 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14714 #define SP_END 0x40 /* leave cursor at end of match */
14716 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14719 * Get flags for a search function.
14720 * Possibly sets "p_ws".
14721 * Returns BACKWARD, FORWARD or zero (for an error).
14723 static int
14724 get_search_arg(varp, flagsp)
14725 typval_T *varp;
14726 int *flagsp;
14728 int dir = FORWARD;
14729 char_u *flags;
14730 char_u nbuf[NUMBUFLEN];
14731 int mask;
14733 if (varp->v_type != VAR_UNKNOWN)
14735 flags = get_tv_string_buf_chk(varp, nbuf);
14736 if (flags == NULL)
14737 return 0; /* type error; errmsg already given */
14738 while (*flags != NUL)
14740 switch (*flags)
14742 case 'b': dir = BACKWARD; break;
14743 case 'w': p_ws = TRUE; break;
14744 case 'W': p_ws = FALSE; break;
14745 default: mask = 0;
14746 if (flagsp != NULL)
14747 switch (*flags)
14749 case 'c': mask = SP_START; break;
14750 case 'e': mask = SP_END; break;
14751 case 'm': mask = SP_RETCOUNT; break;
14752 case 'n': mask = SP_NOMOVE; break;
14753 case 'p': mask = SP_SUBPAT; break;
14754 case 'r': mask = SP_REPEAT; break;
14755 case 's': mask = SP_SETPCMARK; break;
14757 if (mask == 0)
14759 EMSG2(_(e_invarg2), flags);
14760 dir = 0;
14762 else
14763 *flagsp |= mask;
14765 if (dir == 0)
14766 break;
14767 ++flags;
14770 return dir;
14774 * Shared by search() and searchpos() functions
14776 static int
14777 search_cmn(argvars, match_pos, flagsp)
14778 typval_T *argvars;
14779 pos_T *match_pos;
14780 int *flagsp;
14782 int flags;
14783 char_u *pat;
14784 pos_T pos;
14785 pos_T save_cursor;
14786 int save_p_ws = p_ws;
14787 int dir;
14788 int retval = 0; /* default: FAIL */
14789 long lnum_stop = 0;
14790 proftime_T tm;
14791 #ifdef FEAT_RELTIME
14792 long time_limit = 0;
14793 #endif
14794 int options = SEARCH_KEEP;
14795 int subpatnum;
14797 pat = get_tv_string(&argvars[0]);
14798 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14799 if (dir == 0)
14800 goto theend;
14801 flags = *flagsp;
14802 if (flags & SP_START)
14803 options |= SEARCH_START;
14804 if (flags & SP_END)
14805 options |= SEARCH_END;
14807 /* Optional arguments: line number to stop searching and timeout. */
14808 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14810 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14811 if (lnum_stop < 0)
14812 goto theend;
14813 #ifdef FEAT_RELTIME
14814 if (argvars[3].v_type != VAR_UNKNOWN)
14816 time_limit = get_tv_number_chk(&argvars[3], NULL);
14817 if (time_limit < 0)
14818 goto theend;
14820 #endif
14823 #ifdef FEAT_RELTIME
14824 /* Set the time limit, if there is one. */
14825 profile_setlimit(time_limit, &tm);
14826 #endif
14829 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14830 * Check to make sure only those flags are set.
14831 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14832 * flags cannot be set. Check for that condition also.
14834 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14835 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14837 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14838 goto theend;
14841 pos = save_cursor = curwin->w_cursor;
14842 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14843 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14844 if (subpatnum != FAIL)
14846 if (flags & SP_SUBPAT)
14847 retval = subpatnum;
14848 else
14849 retval = pos.lnum;
14850 if (flags & SP_SETPCMARK)
14851 setpcmark();
14852 curwin->w_cursor = pos;
14853 if (match_pos != NULL)
14855 /* Store the match cursor position */
14856 match_pos->lnum = pos.lnum;
14857 match_pos->col = pos.col + 1;
14859 /* "/$" will put the cursor after the end of the line, may need to
14860 * correct that here */
14861 check_cursor();
14864 /* If 'n' flag is used: restore cursor position. */
14865 if (flags & SP_NOMOVE)
14866 curwin->w_cursor = save_cursor;
14867 else
14868 curwin->w_set_curswant = TRUE;
14869 theend:
14870 p_ws = save_p_ws;
14872 return retval;
14875 #ifdef FEAT_FLOAT
14877 * "round({float})" function
14879 static void
14880 f_round(argvars, rettv)
14881 typval_T *argvars;
14882 typval_T *rettv;
14884 float_T f;
14886 rettv->v_type = VAR_FLOAT;
14887 if (get_float_arg(argvars, &f) == OK)
14888 /* round() is not in C90, use ceil() or floor() instead. */
14889 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14890 else
14891 rettv->vval.v_float = 0.0;
14893 #endif
14896 * "search()" function
14898 static void
14899 f_search(argvars, rettv)
14900 typval_T *argvars;
14901 typval_T *rettv;
14903 int flags = 0;
14905 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14909 * "searchdecl()" function
14911 static void
14912 f_searchdecl(argvars, rettv)
14913 typval_T *argvars;
14914 typval_T *rettv;
14916 int locally = 1;
14917 int thisblock = 0;
14918 int error = FALSE;
14919 char_u *name;
14921 rettv->vval.v_number = 1; /* default: FAIL */
14923 name = get_tv_string_chk(&argvars[0]);
14924 if (argvars[1].v_type != VAR_UNKNOWN)
14926 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14927 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14928 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14930 if (!error && name != NULL)
14931 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14932 locally, thisblock, SEARCH_KEEP) == FAIL;
14936 * Used by searchpair() and searchpairpos()
14938 static int
14939 searchpair_cmn(argvars, match_pos)
14940 typval_T *argvars;
14941 pos_T *match_pos;
14943 char_u *spat, *mpat, *epat;
14944 char_u *skip;
14945 int save_p_ws = p_ws;
14946 int dir;
14947 int flags = 0;
14948 char_u nbuf1[NUMBUFLEN];
14949 char_u nbuf2[NUMBUFLEN];
14950 char_u nbuf3[NUMBUFLEN];
14951 int retval = 0; /* default: FAIL */
14952 long lnum_stop = 0;
14953 long time_limit = 0;
14955 /* Get the three pattern arguments: start, middle, end. */
14956 spat = get_tv_string_chk(&argvars[0]);
14957 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14958 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14959 if (spat == NULL || mpat == NULL || epat == NULL)
14960 goto theend; /* type error */
14962 /* Handle the optional fourth argument: flags */
14963 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14964 if (dir == 0)
14965 goto theend;
14967 /* Don't accept SP_END or SP_SUBPAT.
14968 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14970 if ((flags & (SP_END | SP_SUBPAT)) != 0
14971 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14973 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14974 goto theend;
14977 /* Using 'r' implies 'W', otherwise it doesn't work. */
14978 if (flags & SP_REPEAT)
14979 p_ws = FALSE;
14981 /* Optional fifth argument: skip expression */
14982 if (argvars[3].v_type == VAR_UNKNOWN
14983 || argvars[4].v_type == VAR_UNKNOWN)
14984 skip = (char_u *)"";
14985 else
14987 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14988 if (argvars[5].v_type != VAR_UNKNOWN)
14990 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14991 if (lnum_stop < 0)
14992 goto theend;
14993 #ifdef FEAT_RELTIME
14994 if (argvars[6].v_type != VAR_UNKNOWN)
14996 time_limit = get_tv_number_chk(&argvars[6], NULL);
14997 if (time_limit < 0)
14998 goto theend;
15000 #endif
15003 if (skip == NULL)
15004 goto theend; /* type error */
15006 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15007 match_pos, lnum_stop, time_limit);
15009 theend:
15010 p_ws = save_p_ws;
15012 return retval;
15016 * "searchpair()" function
15018 static void
15019 f_searchpair(argvars, rettv)
15020 typval_T *argvars;
15021 typval_T *rettv;
15023 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15027 * "searchpairpos()" function
15029 static void
15030 f_searchpairpos(argvars, rettv)
15031 typval_T *argvars;
15032 typval_T *rettv;
15034 pos_T match_pos;
15035 int lnum = 0;
15036 int col = 0;
15038 if (rettv_list_alloc(rettv) == FAIL)
15039 return;
15041 if (searchpair_cmn(argvars, &match_pos) > 0)
15043 lnum = match_pos.lnum;
15044 col = match_pos.col;
15047 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15048 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15052 * Search for a start/middle/end thing.
15053 * Used by searchpair(), see its documentation for the details.
15054 * Returns 0 or -1 for no match,
15056 long
15057 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15058 lnum_stop, time_limit)
15059 char_u *spat; /* start pattern */
15060 char_u *mpat; /* middle pattern */
15061 char_u *epat; /* end pattern */
15062 int dir; /* BACKWARD or FORWARD */
15063 char_u *skip; /* skip expression */
15064 int flags; /* SP_SETPCMARK and other SP_ values */
15065 pos_T *match_pos;
15066 linenr_T lnum_stop; /* stop at this line if not zero */
15067 long time_limit; /* stop after this many msec */
15069 char_u *save_cpo;
15070 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15071 long retval = 0;
15072 pos_T pos;
15073 pos_T firstpos;
15074 pos_T foundpos;
15075 pos_T save_cursor;
15076 pos_T save_pos;
15077 int n;
15078 int r;
15079 int nest = 1;
15080 int err;
15081 int options = SEARCH_KEEP;
15082 proftime_T tm;
15084 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15085 save_cpo = p_cpo;
15086 p_cpo = empty_option;
15088 #ifdef FEAT_RELTIME
15089 /* Set the time limit, if there is one. */
15090 profile_setlimit(time_limit, &tm);
15091 #endif
15093 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15094 * start/middle/end (pat3, for the top pair). */
15095 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15096 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15097 if (pat2 == NULL || pat3 == NULL)
15098 goto theend;
15099 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15100 if (*mpat == NUL)
15101 STRCPY(pat3, pat2);
15102 else
15103 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15104 spat, epat, mpat);
15105 if (flags & SP_START)
15106 options |= SEARCH_START;
15108 save_cursor = curwin->w_cursor;
15109 pos = curwin->w_cursor;
15110 clearpos(&firstpos);
15111 clearpos(&foundpos);
15112 pat = pat3;
15113 for (;;)
15115 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15116 options, RE_SEARCH, lnum_stop, &tm);
15117 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15118 /* didn't find it or found the first match again: FAIL */
15119 break;
15121 if (firstpos.lnum == 0)
15122 firstpos = pos;
15123 if (equalpos(pos, foundpos))
15125 /* Found the same position again. Can happen with a pattern that
15126 * has "\zs" at the end and searching backwards. Advance one
15127 * character and try again. */
15128 if (dir == BACKWARD)
15129 decl(&pos);
15130 else
15131 incl(&pos);
15133 foundpos = pos;
15135 /* clear the start flag to avoid getting stuck here */
15136 options &= ~SEARCH_START;
15138 /* If the skip pattern matches, ignore this match. */
15139 if (*skip != NUL)
15141 save_pos = curwin->w_cursor;
15142 curwin->w_cursor = pos;
15143 r = eval_to_bool(skip, &err, NULL, FALSE);
15144 curwin->w_cursor = save_pos;
15145 if (err)
15147 /* Evaluating {skip} caused an error, break here. */
15148 curwin->w_cursor = save_cursor;
15149 retval = -1;
15150 break;
15152 if (r)
15153 continue;
15156 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15158 /* Found end when searching backwards or start when searching
15159 * forward: nested pair. */
15160 ++nest;
15161 pat = pat2; /* nested, don't search for middle */
15163 else
15165 /* Found end when searching forward or start when searching
15166 * backward: end of (nested) pair; or found middle in outer pair. */
15167 if (--nest == 1)
15168 pat = pat3; /* outer level, search for middle */
15171 if (nest == 0)
15173 /* Found the match: return matchcount or line number. */
15174 if (flags & SP_RETCOUNT)
15175 ++retval;
15176 else
15177 retval = pos.lnum;
15178 if (flags & SP_SETPCMARK)
15179 setpcmark();
15180 curwin->w_cursor = pos;
15181 if (!(flags & SP_REPEAT))
15182 break;
15183 nest = 1; /* search for next unmatched */
15187 if (match_pos != NULL)
15189 /* Store the match cursor position */
15190 match_pos->lnum = curwin->w_cursor.lnum;
15191 match_pos->col = curwin->w_cursor.col + 1;
15194 /* If 'n' flag is used or search failed: restore cursor position. */
15195 if ((flags & SP_NOMOVE) || retval == 0)
15196 curwin->w_cursor = save_cursor;
15198 theend:
15199 vim_free(pat2);
15200 vim_free(pat3);
15201 if (p_cpo == empty_option)
15202 p_cpo = save_cpo;
15203 else
15204 /* Darn, evaluating the {skip} expression changed the value. */
15205 free_string_option(save_cpo);
15207 return retval;
15211 * "searchpos()" function
15213 static void
15214 f_searchpos(argvars, rettv)
15215 typval_T *argvars;
15216 typval_T *rettv;
15218 pos_T match_pos;
15219 int lnum = 0;
15220 int col = 0;
15221 int n;
15222 int flags = 0;
15224 if (rettv_list_alloc(rettv) == FAIL)
15225 return;
15227 n = search_cmn(argvars, &match_pos, &flags);
15228 if (n > 0)
15230 lnum = match_pos.lnum;
15231 col = match_pos.col;
15234 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15235 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15236 if (flags & SP_SUBPAT)
15237 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15241 static void
15242 f_server2client(argvars, rettv)
15243 typval_T *argvars UNUSED;
15244 typval_T *rettv;
15246 #ifdef FEAT_CLIENTSERVER
15247 char_u buf[NUMBUFLEN];
15248 char_u *server = get_tv_string_chk(&argvars[0]);
15249 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15251 rettv->vval.v_number = -1;
15252 if (server == NULL || reply == NULL)
15253 return;
15254 if (check_restricted() || check_secure())
15255 return;
15256 # ifdef FEAT_X11
15257 if (check_connection() == FAIL)
15258 return;
15259 # endif
15261 if (serverSendReply(server, reply) < 0)
15263 EMSG(_("E258: Unable to send to client"));
15264 return;
15266 rettv->vval.v_number = 0;
15267 #else
15268 rettv->vval.v_number = -1;
15269 #endif
15272 static void
15273 f_serverlist(argvars, rettv)
15274 typval_T *argvars UNUSED;
15275 typval_T *rettv;
15277 char_u *r = NULL;
15279 #ifdef FEAT_CLIENTSERVER
15280 # ifdef WIN32
15281 r = serverGetVimNames();
15282 # else
15283 make_connection();
15284 if (X_DISPLAY != NULL)
15285 r = serverGetVimNames(X_DISPLAY);
15286 # endif
15287 #endif
15288 rettv->v_type = VAR_STRING;
15289 rettv->vval.v_string = r;
15293 * "setbufvar()" function
15295 static void
15296 f_setbufvar(argvars, rettv)
15297 typval_T *argvars;
15298 typval_T *rettv UNUSED;
15300 buf_T *buf;
15301 aco_save_T aco;
15302 char_u *varname, *bufvarname;
15303 typval_T *varp;
15304 char_u nbuf[NUMBUFLEN];
15306 if (check_restricted() || check_secure())
15307 return;
15308 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15309 varname = get_tv_string_chk(&argvars[1]);
15310 buf = get_buf_tv(&argvars[0]);
15311 varp = &argvars[2];
15313 if (buf != NULL && varname != NULL && varp != NULL)
15315 /* set curbuf to be our buf, temporarily */
15316 aucmd_prepbuf(&aco, buf);
15318 if (*varname == '&')
15320 long numval;
15321 char_u *strval;
15322 int error = FALSE;
15324 ++varname;
15325 numval = get_tv_number_chk(varp, &error);
15326 strval = get_tv_string_buf_chk(varp, nbuf);
15327 if (!error && strval != NULL)
15328 set_option_value(varname, numval, strval, OPT_LOCAL);
15330 else
15332 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15333 if (bufvarname != NULL)
15335 STRCPY(bufvarname, "b:");
15336 STRCPY(bufvarname + 2, varname);
15337 set_var(bufvarname, varp, TRUE);
15338 vim_free(bufvarname);
15342 /* reset notion of buffer */
15343 aucmd_restbuf(&aco);
15348 * "setcmdpos()" function
15350 static void
15351 f_setcmdpos(argvars, rettv)
15352 typval_T *argvars;
15353 typval_T *rettv;
15355 int pos = (int)get_tv_number(&argvars[0]) - 1;
15357 if (pos >= 0)
15358 rettv->vval.v_number = set_cmdline_pos(pos);
15362 * "setline()" function
15364 static void
15365 f_setline(argvars, rettv)
15366 typval_T *argvars;
15367 typval_T *rettv;
15369 linenr_T lnum;
15370 char_u *line = NULL;
15371 list_T *l = NULL;
15372 listitem_T *li = NULL;
15373 long added = 0;
15374 linenr_T lcount = curbuf->b_ml.ml_line_count;
15376 lnum = get_tv_lnum(&argvars[0]);
15377 if (argvars[1].v_type == VAR_LIST)
15379 l = argvars[1].vval.v_list;
15380 li = l->lv_first;
15382 else
15383 line = get_tv_string_chk(&argvars[1]);
15385 /* default result is zero == OK */
15386 for (;;)
15388 if (l != NULL)
15390 /* list argument, get next string */
15391 if (li == NULL)
15392 break;
15393 line = get_tv_string_chk(&li->li_tv);
15394 li = li->li_next;
15397 rettv->vval.v_number = 1; /* FAIL */
15398 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15399 break;
15400 if (lnum <= curbuf->b_ml.ml_line_count)
15402 /* existing line, replace it */
15403 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15405 changed_bytes(lnum, 0);
15406 if (lnum == curwin->w_cursor.lnum)
15407 check_cursor_col();
15408 rettv->vval.v_number = 0; /* OK */
15411 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15413 /* lnum is one past the last line, append the line */
15414 ++added;
15415 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15416 rettv->vval.v_number = 0; /* OK */
15419 if (l == NULL) /* only one string argument */
15420 break;
15421 ++lnum;
15424 if (added > 0)
15425 appended_lines_mark(lcount, added);
15428 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15431 * Used by "setqflist()" and "setloclist()" functions
15433 static void
15434 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15435 win_T *wp UNUSED;
15436 typval_T *list_arg UNUSED;
15437 typval_T *action_arg UNUSED;
15438 typval_T *rettv;
15440 #ifdef FEAT_QUICKFIX
15441 char_u *act;
15442 int action = ' ';
15443 #endif
15445 rettv->vval.v_number = -1;
15447 #ifdef FEAT_QUICKFIX
15448 if (list_arg->v_type != VAR_LIST)
15449 EMSG(_(e_listreq));
15450 else
15452 list_T *l = list_arg->vval.v_list;
15454 if (action_arg->v_type == VAR_STRING)
15456 act = get_tv_string_chk(action_arg);
15457 if (act == NULL)
15458 return; /* type error; errmsg already given */
15459 if (*act == 'a' || *act == 'r')
15460 action = *act;
15463 if (l != NULL && set_errorlist(wp, l, action) == OK)
15464 rettv->vval.v_number = 0;
15466 #endif
15470 * "setloclist()" function
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 static void
15550 f_setpos(argvars, rettv)
15551 typval_T *argvars;
15552 typval_T *rettv;
15554 pos_T pos;
15555 int fnum;
15556 char_u *name;
15558 rettv->vval.v_number = -1;
15559 name = get_tv_string_chk(argvars);
15560 if (name != NULL)
15562 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15564 if (--pos.col < 0)
15565 pos.col = 0;
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 static void
15594 f_setqflist(argvars, rettv)
15595 typval_T *argvars;
15596 typval_T *rettv;
15598 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15602 * "setreg()" function
15604 static void
15605 f_setreg(argvars, rettv)
15606 typval_T *argvars;
15607 typval_T *rettv;
15609 int regname;
15610 char_u *strregname;
15611 char_u *stropt;
15612 char_u *strval;
15613 int append;
15614 char_u yank_type;
15615 long block_len;
15617 block_len = -1;
15618 yank_type = MAUTO;
15619 append = FALSE;
15621 strregname = get_tv_string_chk(argvars);
15622 rettv->vval.v_number = 1; /* FAIL is default */
15624 if (strregname == NULL)
15625 return; /* type error; errmsg already given */
15626 regname = *strregname;
15627 if (regname == 0 || regname == '@')
15628 regname = '"';
15629 else if (regname == '=')
15630 return;
15632 if (argvars[2].v_type != VAR_UNKNOWN)
15634 stropt = get_tv_string_chk(&argvars[2]);
15635 if (stropt == NULL)
15636 return; /* type error */
15637 for (; *stropt != NUL; ++stropt)
15638 switch (*stropt)
15640 case 'a': case 'A': /* append */
15641 append = TRUE;
15642 break;
15643 case 'v': case 'c': /* character-wise selection */
15644 yank_type = MCHAR;
15645 break;
15646 case 'V': case 'l': /* line-wise selection */
15647 yank_type = MLINE;
15648 break;
15649 #ifdef FEAT_VISUAL
15650 case 'b': case Ctrl_V: /* block-wise selection */
15651 yank_type = MBLOCK;
15652 if (VIM_ISDIGIT(stropt[1]))
15654 ++stropt;
15655 block_len = getdigits(&stropt) - 1;
15656 --stropt;
15658 break;
15659 #endif
15663 strval = get_tv_string_chk(&argvars[1]);
15664 if (strval != NULL)
15665 write_reg_contents_ex(regname, strval, -1,
15666 append, yank_type, block_len);
15667 rettv->vval.v_number = 0;
15671 * "settabwinvar()" function
15673 static void
15674 f_settabwinvar(argvars, rettv)
15675 typval_T *argvars;
15676 typval_T *rettv;
15678 setwinvar(argvars, rettv, 1);
15682 * "setwinvar()" function
15684 static void
15685 f_setwinvar(argvars, rettv)
15686 typval_T *argvars;
15687 typval_T *rettv;
15689 setwinvar(argvars, rettv, 0);
15693 * "setwinvar()" and "settabwinvar()" functions
15695 static void
15696 setwinvar(argvars, rettv, off)
15697 typval_T *argvars;
15698 typval_T *rettv UNUSED;
15699 int off;
15701 win_T *win;
15702 #ifdef FEAT_WINDOWS
15703 win_T *save_curwin;
15704 tabpage_T *save_curtab;
15705 #endif
15706 char_u *varname, *winvarname;
15707 typval_T *varp;
15708 char_u nbuf[NUMBUFLEN];
15709 tabpage_T *tp;
15711 if (check_restricted() || check_secure())
15712 return;
15714 #ifdef FEAT_WINDOWS
15715 if (off == 1)
15716 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15717 else
15718 tp = curtab;
15719 #endif
15720 win = find_win_by_nr(&argvars[off], tp);
15721 varname = get_tv_string_chk(&argvars[off + 1]);
15722 varp = &argvars[off + 2];
15724 if (win != NULL && varname != NULL && varp != NULL)
15726 #ifdef FEAT_WINDOWS
15727 /* set curwin to be our win, temporarily */
15728 save_curwin = curwin;
15729 save_curtab = curtab;
15730 goto_tabpage_tp(tp);
15731 if (!win_valid(win))
15732 return;
15733 curwin = win;
15734 curbuf = curwin->w_buffer;
15735 #endif
15737 if (*varname == '&')
15739 long numval;
15740 char_u *strval;
15741 int error = FALSE;
15743 ++varname;
15744 numval = get_tv_number_chk(varp, &error);
15745 strval = get_tv_string_buf_chk(varp, nbuf);
15746 if (!error && strval != NULL)
15747 set_option_value(varname, numval, strval, OPT_LOCAL);
15749 else
15751 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15752 if (winvarname != NULL)
15754 STRCPY(winvarname, "w:");
15755 STRCPY(winvarname + 2, varname);
15756 set_var(winvarname, varp, TRUE);
15757 vim_free(winvarname);
15761 #ifdef FEAT_WINDOWS
15762 /* Restore current tabpage and window, if still valid (autocomands can
15763 * make them invalid). */
15764 if (valid_tabpage(save_curtab))
15765 goto_tabpage_tp(save_curtab);
15766 if (win_valid(save_curwin))
15768 curwin = save_curwin;
15769 curbuf = curwin->w_buffer;
15771 #endif
15776 * "shellescape({string})" function
15778 static void
15779 f_shellescape(argvars, rettv)
15780 typval_T *argvars;
15781 typval_T *rettv;
15783 rettv->vval.v_string = vim_strsave_shellescape(
15784 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15785 rettv->v_type = VAR_STRING;
15789 * "simplify()" function
15791 static void
15792 f_simplify(argvars, rettv)
15793 typval_T *argvars;
15794 typval_T *rettv;
15796 char_u *p;
15798 p = get_tv_string(&argvars[0]);
15799 rettv->vval.v_string = vim_strsave(p);
15800 simplify_filename(rettv->vval.v_string); /* simplify in place */
15801 rettv->v_type = VAR_STRING;
15804 #ifdef FEAT_FLOAT
15806 * "sin()" function
15808 static void
15809 f_sin(argvars, rettv)
15810 typval_T *argvars;
15811 typval_T *rettv;
15813 float_T f;
15815 rettv->v_type = VAR_FLOAT;
15816 if (get_float_arg(argvars, &f) == OK)
15817 rettv->vval.v_float = sin(f);
15818 else
15819 rettv->vval.v_float = 0.0;
15821 #endif
15823 static int
15824 #ifdef __BORLANDC__
15825 _RTLENTRYF
15826 #endif
15827 item_compare __ARGS((const void *s1, const void *s2));
15828 static int
15829 #ifdef __BORLANDC__
15830 _RTLENTRYF
15831 #endif
15832 item_compare2 __ARGS((const void *s1, const void *s2));
15834 static int item_compare_ic;
15835 static char_u *item_compare_func;
15836 static int item_compare_func_err;
15837 #define ITEM_COMPARE_FAIL 999
15840 * Compare functions for f_sort() below.
15842 static int
15843 #ifdef __BORLANDC__
15844 _RTLENTRYF
15845 #endif
15846 item_compare(s1, s2)
15847 const void *s1;
15848 const void *s2;
15850 char_u *p1, *p2;
15851 char_u *tofree1, *tofree2;
15852 int res;
15853 char_u numbuf1[NUMBUFLEN];
15854 char_u numbuf2[NUMBUFLEN];
15856 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15857 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15858 if (p1 == NULL)
15859 p1 = (char_u *)"";
15860 if (p2 == NULL)
15861 p2 = (char_u *)"";
15862 if (item_compare_ic)
15863 res = STRICMP(p1, p2);
15864 else
15865 res = STRCMP(p1, p2);
15866 vim_free(tofree1);
15867 vim_free(tofree2);
15868 return res;
15871 static int
15872 #ifdef __BORLANDC__
15873 _RTLENTRYF
15874 #endif
15875 item_compare2(s1, s2)
15876 const void *s1;
15877 const void *s2;
15879 int res;
15880 typval_T rettv;
15881 typval_T argv[3];
15882 int dummy;
15884 /* shortcut after failure in previous call; compare all items equal */
15885 if (item_compare_func_err)
15886 return 0;
15888 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15889 * in the copy without changing the original list items. */
15890 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15891 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15893 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15894 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15895 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15896 clear_tv(&argv[0]);
15897 clear_tv(&argv[1]);
15899 if (res == FAIL)
15900 res = ITEM_COMPARE_FAIL;
15901 else
15902 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15903 if (item_compare_func_err)
15904 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15905 clear_tv(&rettv);
15906 return res;
15910 * "sort({list})" function
15912 static void
15913 f_sort(argvars, rettv)
15914 typval_T *argvars;
15915 typval_T *rettv;
15917 list_T *l;
15918 listitem_T *li;
15919 listitem_T **ptrs;
15920 long len;
15921 long i;
15923 if (argvars[0].v_type != VAR_LIST)
15924 EMSG2(_(e_listarg), "sort()");
15925 else
15927 l = argvars[0].vval.v_list;
15928 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15929 return;
15930 rettv->vval.v_list = l;
15931 rettv->v_type = VAR_LIST;
15932 ++l->lv_refcount;
15934 len = list_len(l);
15935 if (len <= 1)
15936 return; /* short list sorts pretty quickly */
15938 item_compare_ic = FALSE;
15939 item_compare_func = NULL;
15940 if (argvars[1].v_type != VAR_UNKNOWN)
15942 if (argvars[1].v_type == VAR_FUNC)
15943 item_compare_func = argvars[1].vval.v_string;
15944 else
15946 int error = FALSE;
15948 i = get_tv_number_chk(&argvars[1], &error);
15949 if (error)
15950 return; /* type error; errmsg already given */
15951 if (i == 1)
15952 item_compare_ic = TRUE;
15953 else
15954 item_compare_func = get_tv_string(&argvars[1]);
15958 /* Make an array with each entry pointing to an item in the List. */
15959 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15960 if (ptrs == NULL)
15961 return;
15962 i = 0;
15963 for (li = l->lv_first; li != NULL; li = li->li_next)
15964 ptrs[i++] = li;
15966 item_compare_func_err = FALSE;
15967 /* test the compare function */
15968 if (item_compare_func != NULL
15969 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15970 == ITEM_COMPARE_FAIL)
15971 EMSG(_("E702: Sort compare function failed"));
15972 else
15974 /* Sort the array with item pointers. */
15975 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15976 item_compare_func == NULL ? item_compare : item_compare2);
15978 if (!item_compare_func_err)
15980 /* Clear the List and append the items in the sorted order. */
15981 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15982 l->lv_len = 0;
15983 for (i = 0; i < len; ++i)
15984 list_append(l, ptrs[i]);
15988 vim_free(ptrs);
15993 * "soundfold({word})" function
15995 static void
15996 f_soundfold(argvars, rettv)
15997 typval_T *argvars;
15998 typval_T *rettv;
16000 char_u *s;
16002 rettv->v_type = VAR_STRING;
16003 s = get_tv_string(&argvars[0]);
16004 #ifdef FEAT_SPELL
16005 rettv->vval.v_string = eval_soundfold(s);
16006 #else
16007 rettv->vval.v_string = vim_strsave(s);
16008 #endif
16012 * "spellbadword()" function
16014 static void
16015 f_spellbadword(argvars, rettv)
16016 typval_T *argvars UNUSED;
16017 typval_T *rettv;
16019 char_u *word = (char_u *)"";
16020 hlf_T attr = HLF_COUNT;
16021 int len = 0;
16023 if (rettv_list_alloc(rettv) == FAIL)
16024 return;
16026 #ifdef FEAT_SPELL
16027 if (argvars[0].v_type == VAR_UNKNOWN)
16029 /* Find the start and length of the badly spelled word. */
16030 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16031 if (len != 0)
16032 word = ml_get_cursor();
16034 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16036 char_u *str = get_tv_string_chk(&argvars[0]);
16037 int capcol = -1;
16039 if (str != NULL)
16041 /* Check the argument for spelling. */
16042 while (*str != NUL)
16044 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16045 if (attr != HLF_COUNT)
16047 word = str;
16048 break;
16050 str += len;
16054 #endif
16056 list_append_string(rettv->vval.v_list, word, len);
16057 list_append_string(rettv->vval.v_list, (char_u *)(
16058 attr == HLF_SPB ? "bad" :
16059 attr == HLF_SPR ? "rare" :
16060 attr == HLF_SPL ? "local" :
16061 attr == HLF_SPC ? "caps" :
16062 ""), -1);
16066 * "spellsuggest()" function
16068 static void
16069 f_spellsuggest(argvars, rettv)
16070 typval_T *argvars UNUSED;
16071 typval_T *rettv;
16073 #ifdef FEAT_SPELL
16074 char_u *str;
16075 int typeerr = FALSE;
16076 int maxcount;
16077 garray_T ga;
16078 int i;
16079 listitem_T *li;
16080 int need_capital = FALSE;
16081 #endif
16083 if (rettv_list_alloc(rettv) == FAIL)
16084 return;
16086 #ifdef FEAT_SPELL
16087 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16089 str = get_tv_string(&argvars[0]);
16090 if (argvars[1].v_type != VAR_UNKNOWN)
16092 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16093 if (maxcount <= 0)
16094 return;
16095 if (argvars[2].v_type != VAR_UNKNOWN)
16097 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16098 if (typeerr)
16099 return;
16102 else
16103 maxcount = 25;
16105 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16107 for (i = 0; i < ga.ga_len; ++i)
16109 str = ((char_u **)ga.ga_data)[i];
16111 li = listitem_alloc();
16112 if (li == NULL)
16113 vim_free(str);
16114 else
16116 li->li_tv.v_type = VAR_STRING;
16117 li->li_tv.v_lock = 0;
16118 li->li_tv.vval.v_string = str;
16119 list_append(rettv->vval.v_list, li);
16122 ga_clear(&ga);
16124 #endif
16127 static void
16128 f_split(argvars, rettv)
16129 typval_T *argvars;
16130 typval_T *rettv;
16132 char_u *str;
16133 char_u *end;
16134 char_u *pat = NULL;
16135 regmatch_T regmatch;
16136 char_u patbuf[NUMBUFLEN];
16137 char_u *save_cpo;
16138 int match;
16139 colnr_T col = 0;
16140 int keepempty = FALSE;
16141 int typeerr = FALSE;
16143 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16144 save_cpo = p_cpo;
16145 p_cpo = (char_u *)"";
16147 str = get_tv_string(&argvars[0]);
16148 if (argvars[1].v_type != VAR_UNKNOWN)
16150 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16151 if (pat == NULL)
16152 typeerr = TRUE;
16153 if (argvars[2].v_type != VAR_UNKNOWN)
16154 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16156 if (pat == NULL || *pat == NUL)
16157 pat = (char_u *)"[\\x01- ]\\+";
16159 if (rettv_list_alloc(rettv) == FAIL)
16160 return;
16161 if (typeerr)
16162 return;
16164 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16165 if (regmatch.regprog != NULL)
16167 regmatch.rm_ic = FALSE;
16168 while (*str != NUL || keepempty)
16170 if (*str == NUL)
16171 match = FALSE; /* empty item at the end */
16172 else
16173 match = vim_regexec_nl(&regmatch, str, col);
16174 if (match)
16175 end = regmatch.startp[0];
16176 else
16177 end = str + STRLEN(str);
16178 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16179 && *str != NUL && match && end < regmatch.endp[0]))
16181 if (list_append_string(rettv->vval.v_list, str,
16182 (int)(end - str)) == FAIL)
16183 break;
16185 if (!match)
16186 break;
16187 /* Advance to just after the match. */
16188 if (regmatch.endp[0] > str)
16189 col = 0;
16190 else
16192 /* Don't get stuck at the same match. */
16193 #ifdef FEAT_MBYTE
16194 col = (*mb_ptr2len)(regmatch.endp[0]);
16195 #else
16196 col = 1;
16197 #endif
16199 str = regmatch.endp[0];
16202 vim_free(regmatch.regprog);
16205 p_cpo = save_cpo;
16208 #ifdef FEAT_FLOAT
16210 * "sqrt()" function
16212 static void
16213 f_sqrt(argvars, rettv)
16214 typval_T *argvars;
16215 typval_T *rettv;
16217 float_T f;
16219 rettv->v_type = VAR_FLOAT;
16220 if (get_float_arg(argvars, &f) == OK)
16221 rettv->vval.v_float = sqrt(f);
16222 else
16223 rettv->vval.v_float = 0.0;
16227 * "str2float()" function
16229 static void
16230 f_str2float(argvars, rettv)
16231 typval_T *argvars;
16232 typval_T *rettv;
16234 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16236 if (*p == '+')
16237 p = skipwhite(p + 1);
16238 (void)string2float(p, &rettv->vval.v_float);
16239 rettv->v_type = VAR_FLOAT;
16241 #endif
16244 * "str2nr()" function
16246 static void
16247 f_str2nr(argvars, rettv)
16248 typval_T *argvars;
16249 typval_T *rettv;
16251 int base = 10;
16252 char_u *p;
16253 long n;
16255 if (argvars[1].v_type != VAR_UNKNOWN)
16257 base = get_tv_number(&argvars[1]);
16258 if (base != 8 && base != 10 && base != 16)
16260 EMSG(_(e_invarg));
16261 return;
16265 p = skipwhite(get_tv_string(&argvars[0]));
16266 if (*p == '+')
16267 p = skipwhite(p + 1);
16268 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16269 rettv->vval.v_number = n;
16272 #ifdef HAVE_STRFTIME
16274 * "strftime({format}[, {time}])" function
16276 static void
16277 f_strftime(argvars, rettv)
16278 typval_T *argvars;
16279 typval_T *rettv;
16281 char_u result_buf[256];
16282 struct tm *curtime;
16283 time_t seconds;
16284 char_u *p;
16286 rettv->v_type = VAR_STRING;
16288 p = get_tv_string(&argvars[0]);
16289 if (argvars[1].v_type == VAR_UNKNOWN)
16290 seconds = time(NULL);
16291 else
16292 seconds = (time_t)get_tv_number(&argvars[1]);
16293 curtime = localtime(&seconds);
16294 /* MSVC returns NULL for an invalid value of seconds. */
16295 if (curtime == NULL)
16296 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16297 else
16299 # ifdef FEAT_MBYTE
16300 vimconv_T conv;
16301 char_u *enc;
16303 conv.vc_type = CONV_NONE;
16304 enc = enc_locale();
16305 convert_setup(&conv, p_enc, enc);
16306 if (conv.vc_type != CONV_NONE)
16307 p = string_convert(&conv, p, NULL);
16308 # endif
16309 if (p != NULL)
16310 (void)strftime((char *)result_buf, sizeof(result_buf),
16311 (char *)p, curtime);
16312 else
16313 result_buf[0] = NUL;
16315 # ifdef FEAT_MBYTE
16316 if (conv.vc_type != CONV_NONE)
16317 vim_free(p);
16318 convert_setup(&conv, enc, p_enc);
16319 if (conv.vc_type != CONV_NONE)
16320 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16321 else
16322 # endif
16323 rettv->vval.v_string = vim_strsave(result_buf);
16325 # ifdef FEAT_MBYTE
16326 /* Release conversion descriptors */
16327 convert_setup(&conv, NULL, NULL);
16328 vim_free(enc);
16329 # endif
16332 #endif
16335 * "stridx()" function
16337 static void
16338 f_stridx(argvars, rettv)
16339 typval_T *argvars;
16340 typval_T *rettv;
16342 char_u buf[NUMBUFLEN];
16343 char_u *needle;
16344 char_u *haystack;
16345 char_u *save_haystack;
16346 char_u *pos;
16347 int start_idx;
16349 needle = get_tv_string_chk(&argvars[1]);
16350 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16351 rettv->vval.v_number = -1;
16352 if (needle == NULL || haystack == NULL)
16353 return; /* type error; errmsg already given */
16355 if (argvars[2].v_type != VAR_UNKNOWN)
16357 int error = FALSE;
16359 start_idx = get_tv_number_chk(&argvars[2], &error);
16360 if (error || start_idx >= (int)STRLEN(haystack))
16361 return;
16362 if (start_idx >= 0)
16363 haystack += start_idx;
16366 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16367 if (pos != NULL)
16368 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16372 * "string()" function
16374 static void
16375 f_string(argvars, rettv)
16376 typval_T *argvars;
16377 typval_T *rettv;
16379 char_u *tofree;
16380 char_u numbuf[NUMBUFLEN];
16382 rettv->v_type = VAR_STRING;
16383 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16384 /* Make a copy if we have a value but it's not in allocated memory. */
16385 if (rettv->vval.v_string != NULL && tofree == NULL)
16386 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16390 * "strlen()" function
16392 static void
16393 f_strlen(argvars, rettv)
16394 typval_T *argvars;
16395 typval_T *rettv;
16397 rettv->vval.v_number = (varnumber_T)(STRLEN(
16398 get_tv_string(&argvars[0])));
16402 * "strpart()" function
16404 static void
16405 f_strpart(argvars, rettv)
16406 typval_T *argvars;
16407 typval_T *rettv;
16409 char_u *p;
16410 int n;
16411 int len;
16412 int slen;
16413 int error = FALSE;
16415 p = get_tv_string(&argvars[0]);
16416 slen = (int)STRLEN(p);
16418 n = get_tv_number_chk(&argvars[1], &error);
16419 if (error)
16420 len = 0;
16421 else if (argvars[2].v_type != VAR_UNKNOWN)
16422 len = get_tv_number(&argvars[2]);
16423 else
16424 len = slen - n; /* default len: all bytes that are available. */
16427 * Only return the overlap between the specified part and the actual
16428 * string.
16430 if (n < 0)
16432 len += n;
16433 n = 0;
16435 else if (n > slen)
16436 n = slen;
16437 if (len < 0)
16438 len = 0;
16439 else if (n + len > slen)
16440 len = slen - n;
16442 rettv->v_type = VAR_STRING;
16443 rettv->vval.v_string = vim_strnsave(p + n, len);
16447 * "strridx()" function
16449 static void
16450 f_strridx(argvars, rettv)
16451 typval_T *argvars;
16452 typval_T *rettv;
16454 char_u buf[NUMBUFLEN];
16455 char_u *needle;
16456 char_u *haystack;
16457 char_u *rest;
16458 char_u *lastmatch = NULL;
16459 int haystack_len, end_idx;
16461 needle = get_tv_string_chk(&argvars[1]);
16462 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16464 rettv->vval.v_number = -1;
16465 if (needle == NULL || haystack == NULL)
16466 return; /* type error; errmsg already given */
16468 haystack_len = (int)STRLEN(haystack);
16469 if (argvars[2].v_type != VAR_UNKNOWN)
16471 /* Third argument: upper limit for index */
16472 end_idx = get_tv_number_chk(&argvars[2], NULL);
16473 if (end_idx < 0)
16474 return; /* can never find a match */
16476 else
16477 end_idx = haystack_len;
16479 if (*needle == NUL)
16481 /* Empty string matches past the end. */
16482 lastmatch = haystack + end_idx;
16484 else
16486 for (rest = haystack; *rest != '\0'; ++rest)
16488 rest = (char_u *)strstr((char *)rest, (char *)needle);
16489 if (rest == NULL || rest > haystack + end_idx)
16490 break;
16491 lastmatch = rest;
16495 if (lastmatch == NULL)
16496 rettv->vval.v_number = -1;
16497 else
16498 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16502 * "strtrans()" function
16504 static void
16505 f_strtrans(argvars, rettv)
16506 typval_T *argvars;
16507 typval_T *rettv;
16509 rettv->v_type = VAR_STRING;
16510 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16514 * "submatch()" function
16516 static void
16517 f_submatch(argvars, rettv)
16518 typval_T *argvars;
16519 typval_T *rettv;
16521 rettv->v_type = VAR_STRING;
16522 rettv->vval.v_string =
16523 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16527 * "substitute()" function
16529 static void
16530 f_substitute(argvars, rettv)
16531 typval_T *argvars;
16532 typval_T *rettv;
16534 char_u patbuf[NUMBUFLEN];
16535 char_u subbuf[NUMBUFLEN];
16536 char_u flagsbuf[NUMBUFLEN];
16538 char_u *str = get_tv_string_chk(&argvars[0]);
16539 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16540 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16541 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16543 rettv->v_type = VAR_STRING;
16544 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16545 rettv->vval.v_string = NULL;
16546 else
16547 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16551 * "synID(lnum, col, trans)" function
16553 static void
16554 f_synID(argvars, rettv)
16555 typval_T *argvars UNUSED;
16556 typval_T *rettv;
16558 int id = 0;
16559 #ifdef FEAT_SYN_HL
16560 long lnum;
16561 long col;
16562 int trans;
16563 int transerr = FALSE;
16565 lnum = get_tv_lnum(argvars); /* -1 on type error */
16566 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16567 trans = get_tv_number_chk(&argvars[2], &transerr);
16569 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16570 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16571 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16572 #endif
16574 rettv->vval.v_number = id;
16578 * "synIDattr(id, what [, mode])" function
16580 static void
16581 f_synIDattr(argvars, rettv)
16582 typval_T *argvars UNUSED;
16583 typval_T *rettv;
16585 char_u *p = NULL;
16586 #ifdef FEAT_SYN_HL
16587 int id;
16588 char_u *what;
16589 char_u *mode;
16590 char_u modebuf[NUMBUFLEN];
16591 int modec;
16593 id = get_tv_number(&argvars[0]);
16594 what = get_tv_string(&argvars[1]);
16595 if (argvars[2].v_type != VAR_UNKNOWN)
16597 mode = get_tv_string_buf(&argvars[2], modebuf);
16598 modec = TOLOWER_ASC(mode[0]);
16599 if (modec != 't' && modec != 'c'
16600 #ifdef FEAT_GUI
16601 && modec != 'g'
16602 #endif
16604 modec = 0; /* replace invalid with current */
16606 else
16608 #ifdef FEAT_GUI
16609 if (gui.in_use)
16610 modec = 'g';
16611 else
16612 #endif
16613 if (t_colors > 1)
16614 modec = 'c';
16615 else
16616 modec = 't';
16620 switch (TOLOWER_ASC(what[0]))
16622 case 'b':
16623 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16624 p = highlight_color(id, what, modec);
16625 else /* bold */
16626 p = highlight_has_attr(id, HL_BOLD, modec);
16627 break;
16629 case 'f': /* fg[#] */
16630 p = highlight_color(id, what, modec);
16631 break;
16633 case 'i':
16634 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16635 p = highlight_has_attr(id, HL_INVERSE, modec);
16636 else /* italic */
16637 p = highlight_has_attr(id, HL_ITALIC, modec);
16638 break;
16640 case 'n': /* name */
16641 p = get_highlight_name(NULL, id - 1);
16642 break;
16644 case 'r': /* reverse */
16645 p = highlight_has_attr(id, HL_INVERSE, modec);
16646 break;
16648 case 's':
16649 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16650 p = highlight_color(id, what, modec);
16651 else /* standout */
16652 p = highlight_has_attr(id, HL_STANDOUT, modec);
16653 break;
16655 case 'u':
16656 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16657 /* underline */
16658 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16659 else
16660 /* undercurl */
16661 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16662 break;
16665 if (p != NULL)
16666 p = vim_strsave(p);
16667 #endif
16668 rettv->v_type = VAR_STRING;
16669 rettv->vval.v_string = p;
16673 * "synIDtrans(id)" function
16675 static void
16676 f_synIDtrans(argvars, rettv)
16677 typval_T *argvars UNUSED;
16678 typval_T *rettv;
16680 int id;
16682 #ifdef FEAT_SYN_HL
16683 id = get_tv_number(&argvars[0]);
16685 if (id > 0)
16686 id = syn_get_final_id(id);
16687 else
16688 #endif
16689 id = 0;
16691 rettv->vval.v_number = id;
16695 * "synstack(lnum, col)" function
16697 static void
16698 f_synstack(argvars, rettv)
16699 typval_T *argvars UNUSED;
16700 typval_T *rettv;
16702 #ifdef FEAT_SYN_HL
16703 long lnum;
16704 long col;
16705 int i;
16706 int id;
16707 #endif
16709 rettv->v_type = VAR_LIST;
16710 rettv->vval.v_list = NULL;
16712 #ifdef FEAT_SYN_HL
16713 lnum = get_tv_lnum(argvars); /* -1 on type error */
16714 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16716 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16717 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16718 && rettv_list_alloc(rettv) != FAIL)
16720 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16721 for (i = 0; ; ++i)
16723 id = syn_get_stack_item(i);
16724 if (id < 0)
16725 break;
16726 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16727 break;
16730 #endif
16734 * "system()" function
16736 static void
16737 f_system(argvars, rettv)
16738 typval_T *argvars;
16739 typval_T *rettv;
16741 char_u *res = NULL;
16742 char_u *p;
16743 char_u *infile = NULL;
16744 char_u buf[NUMBUFLEN];
16745 int err = FALSE;
16746 FILE *fd;
16748 if (check_restricted() || check_secure())
16749 goto done;
16751 if (argvars[1].v_type != VAR_UNKNOWN)
16754 * Write the string to a temp file, to be used for input of the shell
16755 * command.
16757 if ((infile = vim_tempname('i')) == NULL)
16759 EMSG(_(e_notmp));
16760 goto done;
16763 fd = mch_fopen((char *)infile, WRITEBIN);
16764 if (fd == NULL)
16766 EMSG2(_(e_notopen), infile);
16767 goto done;
16769 p = get_tv_string_buf_chk(&argvars[1], buf);
16770 if (p == NULL)
16772 fclose(fd);
16773 goto done; /* type error; errmsg already given */
16775 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16776 err = TRUE;
16777 if (fclose(fd) != 0)
16778 err = TRUE;
16779 if (err)
16781 EMSG(_("E677: Error writing temp file"));
16782 goto done;
16786 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16787 SHELL_SILENT | SHELL_COOKED);
16789 #ifdef USE_CR
16790 /* translate <CR> into <NL> */
16791 if (res != NULL)
16793 char_u *s;
16795 for (s = res; *s; ++s)
16797 if (*s == CAR)
16798 *s = NL;
16801 #else
16802 # ifdef USE_CRNL
16803 /* translate <CR><NL> into <NL> */
16804 if (res != NULL)
16806 char_u *s, *d;
16808 d = res;
16809 for (s = res; *s; ++s)
16811 if (s[0] == CAR && s[1] == NL)
16812 ++s;
16813 *d++ = *s;
16815 *d = NUL;
16817 # endif
16818 #endif
16820 done:
16821 if (infile != NULL)
16823 mch_remove(infile);
16824 vim_free(infile);
16826 rettv->v_type = VAR_STRING;
16827 rettv->vval.v_string = res;
16831 * "tabpagebuflist()" function
16833 static void
16834 f_tabpagebuflist(argvars, rettv)
16835 typval_T *argvars UNUSED;
16836 typval_T *rettv UNUSED;
16838 #ifdef FEAT_WINDOWS
16839 tabpage_T *tp;
16840 win_T *wp = NULL;
16842 if (argvars[0].v_type == VAR_UNKNOWN)
16843 wp = firstwin;
16844 else
16846 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16847 if (tp != NULL)
16848 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16850 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16852 for (; wp != NULL; wp = wp->w_next)
16853 if (list_append_number(rettv->vval.v_list,
16854 wp->w_buffer->b_fnum) == FAIL)
16855 break;
16857 #endif
16862 * "tabpagenr()" function
16864 static void
16865 f_tabpagenr(argvars, rettv)
16866 typval_T *argvars UNUSED;
16867 typval_T *rettv;
16869 int nr = 1;
16870 #ifdef FEAT_WINDOWS
16871 char_u *arg;
16873 if (argvars[0].v_type != VAR_UNKNOWN)
16875 arg = get_tv_string_chk(&argvars[0]);
16876 nr = 0;
16877 if (arg != NULL)
16879 if (STRCMP(arg, "$") == 0)
16880 nr = tabpage_index(NULL) - 1;
16881 else
16882 EMSG2(_(e_invexpr2), arg);
16885 else
16886 nr = tabpage_index(curtab);
16887 #endif
16888 rettv->vval.v_number = nr;
16892 #ifdef FEAT_WINDOWS
16893 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16896 * Common code for tabpagewinnr() and winnr().
16898 static int
16899 get_winnr(tp, argvar)
16900 tabpage_T *tp;
16901 typval_T *argvar;
16903 win_T *twin;
16904 int nr = 1;
16905 win_T *wp;
16906 char_u *arg;
16908 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16909 if (argvar->v_type != VAR_UNKNOWN)
16911 arg = get_tv_string_chk(argvar);
16912 if (arg == NULL)
16913 nr = 0; /* type error; errmsg already given */
16914 else if (STRCMP(arg, "$") == 0)
16915 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16916 else if (STRCMP(arg, "#") == 0)
16918 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16919 if (twin == NULL)
16920 nr = 0;
16922 else
16924 EMSG2(_(e_invexpr2), arg);
16925 nr = 0;
16929 if (nr > 0)
16930 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16931 wp != twin; wp = wp->w_next)
16933 if (wp == NULL)
16935 /* didn't find it in this tabpage */
16936 nr = 0;
16937 break;
16939 ++nr;
16941 return nr;
16943 #endif
16946 * "tabpagewinnr()" function
16948 static void
16949 f_tabpagewinnr(argvars, rettv)
16950 typval_T *argvars UNUSED;
16951 typval_T *rettv;
16953 int nr = 1;
16954 #ifdef FEAT_WINDOWS
16955 tabpage_T *tp;
16957 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16958 if (tp == NULL)
16959 nr = 0;
16960 else
16961 nr = get_winnr(tp, &argvars[1]);
16962 #endif
16963 rettv->vval.v_number = nr;
16968 * "tagfiles()" function
16970 static void
16971 f_tagfiles(argvars, rettv)
16972 typval_T *argvars UNUSED;
16973 typval_T *rettv;
16975 char_u fname[MAXPATHL + 1];
16976 tagname_T tn;
16977 int first;
16979 if (rettv_list_alloc(rettv) == FAIL)
16980 return;
16982 for (first = TRUE; ; first = FALSE)
16983 if (get_tagfname(&tn, first, fname) == FAIL
16984 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16985 break;
16986 tagname_free(&tn);
16990 * "taglist()" function
16992 static void
16993 f_taglist(argvars, rettv)
16994 typval_T *argvars;
16995 typval_T *rettv;
16997 char_u *tag_pattern;
16999 tag_pattern = get_tv_string(&argvars[0]);
17001 rettv->vval.v_number = FALSE;
17002 if (*tag_pattern == NUL)
17003 return;
17005 if (rettv_list_alloc(rettv) == OK)
17006 (void)get_tags(rettv->vval.v_list, tag_pattern);
17010 * "tempname()" function
17012 static void
17013 f_tempname(argvars, rettv)
17014 typval_T *argvars UNUSED;
17015 typval_T *rettv;
17017 static int x = 'A';
17019 rettv->v_type = VAR_STRING;
17020 rettv->vval.v_string = vim_tempname(x);
17022 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17023 * names. Skip 'I' and 'O', they are used for shell redirection. */
17026 if (x == 'Z')
17027 x = '0';
17028 else if (x == '9')
17029 x = 'A';
17030 else
17032 #ifdef EBCDIC
17033 if (x == 'I')
17034 x = 'J';
17035 else if (x == 'R')
17036 x = 'S';
17037 else
17038 #endif
17039 ++x;
17041 } while (x == 'I' || x == 'O');
17045 * "test(list)" function: Just checking the walls...
17047 static void
17048 f_test(argvars, rettv)
17049 typval_T *argvars UNUSED;
17050 typval_T *rettv UNUSED;
17052 /* Used for unit testing. Change the code below to your liking. */
17053 #if 0
17054 listitem_T *li;
17055 list_T *l;
17056 char_u *bad, *good;
17058 if (argvars[0].v_type != VAR_LIST)
17059 return;
17060 l = argvars[0].vval.v_list;
17061 if (l == NULL)
17062 return;
17063 li = l->lv_first;
17064 if (li == NULL)
17065 return;
17066 bad = get_tv_string(&li->li_tv);
17067 li = li->li_next;
17068 if (li == NULL)
17069 return;
17070 good = get_tv_string(&li->li_tv);
17071 rettv->vval.v_number = test_edit_score(bad, good);
17072 #endif
17076 * "tolower(string)" function
17078 static void
17079 f_tolower(argvars, rettv)
17080 typval_T *argvars;
17081 typval_T *rettv;
17083 char_u *p;
17085 p = vim_strsave(get_tv_string(&argvars[0]));
17086 rettv->v_type = VAR_STRING;
17087 rettv->vval.v_string = p;
17089 if (p != NULL)
17090 while (*p != NUL)
17092 #ifdef FEAT_MBYTE
17093 int l;
17095 if (enc_utf8)
17097 int c, lc;
17099 c = utf_ptr2char(p);
17100 lc = utf_tolower(c);
17101 l = utf_ptr2len(p);
17102 /* TODO: reallocate string when byte count changes. */
17103 if (utf_char2len(lc) == l)
17104 utf_char2bytes(lc, p);
17105 p += l;
17107 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17108 p += l; /* skip multi-byte character */
17109 else
17110 #endif
17112 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17113 ++p;
17119 * "toupper(string)" function
17121 static void
17122 f_toupper(argvars, rettv)
17123 typval_T *argvars;
17124 typval_T *rettv;
17126 rettv->v_type = VAR_STRING;
17127 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17131 * "tr(string, fromstr, tostr)" function
17133 static void
17134 f_tr(argvars, rettv)
17135 typval_T *argvars;
17136 typval_T *rettv;
17138 char_u *instr;
17139 char_u *fromstr;
17140 char_u *tostr;
17141 char_u *p;
17142 #ifdef FEAT_MBYTE
17143 int inlen;
17144 int fromlen;
17145 int tolen;
17146 int idx;
17147 char_u *cpstr;
17148 int cplen;
17149 int first = TRUE;
17150 #endif
17151 char_u buf[NUMBUFLEN];
17152 char_u buf2[NUMBUFLEN];
17153 garray_T ga;
17155 instr = get_tv_string(&argvars[0]);
17156 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17157 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17159 /* Default return value: empty string. */
17160 rettv->v_type = VAR_STRING;
17161 rettv->vval.v_string = NULL;
17162 if (fromstr == NULL || tostr == NULL)
17163 return; /* type error; errmsg already given */
17164 ga_init2(&ga, (int)sizeof(char), 80);
17166 #ifdef FEAT_MBYTE
17167 if (!has_mbyte)
17168 #endif
17169 /* not multi-byte: fromstr and tostr must be the same length */
17170 if (STRLEN(fromstr) != STRLEN(tostr))
17172 #ifdef FEAT_MBYTE
17173 error:
17174 #endif
17175 EMSG2(_(e_invarg2), fromstr);
17176 ga_clear(&ga);
17177 return;
17180 /* fromstr and tostr have to contain the same number of chars */
17181 while (*instr != NUL)
17183 #ifdef FEAT_MBYTE
17184 if (has_mbyte)
17186 inlen = (*mb_ptr2len)(instr);
17187 cpstr = instr;
17188 cplen = inlen;
17189 idx = 0;
17190 for (p = fromstr; *p != NUL; p += fromlen)
17192 fromlen = (*mb_ptr2len)(p);
17193 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17195 for (p = tostr; *p != NUL; p += tolen)
17197 tolen = (*mb_ptr2len)(p);
17198 if (idx-- == 0)
17200 cplen = tolen;
17201 cpstr = p;
17202 break;
17205 if (*p == NUL) /* tostr is shorter than fromstr */
17206 goto error;
17207 break;
17209 ++idx;
17212 if (first && cpstr == instr)
17214 /* Check that fromstr and tostr have the same number of
17215 * (multi-byte) characters. Done only once when a character
17216 * of instr doesn't appear in fromstr. */
17217 first = FALSE;
17218 for (p = tostr; *p != NUL; p += tolen)
17220 tolen = (*mb_ptr2len)(p);
17221 --idx;
17223 if (idx != 0)
17224 goto error;
17227 ga_grow(&ga, cplen);
17228 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17229 ga.ga_len += cplen;
17231 instr += inlen;
17233 else
17234 #endif
17236 /* When not using multi-byte chars we can do it faster. */
17237 p = vim_strchr(fromstr, *instr);
17238 if (p != NULL)
17239 ga_append(&ga, tostr[p - fromstr]);
17240 else
17241 ga_append(&ga, *instr);
17242 ++instr;
17246 /* add a terminating NUL */
17247 ga_grow(&ga, 1);
17248 ga_append(&ga, NUL);
17250 rettv->vval.v_string = ga.ga_data;
17253 #ifdef FEAT_FLOAT
17255 * "trunc({float})" function
17257 static void
17258 f_trunc(argvars, rettv)
17259 typval_T *argvars;
17260 typval_T *rettv;
17262 float_T f;
17264 rettv->v_type = VAR_FLOAT;
17265 if (get_float_arg(argvars, &f) == OK)
17266 /* trunc() is not in C90, use floor() or ceil() instead. */
17267 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17268 else
17269 rettv->vval.v_float = 0.0;
17271 #endif
17274 * "type(expr)" function
17276 static void
17277 f_type(argvars, rettv)
17278 typval_T *argvars;
17279 typval_T *rettv;
17281 int n;
17283 switch (argvars[0].v_type)
17285 case VAR_NUMBER: n = 0; break;
17286 case VAR_STRING: n = 1; break;
17287 case VAR_FUNC: n = 2; break;
17288 case VAR_LIST: n = 3; break;
17289 case VAR_DICT: n = 4; break;
17290 #ifdef FEAT_FLOAT
17291 case VAR_FLOAT: n = 5; break;
17292 #endif
17293 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17295 rettv->vval.v_number = n;
17299 * "values(dict)" function
17301 static void
17302 f_values(argvars, rettv)
17303 typval_T *argvars;
17304 typval_T *rettv;
17306 dict_list(argvars, rettv, 1);
17310 * "virtcol(string)" function
17312 static void
17313 f_virtcol(argvars, rettv)
17314 typval_T *argvars;
17315 typval_T *rettv;
17317 colnr_T vcol = 0;
17318 pos_T *fp;
17319 int fnum = curbuf->b_fnum;
17321 fp = var2fpos(&argvars[0], FALSE, &fnum);
17322 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17323 && fnum == curbuf->b_fnum)
17325 getvvcol(curwin, fp, NULL, NULL, &vcol);
17326 ++vcol;
17329 rettv->vval.v_number = vcol;
17333 * "visualmode()" function
17335 static void
17336 f_visualmode(argvars, rettv)
17337 typval_T *argvars UNUSED;
17338 typval_T *rettv UNUSED;
17340 #ifdef FEAT_VISUAL
17341 char_u str[2];
17343 rettv->v_type = VAR_STRING;
17344 str[0] = curbuf->b_visual_mode_eval;
17345 str[1] = NUL;
17346 rettv->vval.v_string = vim_strsave(str);
17348 /* A non-zero number or non-empty string argument: reset mode. */
17349 if (non_zero_arg(&argvars[0]))
17350 curbuf->b_visual_mode_eval = NUL;
17351 #endif
17355 * "winbufnr(nr)" function
17357 static void
17358 f_winbufnr(argvars, rettv)
17359 typval_T *argvars;
17360 typval_T *rettv;
17362 win_T *wp;
17364 wp = find_win_by_nr(&argvars[0], NULL);
17365 if (wp == NULL)
17366 rettv->vval.v_number = -1;
17367 else
17368 rettv->vval.v_number = wp->w_buffer->b_fnum;
17372 * "wincol()" function
17374 static void
17375 f_wincol(argvars, rettv)
17376 typval_T *argvars UNUSED;
17377 typval_T *rettv;
17379 validate_cursor();
17380 rettv->vval.v_number = curwin->w_wcol + 1;
17384 * "winheight(nr)" function
17386 static void
17387 f_winheight(argvars, rettv)
17388 typval_T *argvars;
17389 typval_T *rettv;
17391 win_T *wp;
17393 wp = find_win_by_nr(&argvars[0], NULL);
17394 if (wp == NULL)
17395 rettv->vval.v_number = -1;
17396 else
17397 rettv->vval.v_number = wp->w_height;
17401 * "winline()" function
17403 static void
17404 f_winline(argvars, rettv)
17405 typval_T *argvars UNUSED;
17406 typval_T *rettv;
17408 validate_cursor();
17409 rettv->vval.v_number = curwin->w_wrow + 1;
17413 * "winnr()" function
17415 static void
17416 f_winnr(argvars, rettv)
17417 typval_T *argvars UNUSED;
17418 typval_T *rettv;
17420 int nr = 1;
17422 #ifdef FEAT_WINDOWS
17423 nr = get_winnr(curtab, &argvars[0]);
17424 #endif
17425 rettv->vval.v_number = nr;
17429 * "winrestcmd()" function
17431 static void
17432 f_winrestcmd(argvars, rettv)
17433 typval_T *argvars UNUSED;
17434 typval_T *rettv;
17436 #ifdef FEAT_WINDOWS
17437 win_T *wp;
17438 int winnr = 1;
17439 garray_T ga;
17440 char_u buf[50];
17442 ga_init2(&ga, (int)sizeof(char), 70);
17443 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17445 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17446 ga_concat(&ga, buf);
17447 # ifdef FEAT_VERTSPLIT
17448 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17449 ga_concat(&ga, buf);
17450 # endif
17451 ++winnr;
17453 ga_append(&ga, NUL);
17455 rettv->vval.v_string = ga.ga_data;
17456 #else
17457 rettv->vval.v_string = NULL;
17458 #endif
17459 rettv->v_type = VAR_STRING;
17463 * "winrestview()" function
17465 static void
17466 f_winrestview(argvars, rettv)
17467 typval_T *argvars;
17468 typval_T *rettv UNUSED;
17470 dict_T *dict;
17472 if (argvars[0].v_type != VAR_DICT
17473 || (dict = argvars[0].vval.v_dict) == NULL)
17474 EMSG(_(e_invarg));
17475 else
17477 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17478 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17479 #ifdef FEAT_VIRTUALEDIT
17480 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17481 #endif
17482 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17483 curwin->w_set_curswant = FALSE;
17485 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17486 #ifdef FEAT_DIFF
17487 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17488 #endif
17489 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17490 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17492 check_cursor();
17493 changed_cline_bef_curs();
17494 invalidate_botline();
17495 redraw_later(VALID);
17497 if (curwin->w_topline == 0)
17498 curwin->w_topline = 1;
17499 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17500 curwin->w_topline = curbuf->b_ml.ml_line_count;
17501 #ifdef FEAT_DIFF
17502 check_topfill(curwin, TRUE);
17503 #endif
17508 * "winsaveview()" function
17510 static void
17511 f_winsaveview(argvars, rettv)
17512 typval_T *argvars UNUSED;
17513 typval_T *rettv;
17515 dict_T *dict;
17517 dict = dict_alloc();
17518 if (dict == NULL)
17519 return;
17520 rettv->v_type = VAR_DICT;
17521 rettv->vval.v_dict = dict;
17522 ++dict->dv_refcount;
17524 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17525 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17526 #ifdef FEAT_VIRTUALEDIT
17527 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17528 #endif
17529 update_curswant();
17530 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17532 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17533 #ifdef FEAT_DIFF
17534 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17535 #endif
17536 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17537 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17541 * "winwidth(nr)" function
17543 static void
17544 f_winwidth(argvars, rettv)
17545 typval_T *argvars;
17546 typval_T *rettv;
17548 win_T *wp;
17550 wp = find_win_by_nr(&argvars[0], NULL);
17551 if (wp == NULL)
17552 rettv->vval.v_number = -1;
17553 else
17554 #ifdef FEAT_VERTSPLIT
17555 rettv->vval.v_number = wp->w_width;
17556 #else
17557 rettv->vval.v_number = Columns;
17558 #endif
17562 * "writefile()" function
17564 static void
17565 f_writefile(argvars, rettv)
17566 typval_T *argvars;
17567 typval_T *rettv;
17569 int binary = FALSE;
17570 char_u *fname;
17571 FILE *fd;
17572 listitem_T *li;
17573 char_u *s;
17574 int ret = 0;
17575 int c;
17577 if (check_restricted() || check_secure())
17578 return;
17580 if (argvars[0].v_type != VAR_LIST)
17582 EMSG2(_(e_listarg), "writefile()");
17583 return;
17585 if (argvars[0].vval.v_list == NULL)
17586 return;
17588 if (argvars[2].v_type != VAR_UNKNOWN
17589 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17590 binary = TRUE;
17592 /* Always open the file in binary mode, library functions have a mind of
17593 * their own about CR-LF conversion. */
17594 fname = get_tv_string(&argvars[1]);
17595 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17597 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17598 ret = -1;
17600 else
17602 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17603 li = li->li_next)
17605 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17607 if (*s == '\n')
17608 c = putc(NUL, fd);
17609 else
17610 c = putc(*s, fd);
17611 if (c == EOF)
17613 ret = -1;
17614 break;
17617 if (!binary || li->li_next != NULL)
17618 if (putc('\n', fd) == EOF)
17620 ret = -1;
17621 break;
17623 if (ret < 0)
17625 EMSG(_(e_write));
17626 break;
17629 fclose(fd);
17632 rettv->vval.v_number = ret;
17636 * Translate a String variable into a position.
17637 * Returns NULL when there is an error.
17639 static pos_T *
17640 var2fpos(varp, dollar_lnum, fnum)
17641 typval_T *varp;
17642 int dollar_lnum; /* TRUE when $ is last line */
17643 int *fnum; /* set to fnum for '0, 'A, etc. */
17645 char_u *name;
17646 static pos_T pos;
17647 pos_T *pp;
17649 /* Argument can be [lnum, col, coladd]. */
17650 if (varp->v_type == VAR_LIST)
17652 list_T *l;
17653 int len;
17654 int error = FALSE;
17655 listitem_T *li;
17657 l = varp->vval.v_list;
17658 if (l == NULL)
17659 return NULL;
17661 /* Get the line number */
17662 pos.lnum = list_find_nr(l, 0L, &error);
17663 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17664 return NULL; /* invalid line number */
17666 /* Get the column number */
17667 pos.col = list_find_nr(l, 1L, &error);
17668 if (error)
17669 return NULL;
17670 len = (long)STRLEN(ml_get(pos.lnum));
17672 /* We accept "$" for the column number: last column. */
17673 li = list_find(l, 1L);
17674 if (li != NULL && li->li_tv.v_type == VAR_STRING
17675 && li->li_tv.vval.v_string != NULL
17676 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17677 pos.col = len + 1;
17679 /* Accept a position up to the NUL after the line. */
17680 if (pos.col == 0 || (int)pos.col > len + 1)
17681 return NULL; /* invalid column number */
17682 --pos.col;
17684 #ifdef FEAT_VIRTUALEDIT
17685 /* Get the virtual offset. Defaults to zero. */
17686 pos.coladd = list_find_nr(l, 2L, &error);
17687 if (error)
17688 pos.coladd = 0;
17689 #endif
17691 return &pos;
17694 name = get_tv_string_chk(varp);
17695 if (name == NULL)
17696 return NULL;
17697 if (name[0] == '.') /* cursor */
17698 return &curwin->w_cursor;
17699 #ifdef FEAT_VISUAL
17700 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17702 if (VIsual_active)
17703 return &VIsual;
17704 return &curwin->w_cursor;
17706 #endif
17707 if (name[0] == '\'') /* mark */
17709 pp = getmark_fnum(name[1], FALSE, fnum);
17710 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17711 return NULL;
17712 return pp;
17715 #ifdef FEAT_VIRTUALEDIT
17716 pos.coladd = 0;
17717 #endif
17719 if (name[0] == 'w' && dollar_lnum)
17721 pos.col = 0;
17722 if (name[1] == '0') /* "w0": first visible line */
17724 update_topline();
17725 pos.lnum = curwin->w_topline;
17726 return &pos;
17728 else if (name[1] == '$') /* "w$": last visible line */
17730 validate_botline();
17731 pos.lnum = curwin->w_botline - 1;
17732 return &pos;
17735 else if (name[0] == '$') /* last column or line */
17737 if (dollar_lnum)
17739 pos.lnum = curbuf->b_ml.ml_line_count;
17740 pos.col = 0;
17742 else
17744 pos.lnum = curwin->w_cursor.lnum;
17745 pos.col = (colnr_T)STRLEN(ml_get_curline());
17747 return &pos;
17749 return NULL;
17753 * Convert list in "arg" into a position and optional file number.
17754 * When "fnump" is NULL there is no file number, only 3 items.
17755 * Note that the column is passed on as-is, the caller may want to decrement
17756 * it to use 1 for the first column.
17757 * Return FAIL when conversion is not possible, doesn't check the position for
17758 * validity.
17760 static int
17761 list2fpos(arg, posp, fnump)
17762 typval_T *arg;
17763 pos_T *posp;
17764 int *fnump;
17766 list_T *l = arg->vval.v_list;
17767 long i = 0;
17768 long n;
17770 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17771 * when "fnump" isn't NULL and "coladd" is optional. */
17772 if (arg->v_type != VAR_LIST
17773 || l == NULL
17774 || l->lv_len < (fnump == NULL ? 2 : 3)
17775 || l->lv_len > (fnump == NULL ? 3 : 4))
17776 return FAIL;
17778 if (fnump != NULL)
17780 n = list_find_nr(l, i++, NULL); /* fnum */
17781 if (n < 0)
17782 return FAIL;
17783 if (n == 0)
17784 n = curbuf->b_fnum; /* current buffer */
17785 *fnump = n;
17788 n = list_find_nr(l, i++, NULL); /* lnum */
17789 if (n < 0)
17790 return FAIL;
17791 posp->lnum = n;
17793 n = list_find_nr(l, i++, NULL); /* col */
17794 if (n < 0)
17795 return FAIL;
17796 posp->col = n;
17798 #ifdef FEAT_VIRTUALEDIT
17799 n = list_find_nr(l, i, NULL);
17800 if (n < 0)
17801 posp->coladd = 0;
17802 else
17803 posp->coladd = n;
17804 #endif
17806 return OK;
17810 * Get the length of an environment variable name.
17811 * Advance "arg" to the first character after the name.
17812 * Return 0 for error.
17814 static int
17815 get_env_len(arg)
17816 char_u **arg;
17818 char_u *p;
17819 int len;
17821 for (p = *arg; vim_isIDc(*p); ++p)
17823 if (p == *arg) /* no name found */
17824 return 0;
17826 len = (int)(p - *arg);
17827 *arg = p;
17828 return len;
17832 * Get the length of the name of a function or internal variable.
17833 * "arg" is advanced to the first non-white character after the name.
17834 * Return 0 if something is wrong.
17836 static int
17837 get_id_len(arg)
17838 char_u **arg;
17840 char_u *p;
17841 int len;
17843 /* Find the end of the name. */
17844 for (p = *arg; eval_isnamec(*p); ++p)
17846 if (p == *arg) /* no name found */
17847 return 0;
17849 len = (int)(p - *arg);
17850 *arg = skipwhite(p);
17852 return len;
17856 * Get the length of the name of a variable or function.
17857 * Only the name is recognized, does not handle ".key" or "[idx]".
17858 * "arg" is advanced to the first non-white character after the name.
17859 * Return -1 if curly braces expansion failed.
17860 * Return 0 if something else is wrong.
17861 * If the name contains 'magic' {}'s, expand them and return the
17862 * expanded name in an allocated string via 'alias' - caller must free.
17864 static int
17865 get_name_len(arg, alias, evaluate, verbose)
17866 char_u **arg;
17867 char_u **alias;
17868 int evaluate;
17869 int verbose;
17871 int len;
17872 char_u *p;
17873 char_u *expr_start;
17874 char_u *expr_end;
17876 *alias = NULL; /* default to no alias */
17878 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17879 && (*arg)[2] == (int)KE_SNR)
17881 /* hard coded <SNR>, already translated */
17882 *arg += 3;
17883 return get_id_len(arg) + 3;
17885 len = eval_fname_script(*arg);
17886 if (len > 0)
17888 /* literal "<SID>", "s:" or "<SNR>" */
17889 *arg += len;
17893 * Find the end of the name; check for {} construction.
17895 p = find_name_end(*arg, &expr_start, &expr_end,
17896 len > 0 ? 0 : FNE_CHECK_START);
17897 if (expr_start != NULL)
17899 char_u *temp_string;
17901 if (!evaluate)
17903 len += (int)(p - *arg);
17904 *arg = skipwhite(p);
17905 return len;
17909 * Include any <SID> etc in the expanded string:
17910 * Thus the -len here.
17912 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17913 if (temp_string == NULL)
17914 return -1;
17915 *alias = temp_string;
17916 *arg = skipwhite(p);
17917 return (int)STRLEN(temp_string);
17920 len += get_id_len(arg);
17921 if (len == 0 && verbose)
17922 EMSG2(_(e_invexpr2), *arg);
17924 return len;
17928 * Find the end of a variable or function name, taking care of magic braces.
17929 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17930 * start and end of the first magic braces item.
17931 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17932 * Return a pointer to just after the name. Equal to "arg" if there is no
17933 * valid name.
17935 static char_u *
17936 find_name_end(arg, expr_start, expr_end, flags)
17937 char_u *arg;
17938 char_u **expr_start;
17939 char_u **expr_end;
17940 int flags;
17942 int mb_nest = 0;
17943 int br_nest = 0;
17944 char_u *p;
17946 if (expr_start != NULL)
17948 *expr_start = NULL;
17949 *expr_end = NULL;
17952 /* Quick check for valid starting character. */
17953 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17954 return arg;
17956 for (p = arg; *p != NUL
17957 && (eval_isnamec(*p)
17958 || *p == '{'
17959 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17960 || mb_nest != 0
17961 || br_nest != 0); mb_ptr_adv(p))
17963 if (*p == '\'')
17965 /* skip over 'string' to avoid counting [ and ] inside it. */
17966 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17968 if (*p == NUL)
17969 break;
17971 else if (*p == '"')
17973 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17974 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17975 if (*p == '\\' && p[1] != NUL)
17976 ++p;
17977 if (*p == NUL)
17978 break;
17981 if (mb_nest == 0)
17983 if (*p == '[')
17984 ++br_nest;
17985 else if (*p == ']')
17986 --br_nest;
17989 if (br_nest == 0)
17991 if (*p == '{')
17993 mb_nest++;
17994 if (expr_start != NULL && *expr_start == NULL)
17995 *expr_start = p;
17997 else if (*p == '}')
17999 mb_nest--;
18000 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18001 *expr_end = p;
18006 return p;
18010 * Expands out the 'magic' {}'s in a variable/function name.
18011 * Note that this can call itself recursively, to deal with
18012 * constructs like foo{bar}{baz}{bam}
18013 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18014 * "in_start" ^
18015 * "expr_start" ^
18016 * "expr_end" ^
18017 * "in_end" ^
18019 * Returns a new allocated string, which the caller must free.
18020 * Returns NULL for failure.
18022 static char_u *
18023 make_expanded_name(in_start, expr_start, expr_end, in_end)
18024 char_u *in_start;
18025 char_u *expr_start;
18026 char_u *expr_end;
18027 char_u *in_end;
18029 char_u c1;
18030 char_u *retval = NULL;
18031 char_u *temp_result;
18032 char_u *nextcmd = NULL;
18034 if (expr_end == NULL || in_end == NULL)
18035 return NULL;
18036 *expr_start = NUL;
18037 *expr_end = NUL;
18038 c1 = *in_end;
18039 *in_end = NUL;
18041 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18042 if (temp_result != NULL && nextcmd == NULL)
18044 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18045 + (in_end - expr_end) + 1));
18046 if (retval != NULL)
18048 STRCPY(retval, in_start);
18049 STRCAT(retval, temp_result);
18050 STRCAT(retval, expr_end + 1);
18053 vim_free(temp_result);
18055 *in_end = c1; /* put char back for error messages */
18056 *expr_start = '{';
18057 *expr_end = '}';
18059 if (retval != NULL)
18061 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18062 if (expr_start != NULL)
18064 /* Further expansion! */
18065 temp_result = make_expanded_name(retval, expr_start,
18066 expr_end, temp_result);
18067 vim_free(retval);
18068 retval = temp_result;
18072 return retval;
18076 * Return TRUE if character "c" can be used in a variable or function name.
18077 * Does not include '{' or '}' for magic braces.
18079 static int
18080 eval_isnamec(c)
18081 int c;
18083 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18087 * Return TRUE if character "c" can be used as the first character in a
18088 * variable or function name (excluding '{' and '}').
18090 static int
18091 eval_isnamec1(c)
18092 int c;
18094 return (ASCII_ISALPHA(c) || c == '_');
18098 * Set number v: variable to "val".
18100 void
18101 set_vim_var_nr(idx, val)
18102 int idx;
18103 long val;
18105 vimvars[idx].vv_nr = val;
18109 * Get number v: variable value.
18111 long
18112 get_vim_var_nr(idx)
18113 int idx;
18115 return vimvars[idx].vv_nr;
18119 * Get string v: variable value. Uses a static buffer, can only be used once.
18121 char_u *
18122 get_vim_var_str(idx)
18123 int idx;
18125 return get_tv_string(&vimvars[idx].vv_tv);
18129 * Get List v: variable value. Caller must take care of reference count when
18130 * needed.
18132 list_T *
18133 get_vim_var_list(idx)
18134 int idx;
18136 return vimvars[idx].vv_list;
18140 * Set v:char to character "c".
18142 void
18143 set_vim_var_char(c)
18144 int c;
18146 #ifdef FEAT_MBYTE
18147 char_u buf[MB_MAXBYTES];
18148 #else
18149 char_u buf[2];
18150 #endif
18152 #ifdef FEAT_MBYTE
18153 if (has_mbyte)
18154 buf[(*mb_char2bytes)(c, buf)] = NUL;
18155 else
18156 #endif
18158 buf[0] = c;
18159 buf[1] = NUL;
18161 set_vim_var_string(VV_CHAR, buf, -1);
18165 * Set v:count to "count" and v:count1 to "count1".
18166 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18168 void
18169 set_vcount(count, count1, set_prevcount)
18170 long count;
18171 long count1;
18172 int set_prevcount;
18174 if (set_prevcount)
18175 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18176 vimvars[VV_COUNT].vv_nr = count;
18177 vimvars[VV_COUNT1].vv_nr = count1;
18181 * Set string v: variable to a copy of "val".
18183 void
18184 set_vim_var_string(idx, val, len)
18185 int idx;
18186 char_u *val;
18187 int len; /* length of "val" to use or -1 (whole string) */
18189 /* Need to do this (at least) once, since we can't initialize a union.
18190 * Will always be invoked when "v:progname" is set. */
18191 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18193 vim_free(vimvars[idx].vv_str);
18194 if (val == NULL)
18195 vimvars[idx].vv_str = NULL;
18196 else if (len == -1)
18197 vimvars[idx].vv_str = vim_strsave(val);
18198 else
18199 vimvars[idx].vv_str = vim_strnsave(val, len);
18203 * Set List v: variable to "val".
18205 void
18206 set_vim_var_list(idx, val)
18207 int idx;
18208 list_T *val;
18210 list_unref(vimvars[idx].vv_list);
18211 vimvars[idx].vv_list = val;
18212 if (val != NULL)
18213 ++val->lv_refcount;
18217 * Set v:register if needed.
18219 void
18220 set_reg_var(c)
18221 int c;
18223 char_u regname;
18225 if (c == 0 || c == ' ')
18226 regname = '"';
18227 else
18228 regname = c;
18229 /* Avoid free/alloc when the value is already right. */
18230 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18231 set_vim_var_string(VV_REG, &regname, 1);
18235 * Get or set v:exception. If "oldval" == NULL, return the current value.
18236 * Otherwise, restore the value to "oldval" and return NULL.
18237 * Must always be called in pairs to save and restore v:exception! Does not
18238 * take care of memory allocations.
18240 char_u *
18241 v_exception(oldval)
18242 char_u *oldval;
18244 if (oldval == NULL)
18245 return vimvars[VV_EXCEPTION].vv_str;
18247 vimvars[VV_EXCEPTION].vv_str = oldval;
18248 return NULL;
18252 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18253 * Otherwise, restore the value to "oldval" and return NULL.
18254 * Must always be called in pairs to save and restore v:throwpoint! Does not
18255 * take care of memory allocations.
18257 char_u *
18258 v_throwpoint(oldval)
18259 char_u *oldval;
18261 if (oldval == NULL)
18262 return vimvars[VV_THROWPOINT].vv_str;
18264 vimvars[VV_THROWPOINT].vv_str = oldval;
18265 return NULL;
18268 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18270 * Set v:cmdarg.
18271 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18272 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18273 * Must always be called in pairs!
18275 char_u *
18276 set_cmdarg(eap, oldarg)
18277 exarg_T *eap;
18278 char_u *oldarg;
18280 char_u *oldval;
18281 char_u *newval;
18282 unsigned len;
18284 oldval = vimvars[VV_CMDARG].vv_str;
18285 if (eap == NULL)
18287 vim_free(oldval);
18288 vimvars[VV_CMDARG].vv_str = oldarg;
18289 return NULL;
18292 if (eap->force_bin == FORCE_BIN)
18293 len = 6;
18294 else if (eap->force_bin == FORCE_NOBIN)
18295 len = 8;
18296 else
18297 len = 0;
18299 if (eap->read_edit)
18300 len += 7;
18302 if (eap->force_ff != 0)
18303 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18304 # ifdef FEAT_MBYTE
18305 if (eap->force_enc != 0)
18306 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18307 if (eap->bad_char != 0)
18308 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18309 # endif
18311 newval = alloc(len + 1);
18312 if (newval == NULL)
18313 return NULL;
18315 if (eap->force_bin == FORCE_BIN)
18316 sprintf((char *)newval, " ++bin");
18317 else if (eap->force_bin == FORCE_NOBIN)
18318 sprintf((char *)newval, " ++nobin");
18319 else
18320 *newval = NUL;
18322 if (eap->read_edit)
18323 STRCAT(newval, " ++edit");
18325 if (eap->force_ff != 0)
18326 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18327 eap->cmd + eap->force_ff);
18328 # ifdef FEAT_MBYTE
18329 if (eap->force_enc != 0)
18330 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18331 eap->cmd + eap->force_enc);
18332 if (eap->bad_char != 0)
18333 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18334 eap->cmd + eap->bad_char);
18335 # endif
18336 vimvars[VV_CMDARG].vv_str = newval;
18337 return oldval;
18339 #endif
18342 * Get the value of internal variable "name".
18343 * Return OK or FAIL.
18345 static int
18346 get_var_tv(name, len, rettv, verbose)
18347 char_u *name;
18348 int len; /* length of "name" */
18349 typval_T *rettv; /* NULL when only checking existence */
18350 int verbose; /* may give error message */
18352 int ret = OK;
18353 typval_T *tv = NULL;
18354 typval_T atv;
18355 dictitem_T *v;
18356 int cc;
18358 /* truncate the name, so that we can use strcmp() */
18359 cc = name[len];
18360 name[len] = NUL;
18363 * Check for "b:changedtick".
18365 if (STRCMP(name, "b:changedtick") == 0)
18367 atv.v_type = VAR_NUMBER;
18368 atv.vval.v_number = curbuf->b_changedtick;
18369 tv = &atv;
18373 * Check for user-defined variables.
18375 else
18377 v = find_var(name, NULL);
18378 if (v != NULL)
18379 tv = &v->di_tv;
18382 if (tv == NULL)
18384 if (rettv != NULL && verbose)
18385 EMSG2(_(e_undefvar), name);
18386 ret = FAIL;
18388 else if (rettv != NULL)
18389 copy_tv(tv, rettv);
18391 name[len] = cc;
18393 return ret;
18397 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18398 * Also handle function call with Funcref variable: func(expr)
18399 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18401 static int
18402 handle_subscript(arg, rettv, evaluate, verbose)
18403 char_u **arg;
18404 typval_T *rettv;
18405 int evaluate; /* do more than finding the end */
18406 int verbose; /* give error messages */
18408 int ret = OK;
18409 dict_T *selfdict = NULL;
18410 char_u *s;
18411 int len;
18412 typval_T functv;
18414 while (ret == OK
18415 && (**arg == '['
18416 || (**arg == '.' && rettv->v_type == VAR_DICT)
18417 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18418 && !vim_iswhite(*(*arg - 1)))
18420 if (**arg == '(')
18422 /* need to copy the funcref so that we can clear rettv */
18423 functv = *rettv;
18424 rettv->v_type = VAR_UNKNOWN;
18426 /* Invoke the function. Recursive! */
18427 s = functv.vval.v_string;
18428 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18429 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18430 &len, evaluate, selfdict);
18432 /* Clear the funcref afterwards, so that deleting it while
18433 * evaluating the arguments is possible (see test55). */
18434 clear_tv(&functv);
18436 /* Stop the expression evaluation when immediately aborting on
18437 * error, or when an interrupt occurred or an exception was thrown
18438 * but not caught. */
18439 if (aborting())
18441 if (ret == OK)
18442 clear_tv(rettv);
18443 ret = FAIL;
18445 dict_unref(selfdict);
18446 selfdict = NULL;
18448 else /* **arg == '[' || **arg == '.' */
18450 dict_unref(selfdict);
18451 if (rettv->v_type == VAR_DICT)
18453 selfdict = rettv->vval.v_dict;
18454 if (selfdict != NULL)
18455 ++selfdict->dv_refcount;
18457 else
18458 selfdict = NULL;
18459 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18461 clear_tv(rettv);
18462 ret = FAIL;
18466 dict_unref(selfdict);
18467 return ret;
18471 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18472 * value).
18474 static typval_T *
18475 alloc_tv()
18477 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18481 * Allocate memory for a variable type-value, and assign a string to it.
18482 * The string "s" must have been allocated, it is consumed.
18483 * Return NULL for out of memory, the variable otherwise.
18485 static typval_T *
18486 alloc_string_tv(s)
18487 char_u *s;
18489 typval_T *rettv;
18491 rettv = alloc_tv();
18492 if (rettv != NULL)
18494 rettv->v_type = VAR_STRING;
18495 rettv->vval.v_string = s;
18497 else
18498 vim_free(s);
18499 return rettv;
18503 * Free the memory for a variable type-value.
18505 void
18506 free_tv(varp)
18507 typval_T *varp;
18509 if (varp != NULL)
18511 switch (varp->v_type)
18513 case VAR_FUNC:
18514 func_unref(varp->vval.v_string);
18515 /*FALLTHROUGH*/
18516 case VAR_STRING:
18517 vim_free(varp->vval.v_string);
18518 break;
18519 case VAR_LIST:
18520 list_unref(varp->vval.v_list);
18521 break;
18522 case VAR_DICT:
18523 dict_unref(varp->vval.v_dict);
18524 break;
18525 case VAR_NUMBER:
18526 #ifdef FEAT_FLOAT
18527 case VAR_FLOAT:
18528 #endif
18529 case VAR_UNKNOWN:
18530 break;
18531 default:
18532 EMSG2(_(e_intern2), "free_tv()");
18533 break;
18535 vim_free(varp);
18540 * Free the memory for a variable value and set the value to NULL or 0.
18542 void
18543 clear_tv(varp)
18544 typval_T *varp;
18546 if (varp != NULL)
18548 switch (varp->v_type)
18550 case VAR_FUNC:
18551 func_unref(varp->vval.v_string);
18552 /*FALLTHROUGH*/
18553 case VAR_STRING:
18554 vim_free(varp->vval.v_string);
18555 varp->vval.v_string = NULL;
18556 break;
18557 case VAR_LIST:
18558 list_unref(varp->vval.v_list);
18559 varp->vval.v_list = NULL;
18560 break;
18561 case VAR_DICT:
18562 dict_unref(varp->vval.v_dict);
18563 varp->vval.v_dict = NULL;
18564 break;
18565 case VAR_NUMBER:
18566 varp->vval.v_number = 0;
18567 break;
18568 #ifdef FEAT_FLOAT
18569 case VAR_FLOAT:
18570 varp->vval.v_float = 0.0;
18571 break;
18572 #endif
18573 case VAR_UNKNOWN:
18574 break;
18575 default:
18576 EMSG2(_(e_intern2), "clear_tv()");
18578 varp->v_lock = 0;
18583 * Set the value of a variable to NULL without freeing items.
18585 static void
18586 init_tv(varp)
18587 typval_T *varp;
18589 if (varp != NULL)
18590 vim_memset(varp, 0, sizeof(typval_T));
18594 * Get the number value of a variable.
18595 * If it is a String variable, uses vim_str2nr().
18596 * For incompatible types, return 0.
18597 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18598 * caller of incompatible types: it sets *denote to TRUE if "denote"
18599 * is not NULL or returns -1 otherwise.
18601 static long
18602 get_tv_number(varp)
18603 typval_T *varp;
18605 int error = FALSE;
18607 return get_tv_number_chk(varp, &error); /* return 0L on error */
18610 long
18611 get_tv_number_chk(varp, denote)
18612 typval_T *varp;
18613 int *denote;
18615 long n = 0L;
18617 switch (varp->v_type)
18619 case VAR_NUMBER:
18620 return (long)(varp->vval.v_number);
18621 #ifdef FEAT_FLOAT
18622 case VAR_FLOAT:
18623 EMSG(_("E805: Using a Float as a Number"));
18624 break;
18625 #endif
18626 case VAR_FUNC:
18627 EMSG(_("E703: Using a Funcref as a Number"));
18628 break;
18629 case VAR_STRING:
18630 if (varp->vval.v_string != NULL)
18631 vim_str2nr(varp->vval.v_string, NULL, NULL,
18632 TRUE, TRUE, &n, NULL);
18633 return n;
18634 case VAR_LIST:
18635 EMSG(_("E745: Using a List as a Number"));
18636 break;
18637 case VAR_DICT:
18638 EMSG(_("E728: Using a Dictionary as a Number"));
18639 break;
18640 default:
18641 EMSG2(_(e_intern2), "get_tv_number()");
18642 break;
18644 if (denote == NULL) /* useful for values that must be unsigned */
18645 n = -1;
18646 else
18647 *denote = TRUE;
18648 return n;
18652 * Get the lnum from the first argument.
18653 * Also accepts ".", "$", etc., but that only works for the current buffer.
18654 * Returns -1 on error.
18656 static linenr_T
18657 get_tv_lnum(argvars)
18658 typval_T *argvars;
18660 typval_T rettv;
18661 linenr_T lnum;
18663 lnum = get_tv_number_chk(&argvars[0], NULL);
18664 if (lnum == 0) /* no valid number, try using line() */
18666 rettv.v_type = VAR_NUMBER;
18667 f_line(argvars, &rettv);
18668 lnum = rettv.vval.v_number;
18669 clear_tv(&rettv);
18671 return lnum;
18675 * Get the lnum from the first argument.
18676 * Also accepts "$", then "buf" is used.
18677 * Returns 0 on error.
18679 static linenr_T
18680 get_tv_lnum_buf(argvars, buf)
18681 typval_T *argvars;
18682 buf_T *buf;
18684 if (argvars[0].v_type == VAR_STRING
18685 && argvars[0].vval.v_string != NULL
18686 && argvars[0].vval.v_string[0] == '$'
18687 && buf != NULL)
18688 return buf->b_ml.ml_line_count;
18689 return get_tv_number_chk(&argvars[0], NULL);
18693 * Get the string value of a variable.
18694 * If it is a Number variable, the number is converted into a string.
18695 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18696 * get_tv_string_buf() uses a given buffer.
18697 * If the String variable has never been set, return an empty string.
18698 * Never returns NULL;
18699 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18700 * NULL on error.
18702 static char_u *
18703 get_tv_string(varp)
18704 typval_T *varp;
18706 static char_u mybuf[NUMBUFLEN];
18708 return get_tv_string_buf(varp, mybuf);
18711 static char_u *
18712 get_tv_string_buf(varp, buf)
18713 typval_T *varp;
18714 char_u *buf;
18716 char_u *res = get_tv_string_buf_chk(varp, buf);
18718 return res != NULL ? res : (char_u *)"";
18721 char_u *
18722 get_tv_string_chk(varp)
18723 typval_T *varp;
18725 static char_u mybuf[NUMBUFLEN];
18727 return get_tv_string_buf_chk(varp, mybuf);
18730 static char_u *
18731 get_tv_string_buf_chk(varp, buf)
18732 typval_T *varp;
18733 char_u *buf;
18735 switch (varp->v_type)
18737 case VAR_NUMBER:
18738 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18739 return buf;
18740 case VAR_FUNC:
18741 EMSG(_("E729: using Funcref as a String"));
18742 break;
18743 case VAR_LIST:
18744 EMSG(_("E730: using List as a String"));
18745 break;
18746 case VAR_DICT:
18747 EMSG(_("E731: using Dictionary as a String"));
18748 break;
18749 #ifdef FEAT_FLOAT
18750 case VAR_FLOAT:
18751 EMSG(_("E806: using Float as a String"));
18752 break;
18753 #endif
18754 case VAR_STRING:
18755 if (varp->vval.v_string != NULL)
18756 return varp->vval.v_string;
18757 return (char_u *)"";
18758 default:
18759 EMSG2(_(e_intern2), "get_tv_string_buf()");
18760 break;
18762 return NULL;
18766 * Find variable "name" in the list of variables.
18767 * Return a pointer to it if found, NULL if not found.
18768 * Careful: "a:0" variables don't have a name.
18769 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18770 * hashtab_T used.
18772 static dictitem_T *
18773 find_var(name, htp)
18774 char_u *name;
18775 hashtab_T **htp;
18777 char_u *varname;
18778 hashtab_T *ht;
18780 ht = find_var_ht(name, &varname);
18781 if (htp != NULL)
18782 *htp = ht;
18783 if (ht == NULL)
18784 return NULL;
18785 return find_var_in_ht(ht, varname, htp != NULL);
18789 * Find variable "varname" in hashtab "ht".
18790 * Returns NULL if not found.
18792 static dictitem_T *
18793 find_var_in_ht(ht, varname, writing)
18794 hashtab_T *ht;
18795 char_u *varname;
18796 int writing;
18798 hashitem_T *hi;
18800 if (*varname == NUL)
18802 /* Must be something like "s:", otherwise "ht" would be NULL. */
18803 switch (varname[-2])
18805 case 's': return &SCRIPT_SV(current_SID).sv_var;
18806 case 'g': return &globvars_var;
18807 case 'v': return &vimvars_var;
18808 case 'b': return &curbuf->b_bufvar;
18809 case 'w': return &curwin->w_winvar;
18810 #ifdef FEAT_WINDOWS
18811 case 't': return &curtab->tp_winvar;
18812 #endif
18813 case 'l': return current_funccal == NULL
18814 ? NULL : &current_funccal->l_vars_var;
18815 case 'a': return current_funccal == NULL
18816 ? NULL : &current_funccal->l_avars_var;
18818 return NULL;
18821 hi = hash_find(ht, varname);
18822 if (HASHITEM_EMPTY(hi))
18824 /* For global variables we may try auto-loading the script. If it
18825 * worked find the variable again. Don't auto-load a script if it was
18826 * loaded already, otherwise it would be loaded every time when
18827 * checking if a function name is a Funcref variable. */
18828 if (ht == &globvarht && !writing
18829 && script_autoload(varname, FALSE) && !aborting())
18830 hi = hash_find(ht, varname);
18831 if (HASHITEM_EMPTY(hi))
18832 return NULL;
18834 return HI2DI(hi);
18838 * Find the hashtab used for a variable name.
18839 * Set "varname" to the start of name without ':'.
18841 static hashtab_T *
18842 find_var_ht(name, varname)
18843 char_u *name;
18844 char_u **varname;
18846 hashitem_T *hi;
18848 if (name[1] != ':')
18850 /* The name must not start with a colon or #. */
18851 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18852 return NULL;
18853 *varname = name;
18855 /* "version" is "v:version" in all scopes */
18856 hi = hash_find(&compat_hashtab, name);
18857 if (!HASHITEM_EMPTY(hi))
18858 return &compat_hashtab;
18860 if (current_funccal == NULL)
18861 return &globvarht; /* global variable */
18862 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18864 *varname = name + 2;
18865 if (*name == 'g') /* global variable */
18866 return &globvarht;
18867 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18869 if (vim_strchr(name + 2, ':') != NULL
18870 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18871 return NULL;
18872 if (*name == 'b') /* buffer variable */
18873 return &curbuf->b_vars.dv_hashtab;
18874 if (*name == 'w') /* window variable */
18875 return &curwin->w_vars.dv_hashtab;
18876 #ifdef FEAT_WINDOWS
18877 if (*name == 't') /* tab page variable */
18878 return &curtab->tp_vars.dv_hashtab;
18879 #endif
18880 if (*name == 'v') /* v: variable */
18881 return &vimvarht;
18882 if (*name == 'a' && current_funccal != NULL) /* function argument */
18883 return &current_funccal->l_avars.dv_hashtab;
18884 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18885 return &current_funccal->l_vars.dv_hashtab;
18886 if (*name == 's' /* script variable */
18887 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18888 return &SCRIPT_VARS(current_SID);
18889 return NULL;
18893 * Get the string value of a (global/local) variable.
18894 * Returns NULL when it doesn't exist.
18896 char_u *
18897 get_var_value(name)
18898 char_u *name;
18900 dictitem_T *v;
18902 v = find_var(name, NULL);
18903 if (v == NULL)
18904 return NULL;
18905 return get_tv_string(&v->di_tv);
18909 * Allocate a new hashtab for a sourced script. It will be used while
18910 * sourcing this script and when executing functions defined in the script.
18912 void
18913 new_script_vars(id)
18914 scid_T id;
18916 int i;
18917 hashtab_T *ht;
18918 scriptvar_T *sv;
18920 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18922 /* Re-allocating ga_data means that an ht_array pointing to
18923 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18924 * at its init value. Also reset "v_dict", it's always the same. */
18925 for (i = 1; i <= ga_scripts.ga_len; ++i)
18927 ht = &SCRIPT_VARS(i);
18928 if (ht->ht_mask == HT_INIT_SIZE - 1)
18929 ht->ht_array = ht->ht_smallarray;
18930 sv = &SCRIPT_SV(i);
18931 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18934 while (ga_scripts.ga_len < id)
18936 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18937 init_var_dict(&sv->sv_dict, &sv->sv_var);
18938 ++ga_scripts.ga_len;
18944 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18945 * point to it.
18947 void
18948 init_var_dict(dict, dict_var)
18949 dict_T *dict;
18950 dictitem_T *dict_var;
18952 hash_init(&dict->dv_hashtab);
18953 dict->dv_refcount = DO_NOT_FREE_CNT;
18954 dict->dv_copyID = 0;
18955 dict_var->di_tv.vval.v_dict = dict;
18956 dict_var->di_tv.v_type = VAR_DICT;
18957 dict_var->di_tv.v_lock = VAR_FIXED;
18958 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18959 dict_var->di_key[0] = NUL;
18963 * Clean up a list of internal variables.
18964 * Frees all allocated variables and the value they contain.
18965 * Clears hashtab "ht", does not free it.
18967 void
18968 vars_clear(ht)
18969 hashtab_T *ht;
18971 vars_clear_ext(ht, TRUE);
18975 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18977 static void
18978 vars_clear_ext(ht, free_val)
18979 hashtab_T *ht;
18980 int free_val;
18982 int todo;
18983 hashitem_T *hi;
18984 dictitem_T *v;
18986 hash_lock(ht);
18987 todo = (int)ht->ht_used;
18988 for (hi = ht->ht_array; todo > 0; ++hi)
18990 if (!HASHITEM_EMPTY(hi))
18992 --todo;
18994 /* Free the variable. Don't remove it from the hashtab,
18995 * ht_array might change then. hash_clear() takes care of it
18996 * later. */
18997 v = HI2DI(hi);
18998 if (free_val)
18999 clear_tv(&v->di_tv);
19000 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19001 vim_free(v);
19004 hash_clear(ht);
19005 ht->ht_used = 0;
19009 * Delete a variable from hashtab "ht" at item "hi".
19010 * Clear the variable value and free the dictitem.
19012 static void
19013 delete_var(ht, hi)
19014 hashtab_T *ht;
19015 hashitem_T *hi;
19017 dictitem_T *di = HI2DI(hi);
19019 hash_remove(ht, hi);
19020 clear_tv(&di->di_tv);
19021 vim_free(di);
19025 * List the value of one internal variable.
19027 static void
19028 list_one_var(v, prefix, first)
19029 dictitem_T *v;
19030 char_u *prefix;
19031 int *first;
19033 char_u *tofree;
19034 char_u *s;
19035 char_u numbuf[NUMBUFLEN];
19037 current_copyID += COPYID_INC;
19038 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19039 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19040 s == NULL ? (char_u *)"" : s, first);
19041 vim_free(tofree);
19044 static void
19045 list_one_var_a(prefix, name, type, string, first)
19046 char_u *prefix;
19047 char_u *name;
19048 int type;
19049 char_u *string;
19050 int *first; /* when TRUE clear rest of screen and set to FALSE */
19052 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19053 msg_start();
19054 msg_puts(prefix);
19055 if (name != NULL) /* "a:" vars don't have a name stored */
19056 msg_puts(name);
19057 msg_putchar(' ');
19058 msg_advance(22);
19059 if (type == VAR_NUMBER)
19060 msg_putchar('#');
19061 else if (type == VAR_FUNC)
19062 msg_putchar('*');
19063 else if (type == VAR_LIST)
19065 msg_putchar('[');
19066 if (*string == '[')
19067 ++string;
19069 else if (type == VAR_DICT)
19071 msg_putchar('{');
19072 if (*string == '{')
19073 ++string;
19075 else
19076 msg_putchar(' ');
19078 msg_outtrans(string);
19080 if (type == VAR_FUNC)
19081 msg_puts((char_u *)"()");
19082 if (*first)
19084 msg_clr_eos();
19085 *first = FALSE;
19090 * Set variable "name" to value in "tv".
19091 * If the variable already exists, the value is updated.
19092 * Otherwise the variable is created.
19094 static void
19095 set_var(name, tv, copy)
19096 char_u *name;
19097 typval_T *tv;
19098 int copy; /* make copy of value in "tv" */
19100 dictitem_T *v;
19101 char_u *varname;
19102 hashtab_T *ht;
19103 char_u *p;
19105 if (tv->v_type == VAR_FUNC)
19107 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19108 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19109 ? name[2] : name[0]))
19111 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19112 return;
19114 if (function_exists(name))
19116 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19117 name);
19118 return;
19122 ht = find_var_ht(name, &varname);
19123 if (ht == NULL || *varname == NUL)
19125 EMSG2(_(e_illvar), name);
19126 return;
19129 v = find_var_in_ht(ht, varname, TRUE);
19130 if (v != NULL)
19132 /* existing variable, need to clear the value */
19133 if (var_check_ro(v->di_flags, name)
19134 || tv_check_lock(v->di_tv.v_lock, name))
19135 return;
19136 if (v->di_tv.v_type != tv->v_type
19137 && !((v->di_tv.v_type == VAR_STRING
19138 || v->di_tv.v_type == VAR_NUMBER)
19139 && (tv->v_type == VAR_STRING
19140 || tv->v_type == VAR_NUMBER))
19141 #ifdef FEAT_FLOAT
19142 && !((v->di_tv.v_type == VAR_NUMBER
19143 || v->di_tv.v_type == VAR_FLOAT)
19144 && (tv->v_type == VAR_NUMBER
19145 || tv->v_type == VAR_FLOAT))
19146 #endif
19149 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19150 return;
19154 * Handle setting internal v: variables separately: we don't change
19155 * the type.
19157 if (ht == &vimvarht)
19159 if (v->di_tv.v_type == VAR_STRING)
19161 vim_free(v->di_tv.vval.v_string);
19162 if (copy || tv->v_type != VAR_STRING)
19163 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19164 else
19166 /* Take over the string to avoid an extra alloc/free. */
19167 v->di_tv.vval.v_string = tv->vval.v_string;
19168 tv->vval.v_string = NULL;
19171 else if (v->di_tv.v_type != VAR_NUMBER)
19172 EMSG2(_(e_intern2), "set_var()");
19173 else
19175 v->di_tv.vval.v_number = get_tv_number(tv);
19176 if (STRCMP(varname, "searchforward") == 0)
19177 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19179 return;
19182 clear_tv(&v->di_tv);
19184 else /* add a new variable */
19186 /* Can't add "v:" variable. */
19187 if (ht == &vimvarht)
19189 EMSG2(_(e_illvar), name);
19190 return;
19193 /* Make sure the variable name is valid. */
19194 for (p = varname; *p != NUL; ++p)
19195 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19196 && *p != AUTOLOAD_CHAR)
19198 EMSG2(_(e_illvar), varname);
19199 return;
19202 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19203 + STRLEN(varname)));
19204 if (v == NULL)
19205 return;
19206 STRCPY(v->di_key, varname);
19207 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19209 vim_free(v);
19210 return;
19212 v->di_flags = 0;
19215 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19216 copy_tv(tv, &v->di_tv);
19217 else
19219 v->di_tv = *tv;
19220 v->di_tv.v_lock = 0;
19221 init_tv(tv);
19226 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19227 * Also give an error message.
19229 static int
19230 var_check_ro(flags, name)
19231 int flags;
19232 char_u *name;
19234 if (flags & DI_FLAGS_RO)
19236 EMSG2(_(e_readonlyvar), name);
19237 return TRUE;
19239 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19241 EMSG2(_(e_readonlysbx), name);
19242 return TRUE;
19244 return FALSE;
19248 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19249 * Also give an error message.
19251 static int
19252 var_check_fixed(flags, name)
19253 int flags;
19254 char_u *name;
19256 if (flags & DI_FLAGS_FIX)
19258 EMSG2(_("E795: Cannot delete variable %s"), name);
19259 return TRUE;
19261 return FALSE;
19265 * Return TRUE if typeval "tv" is set to be locked (immutable).
19266 * Also give an error message, using "name".
19268 static int
19269 tv_check_lock(lock, name)
19270 int lock;
19271 char_u *name;
19273 if (lock & VAR_LOCKED)
19275 EMSG2(_("E741: Value is locked: %s"),
19276 name == NULL ? (char_u *)_("Unknown") : name);
19277 return TRUE;
19279 if (lock & VAR_FIXED)
19281 EMSG2(_("E742: Cannot change value of %s"),
19282 name == NULL ? (char_u *)_("Unknown") : name);
19283 return TRUE;
19285 return FALSE;
19289 * Copy the values from typval_T "from" to typval_T "to".
19290 * When needed allocates string or increases reference count.
19291 * Does not make a copy of a list or dict but copies the reference!
19292 * It is OK for "from" and "to" to point to the same item. This is used to
19293 * make a copy later.
19295 void
19296 copy_tv(from, to)
19297 typval_T *from;
19298 typval_T *to;
19300 to->v_type = from->v_type;
19301 to->v_lock = 0;
19302 switch (from->v_type)
19304 case VAR_NUMBER:
19305 to->vval.v_number = from->vval.v_number;
19306 break;
19307 #ifdef FEAT_FLOAT
19308 case VAR_FLOAT:
19309 to->vval.v_float = from->vval.v_float;
19310 break;
19311 #endif
19312 case VAR_STRING:
19313 case VAR_FUNC:
19314 if (from->vval.v_string == NULL)
19315 to->vval.v_string = NULL;
19316 else
19318 to->vval.v_string = vim_strsave(from->vval.v_string);
19319 if (from->v_type == VAR_FUNC)
19320 func_ref(to->vval.v_string);
19322 break;
19323 case VAR_LIST:
19324 if (from->vval.v_list == NULL)
19325 to->vval.v_list = NULL;
19326 else
19328 to->vval.v_list = from->vval.v_list;
19329 ++to->vval.v_list->lv_refcount;
19331 break;
19332 case VAR_DICT:
19333 if (from->vval.v_dict == NULL)
19334 to->vval.v_dict = NULL;
19335 else
19337 to->vval.v_dict = from->vval.v_dict;
19338 ++to->vval.v_dict->dv_refcount;
19340 break;
19341 default:
19342 EMSG2(_(e_intern2), "copy_tv()");
19343 break;
19348 * Make a copy of an item.
19349 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19350 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19351 * reference to an already copied list/dict can be used.
19352 * Returns FAIL or OK.
19354 static int
19355 item_copy(from, to, deep, copyID)
19356 typval_T *from;
19357 typval_T *to;
19358 int deep;
19359 int copyID;
19361 static int recurse = 0;
19362 int ret = OK;
19364 if (recurse >= DICT_MAXNEST)
19366 EMSG(_("E698: variable nested too deep for making a copy"));
19367 return FAIL;
19369 ++recurse;
19371 switch (from->v_type)
19373 case VAR_NUMBER:
19374 #ifdef FEAT_FLOAT
19375 case VAR_FLOAT:
19376 #endif
19377 case VAR_STRING:
19378 case VAR_FUNC:
19379 copy_tv(from, to);
19380 break;
19381 case VAR_LIST:
19382 to->v_type = VAR_LIST;
19383 to->v_lock = 0;
19384 if (from->vval.v_list == NULL)
19385 to->vval.v_list = NULL;
19386 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19388 /* use the copy made earlier */
19389 to->vval.v_list = from->vval.v_list->lv_copylist;
19390 ++to->vval.v_list->lv_refcount;
19392 else
19393 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19394 if (to->vval.v_list == NULL)
19395 ret = FAIL;
19396 break;
19397 case VAR_DICT:
19398 to->v_type = VAR_DICT;
19399 to->v_lock = 0;
19400 if (from->vval.v_dict == NULL)
19401 to->vval.v_dict = NULL;
19402 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19404 /* use the copy made earlier */
19405 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19406 ++to->vval.v_dict->dv_refcount;
19408 else
19409 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19410 if (to->vval.v_dict == NULL)
19411 ret = FAIL;
19412 break;
19413 default:
19414 EMSG2(_(e_intern2), "item_copy()");
19415 ret = FAIL;
19417 --recurse;
19418 return ret;
19422 * ":echo expr1 ..." print each argument separated with a space, add a
19423 * newline at the end.
19424 * ":echon expr1 ..." print each argument plain.
19426 void
19427 ex_echo(eap)
19428 exarg_T *eap;
19430 char_u *arg = eap->arg;
19431 typval_T rettv;
19432 char_u *tofree;
19433 char_u *p;
19434 int needclr = TRUE;
19435 int atstart = TRUE;
19436 char_u numbuf[NUMBUFLEN];
19438 if (eap->skip)
19439 ++emsg_skip;
19440 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19442 /* If eval1() causes an error message the text from the command may
19443 * still need to be cleared. E.g., "echo 22,44". */
19444 need_clr_eos = needclr;
19446 p = arg;
19447 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19450 * Report the invalid expression unless the expression evaluation
19451 * has been cancelled due to an aborting error, an interrupt, or an
19452 * exception.
19454 if (!aborting())
19455 EMSG2(_(e_invexpr2), p);
19456 need_clr_eos = FALSE;
19457 break;
19459 need_clr_eos = FALSE;
19461 if (!eap->skip)
19463 if (atstart)
19465 atstart = FALSE;
19466 /* Call msg_start() after eval1(), evaluating the expression
19467 * may cause a message to appear. */
19468 if (eap->cmdidx == CMD_echo)
19469 msg_start();
19471 else if (eap->cmdidx == CMD_echo)
19472 msg_puts_attr((char_u *)" ", echo_attr);
19473 current_copyID += COPYID_INC;
19474 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19475 if (p != NULL)
19476 for ( ; *p != NUL && !got_int; ++p)
19478 if (*p == '\n' || *p == '\r' || *p == TAB)
19480 if (*p != TAB && needclr)
19482 /* remove any text still there from the command */
19483 msg_clr_eos();
19484 needclr = FALSE;
19486 msg_putchar_attr(*p, echo_attr);
19488 else
19490 #ifdef FEAT_MBYTE
19491 if (has_mbyte)
19493 int i = (*mb_ptr2len)(p);
19495 (void)msg_outtrans_len_attr(p, i, echo_attr);
19496 p += i - 1;
19498 else
19499 #endif
19500 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19503 vim_free(tofree);
19505 clear_tv(&rettv);
19506 arg = skipwhite(arg);
19508 eap->nextcmd = check_nextcmd(arg);
19510 if (eap->skip)
19511 --emsg_skip;
19512 else
19514 /* remove text that may still be there from the command */
19515 if (needclr)
19516 msg_clr_eos();
19517 if (eap->cmdidx == CMD_echo)
19518 msg_end();
19523 * ":echohl {name}".
19525 void
19526 ex_echohl(eap)
19527 exarg_T *eap;
19529 int id;
19531 id = syn_name2id(eap->arg);
19532 if (id == 0)
19533 echo_attr = 0;
19534 else
19535 echo_attr = syn_id2attr(id);
19539 * ":execute expr1 ..." execute the result of an expression.
19540 * ":echomsg expr1 ..." Print a message
19541 * ":echoerr expr1 ..." Print an error
19542 * Each gets spaces around each argument and a newline at the end for
19543 * echo commands
19545 void
19546 ex_execute(eap)
19547 exarg_T *eap;
19549 char_u *arg = eap->arg;
19550 typval_T rettv;
19551 int ret = OK;
19552 char_u *p;
19553 garray_T ga;
19554 int len;
19555 int save_did_emsg;
19557 ga_init2(&ga, 1, 80);
19559 if (eap->skip)
19560 ++emsg_skip;
19561 while (*arg != NUL && *arg != '|' && *arg != '\n')
19563 p = arg;
19564 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19567 * Report the invalid expression unless the expression evaluation
19568 * has been cancelled due to an aborting error, an interrupt, or an
19569 * exception.
19571 if (!aborting())
19572 EMSG2(_(e_invexpr2), p);
19573 ret = FAIL;
19574 break;
19577 if (!eap->skip)
19579 p = get_tv_string(&rettv);
19580 len = (int)STRLEN(p);
19581 if (ga_grow(&ga, len + 2) == FAIL)
19583 clear_tv(&rettv);
19584 ret = FAIL;
19585 break;
19587 if (ga.ga_len)
19588 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19589 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19590 ga.ga_len += len;
19593 clear_tv(&rettv);
19594 arg = skipwhite(arg);
19597 if (ret != FAIL && ga.ga_data != NULL)
19599 if (eap->cmdidx == CMD_echomsg)
19601 MSG_ATTR(ga.ga_data, echo_attr);
19602 out_flush();
19604 else if (eap->cmdidx == CMD_echoerr)
19606 /* We don't want to abort following commands, restore did_emsg. */
19607 save_did_emsg = did_emsg;
19608 EMSG((char_u *)ga.ga_data);
19609 if (!force_abort)
19610 did_emsg = save_did_emsg;
19612 else if (eap->cmdidx == CMD_execute)
19613 do_cmdline((char_u *)ga.ga_data,
19614 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19617 ga_clear(&ga);
19619 if (eap->skip)
19620 --emsg_skip;
19622 eap->nextcmd = check_nextcmd(arg);
19626 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19627 * "arg" points to the "&" or '+' when called, to "option" when returning.
19628 * Returns NULL when no option name found. Otherwise pointer to the char
19629 * after the option name.
19631 static char_u *
19632 find_option_end(arg, opt_flags)
19633 char_u **arg;
19634 int *opt_flags;
19636 char_u *p = *arg;
19638 ++p;
19639 if (*p == 'g' && p[1] == ':')
19641 *opt_flags = OPT_GLOBAL;
19642 p += 2;
19644 else if (*p == 'l' && p[1] == ':')
19646 *opt_flags = OPT_LOCAL;
19647 p += 2;
19649 else
19650 *opt_flags = 0;
19652 if (!ASCII_ISALPHA(*p))
19653 return NULL;
19654 *arg = p;
19656 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19657 p += 4; /* termcap option */
19658 else
19659 while (ASCII_ISALPHA(*p))
19660 ++p;
19661 return p;
19665 * ":function"
19667 void
19668 ex_function(eap)
19669 exarg_T *eap;
19671 char_u *theline;
19672 int j;
19673 int c;
19674 int saved_did_emsg;
19675 char_u *name = NULL;
19676 char_u *p;
19677 char_u *arg;
19678 char_u *line_arg = NULL;
19679 garray_T newargs;
19680 garray_T newlines;
19681 int varargs = FALSE;
19682 int mustend = FALSE;
19683 int flags = 0;
19684 ufunc_T *fp;
19685 int indent;
19686 int nesting;
19687 char_u *skip_until = NULL;
19688 dictitem_T *v;
19689 funcdict_T fudi;
19690 static int func_nr = 0; /* number for nameless function */
19691 int paren;
19692 hashtab_T *ht;
19693 int todo;
19694 hashitem_T *hi;
19695 int sourcing_lnum_off;
19698 * ":function" without argument: list functions.
19700 if (ends_excmd(*eap->arg))
19702 if (!eap->skip)
19704 todo = (int)func_hashtab.ht_used;
19705 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19707 if (!HASHITEM_EMPTY(hi))
19709 --todo;
19710 fp = HI2UF(hi);
19711 if (!isdigit(*fp->uf_name))
19712 list_func_head(fp, FALSE);
19716 eap->nextcmd = check_nextcmd(eap->arg);
19717 return;
19721 * ":function /pat": list functions matching pattern.
19723 if (*eap->arg == '/')
19725 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19726 if (!eap->skip)
19728 regmatch_T regmatch;
19730 c = *p;
19731 *p = NUL;
19732 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19733 *p = c;
19734 if (regmatch.regprog != NULL)
19736 regmatch.rm_ic = p_ic;
19738 todo = (int)func_hashtab.ht_used;
19739 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19741 if (!HASHITEM_EMPTY(hi))
19743 --todo;
19744 fp = HI2UF(hi);
19745 if (!isdigit(*fp->uf_name)
19746 && vim_regexec(&regmatch, fp->uf_name, 0))
19747 list_func_head(fp, FALSE);
19750 vim_free(regmatch.regprog);
19753 if (*p == '/')
19754 ++p;
19755 eap->nextcmd = check_nextcmd(p);
19756 return;
19760 * Get the function name. There are these situations:
19761 * func normal function name
19762 * "name" == func, "fudi.fd_dict" == NULL
19763 * dict.func new dictionary entry
19764 * "name" == NULL, "fudi.fd_dict" set,
19765 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19766 * dict.func existing dict entry with a Funcref
19767 * "name" == func, "fudi.fd_dict" set,
19768 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19769 * dict.func existing dict entry that's not a Funcref
19770 * "name" == NULL, "fudi.fd_dict" set,
19771 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19773 p = eap->arg;
19774 name = trans_function_name(&p, eap->skip, 0, &fudi);
19775 paren = (vim_strchr(p, '(') != NULL);
19776 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19779 * Return on an invalid expression in braces, unless the expression
19780 * evaluation has been cancelled due to an aborting error, an
19781 * interrupt, or an exception.
19783 if (!aborting())
19785 if (!eap->skip && fudi.fd_newkey != NULL)
19786 EMSG2(_(e_dictkey), fudi.fd_newkey);
19787 vim_free(fudi.fd_newkey);
19788 return;
19790 else
19791 eap->skip = TRUE;
19794 /* An error in a function call during evaluation of an expression in magic
19795 * braces should not cause the function not to be defined. */
19796 saved_did_emsg = did_emsg;
19797 did_emsg = FALSE;
19800 * ":function func" with only function name: list function.
19802 if (!paren)
19804 if (!ends_excmd(*skipwhite(p)))
19806 EMSG(_(e_trailing));
19807 goto ret_free;
19809 eap->nextcmd = check_nextcmd(p);
19810 if (eap->nextcmd != NULL)
19811 *p = NUL;
19812 if (!eap->skip && !got_int)
19814 fp = find_func(name);
19815 if (fp != NULL)
19817 list_func_head(fp, TRUE);
19818 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19820 if (FUNCLINE(fp, j) == NULL)
19821 continue;
19822 msg_putchar('\n');
19823 msg_outnum((long)(j + 1));
19824 if (j < 9)
19825 msg_putchar(' ');
19826 if (j < 99)
19827 msg_putchar(' ');
19828 msg_prt_line(FUNCLINE(fp, j), FALSE);
19829 out_flush(); /* show a line at a time */
19830 ui_breakcheck();
19832 if (!got_int)
19834 msg_putchar('\n');
19835 msg_puts((char_u *)" endfunction");
19838 else
19839 emsg_funcname(N_("E123: Undefined function: %s"), name);
19841 goto ret_free;
19845 * ":function name(arg1, arg2)" Define function.
19847 p = skipwhite(p);
19848 if (*p != '(')
19850 if (!eap->skip)
19852 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19853 goto ret_free;
19855 /* attempt to continue by skipping some text */
19856 if (vim_strchr(p, '(') != NULL)
19857 p = vim_strchr(p, '(');
19859 p = skipwhite(p + 1);
19861 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19862 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19864 if (!eap->skip)
19866 /* Check the name of the function. Unless it's a dictionary function
19867 * (that we are overwriting). */
19868 if (name != NULL)
19869 arg = name;
19870 else
19871 arg = fudi.fd_newkey;
19872 if (arg != NULL && (fudi.fd_di == NULL
19873 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19875 if (*arg == K_SPECIAL)
19876 j = 3;
19877 else
19878 j = 0;
19879 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19880 : eval_isnamec(arg[j])))
19881 ++j;
19882 if (arg[j] != NUL)
19883 emsg_funcname((char *)e_invarg2, arg);
19888 * Isolate the arguments: "arg1, arg2, ...)"
19890 while (*p != ')')
19892 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19894 varargs = TRUE;
19895 p += 3;
19896 mustend = TRUE;
19898 else
19900 arg = p;
19901 while (ASCII_ISALNUM(*p) || *p == '_')
19902 ++p;
19903 if (arg == p || isdigit(*arg)
19904 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19905 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19907 if (!eap->skip)
19908 EMSG2(_("E125: Illegal argument: %s"), arg);
19909 break;
19911 if (ga_grow(&newargs, 1) == FAIL)
19912 goto erret;
19913 c = *p;
19914 *p = NUL;
19915 arg = vim_strsave(arg);
19916 if (arg == NULL)
19917 goto erret;
19918 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19919 *p = c;
19920 newargs.ga_len++;
19921 if (*p == ',')
19922 ++p;
19923 else
19924 mustend = TRUE;
19926 p = skipwhite(p);
19927 if (mustend && *p != ')')
19929 if (!eap->skip)
19930 EMSG2(_(e_invarg2), eap->arg);
19931 break;
19934 ++p; /* skip the ')' */
19936 /* find extra arguments "range", "dict" and "abort" */
19937 for (;;)
19939 p = skipwhite(p);
19940 if (STRNCMP(p, "range", 5) == 0)
19942 flags |= FC_RANGE;
19943 p += 5;
19945 else if (STRNCMP(p, "dict", 4) == 0)
19947 flags |= FC_DICT;
19948 p += 4;
19950 else if (STRNCMP(p, "abort", 5) == 0)
19952 flags |= FC_ABORT;
19953 p += 5;
19955 else
19956 break;
19959 /* When there is a line break use what follows for the function body.
19960 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19961 if (*p == '\n')
19962 line_arg = p + 1;
19963 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19964 EMSG(_(e_trailing));
19967 * Read the body of the function, until ":endfunction" is found.
19969 if (KeyTyped)
19971 /* Check if the function already exists, don't let the user type the
19972 * whole function before telling him it doesn't work! For a script we
19973 * need to skip the body to be able to find what follows. */
19974 if (!eap->skip && !eap->forceit)
19976 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19977 EMSG(_(e_funcdict));
19978 else if (name != NULL && find_func(name) != NULL)
19979 emsg_funcname(e_funcexts, name);
19982 if (!eap->skip && did_emsg)
19983 goto erret;
19985 msg_putchar('\n'); /* don't overwrite the function name */
19986 cmdline_row = msg_row;
19989 indent = 2;
19990 nesting = 0;
19991 for (;;)
19993 msg_scroll = TRUE;
19994 need_wait_return = FALSE;
19995 sourcing_lnum_off = sourcing_lnum;
19997 if (line_arg != NULL)
19999 /* Use eap->arg, split up in parts by line breaks. */
20000 theline = line_arg;
20001 p = vim_strchr(theline, '\n');
20002 if (p == NULL)
20003 line_arg += STRLEN(line_arg);
20004 else
20006 *p = NUL;
20007 line_arg = p + 1;
20010 else if (eap->getline == NULL)
20011 theline = getcmdline(':', 0L, indent);
20012 else
20013 theline = eap->getline(':', eap->cookie, indent);
20014 if (KeyTyped)
20015 lines_left = Rows - 1;
20016 if (theline == NULL)
20018 EMSG(_("E126: Missing :endfunction"));
20019 goto erret;
20022 /* Detect line continuation: sourcing_lnum increased more than one. */
20023 if (sourcing_lnum > sourcing_lnum_off + 1)
20024 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20025 else
20026 sourcing_lnum_off = 0;
20028 if (skip_until != NULL)
20030 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20031 * don't check for ":endfunc". */
20032 if (STRCMP(theline, skip_until) == 0)
20034 vim_free(skip_until);
20035 skip_until = NULL;
20038 else
20040 /* skip ':' and blanks*/
20041 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20044 /* Check for "endfunction". */
20045 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20047 if (line_arg == NULL)
20048 vim_free(theline);
20049 break;
20052 /* Increase indent inside "if", "while", "for" and "try", decrease
20053 * at "end". */
20054 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20055 indent -= 2;
20056 else if (STRNCMP(p, "if", 2) == 0
20057 || STRNCMP(p, "wh", 2) == 0
20058 || STRNCMP(p, "for", 3) == 0
20059 || STRNCMP(p, "try", 3) == 0)
20060 indent += 2;
20062 /* Check for defining a function inside this function. */
20063 if (checkforcmd(&p, "function", 2))
20065 if (*p == '!')
20066 p = skipwhite(p + 1);
20067 p += eval_fname_script(p);
20068 if (ASCII_ISALPHA(*p))
20070 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20071 if (*skipwhite(p) == '(')
20073 ++nesting;
20074 indent += 2;
20079 /* Check for ":append" or ":insert". */
20080 p = skip_range(p, NULL);
20081 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20082 || (p[0] == 'i'
20083 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20084 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20085 skip_until = vim_strsave((char_u *)".");
20087 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20088 arg = skipwhite(skiptowhite(p));
20089 if (arg[0] == '<' && arg[1] =='<'
20090 && ((p[0] == 'p' && p[1] == 'y'
20091 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20092 || (p[0] == 'p' && p[1] == 'e'
20093 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20094 || (p[0] == 't' && p[1] == 'c'
20095 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20096 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20097 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20098 || (p[0] == 'm' && p[1] == 'z'
20099 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20102 /* ":python <<" continues until a dot, like ":append" */
20103 p = skipwhite(arg + 2);
20104 if (*p == NUL)
20105 skip_until = vim_strsave((char_u *)".");
20106 else
20107 skip_until = vim_strsave(p);
20111 /* Add the line to the function. */
20112 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20114 if (line_arg == NULL)
20115 vim_free(theline);
20116 goto erret;
20119 /* Copy the line to newly allocated memory. get_one_sourceline()
20120 * allocates 250 bytes per line, this saves 80% on average. The cost
20121 * is an extra alloc/free. */
20122 p = vim_strsave(theline);
20123 if (p != NULL)
20125 if (line_arg == NULL)
20126 vim_free(theline);
20127 theline = p;
20130 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20132 /* Add NULL lines for continuation lines, so that the line count is
20133 * equal to the index in the growarray. */
20134 while (sourcing_lnum_off-- > 0)
20135 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20137 /* Check for end of eap->arg. */
20138 if (line_arg != NULL && *line_arg == NUL)
20139 line_arg = NULL;
20142 /* Don't define the function when skipping commands or when an error was
20143 * detected. */
20144 if (eap->skip || did_emsg)
20145 goto erret;
20148 * If there are no errors, add the function
20150 if (fudi.fd_dict == NULL)
20152 v = find_var(name, &ht);
20153 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20155 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20156 name);
20157 goto erret;
20160 fp = find_func(name);
20161 if (fp != NULL)
20163 if (!eap->forceit)
20165 emsg_funcname(e_funcexts, name);
20166 goto erret;
20168 if (fp->uf_calls > 0)
20170 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20171 name);
20172 goto erret;
20174 /* redefine existing function */
20175 ga_clear_strings(&(fp->uf_args));
20176 ga_clear_strings(&(fp->uf_lines));
20177 vim_free(name);
20178 name = NULL;
20181 else
20183 char numbuf[20];
20185 fp = NULL;
20186 if (fudi.fd_newkey == NULL && !eap->forceit)
20188 EMSG(_(e_funcdict));
20189 goto erret;
20191 if (fudi.fd_di == NULL)
20193 /* Can't add a function to a locked dictionary */
20194 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20195 goto erret;
20197 /* Can't change an existing function if it is locked */
20198 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20199 goto erret;
20201 /* Give the function a sequential number. Can only be used with a
20202 * Funcref! */
20203 vim_free(name);
20204 sprintf(numbuf, "%d", ++func_nr);
20205 name = vim_strsave((char_u *)numbuf);
20206 if (name == NULL)
20207 goto erret;
20210 if (fp == NULL)
20212 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20214 int slen, plen;
20215 char_u *scriptname;
20217 /* Check that the autoload name matches the script name. */
20218 j = FAIL;
20219 if (sourcing_name != NULL)
20221 scriptname = autoload_name(name);
20222 if (scriptname != NULL)
20224 p = vim_strchr(scriptname, '/');
20225 plen = (int)STRLEN(p);
20226 slen = (int)STRLEN(sourcing_name);
20227 if (slen > plen && fnamecmp(p,
20228 sourcing_name + slen - plen) == 0)
20229 j = OK;
20230 vim_free(scriptname);
20233 if (j == FAIL)
20235 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20236 goto erret;
20240 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20241 if (fp == NULL)
20242 goto erret;
20244 if (fudi.fd_dict != NULL)
20246 if (fudi.fd_di == NULL)
20248 /* add new dict entry */
20249 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20250 if (fudi.fd_di == NULL)
20252 vim_free(fp);
20253 goto erret;
20255 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20257 vim_free(fudi.fd_di);
20258 vim_free(fp);
20259 goto erret;
20262 else
20263 /* overwrite existing dict entry */
20264 clear_tv(&fudi.fd_di->di_tv);
20265 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20266 fudi.fd_di->di_tv.v_lock = 0;
20267 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20268 fp->uf_refcount = 1;
20270 /* behave like "dict" was used */
20271 flags |= FC_DICT;
20274 /* insert the new function in the function list */
20275 STRCPY(fp->uf_name, name);
20276 hash_add(&func_hashtab, UF2HIKEY(fp));
20278 fp->uf_args = newargs;
20279 fp->uf_lines = newlines;
20280 #ifdef FEAT_PROFILE
20281 fp->uf_tml_count = NULL;
20282 fp->uf_tml_total = NULL;
20283 fp->uf_tml_self = NULL;
20284 fp->uf_profiling = FALSE;
20285 if (prof_def_func())
20286 func_do_profile(fp);
20287 #endif
20288 fp->uf_varargs = varargs;
20289 fp->uf_flags = flags;
20290 fp->uf_calls = 0;
20291 fp->uf_script_ID = current_SID;
20292 goto ret_free;
20294 erret:
20295 ga_clear_strings(&newargs);
20296 ga_clear_strings(&newlines);
20297 ret_free:
20298 vim_free(skip_until);
20299 vim_free(fudi.fd_newkey);
20300 vim_free(name);
20301 did_emsg |= saved_did_emsg;
20305 * Get a function name, translating "<SID>" and "<SNR>".
20306 * Also handles a Funcref in a List or Dictionary.
20307 * Returns the function name in allocated memory, or NULL for failure.
20308 * flags:
20309 * TFN_INT: internal function name OK
20310 * TFN_QUIET: be quiet
20311 * Advances "pp" to just after the function name (if no error).
20313 static char_u *
20314 trans_function_name(pp, skip, flags, fdp)
20315 char_u **pp;
20316 int skip; /* only find the end, don't evaluate */
20317 int flags;
20318 funcdict_T *fdp; /* return: info about dictionary used */
20320 char_u *name = NULL;
20321 char_u *start;
20322 char_u *end;
20323 int lead;
20324 char_u sid_buf[20];
20325 int len;
20326 lval_T lv;
20328 if (fdp != NULL)
20329 vim_memset(fdp, 0, sizeof(funcdict_T));
20330 start = *pp;
20332 /* Check for hard coded <SNR>: already translated function ID (from a user
20333 * command). */
20334 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20335 && (*pp)[2] == (int)KE_SNR)
20337 *pp += 3;
20338 len = get_id_len(pp) + 3;
20339 return vim_strnsave(start, len);
20342 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20343 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20344 lead = eval_fname_script(start);
20345 if (lead > 2)
20346 start += lead;
20348 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20349 lead > 2 ? 0 : FNE_CHECK_START);
20350 if (end == start)
20352 if (!skip)
20353 EMSG(_("E129: Function name required"));
20354 goto theend;
20356 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20359 * Report an invalid expression in braces, unless the expression
20360 * evaluation has been cancelled due to an aborting error, an
20361 * interrupt, or an exception.
20363 if (!aborting())
20365 if (end != NULL)
20366 EMSG2(_(e_invarg2), start);
20368 else
20369 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20370 goto theend;
20373 if (lv.ll_tv != NULL)
20375 if (fdp != NULL)
20377 fdp->fd_dict = lv.ll_dict;
20378 fdp->fd_newkey = lv.ll_newkey;
20379 lv.ll_newkey = NULL;
20380 fdp->fd_di = lv.ll_di;
20382 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20384 name = vim_strsave(lv.ll_tv->vval.v_string);
20385 *pp = end;
20387 else
20389 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20390 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20391 EMSG(_(e_funcref));
20392 else
20393 *pp = end;
20394 name = NULL;
20396 goto theend;
20399 if (lv.ll_name == NULL)
20401 /* Error found, but continue after the function name. */
20402 *pp = end;
20403 goto theend;
20406 /* Check if the name is a Funcref. If so, use the value. */
20407 if (lv.ll_exp_name != NULL)
20409 len = (int)STRLEN(lv.ll_exp_name);
20410 name = deref_func_name(lv.ll_exp_name, &len);
20411 if (name == lv.ll_exp_name)
20412 name = NULL;
20414 else
20416 len = (int)(end - *pp);
20417 name = deref_func_name(*pp, &len);
20418 if (name == *pp)
20419 name = NULL;
20421 if (name != NULL)
20423 name = vim_strsave(name);
20424 *pp = end;
20425 goto theend;
20428 if (lv.ll_exp_name != NULL)
20430 len = (int)STRLEN(lv.ll_exp_name);
20431 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20432 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20434 /* When there was "s:" already or the name expanded to get a
20435 * leading "s:" then remove it. */
20436 lv.ll_name += 2;
20437 len -= 2;
20438 lead = 2;
20441 else
20443 if (lead == 2) /* skip over "s:" */
20444 lv.ll_name += 2;
20445 len = (int)(end - lv.ll_name);
20449 * Copy the function name to allocated memory.
20450 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20451 * Accept <SNR>123_name() outside a script.
20453 if (skip)
20454 lead = 0; /* do nothing */
20455 else if (lead > 0)
20457 lead = 3;
20458 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20459 || eval_fname_sid(*pp))
20461 /* It's "s:" or "<SID>" */
20462 if (current_SID <= 0)
20464 EMSG(_(e_usingsid));
20465 goto theend;
20467 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20468 lead += (int)STRLEN(sid_buf);
20471 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20473 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20474 goto theend;
20476 name = alloc((unsigned)(len + lead + 1));
20477 if (name != NULL)
20479 if (lead > 0)
20481 name[0] = K_SPECIAL;
20482 name[1] = KS_EXTRA;
20483 name[2] = (int)KE_SNR;
20484 if (lead > 3) /* If it's "<SID>" */
20485 STRCPY(name + 3, sid_buf);
20487 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20488 name[len + lead] = NUL;
20490 *pp = end;
20492 theend:
20493 clear_lval(&lv);
20494 return name;
20498 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20499 * Return 2 if "p" starts with "s:".
20500 * Return 0 otherwise.
20502 static int
20503 eval_fname_script(p)
20504 char_u *p;
20506 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20507 || STRNICMP(p + 1, "SNR>", 4) == 0))
20508 return 5;
20509 if (p[0] == 's' && p[1] == ':')
20510 return 2;
20511 return 0;
20515 * Return TRUE if "p" starts with "<SID>" or "s:".
20516 * Only works if eval_fname_script() returned non-zero for "p"!
20518 static int
20519 eval_fname_sid(p)
20520 char_u *p;
20522 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20526 * List the head of the function: "name(arg1, arg2)".
20528 static void
20529 list_func_head(fp, indent)
20530 ufunc_T *fp;
20531 int indent;
20533 int j;
20535 msg_start();
20536 if (indent)
20537 MSG_PUTS(" ");
20538 MSG_PUTS("function ");
20539 if (fp->uf_name[0] == K_SPECIAL)
20541 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20542 msg_puts(fp->uf_name + 3);
20544 else
20545 msg_puts(fp->uf_name);
20546 msg_putchar('(');
20547 for (j = 0; j < fp->uf_args.ga_len; ++j)
20549 if (j)
20550 MSG_PUTS(", ");
20551 msg_puts(FUNCARG(fp, j));
20553 if (fp->uf_varargs)
20555 if (j)
20556 MSG_PUTS(", ");
20557 MSG_PUTS("...");
20559 msg_putchar(')');
20560 msg_clr_eos();
20561 if (p_verbose > 0)
20562 last_set_msg(fp->uf_script_ID);
20566 * Find a function by name, return pointer to it in ufuncs.
20567 * Return NULL for unknown function.
20569 static ufunc_T *
20570 find_func(name)
20571 char_u *name;
20573 hashitem_T *hi;
20575 hi = hash_find(&func_hashtab, name);
20576 if (!HASHITEM_EMPTY(hi))
20577 return HI2UF(hi);
20578 return NULL;
20581 #if defined(EXITFREE) || defined(PROTO)
20582 void
20583 free_all_functions()
20585 hashitem_T *hi;
20587 /* Need to start all over every time, because func_free() may change the
20588 * hash table. */
20589 while (func_hashtab.ht_used > 0)
20590 for (hi = func_hashtab.ht_array; ; ++hi)
20591 if (!HASHITEM_EMPTY(hi))
20593 func_free(HI2UF(hi));
20594 break;
20597 #endif
20600 * Return TRUE if a function "name" exists.
20602 static int
20603 function_exists(name)
20604 char_u *name;
20606 char_u *nm = name;
20607 char_u *p;
20608 int n = FALSE;
20610 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20611 nm = skipwhite(nm);
20613 /* Only accept "funcname", "funcname ", "funcname (..." and
20614 * "funcname(...", not "funcname!...". */
20615 if (p != NULL && (*nm == NUL || *nm == '('))
20617 if (builtin_function(p))
20618 n = (find_internal_func(p) >= 0);
20619 else
20620 n = (find_func(p) != NULL);
20622 vim_free(p);
20623 return n;
20627 * Return TRUE if "name" looks like a builtin function name: starts with a
20628 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20630 static int
20631 builtin_function(name)
20632 char_u *name;
20634 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20635 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20638 #if defined(FEAT_PROFILE) || defined(PROTO)
20640 * Start profiling function "fp".
20642 static void
20643 func_do_profile(fp)
20644 ufunc_T *fp;
20646 fp->uf_tm_count = 0;
20647 profile_zero(&fp->uf_tm_self);
20648 profile_zero(&fp->uf_tm_total);
20649 if (fp->uf_tml_count == NULL)
20650 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20651 (sizeof(int) * fp->uf_lines.ga_len));
20652 if (fp->uf_tml_total == NULL)
20653 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20654 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20655 if (fp->uf_tml_self == NULL)
20656 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20657 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20658 fp->uf_tml_idx = -1;
20659 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20660 || fp->uf_tml_self == NULL)
20661 return; /* out of memory */
20663 fp->uf_profiling = TRUE;
20667 * Dump the profiling results for all functions in file "fd".
20669 void
20670 func_dump_profile(fd)
20671 FILE *fd;
20673 hashitem_T *hi;
20674 int todo;
20675 ufunc_T *fp;
20676 int i;
20677 ufunc_T **sorttab;
20678 int st_len = 0;
20680 todo = (int)func_hashtab.ht_used;
20681 if (todo == 0)
20682 return; /* nothing to dump */
20684 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20686 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20688 if (!HASHITEM_EMPTY(hi))
20690 --todo;
20691 fp = HI2UF(hi);
20692 if (fp->uf_profiling)
20694 if (sorttab != NULL)
20695 sorttab[st_len++] = fp;
20697 if (fp->uf_name[0] == K_SPECIAL)
20698 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20699 else
20700 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20701 if (fp->uf_tm_count == 1)
20702 fprintf(fd, "Called 1 time\n");
20703 else
20704 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20705 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20706 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20707 fprintf(fd, "\n");
20708 fprintf(fd, "count total (s) self (s)\n");
20710 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20712 if (FUNCLINE(fp, i) == NULL)
20713 continue;
20714 prof_func_line(fd, fp->uf_tml_count[i],
20715 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20716 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20718 fprintf(fd, "\n");
20723 if (sorttab != NULL && st_len > 0)
20725 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20726 prof_total_cmp);
20727 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20728 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20729 prof_self_cmp);
20730 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20733 vim_free(sorttab);
20736 static void
20737 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20738 FILE *fd;
20739 ufunc_T **sorttab;
20740 int st_len;
20741 char *title;
20742 int prefer_self; /* when equal print only self time */
20744 int i;
20745 ufunc_T *fp;
20747 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20748 fprintf(fd, "count total (s) self (s) function\n");
20749 for (i = 0; i < 20 && i < st_len; ++i)
20751 fp = sorttab[i];
20752 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20753 prefer_self);
20754 if (fp->uf_name[0] == K_SPECIAL)
20755 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20756 else
20757 fprintf(fd, " %s()\n", fp->uf_name);
20759 fprintf(fd, "\n");
20763 * Print the count and times for one function or function line.
20765 static void
20766 prof_func_line(fd, count, total, self, prefer_self)
20767 FILE *fd;
20768 int count;
20769 proftime_T *total;
20770 proftime_T *self;
20771 int prefer_self; /* when equal print only self time */
20773 if (count > 0)
20775 fprintf(fd, "%5d ", count);
20776 if (prefer_self && profile_equal(total, self))
20777 fprintf(fd, " ");
20778 else
20779 fprintf(fd, "%s ", profile_msg(total));
20780 if (!prefer_self && profile_equal(total, self))
20781 fprintf(fd, " ");
20782 else
20783 fprintf(fd, "%s ", profile_msg(self));
20785 else
20786 fprintf(fd, " ");
20790 * Compare function for total time sorting.
20792 static int
20793 #ifdef __BORLANDC__
20794 _RTLENTRYF
20795 #endif
20796 prof_total_cmp(s1, s2)
20797 const void *s1;
20798 const void *s2;
20800 ufunc_T *p1, *p2;
20802 p1 = *(ufunc_T **)s1;
20803 p2 = *(ufunc_T **)s2;
20804 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20808 * Compare function for self time sorting.
20810 static int
20811 #ifdef __BORLANDC__
20812 _RTLENTRYF
20813 #endif
20814 prof_self_cmp(s1, s2)
20815 const void *s1;
20816 const void *s2;
20818 ufunc_T *p1, *p2;
20820 p1 = *(ufunc_T **)s1;
20821 p2 = *(ufunc_T **)s2;
20822 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20825 #endif
20828 * If "name" has a package name try autoloading the script for it.
20829 * Return TRUE if a package was loaded.
20831 static int
20832 script_autoload(name, reload)
20833 char_u *name;
20834 int reload; /* load script again when already loaded */
20836 char_u *p;
20837 char_u *scriptname, *tofree;
20838 int ret = FALSE;
20839 int i;
20841 /* If there is no '#' after name[0] there is no package name. */
20842 p = vim_strchr(name, AUTOLOAD_CHAR);
20843 if (p == NULL || p == name)
20844 return FALSE;
20846 tofree = scriptname = autoload_name(name);
20848 /* Find the name in the list of previously loaded package names. Skip
20849 * "autoload/", it's always the same. */
20850 for (i = 0; i < ga_loaded.ga_len; ++i)
20851 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20852 break;
20853 if (!reload && i < ga_loaded.ga_len)
20854 ret = FALSE; /* was loaded already */
20855 else
20857 /* Remember the name if it wasn't loaded already. */
20858 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20860 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20861 tofree = NULL;
20864 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20865 if (source_runtime(scriptname, FALSE) == OK)
20866 ret = TRUE;
20869 vim_free(tofree);
20870 return ret;
20874 * Return the autoload script name for a function or variable name.
20875 * Returns NULL when out of memory.
20877 static char_u *
20878 autoload_name(name)
20879 char_u *name;
20881 char_u *p;
20882 char_u *scriptname;
20884 /* Get the script file name: replace '#' with '/', append ".vim". */
20885 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20886 if (scriptname == NULL)
20887 return FALSE;
20888 STRCPY(scriptname, "autoload/");
20889 STRCAT(scriptname, name);
20890 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20891 STRCAT(scriptname, ".vim");
20892 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20893 *p = '/';
20894 return scriptname;
20897 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20900 * Function given to ExpandGeneric() to obtain the list of user defined
20901 * function names.
20903 char_u *
20904 get_user_func_name(xp, idx)
20905 expand_T *xp;
20906 int idx;
20908 static long_u done;
20909 static hashitem_T *hi;
20910 ufunc_T *fp;
20912 if (idx == 0)
20914 done = 0;
20915 hi = func_hashtab.ht_array;
20917 if (done < func_hashtab.ht_used)
20919 if (done++ > 0)
20920 ++hi;
20921 while (HASHITEM_EMPTY(hi))
20922 ++hi;
20923 fp = HI2UF(hi);
20925 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20926 return fp->uf_name; /* prevents overflow */
20928 cat_func_name(IObuff, fp);
20929 if (xp->xp_context != EXPAND_USER_FUNC)
20931 STRCAT(IObuff, "(");
20932 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20933 STRCAT(IObuff, ")");
20935 return IObuff;
20937 return NULL;
20940 #endif /* FEAT_CMDL_COMPL */
20943 * Copy the function name of "fp" to buffer "buf".
20944 * "buf" must be able to hold the function name plus three bytes.
20945 * Takes care of script-local function names.
20947 static void
20948 cat_func_name(buf, fp)
20949 char_u *buf;
20950 ufunc_T *fp;
20952 if (fp->uf_name[0] == K_SPECIAL)
20954 STRCPY(buf, "<SNR>");
20955 STRCAT(buf, fp->uf_name + 3);
20957 else
20958 STRCPY(buf, fp->uf_name);
20962 * ":delfunction {name}"
20964 void
20965 ex_delfunction(eap)
20966 exarg_T *eap;
20968 ufunc_T *fp = NULL;
20969 char_u *p;
20970 char_u *name;
20971 funcdict_T fudi;
20973 p = eap->arg;
20974 name = trans_function_name(&p, eap->skip, 0, &fudi);
20975 vim_free(fudi.fd_newkey);
20976 if (name == NULL)
20978 if (fudi.fd_dict != NULL && !eap->skip)
20979 EMSG(_(e_funcref));
20980 return;
20982 if (!ends_excmd(*skipwhite(p)))
20984 vim_free(name);
20985 EMSG(_(e_trailing));
20986 return;
20988 eap->nextcmd = check_nextcmd(p);
20989 if (eap->nextcmd != NULL)
20990 *p = NUL;
20992 if (!eap->skip)
20993 fp = find_func(name);
20994 vim_free(name);
20996 if (!eap->skip)
20998 if (fp == NULL)
21000 EMSG2(_(e_nofunc), eap->arg);
21001 return;
21003 if (fp->uf_calls > 0)
21005 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21006 return;
21009 if (fudi.fd_dict != NULL)
21011 /* Delete the dict item that refers to the function, it will
21012 * invoke func_unref() and possibly delete the function. */
21013 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21015 else
21016 func_free(fp);
21021 * Free a function and remove it from the list of functions.
21023 static void
21024 func_free(fp)
21025 ufunc_T *fp;
21027 hashitem_T *hi;
21029 /* clear this function */
21030 ga_clear_strings(&(fp->uf_args));
21031 ga_clear_strings(&(fp->uf_lines));
21032 #ifdef FEAT_PROFILE
21033 vim_free(fp->uf_tml_count);
21034 vim_free(fp->uf_tml_total);
21035 vim_free(fp->uf_tml_self);
21036 #endif
21038 /* remove the function from the function hashtable */
21039 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21040 if (HASHITEM_EMPTY(hi))
21041 EMSG2(_(e_intern2), "func_free()");
21042 else
21043 hash_remove(&func_hashtab, hi);
21045 vim_free(fp);
21049 * Unreference a Function: decrement the reference count and free it when it
21050 * becomes zero. Only for numbered functions.
21052 static void
21053 func_unref(name)
21054 char_u *name;
21056 ufunc_T *fp;
21058 if (name != NULL && isdigit(*name))
21060 fp = find_func(name);
21061 if (fp == NULL)
21062 EMSG2(_(e_intern2), "func_unref()");
21063 else if (--fp->uf_refcount <= 0)
21065 /* Only delete it when it's not being used. Otherwise it's done
21066 * when "uf_calls" becomes zero. */
21067 if (fp->uf_calls == 0)
21068 func_free(fp);
21074 * Count a reference to a Function.
21076 static void
21077 func_ref(name)
21078 char_u *name;
21080 ufunc_T *fp;
21082 if (name != NULL && isdigit(*name))
21084 fp = find_func(name);
21085 if (fp == NULL)
21086 EMSG2(_(e_intern2), "func_ref()");
21087 else
21088 ++fp->uf_refcount;
21093 * Call a user function.
21095 static void
21096 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21097 ufunc_T *fp; /* pointer to function */
21098 int argcount; /* nr of args */
21099 typval_T *argvars; /* arguments */
21100 typval_T *rettv; /* return value */
21101 linenr_T firstline; /* first line of range */
21102 linenr_T lastline; /* last line of range */
21103 dict_T *selfdict; /* Dictionary for "self" */
21105 char_u *save_sourcing_name;
21106 linenr_T save_sourcing_lnum;
21107 scid_T save_current_SID;
21108 funccall_T *fc;
21109 int save_did_emsg;
21110 static int depth = 0;
21111 dictitem_T *v;
21112 int fixvar_idx = 0; /* index in fixvar[] */
21113 int i;
21114 int ai;
21115 char_u numbuf[NUMBUFLEN];
21116 char_u *name;
21117 #ifdef FEAT_PROFILE
21118 proftime_T wait_start;
21119 proftime_T call_start;
21120 #endif
21122 /* If depth of calling is getting too high, don't execute the function */
21123 if (depth >= p_mfd)
21125 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21126 rettv->v_type = VAR_NUMBER;
21127 rettv->vval.v_number = -1;
21128 return;
21130 ++depth;
21132 line_breakcheck(); /* check for CTRL-C hit */
21134 fc = (funccall_T *)alloc(sizeof(funccall_T));
21135 fc->caller = current_funccal;
21136 current_funccal = fc;
21137 fc->func = fp;
21138 fc->rettv = rettv;
21139 rettv->vval.v_number = 0;
21140 fc->linenr = 0;
21141 fc->returned = FALSE;
21142 fc->level = ex_nesting_level;
21143 /* Check if this function has a breakpoint. */
21144 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21145 fc->dbg_tick = debug_tick;
21148 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21149 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21150 * each argument variable and saves a lot of time.
21153 * Init l: variables.
21155 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21156 if (selfdict != NULL)
21158 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21159 * some compiler that checks the destination size. */
21160 v = &fc->fixvar[fixvar_idx++].var;
21161 name = v->di_key;
21162 STRCPY(name, "self");
21163 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21164 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21165 v->di_tv.v_type = VAR_DICT;
21166 v->di_tv.v_lock = 0;
21167 v->di_tv.vval.v_dict = selfdict;
21168 ++selfdict->dv_refcount;
21172 * Init a: variables.
21173 * Set a:0 to "argcount".
21174 * Set a:000 to a list with room for the "..." arguments.
21176 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21177 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21178 (varnumber_T)(argcount - fp->uf_args.ga_len));
21179 /* Use "name" to avoid a warning from some compiler that checks the
21180 * destination size. */
21181 v = &fc->fixvar[fixvar_idx++].var;
21182 name = v->di_key;
21183 STRCPY(name, "000");
21184 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21185 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21186 v->di_tv.v_type = VAR_LIST;
21187 v->di_tv.v_lock = VAR_FIXED;
21188 v->di_tv.vval.v_list = &fc->l_varlist;
21189 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21190 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21191 fc->l_varlist.lv_lock = VAR_FIXED;
21194 * Set a:firstline to "firstline" and a:lastline to "lastline".
21195 * Set a:name to named arguments.
21196 * Set a:N to the "..." arguments.
21198 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21199 (varnumber_T)firstline);
21200 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21201 (varnumber_T)lastline);
21202 for (i = 0; i < argcount; ++i)
21204 ai = i - fp->uf_args.ga_len;
21205 if (ai < 0)
21206 /* named argument a:name */
21207 name = FUNCARG(fp, i);
21208 else
21210 /* "..." argument a:1, a:2, etc. */
21211 sprintf((char *)numbuf, "%d", ai + 1);
21212 name = numbuf;
21214 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21216 v = &fc->fixvar[fixvar_idx++].var;
21217 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21219 else
21221 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21222 + STRLEN(name)));
21223 if (v == NULL)
21224 break;
21225 v->di_flags = DI_FLAGS_RO;
21227 STRCPY(v->di_key, name);
21228 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21230 /* Note: the values are copied directly to avoid alloc/free.
21231 * "argvars" must have VAR_FIXED for v_lock. */
21232 v->di_tv = argvars[i];
21233 v->di_tv.v_lock = VAR_FIXED;
21235 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21237 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21238 fc->l_listitems[ai].li_tv = argvars[i];
21239 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21243 /* Don't redraw while executing the function. */
21244 ++RedrawingDisabled;
21245 save_sourcing_name = sourcing_name;
21246 save_sourcing_lnum = sourcing_lnum;
21247 sourcing_lnum = 1;
21248 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21249 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21250 if (sourcing_name != NULL)
21252 if (save_sourcing_name != NULL
21253 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21254 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21255 else
21256 STRCPY(sourcing_name, "function ");
21257 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21259 if (p_verbose >= 12)
21261 ++no_wait_return;
21262 verbose_enter_scroll();
21264 smsg((char_u *)_("calling %s"), sourcing_name);
21265 if (p_verbose >= 14)
21267 char_u buf[MSG_BUF_LEN];
21268 char_u numbuf2[NUMBUFLEN];
21269 char_u *tofree;
21270 char_u *s;
21272 msg_puts((char_u *)"(");
21273 for (i = 0; i < argcount; ++i)
21275 if (i > 0)
21276 msg_puts((char_u *)", ");
21277 if (argvars[i].v_type == VAR_NUMBER)
21278 msg_outnum((long)argvars[i].vval.v_number);
21279 else
21281 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21282 if (s != NULL)
21284 trunc_string(s, buf, MSG_BUF_CLEN);
21285 msg_puts(buf);
21286 vim_free(tofree);
21290 msg_puts((char_u *)")");
21292 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21294 verbose_leave_scroll();
21295 --no_wait_return;
21298 #ifdef FEAT_PROFILE
21299 if (do_profiling == PROF_YES)
21301 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21302 func_do_profile(fp);
21303 if (fp->uf_profiling
21304 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21306 ++fp->uf_tm_count;
21307 profile_start(&call_start);
21308 profile_zero(&fp->uf_tm_children);
21310 script_prof_save(&wait_start);
21312 #endif
21314 save_current_SID = current_SID;
21315 current_SID = fp->uf_script_ID;
21316 save_did_emsg = did_emsg;
21317 did_emsg = FALSE;
21319 /* call do_cmdline() to execute the lines */
21320 do_cmdline(NULL, get_func_line, (void *)fc,
21321 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21323 --RedrawingDisabled;
21325 /* when the function was aborted because of an error, return -1 */
21326 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21328 clear_tv(rettv);
21329 rettv->v_type = VAR_NUMBER;
21330 rettv->vval.v_number = -1;
21333 #ifdef FEAT_PROFILE
21334 if (do_profiling == PROF_YES && (fp->uf_profiling
21335 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21337 profile_end(&call_start);
21338 profile_sub_wait(&wait_start, &call_start);
21339 profile_add(&fp->uf_tm_total, &call_start);
21340 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21341 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21343 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21344 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21347 #endif
21349 /* when being verbose, mention the return value */
21350 if (p_verbose >= 12)
21352 ++no_wait_return;
21353 verbose_enter_scroll();
21355 if (aborting())
21356 smsg((char_u *)_("%s aborted"), sourcing_name);
21357 else if (fc->rettv->v_type == VAR_NUMBER)
21358 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21359 (long)fc->rettv->vval.v_number);
21360 else
21362 char_u buf[MSG_BUF_LEN];
21363 char_u numbuf2[NUMBUFLEN];
21364 char_u *tofree;
21365 char_u *s;
21367 /* The value may be very long. Skip the middle part, so that we
21368 * have some idea how it starts and ends. smsg() would always
21369 * truncate it at the end. */
21370 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21371 if (s != NULL)
21373 trunc_string(s, buf, MSG_BUF_CLEN);
21374 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21375 vim_free(tofree);
21378 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21380 verbose_leave_scroll();
21381 --no_wait_return;
21384 vim_free(sourcing_name);
21385 sourcing_name = save_sourcing_name;
21386 sourcing_lnum = save_sourcing_lnum;
21387 current_SID = save_current_SID;
21388 #ifdef FEAT_PROFILE
21389 if (do_profiling == PROF_YES)
21390 script_prof_restore(&wait_start);
21391 #endif
21393 if (p_verbose >= 12 && sourcing_name != NULL)
21395 ++no_wait_return;
21396 verbose_enter_scroll();
21398 smsg((char_u *)_("continuing in %s"), sourcing_name);
21399 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21401 verbose_leave_scroll();
21402 --no_wait_return;
21405 did_emsg |= save_did_emsg;
21406 current_funccal = fc->caller;
21407 --depth;
21409 /* If the a:000 list and the l: and a: dicts are not referenced we can
21410 * free the funccall_T and what's in it. */
21411 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21412 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21413 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21415 free_funccal(fc, FALSE);
21417 else
21419 hashitem_T *hi;
21420 listitem_T *li;
21421 int todo;
21423 /* "fc" is still in use. This can happen when returning "a:000" or
21424 * assigning "l:" to a global variable.
21425 * Link "fc" in the list for garbage collection later. */
21426 fc->caller = previous_funccal;
21427 previous_funccal = fc;
21429 /* Make a copy of the a: variables, since we didn't do that above. */
21430 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21431 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21433 if (!HASHITEM_EMPTY(hi))
21435 --todo;
21436 v = HI2DI(hi);
21437 copy_tv(&v->di_tv, &v->di_tv);
21441 /* Make a copy of the a:000 items, since we didn't do that above. */
21442 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21443 copy_tv(&li->li_tv, &li->li_tv);
21448 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21449 * referenced from anywhere that is in use.
21451 static int
21452 can_free_funccal(fc, copyID)
21453 funccall_T *fc;
21454 int copyID;
21456 return (fc->l_varlist.lv_copyID != copyID
21457 && fc->l_vars.dv_copyID != copyID
21458 && fc->l_avars.dv_copyID != copyID);
21462 * Free "fc" and what it contains.
21464 static void
21465 free_funccal(fc, free_val)
21466 funccall_T *fc;
21467 int free_val; /* a: vars were allocated */
21469 listitem_T *li;
21471 /* The a: variables typevals may not have been allocated, only free the
21472 * allocated variables. */
21473 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21475 /* free all l: variables */
21476 vars_clear(&fc->l_vars.dv_hashtab);
21478 /* Free the a:000 variables if they were allocated. */
21479 if (free_val)
21480 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21481 clear_tv(&li->li_tv);
21483 vim_free(fc);
21487 * Add a number variable "name" to dict "dp" with value "nr".
21489 static void
21490 add_nr_var(dp, v, name, nr)
21491 dict_T *dp;
21492 dictitem_T *v;
21493 char *name;
21494 varnumber_T nr;
21496 STRCPY(v->di_key, name);
21497 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21498 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21499 v->di_tv.v_type = VAR_NUMBER;
21500 v->di_tv.v_lock = VAR_FIXED;
21501 v->di_tv.vval.v_number = nr;
21505 * ":return [expr]"
21507 void
21508 ex_return(eap)
21509 exarg_T *eap;
21511 char_u *arg = eap->arg;
21512 typval_T rettv;
21513 int returning = FALSE;
21515 if (current_funccal == NULL)
21517 EMSG(_("E133: :return not inside a function"));
21518 return;
21521 if (eap->skip)
21522 ++emsg_skip;
21524 eap->nextcmd = NULL;
21525 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21526 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21528 if (!eap->skip)
21529 returning = do_return(eap, FALSE, TRUE, &rettv);
21530 else
21531 clear_tv(&rettv);
21533 /* It's safer to return also on error. */
21534 else if (!eap->skip)
21537 * Return unless the expression evaluation has been cancelled due to an
21538 * aborting error, an interrupt, or an exception.
21540 if (!aborting())
21541 returning = do_return(eap, FALSE, TRUE, NULL);
21544 /* When skipping or the return gets pending, advance to the next command
21545 * in this line (!returning). Otherwise, ignore the rest of the line.
21546 * Following lines will be ignored by get_func_line(). */
21547 if (returning)
21548 eap->nextcmd = NULL;
21549 else if (eap->nextcmd == NULL) /* no argument */
21550 eap->nextcmd = check_nextcmd(arg);
21552 if (eap->skip)
21553 --emsg_skip;
21557 * Return from a function. Possibly makes the return pending. Also called
21558 * for a pending return at the ":endtry" or after returning from an extra
21559 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21560 * when called due to a ":return" command. "rettv" may point to a typval_T
21561 * with the return rettv. Returns TRUE when the return can be carried out,
21562 * FALSE when the return gets pending.
21565 do_return(eap, reanimate, is_cmd, rettv)
21566 exarg_T *eap;
21567 int reanimate;
21568 int is_cmd;
21569 void *rettv;
21571 int idx;
21572 struct condstack *cstack = eap->cstack;
21574 if (reanimate)
21575 /* Undo the return. */
21576 current_funccal->returned = FALSE;
21579 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21580 * not in its finally clause (which then is to be executed next) is found.
21581 * In this case, make the ":return" pending for execution at the ":endtry".
21582 * Otherwise, return normally.
21584 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21585 if (idx >= 0)
21587 cstack->cs_pending[idx] = CSTP_RETURN;
21589 if (!is_cmd && !reanimate)
21590 /* A pending return again gets pending. "rettv" points to an
21591 * allocated variable with the rettv of the original ":return"'s
21592 * argument if present or is NULL else. */
21593 cstack->cs_rettv[idx] = rettv;
21594 else
21596 /* When undoing a return in order to make it pending, get the stored
21597 * return rettv. */
21598 if (reanimate)
21599 rettv = current_funccal->rettv;
21601 if (rettv != NULL)
21603 /* Store the value of the pending return. */
21604 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21605 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21606 else
21607 EMSG(_(e_outofmem));
21609 else
21610 cstack->cs_rettv[idx] = NULL;
21612 if (reanimate)
21614 /* The pending return value could be overwritten by a ":return"
21615 * without argument in a finally clause; reset the default
21616 * return value. */
21617 current_funccal->rettv->v_type = VAR_NUMBER;
21618 current_funccal->rettv->vval.v_number = 0;
21621 report_make_pending(CSTP_RETURN, rettv);
21623 else
21625 current_funccal->returned = TRUE;
21627 /* If the return is carried out now, store the return value. For
21628 * a return immediately after reanimation, the value is already
21629 * there. */
21630 if (!reanimate && rettv != NULL)
21632 clear_tv(current_funccal->rettv);
21633 *current_funccal->rettv = *(typval_T *)rettv;
21634 if (!is_cmd)
21635 vim_free(rettv);
21639 return idx < 0;
21643 * Free the variable with a pending return value.
21645 void
21646 discard_pending_return(rettv)
21647 void *rettv;
21649 free_tv((typval_T *)rettv);
21653 * Generate a return command for producing the value of "rettv". The result
21654 * is an allocated string. Used by report_pending() for verbose messages.
21656 char_u *
21657 get_return_cmd(rettv)
21658 void *rettv;
21660 char_u *s = NULL;
21661 char_u *tofree = NULL;
21662 char_u numbuf[NUMBUFLEN];
21664 if (rettv != NULL)
21665 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21666 if (s == NULL)
21667 s = (char_u *)"";
21669 STRCPY(IObuff, ":return ");
21670 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21671 if (STRLEN(s) + 8 >= IOSIZE)
21672 STRCPY(IObuff + IOSIZE - 4, "...");
21673 vim_free(tofree);
21674 return vim_strsave(IObuff);
21678 * Get next function line.
21679 * Called by do_cmdline() to get the next line.
21680 * Returns allocated string, or NULL for end of function.
21682 char_u *
21683 get_func_line(c, cookie, indent)
21684 int c UNUSED;
21685 void *cookie;
21686 int indent UNUSED;
21688 funccall_T *fcp = (funccall_T *)cookie;
21689 ufunc_T *fp = fcp->func;
21690 char_u *retval;
21691 garray_T *gap; /* growarray with function lines */
21693 /* If breakpoints have been added/deleted need to check for it. */
21694 if (fcp->dbg_tick != debug_tick)
21696 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21697 sourcing_lnum);
21698 fcp->dbg_tick = debug_tick;
21700 #ifdef FEAT_PROFILE
21701 if (do_profiling == PROF_YES)
21702 func_line_end(cookie);
21703 #endif
21705 gap = &fp->uf_lines;
21706 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21707 || fcp->returned)
21708 retval = NULL;
21709 else
21711 /* Skip NULL lines (continuation lines). */
21712 while (fcp->linenr < gap->ga_len
21713 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21714 ++fcp->linenr;
21715 if (fcp->linenr >= gap->ga_len)
21716 retval = NULL;
21717 else
21719 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21720 sourcing_lnum = fcp->linenr;
21721 #ifdef FEAT_PROFILE
21722 if (do_profiling == PROF_YES)
21723 func_line_start(cookie);
21724 #endif
21728 /* Did we encounter a breakpoint? */
21729 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21731 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21732 /* Find next breakpoint. */
21733 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21734 sourcing_lnum);
21735 fcp->dbg_tick = debug_tick;
21738 return retval;
21741 #if defined(FEAT_PROFILE) || defined(PROTO)
21743 * Called when starting to read a function line.
21744 * "sourcing_lnum" must be correct!
21745 * When skipping lines it may not actually be executed, but we won't find out
21746 * until later and we need to store the time now.
21748 void
21749 func_line_start(cookie)
21750 void *cookie;
21752 funccall_T *fcp = (funccall_T *)cookie;
21753 ufunc_T *fp = fcp->func;
21755 if (fp->uf_profiling && sourcing_lnum >= 1
21756 && sourcing_lnum <= fp->uf_lines.ga_len)
21758 fp->uf_tml_idx = sourcing_lnum - 1;
21759 /* Skip continuation lines. */
21760 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21761 --fp->uf_tml_idx;
21762 fp->uf_tml_execed = FALSE;
21763 profile_start(&fp->uf_tml_start);
21764 profile_zero(&fp->uf_tml_children);
21765 profile_get_wait(&fp->uf_tml_wait);
21770 * Called when actually executing a function line.
21772 void
21773 func_line_exec(cookie)
21774 void *cookie;
21776 funccall_T *fcp = (funccall_T *)cookie;
21777 ufunc_T *fp = fcp->func;
21779 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21780 fp->uf_tml_execed = TRUE;
21784 * Called when done with a function line.
21786 void
21787 func_line_end(cookie)
21788 void *cookie;
21790 funccall_T *fcp = (funccall_T *)cookie;
21791 ufunc_T *fp = fcp->func;
21793 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21795 if (fp->uf_tml_execed)
21797 ++fp->uf_tml_count[fp->uf_tml_idx];
21798 profile_end(&fp->uf_tml_start);
21799 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21800 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21801 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21802 &fp->uf_tml_children);
21804 fp->uf_tml_idx = -1;
21807 #endif
21810 * Return TRUE if the currently active function should be ended, because a
21811 * return was encountered or an error occurred. Used inside a ":while".
21814 func_has_ended(cookie)
21815 void *cookie;
21817 funccall_T *fcp = (funccall_T *)cookie;
21819 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21820 * an error inside a try conditional. */
21821 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21822 || fcp->returned);
21826 * return TRUE if cookie indicates a function which "abort"s on errors.
21829 func_has_abort(cookie)
21830 void *cookie;
21832 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21835 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21836 typedef enum
21838 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21839 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21840 VAR_FLAVOUR_VIMINFO /* all uppercase */
21841 } var_flavour_T;
21843 static var_flavour_T var_flavour __ARGS((char_u *varname));
21845 static var_flavour_T
21846 var_flavour(varname)
21847 char_u *varname;
21849 char_u *p = varname;
21851 if (ASCII_ISUPPER(*p))
21853 while (*(++p))
21854 if (ASCII_ISLOWER(*p))
21855 return VAR_FLAVOUR_SESSION;
21856 return VAR_FLAVOUR_VIMINFO;
21858 else
21859 return VAR_FLAVOUR_DEFAULT;
21861 #endif
21863 #if defined(FEAT_VIMINFO) || defined(PROTO)
21865 * Restore global vars that start with a capital from the viminfo file
21868 read_viminfo_varlist(virp, writing)
21869 vir_T *virp;
21870 int writing;
21872 char_u *tab;
21873 int type = VAR_NUMBER;
21874 typval_T tv;
21876 if (!writing && (find_viminfo_parameter('!') != NULL))
21878 tab = vim_strchr(virp->vir_line + 1, '\t');
21879 if (tab != NULL)
21881 *tab++ = '\0'; /* isolate the variable name */
21882 if (*tab == 'S') /* string var */
21883 type = VAR_STRING;
21884 #ifdef FEAT_FLOAT
21885 else if (*tab == 'F')
21886 type = VAR_FLOAT;
21887 #endif
21889 tab = vim_strchr(tab, '\t');
21890 if (tab != NULL)
21892 tv.v_type = type;
21893 if (type == VAR_STRING)
21894 tv.vval.v_string = viminfo_readstring(virp,
21895 (int)(tab - virp->vir_line + 1), TRUE);
21896 #ifdef FEAT_FLOAT
21897 else if (type == VAR_FLOAT)
21898 (void)string2float(tab + 1, &tv.vval.v_float);
21899 #endif
21900 else
21901 tv.vval.v_number = atol((char *)tab + 1);
21902 set_var(virp->vir_line + 1, &tv, FALSE);
21903 if (type == VAR_STRING)
21904 vim_free(tv.vval.v_string);
21909 return viminfo_readline(virp);
21913 * Write global vars that start with a capital to the viminfo file
21915 void
21916 write_viminfo_varlist(fp)
21917 FILE *fp;
21919 hashitem_T *hi;
21920 dictitem_T *this_var;
21921 int todo;
21922 char *s;
21923 char_u *p;
21924 char_u *tofree;
21925 char_u numbuf[NUMBUFLEN];
21927 if (find_viminfo_parameter('!') == NULL)
21928 return;
21930 fprintf(fp, _("\n# global variables:\n"));
21932 todo = (int)globvarht.ht_used;
21933 for (hi = globvarht.ht_array; todo > 0; ++hi)
21935 if (!HASHITEM_EMPTY(hi))
21937 --todo;
21938 this_var = HI2DI(hi);
21939 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21941 switch (this_var->di_tv.v_type)
21943 case VAR_STRING: s = "STR"; break;
21944 case VAR_NUMBER: s = "NUM"; break;
21945 #ifdef FEAT_FLOAT
21946 case VAR_FLOAT: s = "FLO"; break;
21947 #endif
21948 default: continue;
21950 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21951 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21952 if (p != NULL)
21953 viminfo_writestring(fp, p);
21954 vim_free(tofree);
21959 #endif
21961 #if defined(FEAT_SESSION) || defined(PROTO)
21963 store_session_globals(fd)
21964 FILE *fd;
21966 hashitem_T *hi;
21967 dictitem_T *this_var;
21968 int todo;
21969 char_u *p, *t;
21971 todo = (int)globvarht.ht_used;
21972 for (hi = globvarht.ht_array; todo > 0; ++hi)
21974 if (!HASHITEM_EMPTY(hi))
21976 --todo;
21977 this_var = HI2DI(hi);
21978 if ((this_var->di_tv.v_type == VAR_NUMBER
21979 || this_var->di_tv.v_type == VAR_STRING)
21980 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21982 /* Escape special characters with a backslash. Turn a LF and
21983 * CR into \n and \r. */
21984 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21985 (char_u *)"\\\"\n\r");
21986 if (p == NULL) /* out of memory */
21987 break;
21988 for (t = p; *t != NUL; ++t)
21989 if (*t == '\n')
21990 *t = 'n';
21991 else if (*t == '\r')
21992 *t = 'r';
21993 if ((fprintf(fd, "let %s = %c%s%c",
21994 this_var->di_key,
21995 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21996 : ' ',
21998 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21999 : ' ') < 0)
22000 || put_eol(fd) == FAIL)
22002 vim_free(p);
22003 return FAIL;
22005 vim_free(p);
22007 #ifdef FEAT_FLOAT
22008 else if (this_var->di_tv.v_type == VAR_FLOAT
22009 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22011 float_T f = this_var->di_tv.vval.v_float;
22012 int sign = ' ';
22014 if (f < 0)
22016 f = -f;
22017 sign = '-';
22019 if ((fprintf(fd, "let %s = %c&%f",
22020 this_var->di_key, sign, f) < 0)
22021 || put_eol(fd) == FAIL)
22022 return FAIL;
22024 #endif
22027 return OK;
22029 #endif
22032 * Display script name where an item was last set.
22033 * Should only be invoked when 'verbose' is non-zero.
22035 void
22036 last_set_msg(scriptID)
22037 scid_T scriptID;
22039 char_u *p;
22041 if (scriptID != 0)
22043 p = home_replace_save(NULL, get_scriptname(scriptID));
22044 if (p != NULL)
22046 verbose_enter();
22047 MSG_PUTS(_("\n\tLast set from "));
22048 MSG_PUTS(p);
22049 vim_free(p);
22050 verbose_leave();
22056 * List v:oldfiles in a nice way.
22058 void
22059 ex_oldfiles(eap)
22060 exarg_T *eap UNUSED;
22062 list_T *l = vimvars[VV_OLDFILES].vv_list;
22063 listitem_T *li;
22064 int nr = 0;
22066 if (l == NULL)
22067 msg((char_u *)_("No old files"));
22068 else
22070 msg_start();
22071 msg_scroll = TRUE;
22072 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22074 msg_outnum((long)++nr);
22075 MSG_PUTS(": ");
22076 msg_outtrans(get_tv_string(&li->li_tv));
22077 msg_putchar('\n');
22078 out_flush(); /* output one line at a time */
22079 ui_breakcheck();
22081 /* Assume "got_int" was set to truncate the listing. */
22082 got_int = FALSE;
22084 #ifdef FEAT_BROWSE_CMD
22085 if (cmdmod.browse)
22087 quit_more = FALSE;
22088 nr = prompt_for_number(FALSE);
22089 msg_starthere();
22090 if (nr > 0)
22092 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22093 (long)nr);
22095 if (p != NULL)
22097 p = expand_env_save(p);
22098 eap->arg = p;
22099 eap->cmdidx = CMD_edit;
22100 cmdmod.browse = FALSE;
22101 do_exedit(eap, NULL);
22102 vim_free(p);
22106 #endif
22110 #endif /* FEAT_EVAL */
22113 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22115 #ifdef WIN3264
22117 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22119 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22120 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22121 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22124 * Get the short path (8.3) for the filename in "fnamep".
22125 * Only works for a valid file name.
22126 * When the path gets longer "fnamep" is changed and the allocated buffer
22127 * is put in "bufp".
22128 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22129 * Returns OK on success, FAIL on failure.
22131 static int
22132 get_short_pathname(fnamep, bufp, fnamelen)
22133 char_u **fnamep;
22134 char_u **bufp;
22135 int *fnamelen;
22137 int l, len;
22138 char_u *newbuf;
22140 len = *fnamelen;
22141 l = GetShortPathName(*fnamep, *fnamep, len);
22142 if (l > len - 1)
22144 /* If that doesn't work (not enough space), then save the string
22145 * and try again with a new buffer big enough. */
22146 newbuf = vim_strnsave(*fnamep, l);
22147 if (newbuf == NULL)
22148 return FAIL;
22150 vim_free(*bufp);
22151 *fnamep = *bufp = newbuf;
22153 /* Really should always succeed, as the buffer is big enough. */
22154 l = GetShortPathName(*fnamep, *fnamep, l+1);
22157 *fnamelen = l;
22158 return OK;
22162 * Get the short path (8.3) for the filename in "fname". The converted
22163 * path is returned in "bufp".
22165 * Some of the directories specified in "fname" may not exist. This function
22166 * will shorten the existing directories at the beginning of the path and then
22167 * append the remaining non-existing path.
22169 * fname - Pointer to the filename to shorten. On return, contains the
22170 * pointer to the shortened pathname
22171 * bufp - Pointer to an allocated buffer for the filename.
22172 * fnamelen - Length of the filename pointed to by fname
22174 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22176 static int
22177 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22178 char_u **fname;
22179 char_u **bufp;
22180 int *fnamelen;
22182 char_u *short_fname, *save_fname, *pbuf_unused;
22183 char_u *endp, *save_endp;
22184 char_u ch;
22185 int old_len, len;
22186 int new_len, sfx_len;
22187 int retval = OK;
22189 /* Make a copy */
22190 old_len = *fnamelen;
22191 save_fname = vim_strnsave(*fname, old_len);
22192 pbuf_unused = NULL;
22193 short_fname = NULL;
22195 endp = save_fname + old_len - 1; /* Find the end of the copy */
22196 save_endp = endp;
22199 * Try shortening the supplied path till it succeeds by removing one
22200 * directory at a time from the tail of the path.
22202 len = 0;
22203 for (;;)
22205 /* go back one path-separator */
22206 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22207 --endp;
22208 if (endp <= save_fname)
22209 break; /* processed the complete path */
22212 * Replace the path separator with a NUL and try to shorten the
22213 * resulting path.
22215 ch = *endp;
22216 *endp = 0;
22217 short_fname = save_fname;
22218 len = (int)STRLEN(short_fname) + 1;
22219 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22221 retval = FAIL;
22222 goto theend;
22224 *endp = ch; /* preserve the string */
22226 if (len > 0)
22227 break; /* successfully shortened the path */
22229 /* failed to shorten the path. Skip the path separator */
22230 --endp;
22233 if (len > 0)
22236 * Succeeded in shortening the path. Now concatenate the shortened
22237 * path with the remaining path at the tail.
22240 /* Compute the length of the new path. */
22241 sfx_len = (int)(save_endp - endp) + 1;
22242 new_len = len + sfx_len;
22244 *fnamelen = new_len;
22245 vim_free(*bufp);
22246 if (new_len > old_len)
22248 /* There is not enough space in the currently allocated string,
22249 * copy it to a buffer big enough. */
22250 *fname = *bufp = vim_strnsave(short_fname, new_len);
22251 if (*fname == NULL)
22253 retval = FAIL;
22254 goto theend;
22257 else
22259 /* Transfer short_fname to the main buffer (it's big enough),
22260 * unless get_short_pathname() did its work in-place. */
22261 *fname = *bufp = save_fname;
22262 if (short_fname != save_fname)
22263 vim_strncpy(save_fname, short_fname, len);
22264 save_fname = NULL;
22267 /* concat the not-shortened part of the path */
22268 vim_strncpy(*fname + len, endp, sfx_len);
22269 (*fname)[new_len] = NUL;
22272 theend:
22273 vim_free(pbuf_unused);
22274 vim_free(save_fname);
22276 return retval;
22280 * Get a pathname for a partial path.
22281 * Returns OK for success, FAIL for failure.
22283 static int
22284 shortpath_for_partial(fnamep, bufp, fnamelen)
22285 char_u **fnamep;
22286 char_u **bufp;
22287 int *fnamelen;
22289 int sepcount, len, tflen;
22290 char_u *p;
22291 char_u *pbuf, *tfname;
22292 int hasTilde;
22294 /* Count up the path separators from the RHS.. so we know which part
22295 * of the path to return. */
22296 sepcount = 0;
22297 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22298 if (vim_ispathsep(*p))
22299 ++sepcount;
22301 /* Need full path first (use expand_env() to remove a "~/") */
22302 hasTilde = (**fnamep == '~');
22303 if (hasTilde)
22304 pbuf = tfname = expand_env_save(*fnamep);
22305 else
22306 pbuf = tfname = FullName_save(*fnamep, FALSE);
22308 len = tflen = (int)STRLEN(tfname);
22310 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22311 return FAIL;
22313 if (len == 0)
22315 /* Don't have a valid filename, so shorten the rest of the
22316 * path if we can. This CAN give us invalid 8.3 filenames, but
22317 * there's not a lot of point in guessing what it might be.
22319 len = tflen;
22320 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22321 return FAIL;
22324 /* Count the paths backward to find the beginning of the desired string. */
22325 for (p = tfname + len - 1; p >= tfname; --p)
22327 #ifdef FEAT_MBYTE
22328 if (has_mbyte)
22329 p -= mb_head_off(tfname, p);
22330 #endif
22331 if (vim_ispathsep(*p))
22333 if (sepcount == 0 || (hasTilde && sepcount == 1))
22334 break;
22335 else
22336 sepcount --;
22339 if (hasTilde)
22341 --p;
22342 if (p >= tfname)
22343 *p = '~';
22344 else
22345 return FAIL;
22347 else
22348 ++p;
22350 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22351 vim_free(*bufp);
22352 *fnamelen = (int)STRLEN(p);
22353 *bufp = pbuf;
22354 *fnamep = p;
22356 return OK;
22358 #endif /* WIN3264 */
22361 * Adjust a filename, according to a string of modifiers.
22362 * *fnamep must be NUL terminated when called. When returning, the length is
22363 * determined by *fnamelen.
22364 * Returns VALID_ flags or -1 for failure.
22365 * When there is an error, *fnamep is set to NULL.
22368 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22369 char_u *src; /* string with modifiers */
22370 int *usedlen; /* characters after src that are used */
22371 char_u **fnamep; /* file name so far */
22372 char_u **bufp; /* buffer for allocated file name or NULL */
22373 int *fnamelen; /* length of fnamep */
22375 int valid = 0;
22376 char_u *tail;
22377 char_u *s, *p, *pbuf;
22378 char_u dirname[MAXPATHL];
22379 int c;
22380 int has_fullname = 0;
22381 #ifdef WIN3264
22382 int has_shortname = 0;
22383 #endif
22385 repeat:
22386 /* ":p" - full path/file_name */
22387 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22389 has_fullname = 1;
22391 valid |= VALID_PATH;
22392 *usedlen += 2;
22394 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22395 if ((*fnamep)[0] == '~'
22396 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22397 && ((*fnamep)[1] == '/'
22398 # ifdef BACKSLASH_IN_FILENAME
22399 || (*fnamep)[1] == '\\'
22400 # endif
22401 || (*fnamep)[1] == NUL)
22403 #endif
22406 *fnamep = expand_env_save(*fnamep);
22407 vim_free(*bufp); /* free any allocated file name */
22408 *bufp = *fnamep;
22409 if (*fnamep == NULL)
22410 return -1;
22413 /* When "/." or "/.." is used: force expansion to get rid of it. */
22414 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22416 if (vim_ispathsep(*p)
22417 && p[1] == '.'
22418 && (p[2] == NUL
22419 || vim_ispathsep(p[2])
22420 || (p[2] == '.'
22421 && (p[3] == NUL || vim_ispathsep(p[3])))))
22422 break;
22425 /* FullName_save() is slow, don't use it when not needed. */
22426 if (*p != NUL || !vim_isAbsName(*fnamep))
22428 *fnamep = FullName_save(*fnamep, *p != NUL);
22429 vim_free(*bufp); /* free any allocated file name */
22430 *bufp = *fnamep;
22431 if (*fnamep == NULL)
22432 return -1;
22435 /* Append a path separator to a directory. */
22436 if (mch_isdir(*fnamep))
22438 /* Make room for one or two extra characters. */
22439 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22440 vim_free(*bufp); /* free any allocated file name */
22441 *bufp = *fnamep;
22442 if (*fnamep == NULL)
22443 return -1;
22444 add_pathsep(*fnamep);
22448 /* ":." - path relative to the current directory */
22449 /* ":~" - path relative to the home directory */
22450 /* ":8" - shortname path - postponed till after */
22451 while (src[*usedlen] == ':'
22452 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22454 *usedlen += 2;
22455 if (c == '8')
22457 #ifdef WIN3264
22458 has_shortname = 1; /* Postpone this. */
22459 #endif
22460 continue;
22462 pbuf = NULL;
22463 /* Need full path first (use expand_env() to remove a "~/") */
22464 if (!has_fullname)
22466 if (c == '.' && **fnamep == '~')
22467 p = pbuf = expand_env_save(*fnamep);
22468 else
22469 p = pbuf = FullName_save(*fnamep, FALSE);
22471 else
22472 p = *fnamep;
22474 has_fullname = 0;
22476 if (p != NULL)
22478 if (c == '.')
22480 mch_dirname(dirname, MAXPATHL);
22481 s = shorten_fname(p, dirname);
22482 if (s != NULL)
22484 *fnamep = s;
22485 if (pbuf != NULL)
22487 vim_free(*bufp); /* free any allocated file name */
22488 *bufp = pbuf;
22489 pbuf = NULL;
22493 else
22495 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22496 /* Only replace it when it starts with '~' */
22497 if (*dirname == '~')
22499 s = vim_strsave(dirname);
22500 if (s != NULL)
22502 *fnamep = s;
22503 vim_free(*bufp);
22504 *bufp = s;
22508 vim_free(pbuf);
22512 tail = gettail(*fnamep);
22513 *fnamelen = (int)STRLEN(*fnamep);
22515 /* ":h" - head, remove "/file_name", can be repeated */
22516 /* Don't remove the first "/" or "c:\" */
22517 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22519 valid |= VALID_HEAD;
22520 *usedlen += 2;
22521 s = get_past_head(*fnamep);
22522 while (tail > s && after_pathsep(s, tail))
22523 mb_ptr_back(*fnamep, tail);
22524 *fnamelen = (int)(tail - *fnamep);
22525 #ifdef VMS
22526 if (*fnamelen > 0)
22527 *fnamelen += 1; /* the path separator is part of the path */
22528 #endif
22529 if (*fnamelen == 0)
22531 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22532 p = vim_strsave((char_u *)".");
22533 if (p == NULL)
22534 return -1;
22535 vim_free(*bufp);
22536 *bufp = *fnamep = tail = p;
22537 *fnamelen = 1;
22539 else
22541 while (tail > s && !after_pathsep(s, tail))
22542 mb_ptr_back(*fnamep, tail);
22546 /* ":8" - shortname */
22547 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22549 *usedlen += 2;
22550 #ifdef WIN3264
22551 has_shortname = 1;
22552 #endif
22555 #ifdef WIN3264
22556 /* Check shortname after we have done 'heads' and before we do 'tails'
22558 if (has_shortname)
22560 pbuf = NULL;
22561 /* Copy the string if it is shortened by :h */
22562 if (*fnamelen < (int)STRLEN(*fnamep))
22564 p = vim_strnsave(*fnamep, *fnamelen);
22565 if (p == 0)
22566 return -1;
22567 vim_free(*bufp);
22568 *bufp = *fnamep = p;
22571 /* Split into two implementations - makes it easier. First is where
22572 * there isn't a full name already, second is where there is.
22574 if (!has_fullname && !vim_isAbsName(*fnamep))
22576 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22577 return -1;
22579 else
22581 int l;
22583 /* Simple case, already have the full-name
22584 * Nearly always shorter, so try first time. */
22585 l = *fnamelen;
22586 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22587 return -1;
22589 if (l == 0)
22591 /* Couldn't find the filename.. search the paths.
22593 l = *fnamelen;
22594 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22595 return -1;
22597 *fnamelen = l;
22600 #endif /* WIN3264 */
22602 /* ":t" - tail, just the basename */
22603 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22605 *usedlen += 2;
22606 *fnamelen -= (int)(tail - *fnamep);
22607 *fnamep = tail;
22610 /* ":e" - extension, can be repeated */
22611 /* ":r" - root, without extension, can be repeated */
22612 while (src[*usedlen] == ':'
22613 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22615 /* find a '.' in the tail:
22616 * - for second :e: before the current fname
22617 * - otherwise: The last '.'
22619 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22620 s = *fnamep - 2;
22621 else
22622 s = *fnamep + *fnamelen - 1;
22623 for ( ; s > tail; --s)
22624 if (s[0] == '.')
22625 break;
22626 if (src[*usedlen + 1] == 'e') /* :e */
22628 if (s > tail)
22630 *fnamelen += (int)(*fnamep - (s + 1));
22631 *fnamep = s + 1;
22632 #ifdef VMS
22633 /* cut version from the extension */
22634 s = *fnamep + *fnamelen - 1;
22635 for ( ; s > *fnamep; --s)
22636 if (s[0] == ';')
22637 break;
22638 if (s > *fnamep)
22639 *fnamelen = s - *fnamep;
22640 #endif
22642 else if (*fnamep <= tail)
22643 *fnamelen = 0;
22645 else /* :r */
22647 if (s > tail) /* remove one extension */
22648 *fnamelen = (int)(s - *fnamep);
22650 *usedlen += 2;
22653 /* ":s?pat?foo?" - substitute */
22654 /* ":gs?pat?foo?" - global substitute */
22655 if (src[*usedlen] == ':'
22656 && (src[*usedlen + 1] == 's'
22657 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22659 char_u *str;
22660 char_u *pat;
22661 char_u *sub;
22662 int sep;
22663 char_u *flags;
22664 int didit = FALSE;
22666 flags = (char_u *)"";
22667 s = src + *usedlen + 2;
22668 if (src[*usedlen + 1] == 'g')
22670 flags = (char_u *)"g";
22671 ++s;
22674 sep = *s++;
22675 if (sep)
22677 /* find end of pattern */
22678 p = vim_strchr(s, sep);
22679 if (p != NULL)
22681 pat = vim_strnsave(s, (int)(p - s));
22682 if (pat != NULL)
22684 s = p + 1;
22685 /* find end of substitution */
22686 p = vim_strchr(s, sep);
22687 if (p != NULL)
22689 sub = vim_strnsave(s, (int)(p - s));
22690 str = vim_strnsave(*fnamep, *fnamelen);
22691 if (sub != NULL && str != NULL)
22693 *usedlen = (int)(p + 1 - src);
22694 s = do_string_sub(str, pat, sub, flags);
22695 if (s != NULL)
22697 *fnamep = s;
22698 *fnamelen = (int)STRLEN(s);
22699 vim_free(*bufp);
22700 *bufp = s;
22701 didit = TRUE;
22704 vim_free(sub);
22705 vim_free(str);
22707 vim_free(pat);
22710 /* after using ":s", repeat all the modifiers */
22711 if (didit)
22712 goto repeat;
22716 return valid;
22720 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22721 * "flags" can be "g" to do a global substitute.
22722 * Returns an allocated string, NULL for error.
22724 char_u *
22725 do_string_sub(str, pat, sub, flags)
22726 char_u *str;
22727 char_u *pat;
22728 char_u *sub;
22729 char_u *flags;
22731 int sublen;
22732 regmatch_T regmatch;
22733 int i;
22734 int do_all;
22735 char_u *tail;
22736 garray_T ga;
22737 char_u *ret;
22738 char_u *save_cpo;
22740 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22741 save_cpo = p_cpo;
22742 p_cpo = empty_option;
22744 ga_init2(&ga, 1, 200);
22746 do_all = (flags[0] == 'g');
22748 regmatch.rm_ic = p_ic;
22749 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22750 if (regmatch.regprog != NULL)
22752 tail = str;
22753 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22756 * Get some space for a temporary buffer to do the substitution
22757 * into. It will contain:
22758 * - The text up to where the match is.
22759 * - The substituted text.
22760 * - The text after the match.
22762 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22763 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22764 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22766 ga_clear(&ga);
22767 break;
22770 /* copy the text up to where the match is */
22771 i = (int)(regmatch.startp[0] - tail);
22772 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22773 /* add the substituted text */
22774 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22775 + ga.ga_len + i, TRUE, TRUE, FALSE);
22776 ga.ga_len += i + sublen - 1;
22777 /* avoid getting stuck on a match with an empty string */
22778 if (tail == regmatch.endp[0])
22780 if (*tail == NUL)
22781 break;
22782 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22783 ++ga.ga_len;
22785 else
22787 tail = regmatch.endp[0];
22788 if (*tail == NUL)
22789 break;
22791 if (!do_all)
22792 break;
22795 if (ga.ga_data != NULL)
22796 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22798 vim_free(regmatch.regprog);
22801 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22802 ga_clear(&ga);
22803 if (p_cpo == empty_option)
22804 p_cpo = save_cpo;
22805 else
22806 /* Darn, evaluating {sub} expression changed the value. */
22807 free_string_option(save_cpo);
22809 return ret;
22812 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */