Merge branch 'vim'
[MacVim.git] / src / eval.c
bloba7bdf43943e0c09dc03491150afb7dd3a033de96
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_tv __ARGS((list_T *l, typval_T *tv));
437 static int list_append_number __ARGS((list_T *l, varnumber_T n));
438 static int list_insert_tv __ARGS((list_T *l, typval_T *tv, listitem_T *item));
439 static int list_extend __ARGS((list_T *l1, list_T *l2, listitem_T *bef));
440 static int list_concat __ARGS((list_T *l1, list_T *l2, typval_T *tv));
441 static list_T *list_copy __ARGS((list_T *orig, int deep, int copyID));
442 static void list_remove __ARGS((list_T *l, listitem_T *item, listitem_T *item2));
443 static char_u *list2string __ARGS((typval_T *tv, int copyID));
444 static int list_join __ARGS((garray_T *gap, list_T *l, char_u *sep, int echo, int copyID));
445 static int free_unref_items __ARGS((int copyID));
446 static void set_ref_in_ht __ARGS((hashtab_T *ht, int copyID));
447 static void set_ref_in_list __ARGS((list_T *l, int copyID));
448 static void set_ref_in_item __ARGS((typval_T *tv, int copyID));
449 static void dict_unref __ARGS((dict_T *d));
450 static void dict_free __ARGS((dict_T *d, int recurse));
451 static dictitem_T *dictitem_alloc __ARGS((char_u *key));
452 static dictitem_T *dictitem_copy __ARGS((dictitem_T *org));
453 static void dictitem_remove __ARGS((dict_T *dict, dictitem_T *item));
454 static void dictitem_free __ARGS((dictitem_T *item));
455 static dict_T *dict_copy __ARGS((dict_T *orig, int deep, int copyID));
456 static int dict_add __ARGS((dict_T *d, dictitem_T *item));
457 static long dict_len __ARGS((dict_T *d));
458 static dictitem_T *dict_find __ARGS((dict_T *d, char_u *key, int len));
459 static char_u *dict2string __ARGS((typval_T *tv, int copyID));
460 static int get_dict_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
461 static char_u *echo_string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
462 static char_u *tv2string __ARGS((typval_T *tv, char_u **tofree, char_u *numbuf, int copyID));
463 static char_u *string_quote __ARGS((char_u *str, int function));
464 #ifdef FEAT_FLOAT
465 static int string2float __ARGS((char_u *text, float_T *value));
466 #endif
467 static int get_env_tv __ARGS((char_u **arg, typval_T *rettv, int evaluate));
468 static int find_internal_func __ARGS((char_u *name));
469 static char_u *deref_func_name __ARGS((char_u *name, int *lenp));
470 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));
471 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));
472 static void emsg_funcname __ARGS((char *ermsg, char_u *name));
473 static int non_zero_arg __ARGS((typval_T *argvars));
475 #ifdef FEAT_FLOAT
476 static void f_abs __ARGS((typval_T *argvars, typval_T *rettv));
477 #endif
478 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
479 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
480 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
481 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
482 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
483 #ifdef FEAT_FLOAT
484 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
485 #endif
486 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
488 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
491 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
492 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
493 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
494 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
497 #ifdef FEAT_FLOAT
498 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
499 #endif
500 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
501 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
502 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
505 #if defined(FEAT_INS_EXPAND)
506 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
507 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
508 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
509 #endif
510 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
511 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
512 #ifdef FEAT_FLOAT
513 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
514 #endif
515 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
518 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
520 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
521 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
524 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
525 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
527 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
528 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
529 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
530 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
533 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
534 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
537 #ifdef FEAT_FLOAT
538 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
540 #endif
541 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
552 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
553 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
555 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
556 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
608 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
612 #ifdef FEAT_FLOAT
613 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
614 #endif
615 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
620 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
621 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
622 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
623 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
626 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
627 #ifdef vim_mkdir
628 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
634 #ifdef FEAT_FLOAT
635 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
636 #endif
637 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
642 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
643 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
644 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
645 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
649 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
650 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
651 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
652 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
654 #ifdef FEAT_FLOAT
655 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
656 #endif
657 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
669 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
670 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
671 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
672 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
676 #ifdef FEAT_FLOAT
677 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
678 #endif
679 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
683 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
684 #ifdef FEAT_FLOAT
685 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
686 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
687 #endif
688 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
689 #ifdef HAVE_STRFTIME
690 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
691 #endif
692 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
693 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
694 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
699 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
700 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
702 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
703 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
704 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
705 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
706 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
707 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
715 #ifdef FEAT_FLOAT
716 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
717 #endif
718 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
730 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
731 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
733 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
734 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
735 static int get_env_len __ARGS((char_u **arg));
736 static int get_id_len __ARGS((char_u **arg));
737 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
738 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
739 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
740 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
741 valid character */
742 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
743 static int eval_isnamec __ARGS((int c));
744 static int eval_isnamec1 __ARGS((int c));
745 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
746 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
747 static typval_T *alloc_tv __ARGS((void));
748 static typval_T *alloc_string_tv __ARGS((char_u *string));
749 static void init_tv __ARGS((typval_T *varp));
750 static long get_tv_number __ARGS((typval_T *varp));
751 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
752 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
753 static char_u *get_tv_string __ARGS((typval_T *varp));
754 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
755 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
756 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
757 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
758 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
759 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
760 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
761 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
762 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
763 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
764 static int var_check_ro __ARGS((int flags, char_u *name));
765 static int var_check_fixed __ARGS((int flags, char_u *name));
766 static int tv_check_lock __ARGS((int lock, char_u *name));
767 static void copy_tv __ARGS((typval_T *from, typval_T *to));
768 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
769 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
770 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
771 static int eval_fname_script __ARGS((char_u *p));
772 static int eval_fname_sid __ARGS((char_u *p));
773 static void list_func_head __ARGS((ufunc_T *fp, int indent));
774 static ufunc_T *find_func __ARGS((char_u *name));
775 static int function_exists __ARGS((char_u *name));
776 static int builtin_function __ARGS((char_u *name));
777 #ifdef FEAT_PROFILE
778 static void func_do_profile __ARGS((ufunc_T *fp));
779 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
780 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
781 static int
782 # ifdef __BORLANDC__
783 _RTLENTRYF
784 # endif
785 prof_total_cmp __ARGS((const void *s1, const void *s2));
786 static int
787 # ifdef __BORLANDC__
788 _RTLENTRYF
789 # endif
790 prof_self_cmp __ARGS((const void *s1, const void *s2));
791 #endif
792 static int script_autoload __ARGS((char_u *name, int reload));
793 static char_u *autoload_name __ARGS((char_u *name));
794 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
795 static void func_free __ARGS((ufunc_T *fp));
796 static void func_unref __ARGS((char_u *name));
797 static void func_ref __ARGS((char_u *name));
798 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));
799 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
800 static void free_funccal __ARGS((funccall_T *fc, int free_val));
801 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
802 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
803 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
804 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
805 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
806 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
808 /* Character used as separated in autoload function/variable names. */
809 #define AUTOLOAD_CHAR '#'
812 * Initialize the global and v: variables.
814 void
815 eval_init()
817 int i;
818 struct vimvar *p;
820 init_var_dict(&globvardict, &globvars_var);
821 init_var_dict(&vimvardict, &vimvars_var);
822 hash_init(&compat_hashtab);
823 hash_init(&func_hashtab);
825 for (i = 0; i < VV_LEN; ++i)
827 p = &vimvars[i];
828 STRCPY(p->vv_di.di_key, p->vv_name);
829 if (p->vv_flags & VV_RO)
830 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
831 else if (p->vv_flags & VV_RO_SBX)
832 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
833 else
834 p->vv_di.di_flags = DI_FLAGS_FIX;
836 /* add to v: scope dict, unless the value is not always available */
837 if (p->vv_type != VAR_UNKNOWN)
838 hash_add(&vimvarht, p->vv_di.di_key);
839 if (p->vv_flags & VV_COMPAT)
840 /* add to compat scope dict */
841 hash_add(&compat_hashtab, p->vv_di.di_key);
843 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
846 #if defined(EXITFREE) || defined(PROTO)
847 void
848 eval_clear()
850 int i;
851 struct vimvar *p;
853 for (i = 0; i < VV_LEN; ++i)
855 p = &vimvars[i];
856 if (p->vv_di.di_tv.v_type == VAR_STRING)
858 vim_free(p->vv_str);
859 p->vv_str = NULL;
861 else if (p->vv_di.di_tv.v_type == VAR_LIST)
863 list_unref(p->vv_list);
864 p->vv_list = NULL;
867 hash_clear(&vimvarht);
868 hash_init(&vimvarht); /* garbage_collect() will access it */
869 hash_clear(&compat_hashtab);
871 /* script-local variables */
872 for (i = 1; i <= ga_scripts.ga_len; ++i)
873 vars_clear(&SCRIPT_VARS(i));
874 ga_clear(&ga_scripts);
875 free_scriptnames();
877 /* global variables */
878 vars_clear(&globvarht);
880 /* autoloaded script names */
881 ga_clear_strings(&ga_loaded);
883 /* unreferenced lists and dicts */
884 (void)garbage_collect();
886 /* functions */
887 free_all_functions();
888 hash_clear(&func_hashtab);
890 #endif
893 * Return the name of the executed function.
895 char_u *
896 func_name(cookie)
897 void *cookie;
899 return ((funccall_T *)cookie)->func->uf_name;
903 * Return the address holding the next breakpoint line for a funccall cookie.
905 linenr_T *
906 func_breakpoint(cookie)
907 void *cookie;
909 return &((funccall_T *)cookie)->breakpoint;
913 * Return the address holding the debug tick for a funccall cookie.
915 int *
916 func_dbg_tick(cookie)
917 void *cookie;
919 return &((funccall_T *)cookie)->dbg_tick;
923 * Return the nesting level for a funccall cookie.
926 func_level(cookie)
927 void *cookie;
929 return ((funccall_T *)cookie)->level;
932 /* pointer to funccal for currently active function */
933 funccall_T *current_funccal = NULL;
935 /* pointer to list of previously used funccal, still around because some
936 * item in it is still being used. */
937 funccall_T *previous_funccal = NULL;
940 * Return TRUE when a function was ended by a ":return" command.
943 current_func_returned()
945 return current_funccal->returned;
950 * Set an internal variable to a string value. Creates the variable if it does
951 * not already exist.
953 void
954 set_internal_string_var(name, value)
955 char_u *name;
956 char_u *value;
958 char_u *val;
959 typval_T *tvp;
961 val = vim_strsave(value);
962 if (val != NULL)
964 tvp = alloc_string_tv(val);
965 if (tvp != NULL)
967 set_var(name, tvp, FALSE);
968 free_tv(tvp);
973 static lval_T *redir_lval = NULL;
974 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
975 static char_u *redir_endp = NULL;
976 static char_u *redir_varname = NULL;
979 * Start recording command output to a variable
980 * Returns OK if successfully completed the setup. FAIL otherwise.
983 var_redir_start(name, append)
984 char_u *name;
985 int append; /* append to an existing variable */
987 int save_emsg;
988 int err;
989 typval_T tv;
991 /* Make sure a valid variable name is specified */
992 if (!eval_isnamec1(*name))
994 EMSG(_(e_invarg));
995 return FAIL;
998 redir_varname = vim_strsave(name);
999 if (redir_varname == NULL)
1000 return FAIL;
1002 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1003 if (redir_lval == NULL)
1005 var_redir_stop();
1006 return FAIL;
1009 /* The output is stored in growarray "redir_ga" until redirection ends. */
1010 ga_init2(&redir_ga, (int)sizeof(char), 500);
1012 /* Parse the variable name (can be a dict or list entry). */
1013 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1014 FNE_CHECK_START);
1015 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1017 if (redir_endp != NULL && *redir_endp != NUL)
1018 /* Trailing characters are present after the variable name */
1019 EMSG(_(e_trailing));
1020 else
1021 EMSG(_(e_invarg));
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 var_redir_stop();
1041 return FAIL;
1043 if (redir_lval->ll_newkey != NULL)
1045 /* Dictionary item was created, don't do it again. */
1046 vim_free(redir_lval->ll_newkey);
1047 redir_lval->ll_newkey = NULL;
1050 return OK;
1054 * Append "value[value_len]" to the variable set by var_redir_start().
1055 * The actual appending is postponed until redirection ends, because the value
1056 * appended may in fact be the string we write to, changing it may cause freed
1057 * memory to be used:
1058 * :redir => foo
1059 * :let foo
1060 * :redir END
1062 void
1063 var_redir_str(value, value_len)
1064 char_u *value;
1065 int value_len;
1067 int len;
1069 if (redir_lval == NULL)
1070 return;
1072 if (value_len == -1)
1073 len = (int)STRLEN(value); /* Append the entire string */
1074 else
1075 len = value_len; /* Append only "value_len" characters */
1077 if (ga_grow(&redir_ga, len) == OK)
1079 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1080 redir_ga.ga_len += len;
1082 else
1083 var_redir_stop();
1087 * Stop redirecting command output to a variable.
1089 void
1090 var_redir_stop()
1092 typval_T tv;
1094 if (redir_lval != NULL)
1096 /* Append the trailing NUL. */
1097 ga_append(&redir_ga, NUL);
1099 /* Assign the text to the variable. */
1100 tv.v_type = VAR_STRING;
1101 tv.vval.v_string = redir_ga.ga_data;
1102 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1103 vim_free(tv.vval.v_string);
1105 clear_lval(redir_lval);
1106 vim_free(redir_lval);
1107 redir_lval = NULL;
1109 vim_free(redir_varname);
1110 redir_varname = NULL;
1113 # if defined(FEAT_MBYTE) || defined(PROTO)
1115 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1116 char_u *enc_from;
1117 char_u *enc_to;
1118 char_u *fname_from;
1119 char_u *fname_to;
1121 int err = FALSE;
1123 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1124 set_vim_var_string(VV_CC_TO, enc_to, -1);
1125 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1126 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1127 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1128 err = TRUE;
1129 set_vim_var_string(VV_CC_FROM, NULL, -1);
1130 set_vim_var_string(VV_CC_TO, NULL, -1);
1131 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1132 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1134 if (err)
1135 return FAIL;
1136 return OK;
1138 # endif
1140 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1142 eval_printexpr(fname, args)
1143 char_u *fname;
1144 char_u *args;
1146 int err = FALSE;
1148 set_vim_var_string(VV_FNAME_IN, fname, -1);
1149 set_vim_var_string(VV_CMDARG, args, -1);
1150 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1151 err = TRUE;
1152 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1153 set_vim_var_string(VV_CMDARG, NULL, -1);
1155 if (err)
1157 mch_remove(fname);
1158 return FAIL;
1160 return OK;
1162 # endif
1164 # if defined(FEAT_DIFF) || defined(PROTO)
1165 void
1166 eval_diff(origfile, newfile, outfile)
1167 char_u *origfile;
1168 char_u *newfile;
1169 char_u *outfile;
1171 int err = FALSE;
1173 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1174 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1175 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1176 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1177 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1178 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1179 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1182 void
1183 eval_patch(origfile, difffile, outfile)
1184 char_u *origfile;
1185 char_u *difffile;
1186 char_u *outfile;
1188 int err;
1190 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1191 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1192 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1193 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1194 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1195 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1196 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1198 # endif
1201 * Top level evaluation function, returning a boolean.
1202 * Sets "error" to TRUE if there was an error.
1203 * Return TRUE or FALSE.
1206 eval_to_bool(arg, error, nextcmd, skip)
1207 char_u *arg;
1208 int *error;
1209 char_u **nextcmd;
1210 int skip; /* only parse, don't execute */
1212 typval_T tv;
1213 int retval = FALSE;
1215 if (skip)
1216 ++emsg_skip;
1217 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1218 *error = TRUE;
1219 else
1221 *error = FALSE;
1222 if (!skip)
1224 retval = (get_tv_number_chk(&tv, error) != 0);
1225 clear_tv(&tv);
1228 if (skip)
1229 --emsg_skip;
1231 return retval;
1235 * Top level evaluation function, returning a string. If "skip" is TRUE,
1236 * only parsing to "nextcmd" is done, without reporting errors. Return
1237 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1239 char_u *
1240 eval_to_string_skip(arg, nextcmd, skip)
1241 char_u *arg;
1242 char_u **nextcmd;
1243 int skip; /* only parse, don't execute */
1245 typval_T tv;
1246 char_u *retval;
1248 if (skip)
1249 ++emsg_skip;
1250 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1251 retval = NULL;
1252 else
1254 retval = vim_strsave(get_tv_string(&tv));
1255 clear_tv(&tv);
1257 if (skip)
1258 --emsg_skip;
1260 return retval;
1264 * Skip over an expression at "*pp".
1265 * Return FAIL for an error, OK otherwise.
1268 skip_expr(pp)
1269 char_u **pp;
1271 typval_T rettv;
1273 *pp = skipwhite(*pp);
1274 return eval1(pp, &rettv, FALSE);
1278 * Top level evaluation function, returning a string.
1279 * When "convert" is TRUE convert a List into a sequence of lines and convert
1280 * a Float to a String.
1281 * Return pointer to allocated memory, or NULL for failure.
1283 char_u *
1284 eval_to_string(arg, nextcmd, convert)
1285 char_u *arg;
1286 char_u **nextcmd;
1287 int convert;
1289 typval_T tv;
1290 char_u *retval;
1291 garray_T ga;
1292 #ifdef FEAT_FLOAT
1293 char_u numbuf[NUMBUFLEN];
1294 #endif
1296 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1297 retval = NULL;
1298 else
1300 if (convert && tv.v_type == VAR_LIST)
1302 ga_init2(&ga, (int)sizeof(char), 80);
1303 if (tv.vval.v_list != NULL)
1304 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1305 ga_append(&ga, NUL);
1306 retval = (char_u *)ga.ga_data;
1308 #ifdef FEAT_FLOAT
1309 else if (convert && tv.v_type == VAR_FLOAT)
1311 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1312 retval = vim_strsave(numbuf);
1314 #endif
1315 else
1316 retval = vim_strsave(get_tv_string(&tv));
1317 clear_tv(&tv);
1320 return retval;
1324 * Call eval_to_string() without using current local variables and using
1325 * textlock. When "use_sandbox" is TRUE use the sandbox.
1327 char_u *
1328 eval_to_string_safe(arg, nextcmd, use_sandbox)
1329 char_u *arg;
1330 char_u **nextcmd;
1331 int use_sandbox;
1333 char_u *retval;
1334 void *save_funccalp;
1336 save_funccalp = save_funccal();
1337 if (use_sandbox)
1338 ++sandbox;
1339 ++textlock;
1340 retval = eval_to_string(arg, nextcmd, FALSE);
1341 if (use_sandbox)
1342 --sandbox;
1343 --textlock;
1344 restore_funccal(save_funccalp);
1345 return retval;
1349 * Top level evaluation function, returning a number.
1350 * Evaluates "expr" silently.
1351 * Returns -1 for an error.
1354 eval_to_number(expr)
1355 char_u *expr;
1357 typval_T rettv;
1358 int retval;
1359 char_u *p = skipwhite(expr);
1361 ++emsg_off;
1363 if (eval1(&p, &rettv, TRUE) == FAIL)
1364 retval = -1;
1365 else
1367 retval = get_tv_number_chk(&rettv, NULL);
1368 clear_tv(&rettv);
1370 --emsg_off;
1372 return retval;
1376 * Prepare v: variable "idx" to be used.
1377 * Save the current typeval in "save_tv".
1378 * When not used yet add the variable to the v: hashtable.
1380 static void
1381 prepare_vimvar(idx, save_tv)
1382 int idx;
1383 typval_T *save_tv;
1385 *save_tv = vimvars[idx].vv_tv;
1386 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1387 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1391 * Restore v: variable "idx" to typeval "save_tv".
1392 * When no longer defined, remove the variable from the v: hashtable.
1394 static void
1395 restore_vimvar(idx, save_tv)
1396 int idx;
1397 typval_T *save_tv;
1399 hashitem_T *hi;
1401 vimvars[idx].vv_tv = *save_tv;
1402 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1404 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1405 if (HASHITEM_EMPTY(hi))
1406 EMSG2(_(e_intern2), "restore_vimvar()");
1407 else
1408 hash_remove(&vimvarht, hi);
1412 #if defined(FEAT_SPELL) || defined(PROTO)
1414 * Evaluate an expression to a list with suggestions.
1415 * For the "expr:" part of 'spellsuggest'.
1416 * Returns NULL when there is an error.
1418 list_T *
1419 eval_spell_expr(badword, expr)
1420 char_u *badword;
1421 char_u *expr;
1423 typval_T save_val;
1424 typval_T rettv;
1425 list_T *list = NULL;
1426 char_u *p = skipwhite(expr);
1428 /* Set "v:val" to the bad word. */
1429 prepare_vimvar(VV_VAL, &save_val);
1430 vimvars[VV_VAL].vv_type = VAR_STRING;
1431 vimvars[VV_VAL].vv_str = badword;
1432 if (p_verbose == 0)
1433 ++emsg_off;
1435 if (eval1(&p, &rettv, TRUE) == OK)
1437 if (rettv.v_type != VAR_LIST)
1438 clear_tv(&rettv);
1439 else
1440 list = rettv.vval.v_list;
1443 if (p_verbose == 0)
1444 --emsg_off;
1445 restore_vimvar(VV_VAL, &save_val);
1447 return list;
1451 * "list" is supposed to contain two items: a word and a number. Return the
1452 * word in "pp" and the number as the return value.
1453 * Return -1 if anything isn't right.
1454 * Used to get the good word and score from the eval_spell_expr() result.
1457 get_spellword(list, pp)
1458 list_T *list;
1459 char_u **pp;
1461 listitem_T *li;
1463 li = list->lv_first;
1464 if (li == NULL)
1465 return -1;
1466 *pp = get_tv_string(&li->li_tv);
1468 li = li->li_next;
1469 if (li == NULL)
1470 return -1;
1471 return get_tv_number(&li->li_tv);
1473 #endif
1476 * Top level evaluation function.
1477 * Returns an allocated typval_T with the result.
1478 * Returns NULL when there is an error.
1480 typval_T *
1481 eval_expr(arg, nextcmd)
1482 char_u *arg;
1483 char_u **nextcmd;
1485 typval_T *tv;
1487 tv = (typval_T *)alloc(sizeof(typval_T));
1488 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1490 vim_free(tv);
1491 tv = NULL;
1494 return tv;
1498 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1499 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1501 * Call some vimL function and return the result in "*rettv".
1502 * Uses argv[argc] for the function arguments. Only Number and String
1503 * arguments are currently supported.
1504 * Returns OK or FAIL.
1506 static int
1507 call_vim_function(func, argc, argv, safe, rettv)
1508 char_u *func;
1509 int argc;
1510 char_u **argv;
1511 int safe; /* use the sandbox */
1512 typval_T *rettv;
1514 typval_T *argvars;
1515 long n;
1516 int len;
1517 int i;
1518 int doesrange;
1519 void *save_funccalp = NULL;
1520 int ret;
1522 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1523 if (argvars == NULL)
1524 return FAIL;
1526 for (i = 0; i < argc; i++)
1528 /* Pass a NULL or empty argument as an empty string */
1529 if (argv[i] == NULL || *argv[i] == NUL)
1531 argvars[i].v_type = VAR_STRING;
1532 argvars[i].vval.v_string = (char_u *)"";
1533 continue;
1536 /* Recognize a number argument, the others must be strings. */
1537 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1538 if (len != 0 && len == (int)STRLEN(argv[i]))
1540 argvars[i].v_type = VAR_NUMBER;
1541 argvars[i].vval.v_number = n;
1543 else
1545 argvars[i].v_type = VAR_STRING;
1546 argvars[i].vval.v_string = argv[i];
1550 if (safe)
1552 save_funccalp = save_funccal();
1553 ++sandbox;
1556 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1557 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1558 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1559 &doesrange, TRUE, NULL);
1560 if (safe)
1562 --sandbox;
1563 restore_funccal(save_funccalp);
1565 vim_free(argvars);
1567 if (ret == FAIL)
1568 clear_tv(rettv);
1570 return ret;
1573 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1575 * Call vimL function "func" and return the result as a string.
1576 * Returns NULL when calling the function fails.
1577 * Uses argv[argc] for the function arguments.
1579 void *
1580 call_func_retstr(func, argc, argv, safe)
1581 char_u *func;
1582 int argc;
1583 char_u **argv;
1584 int safe; /* use the sandbox */
1586 typval_T rettv;
1587 char_u *retval;
1589 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1590 return NULL;
1592 retval = vim_strsave(get_tv_string(&rettv));
1593 clear_tv(&rettv);
1594 return retval;
1596 # endif
1598 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1600 * Call vimL function "func" and return the result as a number.
1601 * Returns -1 when calling the function fails.
1602 * Uses argv[argc] for the function arguments.
1604 long
1605 call_func_retnr(func, argc, argv, safe)
1606 char_u *func;
1607 int argc;
1608 char_u **argv;
1609 int safe; /* use the sandbox */
1611 typval_T rettv;
1612 long retval;
1614 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1615 return -1;
1617 retval = get_tv_number_chk(&rettv, NULL);
1618 clear_tv(&rettv);
1619 return retval;
1621 # endif
1624 * Call vimL function "func" and return the result as a List.
1625 * Uses argv[argc] for the function arguments.
1626 * Returns NULL when there is something wrong.
1628 void *
1629 call_func_retlist(func, argc, argv, safe)
1630 char_u *func;
1631 int argc;
1632 char_u **argv;
1633 int safe; /* use the sandbox */
1635 typval_T rettv;
1637 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1638 return NULL;
1640 if (rettv.v_type != VAR_LIST)
1642 clear_tv(&rettv);
1643 return NULL;
1646 return rettv.vval.v_list;
1648 #endif
1652 * Save the current function call pointer, and set it to NULL.
1653 * Used when executing autocommands and for ":source".
1655 void *
1656 save_funccal()
1658 funccall_T *fc = current_funccal;
1660 current_funccal = NULL;
1661 return (void *)fc;
1664 void
1665 restore_funccal(vfc)
1666 void *vfc;
1668 funccall_T *fc = (funccall_T *)vfc;
1670 current_funccal = fc;
1673 #if defined(FEAT_PROFILE) || defined(PROTO)
1675 * Prepare profiling for entering a child or something else that is not
1676 * counted for the script/function itself.
1677 * Should always be called in pair with prof_child_exit().
1679 void
1680 prof_child_enter(tm)
1681 proftime_T *tm; /* place to store waittime */
1683 funccall_T *fc = current_funccal;
1685 if (fc != NULL && fc->func->uf_profiling)
1686 profile_start(&fc->prof_child);
1687 script_prof_save(tm);
1691 * Take care of time spent in a child.
1692 * Should always be called after prof_child_enter().
1694 void
1695 prof_child_exit(tm)
1696 proftime_T *tm; /* where waittime was stored */
1698 funccall_T *fc = current_funccal;
1700 if (fc != NULL && fc->func->uf_profiling)
1702 profile_end(&fc->prof_child);
1703 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1704 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1705 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1707 script_prof_restore(tm);
1709 #endif
1712 #ifdef FEAT_FOLDING
1714 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1715 * it in "*cp". Doesn't give error messages.
1718 eval_foldexpr(arg, cp)
1719 char_u *arg;
1720 int *cp;
1722 typval_T tv;
1723 int retval;
1724 char_u *s;
1725 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1726 OPT_LOCAL);
1728 ++emsg_off;
1729 if (use_sandbox)
1730 ++sandbox;
1731 ++textlock;
1732 *cp = NUL;
1733 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1734 retval = 0;
1735 else
1737 /* If the result is a number, just return the number. */
1738 if (tv.v_type == VAR_NUMBER)
1739 retval = tv.vval.v_number;
1740 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1741 retval = 0;
1742 else
1744 /* If the result is a string, check if there is a non-digit before
1745 * the number. */
1746 s = tv.vval.v_string;
1747 if (!VIM_ISDIGIT(*s) && *s != '-')
1748 *cp = *s++;
1749 retval = atol((char *)s);
1751 clear_tv(&tv);
1753 --emsg_off;
1754 if (use_sandbox)
1755 --sandbox;
1756 --textlock;
1758 return retval;
1760 #endif
1763 * ":let" list all variable values
1764 * ":let var1 var2" list variable values
1765 * ":let var = expr" assignment command.
1766 * ":let var += expr" assignment command.
1767 * ":let var -= expr" assignment command.
1768 * ":let var .= expr" assignment command.
1769 * ":let [var1, var2] = expr" unpack list.
1771 void
1772 ex_let(eap)
1773 exarg_T *eap;
1775 char_u *arg = eap->arg;
1776 char_u *expr = NULL;
1777 typval_T rettv;
1778 int i;
1779 int var_count = 0;
1780 int semicolon = 0;
1781 char_u op[2];
1782 char_u *argend;
1783 int first = TRUE;
1785 argend = skip_var_list(arg, &var_count, &semicolon);
1786 if (argend == NULL)
1787 return;
1788 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1789 --argend;
1790 expr = vim_strchr(argend, '=');
1791 if (expr == NULL)
1794 * ":let" without "=": list variables
1796 if (*arg == '[')
1797 EMSG(_(e_invarg));
1798 else if (!ends_excmd(*arg))
1799 /* ":let var1 var2" */
1800 arg = list_arg_vars(eap, arg, &first);
1801 else if (!eap->skip)
1803 /* ":let" */
1804 list_glob_vars(&first);
1805 list_buf_vars(&first);
1806 list_win_vars(&first);
1807 #ifdef FEAT_WINDOWS
1808 list_tab_vars(&first);
1809 #endif
1810 list_script_vars(&first);
1811 list_func_vars(&first);
1812 list_vim_vars(&first);
1814 eap->nextcmd = check_nextcmd(arg);
1816 else
1818 op[0] = '=';
1819 op[1] = NUL;
1820 if (expr > argend)
1822 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1823 op[0] = expr[-1]; /* +=, -= or .= */
1825 expr = skipwhite(expr + 1);
1827 if (eap->skip)
1828 ++emsg_skip;
1829 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1830 if (eap->skip)
1832 if (i != FAIL)
1833 clear_tv(&rettv);
1834 --emsg_skip;
1836 else if (i != FAIL)
1838 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1839 op);
1840 clear_tv(&rettv);
1846 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1847 * Handles both "var" with any type and "[var, var; var]" with a list type.
1848 * When "nextchars" is not NULL it points to a string with characters that
1849 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1850 * or concatenate.
1851 * Returns OK or FAIL;
1853 static int
1854 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1855 char_u *arg_start;
1856 typval_T *tv;
1857 int copy; /* copy values from "tv", don't move */
1858 int semicolon; /* from skip_var_list() */
1859 int var_count; /* from skip_var_list() */
1860 char_u *nextchars;
1862 char_u *arg = arg_start;
1863 list_T *l;
1864 int i;
1865 listitem_T *item;
1866 typval_T ltv;
1868 if (*arg != '[')
1871 * ":let var = expr" or ":for var in list"
1873 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1874 return FAIL;
1875 return OK;
1879 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1881 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1883 EMSG(_(e_listreq));
1884 return FAIL;
1887 i = list_len(l);
1888 if (semicolon == 0 && var_count < i)
1890 EMSG(_("E687: Less targets than List items"));
1891 return FAIL;
1893 if (var_count - semicolon > i)
1895 EMSG(_("E688: More targets than List items"));
1896 return FAIL;
1899 item = l->lv_first;
1900 while (*arg != ']')
1902 arg = skipwhite(arg + 1);
1903 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1904 item = item->li_next;
1905 if (arg == NULL)
1906 return FAIL;
1908 arg = skipwhite(arg);
1909 if (*arg == ';')
1911 /* Put the rest of the list (may be empty) in the var after ';'.
1912 * Create a new list for this. */
1913 l = list_alloc();
1914 if (l == NULL)
1915 return FAIL;
1916 while (item != NULL)
1918 list_append_tv(l, &item->li_tv);
1919 item = item->li_next;
1922 ltv.v_type = VAR_LIST;
1923 ltv.v_lock = 0;
1924 ltv.vval.v_list = l;
1925 l->lv_refcount = 1;
1927 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1928 (char_u *)"]", nextchars);
1929 clear_tv(&ltv);
1930 if (arg == NULL)
1931 return FAIL;
1932 break;
1934 else if (*arg != ',' && *arg != ']')
1936 EMSG2(_(e_intern2), "ex_let_vars()");
1937 return FAIL;
1941 return OK;
1945 * Skip over assignable variable "var" or list of variables "[var, var]".
1946 * Used for ":let varvar = expr" and ":for varvar in expr".
1947 * For "[var, var]" increment "*var_count" for each variable.
1948 * for "[var, var; var]" set "semicolon".
1949 * Return NULL for an error.
1951 static char_u *
1952 skip_var_list(arg, var_count, semicolon)
1953 char_u *arg;
1954 int *var_count;
1955 int *semicolon;
1957 char_u *p, *s;
1959 if (*arg == '[')
1961 /* "[var, var]": find the matching ']'. */
1962 p = arg;
1963 for (;;)
1965 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1966 s = skip_var_one(p);
1967 if (s == p)
1969 EMSG2(_(e_invarg2), p);
1970 return NULL;
1972 ++*var_count;
1974 p = skipwhite(s);
1975 if (*p == ']')
1976 break;
1977 else if (*p == ';')
1979 if (*semicolon == 1)
1981 EMSG(_("Double ; in list of variables"));
1982 return NULL;
1984 *semicolon = 1;
1986 else if (*p != ',')
1988 EMSG2(_(e_invarg2), p);
1989 return NULL;
1992 return p + 1;
1994 else
1995 return skip_var_one(arg);
1999 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2000 * l[idx].
2002 static char_u *
2003 skip_var_one(arg)
2004 char_u *arg;
2006 if (*arg == '@' && arg[1] != NUL)
2007 return arg + 2;
2008 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2009 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2013 * List variables for hashtab "ht" with prefix "prefix".
2014 * If "empty" is TRUE also list NULL strings as empty strings.
2016 static void
2017 list_hashtable_vars(ht, prefix, empty, first)
2018 hashtab_T *ht;
2019 char_u *prefix;
2020 int empty;
2021 int *first;
2023 hashitem_T *hi;
2024 dictitem_T *di;
2025 int todo;
2027 todo = (int)ht->ht_used;
2028 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2030 if (!HASHITEM_EMPTY(hi))
2032 --todo;
2033 di = HI2DI(hi);
2034 if (empty || di->di_tv.v_type != VAR_STRING
2035 || di->di_tv.vval.v_string != NULL)
2036 list_one_var(di, prefix, first);
2042 * List global variables.
2044 static void
2045 list_glob_vars(first)
2046 int *first;
2048 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2052 * List buffer variables.
2054 static void
2055 list_buf_vars(first)
2056 int *first;
2058 char_u numbuf[NUMBUFLEN];
2060 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2061 TRUE, first);
2063 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2064 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2065 numbuf, first);
2069 * List window variables.
2071 static void
2072 list_win_vars(first)
2073 int *first;
2075 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2076 (char_u *)"w:", TRUE, first);
2079 #ifdef FEAT_WINDOWS
2081 * List tab page variables.
2083 static void
2084 list_tab_vars(first)
2085 int *first;
2087 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2088 (char_u *)"t:", TRUE, first);
2090 #endif
2093 * List Vim variables.
2095 static void
2096 list_vim_vars(first)
2097 int *first;
2099 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2103 * List script-local variables, if there is a script.
2105 static void
2106 list_script_vars(first)
2107 int *first;
2109 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2110 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2111 (char_u *)"s:", FALSE, first);
2115 * List function variables, if there is a function.
2117 static void
2118 list_func_vars(first)
2119 int *first;
2121 if (current_funccal != NULL)
2122 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2123 (char_u *)"l:", FALSE, first);
2127 * List variables in "arg".
2129 static char_u *
2130 list_arg_vars(eap, arg, first)
2131 exarg_T *eap;
2132 char_u *arg;
2133 int *first;
2135 int error = FALSE;
2136 int len;
2137 char_u *name;
2138 char_u *name_start;
2139 char_u *arg_subsc;
2140 char_u *tofree;
2141 typval_T tv;
2143 while (!ends_excmd(*arg) && !got_int)
2145 if (error || eap->skip)
2147 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2148 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2150 emsg_severe = TRUE;
2151 EMSG(_(e_trailing));
2152 break;
2155 else
2157 /* get_name_len() takes care of expanding curly braces */
2158 name_start = name = arg;
2159 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2160 if (len <= 0)
2162 /* This is mainly to keep test 49 working: when expanding
2163 * curly braces fails overrule the exception error message. */
2164 if (len < 0 && !aborting())
2166 emsg_severe = TRUE;
2167 EMSG2(_(e_invarg2), arg);
2168 break;
2170 error = TRUE;
2172 else
2174 if (tofree != NULL)
2175 name = tofree;
2176 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2177 error = TRUE;
2178 else
2180 /* handle d.key, l[idx], f(expr) */
2181 arg_subsc = arg;
2182 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2183 error = TRUE;
2184 else
2186 if (arg == arg_subsc && len == 2 && name[1] == ':')
2188 switch (*name)
2190 case 'g': list_glob_vars(first); break;
2191 case 'b': list_buf_vars(first); break;
2192 case 'w': list_win_vars(first); break;
2193 #ifdef FEAT_WINDOWS
2194 case 't': list_tab_vars(first); break;
2195 #endif
2196 case 'v': list_vim_vars(first); break;
2197 case 's': list_script_vars(first); break;
2198 case 'l': list_func_vars(first); break;
2199 default:
2200 EMSG2(_("E738: Can't list variables for %s"), name);
2203 else
2205 char_u numbuf[NUMBUFLEN];
2206 char_u *tf;
2207 int c;
2208 char_u *s;
2210 s = echo_string(&tv, &tf, numbuf, 0);
2211 c = *arg;
2212 *arg = NUL;
2213 list_one_var_a((char_u *)"",
2214 arg == arg_subsc ? name : name_start,
2215 tv.v_type,
2216 s == NULL ? (char_u *)"" : s,
2217 first);
2218 *arg = c;
2219 vim_free(tf);
2221 clear_tv(&tv);
2226 vim_free(tofree);
2229 arg = skipwhite(arg);
2232 return arg;
2236 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2237 * Returns a pointer to the char just after the var name.
2238 * Returns NULL if there is an error.
2240 static char_u *
2241 ex_let_one(arg, tv, copy, endchars, op)
2242 char_u *arg; /* points to variable name */
2243 typval_T *tv; /* value to assign to variable */
2244 int copy; /* copy value from "tv" */
2245 char_u *endchars; /* valid chars after variable name or NULL */
2246 char_u *op; /* "+", "-", "." or NULL*/
2248 int c1;
2249 char_u *name;
2250 char_u *p;
2251 char_u *arg_end = NULL;
2252 int len;
2253 int opt_flags;
2254 char_u *tofree = NULL;
2257 * ":let $VAR = expr": Set environment variable.
2259 if (*arg == '$')
2261 /* Find the end of the name. */
2262 ++arg;
2263 name = arg;
2264 len = get_env_len(&arg);
2265 if (len == 0)
2266 EMSG2(_(e_invarg2), name - 1);
2267 else
2269 if (op != NULL && (*op == '+' || *op == '-'))
2270 EMSG2(_(e_letwrong), op);
2271 else if (endchars != NULL
2272 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2273 EMSG(_(e_letunexp));
2274 else
2276 c1 = name[len];
2277 name[len] = NUL;
2278 p = get_tv_string_chk(tv);
2279 if (p != NULL && op != NULL && *op == '.')
2281 int mustfree = FALSE;
2282 char_u *s = vim_getenv(name, &mustfree);
2284 if (s != NULL)
2286 p = tofree = concat_str(s, p);
2287 if (mustfree)
2288 vim_free(s);
2291 if (p != NULL)
2293 vim_setenv(name, p);
2294 if (STRICMP(name, "HOME") == 0)
2295 init_homedir();
2296 else if (didset_vim && STRICMP(name, "VIM") == 0)
2297 didset_vim = FALSE;
2298 else if (didset_vimruntime
2299 && STRICMP(name, "VIMRUNTIME") == 0)
2300 didset_vimruntime = FALSE;
2301 arg_end = arg;
2303 name[len] = c1;
2304 vim_free(tofree);
2310 * ":let &option = expr": Set option value.
2311 * ":let &l:option = expr": Set local option value.
2312 * ":let &g:option = expr": Set global option value.
2314 else if (*arg == '&')
2316 /* Find the end of the name. */
2317 p = find_option_end(&arg, &opt_flags);
2318 if (p == NULL || (endchars != NULL
2319 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2320 EMSG(_(e_letunexp));
2321 else
2323 long n;
2324 int opt_type;
2325 long numval;
2326 char_u *stringval = NULL;
2327 char_u *s;
2329 c1 = *p;
2330 *p = NUL;
2332 n = get_tv_number(tv);
2333 s = get_tv_string_chk(tv); /* != NULL if number or string */
2334 if (s != NULL && op != NULL && *op != '=')
2336 opt_type = get_option_value(arg, &numval,
2337 &stringval, opt_flags);
2338 if ((opt_type == 1 && *op == '.')
2339 || (opt_type == 0 && *op != '.'))
2340 EMSG2(_(e_letwrong), op);
2341 else
2343 if (opt_type == 1) /* number */
2345 if (*op == '+')
2346 n = numval + n;
2347 else
2348 n = numval - n;
2350 else if (opt_type == 0 && stringval != NULL) /* string */
2352 s = concat_str(stringval, s);
2353 vim_free(stringval);
2354 stringval = s;
2358 if (s != NULL)
2360 set_option_value(arg, n, s, opt_flags);
2361 arg_end = p;
2363 *p = c1;
2364 vim_free(stringval);
2369 * ":let @r = expr": Set register contents.
2371 else if (*arg == '@')
2373 ++arg;
2374 if (op != NULL && (*op == '+' || *op == '-'))
2375 EMSG2(_(e_letwrong), op);
2376 else if (endchars != NULL
2377 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2378 EMSG(_(e_letunexp));
2379 else
2381 char_u *ptofree = NULL;
2382 char_u *s;
2384 p = get_tv_string_chk(tv);
2385 if (p != NULL && op != NULL && *op == '.')
2387 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2388 if (s != NULL)
2390 p = ptofree = concat_str(s, p);
2391 vim_free(s);
2394 if (p != NULL)
2396 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2397 arg_end = arg + 1;
2399 vim_free(ptofree);
2404 * ":let var = expr": Set internal variable.
2405 * ":let {expr} = expr": Idem, name made with curly braces
2407 else if (eval_isnamec1(*arg) || *arg == '{')
2409 lval_T lv;
2411 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2412 if (p != NULL && lv.ll_name != NULL)
2414 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2415 EMSG(_(e_letunexp));
2416 else
2418 set_var_lval(&lv, p, tv, copy, op);
2419 arg_end = p;
2422 clear_lval(&lv);
2425 else
2426 EMSG2(_(e_invarg2), arg);
2428 return arg_end;
2432 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2434 static int
2435 check_changedtick(arg)
2436 char_u *arg;
2438 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2440 EMSG2(_(e_readonlyvar), arg);
2441 return TRUE;
2443 return FALSE;
2447 * Get an lval: variable, Dict item or List item that can be assigned a value
2448 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2449 * "name.key", "name.key[expr]" etc.
2450 * Indexing only works if "name" is an existing List or Dictionary.
2451 * "name" points to the start of the name.
2452 * If "rettv" is not NULL it points to the value to be assigned.
2453 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2454 * wrong; must end in space or cmd separator.
2456 * Returns a pointer to just after the name, including indexes.
2457 * When an evaluation error occurs "lp->ll_name" is NULL;
2458 * Returns NULL for a parsing error. Still need to free items in "lp"!
2460 static char_u *
2461 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2462 char_u *name;
2463 typval_T *rettv;
2464 lval_T *lp;
2465 int unlet;
2466 int skip;
2467 int quiet; /* don't give error messages */
2468 int fne_flags; /* flags for find_name_end() */
2470 char_u *p;
2471 char_u *expr_start, *expr_end;
2472 int cc;
2473 dictitem_T *v;
2474 typval_T var1;
2475 typval_T var2;
2476 int empty1 = FALSE;
2477 listitem_T *ni;
2478 char_u *key = NULL;
2479 int len;
2480 hashtab_T *ht;
2482 /* Clear everything in "lp". */
2483 vim_memset(lp, 0, sizeof(lval_T));
2485 if (skip)
2487 /* When skipping just find the end of the name. */
2488 lp->ll_name = name;
2489 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2492 /* Find the end of the name. */
2493 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2494 if (expr_start != NULL)
2496 /* Don't expand the name when we already know there is an error. */
2497 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2498 && *p != '[' && *p != '.')
2500 EMSG(_(e_trailing));
2501 return NULL;
2504 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2505 if (lp->ll_exp_name == NULL)
2507 /* Report an invalid expression in braces, unless the
2508 * expression evaluation has been cancelled due to an
2509 * aborting error, an interrupt, or an exception. */
2510 if (!aborting() && !quiet)
2512 emsg_severe = TRUE;
2513 EMSG2(_(e_invarg2), name);
2514 return NULL;
2517 lp->ll_name = lp->ll_exp_name;
2519 else
2520 lp->ll_name = name;
2522 /* Without [idx] or .key we are done. */
2523 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2524 return p;
2526 cc = *p;
2527 *p = NUL;
2528 v = find_var(lp->ll_name, &ht);
2529 if (v == NULL && !quiet)
2530 EMSG2(_(e_undefvar), lp->ll_name);
2531 *p = cc;
2532 if (v == NULL)
2533 return NULL;
2536 * Loop until no more [idx] or .key is following.
2538 lp->ll_tv = &v->di_tv;
2539 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2541 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2542 && !(lp->ll_tv->v_type == VAR_DICT
2543 && lp->ll_tv->vval.v_dict != NULL))
2545 if (!quiet)
2546 EMSG(_("E689: Can only index a List or Dictionary"));
2547 return NULL;
2549 if (lp->ll_range)
2551 if (!quiet)
2552 EMSG(_("E708: [:] must come last"));
2553 return NULL;
2556 len = -1;
2557 if (*p == '.')
2559 key = p + 1;
2560 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2562 if (len == 0)
2564 if (!quiet)
2565 EMSG(_(e_emptykey));
2566 return NULL;
2568 p = key + len;
2570 else
2572 /* Get the index [expr] or the first index [expr: ]. */
2573 p = skipwhite(p + 1);
2574 if (*p == ':')
2575 empty1 = TRUE;
2576 else
2578 empty1 = FALSE;
2579 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2580 return NULL;
2581 if (get_tv_string_chk(&var1) == NULL)
2583 /* not a number or string */
2584 clear_tv(&var1);
2585 return NULL;
2589 /* Optionally get the second index [ :expr]. */
2590 if (*p == ':')
2592 if (lp->ll_tv->v_type == VAR_DICT)
2594 if (!quiet)
2595 EMSG(_(e_dictrange));
2596 if (!empty1)
2597 clear_tv(&var1);
2598 return NULL;
2600 if (rettv != NULL && (rettv->v_type != VAR_LIST
2601 || rettv->vval.v_list == NULL))
2603 if (!quiet)
2604 EMSG(_("E709: [:] requires a List value"));
2605 if (!empty1)
2606 clear_tv(&var1);
2607 return NULL;
2609 p = skipwhite(p + 1);
2610 if (*p == ']')
2611 lp->ll_empty2 = TRUE;
2612 else
2614 lp->ll_empty2 = FALSE;
2615 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2617 if (!empty1)
2618 clear_tv(&var1);
2619 return NULL;
2621 if (get_tv_string_chk(&var2) == NULL)
2623 /* not a number or string */
2624 if (!empty1)
2625 clear_tv(&var1);
2626 clear_tv(&var2);
2627 return NULL;
2630 lp->ll_range = TRUE;
2632 else
2633 lp->ll_range = FALSE;
2635 if (*p != ']')
2637 if (!quiet)
2638 EMSG(_(e_missbrac));
2639 if (!empty1)
2640 clear_tv(&var1);
2641 if (lp->ll_range && !lp->ll_empty2)
2642 clear_tv(&var2);
2643 return NULL;
2646 /* Skip to past ']'. */
2647 ++p;
2650 if (lp->ll_tv->v_type == VAR_DICT)
2652 if (len == -1)
2654 /* "[key]": get key from "var1" */
2655 key = get_tv_string(&var1); /* is number or string */
2656 if (*key == NUL)
2658 if (!quiet)
2659 EMSG(_(e_emptykey));
2660 clear_tv(&var1);
2661 return NULL;
2664 lp->ll_list = NULL;
2665 lp->ll_dict = lp->ll_tv->vval.v_dict;
2666 lp->ll_di = dict_find(lp->ll_dict, key, len);
2667 if (lp->ll_di == NULL)
2669 /* Key does not exist in dict: may need to add it. */
2670 if (*p == '[' || *p == '.' || unlet)
2672 if (!quiet)
2673 EMSG2(_(e_dictkey), key);
2674 if (len == -1)
2675 clear_tv(&var1);
2676 return NULL;
2678 if (len == -1)
2679 lp->ll_newkey = vim_strsave(key);
2680 else
2681 lp->ll_newkey = vim_strnsave(key, len);
2682 if (len == -1)
2683 clear_tv(&var1);
2684 if (lp->ll_newkey == NULL)
2685 p = NULL;
2686 break;
2688 if (len == -1)
2689 clear_tv(&var1);
2690 lp->ll_tv = &lp->ll_di->di_tv;
2692 else
2695 * Get the number and item for the only or first index of the List.
2697 if (empty1)
2698 lp->ll_n1 = 0;
2699 else
2701 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2702 clear_tv(&var1);
2704 lp->ll_dict = NULL;
2705 lp->ll_list = lp->ll_tv->vval.v_list;
2706 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2707 if (lp->ll_li == NULL)
2709 if (lp->ll_n1 < 0)
2711 lp->ll_n1 = 0;
2712 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2715 if (lp->ll_li == NULL)
2717 if (lp->ll_range && !lp->ll_empty2)
2718 clear_tv(&var2);
2719 return NULL;
2723 * May need to find the item or absolute index for the second
2724 * index of a range.
2725 * When no index given: "lp->ll_empty2" is TRUE.
2726 * Otherwise "lp->ll_n2" is set to the second index.
2728 if (lp->ll_range && !lp->ll_empty2)
2730 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2731 clear_tv(&var2);
2732 if (lp->ll_n2 < 0)
2734 ni = list_find(lp->ll_list, lp->ll_n2);
2735 if (ni == NULL)
2736 return NULL;
2737 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2740 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2741 if (lp->ll_n1 < 0)
2742 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2743 if (lp->ll_n2 < lp->ll_n1)
2744 return NULL;
2747 lp->ll_tv = &lp->ll_li->li_tv;
2751 return p;
2755 * Clear lval "lp" that was filled by get_lval().
2757 static void
2758 clear_lval(lp)
2759 lval_T *lp;
2761 vim_free(lp->ll_exp_name);
2762 vim_free(lp->ll_newkey);
2766 * Set a variable that was parsed by get_lval() to "rettv".
2767 * "endp" points to just after the parsed name.
2768 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2770 static void
2771 set_var_lval(lp, endp, rettv, copy, op)
2772 lval_T *lp;
2773 char_u *endp;
2774 typval_T *rettv;
2775 int copy;
2776 char_u *op;
2778 int cc;
2779 listitem_T *ri;
2780 dictitem_T *di;
2782 if (lp->ll_tv == NULL)
2784 if (!check_changedtick(lp->ll_name))
2786 cc = *endp;
2787 *endp = NUL;
2788 if (op != NULL && *op != '=')
2790 typval_T tv;
2792 /* handle +=, -= and .= */
2793 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2794 &tv, TRUE) == OK)
2796 if (tv_op(&tv, rettv, op) == OK)
2797 set_var(lp->ll_name, &tv, FALSE);
2798 clear_tv(&tv);
2801 else
2802 set_var(lp->ll_name, rettv, copy);
2803 *endp = cc;
2806 else if (tv_check_lock(lp->ll_newkey == NULL
2807 ? lp->ll_tv->v_lock
2808 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2810 else if (lp->ll_range)
2813 * Assign the List values to the list items.
2815 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2817 if (op != NULL && *op != '=')
2818 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2819 else
2821 clear_tv(&lp->ll_li->li_tv);
2822 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2824 ri = ri->li_next;
2825 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2826 break;
2827 if (lp->ll_li->li_next == NULL)
2829 /* Need to add an empty item. */
2830 if (list_append_number(lp->ll_list, 0) == FAIL)
2832 ri = NULL;
2833 break;
2836 lp->ll_li = lp->ll_li->li_next;
2837 ++lp->ll_n1;
2839 if (ri != NULL)
2840 EMSG(_("E710: List value has more items than target"));
2841 else if (lp->ll_empty2
2842 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2843 : lp->ll_n1 != lp->ll_n2)
2844 EMSG(_("E711: List value has not enough items"));
2846 else
2849 * Assign to a List or Dictionary item.
2851 if (lp->ll_newkey != NULL)
2853 if (op != NULL && *op != '=')
2855 EMSG2(_(e_letwrong), op);
2856 return;
2859 /* Need to add an item to the Dictionary. */
2860 di = dictitem_alloc(lp->ll_newkey);
2861 if (di == NULL)
2862 return;
2863 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2865 vim_free(di);
2866 return;
2868 lp->ll_tv = &di->di_tv;
2870 else if (op != NULL && *op != '=')
2872 tv_op(lp->ll_tv, rettv, op);
2873 return;
2875 else
2876 clear_tv(lp->ll_tv);
2879 * Assign the value to the variable or list item.
2881 if (copy)
2882 copy_tv(rettv, lp->ll_tv);
2883 else
2885 *lp->ll_tv = *rettv;
2886 lp->ll_tv->v_lock = 0;
2887 init_tv(rettv);
2893 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2894 * Returns OK or FAIL.
2896 static int
2897 tv_op(tv1, tv2, op)
2898 typval_T *tv1;
2899 typval_T *tv2;
2900 char_u *op;
2902 long n;
2903 char_u numbuf[NUMBUFLEN];
2904 char_u *s;
2906 /* Can't do anything with a Funcref or a Dict on the right. */
2907 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2909 switch (tv1->v_type)
2911 case VAR_DICT:
2912 case VAR_FUNC:
2913 break;
2915 case VAR_LIST:
2916 if (*op != '+' || tv2->v_type != VAR_LIST)
2917 break;
2918 /* List += List */
2919 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2920 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2921 return OK;
2923 case VAR_NUMBER:
2924 case VAR_STRING:
2925 if (tv2->v_type == VAR_LIST)
2926 break;
2927 if (*op == '+' || *op == '-')
2929 /* nr += nr or nr -= nr*/
2930 n = get_tv_number(tv1);
2931 #ifdef FEAT_FLOAT
2932 if (tv2->v_type == VAR_FLOAT)
2934 float_T f = n;
2936 if (*op == '+')
2937 f += tv2->vval.v_float;
2938 else
2939 f -= tv2->vval.v_float;
2940 clear_tv(tv1);
2941 tv1->v_type = VAR_FLOAT;
2942 tv1->vval.v_float = f;
2944 else
2945 #endif
2947 if (*op == '+')
2948 n += get_tv_number(tv2);
2949 else
2950 n -= get_tv_number(tv2);
2951 clear_tv(tv1);
2952 tv1->v_type = VAR_NUMBER;
2953 tv1->vval.v_number = n;
2956 else
2958 if (tv2->v_type == VAR_FLOAT)
2959 break;
2961 /* str .= str */
2962 s = get_tv_string(tv1);
2963 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2964 clear_tv(tv1);
2965 tv1->v_type = VAR_STRING;
2966 tv1->vval.v_string = s;
2968 return OK;
2970 #ifdef FEAT_FLOAT
2971 case VAR_FLOAT:
2973 float_T f;
2975 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2976 && tv2->v_type != VAR_NUMBER
2977 && tv2->v_type != VAR_STRING))
2978 break;
2979 if (tv2->v_type == VAR_FLOAT)
2980 f = tv2->vval.v_float;
2981 else
2982 f = get_tv_number(tv2);
2983 if (*op == '+')
2984 tv1->vval.v_float += f;
2985 else
2986 tv1->vval.v_float -= f;
2988 return OK;
2989 #endif
2993 EMSG2(_(e_letwrong), op);
2994 return FAIL;
2998 * Add a watcher to a list.
3000 static void
3001 list_add_watch(l, lw)
3002 list_T *l;
3003 listwatch_T *lw;
3005 lw->lw_next = l->lv_watch;
3006 l->lv_watch = lw;
3010 * Remove a watcher from a list.
3011 * No warning when it isn't found...
3013 static void
3014 list_rem_watch(l, lwrem)
3015 list_T *l;
3016 listwatch_T *lwrem;
3018 listwatch_T *lw, **lwp;
3020 lwp = &l->lv_watch;
3021 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3023 if (lw == lwrem)
3025 *lwp = lw->lw_next;
3026 break;
3028 lwp = &lw->lw_next;
3033 * Just before removing an item from a list: advance watchers to the next
3034 * item.
3036 static void
3037 list_fix_watch(l, item)
3038 list_T *l;
3039 listitem_T *item;
3041 listwatch_T *lw;
3043 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3044 if (lw->lw_item == item)
3045 lw->lw_item = item->li_next;
3049 * Evaluate the expression used in a ":for var in expr" command.
3050 * "arg" points to "var".
3051 * Set "*errp" to TRUE for an error, FALSE otherwise;
3052 * Return a pointer that holds the info. Null when there is an error.
3054 void *
3055 eval_for_line(arg, errp, nextcmdp, skip)
3056 char_u *arg;
3057 int *errp;
3058 char_u **nextcmdp;
3059 int skip;
3061 forinfo_T *fi;
3062 char_u *expr;
3063 typval_T tv;
3064 list_T *l;
3066 *errp = TRUE; /* default: there is an error */
3068 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3069 if (fi == NULL)
3070 return NULL;
3072 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3073 if (expr == NULL)
3074 return fi;
3076 expr = skipwhite(expr);
3077 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3079 EMSG(_("E690: Missing \"in\" after :for"));
3080 return fi;
3083 if (skip)
3084 ++emsg_skip;
3085 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3087 *errp = FALSE;
3088 if (!skip)
3090 l = tv.vval.v_list;
3091 if (tv.v_type != VAR_LIST || l == NULL)
3093 EMSG(_(e_listreq));
3094 clear_tv(&tv);
3096 else
3098 /* No need to increment the refcount, it's already set for the
3099 * list being used in "tv". */
3100 fi->fi_list = l;
3101 list_add_watch(l, &fi->fi_lw);
3102 fi->fi_lw.lw_item = l->lv_first;
3106 if (skip)
3107 --emsg_skip;
3109 return fi;
3113 * Use the first item in a ":for" list. Advance to the next.
3114 * Assign the values to the variable (list). "arg" points to the first one.
3115 * Return TRUE when a valid item was found, FALSE when at end of list or
3116 * something wrong.
3119 next_for_item(fi_void, arg)
3120 void *fi_void;
3121 char_u *arg;
3123 forinfo_T *fi = (forinfo_T *)fi_void;
3124 int result;
3125 listitem_T *item;
3127 item = fi->fi_lw.lw_item;
3128 if (item == NULL)
3129 result = FALSE;
3130 else
3132 fi->fi_lw.lw_item = item->li_next;
3133 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3134 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3136 return result;
3140 * Free the structure used to store info used by ":for".
3142 void
3143 free_for_info(fi_void)
3144 void *fi_void;
3146 forinfo_T *fi = (forinfo_T *)fi_void;
3148 if (fi != NULL && fi->fi_list != NULL)
3150 list_rem_watch(fi->fi_list, &fi->fi_lw);
3151 list_unref(fi->fi_list);
3153 vim_free(fi);
3156 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3158 void
3159 set_context_for_expression(xp, arg, cmdidx)
3160 expand_T *xp;
3161 char_u *arg;
3162 cmdidx_T cmdidx;
3164 int got_eq = FALSE;
3165 int c;
3166 char_u *p;
3168 if (cmdidx == CMD_let)
3170 xp->xp_context = EXPAND_USER_VARS;
3171 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3173 /* ":let var1 var2 ...": find last space. */
3174 for (p = arg + STRLEN(arg); p >= arg; )
3176 xp->xp_pattern = p;
3177 mb_ptr_back(arg, p);
3178 if (vim_iswhite(*p))
3179 break;
3181 return;
3184 else
3185 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3186 : EXPAND_EXPRESSION;
3187 while ((xp->xp_pattern = vim_strpbrk(arg,
3188 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3190 c = *xp->xp_pattern;
3191 if (c == '&')
3193 c = xp->xp_pattern[1];
3194 if (c == '&')
3196 ++xp->xp_pattern;
3197 xp->xp_context = cmdidx != CMD_let || got_eq
3198 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3200 else if (c != ' ')
3202 xp->xp_context = EXPAND_SETTINGS;
3203 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3204 xp->xp_pattern += 2;
3208 else if (c == '$')
3210 /* environment variable */
3211 xp->xp_context = EXPAND_ENV_VARS;
3213 else if (c == '=')
3215 got_eq = TRUE;
3216 xp->xp_context = EXPAND_EXPRESSION;
3218 else if (c == '<'
3219 && xp->xp_context == EXPAND_FUNCTIONS
3220 && vim_strchr(xp->xp_pattern, '(') == NULL)
3222 /* Function name can start with "<SNR>" */
3223 break;
3225 else if (cmdidx != CMD_let || got_eq)
3227 if (c == '"') /* string */
3229 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3230 if (c == '\\' && xp->xp_pattern[1] != NUL)
3231 ++xp->xp_pattern;
3232 xp->xp_context = EXPAND_NOTHING;
3234 else if (c == '\'') /* literal string */
3236 /* Trick: '' is like stopping and starting a literal string. */
3237 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3238 /* skip */ ;
3239 xp->xp_context = EXPAND_NOTHING;
3241 else if (c == '|')
3243 if (xp->xp_pattern[1] == '|')
3245 ++xp->xp_pattern;
3246 xp->xp_context = EXPAND_EXPRESSION;
3248 else
3249 xp->xp_context = EXPAND_COMMANDS;
3251 else
3252 xp->xp_context = EXPAND_EXPRESSION;
3254 else
3255 /* Doesn't look like something valid, expand as an expression
3256 * anyway. */
3257 xp->xp_context = EXPAND_EXPRESSION;
3258 arg = xp->xp_pattern;
3259 if (*arg != NUL)
3260 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3261 /* skip */ ;
3263 xp->xp_pattern = arg;
3266 #endif /* FEAT_CMDL_COMPL */
3269 * ":1,25call func(arg1, arg2)" function call.
3271 void
3272 ex_call(eap)
3273 exarg_T *eap;
3275 char_u *arg = eap->arg;
3276 char_u *startarg;
3277 char_u *name;
3278 char_u *tofree;
3279 int len;
3280 typval_T rettv;
3281 linenr_T lnum;
3282 int doesrange;
3283 int failed = FALSE;
3284 funcdict_T fudi;
3286 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3287 if (fudi.fd_newkey != NULL)
3289 /* Still need to give an error message for missing key. */
3290 EMSG2(_(e_dictkey), fudi.fd_newkey);
3291 vim_free(fudi.fd_newkey);
3293 if (tofree == NULL)
3294 return;
3296 /* Increase refcount on dictionary, it could get deleted when evaluating
3297 * the arguments. */
3298 if (fudi.fd_dict != NULL)
3299 ++fudi.fd_dict->dv_refcount;
3301 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3302 len = (int)STRLEN(tofree);
3303 name = deref_func_name(tofree, &len);
3305 /* Skip white space to allow ":call func ()". Not good, but required for
3306 * backward compatibility. */
3307 startarg = skipwhite(arg);
3308 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3310 if (*startarg != '(')
3312 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3313 goto end;
3317 * When skipping, evaluate the function once, to find the end of the
3318 * arguments.
3319 * When the function takes a range, this is discovered after the first
3320 * call, and the loop is broken.
3322 if (eap->skip)
3324 ++emsg_skip;
3325 lnum = eap->line2; /* do it once, also with an invalid range */
3327 else
3328 lnum = eap->line1;
3329 for ( ; lnum <= eap->line2; ++lnum)
3331 if (!eap->skip && eap->addr_count > 0)
3333 curwin->w_cursor.lnum = lnum;
3334 curwin->w_cursor.col = 0;
3336 arg = startarg;
3337 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3338 eap->line1, eap->line2, &doesrange,
3339 !eap->skip, fudi.fd_dict) == FAIL)
3341 failed = TRUE;
3342 break;
3345 /* Handle a function returning a Funcref, Dictionary or List. */
3346 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3348 failed = TRUE;
3349 break;
3352 clear_tv(&rettv);
3353 if (doesrange || eap->skip)
3354 break;
3356 /* Stop when immediately aborting on error, or when an interrupt
3357 * occurred or an exception was thrown but not caught.
3358 * get_func_tv() returned OK, so that the check for trailing
3359 * characters below is executed. */
3360 if (aborting())
3361 break;
3363 if (eap->skip)
3364 --emsg_skip;
3366 if (!failed)
3368 /* Check for trailing illegal characters and a following command. */
3369 if (!ends_excmd(*arg))
3371 emsg_severe = TRUE;
3372 EMSG(_(e_trailing));
3374 else
3375 eap->nextcmd = check_nextcmd(arg);
3378 end:
3379 dict_unref(fudi.fd_dict);
3380 vim_free(tofree);
3384 * ":unlet[!] var1 ... " command.
3386 void
3387 ex_unlet(eap)
3388 exarg_T *eap;
3390 ex_unletlock(eap, eap->arg, 0);
3394 * ":lockvar" and ":unlockvar" commands
3396 void
3397 ex_lockvar(eap)
3398 exarg_T *eap;
3400 char_u *arg = eap->arg;
3401 int deep = 2;
3403 if (eap->forceit)
3404 deep = -1;
3405 else if (vim_isdigit(*arg))
3407 deep = getdigits(&arg);
3408 arg = skipwhite(arg);
3411 ex_unletlock(eap, arg, deep);
3415 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3417 static void
3418 ex_unletlock(eap, argstart, deep)
3419 exarg_T *eap;
3420 char_u *argstart;
3421 int deep;
3423 char_u *arg = argstart;
3424 char_u *name_end;
3425 int error = FALSE;
3426 lval_T lv;
3430 /* Parse the name and find the end. */
3431 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3432 FNE_CHECK_START);
3433 if (lv.ll_name == NULL)
3434 error = TRUE; /* error but continue parsing */
3435 if (name_end == NULL || (!vim_iswhite(*name_end)
3436 && !ends_excmd(*name_end)))
3438 if (name_end != NULL)
3440 emsg_severe = TRUE;
3441 EMSG(_(e_trailing));
3443 if (!(eap->skip || error))
3444 clear_lval(&lv);
3445 break;
3448 if (!error && !eap->skip)
3450 if (eap->cmdidx == CMD_unlet)
3452 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3453 error = TRUE;
3455 else
3457 if (do_lock_var(&lv, name_end, deep,
3458 eap->cmdidx == CMD_lockvar) == FAIL)
3459 error = TRUE;
3463 if (!eap->skip)
3464 clear_lval(&lv);
3466 arg = skipwhite(name_end);
3467 } while (!ends_excmd(*arg));
3469 eap->nextcmd = check_nextcmd(arg);
3472 static int
3473 do_unlet_var(lp, name_end, forceit)
3474 lval_T *lp;
3475 char_u *name_end;
3476 int forceit;
3478 int ret = OK;
3479 int cc;
3481 if (lp->ll_tv == NULL)
3483 cc = *name_end;
3484 *name_end = NUL;
3486 /* Normal name or expanded name. */
3487 if (check_changedtick(lp->ll_name))
3488 ret = FAIL;
3489 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3490 ret = FAIL;
3491 *name_end = cc;
3493 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3494 return FAIL;
3495 else if (lp->ll_range)
3497 listitem_T *li;
3499 /* Delete a range of List items. */
3500 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3502 li = lp->ll_li->li_next;
3503 listitem_remove(lp->ll_list, lp->ll_li);
3504 lp->ll_li = li;
3505 ++lp->ll_n1;
3508 else
3510 if (lp->ll_list != NULL)
3511 /* unlet a List item. */
3512 listitem_remove(lp->ll_list, lp->ll_li);
3513 else
3514 /* unlet a Dictionary item. */
3515 dictitem_remove(lp->ll_dict, lp->ll_di);
3518 return ret;
3522 * "unlet" a variable. Return OK if it existed, FAIL if not.
3523 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3526 do_unlet(name, forceit)
3527 char_u *name;
3528 int forceit;
3530 hashtab_T *ht;
3531 hashitem_T *hi;
3532 char_u *varname;
3533 dictitem_T *di;
3535 ht = find_var_ht(name, &varname);
3536 if (ht != NULL && *varname != NUL)
3538 hi = hash_find(ht, varname);
3539 if (!HASHITEM_EMPTY(hi))
3541 di = HI2DI(hi);
3542 if (var_check_fixed(di->di_flags, name)
3543 || var_check_ro(di->di_flags, name))
3544 return FAIL;
3545 delete_var(ht, hi);
3546 return OK;
3549 if (forceit)
3550 return OK;
3551 EMSG2(_("E108: No such variable: \"%s\""), name);
3552 return FAIL;
3556 * Lock or unlock variable indicated by "lp".
3557 * "deep" is the levels to go (-1 for unlimited);
3558 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3560 static int
3561 do_lock_var(lp, name_end, deep, lock)
3562 lval_T *lp;
3563 char_u *name_end;
3564 int deep;
3565 int lock;
3567 int ret = OK;
3568 int cc;
3569 dictitem_T *di;
3571 if (deep == 0) /* nothing to do */
3572 return OK;
3574 if (lp->ll_tv == NULL)
3576 cc = *name_end;
3577 *name_end = NUL;
3579 /* Normal name or expanded name. */
3580 if (check_changedtick(lp->ll_name))
3581 ret = FAIL;
3582 else
3584 di = find_var(lp->ll_name, NULL);
3585 if (di == NULL)
3586 ret = FAIL;
3587 else
3589 if (lock)
3590 di->di_flags |= DI_FLAGS_LOCK;
3591 else
3592 di->di_flags &= ~DI_FLAGS_LOCK;
3593 item_lock(&di->di_tv, deep, lock);
3596 *name_end = cc;
3598 else if (lp->ll_range)
3600 listitem_T *li = lp->ll_li;
3602 /* (un)lock a range of List items. */
3603 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3605 item_lock(&li->li_tv, deep, lock);
3606 li = li->li_next;
3607 ++lp->ll_n1;
3610 else if (lp->ll_list != NULL)
3611 /* (un)lock a List item. */
3612 item_lock(&lp->ll_li->li_tv, deep, lock);
3613 else
3614 /* un(lock) a Dictionary item. */
3615 item_lock(&lp->ll_di->di_tv, deep, lock);
3617 return ret;
3621 * Lock or unlock an item. "deep" is nr of levels to go.
3623 static void
3624 item_lock(tv, deep, lock)
3625 typval_T *tv;
3626 int deep;
3627 int lock;
3629 static int recurse = 0;
3630 list_T *l;
3631 listitem_T *li;
3632 dict_T *d;
3633 hashitem_T *hi;
3634 int todo;
3636 if (recurse >= DICT_MAXNEST)
3638 EMSG(_("E743: variable nested too deep for (un)lock"));
3639 return;
3641 if (deep == 0)
3642 return;
3643 ++recurse;
3645 /* lock/unlock the item itself */
3646 if (lock)
3647 tv->v_lock |= VAR_LOCKED;
3648 else
3649 tv->v_lock &= ~VAR_LOCKED;
3651 switch (tv->v_type)
3653 case VAR_LIST:
3654 if ((l = tv->vval.v_list) != NULL)
3656 if (lock)
3657 l->lv_lock |= VAR_LOCKED;
3658 else
3659 l->lv_lock &= ~VAR_LOCKED;
3660 if (deep < 0 || deep > 1)
3661 /* recursive: lock/unlock the items the List contains */
3662 for (li = l->lv_first; li != NULL; li = li->li_next)
3663 item_lock(&li->li_tv, deep - 1, lock);
3665 break;
3666 case VAR_DICT:
3667 if ((d = tv->vval.v_dict) != NULL)
3669 if (lock)
3670 d->dv_lock |= VAR_LOCKED;
3671 else
3672 d->dv_lock &= ~VAR_LOCKED;
3673 if (deep < 0 || deep > 1)
3675 /* recursive: lock/unlock the items the List contains */
3676 todo = (int)d->dv_hashtab.ht_used;
3677 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3679 if (!HASHITEM_EMPTY(hi))
3681 --todo;
3682 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3688 --recurse;
3692 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3693 * or it refers to a List or Dictionary that is locked.
3695 static int
3696 tv_islocked(tv)
3697 typval_T *tv;
3699 return (tv->v_lock & VAR_LOCKED)
3700 || (tv->v_type == VAR_LIST
3701 && tv->vval.v_list != NULL
3702 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3703 || (tv->v_type == VAR_DICT
3704 && tv->vval.v_dict != NULL
3705 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3708 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3710 * Delete all "menutrans_" variables.
3712 void
3713 del_menutrans_vars()
3715 hashitem_T *hi;
3716 int todo;
3718 hash_lock(&globvarht);
3719 todo = (int)globvarht.ht_used;
3720 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3722 if (!HASHITEM_EMPTY(hi))
3724 --todo;
3725 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3726 delete_var(&globvarht, hi);
3729 hash_unlock(&globvarht);
3731 #endif
3733 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3736 * Local string buffer for the next two functions to store a variable name
3737 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3738 * get_user_var_name().
3741 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3743 static char_u *varnamebuf = NULL;
3744 static int varnamebuflen = 0;
3747 * Function to concatenate a prefix and a variable name.
3749 static char_u *
3750 cat_prefix_varname(prefix, name)
3751 int prefix;
3752 char_u *name;
3754 int len;
3756 len = (int)STRLEN(name) + 3;
3757 if (len > varnamebuflen)
3759 vim_free(varnamebuf);
3760 len += 10; /* some additional space */
3761 varnamebuf = alloc(len);
3762 if (varnamebuf == NULL)
3764 varnamebuflen = 0;
3765 return NULL;
3767 varnamebuflen = len;
3769 *varnamebuf = prefix;
3770 varnamebuf[1] = ':';
3771 STRCPY(varnamebuf + 2, name);
3772 return varnamebuf;
3776 * Function given to ExpandGeneric() to obtain the list of user defined
3777 * (global/buffer/window/built-in) variable names.
3779 char_u *
3780 get_user_var_name(xp, idx)
3781 expand_T *xp;
3782 int idx;
3784 static long_u gdone;
3785 static long_u bdone;
3786 static long_u wdone;
3787 #ifdef FEAT_WINDOWS
3788 static long_u tdone;
3789 #endif
3790 static int vidx;
3791 static hashitem_T *hi;
3792 hashtab_T *ht;
3794 if (idx == 0)
3796 gdone = bdone = wdone = vidx = 0;
3797 #ifdef FEAT_WINDOWS
3798 tdone = 0;
3799 #endif
3802 /* Global variables */
3803 if (gdone < globvarht.ht_used)
3805 if (gdone++ == 0)
3806 hi = globvarht.ht_array;
3807 else
3808 ++hi;
3809 while (HASHITEM_EMPTY(hi))
3810 ++hi;
3811 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3812 return cat_prefix_varname('g', hi->hi_key);
3813 return hi->hi_key;
3816 /* b: variables */
3817 ht = &curbuf->b_vars.dv_hashtab;
3818 if (bdone < ht->ht_used)
3820 if (bdone++ == 0)
3821 hi = ht->ht_array;
3822 else
3823 ++hi;
3824 while (HASHITEM_EMPTY(hi))
3825 ++hi;
3826 return cat_prefix_varname('b', hi->hi_key);
3828 if (bdone == ht->ht_used)
3830 ++bdone;
3831 return (char_u *)"b:changedtick";
3834 /* w: variables */
3835 ht = &curwin->w_vars.dv_hashtab;
3836 if (wdone < ht->ht_used)
3838 if (wdone++ == 0)
3839 hi = ht->ht_array;
3840 else
3841 ++hi;
3842 while (HASHITEM_EMPTY(hi))
3843 ++hi;
3844 return cat_prefix_varname('w', hi->hi_key);
3847 #ifdef FEAT_WINDOWS
3848 /* t: variables */
3849 ht = &curtab->tp_vars.dv_hashtab;
3850 if (tdone < ht->ht_used)
3852 if (tdone++ == 0)
3853 hi = ht->ht_array;
3854 else
3855 ++hi;
3856 while (HASHITEM_EMPTY(hi))
3857 ++hi;
3858 return cat_prefix_varname('t', hi->hi_key);
3860 #endif
3862 /* v: variables */
3863 if (vidx < VV_LEN)
3864 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3866 vim_free(varnamebuf);
3867 varnamebuf = NULL;
3868 varnamebuflen = 0;
3869 return NULL;
3872 #endif /* FEAT_CMDL_COMPL */
3875 * types for expressions.
3877 typedef enum
3879 TYPE_UNKNOWN = 0
3880 , TYPE_EQUAL /* == */
3881 , TYPE_NEQUAL /* != */
3882 , TYPE_GREATER /* > */
3883 , TYPE_GEQUAL /* >= */
3884 , TYPE_SMALLER /* < */
3885 , TYPE_SEQUAL /* <= */
3886 , TYPE_MATCH /* =~ */
3887 , TYPE_NOMATCH /* !~ */
3888 } exptype_T;
3891 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3892 * executed. The function may return OK, but the rettv will be of type
3893 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3897 * Handle zero level expression.
3898 * This calls eval1() and handles error message and nextcmd.
3899 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3900 * Note: "rettv.v_lock" is not set.
3901 * Return OK or FAIL.
3903 static int
3904 eval0(arg, rettv, nextcmd, evaluate)
3905 char_u *arg;
3906 typval_T *rettv;
3907 char_u **nextcmd;
3908 int evaluate;
3910 int ret;
3911 char_u *p;
3913 p = skipwhite(arg);
3914 ret = eval1(&p, rettv, evaluate);
3915 if (ret == FAIL || !ends_excmd(*p))
3917 if (ret != FAIL)
3918 clear_tv(rettv);
3920 * Report the invalid expression unless the expression evaluation has
3921 * been cancelled due to an aborting error, an interrupt, or an
3922 * exception.
3924 if (!aborting())
3925 EMSG2(_(e_invexpr2), arg);
3926 ret = FAIL;
3928 if (nextcmd != NULL)
3929 *nextcmd = check_nextcmd(p);
3931 return ret;
3935 * Handle top level expression:
3936 * expr2 ? expr1 : expr1
3938 * "arg" must point to the first non-white of the expression.
3939 * "arg" is advanced to the next non-white after the recognized expression.
3941 * Note: "rettv.v_lock" is not set.
3943 * Return OK or FAIL.
3945 static int
3946 eval1(arg, rettv, evaluate)
3947 char_u **arg;
3948 typval_T *rettv;
3949 int evaluate;
3951 int result;
3952 typval_T var2;
3955 * Get the first variable.
3957 if (eval2(arg, rettv, evaluate) == FAIL)
3958 return FAIL;
3960 if ((*arg)[0] == '?')
3962 result = FALSE;
3963 if (evaluate)
3965 int error = FALSE;
3967 if (get_tv_number_chk(rettv, &error) != 0)
3968 result = TRUE;
3969 clear_tv(rettv);
3970 if (error)
3971 return FAIL;
3975 * Get the second variable.
3977 *arg = skipwhite(*arg + 1);
3978 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
3979 return FAIL;
3982 * Check for the ":".
3984 if ((*arg)[0] != ':')
3986 EMSG(_("E109: Missing ':' after '?'"));
3987 if (evaluate && result)
3988 clear_tv(rettv);
3989 return FAIL;
3993 * Get the third variable.
3995 *arg = skipwhite(*arg + 1);
3996 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
3998 if (evaluate && result)
3999 clear_tv(rettv);
4000 return FAIL;
4002 if (evaluate && !result)
4003 *rettv = var2;
4006 return OK;
4010 * Handle first level expression:
4011 * expr2 || expr2 || expr2 logical OR
4013 * "arg" must point to the first non-white of the expression.
4014 * "arg" is advanced to the next non-white after the recognized expression.
4016 * Return OK or FAIL.
4018 static int
4019 eval2(arg, rettv, evaluate)
4020 char_u **arg;
4021 typval_T *rettv;
4022 int evaluate;
4024 typval_T var2;
4025 long result;
4026 int first;
4027 int error = FALSE;
4030 * Get the first variable.
4032 if (eval3(arg, rettv, evaluate) == FAIL)
4033 return FAIL;
4036 * Repeat until there is no following "||".
4038 first = TRUE;
4039 result = FALSE;
4040 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4042 if (evaluate && first)
4044 if (get_tv_number_chk(rettv, &error) != 0)
4045 result = TRUE;
4046 clear_tv(rettv);
4047 if (error)
4048 return FAIL;
4049 first = FALSE;
4053 * Get the second variable.
4055 *arg = skipwhite(*arg + 2);
4056 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4057 return FAIL;
4060 * Compute the result.
4062 if (evaluate && !result)
4064 if (get_tv_number_chk(&var2, &error) != 0)
4065 result = TRUE;
4066 clear_tv(&var2);
4067 if (error)
4068 return FAIL;
4070 if (evaluate)
4072 rettv->v_type = VAR_NUMBER;
4073 rettv->vval.v_number = result;
4077 return OK;
4081 * Handle second level expression:
4082 * expr3 && expr3 && expr3 logical AND
4084 * "arg" must point to the first non-white of the expression.
4085 * "arg" is advanced to the next non-white after the recognized expression.
4087 * Return OK or FAIL.
4089 static int
4090 eval3(arg, rettv, evaluate)
4091 char_u **arg;
4092 typval_T *rettv;
4093 int evaluate;
4095 typval_T var2;
4096 long result;
4097 int first;
4098 int error = FALSE;
4101 * Get the first variable.
4103 if (eval4(arg, rettv, evaluate) == FAIL)
4104 return FAIL;
4107 * Repeat until there is no following "&&".
4109 first = TRUE;
4110 result = TRUE;
4111 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4113 if (evaluate && first)
4115 if (get_tv_number_chk(rettv, &error) == 0)
4116 result = FALSE;
4117 clear_tv(rettv);
4118 if (error)
4119 return FAIL;
4120 first = FALSE;
4124 * Get the second variable.
4126 *arg = skipwhite(*arg + 2);
4127 if (eval4(arg, &var2, evaluate && result) == FAIL)
4128 return FAIL;
4131 * Compute the result.
4133 if (evaluate && result)
4135 if (get_tv_number_chk(&var2, &error) == 0)
4136 result = FALSE;
4137 clear_tv(&var2);
4138 if (error)
4139 return FAIL;
4141 if (evaluate)
4143 rettv->v_type = VAR_NUMBER;
4144 rettv->vval.v_number = result;
4148 return OK;
4152 * Handle third level expression:
4153 * var1 == var2
4154 * var1 =~ var2
4155 * var1 != var2
4156 * var1 !~ var2
4157 * var1 > var2
4158 * var1 >= var2
4159 * var1 < var2
4160 * var1 <= var2
4161 * var1 is var2
4162 * var1 isnot var2
4164 * "arg" must point to the first non-white of the expression.
4165 * "arg" is advanced to the next non-white after the recognized expression.
4167 * Return OK or FAIL.
4169 static int
4170 eval4(arg, rettv, evaluate)
4171 char_u **arg;
4172 typval_T *rettv;
4173 int evaluate;
4175 typval_T var2;
4176 char_u *p;
4177 int i;
4178 exptype_T type = TYPE_UNKNOWN;
4179 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4180 int len = 2;
4181 long n1, n2;
4182 char_u *s1, *s2;
4183 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4184 regmatch_T regmatch;
4185 int ic;
4186 char_u *save_cpo;
4189 * Get the first variable.
4191 if (eval5(arg, rettv, evaluate) == FAIL)
4192 return FAIL;
4194 p = *arg;
4195 switch (p[0])
4197 case '=': if (p[1] == '=')
4198 type = TYPE_EQUAL;
4199 else if (p[1] == '~')
4200 type = TYPE_MATCH;
4201 break;
4202 case '!': if (p[1] == '=')
4203 type = TYPE_NEQUAL;
4204 else if (p[1] == '~')
4205 type = TYPE_NOMATCH;
4206 break;
4207 case '>': if (p[1] != '=')
4209 type = TYPE_GREATER;
4210 len = 1;
4212 else
4213 type = TYPE_GEQUAL;
4214 break;
4215 case '<': if (p[1] != '=')
4217 type = TYPE_SMALLER;
4218 len = 1;
4220 else
4221 type = TYPE_SEQUAL;
4222 break;
4223 case 'i': if (p[1] == 's')
4225 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4226 len = 5;
4227 if (!vim_isIDc(p[len]))
4229 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4230 type_is = TRUE;
4233 break;
4237 * If there is a comparative operator, use it.
4239 if (type != TYPE_UNKNOWN)
4241 /* extra question mark appended: ignore case */
4242 if (p[len] == '?')
4244 ic = TRUE;
4245 ++len;
4247 /* extra '#' appended: match case */
4248 else if (p[len] == '#')
4250 ic = FALSE;
4251 ++len;
4253 /* nothing appended: use 'ignorecase' */
4254 else
4255 ic = p_ic;
4258 * Get the second variable.
4260 *arg = skipwhite(p + len);
4261 if (eval5(arg, &var2, evaluate) == FAIL)
4263 clear_tv(rettv);
4264 return FAIL;
4267 if (evaluate)
4269 if (type_is && rettv->v_type != var2.v_type)
4271 /* For "is" a different type always means FALSE, for "notis"
4272 * it means TRUE. */
4273 n1 = (type == TYPE_NEQUAL);
4275 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4277 if (type_is)
4279 n1 = (rettv->v_type == var2.v_type
4280 && rettv->vval.v_list == var2.vval.v_list);
4281 if (type == TYPE_NEQUAL)
4282 n1 = !n1;
4284 else if (rettv->v_type != var2.v_type
4285 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4287 if (rettv->v_type != var2.v_type)
4288 EMSG(_("E691: Can only compare List with List"));
4289 else
4290 EMSG(_("E692: Invalid operation for Lists"));
4291 clear_tv(rettv);
4292 clear_tv(&var2);
4293 return FAIL;
4295 else
4297 /* Compare two Lists for being equal or unequal. */
4298 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4299 if (type == TYPE_NEQUAL)
4300 n1 = !n1;
4304 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4306 if (type_is)
4308 n1 = (rettv->v_type == var2.v_type
4309 && rettv->vval.v_dict == var2.vval.v_dict);
4310 if (type == TYPE_NEQUAL)
4311 n1 = !n1;
4313 else if (rettv->v_type != var2.v_type
4314 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4316 if (rettv->v_type != var2.v_type)
4317 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4318 else
4319 EMSG(_("E736: Invalid operation for Dictionary"));
4320 clear_tv(rettv);
4321 clear_tv(&var2);
4322 return FAIL;
4324 else
4326 /* Compare two Dictionaries for being equal or unequal. */
4327 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4328 if (type == TYPE_NEQUAL)
4329 n1 = !n1;
4333 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4335 if (rettv->v_type != var2.v_type
4336 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4338 if (rettv->v_type != var2.v_type)
4339 EMSG(_("E693: Can only compare Funcref with Funcref"));
4340 else
4341 EMSG(_("E694: Invalid operation for Funcrefs"));
4342 clear_tv(rettv);
4343 clear_tv(&var2);
4344 return FAIL;
4346 else
4348 /* Compare two Funcrefs for being equal or unequal. */
4349 if (rettv->vval.v_string == NULL
4350 || var2.vval.v_string == NULL)
4351 n1 = FALSE;
4352 else
4353 n1 = STRCMP(rettv->vval.v_string,
4354 var2.vval.v_string) == 0;
4355 if (type == TYPE_NEQUAL)
4356 n1 = !n1;
4360 #ifdef FEAT_FLOAT
4362 * If one of the two variables is a float, compare as a float.
4363 * When using "=~" or "!~", always compare as string.
4365 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4366 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4368 float_T f1, f2;
4370 if (rettv->v_type == VAR_FLOAT)
4371 f1 = rettv->vval.v_float;
4372 else
4373 f1 = get_tv_number(rettv);
4374 if (var2.v_type == VAR_FLOAT)
4375 f2 = var2.vval.v_float;
4376 else
4377 f2 = get_tv_number(&var2);
4378 n1 = FALSE;
4379 switch (type)
4381 case TYPE_EQUAL: n1 = (f1 == f2); break;
4382 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4383 case TYPE_GREATER: n1 = (f1 > f2); break;
4384 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4385 case TYPE_SMALLER: n1 = (f1 < f2); break;
4386 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4387 case TYPE_UNKNOWN:
4388 case TYPE_MATCH:
4389 case TYPE_NOMATCH: break; /* avoid gcc warning */
4392 #endif
4395 * If one of the two variables is a number, compare as a number.
4396 * When using "=~" or "!~", always compare as string.
4398 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4399 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4401 n1 = get_tv_number(rettv);
4402 n2 = get_tv_number(&var2);
4403 switch (type)
4405 case TYPE_EQUAL: n1 = (n1 == n2); break;
4406 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4407 case TYPE_GREATER: n1 = (n1 > n2); break;
4408 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4409 case TYPE_SMALLER: n1 = (n1 < n2); break;
4410 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4411 case TYPE_UNKNOWN:
4412 case TYPE_MATCH:
4413 case TYPE_NOMATCH: break; /* avoid gcc warning */
4416 else
4418 s1 = get_tv_string_buf(rettv, buf1);
4419 s2 = get_tv_string_buf(&var2, buf2);
4420 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4421 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4422 else
4423 i = 0;
4424 n1 = FALSE;
4425 switch (type)
4427 case TYPE_EQUAL: n1 = (i == 0); break;
4428 case TYPE_NEQUAL: n1 = (i != 0); break;
4429 case TYPE_GREATER: n1 = (i > 0); break;
4430 case TYPE_GEQUAL: n1 = (i >= 0); break;
4431 case TYPE_SMALLER: n1 = (i < 0); break;
4432 case TYPE_SEQUAL: n1 = (i <= 0); break;
4434 case TYPE_MATCH:
4435 case TYPE_NOMATCH:
4436 /* avoid 'l' flag in 'cpoptions' */
4437 save_cpo = p_cpo;
4438 p_cpo = (char_u *)"";
4439 regmatch.regprog = vim_regcomp(s2,
4440 RE_MAGIC + RE_STRING);
4441 regmatch.rm_ic = ic;
4442 if (regmatch.regprog != NULL)
4444 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4445 vim_free(regmatch.regprog);
4446 if (type == TYPE_NOMATCH)
4447 n1 = !n1;
4449 p_cpo = save_cpo;
4450 break;
4452 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4455 clear_tv(rettv);
4456 clear_tv(&var2);
4457 rettv->v_type = VAR_NUMBER;
4458 rettv->vval.v_number = n1;
4462 return OK;
4466 * Handle fourth level expression:
4467 * + number addition
4468 * - number subtraction
4469 * . string concatenation
4471 * "arg" must point to the first non-white of the expression.
4472 * "arg" is advanced to the next non-white after the recognized expression.
4474 * Return OK or FAIL.
4476 static int
4477 eval5(arg, rettv, evaluate)
4478 char_u **arg;
4479 typval_T *rettv;
4480 int evaluate;
4482 typval_T var2;
4483 typval_T var3;
4484 int op;
4485 long n1, n2;
4486 #ifdef FEAT_FLOAT
4487 float_T f1 = 0, f2 = 0;
4488 #endif
4489 char_u *s1, *s2;
4490 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4491 char_u *p;
4494 * Get the first variable.
4496 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4497 return FAIL;
4500 * Repeat computing, until no '+', '-' or '.' is following.
4502 for (;;)
4504 op = **arg;
4505 if (op != '+' && op != '-' && op != '.')
4506 break;
4508 if ((op != '+' || rettv->v_type != VAR_LIST)
4509 #ifdef FEAT_FLOAT
4510 && (op == '.' || rettv->v_type != VAR_FLOAT)
4511 #endif
4514 /* For "list + ...", an illegal use of the first operand as
4515 * a number cannot be determined before evaluating the 2nd
4516 * operand: if this is also a list, all is ok.
4517 * For "something . ...", "something - ..." or "non-list + ...",
4518 * we know that the first operand needs to be a string or number
4519 * without evaluating the 2nd operand. So check before to avoid
4520 * side effects after an error. */
4521 if (evaluate && get_tv_string_chk(rettv) == NULL)
4523 clear_tv(rettv);
4524 return FAIL;
4529 * Get the second variable.
4531 *arg = skipwhite(*arg + 1);
4532 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4534 clear_tv(rettv);
4535 return FAIL;
4538 if (evaluate)
4541 * Compute the result.
4543 if (op == '.')
4545 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4546 s2 = get_tv_string_buf_chk(&var2, buf2);
4547 if (s2 == NULL) /* type error ? */
4549 clear_tv(rettv);
4550 clear_tv(&var2);
4551 return FAIL;
4553 p = concat_str(s1, s2);
4554 clear_tv(rettv);
4555 rettv->v_type = VAR_STRING;
4556 rettv->vval.v_string = p;
4558 else if (op == '+' && rettv->v_type == VAR_LIST
4559 && var2.v_type == VAR_LIST)
4561 /* concatenate Lists */
4562 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4563 &var3) == FAIL)
4565 clear_tv(rettv);
4566 clear_tv(&var2);
4567 return FAIL;
4569 clear_tv(rettv);
4570 *rettv = var3;
4572 else
4574 int error = FALSE;
4576 #ifdef FEAT_FLOAT
4577 if (rettv->v_type == VAR_FLOAT)
4579 f1 = rettv->vval.v_float;
4580 n1 = 0;
4582 else
4583 #endif
4585 n1 = get_tv_number_chk(rettv, &error);
4586 if (error)
4588 /* This can only happen for "list + non-list". For
4589 * "non-list + ..." or "something - ...", we returned
4590 * before evaluating the 2nd operand. */
4591 clear_tv(rettv);
4592 return FAIL;
4594 #ifdef FEAT_FLOAT
4595 if (var2.v_type == VAR_FLOAT)
4596 f1 = n1;
4597 #endif
4599 #ifdef FEAT_FLOAT
4600 if (var2.v_type == VAR_FLOAT)
4602 f2 = var2.vval.v_float;
4603 n2 = 0;
4605 else
4606 #endif
4608 n2 = get_tv_number_chk(&var2, &error);
4609 if (error)
4611 clear_tv(rettv);
4612 clear_tv(&var2);
4613 return FAIL;
4615 #ifdef FEAT_FLOAT
4616 if (rettv->v_type == VAR_FLOAT)
4617 f2 = n2;
4618 #endif
4620 clear_tv(rettv);
4622 #ifdef FEAT_FLOAT
4623 /* If there is a float on either side the result is a float. */
4624 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4626 if (op == '+')
4627 f1 = f1 + f2;
4628 else
4629 f1 = f1 - f2;
4630 rettv->v_type = VAR_FLOAT;
4631 rettv->vval.v_float = f1;
4633 else
4634 #endif
4636 if (op == '+')
4637 n1 = n1 + n2;
4638 else
4639 n1 = n1 - n2;
4640 rettv->v_type = VAR_NUMBER;
4641 rettv->vval.v_number = n1;
4644 clear_tv(&var2);
4647 return OK;
4651 * Handle fifth level expression:
4652 * * number multiplication
4653 * / number division
4654 * % number modulo
4656 * "arg" must point to the first non-white of the expression.
4657 * "arg" is advanced to the next non-white after the recognized expression.
4659 * Return OK or FAIL.
4661 static int
4662 eval6(arg, rettv, evaluate, want_string)
4663 char_u **arg;
4664 typval_T *rettv;
4665 int evaluate;
4666 int want_string; /* after "." operator */
4668 typval_T var2;
4669 int op;
4670 long n1, n2;
4671 #ifdef FEAT_FLOAT
4672 int use_float = FALSE;
4673 float_T f1 = 0, f2;
4674 #endif
4675 int error = FALSE;
4678 * Get the first variable.
4680 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4681 return FAIL;
4684 * Repeat computing, until no '*', '/' or '%' is following.
4686 for (;;)
4688 op = **arg;
4689 if (op != '*' && op != '/' && op != '%')
4690 break;
4692 if (evaluate)
4694 #ifdef FEAT_FLOAT
4695 if (rettv->v_type == VAR_FLOAT)
4697 f1 = rettv->vval.v_float;
4698 use_float = TRUE;
4699 n1 = 0;
4701 else
4702 #endif
4703 n1 = get_tv_number_chk(rettv, &error);
4704 clear_tv(rettv);
4705 if (error)
4706 return FAIL;
4708 else
4709 n1 = 0;
4712 * Get the second variable.
4714 *arg = skipwhite(*arg + 1);
4715 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4716 return FAIL;
4718 if (evaluate)
4720 #ifdef FEAT_FLOAT
4721 if (var2.v_type == VAR_FLOAT)
4723 if (!use_float)
4725 f1 = n1;
4726 use_float = TRUE;
4728 f2 = var2.vval.v_float;
4729 n2 = 0;
4731 else
4732 #endif
4734 n2 = get_tv_number_chk(&var2, &error);
4735 clear_tv(&var2);
4736 if (error)
4737 return FAIL;
4738 #ifdef FEAT_FLOAT
4739 if (use_float)
4740 f2 = n2;
4741 #endif
4745 * Compute the result.
4746 * When either side is a float the result is a float.
4748 #ifdef FEAT_FLOAT
4749 if (use_float)
4751 if (op == '*')
4752 f1 = f1 * f2;
4753 else if (op == '/')
4755 /* We rely on the floating point library to handle divide
4756 * by zero to result in "inf" and not a crash. */
4757 f1 = f1 / f2;
4759 else
4761 EMSG(_("E804: Cannot use '%' with Float"));
4762 return FAIL;
4764 rettv->v_type = VAR_FLOAT;
4765 rettv->vval.v_float = f1;
4767 else
4768 #endif
4770 if (op == '*')
4771 n1 = n1 * n2;
4772 else if (op == '/')
4774 if (n2 == 0) /* give an error message? */
4776 if (n1 == 0)
4777 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4778 else if (n1 < 0)
4779 n1 = -0x7fffffffL;
4780 else
4781 n1 = 0x7fffffffL;
4783 else
4784 n1 = n1 / n2;
4786 else
4788 if (n2 == 0) /* give an error message? */
4789 n1 = 0;
4790 else
4791 n1 = n1 % n2;
4793 rettv->v_type = VAR_NUMBER;
4794 rettv->vval.v_number = n1;
4799 return OK;
4803 * Handle sixth level expression:
4804 * number number constant
4805 * "string" string constant
4806 * 'string' literal string constant
4807 * &option-name option value
4808 * @r register contents
4809 * identifier variable value
4810 * function() function call
4811 * $VAR environment variable
4812 * (expression) nested expression
4813 * [expr, expr] List
4814 * {key: val, key: val} Dictionary
4816 * Also handle:
4817 * ! in front logical NOT
4818 * - in front unary minus
4819 * + in front unary plus (ignored)
4820 * trailing [] subscript in String or List
4821 * trailing .name entry in Dictionary
4823 * "arg" must point to the first non-white of the expression.
4824 * "arg" is advanced to the next non-white after the recognized expression.
4826 * Return OK or FAIL.
4828 static int
4829 eval7(arg, rettv, evaluate, want_string)
4830 char_u **arg;
4831 typval_T *rettv;
4832 int evaluate;
4833 int want_string; /* after "." operator */
4835 long n;
4836 int len;
4837 char_u *s;
4838 char_u *start_leader, *end_leader;
4839 int ret = OK;
4840 char_u *alias;
4843 * Initialise variable so that clear_tv() can't mistake this for a
4844 * string and free a string that isn't there.
4846 rettv->v_type = VAR_UNKNOWN;
4849 * Skip '!' and '-' characters. They are handled later.
4851 start_leader = *arg;
4852 while (**arg == '!' || **arg == '-' || **arg == '+')
4853 *arg = skipwhite(*arg + 1);
4854 end_leader = *arg;
4856 switch (**arg)
4859 * Number constant.
4861 case '0':
4862 case '1':
4863 case '2':
4864 case '3':
4865 case '4':
4866 case '5':
4867 case '6':
4868 case '7':
4869 case '8':
4870 case '9':
4872 #ifdef FEAT_FLOAT
4873 char_u *p = skipdigits(*arg + 1);
4874 int get_float = FALSE;
4876 /* We accept a float when the format matches
4877 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4878 * strict to avoid backwards compatibility problems.
4879 * Don't look for a float after the "." operator, so that
4880 * ":let vers = 1.2.3" doesn't fail. */
4881 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4883 get_float = TRUE;
4884 p = skipdigits(p + 2);
4885 if (*p == 'e' || *p == 'E')
4887 ++p;
4888 if (*p == '-' || *p == '+')
4889 ++p;
4890 if (!vim_isdigit(*p))
4891 get_float = FALSE;
4892 else
4893 p = skipdigits(p + 1);
4895 if (ASCII_ISALPHA(*p) || *p == '.')
4896 get_float = FALSE;
4898 if (get_float)
4900 float_T f;
4902 *arg += string2float(*arg, &f);
4903 if (evaluate)
4905 rettv->v_type = VAR_FLOAT;
4906 rettv->vval.v_float = f;
4909 else
4910 #endif
4912 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4913 *arg += len;
4914 if (evaluate)
4916 rettv->v_type = VAR_NUMBER;
4917 rettv->vval.v_number = n;
4920 break;
4924 * String constant: "string".
4926 case '"': ret = get_string_tv(arg, rettv, evaluate);
4927 break;
4930 * Literal string constant: 'str''ing'.
4932 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4933 break;
4936 * List: [expr, expr]
4938 case '[': ret = get_list_tv(arg, rettv, evaluate);
4939 break;
4942 * Dictionary: {key: val, key: val}
4944 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4945 break;
4948 * Option value: &name
4950 case '&': ret = get_option_tv(arg, rettv, evaluate);
4951 break;
4954 * Environment variable: $VAR.
4956 case '$': ret = get_env_tv(arg, rettv, evaluate);
4957 break;
4960 * Register contents: @r.
4962 case '@': ++*arg;
4963 if (evaluate)
4965 rettv->v_type = VAR_STRING;
4966 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4968 if (**arg != NUL)
4969 ++*arg;
4970 break;
4973 * nested expression: (expression).
4975 case '(': *arg = skipwhite(*arg + 1);
4976 ret = eval1(arg, rettv, evaluate); /* recursive! */
4977 if (**arg == ')')
4978 ++*arg;
4979 else if (ret == OK)
4981 EMSG(_("E110: Missing ')'"));
4982 clear_tv(rettv);
4983 ret = FAIL;
4985 break;
4987 default: ret = NOTDONE;
4988 break;
4991 if (ret == NOTDONE)
4994 * Must be a variable or function name.
4995 * Can also be a curly-braces kind of name: {expr}.
4997 s = *arg;
4998 len = get_name_len(arg, &alias, evaluate, TRUE);
4999 if (alias != NULL)
5000 s = alias;
5002 if (len <= 0)
5003 ret = FAIL;
5004 else
5006 if (**arg == '(') /* recursive! */
5008 /* If "s" is the name of a variable of type VAR_FUNC
5009 * use its contents. */
5010 s = deref_func_name(s, &len);
5012 /* Invoke the function. */
5013 ret = get_func_tv(s, len, rettv, arg,
5014 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5015 &len, evaluate, NULL);
5016 /* Stop the expression evaluation when immediately
5017 * aborting on error, or when an interrupt occurred or
5018 * an exception was thrown but not caught. */
5019 if (aborting())
5021 if (ret == OK)
5022 clear_tv(rettv);
5023 ret = FAIL;
5026 else if (evaluate)
5027 ret = get_var_tv(s, len, rettv, TRUE);
5028 else
5029 ret = OK;
5032 if (alias != NULL)
5033 vim_free(alias);
5036 *arg = skipwhite(*arg);
5038 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5039 * expr(expr). */
5040 if (ret == OK)
5041 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5044 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5046 if (ret == OK && evaluate && end_leader > start_leader)
5048 int error = FALSE;
5049 int val = 0;
5050 #ifdef FEAT_FLOAT
5051 float_T f = 0.0;
5053 if (rettv->v_type == VAR_FLOAT)
5054 f = rettv->vval.v_float;
5055 else
5056 #endif
5057 val = get_tv_number_chk(rettv, &error);
5058 if (error)
5060 clear_tv(rettv);
5061 ret = FAIL;
5063 else
5065 while (end_leader > start_leader)
5067 --end_leader;
5068 if (*end_leader == '!')
5070 #ifdef FEAT_FLOAT
5071 if (rettv->v_type == VAR_FLOAT)
5072 f = !f;
5073 else
5074 #endif
5075 val = !val;
5077 else if (*end_leader == '-')
5079 #ifdef FEAT_FLOAT
5080 if (rettv->v_type == VAR_FLOAT)
5081 f = -f;
5082 else
5083 #endif
5084 val = -val;
5087 #ifdef FEAT_FLOAT
5088 if (rettv->v_type == VAR_FLOAT)
5090 clear_tv(rettv);
5091 rettv->vval.v_float = f;
5093 else
5094 #endif
5096 clear_tv(rettv);
5097 rettv->v_type = VAR_NUMBER;
5098 rettv->vval.v_number = val;
5103 return ret;
5107 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5108 * "*arg" points to the '[' or '.'.
5109 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5111 static int
5112 eval_index(arg, rettv, evaluate, verbose)
5113 char_u **arg;
5114 typval_T *rettv;
5115 int evaluate;
5116 int verbose; /* give error messages */
5118 int empty1 = FALSE, empty2 = FALSE;
5119 typval_T var1, var2;
5120 long n1, n2 = 0;
5121 long len = -1;
5122 int range = FALSE;
5123 char_u *s;
5124 char_u *key = NULL;
5126 if (rettv->v_type == VAR_FUNC
5127 #ifdef FEAT_FLOAT
5128 || rettv->v_type == VAR_FLOAT
5129 #endif
5132 if (verbose)
5133 EMSG(_("E695: Cannot index a Funcref"));
5134 return FAIL;
5137 if (**arg == '.')
5140 * dict.name
5142 key = *arg + 1;
5143 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5145 if (len == 0)
5146 return FAIL;
5147 *arg = skipwhite(key + len);
5149 else
5152 * something[idx]
5154 * Get the (first) variable from inside the [].
5156 *arg = skipwhite(*arg + 1);
5157 if (**arg == ':')
5158 empty1 = TRUE;
5159 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5160 return FAIL;
5161 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5163 /* not a number or string */
5164 clear_tv(&var1);
5165 return FAIL;
5169 * Get the second variable from inside the [:].
5171 if (**arg == ':')
5173 range = TRUE;
5174 *arg = skipwhite(*arg + 1);
5175 if (**arg == ']')
5176 empty2 = TRUE;
5177 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5179 if (!empty1)
5180 clear_tv(&var1);
5181 return FAIL;
5183 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5185 /* not a number or string */
5186 if (!empty1)
5187 clear_tv(&var1);
5188 clear_tv(&var2);
5189 return FAIL;
5193 /* Check for the ']'. */
5194 if (**arg != ']')
5196 if (verbose)
5197 EMSG(_(e_missbrac));
5198 clear_tv(&var1);
5199 if (range)
5200 clear_tv(&var2);
5201 return FAIL;
5203 *arg = skipwhite(*arg + 1); /* skip the ']' */
5206 if (evaluate)
5208 n1 = 0;
5209 if (!empty1 && rettv->v_type != VAR_DICT)
5211 n1 = get_tv_number(&var1);
5212 clear_tv(&var1);
5214 if (range)
5216 if (empty2)
5217 n2 = -1;
5218 else
5220 n2 = get_tv_number(&var2);
5221 clear_tv(&var2);
5225 switch (rettv->v_type)
5227 case VAR_NUMBER:
5228 case VAR_STRING:
5229 s = get_tv_string(rettv);
5230 len = (long)STRLEN(s);
5231 if (range)
5233 /* The resulting variable is a substring. If the indexes
5234 * are out of range the result is empty. */
5235 if (n1 < 0)
5237 n1 = len + n1;
5238 if (n1 < 0)
5239 n1 = 0;
5241 if (n2 < 0)
5242 n2 = len + n2;
5243 else if (n2 >= len)
5244 n2 = len;
5245 if (n1 >= len || n2 < 0 || n1 > n2)
5246 s = NULL;
5247 else
5248 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5250 else
5252 /* The resulting variable is a string of a single
5253 * character. If the index is too big or negative the
5254 * result is empty. */
5255 if (n1 >= len || n1 < 0)
5256 s = NULL;
5257 else
5258 s = vim_strnsave(s + n1, 1);
5260 clear_tv(rettv);
5261 rettv->v_type = VAR_STRING;
5262 rettv->vval.v_string = s;
5263 break;
5265 case VAR_LIST:
5266 len = list_len(rettv->vval.v_list);
5267 if (n1 < 0)
5268 n1 = len + n1;
5269 if (!empty1 && (n1 < 0 || n1 >= len))
5271 /* For a range we allow invalid values and return an empty
5272 * list. A list index out of range is an error. */
5273 if (!range)
5275 if (verbose)
5276 EMSGN(_(e_listidx), n1);
5277 return FAIL;
5279 n1 = len;
5281 if (range)
5283 list_T *l;
5284 listitem_T *item;
5286 if (n2 < 0)
5287 n2 = len + n2;
5288 else if (n2 >= len)
5289 n2 = len - 1;
5290 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5291 n2 = -1;
5292 l = list_alloc();
5293 if (l == NULL)
5294 return FAIL;
5295 for (item = list_find(rettv->vval.v_list, n1);
5296 n1 <= n2; ++n1)
5298 if (list_append_tv(l, &item->li_tv) == FAIL)
5300 list_free(l, TRUE);
5301 return FAIL;
5303 item = item->li_next;
5305 clear_tv(rettv);
5306 rettv->v_type = VAR_LIST;
5307 rettv->vval.v_list = l;
5308 ++l->lv_refcount;
5310 else
5312 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5313 clear_tv(rettv);
5314 *rettv = var1;
5316 break;
5318 case VAR_DICT:
5319 if (range)
5321 if (verbose)
5322 EMSG(_(e_dictrange));
5323 if (len == -1)
5324 clear_tv(&var1);
5325 return FAIL;
5328 dictitem_T *item;
5330 if (len == -1)
5332 key = get_tv_string(&var1);
5333 if (*key == NUL)
5335 if (verbose)
5336 EMSG(_(e_emptykey));
5337 clear_tv(&var1);
5338 return FAIL;
5342 item = dict_find(rettv->vval.v_dict, key, (int)len);
5344 if (item == NULL && verbose)
5345 EMSG2(_(e_dictkey), key);
5346 if (len == -1)
5347 clear_tv(&var1);
5348 if (item == NULL)
5349 return FAIL;
5351 copy_tv(&item->di_tv, &var1);
5352 clear_tv(rettv);
5353 *rettv = var1;
5355 break;
5359 return OK;
5363 * Get an option value.
5364 * "arg" points to the '&' or '+' before the option name.
5365 * "arg" is advanced to character after the option name.
5366 * Return OK or FAIL.
5368 static int
5369 get_option_tv(arg, rettv, evaluate)
5370 char_u **arg;
5371 typval_T *rettv; /* when NULL, only check if option exists */
5372 int evaluate;
5374 char_u *option_end;
5375 long numval;
5376 char_u *stringval;
5377 int opt_type;
5378 int c;
5379 int working = (**arg == '+'); /* has("+option") */
5380 int ret = OK;
5381 int opt_flags;
5384 * Isolate the option name and find its value.
5386 option_end = find_option_end(arg, &opt_flags);
5387 if (option_end == NULL)
5389 if (rettv != NULL)
5390 EMSG2(_("E112: Option name missing: %s"), *arg);
5391 return FAIL;
5394 if (!evaluate)
5396 *arg = option_end;
5397 return OK;
5400 c = *option_end;
5401 *option_end = NUL;
5402 opt_type = get_option_value(*arg, &numval,
5403 rettv == NULL ? NULL : &stringval, opt_flags);
5405 if (opt_type == -3) /* invalid name */
5407 if (rettv != NULL)
5408 EMSG2(_("E113: Unknown option: %s"), *arg);
5409 ret = FAIL;
5411 else if (rettv != NULL)
5413 if (opt_type == -2) /* hidden string option */
5415 rettv->v_type = VAR_STRING;
5416 rettv->vval.v_string = NULL;
5418 else if (opt_type == -1) /* hidden number option */
5420 rettv->v_type = VAR_NUMBER;
5421 rettv->vval.v_number = 0;
5423 else if (opt_type == 1) /* number option */
5425 rettv->v_type = VAR_NUMBER;
5426 rettv->vval.v_number = numval;
5428 else /* string option */
5430 rettv->v_type = VAR_STRING;
5431 rettv->vval.v_string = stringval;
5434 else if (working && (opt_type == -2 || opt_type == -1))
5435 ret = FAIL;
5437 *option_end = c; /* put back for error messages */
5438 *arg = option_end;
5440 return ret;
5444 * Allocate a variable for a string constant.
5445 * Return OK or FAIL.
5447 static int
5448 get_string_tv(arg, rettv, evaluate)
5449 char_u **arg;
5450 typval_T *rettv;
5451 int evaluate;
5453 char_u *p;
5454 char_u *name;
5455 int extra = 0;
5458 * Find the end of the string, skipping backslashed characters.
5460 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5462 if (*p == '\\' && p[1] != NUL)
5464 ++p;
5465 /* A "\<x>" form occupies at least 4 characters, and produces up
5466 * to 6 characters: reserve space for 2 extra */
5467 if (*p == '<')
5468 extra += 2;
5472 if (*p != '"')
5474 EMSG2(_("E114: Missing quote: %s"), *arg);
5475 return FAIL;
5478 /* If only parsing, set *arg and return here */
5479 if (!evaluate)
5481 *arg = p + 1;
5482 return OK;
5486 * Copy the string into allocated memory, handling backslashed
5487 * characters.
5489 name = alloc((unsigned)(p - *arg + extra));
5490 if (name == NULL)
5491 return FAIL;
5492 rettv->v_type = VAR_STRING;
5493 rettv->vval.v_string = name;
5495 for (p = *arg + 1; *p != NUL && *p != '"'; )
5497 if (*p == '\\')
5499 switch (*++p)
5501 case 'b': *name++ = BS; ++p; break;
5502 case 'e': *name++ = ESC; ++p; break;
5503 case 'f': *name++ = FF; ++p; break;
5504 case 'n': *name++ = NL; ++p; break;
5505 case 'r': *name++ = CAR; ++p; break;
5506 case 't': *name++ = TAB; ++p; break;
5508 case 'X': /* hex: "\x1", "\x12" */
5509 case 'x':
5510 case 'u': /* Unicode: "\u0023" */
5511 case 'U':
5512 if (vim_isxdigit(p[1]))
5514 int n, nr;
5515 int c = toupper(*p);
5517 if (c == 'X')
5518 n = 2;
5519 else
5520 n = 4;
5521 nr = 0;
5522 while (--n >= 0 && vim_isxdigit(p[1]))
5524 ++p;
5525 nr = (nr << 4) + hex2nr(*p);
5527 ++p;
5528 #ifdef FEAT_MBYTE
5529 /* For "\u" store the number according to
5530 * 'encoding'. */
5531 if (c != 'X')
5532 name += (*mb_char2bytes)(nr, name);
5533 else
5534 #endif
5535 *name++ = nr;
5537 break;
5539 /* octal: "\1", "\12", "\123" */
5540 case '0':
5541 case '1':
5542 case '2':
5543 case '3':
5544 case '4':
5545 case '5':
5546 case '6':
5547 case '7': *name = *p++ - '0';
5548 if (*p >= '0' && *p <= '7')
5550 *name = (*name << 3) + *p++ - '0';
5551 if (*p >= '0' && *p <= '7')
5552 *name = (*name << 3) + *p++ - '0';
5554 ++name;
5555 break;
5557 /* Special key, e.g.: "\<C-W>" */
5558 case '<': extra = trans_special(&p, name, TRUE);
5559 if (extra != 0)
5561 name += extra;
5562 break;
5564 /* FALLTHROUGH */
5566 default: MB_COPY_CHAR(p, name);
5567 break;
5570 else
5571 MB_COPY_CHAR(p, name);
5574 *name = NUL;
5575 *arg = p + 1;
5577 return OK;
5581 * Allocate a variable for a 'str''ing' constant.
5582 * Return OK or FAIL.
5584 static int
5585 get_lit_string_tv(arg, rettv, evaluate)
5586 char_u **arg;
5587 typval_T *rettv;
5588 int evaluate;
5590 char_u *p;
5591 char_u *str;
5592 int reduce = 0;
5595 * Find the end of the string, skipping ''.
5597 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5599 if (*p == '\'')
5601 if (p[1] != '\'')
5602 break;
5603 ++reduce;
5604 ++p;
5608 if (*p != '\'')
5610 EMSG2(_("E115: Missing quote: %s"), *arg);
5611 return FAIL;
5614 /* If only parsing return after setting "*arg" */
5615 if (!evaluate)
5617 *arg = p + 1;
5618 return OK;
5622 * Copy the string into allocated memory, handling '' to ' reduction.
5624 str = alloc((unsigned)((p - *arg) - reduce));
5625 if (str == NULL)
5626 return FAIL;
5627 rettv->v_type = VAR_STRING;
5628 rettv->vval.v_string = str;
5630 for (p = *arg + 1; *p != NUL; )
5632 if (*p == '\'')
5634 if (p[1] != '\'')
5635 break;
5636 ++p;
5638 MB_COPY_CHAR(p, str);
5640 *str = NUL;
5641 *arg = p + 1;
5643 return OK;
5647 * Allocate a variable for a List and fill it from "*arg".
5648 * Return OK or FAIL.
5650 static int
5651 get_list_tv(arg, rettv, evaluate)
5652 char_u **arg;
5653 typval_T *rettv;
5654 int evaluate;
5656 list_T *l = NULL;
5657 typval_T tv;
5658 listitem_T *item;
5660 if (evaluate)
5662 l = list_alloc();
5663 if (l == NULL)
5664 return FAIL;
5667 *arg = skipwhite(*arg + 1);
5668 while (**arg != ']' && **arg != NUL)
5670 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5671 goto failret;
5672 if (evaluate)
5674 item = listitem_alloc();
5675 if (item != NULL)
5677 item->li_tv = tv;
5678 item->li_tv.v_lock = 0;
5679 list_append(l, item);
5681 else
5682 clear_tv(&tv);
5685 if (**arg == ']')
5686 break;
5687 if (**arg != ',')
5689 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5690 goto failret;
5692 *arg = skipwhite(*arg + 1);
5695 if (**arg != ']')
5697 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5698 failret:
5699 if (evaluate)
5700 list_free(l, TRUE);
5701 return FAIL;
5704 *arg = skipwhite(*arg + 1);
5705 if (evaluate)
5707 rettv->v_type = VAR_LIST;
5708 rettv->vval.v_list = l;
5709 ++l->lv_refcount;
5712 return OK;
5716 * Allocate an empty header for a list.
5717 * Caller should take care of the reference count.
5719 list_T *
5720 list_alloc()
5722 list_T *l;
5724 l = (list_T *)alloc_clear(sizeof(list_T));
5725 if (l != NULL)
5727 /* Prepend the list to the list of lists for garbage collection. */
5728 if (first_list != NULL)
5729 first_list->lv_used_prev = l;
5730 l->lv_used_prev = NULL;
5731 l->lv_used_next = first_list;
5732 first_list = l;
5734 return l;
5738 * Allocate an empty list for a return value.
5739 * Returns OK or FAIL.
5741 static int
5742 rettv_list_alloc(rettv)
5743 typval_T *rettv;
5745 list_T *l = list_alloc();
5747 if (l == NULL)
5748 return FAIL;
5750 rettv->vval.v_list = l;
5751 rettv->v_type = VAR_LIST;
5752 ++l->lv_refcount;
5753 return OK;
5757 * Unreference a list: decrement the reference count and free it when it
5758 * becomes zero.
5760 void
5761 list_unref(l)
5762 list_T *l;
5764 if (l != NULL && --l->lv_refcount <= 0)
5765 list_free(l, TRUE);
5769 * Free a list, including all items it points to.
5770 * Ignores the reference count.
5772 void
5773 list_free(l, recurse)
5774 list_T *l;
5775 int recurse; /* Free Lists and Dictionaries recursively. */
5777 listitem_T *item;
5779 /* Remove the list from the list of lists for garbage collection. */
5780 if (l->lv_used_prev == NULL)
5781 first_list = l->lv_used_next;
5782 else
5783 l->lv_used_prev->lv_used_next = l->lv_used_next;
5784 if (l->lv_used_next != NULL)
5785 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5787 for (item = l->lv_first; item != NULL; item = l->lv_first)
5789 /* Remove the item before deleting it. */
5790 l->lv_first = item->li_next;
5791 if (recurse || (item->li_tv.v_type != VAR_LIST
5792 && item->li_tv.v_type != VAR_DICT))
5793 clear_tv(&item->li_tv);
5794 vim_free(item);
5796 vim_free(l);
5800 * Allocate a list item.
5802 static listitem_T *
5803 listitem_alloc()
5805 return (listitem_T *)alloc(sizeof(listitem_T));
5809 * Free a list item. Also clears the value. Does not notify watchers.
5811 static void
5812 listitem_free(item)
5813 listitem_T *item;
5815 clear_tv(&item->li_tv);
5816 vim_free(item);
5820 * Remove a list item from a List and free it. Also clears the value.
5822 static void
5823 listitem_remove(l, item)
5824 list_T *l;
5825 listitem_T *item;
5827 list_remove(l, item, item);
5828 listitem_free(item);
5832 * Get the number of items in a list.
5834 static long
5835 list_len(l)
5836 list_T *l;
5838 if (l == NULL)
5839 return 0L;
5840 return l->lv_len;
5844 * Return TRUE when two lists have exactly the same values.
5846 static int
5847 list_equal(l1, l2, ic)
5848 list_T *l1;
5849 list_T *l2;
5850 int ic; /* ignore case for strings */
5852 listitem_T *item1, *item2;
5854 if (l1 == NULL || l2 == NULL)
5855 return FALSE;
5856 if (l1 == l2)
5857 return TRUE;
5858 if (list_len(l1) != list_len(l2))
5859 return FALSE;
5861 for (item1 = l1->lv_first, item2 = l2->lv_first;
5862 item1 != NULL && item2 != NULL;
5863 item1 = item1->li_next, item2 = item2->li_next)
5864 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5865 return FALSE;
5866 return item1 == NULL && item2 == NULL;
5869 #if defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) || defined(PROTO) \
5870 || defined(FEAT_GUI_MACVIM)
5872 * Return the dictitem that an entry in a hashtable points to.
5874 dictitem_T *
5875 dict_lookup(hi)
5876 hashitem_T *hi;
5878 return HI2DI(hi);
5880 #endif
5883 * Return TRUE when two dictionaries have exactly the same key/values.
5885 static int
5886 dict_equal(d1, d2, ic)
5887 dict_T *d1;
5888 dict_T *d2;
5889 int ic; /* ignore case for strings */
5891 hashitem_T *hi;
5892 dictitem_T *item2;
5893 int todo;
5895 if (d1 == NULL || d2 == NULL)
5896 return FALSE;
5897 if (d1 == d2)
5898 return TRUE;
5899 if (dict_len(d1) != dict_len(d2))
5900 return FALSE;
5902 todo = (int)d1->dv_hashtab.ht_used;
5903 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5905 if (!HASHITEM_EMPTY(hi))
5907 item2 = dict_find(d2, hi->hi_key, -1);
5908 if (item2 == NULL)
5909 return FALSE;
5910 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5911 return FALSE;
5912 --todo;
5915 return TRUE;
5919 * Return TRUE if "tv1" and "tv2" have the same value.
5920 * Compares the items just like "==" would compare them, but strings and
5921 * numbers are different. Floats and numbers are also different.
5923 static int
5924 tv_equal(tv1, tv2, ic)
5925 typval_T *tv1;
5926 typval_T *tv2;
5927 int ic; /* ignore case */
5929 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5930 char_u *s1, *s2;
5931 static int recursive = 0; /* cach recursive loops */
5932 int r;
5934 if (tv1->v_type != tv2->v_type)
5935 return FALSE;
5936 /* Catch lists and dicts that have an endless loop by limiting
5937 * recursiveness to 1000. We guess they are equal then. */
5938 if (recursive >= 1000)
5939 return TRUE;
5941 switch (tv1->v_type)
5943 case VAR_LIST:
5944 ++recursive;
5945 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5946 --recursive;
5947 return r;
5949 case VAR_DICT:
5950 ++recursive;
5951 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5952 --recursive;
5953 return r;
5955 case VAR_FUNC:
5956 return (tv1->vval.v_string != NULL
5957 && tv2->vval.v_string != NULL
5958 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5960 case VAR_NUMBER:
5961 return tv1->vval.v_number == tv2->vval.v_number;
5963 #ifdef FEAT_FLOAT
5964 case VAR_FLOAT:
5965 return tv1->vval.v_float == tv2->vval.v_float;
5966 #endif
5968 case VAR_STRING:
5969 s1 = get_tv_string_buf(tv1, buf1);
5970 s2 = get_tv_string_buf(tv2, buf2);
5971 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5974 EMSG2(_(e_intern2), "tv_equal()");
5975 return TRUE;
5979 * Locate item with index "n" in list "l" and return it.
5980 * A negative index is counted from the end; -1 is the last item.
5981 * Returns NULL when "n" is out of range.
5983 static listitem_T *
5984 list_find(l, n)
5985 list_T *l;
5986 long n;
5988 listitem_T *item;
5989 long idx;
5991 if (l == NULL)
5992 return NULL;
5994 /* Negative index is relative to the end. */
5995 if (n < 0)
5996 n = l->lv_len + n;
5998 /* Check for index out of range. */
5999 if (n < 0 || n >= l->lv_len)
6000 return NULL;
6002 /* When there is a cached index may start search from there. */
6003 if (l->lv_idx_item != NULL)
6005 if (n < l->lv_idx / 2)
6007 /* closest to the start of the list */
6008 item = l->lv_first;
6009 idx = 0;
6011 else if (n > (l->lv_idx + l->lv_len) / 2)
6013 /* closest to the end of the list */
6014 item = l->lv_last;
6015 idx = l->lv_len - 1;
6017 else
6019 /* closest to the cached index */
6020 item = l->lv_idx_item;
6021 idx = l->lv_idx;
6024 else
6026 if (n < l->lv_len / 2)
6028 /* closest to the start of the list */
6029 item = l->lv_first;
6030 idx = 0;
6032 else
6034 /* closest to the end of the list */
6035 item = l->lv_last;
6036 idx = l->lv_len - 1;
6040 while (n > idx)
6042 /* search forward */
6043 item = item->li_next;
6044 ++idx;
6046 while (n < idx)
6048 /* search backward */
6049 item = item->li_prev;
6050 --idx;
6053 /* cache the used index */
6054 l->lv_idx = idx;
6055 l->lv_idx_item = item;
6057 return item;
6061 * Get list item "l[idx]" as a number.
6063 static long
6064 list_find_nr(l, idx, errorp)
6065 list_T *l;
6066 long idx;
6067 int *errorp; /* set to TRUE when something wrong */
6069 listitem_T *li;
6071 li = list_find(l, idx);
6072 if (li == NULL)
6074 if (errorp != NULL)
6075 *errorp = TRUE;
6076 return -1L;
6078 return get_tv_number_chk(&li->li_tv, errorp);
6082 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6084 char_u *
6085 list_find_str(l, idx)
6086 list_T *l;
6087 long idx;
6089 listitem_T *li;
6091 li = list_find(l, idx - 1);
6092 if (li == NULL)
6094 EMSGN(_(e_listidx), idx);
6095 return NULL;
6097 return get_tv_string(&li->li_tv);
6101 * Locate "item" list "l" and return its index.
6102 * Returns -1 when "item" is not in the list.
6104 static long
6105 list_idx_of_item(l, item)
6106 list_T *l;
6107 listitem_T *item;
6109 long idx = 0;
6110 listitem_T *li;
6112 if (l == NULL)
6113 return -1;
6114 idx = 0;
6115 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6116 ++idx;
6117 if (li == NULL)
6118 return -1;
6119 return idx;
6123 * Append item "item" to the end of list "l".
6125 static void
6126 list_append(l, item)
6127 list_T *l;
6128 listitem_T *item;
6130 if (l->lv_last == NULL)
6132 /* empty list */
6133 l->lv_first = item;
6134 l->lv_last = item;
6135 item->li_prev = NULL;
6137 else
6139 l->lv_last->li_next = item;
6140 item->li_prev = l->lv_last;
6141 l->lv_last = item;
6143 ++l->lv_len;
6144 item->li_next = NULL;
6148 * Append typval_T "tv" to the end of list "l".
6149 * Return FAIL when out of memory.
6151 static int
6152 list_append_tv(l, tv)
6153 list_T *l;
6154 typval_T *tv;
6156 listitem_T *li = listitem_alloc();
6158 if (li == NULL)
6159 return FAIL;
6160 copy_tv(tv, &li->li_tv);
6161 list_append(l, li);
6162 return OK;
6166 * Add a dictionary to a list. Used by getqflist().
6167 * Return FAIL when out of memory.
6170 list_append_dict(list, dict)
6171 list_T *list;
6172 dict_T *dict;
6174 listitem_T *li = listitem_alloc();
6176 if (li == NULL)
6177 return FAIL;
6178 li->li_tv.v_type = VAR_DICT;
6179 li->li_tv.v_lock = 0;
6180 li->li_tv.vval.v_dict = dict;
6181 list_append(list, li);
6182 ++dict->dv_refcount;
6183 return OK;
6187 * Make a copy of "str" and append it as an item to list "l".
6188 * When "len" >= 0 use "str[len]".
6189 * Returns FAIL when out of memory.
6192 list_append_string(l, str, len)
6193 list_T *l;
6194 char_u *str;
6195 int len;
6197 listitem_T *li = listitem_alloc();
6199 if (li == NULL)
6200 return FAIL;
6201 list_append(l, li);
6202 li->li_tv.v_type = VAR_STRING;
6203 li->li_tv.v_lock = 0;
6204 if (str == NULL)
6205 li->li_tv.vval.v_string = NULL;
6206 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6207 : vim_strsave(str))) == NULL)
6208 return FAIL;
6209 return OK;
6213 * Append "n" to list "l".
6214 * Returns FAIL when out of memory.
6216 static int
6217 list_append_number(l, n)
6218 list_T *l;
6219 varnumber_T n;
6221 listitem_T *li;
6223 li = listitem_alloc();
6224 if (li == NULL)
6225 return FAIL;
6226 li->li_tv.v_type = VAR_NUMBER;
6227 li->li_tv.v_lock = 0;
6228 li->li_tv.vval.v_number = n;
6229 list_append(l, li);
6230 return OK;
6234 * Insert typval_T "tv" in list "l" before "item".
6235 * If "item" is NULL append at the end.
6236 * Return FAIL when out of memory.
6238 static int
6239 list_insert_tv(l, tv, item)
6240 list_T *l;
6241 typval_T *tv;
6242 listitem_T *item;
6244 listitem_T *ni = listitem_alloc();
6246 if (ni == NULL)
6247 return FAIL;
6248 copy_tv(tv, &ni->li_tv);
6249 if (item == NULL)
6250 /* Append new item at end of list. */
6251 list_append(l, ni);
6252 else
6254 /* Insert new item before existing item. */
6255 ni->li_prev = item->li_prev;
6256 ni->li_next = item;
6257 if (item->li_prev == NULL)
6259 l->lv_first = ni;
6260 ++l->lv_idx;
6262 else
6264 item->li_prev->li_next = ni;
6265 l->lv_idx_item = NULL;
6267 item->li_prev = ni;
6268 ++l->lv_len;
6270 return OK;
6274 * Extend "l1" with "l2".
6275 * If "bef" is NULL append at the end, otherwise insert before this item.
6276 * Returns FAIL when out of memory.
6278 static int
6279 list_extend(l1, l2, bef)
6280 list_T *l1;
6281 list_T *l2;
6282 listitem_T *bef;
6284 listitem_T *item;
6285 int todo = l2->lv_len;
6287 /* We also quit the loop when we have inserted the original item count of
6288 * the list, avoid a hang when we extend a list with itself. */
6289 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6290 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6291 return FAIL;
6292 return OK;
6296 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6297 * Return FAIL when out of memory.
6299 static int
6300 list_concat(l1, l2, tv)
6301 list_T *l1;
6302 list_T *l2;
6303 typval_T *tv;
6305 list_T *l;
6307 if (l1 == NULL || l2 == NULL)
6308 return FAIL;
6310 /* make a copy of the first list. */
6311 l = list_copy(l1, FALSE, 0);
6312 if (l == NULL)
6313 return FAIL;
6314 tv->v_type = VAR_LIST;
6315 tv->vval.v_list = l;
6317 /* append all items from the second list */
6318 return list_extend(l, l2, NULL);
6322 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6323 * The refcount of the new list is set to 1.
6324 * See item_copy() for "copyID".
6325 * Returns NULL when out of memory.
6327 static list_T *
6328 list_copy(orig, deep, copyID)
6329 list_T *orig;
6330 int deep;
6331 int copyID;
6333 list_T *copy;
6334 listitem_T *item;
6335 listitem_T *ni;
6337 if (orig == NULL)
6338 return NULL;
6340 copy = list_alloc();
6341 if (copy != NULL)
6343 if (copyID != 0)
6345 /* Do this before adding the items, because one of the items may
6346 * refer back to this list. */
6347 orig->lv_copyID = copyID;
6348 orig->lv_copylist = copy;
6350 for (item = orig->lv_first; item != NULL && !got_int;
6351 item = item->li_next)
6353 ni = listitem_alloc();
6354 if (ni == NULL)
6355 break;
6356 if (deep)
6358 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6360 vim_free(ni);
6361 break;
6364 else
6365 copy_tv(&item->li_tv, &ni->li_tv);
6366 list_append(copy, ni);
6368 ++copy->lv_refcount;
6369 if (item != NULL)
6371 list_unref(copy);
6372 copy = NULL;
6376 return copy;
6380 * Remove items "item" to "item2" from list "l".
6381 * Does not free the listitem or the value!
6383 static void
6384 list_remove(l, item, item2)
6385 list_T *l;
6386 listitem_T *item;
6387 listitem_T *item2;
6389 listitem_T *ip;
6391 /* notify watchers */
6392 for (ip = item; ip != NULL; ip = ip->li_next)
6394 --l->lv_len;
6395 list_fix_watch(l, ip);
6396 if (ip == item2)
6397 break;
6400 if (item2->li_next == NULL)
6401 l->lv_last = item->li_prev;
6402 else
6403 item2->li_next->li_prev = item->li_prev;
6404 if (item->li_prev == NULL)
6405 l->lv_first = item2->li_next;
6406 else
6407 item->li_prev->li_next = item2->li_next;
6408 l->lv_idx_item = NULL;
6412 * Return an allocated string with the string representation of a list.
6413 * May return NULL.
6415 static char_u *
6416 list2string(tv, copyID)
6417 typval_T *tv;
6418 int copyID;
6420 garray_T ga;
6422 if (tv->vval.v_list == NULL)
6423 return NULL;
6424 ga_init2(&ga, (int)sizeof(char), 80);
6425 ga_append(&ga, '[');
6426 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6428 vim_free(ga.ga_data);
6429 return NULL;
6431 ga_append(&ga, ']');
6432 ga_append(&ga, NUL);
6433 return (char_u *)ga.ga_data;
6437 * Join list "l" into a string in "*gap", using separator "sep".
6438 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6439 * Return FAIL or OK.
6441 static int
6442 list_join(gap, l, sep, echo, copyID)
6443 garray_T *gap;
6444 list_T *l;
6445 char_u *sep;
6446 int echo;
6447 int copyID;
6449 int first = TRUE;
6450 char_u *tofree;
6451 char_u numbuf[NUMBUFLEN];
6452 listitem_T *item;
6453 char_u *s;
6455 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6457 if (first)
6458 first = FALSE;
6459 else
6460 ga_concat(gap, sep);
6462 if (echo)
6463 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6464 else
6465 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6466 if (s != NULL)
6467 ga_concat(gap, s);
6468 vim_free(tofree);
6469 if (s == NULL)
6470 return FAIL;
6472 return OK;
6476 * Garbage collection for lists and dictionaries.
6478 * We use reference counts to be able to free most items right away when they
6479 * are no longer used. But for composite items it's possible that it becomes
6480 * unused while the reference count is > 0: When there is a recursive
6481 * reference. Example:
6482 * :let l = [1, 2, 3]
6483 * :let d = {9: l}
6484 * :let l[1] = d
6486 * Since this is quite unusual we handle this with garbage collection: every
6487 * once in a while find out which lists and dicts are not referenced from any
6488 * variable.
6490 * Here is a good reference text about garbage collection (refers to Python
6491 * but it applies to all reference-counting mechanisms):
6492 * http://python.ca/nas/python/gc/
6496 * Do garbage collection for lists and dicts.
6497 * Return TRUE if some memory was freed.
6500 garbage_collect()
6502 int copyID;
6503 buf_T *buf;
6504 win_T *wp;
6505 int i;
6506 funccall_T *fc, **pfc;
6507 int did_free;
6508 int did_free_funccal = FALSE;
6509 #ifdef FEAT_WINDOWS
6510 tabpage_T *tp;
6511 #endif
6513 /* Only do this once. */
6514 want_garbage_collect = FALSE;
6515 may_garbage_collect = FALSE;
6516 garbage_collect_at_exit = FALSE;
6518 /* We advance by two because we add one for items referenced through
6519 * previous_funccal. */
6520 current_copyID += COPYID_INC;
6521 copyID = current_copyID;
6524 * 1. Go through all accessible variables and mark all lists and dicts
6525 * with copyID.
6528 /* Don't free variables in the previous_funccal list unless they are only
6529 * referenced through previous_funccal. This must be first, because if
6530 * the item is referenced elsewhere the funccal must not be freed. */
6531 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6533 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6534 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6537 /* script-local variables */
6538 for (i = 1; i <= ga_scripts.ga_len; ++i)
6539 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6541 /* buffer-local variables */
6542 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6543 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6545 /* window-local variables */
6546 FOR_ALL_TAB_WINDOWS(tp, wp)
6547 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6549 #ifdef FEAT_WINDOWS
6550 /* tabpage-local variables */
6551 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6552 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6553 #endif
6555 /* global variables */
6556 set_ref_in_ht(&globvarht, copyID);
6558 /* function-local variables */
6559 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6561 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6562 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6565 /* v: vars */
6566 set_ref_in_ht(&vimvarht, copyID);
6569 * 2. Free lists and dictionaries that are not referenced.
6571 did_free = free_unref_items(copyID);
6574 * 3. Check if any funccal can be freed now.
6576 for (pfc = &previous_funccal; *pfc != NULL; )
6578 if (can_free_funccal(*pfc, copyID))
6580 fc = *pfc;
6581 *pfc = fc->caller;
6582 free_funccal(fc, TRUE);
6583 did_free = TRUE;
6584 did_free_funccal = TRUE;
6586 else
6587 pfc = &(*pfc)->caller;
6589 if (did_free_funccal)
6590 /* When a funccal was freed some more items might be garbage
6591 * collected, so run again. */
6592 (void)garbage_collect();
6594 return did_free;
6598 * Free lists and dictionaries that are no longer referenced.
6600 static int
6601 free_unref_items(copyID)
6602 int copyID;
6604 dict_T *dd;
6605 list_T *ll;
6606 int did_free = FALSE;
6609 * Go through the list of dicts and free items without the copyID.
6611 for (dd = first_dict; dd != NULL; )
6612 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6614 /* Free the Dictionary and ordinary items it contains, but don't
6615 * recurse into Lists and Dictionaries, they will be in the list
6616 * of dicts or list of lists. */
6617 dict_free(dd, FALSE);
6618 did_free = TRUE;
6620 /* restart, next dict may also have been freed */
6621 dd = first_dict;
6623 else
6624 dd = dd->dv_used_next;
6627 * Go through the list of lists and free items without the copyID.
6628 * But don't free a list that has a watcher (used in a for loop), these
6629 * are not referenced anywhere.
6631 for (ll = first_list; ll != NULL; )
6632 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6633 && ll->lv_watch == NULL)
6635 /* Free the List and ordinary items it contains, but don't recurse
6636 * into Lists and Dictionaries, they will be in the list of dicts
6637 * or list of lists. */
6638 list_free(ll, FALSE);
6639 did_free = TRUE;
6641 /* restart, next list may also have been freed */
6642 ll = first_list;
6644 else
6645 ll = ll->lv_used_next;
6647 return did_free;
6651 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6653 static void
6654 set_ref_in_ht(ht, copyID)
6655 hashtab_T *ht;
6656 int copyID;
6658 int todo;
6659 hashitem_T *hi;
6661 todo = (int)ht->ht_used;
6662 for (hi = ht->ht_array; todo > 0; ++hi)
6663 if (!HASHITEM_EMPTY(hi))
6665 --todo;
6666 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6671 * Mark all lists and dicts referenced through list "l" with "copyID".
6673 static void
6674 set_ref_in_list(l, copyID)
6675 list_T *l;
6676 int copyID;
6678 listitem_T *li;
6680 for (li = l->lv_first; li != NULL; li = li->li_next)
6681 set_ref_in_item(&li->li_tv, copyID);
6685 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6687 static void
6688 set_ref_in_item(tv, copyID)
6689 typval_T *tv;
6690 int copyID;
6692 dict_T *dd;
6693 list_T *ll;
6695 switch (tv->v_type)
6697 case VAR_DICT:
6698 dd = tv->vval.v_dict;
6699 if (dd != NULL && dd->dv_copyID != copyID)
6701 /* Didn't see this dict yet. */
6702 dd->dv_copyID = copyID;
6703 set_ref_in_ht(&dd->dv_hashtab, copyID);
6705 break;
6707 case VAR_LIST:
6708 ll = tv->vval.v_list;
6709 if (ll != NULL && ll->lv_copyID != copyID)
6711 /* Didn't see this list yet. */
6712 ll->lv_copyID = copyID;
6713 set_ref_in_list(ll, copyID);
6715 break;
6717 return;
6721 * Allocate an empty header for a dictionary.
6723 dict_T *
6724 dict_alloc()
6726 dict_T *d;
6728 d = (dict_T *)alloc(sizeof(dict_T));
6729 if (d != NULL)
6731 /* Add the list to the list of dicts for garbage collection. */
6732 if (first_dict != NULL)
6733 first_dict->dv_used_prev = d;
6734 d->dv_used_next = first_dict;
6735 d->dv_used_prev = NULL;
6736 first_dict = d;
6738 hash_init(&d->dv_hashtab);
6739 d->dv_lock = 0;
6740 d->dv_refcount = 0;
6741 d->dv_copyID = 0;
6743 return d;
6747 * Unreference a Dictionary: decrement the reference count and free it when it
6748 * becomes zero.
6750 static void
6751 dict_unref(d)
6752 dict_T *d;
6754 if (d != NULL && --d->dv_refcount <= 0)
6755 dict_free(d, TRUE);
6759 * Free a Dictionary, including all items it contains.
6760 * Ignores the reference count.
6762 static void
6763 dict_free(d, recurse)
6764 dict_T *d;
6765 int recurse; /* Free Lists and Dictionaries recursively. */
6767 int todo;
6768 hashitem_T *hi;
6769 dictitem_T *di;
6771 /* Remove the dict from the list of dicts for garbage collection. */
6772 if (d->dv_used_prev == NULL)
6773 first_dict = d->dv_used_next;
6774 else
6775 d->dv_used_prev->dv_used_next = d->dv_used_next;
6776 if (d->dv_used_next != NULL)
6777 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6779 /* Lock the hashtab, we don't want it to resize while freeing items. */
6780 hash_lock(&d->dv_hashtab);
6781 todo = (int)d->dv_hashtab.ht_used;
6782 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6784 if (!HASHITEM_EMPTY(hi))
6786 /* Remove the item before deleting it, just in case there is
6787 * something recursive causing trouble. */
6788 di = HI2DI(hi);
6789 hash_remove(&d->dv_hashtab, hi);
6790 if (recurse || (di->di_tv.v_type != VAR_LIST
6791 && di->di_tv.v_type != VAR_DICT))
6792 clear_tv(&di->di_tv);
6793 vim_free(di);
6794 --todo;
6797 hash_clear(&d->dv_hashtab);
6798 vim_free(d);
6802 * Allocate a Dictionary item.
6803 * The "key" is copied to the new item.
6804 * Note that the value of the item "di_tv" still needs to be initialized!
6805 * Returns NULL when out of memory.
6807 static dictitem_T *
6808 dictitem_alloc(key)
6809 char_u *key;
6811 dictitem_T *di;
6813 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6814 if (di != NULL)
6816 STRCPY(di->di_key, key);
6817 di->di_flags = 0;
6819 return di;
6823 * Make a copy of a Dictionary item.
6825 static dictitem_T *
6826 dictitem_copy(org)
6827 dictitem_T *org;
6829 dictitem_T *di;
6831 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6832 + STRLEN(org->di_key)));
6833 if (di != NULL)
6835 STRCPY(di->di_key, org->di_key);
6836 di->di_flags = 0;
6837 copy_tv(&org->di_tv, &di->di_tv);
6839 return di;
6843 * Remove item "item" from Dictionary "dict" and free it.
6845 static void
6846 dictitem_remove(dict, item)
6847 dict_T *dict;
6848 dictitem_T *item;
6850 hashitem_T *hi;
6852 hi = hash_find(&dict->dv_hashtab, item->di_key);
6853 if (HASHITEM_EMPTY(hi))
6854 EMSG2(_(e_intern2), "dictitem_remove()");
6855 else
6856 hash_remove(&dict->dv_hashtab, hi);
6857 dictitem_free(item);
6861 * Free a dict item. Also clears the value.
6863 static void
6864 dictitem_free(item)
6865 dictitem_T *item;
6867 clear_tv(&item->di_tv);
6868 vim_free(item);
6872 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6873 * The refcount of the new dict is set to 1.
6874 * See item_copy() for "copyID".
6875 * Returns NULL when out of memory.
6877 static dict_T *
6878 dict_copy(orig, deep, copyID)
6879 dict_T *orig;
6880 int deep;
6881 int copyID;
6883 dict_T *copy;
6884 dictitem_T *di;
6885 int todo;
6886 hashitem_T *hi;
6888 if (orig == NULL)
6889 return NULL;
6891 copy = dict_alloc();
6892 if (copy != NULL)
6894 if (copyID != 0)
6896 orig->dv_copyID = copyID;
6897 orig->dv_copydict = copy;
6899 todo = (int)orig->dv_hashtab.ht_used;
6900 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6902 if (!HASHITEM_EMPTY(hi))
6904 --todo;
6906 di = dictitem_alloc(hi->hi_key);
6907 if (di == NULL)
6908 break;
6909 if (deep)
6911 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6912 copyID) == FAIL)
6914 vim_free(di);
6915 break;
6918 else
6919 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6920 if (dict_add(copy, di) == FAIL)
6922 dictitem_free(di);
6923 break;
6928 ++copy->dv_refcount;
6929 if (todo > 0)
6931 dict_unref(copy);
6932 copy = NULL;
6936 return copy;
6940 * Add item "item" to Dictionary "d".
6941 * Returns FAIL when out of memory and when key already existed.
6943 static int
6944 dict_add(d, item)
6945 dict_T *d;
6946 dictitem_T *item;
6948 return hash_add(&d->dv_hashtab, item->di_key);
6952 * Add a number or string entry to dictionary "d".
6953 * When "str" is NULL use number "nr", otherwise use "str".
6954 * Returns FAIL when out of memory and when key already exists.
6957 dict_add_nr_str(d, key, nr, str)
6958 dict_T *d;
6959 char *key;
6960 long nr;
6961 char_u *str;
6963 dictitem_T *item;
6965 item = dictitem_alloc((char_u *)key);
6966 if (item == NULL)
6967 return FAIL;
6968 item->di_tv.v_lock = 0;
6969 if (str == NULL)
6971 item->di_tv.v_type = VAR_NUMBER;
6972 item->di_tv.vval.v_number = nr;
6974 else
6976 item->di_tv.v_type = VAR_STRING;
6977 item->di_tv.vval.v_string = vim_strsave(str);
6979 if (dict_add(d, item) == FAIL)
6981 dictitem_free(item);
6982 return FAIL;
6984 return OK;
6988 * Get the number of items in a Dictionary.
6990 static long
6991 dict_len(d)
6992 dict_T *d;
6994 if (d == NULL)
6995 return 0L;
6996 return (long)d->dv_hashtab.ht_used;
7000 * Find item "key[len]" in Dictionary "d".
7001 * If "len" is negative use strlen(key).
7002 * Returns NULL when not found.
7004 static dictitem_T *
7005 dict_find(d, key, len)
7006 dict_T *d;
7007 char_u *key;
7008 int len;
7010 #define AKEYLEN 200
7011 char_u buf[AKEYLEN];
7012 char_u *akey;
7013 char_u *tofree = NULL;
7014 hashitem_T *hi;
7016 if (len < 0)
7017 akey = key;
7018 else if (len >= AKEYLEN)
7020 tofree = akey = vim_strnsave(key, len);
7021 if (akey == NULL)
7022 return NULL;
7024 else
7026 /* Avoid a malloc/free by using buf[]. */
7027 vim_strncpy(buf, key, len);
7028 akey = buf;
7031 hi = hash_find(&d->dv_hashtab, akey);
7032 vim_free(tofree);
7033 if (HASHITEM_EMPTY(hi))
7034 return NULL;
7035 return HI2DI(hi);
7039 * Get a string item from a dictionary.
7040 * When "save" is TRUE allocate memory for it.
7041 * Returns NULL if the entry doesn't exist or out of memory.
7043 char_u *
7044 get_dict_string(d, key, save)
7045 dict_T *d;
7046 char_u *key;
7047 int save;
7049 dictitem_T *di;
7050 char_u *s;
7052 di = dict_find(d, key, -1);
7053 if (di == NULL)
7054 return NULL;
7055 s = get_tv_string(&di->di_tv);
7056 if (save && s != NULL)
7057 s = vim_strsave(s);
7058 return s;
7062 * Get a number item from a dictionary.
7063 * Returns 0 if the entry doesn't exist or out of memory.
7065 long
7066 get_dict_number(d, key)
7067 dict_T *d;
7068 char_u *key;
7070 dictitem_T *di;
7072 di = dict_find(d, key, -1);
7073 if (di == NULL)
7074 return 0;
7075 return get_tv_number(&di->di_tv);
7079 * Return an allocated string with the string representation of a Dictionary.
7080 * May return NULL.
7082 static char_u *
7083 dict2string(tv, copyID)
7084 typval_T *tv;
7085 int copyID;
7087 garray_T ga;
7088 int first = TRUE;
7089 char_u *tofree;
7090 char_u numbuf[NUMBUFLEN];
7091 hashitem_T *hi;
7092 char_u *s;
7093 dict_T *d;
7094 int todo;
7096 if ((d = tv->vval.v_dict) == NULL)
7097 return NULL;
7098 ga_init2(&ga, (int)sizeof(char), 80);
7099 ga_append(&ga, '{');
7101 todo = (int)d->dv_hashtab.ht_used;
7102 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7104 if (!HASHITEM_EMPTY(hi))
7106 --todo;
7108 if (first)
7109 first = FALSE;
7110 else
7111 ga_concat(&ga, (char_u *)", ");
7113 tofree = string_quote(hi->hi_key, FALSE);
7114 if (tofree != NULL)
7116 ga_concat(&ga, tofree);
7117 vim_free(tofree);
7119 ga_concat(&ga, (char_u *)": ");
7120 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7121 if (s != NULL)
7122 ga_concat(&ga, s);
7123 vim_free(tofree);
7124 if (s == NULL)
7125 break;
7128 if (todo > 0)
7130 vim_free(ga.ga_data);
7131 return NULL;
7134 ga_append(&ga, '}');
7135 ga_append(&ga, NUL);
7136 return (char_u *)ga.ga_data;
7140 * Allocate a variable for a Dictionary and fill it from "*arg".
7141 * Return OK or FAIL. Returns NOTDONE for {expr}.
7143 static int
7144 get_dict_tv(arg, rettv, evaluate)
7145 char_u **arg;
7146 typval_T *rettv;
7147 int evaluate;
7149 dict_T *d = NULL;
7150 typval_T tvkey;
7151 typval_T tv;
7152 char_u *key = NULL;
7153 dictitem_T *item;
7154 char_u *start = skipwhite(*arg + 1);
7155 char_u buf[NUMBUFLEN];
7158 * First check if it's not a curly-braces thing: {expr}.
7159 * Must do this without evaluating, otherwise a function may be called
7160 * twice. Unfortunately this means we need to call eval1() twice for the
7161 * first item.
7162 * But {} is an empty Dictionary.
7164 if (*start != '}')
7166 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7167 return FAIL;
7168 if (*start == '}')
7169 return NOTDONE;
7172 if (evaluate)
7174 d = dict_alloc();
7175 if (d == NULL)
7176 return FAIL;
7178 tvkey.v_type = VAR_UNKNOWN;
7179 tv.v_type = VAR_UNKNOWN;
7181 *arg = skipwhite(*arg + 1);
7182 while (**arg != '}' && **arg != NUL)
7184 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7185 goto failret;
7186 if (**arg != ':')
7188 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7189 clear_tv(&tvkey);
7190 goto failret;
7192 if (evaluate)
7194 key = get_tv_string_buf_chk(&tvkey, buf);
7195 if (key == NULL || *key == NUL)
7197 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7198 if (key != NULL)
7199 EMSG(_(e_emptykey));
7200 clear_tv(&tvkey);
7201 goto failret;
7205 *arg = skipwhite(*arg + 1);
7206 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7208 if (evaluate)
7209 clear_tv(&tvkey);
7210 goto failret;
7212 if (evaluate)
7214 item = dict_find(d, key, -1);
7215 if (item != NULL)
7217 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7218 clear_tv(&tvkey);
7219 clear_tv(&tv);
7220 goto failret;
7222 item = dictitem_alloc(key);
7223 clear_tv(&tvkey);
7224 if (item != NULL)
7226 item->di_tv = tv;
7227 item->di_tv.v_lock = 0;
7228 if (dict_add(d, item) == FAIL)
7229 dictitem_free(item);
7233 if (**arg == '}')
7234 break;
7235 if (**arg != ',')
7237 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7238 goto failret;
7240 *arg = skipwhite(*arg + 1);
7243 if (**arg != '}')
7245 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7246 failret:
7247 if (evaluate)
7248 dict_free(d, TRUE);
7249 return FAIL;
7252 *arg = skipwhite(*arg + 1);
7253 if (evaluate)
7255 rettv->v_type = VAR_DICT;
7256 rettv->vval.v_dict = d;
7257 ++d->dv_refcount;
7260 return OK;
7264 * Return a string with the string representation of a variable.
7265 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7266 * "numbuf" is used for a number.
7267 * Does not put quotes around strings, as ":echo" displays values.
7268 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7269 * May return NULL.
7271 static char_u *
7272 echo_string(tv, tofree, numbuf, copyID)
7273 typval_T *tv;
7274 char_u **tofree;
7275 char_u *numbuf;
7276 int copyID;
7278 static int recurse = 0;
7279 char_u *r = NULL;
7281 if (recurse >= DICT_MAXNEST)
7283 EMSG(_("E724: variable nested too deep for displaying"));
7284 *tofree = NULL;
7285 return NULL;
7287 ++recurse;
7289 switch (tv->v_type)
7291 case VAR_FUNC:
7292 *tofree = NULL;
7293 r = tv->vval.v_string;
7294 break;
7296 case VAR_LIST:
7297 if (tv->vval.v_list == NULL)
7299 *tofree = NULL;
7300 r = NULL;
7302 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7304 *tofree = NULL;
7305 r = (char_u *)"[...]";
7307 else
7309 tv->vval.v_list->lv_copyID = copyID;
7310 *tofree = list2string(tv, copyID);
7311 r = *tofree;
7313 break;
7315 case VAR_DICT:
7316 if (tv->vval.v_dict == NULL)
7318 *tofree = NULL;
7319 r = NULL;
7321 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7323 *tofree = NULL;
7324 r = (char_u *)"{...}";
7326 else
7328 tv->vval.v_dict->dv_copyID = copyID;
7329 *tofree = dict2string(tv, copyID);
7330 r = *tofree;
7332 break;
7334 case VAR_STRING:
7335 case VAR_NUMBER:
7336 *tofree = NULL;
7337 r = get_tv_string_buf(tv, numbuf);
7338 break;
7340 #ifdef FEAT_FLOAT
7341 case VAR_FLOAT:
7342 *tofree = NULL;
7343 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7344 r = numbuf;
7345 break;
7346 #endif
7348 default:
7349 EMSG2(_(e_intern2), "echo_string()");
7350 *tofree = NULL;
7353 --recurse;
7354 return r;
7358 * Return a string with the string representation of a variable.
7359 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7360 * "numbuf" is used for a number.
7361 * Puts quotes around strings, so that they can be parsed back by eval().
7362 * May return NULL.
7364 static char_u *
7365 tv2string(tv, tofree, numbuf, copyID)
7366 typval_T *tv;
7367 char_u **tofree;
7368 char_u *numbuf;
7369 int copyID;
7371 switch (tv->v_type)
7373 case VAR_FUNC:
7374 *tofree = string_quote(tv->vval.v_string, TRUE);
7375 return *tofree;
7376 case VAR_STRING:
7377 *tofree = string_quote(tv->vval.v_string, FALSE);
7378 return *tofree;
7379 #ifdef FEAT_FLOAT
7380 case VAR_FLOAT:
7381 *tofree = NULL;
7382 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7383 return numbuf;
7384 #endif
7385 case VAR_NUMBER:
7386 case VAR_LIST:
7387 case VAR_DICT:
7388 break;
7389 default:
7390 EMSG2(_(e_intern2), "tv2string()");
7392 return echo_string(tv, tofree, numbuf, copyID);
7396 * Return string "str" in ' quotes, doubling ' characters.
7397 * If "str" is NULL an empty string is assumed.
7398 * If "function" is TRUE make it function('string').
7400 static char_u *
7401 string_quote(str, function)
7402 char_u *str;
7403 int function;
7405 unsigned len;
7406 char_u *p, *r, *s;
7408 len = (function ? 13 : 3);
7409 if (str != NULL)
7411 len += (unsigned)STRLEN(str);
7412 for (p = str; *p != NUL; mb_ptr_adv(p))
7413 if (*p == '\'')
7414 ++len;
7416 s = r = alloc(len);
7417 if (r != NULL)
7419 if (function)
7421 STRCPY(r, "function('");
7422 r += 10;
7424 else
7425 *r++ = '\'';
7426 if (str != NULL)
7427 for (p = str; *p != NUL; )
7429 if (*p == '\'')
7430 *r++ = '\'';
7431 MB_COPY_CHAR(p, r);
7433 *r++ = '\'';
7434 if (function)
7435 *r++ = ')';
7436 *r++ = NUL;
7438 return s;
7441 #ifdef FEAT_FLOAT
7443 * Convert the string "text" to a floating point number.
7444 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7445 * this always uses a decimal point.
7446 * Returns the length of the text that was consumed.
7448 static int
7449 string2float(text, value)
7450 char_u *text;
7451 float_T *value; /* result stored here */
7453 char *s = (char *)text;
7454 float_T f;
7456 f = strtod(s, &s);
7457 *value = f;
7458 return (int)((char_u *)s - text);
7460 #endif
7463 * Get the value of an environment variable.
7464 * "arg" is pointing to the '$'. It is advanced to after the name.
7465 * If the environment variable was not set, silently assume it is empty.
7466 * Always return OK.
7468 static int
7469 get_env_tv(arg, rettv, evaluate)
7470 char_u **arg;
7471 typval_T *rettv;
7472 int evaluate;
7474 char_u *string = NULL;
7475 int len;
7476 int cc;
7477 char_u *name;
7478 int mustfree = FALSE;
7480 ++*arg;
7481 name = *arg;
7482 len = get_env_len(arg);
7483 if (evaluate)
7485 if (len != 0)
7487 cc = name[len];
7488 name[len] = NUL;
7489 /* first try vim_getenv(), fast for normal environment vars */
7490 string = vim_getenv(name, &mustfree);
7491 if (string != NULL && *string != NUL)
7493 if (!mustfree)
7494 string = vim_strsave(string);
7496 else
7498 if (mustfree)
7499 vim_free(string);
7501 /* next try expanding things like $VIM and ${HOME} */
7502 string = expand_env_save(name - 1);
7503 if (string != NULL && *string == '$')
7505 vim_free(string);
7506 string = NULL;
7509 name[len] = cc;
7511 rettv->v_type = VAR_STRING;
7512 rettv->vval.v_string = string;
7515 return OK;
7519 * Array with names and number of arguments of all internal functions
7520 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7522 static struct fst
7524 char *f_name; /* function name */
7525 char f_min_argc; /* minimal number of arguments */
7526 char f_max_argc; /* maximal number of arguments */
7527 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7528 /* implementation of function */
7529 } functions[] =
7531 #ifdef FEAT_FLOAT
7532 {"abs", 1, 1, f_abs},
7533 #endif
7534 {"add", 2, 2, f_add},
7535 {"append", 2, 2, f_append},
7536 {"argc", 0, 0, f_argc},
7537 {"argidx", 0, 0, f_argidx},
7538 {"argv", 0, 1, f_argv},
7539 #ifdef FEAT_FLOAT
7540 {"atan", 1, 1, f_atan},
7541 #endif
7542 {"browse", 4, 4, f_browse},
7543 {"browsedir", 2, 2, f_browsedir},
7544 {"bufexists", 1, 1, f_bufexists},
7545 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7546 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7547 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7548 {"buflisted", 1, 1, f_buflisted},
7549 {"bufloaded", 1, 1, f_bufloaded},
7550 {"bufname", 1, 1, f_bufname},
7551 {"bufnr", 1, 2, f_bufnr},
7552 {"bufwinnr", 1, 1, f_bufwinnr},
7553 {"byte2line", 1, 1, f_byte2line},
7554 {"byteidx", 2, 2, f_byteidx},
7555 {"call", 2, 3, f_call},
7556 #ifdef FEAT_FLOAT
7557 {"ceil", 1, 1, f_ceil},
7558 #endif
7559 {"changenr", 0, 0, f_changenr},
7560 {"char2nr", 1, 1, f_char2nr},
7561 {"cindent", 1, 1, f_cindent},
7562 {"clearmatches", 0, 0, f_clearmatches},
7563 {"col", 1, 1, f_col},
7564 #if defined(FEAT_INS_EXPAND)
7565 {"complete", 2, 2, f_complete},
7566 {"complete_add", 1, 1, f_complete_add},
7567 {"complete_check", 0, 0, f_complete_check},
7568 #endif
7569 {"confirm", 1, 4, f_confirm},
7570 {"copy", 1, 1, f_copy},
7571 #ifdef FEAT_FLOAT
7572 {"cos", 1, 1, f_cos},
7573 #endif
7574 {"count", 2, 4, f_count},
7575 {"cscope_connection",0,3, f_cscope_connection},
7576 {"cursor", 1, 3, f_cursor},
7577 {"deepcopy", 1, 2, f_deepcopy},
7578 {"delete", 1, 1, f_delete},
7579 {"did_filetype", 0, 0, f_did_filetype},
7580 {"diff_filler", 1, 1, f_diff_filler},
7581 {"diff_hlID", 2, 2, f_diff_hlID},
7582 {"empty", 1, 1, f_empty},
7583 {"escape", 2, 2, f_escape},
7584 {"eval", 1, 1, f_eval},
7585 {"eventhandler", 0, 0, f_eventhandler},
7586 {"executable", 1, 1, f_executable},
7587 {"exists", 1, 1, f_exists},
7588 {"expand", 1, 2, f_expand},
7589 {"extend", 2, 3, f_extend},
7590 {"feedkeys", 1, 2, f_feedkeys},
7591 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7592 {"filereadable", 1, 1, f_filereadable},
7593 {"filewritable", 1, 1, f_filewritable},
7594 {"filter", 2, 2, f_filter},
7595 {"finddir", 1, 3, f_finddir},
7596 {"findfile", 1, 3, f_findfile},
7597 #ifdef FEAT_FLOAT
7598 {"float2nr", 1, 1, f_float2nr},
7599 {"floor", 1, 1, f_floor},
7600 #endif
7601 {"fnameescape", 1, 1, f_fnameescape},
7602 {"fnamemodify", 2, 2, f_fnamemodify},
7603 {"foldclosed", 1, 1, f_foldclosed},
7604 {"foldclosedend", 1, 1, f_foldclosedend},
7605 {"foldlevel", 1, 1, f_foldlevel},
7606 {"foldtext", 0, 0, f_foldtext},
7607 {"foldtextresult", 1, 1, f_foldtextresult},
7608 {"foreground", 0, 0, f_foreground},
7609 {"function", 1, 1, f_function},
7610 {"garbagecollect", 0, 1, f_garbagecollect},
7611 {"get", 2, 3, f_get},
7612 {"getbufline", 2, 3, f_getbufline},
7613 {"getbufvar", 2, 2, f_getbufvar},
7614 {"getchar", 0, 1, f_getchar},
7615 {"getcharmod", 0, 0, f_getcharmod},
7616 {"getcmdline", 0, 0, f_getcmdline},
7617 {"getcmdpos", 0, 0, f_getcmdpos},
7618 {"getcmdtype", 0, 0, f_getcmdtype},
7619 {"getcwd", 0, 0, f_getcwd},
7620 {"getfontname", 0, 1, f_getfontname},
7621 {"getfperm", 1, 1, f_getfperm},
7622 {"getfsize", 1, 1, f_getfsize},
7623 {"getftime", 1, 1, f_getftime},
7624 {"getftype", 1, 1, f_getftype},
7625 {"getline", 1, 2, f_getline},
7626 {"getloclist", 1, 1, f_getqflist},
7627 {"getmatches", 0, 0, f_getmatches},
7628 {"getpid", 0, 0, f_getpid},
7629 {"getpos", 1, 1, f_getpos},
7630 {"getqflist", 0, 0, f_getqflist},
7631 {"getreg", 0, 2, f_getreg},
7632 {"getregtype", 0, 1, f_getregtype},
7633 {"gettabwinvar", 3, 3, f_gettabwinvar},
7634 {"getwinposx", 0, 0, f_getwinposx},
7635 {"getwinposy", 0, 0, f_getwinposy},
7636 {"getwinvar", 2, 2, f_getwinvar},
7637 {"glob", 1, 2, f_glob},
7638 {"globpath", 2, 3, f_globpath},
7639 {"has", 1, 1, f_has},
7640 {"has_key", 2, 2, f_has_key},
7641 {"haslocaldir", 0, 0, f_haslocaldir},
7642 {"hasmapto", 1, 3, f_hasmapto},
7643 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7644 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7645 {"histadd", 2, 2, f_histadd},
7646 {"histdel", 1, 2, f_histdel},
7647 {"histget", 1, 2, f_histget},
7648 {"histnr", 1, 1, f_histnr},
7649 {"hlID", 1, 1, f_hlID},
7650 {"hlexists", 1, 1, f_hlexists},
7651 {"hostname", 0, 0, f_hostname},
7652 {"iconv", 3, 3, f_iconv},
7653 {"indent", 1, 1, f_indent},
7654 {"index", 2, 4, f_index},
7655 {"input", 1, 3, f_input},
7656 {"inputdialog", 1, 3, f_inputdialog},
7657 {"inputlist", 1, 1, f_inputlist},
7658 {"inputrestore", 0, 0, f_inputrestore},
7659 {"inputsave", 0, 0, f_inputsave},
7660 {"inputsecret", 1, 2, f_inputsecret},
7661 {"insert", 2, 3, f_insert},
7662 {"isdirectory", 1, 1, f_isdirectory},
7663 {"islocked", 1, 1, f_islocked},
7664 {"items", 1, 1, f_items},
7665 {"join", 1, 2, f_join},
7666 {"keys", 1, 1, f_keys},
7667 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7668 {"len", 1, 1, f_len},
7669 {"libcall", 3, 3, f_libcall},
7670 {"libcallnr", 3, 3, f_libcallnr},
7671 {"line", 1, 1, f_line},
7672 {"line2byte", 1, 1, f_line2byte},
7673 {"lispindent", 1, 1, f_lispindent},
7674 {"localtime", 0, 0, f_localtime},
7675 #ifdef FEAT_FLOAT
7676 {"log10", 1, 1, f_log10},
7677 #endif
7678 {"map", 2, 2, f_map},
7679 {"maparg", 1, 3, f_maparg},
7680 {"mapcheck", 1, 3, f_mapcheck},
7681 {"match", 2, 4, f_match},
7682 {"matchadd", 2, 4, f_matchadd},
7683 {"matcharg", 1, 1, f_matcharg},
7684 {"matchdelete", 1, 1, f_matchdelete},
7685 {"matchend", 2, 4, f_matchend},
7686 {"matchlist", 2, 4, f_matchlist},
7687 {"matchstr", 2, 4, f_matchstr},
7688 {"max", 1, 1, f_max},
7689 {"min", 1, 1, f_min},
7690 #ifdef vim_mkdir
7691 {"mkdir", 1, 3, f_mkdir},
7692 #endif
7693 {"mode", 0, 1, f_mode},
7694 {"nextnonblank", 1, 1, f_nextnonblank},
7695 {"nr2char", 1, 1, f_nr2char},
7696 {"pathshorten", 1, 1, f_pathshorten},
7697 #ifdef FEAT_FLOAT
7698 {"pow", 2, 2, f_pow},
7699 #endif
7700 {"prevnonblank", 1, 1, f_prevnonblank},
7701 {"printf", 2, 19, f_printf},
7702 {"pumvisible", 0, 0, f_pumvisible},
7703 {"range", 1, 3, f_range},
7704 {"readfile", 1, 3, f_readfile},
7705 {"reltime", 0, 2, f_reltime},
7706 {"reltimestr", 1, 1, f_reltimestr},
7707 {"remote_expr", 2, 3, f_remote_expr},
7708 {"remote_foreground", 1, 1, f_remote_foreground},
7709 {"remote_peek", 1, 2, f_remote_peek},
7710 {"remote_read", 1, 1, f_remote_read},
7711 {"remote_send", 2, 3, f_remote_send},
7712 {"remove", 2, 3, f_remove},
7713 {"rename", 2, 2, f_rename},
7714 {"repeat", 2, 2, f_repeat},
7715 {"resolve", 1, 1, f_resolve},
7716 {"reverse", 1, 1, f_reverse},
7717 #ifdef FEAT_FLOAT
7718 {"round", 1, 1, f_round},
7719 #endif
7720 {"search", 1, 4, f_search},
7721 {"searchdecl", 1, 3, f_searchdecl},
7722 {"searchpair", 3, 7, f_searchpair},
7723 {"searchpairpos", 3, 7, f_searchpairpos},
7724 {"searchpos", 1, 4, f_searchpos},
7725 {"server2client", 2, 2, f_server2client},
7726 {"serverlist", 0, 0, f_serverlist},
7727 {"setbufvar", 3, 3, f_setbufvar},
7728 {"setcmdpos", 1, 1, f_setcmdpos},
7729 {"setline", 2, 2, f_setline},
7730 {"setloclist", 2, 3, f_setloclist},
7731 {"setmatches", 1, 1, f_setmatches},
7732 {"setpos", 2, 2, f_setpos},
7733 {"setqflist", 1, 2, f_setqflist},
7734 {"setreg", 2, 3, f_setreg},
7735 {"settabwinvar", 4, 4, f_settabwinvar},
7736 {"setwinvar", 3, 3, f_setwinvar},
7737 {"shellescape", 1, 2, f_shellescape},
7738 {"simplify", 1, 1, f_simplify},
7739 #ifdef FEAT_FLOAT
7740 {"sin", 1, 1, f_sin},
7741 #endif
7742 {"sort", 1, 2, f_sort},
7743 {"soundfold", 1, 1, f_soundfold},
7744 {"spellbadword", 0, 1, f_spellbadword},
7745 {"spellsuggest", 1, 3, f_spellsuggest},
7746 {"split", 1, 3, f_split},
7747 #ifdef FEAT_FLOAT
7748 {"sqrt", 1, 1, f_sqrt},
7749 {"str2float", 1, 1, f_str2float},
7750 #endif
7751 {"str2nr", 1, 2, f_str2nr},
7752 #ifdef HAVE_STRFTIME
7753 {"strftime", 1, 2, f_strftime},
7754 #endif
7755 {"stridx", 2, 3, f_stridx},
7756 {"string", 1, 1, f_string},
7757 {"strlen", 1, 1, f_strlen},
7758 {"strpart", 2, 3, f_strpart},
7759 {"strridx", 2, 3, f_strridx},
7760 {"strtrans", 1, 1, f_strtrans},
7761 {"submatch", 1, 1, f_submatch},
7762 {"substitute", 4, 4, f_substitute},
7763 {"synID", 3, 3, f_synID},
7764 {"synIDattr", 2, 3, f_synIDattr},
7765 {"synIDtrans", 1, 1, f_synIDtrans},
7766 {"synstack", 2, 2, f_synstack},
7767 {"system", 1, 2, f_system},
7768 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7769 {"tabpagenr", 0, 1, f_tabpagenr},
7770 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7771 {"tagfiles", 0, 0, f_tagfiles},
7772 {"taglist", 1, 1, f_taglist},
7773 {"tempname", 0, 0, f_tempname},
7774 {"test", 1, 1, f_test},
7775 {"tolower", 1, 1, f_tolower},
7776 {"toupper", 1, 1, f_toupper},
7777 {"tr", 3, 3, f_tr},
7778 #ifdef FEAT_FLOAT
7779 {"trunc", 1, 1, f_trunc},
7780 #endif
7781 {"type", 1, 1, f_type},
7782 {"values", 1, 1, f_values},
7783 {"virtcol", 1, 1, f_virtcol},
7784 {"visualmode", 0, 1, f_visualmode},
7785 {"winbufnr", 1, 1, f_winbufnr},
7786 {"wincol", 0, 0, f_wincol},
7787 {"winheight", 1, 1, f_winheight},
7788 {"winline", 0, 0, f_winline},
7789 {"winnr", 0, 1, f_winnr},
7790 {"winrestcmd", 0, 0, f_winrestcmd},
7791 {"winrestview", 1, 1, f_winrestview},
7792 {"winsaveview", 0, 0, f_winsaveview},
7793 {"winwidth", 1, 1, f_winwidth},
7794 {"writefile", 2, 3, f_writefile},
7797 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7800 * Function given to ExpandGeneric() to obtain the list of internal
7801 * or user defined function names.
7803 char_u *
7804 get_function_name(xp, idx)
7805 expand_T *xp;
7806 int idx;
7808 static int intidx = -1;
7809 char_u *name;
7811 if (idx == 0)
7812 intidx = -1;
7813 if (intidx < 0)
7815 name = get_user_func_name(xp, idx);
7816 if (name != NULL)
7817 return name;
7819 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7821 STRCPY(IObuff, functions[intidx].f_name);
7822 STRCAT(IObuff, "(");
7823 if (functions[intidx].f_max_argc == 0)
7824 STRCAT(IObuff, ")");
7825 return IObuff;
7828 return NULL;
7832 * Function given to ExpandGeneric() to obtain the list of internal or
7833 * user defined variable or function names.
7835 char_u *
7836 get_expr_name(xp, idx)
7837 expand_T *xp;
7838 int idx;
7840 static int intidx = -1;
7841 char_u *name;
7843 if (idx == 0)
7844 intidx = -1;
7845 if (intidx < 0)
7847 name = get_function_name(xp, idx);
7848 if (name != NULL)
7849 return name;
7851 return get_user_var_name(xp, ++intidx);
7854 #endif /* FEAT_CMDL_COMPL */
7857 * Find internal function in table above.
7858 * Return index, or -1 if not found
7860 static int
7861 find_internal_func(name)
7862 char_u *name; /* name of the function */
7864 int first = 0;
7865 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7866 int cmp;
7867 int x;
7870 * Find the function name in the table. Binary search.
7872 while (first <= last)
7874 x = first + ((unsigned)(last - first) >> 1);
7875 cmp = STRCMP(name, functions[x].f_name);
7876 if (cmp < 0)
7877 last = x - 1;
7878 else if (cmp > 0)
7879 first = x + 1;
7880 else
7881 return x;
7883 return -1;
7887 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7888 * name it contains, otherwise return "name".
7890 static char_u *
7891 deref_func_name(name, lenp)
7892 char_u *name;
7893 int *lenp;
7895 dictitem_T *v;
7896 int cc;
7898 cc = name[*lenp];
7899 name[*lenp] = NUL;
7900 v = find_var(name, NULL);
7901 name[*lenp] = cc;
7902 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7904 if (v->di_tv.vval.v_string == NULL)
7906 *lenp = 0;
7907 return (char_u *)""; /* just in case */
7909 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7910 return v->di_tv.vval.v_string;
7913 return name;
7917 * Allocate a variable for the result of a function.
7918 * Return OK or FAIL.
7920 static int
7921 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7922 evaluate, selfdict)
7923 char_u *name; /* name of the function */
7924 int len; /* length of "name" */
7925 typval_T *rettv;
7926 char_u **arg; /* argument, pointing to the '(' */
7927 linenr_T firstline; /* first line of range */
7928 linenr_T lastline; /* last line of range */
7929 int *doesrange; /* return: function handled range */
7930 int evaluate;
7931 dict_T *selfdict; /* Dictionary for "self" */
7933 char_u *argp;
7934 int ret = OK;
7935 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7936 int argcount = 0; /* number of arguments found */
7939 * Get the arguments.
7941 argp = *arg;
7942 while (argcount < MAX_FUNC_ARGS)
7944 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7945 if (*argp == ')' || *argp == ',' || *argp == NUL)
7946 break;
7947 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7949 ret = FAIL;
7950 break;
7952 ++argcount;
7953 if (*argp != ',')
7954 break;
7956 if (*argp == ')')
7957 ++argp;
7958 else
7959 ret = FAIL;
7961 if (ret == OK)
7962 ret = call_func(name, len, rettv, argcount, argvars,
7963 firstline, lastline, doesrange, evaluate, selfdict);
7964 else if (!aborting())
7966 if (argcount == MAX_FUNC_ARGS)
7967 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
7968 else
7969 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
7972 while (--argcount >= 0)
7973 clear_tv(&argvars[argcount]);
7975 *arg = skipwhite(argp);
7976 return ret;
7981 * Call a function with its resolved parameters
7982 * Return OK when the function can't be called, FAIL otherwise.
7983 * Also returns OK when an error was encountered while executing the function.
7985 static int
7986 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
7987 doesrange, evaluate, selfdict)
7988 char_u *name; /* name of the function */
7989 int len; /* length of "name" */
7990 typval_T *rettv; /* return value goes here */
7991 int argcount; /* number of "argvars" */
7992 typval_T *argvars; /* vars for arguments, must have "argcount"
7993 PLUS ONE elements! */
7994 linenr_T firstline; /* first line of range */
7995 linenr_T lastline; /* last line of range */
7996 int *doesrange; /* return: function handled range */
7997 int evaluate;
7998 dict_T *selfdict; /* Dictionary for "self" */
8000 int ret = FAIL;
8001 #define ERROR_UNKNOWN 0
8002 #define ERROR_TOOMANY 1
8003 #define ERROR_TOOFEW 2
8004 #define ERROR_SCRIPT 3
8005 #define ERROR_DICT 4
8006 #define ERROR_NONE 5
8007 #define ERROR_OTHER 6
8008 int error = ERROR_NONE;
8009 int i;
8010 int llen;
8011 ufunc_T *fp;
8012 int cc;
8013 #define FLEN_FIXED 40
8014 char_u fname_buf[FLEN_FIXED + 1];
8015 char_u *fname;
8018 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8019 * Change <SNR>123_name() to K_SNR 123_name().
8020 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8022 cc = name[len];
8023 name[len] = NUL;
8024 llen = eval_fname_script(name);
8025 if (llen > 0)
8027 fname_buf[0] = K_SPECIAL;
8028 fname_buf[1] = KS_EXTRA;
8029 fname_buf[2] = (int)KE_SNR;
8030 i = 3;
8031 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8033 if (current_SID <= 0)
8034 error = ERROR_SCRIPT;
8035 else
8037 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8038 i = (int)STRLEN(fname_buf);
8041 if (i + STRLEN(name + llen) < FLEN_FIXED)
8043 STRCPY(fname_buf + i, name + llen);
8044 fname = fname_buf;
8046 else
8048 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8049 if (fname == NULL)
8050 error = ERROR_OTHER;
8051 else
8053 mch_memmove(fname, fname_buf, (size_t)i);
8054 STRCPY(fname + i, name + llen);
8058 else
8059 fname = name;
8061 *doesrange = FALSE;
8064 /* execute the function if no errors detected and executing */
8065 if (evaluate && error == ERROR_NONE)
8067 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8068 rettv->vval.v_number = 0;
8069 error = ERROR_UNKNOWN;
8071 if (!builtin_function(fname))
8074 * User defined function.
8076 fp = find_func(fname);
8078 #ifdef FEAT_AUTOCMD
8079 /* Trigger FuncUndefined event, may load the function. */
8080 if (fp == NULL
8081 && apply_autocmds(EVENT_FUNCUNDEFINED,
8082 fname, fname, TRUE, NULL)
8083 && !aborting())
8085 /* executed an autocommand, search for the function again */
8086 fp = find_func(fname);
8088 #endif
8089 /* Try loading a package. */
8090 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8092 /* loaded a package, search for the function again */
8093 fp = find_func(fname);
8096 if (fp != NULL)
8098 if (fp->uf_flags & FC_RANGE)
8099 *doesrange = TRUE;
8100 if (argcount < fp->uf_args.ga_len)
8101 error = ERROR_TOOFEW;
8102 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8103 error = ERROR_TOOMANY;
8104 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8105 error = ERROR_DICT;
8106 else
8109 * Call the user function.
8110 * Save and restore search patterns, script variables and
8111 * redo buffer.
8113 save_search_patterns();
8114 saveRedobuff();
8115 ++fp->uf_calls;
8116 call_user_func(fp, argcount, argvars, rettv,
8117 firstline, lastline,
8118 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8119 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8120 && fp->uf_refcount <= 0)
8121 /* Function was unreferenced while being used, free it
8122 * now. */
8123 func_free(fp);
8124 restoreRedobuff();
8125 restore_search_patterns();
8126 error = ERROR_NONE;
8130 else
8133 * Find the function name in the table, call its implementation.
8135 i = find_internal_func(fname);
8136 if (i >= 0)
8138 if (argcount < functions[i].f_min_argc)
8139 error = ERROR_TOOFEW;
8140 else if (argcount > functions[i].f_max_argc)
8141 error = ERROR_TOOMANY;
8142 else
8144 argvars[argcount].v_type = VAR_UNKNOWN;
8145 functions[i].f_func(argvars, rettv);
8146 error = ERROR_NONE;
8151 * The function call (or "FuncUndefined" autocommand sequence) might
8152 * have been aborted by an error, an interrupt, or an explicitly thrown
8153 * exception that has not been caught so far. This situation can be
8154 * tested for by calling aborting(). For an error in an internal
8155 * function or for the "E132" error in call_user_func(), however, the
8156 * throw point at which the "force_abort" flag (temporarily reset by
8157 * emsg()) is normally updated has not been reached yet. We need to
8158 * update that flag first to make aborting() reliable.
8160 update_force_abort();
8162 if (error == ERROR_NONE)
8163 ret = OK;
8166 * Report an error unless the argument evaluation or function call has been
8167 * cancelled due to an aborting error, an interrupt, or an exception.
8169 if (!aborting())
8171 switch (error)
8173 case ERROR_UNKNOWN:
8174 emsg_funcname(N_("E117: Unknown function: %s"), name);
8175 break;
8176 case ERROR_TOOMANY:
8177 emsg_funcname(e_toomanyarg, name);
8178 break;
8179 case ERROR_TOOFEW:
8180 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8181 name);
8182 break;
8183 case ERROR_SCRIPT:
8184 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8185 name);
8186 break;
8187 case ERROR_DICT:
8188 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8189 name);
8190 break;
8194 name[len] = cc;
8195 if (fname != name && fname != fname_buf)
8196 vim_free(fname);
8198 return ret;
8202 * Give an error message with a function name. Handle <SNR> things.
8203 * "ermsg" is to be passed without translation, use N_() instead of _().
8205 static void
8206 emsg_funcname(ermsg, name)
8207 char *ermsg;
8208 char_u *name;
8210 char_u *p;
8212 if (*name == K_SPECIAL)
8213 p = concat_str((char_u *)"<SNR>", name + 3);
8214 else
8215 p = name;
8216 EMSG2(_(ermsg), p);
8217 if (p != name)
8218 vim_free(p);
8222 * Return TRUE for a non-zero Number and a non-empty String.
8224 static int
8225 non_zero_arg(argvars)
8226 typval_T *argvars;
8228 return ((argvars[0].v_type == VAR_NUMBER
8229 && argvars[0].vval.v_number != 0)
8230 || (argvars[0].v_type == VAR_STRING
8231 && argvars[0].vval.v_string != NULL
8232 && *argvars[0].vval.v_string != NUL));
8235 /*********************************************
8236 * Implementation of the built-in functions
8239 #ifdef FEAT_FLOAT
8241 * "abs(expr)" function
8243 static void
8244 f_abs(argvars, rettv)
8245 typval_T *argvars;
8246 typval_T *rettv;
8248 if (argvars[0].v_type == VAR_FLOAT)
8250 rettv->v_type = VAR_FLOAT;
8251 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8253 else
8255 varnumber_T n;
8256 int error = FALSE;
8258 n = get_tv_number_chk(&argvars[0], &error);
8259 if (error)
8260 rettv->vval.v_number = -1;
8261 else if (n > 0)
8262 rettv->vval.v_number = n;
8263 else
8264 rettv->vval.v_number = -n;
8267 #endif
8270 * "add(list, item)" function
8272 static void
8273 f_add(argvars, rettv)
8274 typval_T *argvars;
8275 typval_T *rettv;
8277 list_T *l;
8279 rettv->vval.v_number = 1; /* Default: Failed */
8280 if (argvars[0].v_type == VAR_LIST)
8282 if ((l = argvars[0].vval.v_list) != NULL
8283 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8284 && list_append_tv(l, &argvars[1]) == OK)
8285 copy_tv(&argvars[0], rettv);
8287 else
8288 EMSG(_(e_listreq));
8292 * "append(lnum, string/list)" function
8294 static void
8295 f_append(argvars, rettv)
8296 typval_T *argvars;
8297 typval_T *rettv;
8299 long lnum;
8300 char_u *line;
8301 list_T *l = NULL;
8302 listitem_T *li = NULL;
8303 typval_T *tv;
8304 long added = 0;
8306 lnum = get_tv_lnum(argvars);
8307 if (lnum >= 0
8308 && lnum <= curbuf->b_ml.ml_line_count
8309 && u_save(lnum, lnum + 1) == OK)
8311 if (argvars[1].v_type == VAR_LIST)
8313 l = argvars[1].vval.v_list;
8314 if (l == NULL)
8315 return;
8316 li = l->lv_first;
8318 for (;;)
8320 if (l == NULL)
8321 tv = &argvars[1]; /* append a string */
8322 else if (li == NULL)
8323 break; /* end of list */
8324 else
8325 tv = &li->li_tv; /* append item from list */
8326 line = get_tv_string_chk(tv);
8327 if (line == NULL) /* type error */
8329 rettv->vval.v_number = 1; /* Failed */
8330 break;
8332 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8333 ++added;
8334 if (l == NULL)
8335 break;
8336 li = li->li_next;
8339 appended_lines_mark(lnum, added);
8340 if (curwin->w_cursor.lnum > lnum)
8341 curwin->w_cursor.lnum += added;
8343 else
8344 rettv->vval.v_number = 1; /* Failed */
8348 * "argc()" function
8350 static void
8351 f_argc(argvars, rettv)
8352 typval_T *argvars UNUSED;
8353 typval_T *rettv;
8355 rettv->vval.v_number = ARGCOUNT;
8359 * "argidx()" function
8361 static void
8362 f_argidx(argvars, rettv)
8363 typval_T *argvars UNUSED;
8364 typval_T *rettv;
8366 rettv->vval.v_number = curwin->w_arg_idx;
8370 * "argv(nr)" function
8372 static void
8373 f_argv(argvars, rettv)
8374 typval_T *argvars;
8375 typval_T *rettv;
8377 int idx;
8379 if (argvars[0].v_type != VAR_UNKNOWN)
8381 idx = get_tv_number_chk(&argvars[0], NULL);
8382 if (idx >= 0 && idx < ARGCOUNT)
8383 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8384 else
8385 rettv->vval.v_string = NULL;
8386 rettv->v_type = VAR_STRING;
8388 else if (rettv_list_alloc(rettv) == OK)
8389 for (idx = 0; idx < ARGCOUNT; ++idx)
8390 list_append_string(rettv->vval.v_list,
8391 alist_name(&ARGLIST[idx]), -1);
8394 #ifdef FEAT_FLOAT
8395 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8398 * Get the float value of "argvars[0]" into "f".
8399 * Returns FAIL when the argument is not a Number or Float.
8401 static int
8402 get_float_arg(argvars, f)
8403 typval_T *argvars;
8404 float_T *f;
8406 if (argvars[0].v_type == VAR_FLOAT)
8408 *f = argvars[0].vval.v_float;
8409 return OK;
8411 if (argvars[0].v_type == VAR_NUMBER)
8413 *f = (float_T)argvars[0].vval.v_number;
8414 return OK;
8416 EMSG(_("E808: Number or Float required"));
8417 return FAIL;
8421 * "atan()" function
8423 static void
8424 f_atan(argvars, rettv)
8425 typval_T *argvars;
8426 typval_T *rettv;
8428 float_T f;
8430 rettv->v_type = VAR_FLOAT;
8431 if (get_float_arg(argvars, &f) == OK)
8432 rettv->vval.v_float = atan(f);
8433 else
8434 rettv->vval.v_float = 0.0;
8436 #endif
8439 * "browse(save, title, initdir, default)" function
8441 static void
8442 f_browse(argvars, rettv)
8443 typval_T *argvars UNUSED;
8444 typval_T *rettv;
8446 #ifdef FEAT_BROWSE
8447 int save;
8448 char_u *title;
8449 char_u *initdir;
8450 char_u *defname;
8451 char_u buf[NUMBUFLEN];
8452 char_u buf2[NUMBUFLEN];
8453 int error = FALSE;
8455 save = get_tv_number_chk(&argvars[0], &error);
8456 title = get_tv_string_chk(&argvars[1]);
8457 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8458 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8460 if (error || title == NULL || initdir == NULL || defname == NULL)
8461 rettv->vval.v_string = NULL;
8462 else
8463 rettv->vval.v_string =
8464 do_browse(save ? BROWSE_SAVE : 0,
8465 title, defname, NULL, initdir, NULL, curbuf);
8466 #else
8467 rettv->vval.v_string = NULL;
8468 #endif
8469 rettv->v_type = VAR_STRING;
8473 * "browsedir(title, initdir)" function
8475 static void
8476 f_browsedir(argvars, rettv)
8477 typval_T *argvars UNUSED;
8478 typval_T *rettv;
8480 #ifdef FEAT_BROWSE
8481 char_u *title;
8482 char_u *initdir;
8483 char_u buf[NUMBUFLEN];
8485 title = get_tv_string_chk(&argvars[0]);
8486 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8488 if (title == NULL || initdir == NULL)
8489 rettv->vval.v_string = NULL;
8490 else
8491 rettv->vval.v_string = do_browse(BROWSE_DIR,
8492 title, NULL, NULL, initdir, NULL, curbuf);
8493 #else
8494 rettv->vval.v_string = NULL;
8495 #endif
8496 rettv->v_type = VAR_STRING;
8499 static buf_T *find_buffer __ARGS((typval_T *avar));
8502 * Find a buffer by number or exact name.
8504 static buf_T *
8505 find_buffer(avar)
8506 typval_T *avar;
8508 buf_T *buf = NULL;
8510 if (avar->v_type == VAR_NUMBER)
8511 buf = buflist_findnr((int)avar->vval.v_number);
8512 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8514 buf = buflist_findname_exp(avar->vval.v_string);
8515 if (buf == NULL)
8517 /* No full path name match, try a match with a URL or a "nofile"
8518 * buffer, these don't use the full path. */
8519 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8520 if (buf->b_fname != NULL
8521 && (path_with_url(buf->b_fname)
8522 #ifdef FEAT_QUICKFIX
8523 || bt_nofile(buf)
8524 #endif
8526 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8527 break;
8530 return buf;
8534 * "bufexists(expr)" function
8536 static void
8537 f_bufexists(argvars, rettv)
8538 typval_T *argvars;
8539 typval_T *rettv;
8541 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8545 * "buflisted(expr)" function
8547 static void
8548 f_buflisted(argvars, rettv)
8549 typval_T *argvars;
8550 typval_T *rettv;
8552 buf_T *buf;
8554 buf = find_buffer(&argvars[0]);
8555 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8559 * "bufloaded(expr)" function
8561 static void
8562 f_bufloaded(argvars, rettv)
8563 typval_T *argvars;
8564 typval_T *rettv;
8566 buf_T *buf;
8568 buf = find_buffer(&argvars[0]);
8569 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8572 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8575 * Get buffer by number or pattern.
8577 static buf_T *
8578 get_buf_tv(tv)
8579 typval_T *tv;
8581 char_u *name = tv->vval.v_string;
8582 int save_magic;
8583 char_u *save_cpo;
8584 buf_T *buf;
8586 if (tv->v_type == VAR_NUMBER)
8587 return buflist_findnr((int)tv->vval.v_number);
8588 if (tv->v_type != VAR_STRING)
8589 return NULL;
8590 if (name == NULL || *name == NUL)
8591 return curbuf;
8592 if (name[0] == '$' && name[1] == NUL)
8593 return lastbuf;
8595 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8596 save_magic = p_magic;
8597 p_magic = TRUE;
8598 save_cpo = p_cpo;
8599 p_cpo = (char_u *)"";
8601 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8602 TRUE, FALSE));
8604 p_magic = save_magic;
8605 p_cpo = save_cpo;
8607 /* If not found, try expanding the name, like done for bufexists(). */
8608 if (buf == NULL)
8609 buf = find_buffer(tv);
8611 return buf;
8615 * "bufname(expr)" function
8617 static void
8618 f_bufname(argvars, rettv)
8619 typval_T *argvars;
8620 typval_T *rettv;
8622 buf_T *buf;
8624 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8625 ++emsg_off;
8626 buf = get_buf_tv(&argvars[0]);
8627 rettv->v_type = VAR_STRING;
8628 if (buf != NULL && buf->b_fname != NULL)
8629 rettv->vval.v_string = vim_strsave(buf->b_fname);
8630 else
8631 rettv->vval.v_string = NULL;
8632 --emsg_off;
8636 * "bufnr(expr)" function
8638 static void
8639 f_bufnr(argvars, rettv)
8640 typval_T *argvars;
8641 typval_T *rettv;
8643 buf_T *buf;
8644 int error = FALSE;
8645 char_u *name;
8647 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8648 ++emsg_off;
8649 buf = get_buf_tv(&argvars[0]);
8650 --emsg_off;
8652 /* If the buffer isn't found and the second argument is not zero create a
8653 * new buffer. */
8654 if (buf == NULL
8655 && argvars[1].v_type != VAR_UNKNOWN
8656 && get_tv_number_chk(&argvars[1], &error) != 0
8657 && !error
8658 && (name = get_tv_string_chk(&argvars[0])) != NULL
8659 && !error)
8660 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8662 if (buf != NULL)
8663 rettv->vval.v_number = buf->b_fnum;
8664 else
8665 rettv->vval.v_number = -1;
8669 * "bufwinnr(nr)" function
8671 static void
8672 f_bufwinnr(argvars, rettv)
8673 typval_T *argvars;
8674 typval_T *rettv;
8676 #ifdef FEAT_WINDOWS
8677 win_T *wp;
8678 int winnr = 0;
8679 #endif
8680 buf_T *buf;
8682 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8683 ++emsg_off;
8684 buf = get_buf_tv(&argvars[0]);
8685 #ifdef FEAT_WINDOWS
8686 for (wp = firstwin; wp; wp = wp->w_next)
8688 ++winnr;
8689 if (wp->w_buffer == buf)
8690 break;
8692 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8693 #else
8694 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8695 #endif
8696 --emsg_off;
8700 * "byte2line(byte)" function
8702 static void
8703 f_byte2line(argvars, rettv)
8704 typval_T *argvars UNUSED;
8705 typval_T *rettv;
8707 #ifndef FEAT_BYTEOFF
8708 rettv->vval.v_number = -1;
8709 #else
8710 long boff = 0;
8712 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8713 if (boff < 0)
8714 rettv->vval.v_number = -1;
8715 else
8716 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8717 (linenr_T)0, &boff);
8718 #endif
8722 * "byteidx()" function
8724 static void
8725 f_byteidx(argvars, rettv)
8726 typval_T *argvars;
8727 typval_T *rettv;
8729 #ifdef FEAT_MBYTE
8730 char_u *t;
8731 #endif
8732 char_u *str;
8733 long idx;
8735 str = get_tv_string_chk(&argvars[0]);
8736 idx = get_tv_number_chk(&argvars[1], NULL);
8737 rettv->vval.v_number = -1;
8738 if (str == NULL || idx < 0)
8739 return;
8741 #ifdef FEAT_MBYTE
8742 t = str;
8743 for ( ; idx > 0; idx--)
8745 if (*t == NUL) /* EOL reached */
8746 return;
8747 t += (*mb_ptr2len)(t);
8749 rettv->vval.v_number = (varnumber_T)(t - str);
8750 #else
8751 if ((size_t)idx <= STRLEN(str))
8752 rettv->vval.v_number = idx;
8753 #endif
8757 * "call(func, arglist)" function
8759 static void
8760 f_call(argvars, rettv)
8761 typval_T *argvars;
8762 typval_T *rettv;
8764 char_u *func;
8765 typval_T argv[MAX_FUNC_ARGS + 1];
8766 int argc = 0;
8767 listitem_T *item;
8768 int dummy;
8769 dict_T *selfdict = NULL;
8771 if (argvars[1].v_type != VAR_LIST)
8773 EMSG(_(e_listreq));
8774 return;
8776 if (argvars[1].vval.v_list == NULL)
8777 return;
8779 if (argvars[0].v_type == VAR_FUNC)
8780 func = argvars[0].vval.v_string;
8781 else
8782 func = get_tv_string(&argvars[0]);
8783 if (*func == NUL)
8784 return; /* type error or empty name */
8786 if (argvars[2].v_type != VAR_UNKNOWN)
8788 if (argvars[2].v_type != VAR_DICT)
8790 EMSG(_(e_dictreq));
8791 return;
8793 selfdict = argvars[2].vval.v_dict;
8796 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
8797 item = item->li_next)
8799 if (argc == MAX_FUNC_ARGS)
8801 EMSG(_("E699: Too many arguments"));
8802 break;
8804 /* Make a copy of each argument. This is needed to be able to set
8805 * v_lock to VAR_FIXED in the copy without changing the original list.
8807 copy_tv(&item->li_tv, &argv[argc++]);
8810 if (item == NULL)
8811 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
8812 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
8813 &dummy, TRUE, selfdict);
8815 /* Free the arguments. */
8816 while (argc > 0)
8817 clear_tv(&argv[--argc]);
8820 #ifdef FEAT_FLOAT
8822 * "ceil({float})" function
8824 static void
8825 f_ceil(argvars, rettv)
8826 typval_T *argvars;
8827 typval_T *rettv;
8829 float_T f;
8831 rettv->v_type = VAR_FLOAT;
8832 if (get_float_arg(argvars, &f) == OK)
8833 rettv->vval.v_float = ceil(f);
8834 else
8835 rettv->vval.v_float = 0.0;
8837 #endif
8840 * "changenr()" function
8842 static void
8843 f_changenr(argvars, rettv)
8844 typval_T *argvars UNUSED;
8845 typval_T *rettv;
8847 rettv->vval.v_number = curbuf->b_u_seq_cur;
8851 * "char2nr(string)" function
8853 static void
8854 f_char2nr(argvars, rettv)
8855 typval_T *argvars;
8856 typval_T *rettv;
8858 #ifdef FEAT_MBYTE
8859 if (has_mbyte)
8860 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
8861 else
8862 #endif
8863 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
8867 * "cindent(lnum)" function
8869 static void
8870 f_cindent(argvars, rettv)
8871 typval_T *argvars;
8872 typval_T *rettv;
8874 #ifdef FEAT_CINDENT
8875 pos_T pos;
8876 linenr_T lnum;
8878 pos = curwin->w_cursor;
8879 lnum = get_tv_lnum(argvars);
8880 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
8882 curwin->w_cursor.lnum = lnum;
8883 rettv->vval.v_number = get_c_indent();
8884 curwin->w_cursor = pos;
8886 else
8887 #endif
8888 rettv->vval.v_number = -1;
8892 * "clearmatches()" function
8894 static void
8895 f_clearmatches(argvars, rettv)
8896 typval_T *argvars UNUSED;
8897 typval_T *rettv UNUSED;
8899 #ifdef FEAT_SEARCH_EXTRA
8900 clear_matches(curwin);
8901 #endif
8905 * "col(string)" function
8907 static void
8908 f_col(argvars, rettv)
8909 typval_T *argvars;
8910 typval_T *rettv;
8912 colnr_T col = 0;
8913 pos_T *fp;
8914 int fnum = curbuf->b_fnum;
8916 fp = var2fpos(&argvars[0], FALSE, &fnum);
8917 if (fp != NULL && fnum == curbuf->b_fnum)
8919 if (fp->col == MAXCOL)
8921 /* '> can be MAXCOL, get the length of the line then */
8922 if (fp->lnum <= curbuf->b_ml.ml_line_count)
8923 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
8924 else
8925 col = MAXCOL;
8927 else
8929 col = fp->col + 1;
8930 #ifdef FEAT_VIRTUALEDIT
8931 /* col(".") when the cursor is on the NUL at the end of the line
8932 * because of "coladd" can be seen as an extra column. */
8933 if (virtual_active() && fp == &curwin->w_cursor)
8935 char_u *p = ml_get_cursor();
8937 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
8938 curwin->w_virtcol - curwin->w_cursor.coladd))
8940 # ifdef FEAT_MBYTE
8941 int l;
8943 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
8944 col += l;
8945 # else
8946 if (*p != NUL && p[1] == NUL)
8947 ++col;
8948 # endif
8951 #endif
8954 rettv->vval.v_number = col;
8957 #if defined(FEAT_INS_EXPAND)
8959 * "complete()" function
8961 static void
8962 f_complete(argvars, rettv)
8963 typval_T *argvars;
8964 typval_T *rettv UNUSED;
8966 int startcol;
8968 if ((State & INSERT) == 0)
8970 EMSG(_("E785: complete() can only be used in Insert mode"));
8971 return;
8974 /* Check for undo allowed here, because if something was already inserted
8975 * the line was already saved for undo and this check isn't done. */
8976 if (!undo_allowed())
8977 return;
8979 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
8981 EMSG(_(e_invarg));
8982 return;
8985 startcol = get_tv_number_chk(&argvars[0], NULL);
8986 if (startcol <= 0)
8987 return;
8989 set_completion(startcol - 1, argvars[1].vval.v_list);
8993 * "complete_add()" function
8995 static void
8996 f_complete_add(argvars, rettv)
8997 typval_T *argvars;
8998 typval_T *rettv;
9000 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9004 * "complete_check()" function
9006 static void
9007 f_complete_check(argvars, rettv)
9008 typval_T *argvars UNUSED;
9009 typval_T *rettv;
9011 int saved = RedrawingDisabled;
9013 RedrawingDisabled = 0;
9014 ins_compl_check_keys(0);
9015 rettv->vval.v_number = compl_interrupted;
9016 RedrawingDisabled = saved;
9018 #endif
9021 * "confirm(message, buttons[, default [, type]])" function
9023 static void
9024 f_confirm(argvars, rettv)
9025 typval_T *argvars UNUSED;
9026 typval_T *rettv UNUSED;
9028 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9029 char_u *message;
9030 char_u *buttons = NULL;
9031 char_u buf[NUMBUFLEN];
9032 char_u buf2[NUMBUFLEN];
9033 int def = 1;
9034 int type = VIM_GENERIC;
9035 char_u *typestr;
9036 int error = FALSE;
9038 message = get_tv_string_chk(&argvars[0]);
9039 if (message == NULL)
9040 error = TRUE;
9041 if (argvars[1].v_type != VAR_UNKNOWN)
9043 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9044 if (buttons == NULL)
9045 error = TRUE;
9046 if (argvars[2].v_type != VAR_UNKNOWN)
9048 def = get_tv_number_chk(&argvars[2], &error);
9049 if (argvars[3].v_type != VAR_UNKNOWN)
9051 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9052 if (typestr == NULL)
9053 error = TRUE;
9054 else
9056 switch (TOUPPER_ASC(*typestr))
9058 case 'E': type = VIM_ERROR; break;
9059 case 'Q': type = VIM_QUESTION; break;
9060 case 'I': type = VIM_INFO; break;
9061 case 'W': type = VIM_WARNING; break;
9062 case 'G': type = VIM_GENERIC; break;
9069 if (buttons == NULL || *buttons == NUL)
9070 buttons = (char_u *)_("&Ok");
9072 if (!error)
9073 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9074 def, NULL);
9075 #endif
9079 * "copy()" function
9081 static void
9082 f_copy(argvars, rettv)
9083 typval_T *argvars;
9084 typval_T *rettv;
9086 item_copy(&argvars[0], rettv, FALSE, 0);
9089 #ifdef FEAT_FLOAT
9091 * "cos()" function
9093 static void
9094 f_cos(argvars, rettv)
9095 typval_T *argvars;
9096 typval_T *rettv;
9098 float_T f;
9100 rettv->v_type = VAR_FLOAT;
9101 if (get_float_arg(argvars, &f) == OK)
9102 rettv->vval.v_float = cos(f);
9103 else
9104 rettv->vval.v_float = 0.0;
9106 #endif
9109 * "count()" function
9111 static void
9112 f_count(argvars, rettv)
9113 typval_T *argvars;
9114 typval_T *rettv;
9116 long n = 0;
9117 int ic = FALSE;
9119 if (argvars[0].v_type == VAR_LIST)
9121 listitem_T *li;
9122 list_T *l;
9123 long idx;
9125 if ((l = argvars[0].vval.v_list) != NULL)
9127 li = l->lv_first;
9128 if (argvars[2].v_type != VAR_UNKNOWN)
9130 int error = FALSE;
9132 ic = get_tv_number_chk(&argvars[2], &error);
9133 if (argvars[3].v_type != VAR_UNKNOWN)
9135 idx = get_tv_number_chk(&argvars[3], &error);
9136 if (!error)
9138 li = list_find(l, idx);
9139 if (li == NULL)
9140 EMSGN(_(e_listidx), idx);
9143 if (error)
9144 li = NULL;
9147 for ( ; li != NULL; li = li->li_next)
9148 if (tv_equal(&li->li_tv, &argvars[1], ic))
9149 ++n;
9152 else if (argvars[0].v_type == VAR_DICT)
9154 int todo;
9155 dict_T *d;
9156 hashitem_T *hi;
9158 if ((d = argvars[0].vval.v_dict) != NULL)
9160 int error = FALSE;
9162 if (argvars[2].v_type != VAR_UNKNOWN)
9164 ic = get_tv_number_chk(&argvars[2], &error);
9165 if (argvars[3].v_type != VAR_UNKNOWN)
9166 EMSG(_(e_invarg));
9169 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9170 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9172 if (!HASHITEM_EMPTY(hi))
9174 --todo;
9175 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9176 ++n;
9181 else
9182 EMSG2(_(e_listdictarg), "count()");
9183 rettv->vval.v_number = n;
9187 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9189 * Checks the existence of a cscope connection.
9191 static void
9192 f_cscope_connection(argvars, rettv)
9193 typval_T *argvars UNUSED;
9194 typval_T *rettv UNUSED;
9196 #ifdef FEAT_CSCOPE
9197 int num = 0;
9198 char_u *dbpath = NULL;
9199 char_u *prepend = NULL;
9200 char_u buf[NUMBUFLEN];
9202 if (argvars[0].v_type != VAR_UNKNOWN
9203 && argvars[1].v_type != VAR_UNKNOWN)
9205 num = (int)get_tv_number(&argvars[0]);
9206 dbpath = get_tv_string(&argvars[1]);
9207 if (argvars[2].v_type != VAR_UNKNOWN)
9208 prepend = get_tv_string_buf(&argvars[2], buf);
9211 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9212 #endif
9216 * "cursor(lnum, col)" function
9218 * Moves the cursor to the specified line and column.
9219 * Returns 0 when the position could be set, -1 otherwise.
9221 static void
9222 f_cursor(argvars, rettv)
9223 typval_T *argvars;
9224 typval_T *rettv;
9226 long line, col;
9227 #ifdef FEAT_VIRTUALEDIT
9228 long coladd = 0;
9229 #endif
9231 rettv->vval.v_number = -1;
9232 if (argvars[1].v_type == VAR_UNKNOWN)
9234 pos_T pos;
9236 if (list2fpos(argvars, &pos, NULL) == FAIL)
9237 return;
9238 line = pos.lnum;
9239 col = pos.col;
9240 #ifdef FEAT_VIRTUALEDIT
9241 coladd = pos.coladd;
9242 #endif
9244 else
9246 line = get_tv_lnum(argvars);
9247 col = get_tv_number_chk(&argvars[1], NULL);
9248 #ifdef FEAT_VIRTUALEDIT
9249 if (argvars[2].v_type != VAR_UNKNOWN)
9250 coladd = get_tv_number_chk(&argvars[2], NULL);
9251 #endif
9253 if (line < 0 || col < 0
9254 #ifdef FEAT_VIRTUALEDIT
9255 || coladd < 0
9256 #endif
9258 return; /* type error; errmsg already given */
9259 if (line > 0)
9260 curwin->w_cursor.lnum = line;
9261 if (col > 0)
9262 curwin->w_cursor.col = col - 1;
9263 #ifdef FEAT_VIRTUALEDIT
9264 curwin->w_cursor.coladd = coladd;
9265 #endif
9267 /* Make sure the cursor is in a valid position. */
9268 check_cursor();
9269 #ifdef FEAT_MBYTE
9270 /* Correct cursor for multi-byte character. */
9271 if (has_mbyte)
9272 mb_adjust_cursor();
9273 #endif
9275 curwin->w_set_curswant = TRUE;
9276 rettv->vval.v_number = 0;
9280 * "deepcopy()" function
9282 static void
9283 f_deepcopy(argvars, rettv)
9284 typval_T *argvars;
9285 typval_T *rettv;
9287 int noref = 0;
9289 if (argvars[1].v_type != VAR_UNKNOWN)
9290 noref = get_tv_number_chk(&argvars[1], NULL);
9291 if (noref < 0 || noref > 1)
9292 EMSG(_(e_invarg));
9293 else
9295 current_copyID += COPYID_INC;
9296 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9301 * "delete()" function
9303 static void
9304 f_delete(argvars, rettv)
9305 typval_T *argvars;
9306 typval_T *rettv;
9308 if (check_restricted() || check_secure())
9309 rettv->vval.v_number = -1;
9310 else
9311 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9315 * "did_filetype()" function
9317 static void
9318 f_did_filetype(argvars, rettv)
9319 typval_T *argvars UNUSED;
9320 typval_T *rettv UNUSED;
9322 #ifdef FEAT_AUTOCMD
9323 rettv->vval.v_number = did_filetype;
9324 #endif
9328 * "diff_filler()" function
9330 static void
9331 f_diff_filler(argvars, rettv)
9332 typval_T *argvars UNUSED;
9333 typval_T *rettv UNUSED;
9335 #ifdef FEAT_DIFF
9336 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9337 #endif
9341 * "diff_hlID()" function
9343 static void
9344 f_diff_hlID(argvars, rettv)
9345 typval_T *argvars UNUSED;
9346 typval_T *rettv UNUSED;
9348 #ifdef FEAT_DIFF
9349 linenr_T lnum = get_tv_lnum(argvars);
9350 static linenr_T prev_lnum = 0;
9351 static int changedtick = 0;
9352 static int fnum = 0;
9353 static int change_start = 0;
9354 static int change_end = 0;
9355 static hlf_T hlID = (hlf_T)0;
9356 int filler_lines;
9357 int col;
9359 if (lnum < 0) /* ignore type error in {lnum} arg */
9360 lnum = 0;
9361 if (lnum != prev_lnum
9362 || changedtick != curbuf->b_changedtick
9363 || fnum != curbuf->b_fnum)
9365 /* New line, buffer, change: need to get the values. */
9366 filler_lines = diff_check(curwin, lnum);
9367 if (filler_lines < 0)
9369 if (filler_lines == -1)
9371 change_start = MAXCOL;
9372 change_end = -1;
9373 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9374 hlID = HLF_ADD; /* added line */
9375 else
9376 hlID = HLF_CHD; /* changed line */
9378 else
9379 hlID = HLF_ADD; /* added line */
9381 else
9382 hlID = (hlf_T)0;
9383 prev_lnum = lnum;
9384 changedtick = curbuf->b_changedtick;
9385 fnum = curbuf->b_fnum;
9388 if (hlID == HLF_CHD || hlID == HLF_TXD)
9390 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9391 if (col >= change_start && col <= change_end)
9392 hlID = HLF_TXD; /* changed text */
9393 else
9394 hlID = HLF_CHD; /* changed line */
9396 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9397 #endif
9401 * "empty({expr})" function
9403 static void
9404 f_empty(argvars, rettv)
9405 typval_T *argvars;
9406 typval_T *rettv;
9408 int n;
9410 switch (argvars[0].v_type)
9412 case VAR_STRING:
9413 case VAR_FUNC:
9414 n = argvars[0].vval.v_string == NULL
9415 || *argvars[0].vval.v_string == NUL;
9416 break;
9417 case VAR_NUMBER:
9418 n = argvars[0].vval.v_number == 0;
9419 break;
9420 #ifdef FEAT_FLOAT
9421 case VAR_FLOAT:
9422 n = argvars[0].vval.v_float == 0.0;
9423 break;
9424 #endif
9425 case VAR_LIST:
9426 n = argvars[0].vval.v_list == NULL
9427 || argvars[0].vval.v_list->lv_first == NULL;
9428 break;
9429 case VAR_DICT:
9430 n = argvars[0].vval.v_dict == NULL
9431 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9432 break;
9433 default:
9434 EMSG2(_(e_intern2), "f_empty()");
9435 n = 0;
9438 rettv->vval.v_number = n;
9442 * "escape({string}, {chars})" function
9444 static void
9445 f_escape(argvars, rettv)
9446 typval_T *argvars;
9447 typval_T *rettv;
9449 char_u buf[NUMBUFLEN];
9451 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9452 get_tv_string_buf(&argvars[1], buf));
9453 rettv->v_type = VAR_STRING;
9457 * "eval()" function
9459 static void
9460 f_eval(argvars, rettv)
9461 typval_T *argvars;
9462 typval_T *rettv;
9464 char_u *s;
9466 s = get_tv_string_chk(&argvars[0]);
9467 if (s != NULL)
9468 s = skipwhite(s);
9470 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9472 rettv->v_type = VAR_NUMBER;
9473 rettv->vval.v_number = 0;
9475 else if (*s != NUL)
9476 EMSG(_(e_trailing));
9480 * "eventhandler()" function
9482 static void
9483 f_eventhandler(argvars, rettv)
9484 typval_T *argvars UNUSED;
9485 typval_T *rettv;
9487 rettv->vval.v_number = vgetc_busy;
9491 * "executable()" function
9493 static void
9494 f_executable(argvars, rettv)
9495 typval_T *argvars;
9496 typval_T *rettv;
9498 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9502 * "exists()" function
9504 static void
9505 f_exists(argvars, rettv)
9506 typval_T *argvars;
9507 typval_T *rettv;
9509 char_u *p;
9510 char_u *name;
9511 int n = FALSE;
9512 int len = 0;
9514 p = get_tv_string(&argvars[0]);
9515 if (*p == '$') /* environment variable */
9517 /* first try "normal" environment variables (fast) */
9518 if (mch_getenv(p + 1) != NULL)
9519 n = TRUE;
9520 else
9522 /* try expanding things like $VIM and ${HOME} */
9523 p = expand_env_save(p);
9524 if (p != NULL && *p != '$')
9525 n = TRUE;
9526 vim_free(p);
9529 else if (*p == '&' || *p == '+') /* option */
9531 n = (get_option_tv(&p, NULL, TRUE) == OK);
9532 if (*skipwhite(p) != NUL)
9533 n = FALSE; /* trailing garbage */
9535 else if (*p == '*') /* internal or user defined function */
9537 n = function_exists(p + 1);
9539 else if (*p == ':')
9541 n = cmd_exists(p + 1);
9543 else if (*p == '#')
9545 #ifdef FEAT_AUTOCMD
9546 if (p[1] == '#')
9547 n = autocmd_supported(p + 2);
9548 else
9549 n = au_exists(p + 1);
9550 #endif
9552 else /* internal variable */
9554 char_u *tofree;
9555 typval_T tv;
9557 /* get_name_len() takes care of expanding curly braces */
9558 name = p;
9559 len = get_name_len(&p, &tofree, TRUE, FALSE);
9560 if (len > 0)
9562 if (tofree != NULL)
9563 name = tofree;
9564 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9565 if (n)
9567 /* handle d.key, l[idx], f(expr) */
9568 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9569 if (n)
9570 clear_tv(&tv);
9573 if (*p != NUL)
9574 n = FALSE;
9576 vim_free(tofree);
9579 rettv->vval.v_number = n;
9583 * "expand()" function
9585 static void
9586 f_expand(argvars, rettv)
9587 typval_T *argvars;
9588 typval_T *rettv;
9590 char_u *s;
9591 int len;
9592 char_u *errormsg;
9593 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9594 expand_T xpc;
9595 int error = FALSE;
9597 rettv->v_type = VAR_STRING;
9598 s = get_tv_string(&argvars[0]);
9599 if (*s == '%' || *s == '#' || *s == '<')
9601 ++emsg_off;
9602 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9603 --emsg_off;
9605 else
9607 /* When the optional second argument is non-zero, don't remove matches
9608 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9609 if (argvars[1].v_type != VAR_UNKNOWN
9610 && get_tv_number_chk(&argvars[1], &error))
9611 flags |= WILD_KEEP_ALL;
9612 if (!error)
9614 ExpandInit(&xpc);
9615 xpc.xp_context = EXPAND_FILES;
9616 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9618 else
9619 rettv->vval.v_string = NULL;
9624 * "extend(list, list [, idx])" function
9625 * "extend(dict, dict [, action])" function
9627 static void
9628 f_extend(argvars, rettv)
9629 typval_T *argvars;
9630 typval_T *rettv;
9632 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9634 list_T *l1, *l2;
9635 listitem_T *item;
9636 long before;
9637 int error = FALSE;
9639 l1 = argvars[0].vval.v_list;
9640 l2 = argvars[1].vval.v_list;
9641 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9642 && l2 != NULL)
9644 if (argvars[2].v_type != VAR_UNKNOWN)
9646 before = get_tv_number_chk(&argvars[2], &error);
9647 if (error)
9648 return; /* type error; errmsg already given */
9650 if (before == l1->lv_len)
9651 item = NULL;
9652 else
9654 item = list_find(l1, before);
9655 if (item == NULL)
9657 EMSGN(_(e_listidx), before);
9658 return;
9662 else
9663 item = NULL;
9664 list_extend(l1, l2, item);
9666 copy_tv(&argvars[0], rettv);
9669 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9671 dict_T *d1, *d2;
9672 dictitem_T *di1;
9673 char_u *action;
9674 int i;
9675 hashitem_T *hi2;
9676 int todo;
9678 d1 = argvars[0].vval.v_dict;
9679 d2 = argvars[1].vval.v_dict;
9680 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9681 && d2 != NULL)
9683 /* Check the third argument. */
9684 if (argvars[2].v_type != VAR_UNKNOWN)
9686 static char *(av[]) = {"keep", "force", "error"};
9688 action = get_tv_string_chk(&argvars[2]);
9689 if (action == NULL)
9690 return; /* type error; errmsg already given */
9691 for (i = 0; i < 3; ++i)
9692 if (STRCMP(action, av[i]) == 0)
9693 break;
9694 if (i == 3)
9696 EMSG2(_(e_invarg2), action);
9697 return;
9700 else
9701 action = (char_u *)"force";
9703 /* Go over all entries in the second dict and add them to the
9704 * first dict. */
9705 todo = (int)d2->dv_hashtab.ht_used;
9706 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9708 if (!HASHITEM_EMPTY(hi2))
9710 --todo;
9711 di1 = dict_find(d1, hi2->hi_key, -1);
9712 if (di1 == NULL)
9714 di1 = dictitem_copy(HI2DI(hi2));
9715 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9716 dictitem_free(di1);
9718 else if (*action == 'e')
9720 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9721 break;
9723 else if (*action == 'f')
9725 clear_tv(&di1->di_tv);
9726 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9731 copy_tv(&argvars[0], rettv);
9734 else
9735 EMSG2(_(e_listdictarg), "extend()");
9739 * "feedkeys()" function
9741 static void
9742 f_feedkeys(argvars, rettv)
9743 typval_T *argvars;
9744 typval_T *rettv UNUSED;
9746 int remap = TRUE;
9747 char_u *keys, *flags;
9748 char_u nbuf[NUMBUFLEN];
9749 int typed = FALSE;
9750 char_u *keys_esc;
9752 /* This is not allowed in the sandbox. If the commands would still be
9753 * executed in the sandbox it would be OK, but it probably happens later,
9754 * when "sandbox" is no longer set. */
9755 if (check_secure())
9756 return;
9758 keys = get_tv_string(&argvars[0]);
9759 if (*keys != NUL)
9761 if (argvars[1].v_type != VAR_UNKNOWN)
9763 flags = get_tv_string_buf(&argvars[1], nbuf);
9764 for ( ; *flags != NUL; ++flags)
9766 switch (*flags)
9768 case 'n': remap = FALSE; break;
9769 case 'm': remap = TRUE; break;
9770 case 't': typed = TRUE; break;
9775 /* Need to escape K_SPECIAL and CSI before putting the string in the
9776 * typeahead buffer. */
9777 keys_esc = vim_strsave_escape_csi(keys);
9778 if (keys_esc != NULL)
9780 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9781 typebuf.tb_len, !typed, FALSE);
9782 vim_free(keys_esc);
9783 if (vgetc_busy)
9784 typebuf_was_filled = TRUE;
9790 * "filereadable()" function
9792 static void
9793 f_filereadable(argvars, rettv)
9794 typval_T *argvars;
9795 typval_T *rettv;
9797 int fd;
9798 char_u *p;
9799 int n;
9801 #ifndef O_NONBLOCK
9802 # define O_NONBLOCK 0
9803 #endif
9804 p = get_tv_string(&argvars[0]);
9805 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
9806 O_RDONLY | O_NONBLOCK, 0)) >= 0)
9808 n = TRUE;
9809 close(fd);
9811 else
9812 n = FALSE;
9814 rettv->vval.v_number = n;
9818 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
9819 * rights to write into.
9821 static void
9822 f_filewritable(argvars, rettv)
9823 typval_T *argvars;
9824 typval_T *rettv;
9826 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
9829 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
9831 static void
9832 findfilendir(argvars, rettv, find_what)
9833 typval_T *argvars;
9834 typval_T *rettv;
9835 int find_what;
9837 #ifdef FEAT_SEARCHPATH
9838 char_u *fname;
9839 char_u *fresult = NULL;
9840 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
9841 char_u *p;
9842 char_u pathbuf[NUMBUFLEN];
9843 int count = 1;
9844 int first = TRUE;
9845 int error = FALSE;
9846 #endif
9848 rettv->vval.v_string = NULL;
9849 rettv->v_type = VAR_STRING;
9851 #ifdef FEAT_SEARCHPATH
9852 fname = get_tv_string(&argvars[0]);
9854 if (argvars[1].v_type != VAR_UNKNOWN)
9856 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
9857 if (p == NULL)
9858 error = TRUE;
9859 else
9861 if (*p != NUL)
9862 path = p;
9864 if (argvars[2].v_type != VAR_UNKNOWN)
9865 count = get_tv_number_chk(&argvars[2], &error);
9869 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
9870 error = TRUE;
9872 if (*fname != NUL && !error)
9876 if (rettv->v_type == VAR_STRING)
9877 vim_free(fresult);
9878 fresult = find_file_in_path_option(first ? fname : NULL,
9879 first ? (int)STRLEN(fname) : 0,
9880 0, first, path,
9881 find_what,
9882 curbuf->b_ffname,
9883 find_what == FINDFILE_DIR
9884 ? (char_u *)"" : curbuf->b_p_sua);
9885 first = FALSE;
9887 if (fresult != NULL && rettv->v_type == VAR_LIST)
9888 list_append_string(rettv->vval.v_list, fresult, -1);
9890 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
9893 if (rettv->v_type == VAR_STRING)
9894 rettv->vval.v_string = fresult;
9895 #endif
9898 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
9899 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
9902 * Implementation of map() and filter().
9904 static void
9905 filter_map(argvars, rettv, map)
9906 typval_T *argvars;
9907 typval_T *rettv;
9908 int map;
9910 char_u buf[NUMBUFLEN];
9911 char_u *expr;
9912 listitem_T *li, *nli;
9913 list_T *l = NULL;
9914 dictitem_T *di;
9915 hashtab_T *ht;
9916 hashitem_T *hi;
9917 dict_T *d = NULL;
9918 typval_T save_val;
9919 typval_T save_key;
9920 int rem;
9921 int todo;
9922 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
9923 int save_did_emsg;
9925 if (argvars[0].v_type == VAR_LIST)
9927 if ((l = argvars[0].vval.v_list) == NULL
9928 || (map && tv_check_lock(l->lv_lock, ermsg)))
9929 return;
9931 else if (argvars[0].v_type == VAR_DICT)
9933 if ((d = argvars[0].vval.v_dict) == NULL
9934 || (map && tv_check_lock(d->dv_lock, ermsg)))
9935 return;
9937 else
9939 EMSG2(_(e_listdictarg), ermsg);
9940 return;
9943 expr = get_tv_string_buf_chk(&argvars[1], buf);
9944 /* On type errors, the preceding call has already displayed an error
9945 * message. Avoid a misleading error message for an empty string that
9946 * was not passed as argument. */
9947 if (expr != NULL)
9949 prepare_vimvar(VV_VAL, &save_val);
9950 expr = skipwhite(expr);
9952 /* We reset "did_emsg" to be able to detect whether an error
9953 * occurred during evaluation of the expression. */
9954 save_did_emsg = did_emsg;
9955 did_emsg = FALSE;
9957 if (argvars[0].v_type == VAR_DICT)
9959 prepare_vimvar(VV_KEY, &save_key);
9960 vimvars[VV_KEY].vv_type = VAR_STRING;
9962 ht = &d->dv_hashtab;
9963 hash_lock(ht);
9964 todo = (int)ht->ht_used;
9965 for (hi = ht->ht_array; todo > 0; ++hi)
9967 if (!HASHITEM_EMPTY(hi))
9969 --todo;
9970 di = HI2DI(hi);
9971 if (tv_check_lock(di->di_tv.v_lock, ermsg))
9972 break;
9973 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
9974 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
9975 || did_emsg)
9976 break;
9977 if (!map && rem)
9978 dictitem_remove(d, di);
9979 clear_tv(&vimvars[VV_KEY].vv_tv);
9982 hash_unlock(ht);
9984 restore_vimvar(VV_KEY, &save_key);
9986 else
9988 for (li = l->lv_first; li != NULL; li = nli)
9990 if (tv_check_lock(li->li_tv.v_lock, ermsg))
9991 break;
9992 nli = li->li_next;
9993 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
9994 || did_emsg)
9995 break;
9996 if (!map && rem)
9997 listitem_remove(l, li);
10001 restore_vimvar(VV_VAL, &save_val);
10003 did_emsg |= save_did_emsg;
10006 copy_tv(&argvars[0], rettv);
10009 static int
10010 filter_map_one(tv, expr, map, remp)
10011 typval_T *tv;
10012 char_u *expr;
10013 int map;
10014 int *remp;
10016 typval_T rettv;
10017 char_u *s;
10018 int retval = FAIL;
10020 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10021 s = expr;
10022 if (eval1(&s, &rettv, TRUE) == FAIL)
10023 goto theend;
10024 if (*s != NUL) /* check for trailing chars after expr */
10026 EMSG2(_(e_invexpr2), s);
10027 goto theend;
10029 if (map)
10031 /* map(): replace the list item value */
10032 clear_tv(tv);
10033 rettv.v_lock = 0;
10034 *tv = rettv;
10036 else
10038 int error = FALSE;
10040 /* filter(): when expr is zero remove the item */
10041 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10042 clear_tv(&rettv);
10043 /* On type error, nothing has been removed; return FAIL to stop the
10044 * loop. The error message was given by get_tv_number_chk(). */
10045 if (error)
10046 goto theend;
10048 retval = OK;
10049 theend:
10050 clear_tv(&vimvars[VV_VAL].vv_tv);
10051 return retval;
10055 * "filter()" function
10057 static void
10058 f_filter(argvars, rettv)
10059 typval_T *argvars;
10060 typval_T *rettv;
10062 filter_map(argvars, rettv, FALSE);
10066 * "finddir({fname}[, {path}[, {count}]])" function
10068 static void
10069 f_finddir(argvars, rettv)
10070 typval_T *argvars;
10071 typval_T *rettv;
10073 findfilendir(argvars, rettv, FINDFILE_DIR);
10077 * "findfile({fname}[, {path}[, {count}]])" function
10079 static void
10080 f_findfile(argvars, rettv)
10081 typval_T *argvars;
10082 typval_T *rettv;
10084 findfilendir(argvars, rettv, FINDFILE_FILE);
10087 #ifdef FEAT_FLOAT
10089 * "float2nr({float})" function
10091 static void
10092 f_float2nr(argvars, rettv)
10093 typval_T *argvars;
10094 typval_T *rettv;
10096 float_T f;
10098 if (get_float_arg(argvars, &f) == OK)
10100 if (f < -0x7fffffff)
10101 rettv->vval.v_number = -0x7fffffff;
10102 else if (f > 0x7fffffff)
10103 rettv->vval.v_number = 0x7fffffff;
10104 else
10105 rettv->vval.v_number = (varnumber_T)f;
10110 * "floor({float})" function
10112 static void
10113 f_floor(argvars, rettv)
10114 typval_T *argvars;
10115 typval_T *rettv;
10117 float_T f;
10119 rettv->v_type = VAR_FLOAT;
10120 if (get_float_arg(argvars, &f) == OK)
10121 rettv->vval.v_float = floor(f);
10122 else
10123 rettv->vval.v_float = 0.0;
10125 #endif
10128 * "fnameescape({string})" function
10130 static void
10131 f_fnameescape(argvars, rettv)
10132 typval_T *argvars;
10133 typval_T *rettv;
10135 rettv->vval.v_string = vim_strsave_fnameescape(
10136 get_tv_string(&argvars[0]), FALSE);
10137 rettv->v_type = VAR_STRING;
10141 * "fnamemodify({fname}, {mods})" function
10143 static void
10144 f_fnamemodify(argvars, rettv)
10145 typval_T *argvars;
10146 typval_T *rettv;
10148 char_u *fname;
10149 char_u *mods;
10150 int usedlen = 0;
10151 int len;
10152 char_u *fbuf = NULL;
10153 char_u buf[NUMBUFLEN];
10155 fname = get_tv_string_chk(&argvars[0]);
10156 mods = get_tv_string_buf_chk(&argvars[1], buf);
10157 if (fname == NULL || mods == NULL)
10158 fname = NULL;
10159 else
10161 len = (int)STRLEN(fname);
10162 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10165 rettv->v_type = VAR_STRING;
10166 if (fname == NULL)
10167 rettv->vval.v_string = NULL;
10168 else
10169 rettv->vval.v_string = vim_strnsave(fname, len);
10170 vim_free(fbuf);
10173 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10176 * "foldclosed()" function
10178 static void
10179 foldclosed_both(argvars, rettv, end)
10180 typval_T *argvars;
10181 typval_T *rettv;
10182 int end;
10184 #ifdef FEAT_FOLDING
10185 linenr_T lnum;
10186 linenr_T first, last;
10188 lnum = get_tv_lnum(argvars);
10189 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10191 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10193 if (end)
10194 rettv->vval.v_number = (varnumber_T)last;
10195 else
10196 rettv->vval.v_number = (varnumber_T)first;
10197 return;
10200 #endif
10201 rettv->vval.v_number = -1;
10205 * "foldclosed()" function
10207 static void
10208 f_foldclosed(argvars, rettv)
10209 typval_T *argvars;
10210 typval_T *rettv;
10212 foldclosed_both(argvars, rettv, FALSE);
10216 * "foldclosedend()" function
10218 static void
10219 f_foldclosedend(argvars, rettv)
10220 typval_T *argvars;
10221 typval_T *rettv;
10223 foldclosed_both(argvars, rettv, TRUE);
10227 * "foldlevel()" function
10229 static void
10230 f_foldlevel(argvars, rettv)
10231 typval_T *argvars;
10232 typval_T *rettv;
10234 #ifdef FEAT_FOLDING
10235 linenr_T lnum;
10237 lnum = get_tv_lnum(argvars);
10238 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10239 rettv->vval.v_number = foldLevel(lnum);
10240 #endif
10244 * "foldtext()" function
10246 static void
10247 f_foldtext(argvars, rettv)
10248 typval_T *argvars UNUSED;
10249 typval_T *rettv;
10251 #ifdef FEAT_FOLDING
10252 linenr_T lnum;
10253 char_u *s;
10254 char_u *r;
10255 int len;
10256 char *txt;
10257 #endif
10259 rettv->v_type = VAR_STRING;
10260 rettv->vval.v_string = NULL;
10261 #ifdef FEAT_FOLDING
10262 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10263 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10264 <= curbuf->b_ml.ml_line_count
10265 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10267 /* Find first non-empty line in the fold. */
10268 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10269 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10271 if (!linewhite(lnum))
10272 break;
10273 ++lnum;
10276 /* Find interesting text in this line. */
10277 s = skipwhite(ml_get(lnum));
10278 /* skip C comment-start */
10279 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10281 s = skipwhite(s + 2);
10282 if (*skipwhite(s) == NUL
10283 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10285 s = skipwhite(ml_get(lnum + 1));
10286 if (*s == '*')
10287 s = skipwhite(s + 1);
10290 txt = _("+-%s%3ld lines: ");
10291 r = alloc((unsigned)(STRLEN(txt)
10292 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10293 + 20 /* for %3ld */
10294 + STRLEN(s))); /* concatenated */
10295 if (r != NULL)
10297 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10298 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10299 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10300 len = (int)STRLEN(r);
10301 STRCAT(r, s);
10302 /* remove 'foldmarker' and 'commentstring' */
10303 foldtext_cleanup(r + len);
10304 rettv->vval.v_string = r;
10307 #endif
10311 * "foldtextresult(lnum)" function
10313 static void
10314 f_foldtextresult(argvars, rettv)
10315 typval_T *argvars UNUSED;
10316 typval_T *rettv;
10318 #ifdef FEAT_FOLDING
10319 linenr_T lnum;
10320 char_u *text;
10321 char_u buf[51];
10322 foldinfo_T foldinfo;
10323 int fold_count;
10324 #endif
10326 rettv->v_type = VAR_STRING;
10327 rettv->vval.v_string = NULL;
10328 #ifdef FEAT_FOLDING
10329 lnum = get_tv_lnum(argvars);
10330 /* treat illegal types and illegal string values for {lnum} the same */
10331 if (lnum < 0)
10332 lnum = 0;
10333 fold_count = foldedCount(curwin, lnum, &foldinfo);
10334 if (fold_count > 0)
10336 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10337 &foldinfo, buf);
10338 if (text == buf)
10339 text = vim_strsave(text);
10340 rettv->vval.v_string = text;
10342 #endif
10346 * "foreground()" function
10348 static void
10349 f_foreground(argvars, rettv)
10350 typval_T *argvars UNUSED;
10351 typval_T *rettv UNUSED;
10353 #ifdef FEAT_GUI
10354 if (gui.in_use)
10355 gui_mch_set_foreground();
10356 #else
10357 # ifdef WIN32
10358 win32_set_foreground();
10359 # endif
10360 #endif
10364 * "function()" function
10366 static void
10367 f_function(argvars, rettv)
10368 typval_T *argvars;
10369 typval_T *rettv;
10371 char_u *s;
10373 s = get_tv_string(&argvars[0]);
10374 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10375 EMSG2(_(e_invarg2), s);
10376 /* Don't check an autoload name for existence here. */
10377 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10378 EMSG2(_("E700: Unknown function: %s"), s);
10379 else
10381 rettv->vval.v_string = vim_strsave(s);
10382 rettv->v_type = VAR_FUNC;
10387 * "garbagecollect()" function
10389 static void
10390 f_garbagecollect(argvars, rettv)
10391 typval_T *argvars;
10392 typval_T *rettv UNUSED;
10394 /* This is postponed until we are back at the toplevel, because we may be
10395 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10396 want_garbage_collect = TRUE;
10398 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10399 garbage_collect_at_exit = TRUE;
10403 * "get()" function
10405 static void
10406 f_get(argvars, rettv)
10407 typval_T *argvars;
10408 typval_T *rettv;
10410 listitem_T *li;
10411 list_T *l;
10412 dictitem_T *di;
10413 dict_T *d;
10414 typval_T *tv = NULL;
10416 if (argvars[0].v_type == VAR_LIST)
10418 if ((l = argvars[0].vval.v_list) != NULL)
10420 int error = FALSE;
10422 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10423 if (!error && li != NULL)
10424 tv = &li->li_tv;
10427 else if (argvars[0].v_type == VAR_DICT)
10429 if ((d = argvars[0].vval.v_dict) != NULL)
10431 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10432 if (di != NULL)
10433 tv = &di->di_tv;
10436 else
10437 EMSG2(_(e_listdictarg), "get()");
10439 if (tv == NULL)
10441 if (argvars[2].v_type != VAR_UNKNOWN)
10442 copy_tv(&argvars[2], rettv);
10444 else
10445 copy_tv(tv, rettv);
10448 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10451 * Get line or list of lines from buffer "buf" into "rettv".
10452 * Return a range (from start to end) of lines in rettv from the specified
10453 * buffer.
10454 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10456 static void
10457 get_buffer_lines(buf, start, end, retlist, rettv)
10458 buf_T *buf;
10459 linenr_T start;
10460 linenr_T end;
10461 int retlist;
10462 typval_T *rettv;
10464 char_u *p;
10466 if (retlist && rettv_list_alloc(rettv) == FAIL)
10467 return;
10469 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10470 return;
10472 if (!retlist)
10474 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10475 p = ml_get_buf(buf, start, FALSE);
10476 else
10477 p = (char_u *)"";
10479 rettv->v_type = VAR_STRING;
10480 rettv->vval.v_string = vim_strsave(p);
10482 else
10484 if (end < start)
10485 return;
10487 if (start < 1)
10488 start = 1;
10489 if (end > buf->b_ml.ml_line_count)
10490 end = buf->b_ml.ml_line_count;
10491 while (start <= end)
10492 if (list_append_string(rettv->vval.v_list,
10493 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10494 break;
10499 * "getbufline()" function
10501 static void
10502 f_getbufline(argvars, rettv)
10503 typval_T *argvars;
10504 typval_T *rettv;
10506 linenr_T lnum;
10507 linenr_T end;
10508 buf_T *buf;
10510 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10511 ++emsg_off;
10512 buf = get_buf_tv(&argvars[0]);
10513 --emsg_off;
10515 lnum = get_tv_lnum_buf(&argvars[1], buf);
10516 if (argvars[2].v_type == VAR_UNKNOWN)
10517 end = lnum;
10518 else
10519 end = get_tv_lnum_buf(&argvars[2], buf);
10521 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10525 * "getbufvar()" function
10527 static void
10528 f_getbufvar(argvars, rettv)
10529 typval_T *argvars;
10530 typval_T *rettv;
10532 buf_T *buf;
10533 buf_T *save_curbuf;
10534 char_u *varname;
10535 dictitem_T *v;
10537 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10538 varname = get_tv_string_chk(&argvars[1]);
10539 ++emsg_off;
10540 buf = get_buf_tv(&argvars[0]);
10542 rettv->v_type = VAR_STRING;
10543 rettv->vval.v_string = NULL;
10545 if (buf != NULL && varname != NULL)
10547 /* set curbuf to be our buf, temporarily */
10548 save_curbuf = curbuf;
10549 curbuf = buf;
10551 if (*varname == '&') /* buffer-local-option */
10552 get_option_tv(&varname, rettv, TRUE);
10553 else
10555 if (*varname == NUL)
10556 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10557 * scope prefix before the NUL byte is required by
10558 * find_var_in_ht(). */
10559 varname = (char_u *)"b:" + 2;
10560 /* look up the variable */
10561 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10562 if (v != NULL)
10563 copy_tv(&v->di_tv, rettv);
10566 /* restore previous notion of curbuf */
10567 curbuf = save_curbuf;
10570 --emsg_off;
10574 * "getchar()" function
10576 static void
10577 f_getchar(argvars, rettv)
10578 typval_T *argvars;
10579 typval_T *rettv;
10581 varnumber_T n;
10582 int error = FALSE;
10584 /* Position the cursor. Needed after a message that ends in a space. */
10585 windgoto(msg_row, msg_col);
10587 ++no_mapping;
10588 ++allow_keys;
10589 for (;;)
10591 if (argvars[0].v_type == VAR_UNKNOWN)
10592 /* getchar(): blocking wait. */
10593 n = safe_vgetc();
10594 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10595 /* getchar(1): only check if char avail */
10596 n = vpeekc();
10597 else if (error || vpeekc() == NUL)
10598 /* illegal argument or getchar(0) and no char avail: return zero */
10599 n = 0;
10600 else
10601 /* getchar(0) and char avail: return char */
10602 n = safe_vgetc();
10603 if (n == K_IGNORE)
10604 continue;
10605 break;
10607 --no_mapping;
10608 --allow_keys;
10610 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10611 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10612 vimvars[VV_MOUSE_COL].vv_nr = 0;
10614 rettv->vval.v_number = n;
10615 if (IS_SPECIAL(n) || mod_mask != 0)
10617 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10618 int i = 0;
10620 /* Turn a special key into three bytes, plus modifier. */
10621 if (mod_mask != 0)
10623 temp[i++] = K_SPECIAL;
10624 temp[i++] = KS_MODIFIER;
10625 temp[i++] = mod_mask;
10627 if (IS_SPECIAL(n))
10629 temp[i++] = K_SPECIAL;
10630 temp[i++] = K_SECOND(n);
10631 temp[i++] = K_THIRD(n);
10633 #ifdef FEAT_MBYTE
10634 else if (has_mbyte)
10635 i += (*mb_char2bytes)(n, temp + i);
10636 #endif
10637 else
10638 temp[i++] = n;
10639 temp[i++] = NUL;
10640 rettv->v_type = VAR_STRING;
10641 rettv->vval.v_string = vim_strsave(temp);
10643 #ifdef FEAT_MOUSE
10644 if (n == K_LEFTMOUSE
10645 || n == K_LEFTMOUSE_NM
10646 || n == K_LEFTDRAG
10647 || n == K_LEFTRELEASE
10648 || n == K_LEFTRELEASE_NM
10649 || n == K_MIDDLEMOUSE
10650 || n == K_MIDDLEDRAG
10651 || n == K_MIDDLERELEASE
10652 || n == K_RIGHTMOUSE
10653 || n == K_RIGHTDRAG
10654 || n == K_RIGHTRELEASE
10655 || n == K_X1MOUSE
10656 || n == K_X1DRAG
10657 || n == K_X1RELEASE
10658 || n == K_X2MOUSE
10659 || n == K_X2DRAG
10660 || n == K_X2RELEASE
10661 || n == K_MOUSEDOWN
10662 || n == K_MOUSEUP)
10664 int row = mouse_row;
10665 int col = mouse_col;
10666 win_T *win;
10667 linenr_T lnum;
10668 # ifdef FEAT_WINDOWS
10669 win_T *wp;
10670 # endif
10671 int winnr = 1;
10673 if (row >= 0 && col >= 0)
10675 /* Find the window at the mouse coordinates and compute the
10676 * text position. */
10677 win = mouse_find_win(&row, &col);
10678 (void)mouse_comp_pos(win, &row, &col, &lnum);
10679 # ifdef FEAT_WINDOWS
10680 for (wp = firstwin; wp != win; wp = wp->w_next)
10681 ++winnr;
10682 # endif
10683 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10684 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10685 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10688 #endif
10693 * "getcharmod()" function
10695 static void
10696 f_getcharmod(argvars, rettv)
10697 typval_T *argvars UNUSED;
10698 typval_T *rettv;
10700 rettv->vval.v_number = mod_mask;
10704 * "getcmdline()" function
10706 static void
10707 f_getcmdline(argvars, rettv)
10708 typval_T *argvars UNUSED;
10709 typval_T *rettv;
10711 rettv->v_type = VAR_STRING;
10712 rettv->vval.v_string = get_cmdline_str();
10716 * "getcmdpos()" function
10718 static void
10719 f_getcmdpos(argvars, rettv)
10720 typval_T *argvars UNUSED;
10721 typval_T *rettv;
10723 rettv->vval.v_number = get_cmdline_pos() + 1;
10727 * "getcmdtype()" function
10729 static void
10730 f_getcmdtype(argvars, rettv)
10731 typval_T *argvars UNUSED;
10732 typval_T *rettv;
10734 rettv->v_type = VAR_STRING;
10735 rettv->vval.v_string = alloc(2);
10736 if (rettv->vval.v_string != NULL)
10738 rettv->vval.v_string[0] = get_cmdline_type();
10739 rettv->vval.v_string[1] = NUL;
10744 * "getcwd()" function
10746 static void
10747 f_getcwd(argvars, rettv)
10748 typval_T *argvars UNUSED;
10749 typval_T *rettv;
10751 char_u cwd[MAXPATHL];
10753 rettv->v_type = VAR_STRING;
10754 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10755 rettv->vval.v_string = NULL;
10756 else
10758 rettv->vval.v_string = vim_strsave(cwd);
10759 #ifdef BACKSLASH_IN_FILENAME
10760 if (rettv->vval.v_string != NULL)
10761 slash_adjust(rettv->vval.v_string);
10762 #endif
10767 * "getfontname()" function
10769 static void
10770 f_getfontname(argvars, rettv)
10771 typval_T *argvars UNUSED;
10772 typval_T *rettv;
10774 rettv->v_type = VAR_STRING;
10775 rettv->vval.v_string = NULL;
10776 #ifdef FEAT_GUI
10777 if (gui.in_use)
10779 GuiFont font;
10780 char_u *name = NULL;
10782 if (argvars[0].v_type == VAR_UNKNOWN)
10784 /* Get the "Normal" font. Either the name saved by
10785 * hl_set_font_name() or from the font ID. */
10786 font = gui.norm_font;
10787 name = hl_get_font_name();
10789 else
10791 name = get_tv_string(&argvars[0]);
10792 if (STRCMP(name, "*") == 0) /* don't use font dialog */
10793 return;
10794 font = gui_mch_get_font(name, FALSE);
10795 if (font == NOFONT)
10796 return; /* Invalid font name, return empty string. */
10798 rettv->vval.v_string = gui_mch_get_fontname(font, name);
10799 if (argvars[0].v_type != VAR_UNKNOWN)
10800 gui_mch_free_font(font);
10802 #endif
10806 * "getfperm({fname})" function
10808 static void
10809 f_getfperm(argvars, rettv)
10810 typval_T *argvars;
10811 typval_T *rettv;
10813 char_u *fname;
10814 struct stat st;
10815 char_u *perm = NULL;
10816 char_u flags[] = "rwx";
10817 int i;
10819 fname = get_tv_string(&argvars[0]);
10821 rettv->v_type = VAR_STRING;
10822 if (mch_stat((char *)fname, &st) >= 0)
10824 perm = vim_strsave((char_u *)"---------");
10825 if (perm != NULL)
10827 for (i = 0; i < 9; i++)
10829 if (st.st_mode & (1 << (8 - i)))
10830 perm[i] = flags[i % 3];
10834 rettv->vval.v_string = perm;
10838 * "getfsize({fname})" function
10840 static void
10841 f_getfsize(argvars, rettv)
10842 typval_T *argvars;
10843 typval_T *rettv;
10845 char_u *fname;
10846 struct stat st;
10848 fname = get_tv_string(&argvars[0]);
10850 rettv->v_type = VAR_NUMBER;
10852 if (mch_stat((char *)fname, &st) >= 0)
10854 if (mch_isdir(fname))
10855 rettv->vval.v_number = 0;
10856 else
10858 rettv->vval.v_number = (varnumber_T)st.st_size;
10860 /* non-perfect check for overflow */
10861 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
10862 rettv->vval.v_number = -2;
10865 else
10866 rettv->vval.v_number = -1;
10870 * "getftime({fname})" function
10872 static void
10873 f_getftime(argvars, rettv)
10874 typval_T *argvars;
10875 typval_T *rettv;
10877 char_u *fname;
10878 struct stat st;
10880 fname = get_tv_string(&argvars[0]);
10882 if (mch_stat((char *)fname, &st) >= 0)
10883 rettv->vval.v_number = (varnumber_T)st.st_mtime;
10884 else
10885 rettv->vval.v_number = -1;
10889 * "getftype({fname})" function
10891 static void
10892 f_getftype(argvars, rettv)
10893 typval_T *argvars;
10894 typval_T *rettv;
10896 char_u *fname;
10897 struct stat st;
10898 char_u *type = NULL;
10899 char *t;
10901 fname = get_tv_string(&argvars[0]);
10903 rettv->v_type = VAR_STRING;
10904 if (mch_lstat((char *)fname, &st) >= 0)
10906 #ifdef S_ISREG
10907 if (S_ISREG(st.st_mode))
10908 t = "file";
10909 else if (S_ISDIR(st.st_mode))
10910 t = "dir";
10911 # ifdef S_ISLNK
10912 else if (S_ISLNK(st.st_mode))
10913 t = "link";
10914 # endif
10915 # ifdef S_ISBLK
10916 else if (S_ISBLK(st.st_mode))
10917 t = "bdev";
10918 # endif
10919 # ifdef S_ISCHR
10920 else if (S_ISCHR(st.st_mode))
10921 t = "cdev";
10922 # endif
10923 # ifdef S_ISFIFO
10924 else if (S_ISFIFO(st.st_mode))
10925 t = "fifo";
10926 # endif
10927 # ifdef S_ISSOCK
10928 else if (S_ISSOCK(st.st_mode))
10929 t = "fifo";
10930 # endif
10931 else
10932 t = "other";
10933 #else
10934 # ifdef S_IFMT
10935 switch (st.st_mode & S_IFMT)
10937 case S_IFREG: t = "file"; break;
10938 case S_IFDIR: t = "dir"; break;
10939 # ifdef S_IFLNK
10940 case S_IFLNK: t = "link"; break;
10941 # endif
10942 # ifdef S_IFBLK
10943 case S_IFBLK: t = "bdev"; break;
10944 # endif
10945 # ifdef S_IFCHR
10946 case S_IFCHR: t = "cdev"; break;
10947 # endif
10948 # ifdef S_IFIFO
10949 case S_IFIFO: t = "fifo"; break;
10950 # endif
10951 # ifdef S_IFSOCK
10952 case S_IFSOCK: t = "socket"; break;
10953 # endif
10954 default: t = "other";
10956 # else
10957 if (mch_isdir(fname))
10958 t = "dir";
10959 else
10960 t = "file";
10961 # endif
10962 #endif
10963 type = vim_strsave((char_u *)t);
10965 rettv->vval.v_string = type;
10969 * "getline(lnum, [end])" function
10971 static void
10972 f_getline(argvars, rettv)
10973 typval_T *argvars;
10974 typval_T *rettv;
10976 linenr_T lnum;
10977 linenr_T end;
10978 int retlist;
10980 lnum = get_tv_lnum(argvars);
10981 if (argvars[1].v_type == VAR_UNKNOWN)
10983 end = 0;
10984 retlist = FALSE;
10986 else
10988 end = get_tv_lnum(&argvars[1]);
10989 retlist = TRUE;
10992 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
10996 * "getmatches()" function
10998 static void
10999 f_getmatches(argvars, rettv)
11000 typval_T *argvars UNUSED;
11001 typval_T *rettv;
11003 #ifdef FEAT_SEARCH_EXTRA
11004 dict_T *dict;
11005 matchitem_T *cur = curwin->w_match_head;
11007 if (rettv_list_alloc(rettv) == OK)
11009 while (cur != NULL)
11011 dict = dict_alloc();
11012 if (dict == NULL)
11013 return;
11014 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11015 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11016 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11017 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11018 list_append_dict(rettv->vval.v_list, dict);
11019 cur = cur->next;
11022 #endif
11026 * "getpid()" function
11028 static void
11029 f_getpid(argvars, rettv)
11030 typval_T *argvars UNUSED;
11031 typval_T *rettv;
11033 rettv->vval.v_number = mch_get_pid();
11037 * "getpos(string)" function
11039 static void
11040 f_getpos(argvars, rettv)
11041 typval_T *argvars;
11042 typval_T *rettv;
11044 pos_T *fp;
11045 list_T *l;
11046 int fnum = -1;
11048 if (rettv_list_alloc(rettv) == OK)
11050 l = rettv->vval.v_list;
11051 fp = var2fpos(&argvars[0], TRUE, &fnum);
11052 if (fnum != -1)
11053 list_append_number(l, (varnumber_T)fnum);
11054 else
11055 list_append_number(l, (varnumber_T)0);
11056 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11057 : (varnumber_T)0);
11058 list_append_number(l, (fp != NULL)
11059 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11060 : (varnumber_T)0);
11061 list_append_number(l,
11062 #ifdef FEAT_VIRTUALEDIT
11063 (fp != NULL) ? (varnumber_T)fp->coladd :
11064 #endif
11065 (varnumber_T)0);
11067 else
11068 rettv->vval.v_number = FALSE;
11072 * "getqflist()" and "getloclist()" functions
11074 static void
11075 f_getqflist(argvars, rettv)
11076 typval_T *argvars UNUSED;
11077 typval_T *rettv UNUSED;
11079 #ifdef FEAT_QUICKFIX
11080 win_T *wp;
11081 #endif
11083 #ifdef FEAT_QUICKFIX
11084 if (rettv_list_alloc(rettv) == OK)
11086 wp = NULL;
11087 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11089 wp = find_win_by_nr(&argvars[0], NULL);
11090 if (wp == NULL)
11091 return;
11094 (void)get_errorlist(wp, rettv->vval.v_list);
11096 #endif
11100 * "getreg()" function
11102 static void
11103 f_getreg(argvars, rettv)
11104 typval_T *argvars;
11105 typval_T *rettv;
11107 char_u *strregname;
11108 int regname;
11109 int arg2 = FALSE;
11110 int error = FALSE;
11112 if (argvars[0].v_type != VAR_UNKNOWN)
11114 strregname = get_tv_string_chk(&argvars[0]);
11115 error = strregname == NULL;
11116 if (argvars[1].v_type != VAR_UNKNOWN)
11117 arg2 = get_tv_number_chk(&argvars[1], &error);
11119 else
11120 strregname = vimvars[VV_REG].vv_str;
11121 regname = (strregname == NULL ? '"' : *strregname);
11122 if (regname == 0)
11123 regname = '"';
11125 rettv->v_type = VAR_STRING;
11126 rettv->vval.v_string = error ? NULL :
11127 get_reg_contents(regname, TRUE, arg2);
11131 * "getregtype()" function
11133 static void
11134 f_getregtype(argvars, rettv)
11135 typval_T *argvars;
11136 typval_T *rettv;
11138 char_u *strregname;
11139 int regname;
11140 char_u buf[NUMBUFLEN + 2];
11141 long reglen = 0;
11143 if (argvars[0].v_type != VAR_UNKNOWN)
11145 strregname = get_tv_string_chk(&argvars[0]);
11146 if (strregname == NULL) /* type error; errmsg already given */
11148 rettv->v_type = VAR_STRING;
11149 rettv->vval.v_string = NULL;
11150 return;
11153 else
11154 /* Default to v:register */
11155 strregname = vimvars[VV_REG].vv_str;
11157 regname = (strregname == NULL ? '"' : *strregname);
11158 if (regname == 0)
11159 regname = '"';
11161 buf[0] = NUL;
11162 buf[1] = NUL;
11163 switch (get_reg_type(regname, &reglen))
11165 case MLINE: buf[0] = 'V'; break;
11166 case MCHAR: buf[0] = 'v'; break;
11167 #ifdef FEAT_VISUAL
11168 case MBLOCK:
11169 buf[0] = Ctrl_V;
11170 sprintf((char *)buf + 1, "%ld", reglen + 1);
11171 break;
11172 #endif
11174 rettv->v_type = VAR_STRING;
11175 rettv->vval.v_string = vim_strsave(buf);
11179 * "gettabwinvar()" function
11181 static void
11182 f_gettabwinvar(argvars, rettv)
11183 typval_T *argvars;
11184 typval_T *rettv;
11186 getwinvar(argvars, rettv, 1);
11190 * "getwinposx()" function
11192 static void
11193 f_getwinposx(argvars, rettv)
11194 typval_T *argvars UNUSED;
11195 typval_T *rettv;
11197 rettv->vval.v_number = -1;
11198 #ifdef FEAT_GUI
11199 if (gui.in_use)
11201 int x, y;
11203 if (gui_mch_get_winpos(&x, &y) == OK)
11204 rettv->vval.v_number = x;
11206 #endif
11210 * "getwinposy()" function
11212 static void
11213 f_getwinposy(argvars, rettv)
11214 typval_T *argvars UNUSED;
11215 typval_T *rettv;
11217 rettv->vval.v_number = -1;
11218 #ifdef FEAT_GUI
11219 if (gui.in_use)
11221 int x, y;
11223 if (gui_mch_get_winpos(&x, &y) == OK)
11224 rettv->vval.v_number = y;
11226 #endif
11230 * Find window specified by "vp" in tabpage "tp".
11232 static win_T *
11233 find_win_by_nr(vp, tp)
11234 typval_T *vp;
11235 tabpage_T *tp; /* NULL for current tab page */
11237 #ifdef FEAT_WINDOWS
11238 win_T *wp;
11239 #endif
11240 int nr;
11242 nr = get_tv_number_chk(vp, NULL);
11244 #ifdef FEAT_WINDOWS
11245 if (nr < 0)
11246 return NULL;
11247 if (nr == 0)
11248 return curwin;
11250 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11251 wp != NULL; wp = wp->w_next)
11252 if (--nr <= 0)
11253 break;
11254 return wp;
11255 #else
11256 if (nr == 0 || nr == 1)
11257 return curwin;
11258 return NULL;
11259 #endif
11263 * "getwinvar()" function
11265 static void
11266 f_getwinvar(argvars, rettv)
11267 typval_T *argvars;
11268 typval_T *rettv;
11270 getwinvar(argvars, rettv, 0);
11274 * getwinvar() and gettabwinvar()
11276 static void
11277 getwinvar(argvars, rettv, off)
11278 typval_T *argvars;
11279 typval_T *rettv;
11280 int off; /* 1 for gettabwinvar() */
11282 win_T *win, *oldcurwin;
11283 char_u *varname;
11284 dictitem_T *v;
11285 tabpage_T *tp;
11287 #ifdef FEAT_WINDOWS
11288 if (off == 1)
11289 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11290 else
11291 tp = curtab;
11292 #endif
11293 win = find_win_by_nr(&argvars[off], tp);
11294 varname = get_tv_string_chk(&argvars[off + 1]);
11295 ++emsg_off;
11297 rettv->v_type = VAR_STRING;
11298 rettv->vval.v_string = NULL;
11300 if (win != NULL && varname != NULL)
11302 /* Set curwin to be our win, temporarily. Also set curbuf, so
11303 * that we can get buffer-local options. */
11304 oldcurwin = curwin;
11305 curwin = win;
11306 curbuf = win->w_buffer;
11308 if (*varname == '&') /* window-local-option */
11309 get_option_tv(&varname, rettv, 1);
11310 else
11312 if (*varname == NUL)
11313 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11314 * scope prefix before the NUL byte is required by
11315 * find_var_in_ht(). */
11316 varname = (char_u *)"w:" + 2;
11317 /* look up the variable */
11318 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11319 if (v != NULL)
11320 copy_tv(&v->di_tv, rettv);
11323 /* restore previous notion of curwin */
11324 curwin = oldcurwin;
11325 curbuf = curwin->w_buffer;
11328 --emsg_off;
11332 * "glob()" function
11334 static void
11335 f_glob(argvars, rettv)
11336 typval_T *argvars;
11337 typval_T *rettv;
11339 int flags = WILD_SILENT|WILD_USE_NL;
11340 expand_T xpc;
11341 int error = FALSE;
11343 /* When the optional second argument is non-zero, don't remove matches
11344 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11345 if (argvars[1].v_type != VAR_UNKNOWN
11346 && get_tv_number_chk(&argvars[1], &error))
11347 flags |= WILD_KEEP_ALL;
11348 rettv->v_type = VAR_STRING;
11349 if (!error)
11351 ExpandInit(&xpc);
11352 xpc.xp_context = EXPAND_FILES;
11353 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11354 NULL, flags, WILD_ALL);
11356 else
11357 rettv->vval.v_string = NULL;
11361 * "globpath()" function
11363 static void
11364 f_globpath(argvars, rettv)
11365 typval_T *argvars;
11366 typval_T *rettv;
11368 int flags = 0;
11369 char_u buf1[NUMBUFLEN];
11370 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11371 int error = FALSE;
11373 /* When the optional second argument is non-zero, don't remove matches
11374 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11375 if (argvars[2].v_type != VAR_UNKNOWN
11376 && get_tv_number_chk(&argvars[2], &error))
11377 flags |= WILD_KEEP_ALL;
11378 rettv->v_type = VAR_STRING;
11379 if (file == NULL || error)
11380 rettv->vval.v_string = NULL;
11381 else
11382 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11383 flags);
11387 * "has()" function
11389 static void
11390 f_has(argvars, rettv)
11391 typval_T *argvars;
11392 typval_T *rettv;
11394 int i;
11395 char_u *name;
11396 int n = FALSE;
11397 static char *(has_list[]) =
11399 #ifdef AMIGA
11400 "amiga",
11401 # ifdef FEAT_ARP
11402 "arp",
11403 # endif
11404 #endif
11405 #ifdef __BEOS__
11406 "beos",
11407 #endif
11408 #ifdef MSDOS
11409 # ifdef DJGPP
11410 "dos32",
11411 # else
11412 "dos16",
11413 # endif
11414 #endif
11415 #ifdef MACOS
11416 "mac",
11417 #endif
11418 #if defined(MACOS_X_UNIX)
11419 "macunix",
11420 #endif
11421 #ifdef OS2
11422 "os2",
11423 #endif
11424 #ifdef __QNX__
11425 "qnx",
11426 #endif
11427 #ifdef RISCOS
11428 "riscos",
11429 #endif
11430 #ifdef UNIX
11431 "unix",
11432 #endif
11433 #ifdef VMS
11434 "vms",
11435 #endif
11436 #ifdef WIN16
11437 "win16",
11438 #endif
11439 #ifdef WIN32
11440 "win32",
11441 #endif
11442 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11443 "win32unix",
11444 #endif
11445 #ifdef WIN64
11446 "win64",
11447 #endif
11448 #ifdef EBCDIC
11449 "ebcdic",
11450 #endif
11451 #ifndef CASE_INSENSITIVE_FILENAME
11452 "fname_case",
11453 #endif
11454 #ifdef FEAT_ARABIC
11455 "arabic",
11456 #endif
11457 #ifdef FEAT_AUTOCMD
11458 "autocmd",
11459 #endif
11460 #ifdef FEAT_BEVAL
11461 "balloon_eval",
11462 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11463 "balloon_multiline",
11464 # endif
11465 #endif
11466 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11467 "builtin_terms",
11468 # ifdef ALL_BUILTIN_TCAPS
11469 "all_builtin_terms",
11470 # endif
11471 #endif
11472 #ifdef FEAT_BYTEOFF
11473 "byte_offset",
11474 #endif
11475 #ifdef FEAT_CINDENT
11476 "cindent",
11477 #endif
11478 #ifdef FEAT_CLIENTSERVER
11479 "clientserver",
11480 #endif
11481 #ifdef FEAT_CLIPBOARD
11482 "clipboard",
11483 #endif
11484 #ifdef FEAT_CMDL_COMPL
11485 "cmdline_compl",
11486 #endif
11487 #ifdef FEAT_CMDHIST
11488 "cmdline_hist",
11489 #endif
11490 #ifdef FEAT_COMMENTS
11491 "comments",
11492 #endif
11493 #ifdef FEAT_CRYPT
11494 "cryptv",
11495 #endif
11496 #ifdef FEAT_CSCOPE
11497 "cscope",
11498 #endif
11499 #ifdef CURSOR_SHAPE
11500 "cursorshape",
11501 #endif
11502 #ifdef DEBUG
11503 "debug",
11504 #endif
11505 #ifdef FEAT_CON_DIALOG
11506 "dialog_con",
11507 #endif
11508 #ifdef FEAT_GUI_DIALOG
11509 "dialog_gui",
11510 #endif
11511 #ifdef FEAT_DIFF
11512 "diff",
11513 #endif
11514 #ifdef FEAT_DIGRAPHS
11515 "digraphs",
11516 #endif
11517 #ifdef FEAT_DND
11518 "dnd",
11519 #endif
11520 #ifdef FEAT_EMACS_TAGS
11521 "emacs_tags",
11522 #endif
11523 "eval", /* always present, of course! */
11524 #ifdef FEAT_EX_EXTRA
11525 "ex_extra",
11526 #endif
11527 #ifdef FEAT_SEARCH_EXTRA
11528 "extra_search",
11529 #endif
11530 #ifdef FEAT_FKMAP
11531 "farsi",
11532 #endif
11533 #ifdef FEAT_SEARCHPATH
11534 "file_in_path",
11535 #endif
11536 #if defined(UNIX) && !defined(USE_SYSTEM)
11537 "filterpipe",
11538 #endif
11539 #ifdef FEAT_FIND_ID
11540 "find_in_path",
11541 #endif
11542 #ifdef FEAT_FLOAT
11543 "float",
11544 #endif
11545 #ifdef FEAT_FOLDING
11546 "folding",
11547 #endif
11548 #ifdef FEAT_FOOTER
11549 "footer",
11550 #endif
11551 #if !defined(USE_SYSTEM) && defined(UNIX)
11552 "fork",
11553 #endif
11554 #ifdef FEAT_FULLSCREEN
11555 "fullscreen",
11556 #endif
11557 #ifdef FEAT_GETTEXT
11558 "gettext",
11559 #endif
11560 #ifdef FEAT_GUI
11561 "gui",
11562 #endif
11563 #ifdef FEAT_GUI_ATHENA
11564 # ifdef FEAT_GUI_NEXTAW
11565 "gui_neXtaw",
11566 # else
11567 "gui_athena",
11568 # endif
11569 #endif
11570 #ifdef FEAT_GUI_GTK
11571 "gui_gtk",
11572 # ifdef HAVE_GTK2
11573 "gui_gtk2",
11574 # endif
11575 #endif
11576 #ifdef FEAT_GUI_GNOME
11577 "gui_gnome",
11578 #endif
11579 #ifdef FEAT_GUI_MAC
11580 "gui_mac",
11581 #endif
11582 #ifdef FEAT_GUI_MACVIM
11583 "gui_macvim",
11584 #endif
11585 #ifdef FEAT_GUI_MOTIF
11586 "gui_motif",
11587 #endif
11588 #ifdef FEAT_GUI_PHOTON
11589 "gui_photon",
11590 #endif
11591 #ifdef FEAT_GUI_W16
11592 "gui_win16",
11593 #endif
11594 #ifdef FEAT_GUI_W32
11595 "gui_win32",
11596 #endif
11597 #ifdef FEAT_HANGULIN
11598 "hangul_input",
11599 #endif
11600 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11601 "iconv",
11602 #endif
11603 #ifdef FEAT_INS_EXPAND
11604 "insert_expand",
11605 #endif
11606 #ifdef FEAT_JUMPLIST
11607 "jumplist",
11608 #endif
11609 #ifdef FEAT_KEYMAP
11610 "keymap",
11611 #endif
11612 #ifdef FEAT_LANGMAP
11613 "langmap",
11614 #endif
11615 #ifdef FEAT_LIBCALL
11616 "libcall",
11617 #endif
11618 #ifdef FEAT_LINEBREAK
11619 "linebreak",
11620 #endif
11621 #ifdef FEAT_LISP
11622 "lispindent",
11623 #endif
11624 #ifdef FEAT_LISTCMDS
11625 "listcmds",
11626 #endif
11627 #ifdef FEAT_LOCALMAP
11628 "localmap",
11629 #endif
11630 #ifdef FEAT_MENU
11631 "menu",
11632 #endif
11633 #ifdef FEAT_SESSION
11634 "mksession",
11635 #endif
11636 #ifdef FEAT_MODIFY_FNAME
11637 "modify_fname",
11638 #endif
11639 #ifdef FEAT_MOUSE
11640 "mouse",
11641 #endif
11642 #ifdef FEAT_MOUSESHAPE
11643 "mouseshape",
11644 #endif
11645 #if defined(UNIX) || defined(VMS)
11646 # ifdef FEAT_MOUSE_DEC
11647 "mouse_dec",
11648 # endif
11649 # ifdef FEAT_MOUSE_GPM
11650 "mouse_gpm",
11651 # endif
11652 # ifdef FEAT_MOUSE_JSB
11653 "mouse_jsbterm",
11654 # endif
11655 # ifdef FEAT_MOUSE_NET
11656 "mouse_netterm",
11657 # endif
11658 # ifdef FEAT_MOUSE_PTERM
11659 "mouse_pterm",
11660 # endif
11661 # ifdef FEAT_SYSMOUSE
11662 "mouse_sysmouse",
11663 # endif
11664 # ifdef FEAT_MOUSE_XTERM
11665 "mouse_xterm",
11666 # endif
11667 #endif
11668 #ifdef FEAT_MBYTE
11669 "multi_byte",
11670 #endif
11671 #ifdef FEAT_MBYTE_IME
11672 "multi_byte_ime",
11673 #endif
11674 #ifdef FEAT_MULTI_LANG
11675 "multi_lang",
11676 #endif
11677 #ifdef FEAT_MZSCHEME
11678 #ifndef DYNAMIC_MZSCHEME
11679 "mzscheme",
11680 #endif
11681 #endif
11682 #ifdef FEAT_OLE
11683 "ole",
11684 #endif
11685 #ifdef FEAT_OSFILETYPE
11686 "osfiletype",
11687 #endif
11688 #ifdef FEAT_PATH_EXTRA
11689 "path_extra",
11690 #endif
11691 #ifdef FEAT_PERL
11692 #ifndef DYNAMIC_PERL
11693 "perl",
11694 #endif
11695 #endif
11696 #ifdef FEAT_PYTHON
11697 #ifndef DYNAMIC_PYTHON
11698 "python",
11699 #endif
11700 #endif
11701 #ifdef FEAT_POSTSCRIPT
11702 "postscript",
11703 #endif
11704 #ifdef FEAT_PRINTER
11705 "printer",
11706 #endif
11707 #ifdef FEAT_PROFILE
11708 "profile",
11709 #endif
11710 #ifdef FEAT_RELTIME
11711 "reltime",
11712 #endif
11713 #ifdef FEAT_QUICKFIX
11714 "quickfix",
11715 #endif
11716 #ifdef FEAT_RIGHTLEFT
11717 "rightleft",
11718 #endif
11719 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11720 "ruby",
11721 #endif
11722 #ifdef FEAT_SCROLLBIND
11723 "scrollbind",
11724 #endif
11725 #ifdef FEAT_CMDL_INFO
11726 "showcmd",
11727 "cmdline_info",
11728 #endif
11729 #ifdef FEAT_SIGNS
11730 "signs",
11731 #endif
11732 #ifdef FEAT_SMARTINDENT
11733 "smartindent",
11734 #endif
11735 #ifdef FEAT_SNIFF
11736 "sniff",
11737 #endif
11738 #ifdef FEAT_STL_OPT
11739 "statusline",
11740 #endif
11741 #ifdef FEAT_SUN_WORKSHOP
11742 "sun_workshop",
11743 #endif
11744 #ifdef FEAT_NETBEANS_INTG
11745 "netbeans_intg",
11746 #endif
11747 #ifdef FEAT_ODB_EDITOR
11748 "odbeditor",
11749 #endif
11750 #ifdef FEAT_SPELL
11751 "spell",
11752 #endif
11753 #ifdef FEAT_SYN_HL
11754 "syntax",
11755 #endif
11756 #if defined(USE_SYSTEM) || !defined(UNIX)
11757 "system",
11758 #endif
11759 #ifdef FEAT_TAG_BINS
11760 "tag_binary",
11761 #endif
11762 #ifdef FEAT_TAG_OLDSTATIC
11763 "tag_old_static",
11764 #endif
11765 #ifdef FEAT_TAG_ANYWHITE
11766 "tag_any_white",
11767 #endif
11768 #ifdef FEAT_TCL
11769 # ifndef DYNAMIC_TCL
11770 "tcl",
11771 # endif
11772 #endif
11773 #ifdef TERMINFO
11774 "terminfo",
11775 #endif
11776 #ifdef FEAT_TERMRESPONSE
11777 "termresponse",
11778 #endif
11779 #ifdef FEAT_TEXTOBJ
11780 "textobjects",
11781 #endif
11782 #ifdef HAVE_TGETENT
11783 "tgetent",
11784 #endif
11785 #ifdef FEAT_TITLE
11786 "title",
11787 #endif
11788 #ifdef FEAT_TOOLBAR
11789 "toolbar",
11790 #endif
11791 #ifdef FEAT_TRANSPARENCY
11792 "transparency",
11793 #endif
11794 #ifdef FEAT_USR_CMDS
11795 "user-commands", /* was accidentally included in 5.4 */
11796 "user_commands",
11797 #endif
11798 #ifdef FEAT_VIMINFO
11799 "viminfo",
11800 #endif
11801 #ifdef FEAT_VERTSPLIT
11802 "vertsplit",
11803 #endif
11804 #ifdef FEAT_VIRTUALEDIT
11805 "virtualedit",
11806 #endif
11807 #ifdef FEAT_VISUAL
11808 "visual",
11809 #endif
11810 #ifdef FEAT_VISUALEXTRA
11811 "visualextra",
11812 #endif
11813 #ifdef FEAT_VREPLACE
11814 "vreplace",
11815 #endif
11816 #ifdef FEAT_WILDIGN
11817 "wildignore",
11818 #endif
11819 #ifdef FEAT_WILDMENU
11820 "wildmenu",
11821 #endif
11822 #ifdef FEAT_WINDOWS
11823 "windows",
11824 #endif
11825 #ifdef FEAT_WAK
11826 "winaltkeys",
11827 #endif
11828 #ifdef FEAT_WRITEBACKUP
11829 "writebackup",
11830 #endif
11831 #ifdef FEAT_XIM
11832 "xim",
11833 #endif
11834 #ifdef FEAT_XFONTSET
11835 "xfontset",
11836 #endif
11837 #ifdef USE_XSMP
11838 "xsmp",
11839 #endif
11840 #ifdef USE_XSMP_INTERACT
11841 "xsmp_interact",
11842 #endif
11843 #ifdef FEAT_XCLIPBOARD
11844 "xterm_clipboard",
11845 #endif
11846 #ifdef FEAT_XTERM_SAVE
11847 "xterm_save",
11848 #endif
11849 #if defined(UNIX) && defined(FEAT_X11)
11850 "X11",
11851 #endif
11852 NULL
11855 name = get_tv_string(&argvars[0]);
11856 for (i = 0; has_list[i] != NULL; ++i)
11857 if (STRICMP(name, has_list[i]) == 0)
11859 n = TRUE;
11860 break;
11863 if (n == FALSE)
11865 if (STRNICMP(name, "patch", 5) == 0)
11866 n = has_patch(atoi((char *)name + 5));
11867 else if (STRICMP(name, "vim_starting") == 0)
11868 n = (starting != 0);
11869 #ifdef FEAT_MBYTE
11870 else if (STRICMP(name, "multi_byte_encoding") == 0)
11871 n = has_mbyte;
11872 #endif
11873 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
11874 else if (STRICMP(name, "balloon_multiline") == 0)
11875 n = multiline_balloon_available();
11876 #endif
11877 #ifdef DYNAMIC_TCL
11878 else if (STRICMP(name, "tcl") == 0)
11879 n = tcl_enabled(FALSE);
11880 #endif
11881 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
11882 else if (STRICMP(name, "iconv") == 0)
11883 n = iconv_enabled(FALSE);
11884 #endif
11885 #ifdef DYNAMIC_MZSCHEME
11886 else if (STRICMP(name, "mzscheme") == 0)
11887 n = mzscheme_enabled(FALSE);
11888 #endif
11889 #ifdef DYNAMIC_RUBY
11890 else if (STRICMP(name, "ruby") == 0)
11891 n = ruby_enabled(FALSE);
11892 #endif
11893 #ifdef DYNAMIC_PYTHON
11894 else if (STRICMP(name, "python") == 0)
11895 n = python_enabled(FALSE);
11896 #endif
11897 #ifdef DYNAMIC_PERL
11898 else if (STRICMP(name, "perl") == 0)
11899 n = perl_enabled(FALSE);
11900 #endif
11901 #ifdef FEAT_GUI
11902 else if (STRICMP(name, "gui_running") == 0)
11903 n = (gui.in_use || gui.starting);
11904 # ifdef FEAT_GUI_W32
11905 else if (STRICMP(name, "gui_win32s") == 0)
11906 n = gui_is_win32s();
11907 # endif
11908 # ifdef FEAT_BROWSE
11909 else if (STRICMP(name, "browse") == 0)
11910 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
11911 # endif
11912 #endif
11913 #ifdef FEAT_SYN_HL
11914 else if (STRICMP(name, "syntax_items") == 0)
11915 n = syntax_present(curbuf);
11916 #endif
11917 #if defined(WIN3264)
11918 else if (STRICMP(name, "win95") == 0)
11919 n = mch_windows95();
11920 #endif
11921 #ifdef FEAT_NETBEANS_INTG
11922 else if (STRICMP(name, "netbeans_enabled") == 0)
11923 n = usingNetbeans;
11924 #endif
11927 rettv->vval.v_number = n;
11931 * "has_key()" function
11933 static void
11934 f_has_key(argvars, rettv)
11935 typval_T *argvars;
11936 typval_T *rettv;
11938 if (argvars[0].v_type != VAR_DICT)
11940 EMSG(_(e_dictreq));
11941 return;
11943 if (argvars[0].vval.v_dict == NULL)
11944 return;
11946 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
11947 get_tv_string(&argvars[1]), -1) != NULL;
11951 * "haslocaldir()" function
11953 static void
11954 f_haslocaldir(argvars, rettv)
11955 typval_T *argvars UNUSED;
11956 typval_T *rettv;
11958 rettv->vval.v_number = (curwin->w_localdir != NULL);
11962 * "hasmapto()" function
11964 static void
11965 f_hasmapto(argvars, rettv)
11966 typval_T *argvars;
11967 typval_T *rettv;
11969 char_u *name;
11970 char_u *mode;
11971 char_u buf[NUMBUFLEN];
11972 int abbr = FALSE;
11974 name = get_tv_string(&argvars[0]);
11975 if (argvars[1].v_type == VAR_UNKNOWN)
11976 mode = (char_u *)"nvo";
11977 else
11979 mode = get_tv_string_buf(&argvars[1], buf);
11980 if (argvars[2].v_type != VAR_UNKNOWN)
11981 abbr = get_tv_number(&argvars[2]);
11984 if (map_to_exists(name, mode, abbr))
11985 rettv->vval.v_number = TRUE;
11986 else
11987 rettv->vval.v_number = FALSE;
11991 * "histadd()" function
11993 static void
11994 f_histadd(argvars, rettv)
11995 typval_T *argvars UNUSED;
11996 typval_T *rettv;
11998 #ifdef FEAT_CMDHIST
11999 int histype;
12000 char_u *str;
12001 char_u buf[NUMBUFLEN];
12002 #endif
12004 rettv->vval.v_number = FALSE;
12005 if (check_restricted() || check_secure())
12006 return;
12007 #ifdef FEAT_CMDHIST
12008 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12009 histype = str != NULL ? get_histtype(str) : -1;
12010 if (histype >= 0)
12012 str = get_tv_string_buf(&argvars[1], buf);
12013 if (*str != NUL)
12015 add_to_history(histype, str, FALSE, NUL);
12016 rettv->vval.v_number = TRUE;
12017 return;
12020 #endif
12024 * "histdel()" function
12026 static void
12027 f_histdel(argvars, rettv)
12028 typval_T *argvars UNUSED;
12029 typval_T *rettv UNUSED;
12031 #ifdef FEAT_CMDHIST
12032 int n;
12033 char_u buf[NUMBUFLEN];
12034 char_u *str;
12036 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12037 if (str == NULL)
12038 n = 0;
12039 else if (argvars[1].v_type == VAR_UNKNOWN)
12040 /* only one argument: clear entire history */
12041 n = clr_history(get_histtype(str));
12042 else if (argvars[1].v_type == VAR_NUMBER)
12043 /* index given: remove that entry */
12044 n = del_history_idx(get_histtype(str),
12045 (int)get_tv_number(&argvars[1]));
12046 else
12047 /* string given: remove all matching entries */
12048 n = del_history_entry(get_histtype(str),
12049 get_tv_string_buf(&argvars[1], buf));
12050 rettv->vval.v_number = n;
12051 #endif
12055 * "histget()" function
12057 static void
12058 f_histget(argvars, rettv)
12059 typval_T *argvars UNUSED;
12060 typval_T *rettv;
12062 #ifdef FEAT_CMDHIST
12063 int type;
12064 int idx;
12065 char_u *str;
12067 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12068 if (str == NULL)
12069 rettv->vval.v_string = NULL;
12070 else
12072 type = get_histtype(str);
12073 if (argvars[1].v_type == VAR_UNKNOWN)
12074 idx = get_history_idx(type);
12075 else
12076 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12077 /* -1 on type error */
12078 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12080 #else
12081 rettv->vval.v_string = NULL;
12082 #endif
12083 rettv->v_type = VAR_STRING;
12087 * "histnr()" function
12089 static void
12090 f_histnr(argvars, rettv)
12091 typval_T *argvars UNUSED;
12092 typval_T *rettv;
12094 int i;
12096 #ifdef FEAT_CMDHIST
12097 char_u *history = get_tv_string_chk(&argvars[0]);
12099 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12100 if (i >= HIST_CMD && i < HIST_COUNT)
12101 i = get_history_idx(i);
12102 else
12103 #endif
12104 i = -1;
12105 rettv->vval.v_number = i;
12109 * "highlightID(name)" function
12111 static void
12112 f_hlID(argvars, rettv)
12113 typval_T *argvars;
12114 typval_T *rettv;
12116 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12120 * "highlight_exists()" function
12122 static void
12123 f_hlexists(argvars, rettv)
12124 typval_T *argvars;
12125 typval_T *rettv;
12127 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12131 * "hostname()" function
12133 static void
12134 f_hostname(argvars, rettv)
12135 typval_T *argvars UNUSED;
12136 typval_T *rettv;
12138 char_u hostname[256];
12140 mch_get_host_name(hostname, 256);
12141 rettv->v_type = VAR_STRING;
12142 rettv->vval.v_string = vim_strsave(hostname);
12146 * iconv() function
12148 static void
12149 f_iconv(argvars, rettv)
12150 typval_T *argvars UNUSED;
12151 typval_T *rettv;
12153 #ifdef FEAT_MBYTE
12154 char_u buf1[NUMBUFLEN];
12155 char_u buf2[NUMBUFLEN];
12156 char_u *from, *to, *str;
12157 vimconv_T vimconv;
12158 #endif
12160 rettv->v_type = VAR_STRING;
12161 rettv->vval.v_string = NULL;
12163 #ifdef FEAT_MBYTE
12164 str = get_tv_string(&argvars[0]);
12165 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12166 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12167 vimconv.vc_type = CONV_NONE;
12168 convert_setup(&vimconv, from, to);
12170 /* If the encodings are equal, no conversion needed. */
12171 if (vimconv.vc_type == CONV_NONE)
12172 rettv->vval.v_string = vim_strsave(str);
12173 else
12174 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12176 convert_setup(&vimconv, NULL, NULL);
12177 vim_free(from);
12178 vim_free(to);
12179 #endif
12183 * "indent()" function
12185 static void
12186 f_indent(argvars, rettv)
12187 typval_T *argvars;
12188 typval_T *rettv;
12190 linenr_T lnum;
12192 lnum = get_tv_lnum(argvars);
12193 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12194 rettv->vval.v_number = get_indent_lnum(lnum);
12195 else
12196 rettv->vval.v_number = -1;
12200 * "index()" function
12202 static void
12203 f_index(argvars, rettv)
12204 typval_T *argvars;
12205 typval_T *rettv;
12207 list_T *l;
12208 listitem_T *item;
12209 long idx = 0;
12210 int ic = FALSE;
12212 rettv->vval.v_number = -1;
12213 if (argvars[0].v_type != VAR_LIST)
12215 EMSG(_(e_listreq));
12216 return;
12218 l = argvars[0].vval.v_list;
12219 if (l != NULL)
12221 item = l->lv_first;
12222 if (argvars[2].v_type != VAR_UNKNOWN)
12224 int error = FALSE;
12226 /* Start at specified item. Use the cached index that list_find()
12227 * sets, so that a negative number also works. */
12228 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12229 idx = l->lv_idx;
12230 if (argvars[3].v_type != VAR_UNKNOWN)
12231 ic = get_tv_number_chk(&argvars[3], &error);
12232 if (error)
12233 item = NULL;
12236 for ( ; item != NULL; item = item->li_next, ++idx)
12237 if (tv_equal(&item->li_tv, &argvars[1], ic))
12239 rettv->vval.v_number = idx;
12240 break;
12245 static int inputsecret_flag = 0;
12247 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12250 * This function is used by f_input() and f_inputdialog() functions. The third
12251 * argument to f_input() specifies the type of completion to use at the
12252 * prompt. The third argument to f_inputdialog() specifies the value to return
12253 * when the user cancels the prompt.
12255 static void
12256 get_user_input(argvars, rettv, inputdialog)
12257 typval_T *argvars;
12258 typval_T *rettv;
12259 int inputdialog;
12261 char_u *prompt = get_tv_string_chk(&argvars[0]);
12262 char_u *p = NULL;
12263 int c;
12264 char_u buf[NUMBUFLEN];
12265 int cmd_silent_save = cmd_silent;
12266 char_u *defstr = (char_u *)"";
12267 int xp_type = EXPAND_NOTHING;
12268 char_u *xp_arg = NULL;
12270 rettv->v_type = VAR_STRING;
12271 rettv->vval.v_string = NULL;
12273 #ifdef NO_CONSOLE_INPUT
12274 /* While starting up, there is no place to enter text. */
12275 if (no_console_input())
12276 return;
12277 #endif
12279 cmd_silent = FALSE; /* Want to see the prompt. */
12280 if (prompt != NULL)
12282 /* Only the part of the message after the last NL is considered as
12283 * prompt for the command line */
12284 p = vim_strrchr(prompt, '\n');
12285 if (p == NULL)
12286 p = prompt;
12287 else
12289 ++p;
12290 c = *p;
12291 *p = NUL;
12292 msg_start();
12293 msg_clr_eos();
12294 msg_puts_attr(prompt, echo_attr);
12295 msg_didout = FALSE;
12296 msg_starthere();
12297 *p = c;
12299 cmdline_row = msg_row;
12301 if (argvars[1].v_type != VAR_UNKNOWN)
12303 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12304 if (defstr != NULL)
12305 stuffReadbuffSpec(defstr);
12307 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12309 char_u *xp_name;
12310 int xp_namelen;
12311 long argt;
12313 rettv->vval.v_string = NULL;
12315 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12316 if (xp_name == NULL)
12317 return;
12319 xp_namelen = (int)STRLEN(xp_name);
12321 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12322 &xp_arg) == FAIL)
12323 return;
12327 if (defstr != NULL)
12328 rettv->vval.v_string =
12329 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12330 xp_type, xp_arg);
12332 vim_free(xp_arg);
12334 /* since the user typed this, no need to wait for return */
12335 need_wait_return = FALSE;
12336 msg_didout = FALSE;
12338 cmd_silent = cmd_silent_save;
12342 * "input()" function
12343 * Also handles inputsecret() when inputsecret is set.
12345 static void
12346 f_input(argvars, rettv)
12347 typval_T *argvars;
12348 typval_T *rettv;
12350 get_user_input(argvars, rettv, FALSE);
12354 * "inputdialog()" function
12356 static void
12357 f_inputdialog(argvars, rettv)
12358 typval_T *argvars;
12359 typval_T *rettv;
12361 #if defined(FEAT_GUI_TEXTDIALOG)
12362 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12363 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12365 char_u *message;
12366 char_u buf[NUMBUFLEN];
12367 char_u *defstr = (char_u *)"";
12369 message = get_tv_string_chk(&argvars[0]);
12370 if (argvars[1].v_type != VAR_UNKNOWN
12371 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12372 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12373 else
12374 IObuff[0] = NUL;
12375 if (message != NULL && defstr != NULL
12376 && do_dialog(VIM_QUESTION, NULL, message,
12377 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12378 rettv->vval.v_string = vim_strsave(IObuff);
12379 else
12381 if (message != NULL && defstr != NULL
12382 && argvars[1].v_type != VAR_UNKNOWN
12383 && argvars[2].v_type != VAR_UNKNOWN)
12384 rettv->vval.v_string = vim_strsave(
12385 get_tv_string_buf(&argvars[2], buf));
12386 else
12387 rettv->vval.v_string = NULL;
12389 rettv->v_type = VAR_STRING;
12391 else
12392 #endif
12393 get_user_input(argvars, rettv, TRUE);
12397 * "inputlist()" function
12399 static void
12400 f_inputlist(argvars, rettv)
12401 typval_T *argvars;
12402 typval_T *rettv;
12404 listitem_T *li;
12405 int selected;
12406 int mouse_used;
12408 #ifdef NO_CONSOLE_INPUT
12409 /* While starting up, there is no place to enter text. */
12410 if (no_console_input())
12411 return;
12412 #endif
12413 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12415 EMSG2(_(e_listarg), "inputlist()");
12416 return;
12419 msg_start();
12420 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12421 lines_left = Rows; /* avoid more prompt */
12422 msg_scroll = TRUE;
12423 msg_clr_eos();
12425 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12427 msg_puts(get_tv_string(&li->li_tv));
12428 msg_putchar('\n');
12431 /* Ask for choice. */
12432 selected = prompt_for_number(&mouse_used);
12433 if (mouse_used)
12434 selected -= lines_left;
12436 rettv->vval.v_number = selected;
12440 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12443 * "inputrestore()" function
12445 static void
12446 f_inputrestore(argvars, rettv)
12447 typval_T *argvars UNUSED;
12448 typval_T *rettv;
12450 if (ga_userinput.ga_len > 0)
12452 --ga_userinput.ga_len;
12453 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12454 + ga_userinput.ga_len);
12455 /* default return is zero == OK */
12457 else if (p_verbose > 1)
12459 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12460 rettv->vval.v_number = 1; /* Failed */
12465 * "inputsave()" function
12467 static void
12468 f_inputsave(argvars, rettv)
12469 typval_T *argvars UNUSED;
12470 typval_T *rettv;
12472 /* Add an entry to the stack of typeahead storage. */
12473 if (ga_grow(&ga_userinput, 1) == OK)
12475 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12476 + ga_userinput.ga_len);
12477 ++ga_userinput.ga_len;
12478 /* default return is zero == OK */
12480 else
12481 rettv->vval.v_number = 1; /* Failed */
12485 * "inputsecret()" function
12487 static void
12488 f_inputsecret(argvars, rettv)
12489 typval_T *argvars;
12490 typval_T *rettv;
12492 ++cmdline_star;
12493 ++inputsecret_flag;
12494 f_input(argvars, rettv);
12495 --cmdline_star;
12496 --inputsecret_flag;
12500 * "insert()" function
12502 static void
12503 f_insert(argvars, rettv)
12504 typval_T *argvars;
12505 typval_T *rettv;
12507 long before = 0;
12508 listitem_T *item;
12509 list_T *l;
12510 int error = FALSE;
12512 if (argvars[0].v_type != VAR_LIST)
12513 EMSG2(_(e_listarg), "insert()");
12514 else if ((l = argvars[0].vval.v_list) != NULL
12515 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12517 if (argvars[2].v_type != VAR_UNKNOWN)
12518 before = get_tv_number_chk(&argvars[2], &error);
12519 if (error)
12520 return; /* type error; errmsg already given */
12522 if (before == l->lv_len)
12523 item = NULL;
12524 else
12526 item = list_find(l, before);
12527 if (item == NULL)
12529 EMSGN(_(e_listidx), before);
12530 l = NULL;
12533 if (l != NULL)
12535 list_insert_tv(l, &argvars[1], item);
12536 copy_tv(&argvars[0], rettv);
12542 * "isdirectory()" function
12544 static void
12545 f_isdirectory(argvars, rettv)
12546 typval_T *argvars;
12547 typval_T *rettv;
12549 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12553 * "islocked()" function
12555 static void
12556 f_islocked(argvars, rettv)
12557 typval_T *argvars;
12558 typval_T *rettv;
12560 lval_T lv;
12561 char_u *end;
12562 dictitem_T *di;
12564 rettv->vval.v_number = -1;
12565 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12566 FNE_CHECK_START);
12567 if (end != NULL && lv.ll_name != NULL)
12569 if (*end != NUL)
12570 EMSG(_(e_trailing));
12571 else
12573 if (lv.ll_tv == NULL)
12575 if (check_changedtick(lv.ll_name))
12576 rettv->vval.v_number = 1; /* always locked */
12577 else
12579 di = find_var(lv.ll_name, NULL);
12580 if (di != NULL)
12582 /* Consider a variable locked when:
12583 * 1. the variable itself is locked
12584 * 2. the value of the variable is locked.
12585 * 3. the List or Dict value is locked.
12587 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12588 || tv_islocked(&di->di_tv));
12592 else if (lv.ll_range)
12593 EMSG(_("E786: Range not allowed"));
12594 else if (lv.ll_newkey != NULL)
12595 EMSG2(_(e_dictkey), lv.ll_newkey);
12596 else if (lv.ll_list != NULL)
12597 /* List item. */
12598 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12599 else
12600 /* Dictionary item. */
12601 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12605 clear_lval(&lv);
12608 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12611 * Turn a dict into a list:
12612 * "what" == 0: list of keys
12613 * "what" == 1: list of values
12614 * "what" == 2: list of items
12616 static void
12617 dict_list(argvars, rettv, what)
12618 typval_T *argvars;
12619 typval_T *rettv;
12620 int what;
12622 list_T *l2;
12623 dictitem_T *di;
12624 hashitem_T *hi;
12625 listitem_T *li;
12626 listitem_T *li2;
12627 dict_T *d;
12628 int todo;
12630 if (argvars[0].v_type != VAR_DICT)
12632 EMSG(_(e_dictreq));
12633 return;
12635 if ((d = argvars[0].vval.v_dict) == NULL)
12636 return;
12638 if (rettv_list_alloc(rettv) == FAIL)
12639 return;
12641 todo = (int)d->dv_hashtab.ht_used;
12642 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12644 if (!HASHITEM_EMPTY(hi))
12646 --todo;
12647 di = HI2DI(hi);
12649 li = listitem_alloc();
12650 if (li == NULL)
12651 break;
12652 list_append(rettv->vval.v_list, li);
12654 if (what == 0)
12656 /* keys() */
12657 li->li_tv.v_type = VAR_STRING;
12658 li->li_tv.v_lock = 0;
12659 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12661 else if (what == 1)
12663 /* values() */
12664 copy_tv(&di->di_tv, &li->li_tv);
12666 else
12668 /* items() */
12669 l2 = list_alloc();
12670 li->li_tv.v_type = VAR_LIST;
12671 li->li_tv.v_lock = 0;
12672 li->li_tv.vval.v_list = l2;
12673 if (l2 == NULL)
12674 break;
12675 ++l2->lv_refcount;
12677 li2 = listitem_alloc();
12678 if (li2 == NULL)
12679 break;
12680 list_append(l2, li2);
12681 li2->li_tv.v_type = VAR_STRING;
12682 li2->li_tv.v_lock = 0;
12683 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12685 li2 = listitem_alloc();
12686 if (li2 == NULL)
12687 break;
12688 list_append(l2, li2);
12689 copy_tv(&di->di_tv, &li2->li_tv);
12696 * "items(dict)" function
12698 static void
12699 f_items(argvars, rettv)
12700 typval_T *argvars;
12701 typval_T *rettv;
12703 dict_list(argvars, rettv, 2);
12707 * "join()" function
12709 static void
12710 f_join(argvars, rettv)
12711 typval_T *argvars;
12712 typval_T *rettv;
12714 garray_T ga;
12715 char_u *sep;
12717 if (argvars[0].v_type != VAR_LIST)
12719 EMSG(_(e_listreq));
12720 return;
12722 if (argvars[0].vval.v_list == NULL)
12723 return;
12724 if (argvars[1].v_type == VAR_UNKNOWN)
12725 sep = (char_u *)" ";
12726 else
12727 sep = get_tv_string_chk(&argvars[1]);
12729 rettv->v_type = VAR_STRING;
12731 if (sep != NULL)
12733 ga_init2(&ga, (int)sizeof(char), 80);
12734 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12735 ga_append(&ga, NUL);
12736 rettv->vval.v_string = (char_u *)ga.ga_data;
12738 else
12739 rettv->vval.v_string = NULL;
12743 * "keys()" function
12745 static void
12746 f_keys(argvars, rettv)
12747 typval_T *argvars;
12748 typval_T *rettv;
12750 dict_list(argvars, rettv, 0);
12754 * "last_buffer_nr()" function.
12756 static void
12757 f_last_buffer_nr(argvars, rettv)
12758 typval_T *argvars UNUSED;
12759 typval_T *rettv;
12761 int n = 0;
12762 buf_T *buf;
12764 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12765 if (n < buf->b_fnum)
12766 n = buf->b_fnum;
12768 rettv->vval.v_number = n;
12772 * "len()" function
12774 static void
12775 f_len(argvars, rettv)
12776 typval_T *argvars;
12777 typval_T *rettv;
12779 switch (argvars[0].v_type)
12781 case VAR_STRING:
12782 case VAR_NUMBER:
12783 rettv->vval.v_number = (varnumber_T)STRLEN(
12784 get_tv_string(&argvars[0]));
12785 break;
12786 case VAR_LIST:
12787 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12788 break;
12789 case VAR_DICT:
12790 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12791 break;
12792 default:
12793 EMSG(_("E701: Invalid type for len()"));
12794 break;
12798 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12800 static void
12801 libcall_common(argvars, rettv, type)
12802 typval_T *argvars;
12803 typval_T *rettv;
12804 int type;
12806 #ifdef FEAT_LIBCALL
12807 char_u *string_in;
12808 char_u **string_result;
12809 int nr_result;
12810 #endif
12812 rettv->v_type = type;
12813 if (type != VAR_NUMBER)
12814 rettv->vval.v_string = NULL;
12816 if (check_restricted() || check_secure())
12817 return;
12819 #ifdef FEAT_LIBCALL
12820 /* The first two args must be strings, otherwise its meaningless */
12821 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
12823 string_in = NULL;
12824 if (argvars[2].v_type == VAR_STRING)
12825 string_in = argvars[2].vval.v_string;
12826 if (type == VAR_NUMBER)
12827 string_result = NULL;
12828 else
12829 string_result = &rettv->vval.v_string;
12830 if (mch_libcall(argvars[0].vval.v_string,
12831 argvars[1].vval.v_string,
12832 string_in,
12833 argvars[2].vval.v_number,
12834 string_result,
12835 &nr_result) == OK
12836 && type == VAR_NUMBER)
12837 rettv->vval.v_number = nr_result;
12839 #endif
12843 * "libcall()" function
12845 static void
12846 f_libcall(argvars, rettv)
12847 typval_T *argvars;
12848 typval_T *rettv;
12850 libcall_common(argvars, rettv, VAR_STRING);
12854 * "libcallnr()" function
12856 static void
12857 f_libcallnr(argvars, rettv)
12858 typval_T *argvars;
12859 typval_T *rettv;
12861 libcall_common(argvars, rettv, VAR_NUMBER);
12865 * "line(string)" function
12867 static void
12868 f_line(argvars, rettv)
12869 typval_T *argvars;
12870 typval_T *rettv;
12872 linenr_T lnum = 0;
12873 pos_T *fp;
12874 int fnum;
12876 fp = var2fpos(&argvars[0], TRUE, &fnum);
12877 if (fp != NULL)
12878 lnum = fp->lnum;
12879 rettv->vval.v_number = lnum;
12883 * "line2byte(lnum)" function
12885 static void
12886 f_line2byte(argvars, rettv)
12887 typval_T *argvars UNUSED;
12888 typval_T *rettv;
12890 #ifndef FEAT_BYTEOFF
12891 rettv->vval.v_number = -1;
12892 #else
12893 linenr_T lnum;
12895 lnum = get_tv_lnum(argvars);
12896 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
12897 rettv->vval.v_number = -1;
12898 else
12899 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
12900 if (rettv->vval.v_number >= 0)
12901 ++rettv->vval.v_number;
12902 #endif
12906 * "lispindent(lnum)" function
12908 static void
12909 f_lispindent(argvars, rettv)
12910 typval_T *argvars;
12911 typval_T *rettv;
12913 #ifdef FEAT_LISP
12914 pos_T pos;
12915 linenr_T lnum;
12917 pos = curwin->w_cursor;
12918 lnum = get_tv_lnum(argvars);
12919 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12921 curwin->w_cursor.lnum = lnum;
12922 rettv->vval.v_number = get_lisp_indent();
12923 curwin->w_cursor = pos;
12925 else
12926 #endif
12927 rettv->vval.v_number = -1;
12931 * "localtime()" function
12933 static void
12934 f_localtime(argvars, rettv)
12935 typval_T *argvars UNUSED;
12936 typval_T *rettv;
12938 rettv->vval.v_number = (varnumber_T)time(NULL);
12941 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
12943 static void
12944 get_maparg(argvars, rettv, exact)
12945 typval_T *argvars;
12946 typval_T *rettv;
12947 int exact;
12949 char_u *keys;
12950 char_u *which;
12951 char_u buf[NUMBUFLEN];
12952 char_u *keys_buf = NULL;
12953 char_u *rhs;
12954 int mode;
12955 garray_T ga;
12956 int abbr = FALSE;
12958 /* return empty string for failure */
12959 rettv->v_type = VAR_STRING;
12960 rettv->vval.v_string = NULL;
12962 keys = get_tv_string(&argvars[0]);
12963 if (*keys == NUL)
12964 return;
12966 if (argvars[1].v_type != VAR_UNKNOWN)
12968 which = get_tv_string_buf_chk(&argvars[1], buf);
12969 if (argvars[2].v_type != VAR_UNKNOWN)
12970 abbr = get_tv_number(&argvars[2]);
12972 else
12973 which = (char_u *)"";
12974 if (which == NULL)
12975 return;
12977 mode = get_map_mode(&which, 0);
12979 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
12980 rhs = check_map(keys, mode, exact, FALSE, abbr);
12981 vim_free(keys_buf);
12982 if (rhs != NULL)
12984 ga_init(&ga);
12985 ga.ga_itemsize = 1;
12986 ga.ga_growsize = 40;
12988 while (*rhs != NUL)
12989 ga_concat(&ga, str2special(&rhs, FALSE));
12991 ga_append(&ga, NUL);
12992 rettv->vval.v_string = (char_u *)ga.ga_data;
12996 #ifdef FEAT_FLOAT
12998 * "log10()" function
13000 static void
13001 f_log10(argvars, rettv)
13002 typval_T *argvars;
13003 typval_T *rettv;
13005 float_T f;
13007 rettv->v_type = VAR_FLOAT;
13008 if (get_float_arg(argvars, &f) == OK)
13009 rettv->vval.v_float = log10(f);
13010 else
13011 rettv->vval.v_float = 0.0;
13013 #endif
13016 * "map()" function
13018 static void
13019 f_map(argvars, rettv)
13020 typval_T *argvars;
13021 typval_T *rettv;
13023 filter_map(argvars, rettv, TRUE);
13027 * "maparg()" function
13029 static void
13030 f_maparg(argvars, rettv)
13031 typval_T *argvars;
13032 typval_T *rettv;
13034 get_maparg(argvars, rettv, TRUE);
13038 * "mapcheck()" function
13040 static void
13041 f_mapcheck(argvars, rettv)
13042 typval_T *argvars;
13043 typval_T *rettv;
13045 get_maparg(argvars, rettv, FALSE);
13048 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13050 static void
13051 find_some_match(argvars, rettv, type)
13052 typval_T *argvars;
13053 typval_T *rettv;
13054 int type;
13056 char_u *str = NULL;
13057 char_u *expr = NULL;
13058 char_u *pat;
13059 regmatch_T regmatch;
13060 char_u patbuf[NUMBUFLEN];
13061 char_u strbuf[NUMBUFLEN];
13062 char_u *save_cpo;
13063 long start = 0;
13064 long nth = 1;
13065 colnr_T startcol = 0;
13066 int match = 0;
13067 list_T *l = NULL;
13068 listitem_T *li = NULL;
13069 long idx = 0;
13070 char_u *tofree = NULL;
13072 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13073 save_cpo = p_cpo;
13074 p_cpo = (char_u *)"";
13076 rettv->vval.v_number = -1;
13077 if (type == 3)
13079 /* return empty list when there are no matches */
13080 if (rettv_list_alloc(rettv) == FAIL)
13081 goto theend;
13083 else if (type == 2)
13085 rettv->v_type = VAR_STRING;
13086 rettv->vval.v_string = NULL;
13089 if (argvars[0].v_type == VAR_LIST)
13091 if ((l = argvars[0].vval.v_list) == NULL)
13092 goto theend;
13093 li = l->lv_first;
13095 else
13096 expr = str = get_tv_string(&argvars[0]);
13098 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13099 if (pat == NULL)
13100 goto theend;
13102 if (argvars[2].v_type != VAR_UNKNOWN)
13104 int error = FALSE;
13106 start = get_tv_number_chk(&argvars[2], &error);
13107 if (error)
13108 goto theend;
13109 if (l != NULL)
13111 li = list_find(l, start);
13112 if (li == NULL)
13113 goto theend;
13114 idx = l->lv_idx; /* use the cached index */
13116 else
13118 if (start < 0)
13119 start = 0;
13120 if (start > (long)STRLEN(str))
13121 goto theend;
13122 /* When "count" argument is there ignore matches before "start",
13123 * otherwise skip part of the string. Differs when pattern is "^"
13124 * or "\<". */
13125 if (argvars[3].v_type != VAR_UNKNOWN)
13126 startcol = start;
13127 else
13128 str += start;
13131 if (argvars[3].v_type != VAR_UNKNOWN)
13132 nth = get_tv_number_chk(&argvars[3], &error);
13133 if (error)
13134 goto theend;
13137 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13138 if (regmatch.regprog != NULL)
13140 regmatch.rm_ic = p_ic;
13142 for (;;)
13144 if (l != NULL)
13146 if (li == NULL)
13148 match = FALSE;
13149 break;
13151 vim_free(tofree);
13152 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13153 if (str == NULL)
13154 break;
13157 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13159 if (match && --nth <= 0)
13160 break;
13161 if (l == NULL && !match)
13162 break;
13164 /* Advance to just after the match. */
13165 if (l != NULL)
13167 li = li->li_next;
13168 ++idx;
13170 else
13172 #ifdef FEAT_MBYTE
13173 startcol = (colnr_T)(regmatch.startp[0]
13174 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13175 #else
13176 startcol = regmatch.startp[0] + 1 - str;
13177 #endif
13181 if (match)
13183 if (type == 3)
13185 int i;
13187 /* return list with matched string and submatches */
13188 for (i = 0; i < NSUBEXP; ++i)
13190 if (regmatch.endp[i] == NULL)
13192 if (list_append_string(rettv->vval.v_list,
13193 (char_u *)"", 0) == FAIL)
13194 break;
13196 else if (list_append_string(rettv->vval.v_list,
13197 regmatch.startp[i],
13198 (int)(regmatch.endp[i] - regmatch.startp[i]))
13199 == FAIL)
13200 break;
13203 else if (type == 2)
13205 /* return matched string */
13206 if (l != NULL)
13207 copy_tv(&li->li_tv, rettv);
13208 else
13209 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13210 (int)(regmatch.endp[0] - regmatch.startp[0]));
13212 else if (l != NULL)
13213 rettv->vval.v_number = idx;
13214 else
13216 if (type != 0)
13217 rettv->vval.v_number =
13218 (varnumber_T)(regmatch.startp[0] - str);
13219 else
13220 rettv->vval.v_number =
13221 (varnumber_T)(regmatch.endp[0] - str);
13222 rettv->vval.v_number += (varnumber_T)(str - expr);
13225 vim_free(regmatch.regprog);
13228 theend:
13229 vim_free(tofree);
13230 p_cpo = save_cpo;
13234 * "match()" function
13236 static void
13237 f_match(argvars, rettv)
13238 typval_T *argvars;
13239 typval_T *rettv;
13241 find_some_match(argvars, rettv, 1);
13245 * "matchadd()" function
13247 static void
13248 f_matchadd(argvars, rettv)
13249 typval_T *argvars;
13250 typval_T *rettv;
13252 #ifdef FEAT_SEARCH_EXTRA
13253 char_u buf[NUMBUFLEN];
13254 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13255 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13256 int prio = 10; /* default priority */
13257 int id = -1;
13258 int error = FALSE;
13260 rettv->vval.v_number = -1;
13262 if (grp == NULL || pat == NULL)
13263 return;
13264 if (argvars[2].v_type != VAR_UNKNOWN)
13266 prio = get_tv_number_chk(&argvars[2], &error);
13267 if (argvars[3].v_type != VAR_UNKNOWN)
13268 id = get_tv_number_chk(&argvars[3], &error);
13270 if (error == TRUE)
13271 return;
13272 if (id >= 1 && id <= 3)
13274 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13275 return;
13278 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13279 #endif
13283 * "matcharg()" function
13285 static void
13286 f_matcharg(argvars, rettv)
13287 typval_T *argvars;
13288 typval_T *rettv;
13290 if (rettv_list_alloc(rettv) == OK)
13292 #ifdef FEAT_SEARCH_EXTRA
13293 int id = get_tv_number(&argvars[0]);
13294 matchitem_T *m;
13296 if (id >= 1 && id <= 3)
13298 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13300 list_append_string(rettv->vval.v_list,
13301 syn_id2name(m->hlg_id), -1);
13302 list_append_string(rettv->vval.v_list, m->pattern, -1);
13304 else
13306 list_append_string(rettv->vval.v_list, NUL, -1);
13307 list_append_string(rettv->vval.v_list, NUL, -1);
13310 #endif
13315 * "matchdelete()" function
13317 static void
13318 f_matchdelete(argvars, rettv)
13319 typval_T *argvars;
13320 typval_T *rettv;
13322 #ifdef FEAT_SEARCH_EXTRA
13323 rettv->vval.v_number = match_delete(curwin,
13324 (int)get_tv_number(&argvars[0]), TRUE);
13325 #endif
13329 * "matchend()" function
13331 static void
13332 f_matchend(argvars, rettv)
13333 typval_T *argvars;
13334 typval_T *rettv;
13336 find_some_match(argvars, rettv, 0);
13340 * "matchlist()" function
13342 static void
13343 f_matchlist(argvars, rettv)
13344 typval_T *argvars;
13345 typval_T *rettv;
13347 find_some_match(argvars, rettv, 3);
13351 * "matchstr()" function
13353 static void
13354 f_matchstr(argvars, rettv)
13355 typval_T *argvars;
13356 typval_T *rettv;
13358 find_some_match(argvars, rettv, 2);
13361 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13363 static void
13364 max_min(argvars, rettv, domax)
13365 typval_T *argvars;
13366 typval_T *rettv;
13367 int domax;
13369 long n = 0;
13370 long i;
13371 int error = FALSE;
13373 if (argvars[0].v_type == VAR_LIST)
13375 list_T *l;
13376 listitem_T *li;
13378 l = argvars[0].vval.v_list;
13379 if (l != NULL)
13381 li = l->lv_first;
13382 if (li != NULL)
13384 n = get_tv_number_chk(&li->li_tv, &error);
13385 for (;;)
13387 li = li->li_next;
13388 if (li == NULL)
13389 break;
13390 i = get_tv_number_chk(&li->li_tv, &error);
13391 if (domax ? i > n : i < n)
13392 n = i;
13397 else if (argvars[0].v_type == VAR_DICT)
13399 dict_T *d;
13400 int first = TRUE;
13401 hashitem_T *hi;
13402 int todo;
13404 d = argvars[0].vval.v_dict;
13405 if (d != NULL)
13407 todo = (int)d->dv_hashtab.ht_used;
13408 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13410 if (!HASHITEM_EMPTY(hi))
13412 --todo;
13413 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13414 if (first)
13416 n = i;
13417 first = FALSE;
13419 else if (domax ? i > n : i < n)
13420 n = i;
13425 else
13426 EMSG(_(e_listdictarg));
13427 rettv->vval.v_number = error ? 0 : n;
13431 * "max()" function
13433 static void
13434 f_max(argvars, rettv)
13435 typval_T *argvars;
13436 typval_T *rettv;
13438 max_min(argvars, rettv, TRUE);
13442 * "min()" function
13444 static void
13445 f_min(argvars, rettv)
13446 typval_T *argvars;
13447 typval_T *rettv;
13449 max_min(argvars, rettv, FALSE);
13452 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13455 * Create the directory in which "dir" is located, and higher levels when
13456 * needed.
13458 static int
13459 mkdir_recurse(dir, prot)
13460 char_u *dir;
13461 int prot;
13463 char_u *p;
13464 char_u *updir;
13465 int r = FAIL;
13467 /* Get end of directory name in "dir".
13468 * We're done when it's "/" or "c:/". */
13469 p = gettail_sep(dir);
13470 if (p <= get_past_head(dir))
13471 return OK;
13473 /* If the directory exists we're done. Otherwise: create it.*/
13474 updir = vim_strnsave(dir, (int)(p - dir));
13475 if (updir == NULL)
13476 return FAIL;
13477 if (mch_isdir(updir))
13478 r = OK;
13479 else if (mkdir_recurse(updir, prot) == OK)
13480 r = vim_mkdir_emsg(updir, prot);
13481 vim_free(updir);
13482 return r;
13485 #ifdef vim_mkdir
13487 * "mkdir()" function
13489 static void
13490 f_mkdir(argvars, rettv)
13491 typval_T *argvars;
13492 typval_T *rettv;
13494 char_u *dir;
13495 char_u buf[NUMBUFLEN];
13496 int prot = 0755;
13498 rettv->vval.v_number = FAIL;
13499 if (check_restricted() || check_secure())
13500 return;
13502 dir = get_tv_string_buf(&argvars[0], buf);
13503 if (argvars[1].v_type != VAR_UNKNOWN)
13505 if (argvars[2].v_type != VAR_UNKNOWN)
13506 prot = get_tv_number_chk(&argvars[2], NULL);
13507 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13508 mkdir_recurse(dir, prot);
13510 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13512 #endif
13515 * "mode()" function
13517 static void
13518 f_mode(argvars, rettv)
13519 typval_T *argvars;
13520 typval_T *rettv;
13522 char_u buf[3];
13524 buf[1] = NUL;
13525 buf[2] = NUL;
13527 #ifdef FEAT_VISUAL
13528 if (VIsual_active)
13530 if (VIsual_select)
13531 buf[0] = VIsual_mode + 's' - 'v';
13532 else
13533 buf[0] = VIsual_mode;
13535 else
13536 #endif
13537 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13538 || State == CONFIRM)
13540 buf[0] = 'r';
13541 if (State == ASKMORE)
13542 buf[1] = 'm';
13543 else if (State == CONFIRM)
13544 buf[1] = '?';
13546 else if (State == EXTERNCMD)
13547 buf[0] = '!';
13548 else if (State & INSERT)
13550 #ifdef FEAT_VREPLACE
13551 if (State & VREPLACE_FLAG)
13553 buf[0] = 'R';
13554 buf[1] = 'v';
13556 else
13557 #endif
13558 if (State & REPLACE_FLAG)
13559 buf[0] = 'R';
13560 else
13561 buf[0] = 'i';
13563 else if (State & CMDLINE)
13565 buf[0] = 'c';
13566 if (exmode_active)
13567 buf[1] = 'v';
13569 else if (exmode_active)
13571 buf[0] = 'c';
13572 buf[1] = 'e';
13574 else
13576 buf[0] = 'n';
13577 if (finish_op)
13578 buf[1] = 'o';
13581 /* Clear out the minor mode when the argument is not a non-zero number or
13582 * non-empty string. */
13583 if (!non_zero_arg(&argvars[0]))
13584 buf[1] = NUL;
13586 rettv->vval.v_string = vim_strsave(buf);
13587 rettv->v_type = VAR_STRING;
13591 * "nextnonblank()" function
13593 static void
13594 f_nextnonblank(argvars, rettv)
13595 typval_T *argvars;
13596 typval_T *rettv;
13598 linenr_T lnum;
13600 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13602 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13604 lnum = 0;
13605 break;
13607 if (*skipwhite(ml_get(lnum)) != NUL)
13608 break;
13610 rettv->vval.v_number = lnum;
13614 * "nr2char()" function
13616 static void
13617 f_nr2char(argvars, rettv)
13618 typval_T *argvars;
13619 typval_T *rettv;
13621 char_u buf[NUMBUFLEN];
13623 #ifdef FEAT_MBYTE
13624 if (has_mbyte)
13625 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13626 else
13627 #endif
13629 buf[0] = (char_u)get_tv_number(&argvars[0]);
13630 buf[1] = NUL;
13632 rettv->v_type = VAR_STRING;
13633 rettv->vval.v_string = vim_strsave(buf);
13637 * "pathshorten()" function
13639 static void
13640 f_pathshorten(argvars, rettv)
13641 typval_T *argvars;
13642 typval_T *rettv;
13644 char_u *p;
13646 rettv->v_type = VAR_STRING;
13647 p = get_tv_string_chk(&argvars[0]);
13648 if (p == NULL)
13649 rettv->vval.v_string = NULL;
13650 else
13652 p = vim_strsave(p);
13653 rettv->vval.v_string = p;
13654 if (p != NULL)
13655 shorten_dir(p);
13659 #ifdef FEAT_FLOAT
13661 * "pow()" function
13663 static void
13664 f_pow(argvars, rettv)
13665 typval_T *argvars;
13666 typval_T *rettv;
13668 float_T fx, fy;
13670 rettv->v_type = VAR_FLOAT;
13671 if (get_float_arg(argvars, &fx) == OK
13672 && get_float_arg(&argvars[1], &fy) == OK)
13673 rettv->vval.v_float = pow(fx, fy);
13674 else
13675 rettv->vval.v_float = 0.0;
13677 #endif
13680 * "prevnonblank()" function
13682 static void
13683 f_prevnonblank(argvars, rettv)
13684 typval_T *argvars;
13685 typval_T *rettv;
13687 linenr_T lnum;
13689 lnum = get_tv_lnum(argvars);
13690 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13691 lnum = 0;
13692 else
13693 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13694 --lnum;
13695 rettv->vval.v_number = lnum;
13698 #ifdef HAVE_STDARG_H
13699 /* This dummy va_list is here because:
13700 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13701 * - locally in the function results in a "used before set" warning
13702 * - using va_start() to initialize it gives "function with fixed args" error */
13703 static va_list ap;
13704 #endif
13707 * "printf()" function
13709 static void
13710 f_printf(argvars, rettv)
13711 typval_T *argvars;
13712 typval_T *rettv;
13714 rettv->v_type = VAR_STRING;
13715 rettv->vval.v_string = NULL;
13716 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13718 char_u buf[NUMBUFLEN];
13719 int len;
13720 char_u *s;
13721 int saved_did_emsg = did_emsg;
13722 char *fmt;
13724 /* Get the required length, allocate the buffer and do it for real. */
13725 did_emsg = FALSE;
13726 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13727 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13728 if (!did_emsg)
13730 s = alloc(len + 1);
13731 if (s != NULL)
13733 rettv->vval.v_string = s;
13734 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13737 did_emsg |= saved_did_emsg;
13739 #endif
13743 * "pumvisible()" function
13745 static void
13746 f_pumvisible(argvars, rettv)
13747 typval_T *argvars UNUSED;
13748 typval_T *rettv UNUSED;
13750 #ifdef FEAT_INS_EXPAND
13751 if (pum_visible())
13752 rettv->vval.v_number = 1;
13753 #endif
13757 * "range()" function
13759 static void
13760 f_range(argvars, rettv)
13761 typval_T *argvars;
13762 typval_T *rettv;
13764 long start;
13765 long end;
13766 long stride = 1;
13767 long i;
13768 int error = FALSE;
13770 start = get_tv_number_chk(&argvars[0], &error);
13771 if (argvars[1].v_type == VAR_UNKNOWN)
13773 end = start - 1;
13774 start = 0;
13776 else
13778 end = get_tv_number_chk(&argvars[1], &error);
13779 if (argvars[2].v_type != VAR_UNKNOWN)
13780 stride = get_tv_number_chk(&argvars[2], &error);
13783 if (error)
13784 return; /* type error; errmsg already given */
13785 if (stride == 0)
13786 EMSG(_("E726: Stride is zero"));
13787 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13788 EMSG(_("E727: Start past end"));
13789 else
13791 if (rettv_list_alloc(rettv) == OK)
13792 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13793 if (list_append_number(rettv->vval.v_list,
13794 (varnumber_T)i) == FAIL)
13795 break;
13800 * "readfile()" function
13802 static void
13803 f_readfile(argvars, rettv)
13804 typval_T *argvars;
13805 typval_T *rettv;
13807 int binary = FALSE;
13808 char_u *fname;
13809 FILE *fd;
13810 listitem_T *li;
13811 #define FREAD_SIZE 200 /* optimized for text lines */
13812 char_u buf[FREAD_SIZE];
13813 int readlen; /* size of last fread() */
13814 int buflen; /* nr of valid chars in buf[] */
13815 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
13816 int tolist; /* first byte in buf[] still to be put in list */
13817 int chop; /* how many CR to chop off */
13818 char_u *prev = NULL; /* previously read bytes, if any */
13819 int prevlen = 0; /* length of "prev" if not NULL */
13820 char_u *s;
13821 int len;
13822 long maxline = MAXLNUM;
13823 long cnt = 0;
13825 if (argvars[1].v_type != VAR_UNKNOWN)
13827 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
13828 binary = TRUE;
13829 if (argvars[2].v_type != VAR_UNKNOWN)
13830 maxline = get_tv_number(&argvars[2]);
13833 if (rettv_list_alloc(rettv) == FAIL)
13834 return;
13836 /* Always open the file in binary mode, library functions have a mind of
13837 * their own about CR-LF conversion. */
13838 fname = get_tv_string(&argvars[0]);
13839 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
13841 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
13842 return;
13845 filtd = 0;
13846 while (cnt < maxline || maxline < 0)
13848 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
13849 buflen = filtd + readlen;
13850 tolist = 0;
13851 for ( ; filtd < buflen || readlen <= 0; ++filtd)
13853 if (buf[filtd] == '\n' || readlen <= 0)
13855 /* Only when in binary mode add an empty list item when the
13856 * last line ends in a '\n'. */
13857 if (!binary && readlen == 0 && filtd == 0)
13858 break;
13860 /* Found end-of-line or end-of-file: add a text line to the
13861 * list. */
13862 chop = 0;
13863 if (!binary)
13864 while (filtd - chop - 1 >= tolist
13865 && buf[filtd - chop - 1] == '\r')
13866 ++chop;
13867 len = filtd - tolist - chop;
13868 if (prev == NULL)
13869 s = vim_strnsave(buf + tolist, len);
13870 else
13872 s = alloc((unsigned)(prevlen + len + 1));
13873 if (s != NULL)
13875 mch_memmove(s, prev, prevlen);
13876 vim_free(prev);
13877 prev = NULL;
13878 mch_memmove(s + prevlen, buf + tolist, len);
13879 s[prevlen + len] = NUL;
13882 tolist = filtd + 1;
13884 li = listitem_alloc();
13885 if (li == NULL)
13887 vim_free(s);
13888 break;
13890 li->li_tv.v_type = VAR_STRING;
13891 li->li_tv.v_lock = 0;
13892 li->li_tv.vval.v_string = s;
13893 list_append(rettv->vval.v_list, li);
13895 if (++cnt >= maxline && maxline >= 0)
13896 break;
13897 if (readlen <= 0)
13898 break;
13900 else if (buf[filtd] == NUL)
13901 buf[filtd] = '\n';
13903 if (readlen <= 0)
13904 break;
13906 if (tolist == 0)
13908 /* "buf" is full, need to move text to an allocated buffer */
13909 if (prev == NULL)
13911 prev = vim_strnsave(buf, buflen);
13912 prevlen = buflen;
13914 else
13916 s = alloc((unsigned)(prevlen + buflen));
13917 if (s != NULL)
13919 mch_memmove(s, prev, prevlen);
13920 mch_memmove(s + prevlen, buf, buflen);
13921 vim_free(prev);
13922 prev = s;
13923 prevlen += buflen;
13926 filtd = 0;
13928 else
13930 mch_memmove(buf, buf + tolist, buflen - tolist);
13931 filtd -= tolist;
13936 * For a negative line count use only the lines at the end of the file,
13937 * free the rest.
13939 if (maxline < 0)
13940 while (cnt > -maxline)
13942 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
13943 --cnt;
13946 vim_free(prev);
13947 fclose(fd);
13950 #if defined(FEAT_RELTIME)
13951 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
13954 * Convert a List to proftime_T.
13955 * Return FAIL when there is something wrong.
13957 static int
13958 list2proftime(arg, tm)
13959 typval_T *arg;
13960 proftime_T *tm;
13962 long n1, n2;
13963 int error = FALSE;
13965 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
13966 || arg->vval.v_list->lv_len != 2)
13967 return FAIL;
13968 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
13969 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
13970 # ifdef WIN3264
13971 tm->HighPart = n1;
13972 tm->LowPart = n2;
13973 # else
13974 tm->tv_sec = n1;
13975 tm->tv_usec = n2;
13976 # endif
13977 return error ? FAIL : OK;
13979 #endif /* FEAT_RELTIME */
13982 * "reltime()" function
13984 static void
13985 f_reltime(argvars, rettv)
13986 typval_T *argvars;
13987 typval_T *rettv;
13989 #ifdef FEAT_RELTIME
13990 proftime_T res;
13991 proftime_T start;
13993 if (argvars[0].v_type == VAR_UNKNOWN)
13995 /* No arguments: get current time. */
13996 profile_start(&res);
13998 else if (argvars[1].v_type == VAR_UNKNOWN)
14000 if (list2proftime(&argvars[0], &res) == FAIL)
14001 return;
14002 profile_end(&res);
14004 else
14006 /* Two arguments: compute the difference. */
14007 if (list2proftime(&argvars[0], &start) == FAIL
14008 || list2proftime(&argvars[1], &res) == FAIL)
14009 return;
14010 profile_sub(&res, &start);
14013 if (rettv_list_alloc(rettv) == OK)
14015 long n1, n2;
14017 # ifdef WIN3264
14018 n1 = res.HighPart;
14019 n2 = res.LowPart;
14020 # else
14021 n1 = res.tv_sec;
14022 n2 = res.tv_usec;
14023 # endif
14024 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14025 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14027 #endif
14031 * "reltimestr()" function
14033 static void
14034 f_reltimestr(argvars, rettv)
14035 typval_T *argvars;
14036 typval_T *rettv;
14038 #ifdef FEAT_RELTIME
14039 proftime_T tm;
14040 #endif
14042 rettv->v_type = VAR_STRING;
14043 rettv->vval.v_string = NULL;
14044 #ifdef FEAT_RELTIME
14045 if (list2proftime(&argvars[0], &tm) == OK)
14046 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14047 #endif
14050 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14051 static void make_connection __ARGS((void));
14052 static int check_connection __ARGS((void));
14054 static void
14055 make_connection()
14057 if (X_DISPLAY == NULL
14058 # ifdef FEAT_GUI
14059 && !gui.in_use
14060 # endif
14063 x_force_connect = TRUE;
14064 setup_term_clip();
14065 x_force_connect = FALSE;
14069 static int
14070 check_connection()
14072 make_connection();
14073 if (X_DISPLAY == NULL)
14075 EMSG(_("E240: No connection to Vim server"));
14076 return FAIL;
14078 return OK;
14080 #endif
14082 #ifdef FEAT_CLIENTSERVER
14083 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14085 static void
14086 remote_common(argvars, rettv, expr)
14087 typval_T *argvars;
14088 typval_T *rettv;
14089 int expr;
14091 char_u *server_name;
14092 char_u *keys;
14093 char_u *r = NULL;
14094 char_u buf[NUMBUFLEN];
14095 # ifdef WIN32
14096 HWND w;
14097 # elif defined(FEAT_X11)
14098 Window w;
14099 # elif defined(MAC_CLIENTSERVER)
14100 int w; // This is the port number ('w' is a bit confusing)
14101 # endif
14103 if (check_restricted() || check_secure())
14104 return;
14106 # ifdef FEAT_X11
14107 if (check_connection() == FAIL)
14108 return;
14109 # endif
14111 server_name = get_tv_string_chk(&argvars[0]);
14112 if (server_name == NULL)
14113 return; /* type error; errmsg already given */
14114 keys = get_tv_string_buf(&argvars[1], buf);
14115 # ifdef WIN32
14116 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14117 # elif defined(FEAT_X11)
14118 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14119 < 0)
14120 # elif defined(MAC_CLIENTSERVER)
14121 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14122 # endif
14124 if (r != NULL)
14125 EMSG(r); /* sending worked but evaluation failed */
14126 else
14127 EMSG2(_("E241: Unable to send to %s"), server_name);
14128 return;
14131 rettv->vval.v_string = r;
14133 if (argvars[2].v_type != VAR_UNKNOWN)
14135 dictitem_T v;
14136 char_u str[30];
14137 char_u *idvar;
14139 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14140 v.di_tv.v_type = VAR_STRING;
14141 v.di_tv.vval.v_string = vim_strsave(str);
14142 idvar = get_tv_string_chk(&argvars[2]);
14143 if (idvar != NULL)
14144 set_var(idvar, &v.di_tv, FALSE);
14145 vim_free(v.di_tv.vval.v_string);
14148 #endif
14151 * "remote_expr()" function
14153 static void
14154 f_remote_expr(argvars, rettv)
14155 typval_T *argvars UNUSED;
14156 typval_T *rettv;
14158 rettv->v_type = VAR_STRING;
14159 rettv->vval.v_string = NULL;
14160 #ifdef FEAT_CLIENTSERVER
14161 remote_common(argvars, rettv, TRUE);
14162 #endif
14166 * "remote_foreground()" function
14168 static void
14169 f_remote_foreground(argvars, rettv)
14170 typval_T *argvars UNUSED;
14171 typval_T *rettv UNUSED;
14173 #ifdef FEAT_CLIENTSERVER
14174 # ifdef WIN32
14175 /* On Win32 it's done in this application. */
14177 char_u *server_name = get_tv_string_chk(&argvars[0]);
14179 if (server_name != NULL)
14180 serverForeground(server_name);
14182 # elif defined(FEAT_X11) || defined(MAC_CLIENTSERVER)
14183 /* Send a foreground() expression to the server. */
14184 argvars[1].v_type = VAR_STRING;
14185 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14186 argvars[2].v_type = VAR_UNKNOWN;
14187 remote_common(argvars, rettv, TRUE);
14188 vim_free(argvars[1].vval.v_string);
14189 # endif
14190 #endif
14193 static void
14194 f_remote_peek(argvars, rettv)
14195 typval_T *argvars UNUSED;
14196 typval_T *rettv;
14198 #ifdef FEAT_CLIENTSERVER
14199 dictitem_T v;
14200 char_u *s = NULL;
14201 # ifdef WIN32
14202 long_u n = 0;
14203 # endif
14204 char_u *serverid;
14206 if (check_restricted() || check_secure())
14208 rettv->vval.v_number = -1;
14209 return;
14211 serverid = get_tv_string_chk(&argvars[0]);
14212 if (serverid == NULL)
14214 rettv->vval.v_number = -1;
14215 return; /* type error; errmsg already given */
14217 # ifdef WIN32
14218 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14219 if (n == 0)
14220 rettv->vval.v_number = -1;
14221 else
14223 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14224 rettv->vval.v_number = (s != NULL);
14226 # elif defined(FEAT_X11)
14227 if (check_connection() == FAIL)
14228 return;
14230 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14231 serverStrToWin(serverid), &s);
14232 # elif defined(MAC_CLIENTSERVER)
14233 rettv->vval.v_number = serverPeekReply(serverStrToPort(serverid), &s);
14234 # endif
14236 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14238 char_u *retvar;
14240 v.di_tv.v_type = VAR_STRING;
14241 v.di_tv.vval.v_string = vim_strsave(s);
14242 retvar = get_tv_string_chk(&argvars[1]);
14243 if (retvar != NULL)
14244 set_var(retvar, &v.di_tv, FALSE);
14245 vim_free(v.di_tv.vval.v_string);
14247 #else
14248 rettv->vval.v_number = -1;
14249 #endif
14252 static void
14253 f_remote_read(argvars, rettv)
14254 typval_T *argvars UNUSED;
14255 typval_T *rettv;
14257 char_u *r = NULL;
14259 #ifdef FEAT_CLIENTSERVER
14260 char_u *serverid = get_tv_string_chk(&argvars[0]);
14262 if (serverid != NULL && !check_restricted() && !check_secure())
14264 # ifdef WIN32
14265 /* The server's HWND is encoded in the 'id' parameter */
14266 long_u n = 0;
14268 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14269 if (n != 0)
14270 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14271 if (r == NULL)
14272 # elif defined(FEAT_X11)
14273 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14274 serverStrToWin(serverid), &r, FALSE) < 0)
14275 # elif defined(MAC_CLIENTSERVER)
14276 if (serverReadReply(serverStrToPort(serverid), &r) < 0)
14277 # endif
14278 EMSG(_("E277: Unable to read a server reply"));
14280 #endif
14281 rettv->v_type = VAR_STRING;
14282 rettv->vval.v_string = r;
14286 * "remote_send()" function
14288 static void
14289 f_remote_send(argvars, rettv)
14290 typval_T *argvars UNUSED;
14291 typval_T *rettv;
14293 rettv->v_type = VAR_STRING;
14294 rettv->vval.v_string = NULL;
14295 #ifdef FEAT_CLIENTSERVER
14296 remote_common(argvars, rettv, FALSE);
14297 #endif
14301 * "remove()" function
14303 static void
14304 f_remove(argvars, rettv)
14305 typval_T *argvars;
14306 typval_T *rettv;
14308 list_T *l;
14309 listitem_T *item, *item2;
14310 listitem_T *li;
14311 long idx;
14312 long end;
14313 char_u *key;
14314 dict_T *d;
14315 dictitem_T *di;
14317 if (argvars[0].v_type == VAR_DICT)
14319 if (argvars[2].v_type != VAR_UNKNOWN)
14320 EMSG2(_(e_toomanyarg), "remove()");
14321 else if ((d = argvars[0].vval.v_dict) != NULL
14322 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14324 key = get_tv_string_chk(&argvars[1]);
14325 if (key != NULL)
14327 di = dict_find(d, key, -1);
14328 if (di == NULL)
14329 EMSG2(_(e_dictkey), key);
14330 else
14332 *rettv = di->di_tv;
14333 init_tv(&di->di_tv);
14334 dictitem_remove(d, di);
14339 else if (argvars[0].v_type != VAR_LIST)
14340 EMSG2(_(e_listdictarg), "remove()");
14341 else if ((l = argvars[0].vval.v_list) != NULL
14342 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14344 int error = FALSE;
14346 idx = get_tv_number_chk(&argvars[1], &error);
14347 if (error)
14348 ; /* type error: do nothing, errmsg already given */
14349 else if ((item = list_find(l, idx)) == NULL)
14350 EMSGN(_(e_listidx), idx);
14351 else
14353 if (argvars[2].v_type == VAR_UNKNOWN)
14355 /* Remove one item, return its value. */
14356 list_remove(l, item, item);
14357 *rettv = item->li_tv;
14358 vim_free(item);
14360 else
14362 /* Remove range of items, return list with values. */
14363 end = get_tv_number_chk(&argvars[2], &error);
14364 if (error)
14365 ; /* type error: do nothing */
14366 else if ((item2 = list_find(l, end)) == NULL)
14367 EMSGN(_(e_listidx), end);
14368 else
14370 int cnt = 0;
14372 for (li = item; li != NULL; li = li->li_next)
14374 ++cnt;
14375 if (li == item2)
14376 break;
14378 if (li == NULL) /* didn't find "item2" after "item" */
14379 EMSG(_(e_invrange));
14380 else
14382 list_remove(l, item, item2);
14383 if (rettv_list_alloc(rettv) == OK)
14385 l = rettv->vval.v_list;
14386 l->lv_first = item;
14387 l->lv_last = item2;
14388 item->li_prev = NULL;
14389 item2->li_next = NULL;
14390 l->lv_len = cnt;
14400 * "rename({from}, {to})" function
14402 static void
14403 f_rename(argvars, rettv)
14404 typval_T *argvars;
14405 typval_T *rettv;
14407 char_u buf[NUMBUFLEN];
14409 if (check_restricted() || check_secure())
14410 rettv->vval.v_number = -1;
14411 else
14412 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14413 get_tv_string_buf(&argvars[1], buf));
14417 * "repeat()" function
14419 static void
14420 f_repeat(argvars, rettv)
14421 typval_T *argvars;
14422 typval_T *rettv;
14424 char_u *p;
14425 int n;
14426 int slen;
14427 int len;
14428 char_u *r;
14429 int i;
14431 n = get_tv_number(&argvars[1]);
14432 if (argvars[0].v_type == VAR_LIST)
14434 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14435 while (n-- > 0)
14436 if (list_extend(rettv->vval.v_list,
14437 argvars[0].vval.v_list, NULL) == FAIL)
14438 break;
14440 else
14442 p = get_tv_string(&argvars[0]);
14443 rettv->v_type = VAR_STRING;
14444 rettv->vval.v_string = NULL;
14446 slen = (int)STRLEN(p);
14447 len = slen * n;
14448 if (len <= 0)
14449 return;
14451 r = alloc(len + 1);
14452 if (r != NULL)
14454 for (i = 0; i < n; i++)
14455 mch_memmove(r + i * slen, p, (size_t)slen);
14456 r[len] = NUL;
14459 rettv->vval.v_string = r;
14464 * "resolve()" function
14466 static void
14467 f_resolve(argvars, rettv)
14468 typval_T *argvars;
14469 typval_T *rettv;
14471 char_u *p;
14473 p = get_tv_string(&argvars[0]);
14474 #ifdef FEAT_SHORTCUT
14476 char_u *v = NULL;
14478 v = mch_resolve_shortcut(p);
14479 if (v != NULL)
14480 rettv->vval.v_string = v;
14481 else
14482 rettv->vval.v_string = vim_strsave(p);
14484 #else
14485 # ifdef HAVE_READLINK
14487 char_u buf[MAXPATHL + 1];
14488 char_u *cpy;
14489 int len;
14490 char_u *remain = NULL;
14491 char_u *q;
14492 int is_relative_to_current = FALSE;
14493 int has_trailing_pathsep = FALSE;
14494 int limit = 100;
14496 p = vim_strsave(p);
14498 if (p[0] == '.' && (vim_ispathsep(p[1])
14499 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14500 is_relative_to_current = TRUE;
14502 len = STRLEN(p);
14503 if (len > 0 && after_pathsep(p, p + len))
14504 has_trailing_pathsep = TRUE;
14506 q = getnextcomp(p);
14507 if (*q != NUL)
14509 /* Separate the first path component in "p", and keep the
14510 * remainder (beginning with the path separator). */
14511 remain = vim_strsave(q - 1);
14512 q[-1] = NUL;
14515 for (;;)
14517 for (;;)
14519 len = readlink((char *)p, (char *)buf, MAXPATHL);
14520 if (len <= 0)
14521 break;
14522 buf[len] = NUL;
14524 if (limit-- == 0)
14526 vim_free(p);
14527 vim_free(remain);
14528 EMSG(_("E655: Too many symbolic links (cycle?)"));
14529 rettv->vval.v_string = NULL;
14530 goto fail;
14533 /* Ensure that the result will have a trailing path separator
14534 * if the argument has one. */
14535 if (remain == NULL && has_trailing_pathsep)
14536 add_pathsep(buf);
14538 /* Separate the first path component in the link value and
14539 * concatenate the remainders. */
14540 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14541 if (*q != NUL)
14543 if (remain == NULL)
14544 remain = vim_strsave(q - 1);
14545 else
14547 cpy = concat_str(q - 1, remain);
14548 if (cpy != NULL)
14550 vim_free(remain);
14551 remain = cpy;
14554 q[-1] = NUL;
14557 q = gettail(p);
14558 if (q > p && *q == NUL)
14560 /* Ignore trailing path separator. */
14561 q[-1] = NUL;
14562 q = gettail(p);
14564 if (q > p && !mch_isFullName(buf))
14566 /* symlink is relative to directory of argument */
14567 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14568 if (cpy != NULL)
14570 STRCPY(cpy, p);
14571 STRCPY(gettail(cpy), buf);
14572 vim_free(p);
14573 p = cpy;
14576 else
14578 vim_free(p);
14579 p = vim_strsave(buf);
14583 if (remain == NULL)
14584 break;
14586 /* Append the first path component of "remain" to "p". */
14587 q = getnextcomp(remain + 1);
14588 len = q - remain - (*q != NUL);
14589 cpy = vim_strnsave(p, STRLEN(p) + len);
14590 if (cpy != NULL)
14592 STRNCAT(cpy, remain, len);
14593 vim_free(p);
14594 p = cpy;
14596 /* Shorten "remain". */
14597 if (*q != NUL)
14598 STRMOVE(remain, q - 1);
14599 else
14601 vim_free(remain);
14602 remain = NULL;
14606 /* If the result is a relative path name, make it explicitly relative to
14607 * the current directory if and only if the argument had this form. */
14608 if (!vim_ispathsep(*p))
14610 if (is_relative_to_current
14611 && *p != NUL
14612 && !(p[0] == '.'
14613 && (p[1] == NUL
14614 || vim_ispathsep(p[1])
14615 || (p[1] == '.'
14616 && (p[2] == NUL
14617 || vim_ispathsep(p[2]))))))
14619 /* Prepend "./". */
14620 cpy = concat_str((char_u *)"./", p);
14621 if (cpy != NULL)
14623 vim_free(p);
14624 p = cpy;
14627 else if (!is_relative_to_current)
14629 /* Strip leading "./". */
14630 q = p;
14631 while (q[0] == '.' && vim_ispathsep(q[1]))
14632 q += 2;
14633 if (q > p)
14634 STRMOVE(p, p + 2);
14638 /* Ensure that the result will have no trailing path separator
14639 * if the argument had none. But keep "/" or "//". */
14640 if (!has_trailing_pathsep)
14642 q = p + STRLEN(p);
14643 if (after_pathsep(p, q))
14644 *gettail_sep(p) = NUL;
14647 rettv->vval.v_string = p;
14649 # else
14650 rettv->vval.v_string = vim_strsave(p);
14651 # endif
14652 #endif
14654 simplify_filename(rettv->vval.v_string);
14656 #ifdef HAVE_READLINK
14657 fail:
14658 #endif
14659 rettv->v_type = VAR_STRING;
14663 * "reverse({list})" function
14665 static void
14666 f_reverse(argvars, rettv)
14667 typval_T *argvars;
14668 typval_T *rettv;
14670 list_T *l;
14671 listitem_T *li, *ni;
14673 if (argvars[0].v_type != VAR_LIST)
14674 EMSG2(_(e_listarg), "reverse()");
14675 else if ((l = argvars[0].vval.v_list) != NULL
14676 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14678 li = l->lv_last;
14679 l->lv_first = l->lv_last = NULL;
14680 l->lv_len = 0;
14681 while (li != NULL)
14683 ni = li->li_prev;
14684 list_append(l, li);
14685 li = ni;
14687 rettv->vval.v_list = l;
14688 rettv->v_type = VAR_LIST;
14689 ++l->lv_refcount;
14690 l->lv_idx = l->lv_len - l->lv_idx - 1;
14694 #define SP_NOMOVE 0x01 /* don't move cursor */
14695 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14696 #define SP_RETCOUNT 0x04 /* return matchcount */
14697 #define SP_SETPCMARK 0x08 /* set previous context mark */
14698 #define SP_START 0x10 /* accept match at start position */
14699 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14700 #define SP_END 0x40 /* leave cursor at end of match */
14702 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14705 * Get flags for a search function.
14706 * Possibly sets "p_ws".
14707 * Returns BACKWARD, FORWARD or zero (for an error).
14709 static int
14710 get_search_arg(varp, flagsp)
14711 typval_T *varp;
14712 int *flagsp;
14714 int dir = FORWARD;
14715 char_u *flags;
14716 char_u nbuf[NUMBUFLEN];
14717 int mask;
14719 if (varp->v_type != VAR_UNKNOWN)
14721 flags = get_tv_string_buf_chk(varp, nbuf);
14722 if (flags == NULL)
14723 return 0; /* type error; errmsg already given */
14724 while (*flags != NUL)
14726 switch (*flags)
14728 case 'b': dir = BACKWARD; break;
14729 case 'w': p_ws = TRUE; break;
14730 case 'W': p_ws = FALSE; break;
14731 default: mask = 0;
14732 if (flagsp != NULL)
14733 switch (*flags)
14735 case 'c': mask = SP_START; break;
14736 case 'e': mask = SP_END; break;
14737 case 'm': mask = SP_RETCOUNT; break;
14738 case 'n': mask = SP_NOMOVE; break;
14739 case 'p': mask = SP_SUBPAT; break;
14740 case 'r': mask = SP_REPEAT; break;
14741 case 's': mask = SP_SETPCMARK; break;
14743 if (mask == 0)
14745 EMSG2(_(e_invarg2), flags);
14746 dir = 0;
14748 else
14749 *flagsp |= mask;
14751 if (dir == 0)
14752 break;
14753 ++flags;
14756 return dir;
14760 * Shared by search() and searchpos() functions
14762 static int
14763 search_cmn(argvars, match_pos, flagsp)
14764 typval_T *argvars;
14765 pos_T *match_pos;
14766 int *flagsp;
14768 int flags;
14769 char_u *pat;
14770 pos_T pos;
14771 pos_T save_cursor;
14772 int save_p_ws = p_ws;
14773 int dir;
14774 int retval = 0; /* default: FAIL */
14775 long lnum_stop = 0;
14776 proftime_T tm;
14777 #ifdef FEAT_RELTIME
14778 long time_limit = 0;
14779 #endif
14780 int options = SEARCH_KEEP;
14781 int subpatnum;
14783 pat = get_tv_string(&argvars[0]);
14784 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14785 if (dir == 0)
14786 goto theend;
14787 flags = *flagsp;
14788 if (flags & SP_START)
14789 options |= SEARCH_START;
14790 if (flags & SP_END)
14791 options |= SEARCH_END;
14793 /* Optional arguments: line number to stop searching and timeout. */
14794 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14796 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14797 if (lnum_stop < 0)
14798 goto theend;
14799 #ifdef FEAT_RELTIME
14800 if (argvars[3].v_type != VAR_UNKNOWN)
14802 time_limit = get_tv_number_chk(&argvars[3], NULL);
14803 if (time_limit < 0)
14804 goto theend;
14806 #endif
14809 #ifdef FEAT_RELTIME
14810 /* Set the time limit, if there is one. */
14811 profile_setlimit(time_limit, &tm);
14812 #endif
14815 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
14816 * Check to make sure only those flags are set.
14817 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
14818 * flags cannot be set. Check for that condition also.
14820 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
14821 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14823 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
14824 goto theend;
14827 pos = save_cursor = curwin->w_cursor;
14828 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
14829 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
14830 if (subpatnum != FAIL)
14832 if (flags & SP_SUBPAT)
14833 retval = subpatnum;
14834 else
14835 retval = pos.lnum;
14836 if (flags & SP_SETPCMARK)
14837 setpcmark();
14838 curwin->w_cursor = pos;
14839 if (match_pos != NULL)
14841 /* Store the match cursor position */
14842 match_pos->lnum = pos.lnum;
14843 match_pos->col = pos.col + 1;
14845 /* "/$" will put the cursor after the end of the line, may need to
14846 * correct that here */
14847 check_cursor();
14850 /* If 'n' flag is used: restore cursor position. */
14851 if (flags & SP_NOMOVE)
14852 curwin->w_cursor = save_cursor;
14853 else
14854 curwin->w_set_curswant = TRUE;
14855 theend:
14856 p_ws = save_p_ws;
14858 return retval;
14861 #ifdef FEAT_FLOAT
14863 * "round({float})" function
14865 static void
14866 f_round(argvars, rettv)
14867 typval_T *argvars;
14868 typval_T *rettv;
14870 float_T f;
14872 rettv->v_type = VAR_FLOAT;
14873 if (get_float_arg(argvars, &f) == OK)
14874 /* round() is not in C90, use ceil() or floor() instead. */
14875 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
14876 else
14877 rettv->vval.v_float = 0.0;
14879 #endif
14882 * "search()" function
14884 static void
14885 f_search(argvars, rettv)
14886 typval_T *argvars;
14887 typval_T *rettv;
14889 int flags = 0;
14891 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
14895 * "searchdecl()" function
14897 static void
14898 f_searchdecl(argvars, rettv)
14899 typval_T *argvars;
14900 typval_T *rettv;
14902 int locally = 1;
14903 int thisblock = 0;
14904 int error = FALSE;
14905 char_u *name;
14907 rettv->vval.v_number = 1; /* default: FAIL */
14909 name = get_tv_string_chk(&argvars[0]);
14910 if (argvars[1].v_type != VAR_UNKNOWN)
14912 locally = get_tv_number_chk(&argvars[1], &error) == 0;
14913 if (!error && argvars[2].v_type != VAR_UNKNOWN)
14914 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
14916 if (!error && name != NULL)
14917 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
14918 locally, thisblock, SEARCH_KEEP) == FAIL;
14922 * Used by searchpair() and searchpairpos()
14924 static int
14925 searchpair_cmn(argvars, match_pos)
14926 typval_T *argvars;
14927 pos_T *match_pos;
14929 char_u *spat, *mpat, *epat;
14930 char_u *skip;
14931 int save_p_ws = p_ws;
14932 int dir;
14933 int flags = 0;
14934 char_u nbuf1[NUMBUFLEN];
14935 char_u nbuf2[NUMBUFLEN];
14936 char_u nbuf3[NUMBUFLEN];
14937 int retval = 0; /* default: FAIL */
14938 long lnum_stop = 0;
14939 long time_limit = 0;
14941 /* Get the three pattern arguments: start, middle, end. */
14942 spat = get_tv_string_chk(&argvars[0]);
14943 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
14944 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
14945 if (spat == NULL || mpat == NULL || epat == NULL)
14946 goto theend; /* type error */
14948 /* Handle the optional fourth argument: flags */
14949 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
14950 if (dir == 0)
14951 goto theend;
14953 /* Don't accept SP_END or SP_SUBPAT.
14954 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
14956 if ((flags & (SP_END | SP_SUBPAT)) != 0
14957 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
14959 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
14960 goto theend;
14963 /* Using 'r' implies 'W', otherwise it doesn't work. */
14964 if (flags & SP_REPEAT)
14965 p_ws = FALSE;
14967 /* Optional fifth argument: skip expression */
14968 if (argvars[3].v_type == VAR_UNKNOWN
14969 || argvars[4].v_type == VAR_UNKNOWN)
14970 skip = (char_u *)"";
14971 else
14973 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
14974 if (argvars[5].v_type != VAR_UNKNOWN)
14976 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
14977 if (lnum_stop < 0)
14978 goto theend;
14979 #ifdef FEAT_RELTIME
14980 if (argvars[6].v_type != VAR_UNKNOWN)
14982 time_limit = get_tv_number_chk(&argvars[6], NULL);
14983 if (time_limit < 0)
14984 goto theend;
14986 #endif
14989 if (skip == NULL)
14990 goto theend; /* type error */
14992 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
14993 match_pos, lnum_stop, time_limit);
14995 theend:
14996 p_ws = save_p_ws;
14998 return retval;
15002 * "searchpair()" function
15004 static void
15005 f_searchpair(argvars, rettv)
15006 typval_T *argvars;
15007 typval_T *rettv;
15009 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15013 * "searchpairpos()" function
15015 static void
15016 f_searchpairpos(argvars, rettv)
15017 typval_T *argvars;
15018 typval_T *rettv;
15020 pos_T match_pos;
15021 int lnum = 0;
15022 int col = 0;
15024 if (rettv_list_alloc(rettv) == FAIL)
15025 return;
15027 if (searchpair_cmn(argvars, &match_pos) > 0)
15029 lnum = match_pos.lnum;
15030 col = match_pos.col;
15033 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15034 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15038 * Search for a start/middle/end thing.
15039 * Used by searchpair(), see its documentation for the details.
15040 * Returns 0 or -1 for no match,
15042 long
15043 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15044 lnum_stop, time_limit)
15045 char_u *spat; /* start pattern */
15046 char_u *mpat; /* middle pattern */
15047 char_u *epat; /* end pattern */
15048 int dir; /* BACKWARD or FORWARD */
15049 char_u *skip; /* skip expression */
15050 int flags; /* SP_SETPCMARK and other SP_ values */
15051 pos_T *match_pos;
15052 linenr_T lnum_stop; /* stop at this line if not zero */
15053 long time_limit; /* stop after this many msec */
15055 char_u *save_cpo;
15056 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15057 long retval = 0;
15058 pos_T pos;
15059 pos_T firstpos;
15060 pos_T foundpos;
15061 pos_T save_cursor;
15062 pos_T save_pos;
15063 int n;
15064 int r;
15065 int nest = 1;
15066 int err;
15067 int options = SEARCH_KEEP;
15068 proftime_T tm;
15070 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15071 save_cpo = p_cpo;
15072 p_cpo = empty_option;
15074 #ifdef FEAT_RELTIME
15075 /* Set the time limit, if there is one. */
15076 profile_setlimit(time_limit, &tm);
15077 #endif
15079 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15080 * start/middle/end (pat3, for the top pair). */
15081 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15082 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15083 if (pat2 == NULL || pat3 == NULL)
15084 goto theend;
15085 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15086 if (*mpat == NUL)
15087 STRCPY(pat3, pat2);
15088 else
15089 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15090 spat, epat, mpat);
15091 if (flags & SP_START)
15092 options |= SEARCH_START;
15094 save_cursor = curwin->w_cursor;
15095 pos = curwin->w_cursor;
15096 clearpos(&firstpos);
15097 clearpos(&foundpos);
15098 pat = pat3;
15099 for (;;)
15101 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15102 options, RE_SEARCH, lnum_stop, &tm);
15103 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15104 /* didn't find it or found the first match again: FAIL */
15105 break;
15107 if (firstpos.lnum == 0)
15108 firstpos = pos;
15109 if (equalpos(pos, foundpos))
15111 /* Found the same position again. Can happen with a pattern that
15112 * has "\zs" at the end and searching backwards. Advance one
15113 * character and try again. */
15114 if (dir == BACKWARD)
15115 decl(&pos);
15116 else
15117 incl(&pos);
15119 foundpos = pos;
15121 /* clear the start flag to avoid getting stuck here */
15122 options &= ~SEARCH_START;
15124 /* If the skip pattern matches, ignore this match. */
15125 if (*skip != NUL)
15127 save_pos = curwin->w_cursor;
15128 curwin->w_cursor = pos;
15129 r = eval_to_bool(skip, &err, NULL, FALSE);
15130 curwin->w_cursor = save_pos;
15131 if (err)
15133 /* Evaluating {skip} caused an error, break here. */
15134 curwin->w_cursor = save_cursor;
15135 retval = -1;
15136 break;
15138 if (r)
15139 continue;
15142 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15144 /* Found end when searching backwards or start when searching
15145 * forward: nested pair. */
15146 ++nest;
15147 pat = pat2; /* nested, don't search for middle */
15149 else
15151 /* Found end when searching forward or start when searching
15152 * backward: end of (nested) pair; or found middle in outer pair. */
15153 if (--nest == 1)
15154 pat = pat3; /* outer level, search for middle */
15157 if (nest == 0)
15159 /* Found the match: return matchcount or line number. */
15160 if (flags & SP_RETCOUNT)
15161 ++retval;
15162 else
15163 retval = pos.lnum;
15164 if (flags & SP_SETPCMARK)
15165 setpcmark();
15166 curwin->w_cursor = pos;
15167 if (!(flags & SP_REPEAT))
15168 break;
15169 nest = 1; /* search for next unmatched */
15173 if (match_pos != NULL)
15175 /* Store the match cursor position */
15176 match_pos->lnum = curwin->w_cursor.lnum;
15177 match_pos->col = curwin->w_cursor.col + 1;
15180 /* If 'n' flag is used or search failed: restore cursor position. */
15181 if ((flags & SP_NOMOVE) || retval == 0)
15182 curwin->w_cursor = save_cursor;
15184 theend:
15185 vim_free(pat2);
15186 vim_free(pat3);
15187 if (p_cpo == empty_option)
15188 p_cpo = save_cpo;
15189 else
15190 /* Darn, evaluating the {skip} expression changed the value. */
15191 free_string_option(save_cpo);
15193 return retval;
15197 * "searchpos()" function
15199 static void
15200 f_searchpos(argvars, rettv)
15201 typval_T *argvars;
15202 typval_T *rettv;
15204 pos_T match_pos;
15205 int lnum = 0;
15206 int col = 0;
15207 int n;
15208 int flags = 0;
15210 if (rettv_list_alloc(rettv) == FAIL)
15211 return;
15213 n = search_cmn(argvars, &match_pos, &flags);
15214 if (n > 0)
15216 lnum = match_pos.lnum;
15217 col = match_pos.col;
15220 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15221 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15222 if (flags & SP_SUBPAT)
15223 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15227 static void
15228 f_server2client(argvars, rettv)
15229 typval_T *argvars UNUSED;
15230 typval_T *rettv;
15232 #ifdef FEAT_CLIENTSERVER
15233 char_u buf[NUMBUFLEN];
15234 char_u *server = get_tv_string_chk(&argvars[0]);
15235 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15237 rettv->vval.v_number = -1;
15238 if (server == NULL || reply == NULL)
15239 return;
15240 if (check_restricted() || check_secure())
15241 return;
15242 # ifdef FEAT_X11
15243 if (check_connection() == FAIL)
15244 return;
15245 # endif
15247 if (serverSendReply(server, reply) < 0)
15249 EMSG(_("E258: Unable to send to client"));
15250 return;
15252 rettv->vval.v_number = 0;
15253 #else
15254 rettv->vval.v_number = -1;
15255 #endif
15258 static void
15259 f_serverlist(argvars, rettv)
15260 typval_T *argvars UNUSED;
15261 typval_T *rettv;
15263 char_u *r = NULL;
15265 #ifdef FEAT_CLIENTSERVER
15266 # if defined(WIN32) || defined(MAC_CLIENTSERVER)
15267 r = serverGetVimNames();
15268 # elif defined(FEAT_X11)
15269 make_connection();
15270 if (X_DISPLAY != NULL)
15271 r = serverGetVimNames(X_DISPLAY);
15272 # endif
15273 #endif
15274 rettv->v_type = VAR_STRING;
15275 rettv->vval.v_string = r;
15279 * "setbufvar()" function
15281 static void
15282 f_setbufvar(argvars, rettv)
15283 typval_T *argvars;
15284 typval_T *rettv UNUSED;
15286 buf_T *buf;
15287 aco_save_T aco;
15288 char_u *varname, *bufvarname;
15289 typval_T *varp;
15290 char_u nbuf[NUMBUFLEN];
15292 if (check_restricted() || check_secure())
15293 return;
15294 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15295 varname = get_tv_string_chk(&argvars[1]);
15296 buf = get_buf_tv(&argvars[0]);
15297 varp = &argvars[2];
15299 if (buf != NULL && varname != NULL && varp != NULL)
15301 /* set curbuf to be our buf, temporarily */
15302 aucmd_prepbuf(&aco, buf);
15304 if (*varname == '&')
15306 long numval;
15307 char_u *strval;
15308 int error = FALSE;
15310 ++varname;
15311 numval = get_tv_number_chk(varp, &error);
15312 strval = get_tv_string_buf_chk(varp, nbuf);
15313 if (!error && strval != NULL)
15314 set_option_value(varname, numval, strval, OPT_LOCAL);
15316 else
15318 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15319 if (bufvarname != NULL)
15321 STRCPY(bufvarname, "b:");
15322 STRCPY(bufvarname + 2, varname);
15323 set_var(bufvarname, varp, TRUE);
15324 vim_free(bufvarname);
15328 /* reset notion of buffer */
15329 aucmd_restbuf(&aco);
15334 * "setcmdpos()" function
15336 static void
15337 f_setcmdpos(argvars, rettv)
15338 typval_T *argvars;
15339 typval_T *rettv;
15341 int pos = (int)get_tv_number(&argvars[0]) - 1;
15343 if (pos >= 0)
15344 rettv->vval.v_number = set_cmdline_pos(pos);
15348 * "setline()" function
15350 static void
15351 f_setline(argvars, rettv)
15352 typval_T *argvars;
15353 typval_T *rettv;
15355 linenr_T lnum;
15356 char_u *line = NULL;
15357 list_T *l = NULL;
15358 listitem_T *li = NULL;
15359 long added = 0;
15360 linenr_T lcount = curbuf->b_ml.ml_line_count;
15362 lnum = get_tv_lnum(&argvars[0]);
15363 if (argvars[1].v_type == VAR_LIST)
15365 l = argvars[1].vval.v_list;
15366 li = l->lv_first;
15368 else
15369 line = get_tv_string_chk(&argvars[1]);
15371 /* default result is zero == OK */
15372 for (;;)
15374 if (l != NULL)
15376 /* list argument, get next string */
15377 if (li == NULL)
15378 break;
15379 line = get_tv_string_chk(&li->li_tv);
15380 li = li->li_next;
15383 rettv->vval.v_number = 1; /* FAIL */
15384 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15385 break;
15386 if (lnum <= curbuf->b_ml.ml_line_count)
15388 /* existing line, replace it */
15389 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15391 changed_bytes(lnum, 0);
15392 if (lnum == curwin->w_cursor.lnum)
15393 check_cursor_col();
15394 rettv->vval.v_number = 0; /* OK */
15397 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15399 /* lnum is one past the last line, append the line */
15400 ++added;
15401 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15402 rettv->vval.v_number = 0; /* OK */
15405 if (l == NULL) /* only one string argument */
15406 break;
15407 ++lnum;
15410 if (added > 0)
15411 appended_lines_mark(lcount, added);
15414 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15417 * Used by "setqflist()" and "setloclist()" functions
15419 static void
15420 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15421 win_T *wp UNUSED;
15422 typval_T *list_arg UNUSED;
15423 typval_T *action_arg UNUSED;
15424 typval_T *rettv;
15426 #ifdef FEAT_QUICKFIX
15427 char_u *act;
15428 int action = ' ';
15429 #endif
15431 rettv->vval.v_number = -1;
15433 #ifdef FEAT_QUICKFIX
15434 if (list_arg->v_type != VAR_LIST)
15435 EMSG(_(e_listreq));
15436 else
15438 list_T *l = list_arg->vval.v_list;
15440 if (action_arg->v_type == VAR_STRING)
15442 act = get_tv_string_chk(action_arg);
15443 if (act == NULL)
15444 return; /* type error; errmsg already given */
15445 if (*act == 'a' || *act == 'r')
15446 action = *act;
15449 if (l != NULL && set_errorlist(wp, l, action) == OK)
15450 rettv->vval.v_number = 0;
15452 #endif
15456 * "setloclist()" function
15458 static void
15459 f_setloclist(argvars, rettv)
15460 typval_T *argvars;
15461 typval_T *rettv;
15463 win_T *win;
15465 rettv->vval.v_number = -1;
15467 win = find_win_by_nr(&argvars[0], NULL);
15468 if (win != NULL)
15469 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15473 * "setmatches()" function
15475 static void
15476 f_setmatches(argvars, rettv)
15477 typval_T *argvars;
15478 typval_T *rettv;
15480 #ifdef FEAT_SEARCH_EXTRA
15481 list_T *l;
15482 listitem_T *li;
15483 dict_T *d;
15485 rettv->vval.v_number = -1;
15486 if (argvars[0].v_type != VAR_LIST)
15488 EMSG(_(e_listreq));
15489 return;
15491 if ((l = argvars[0].vval.v_list) != NULL)
15494 /* To some extent make sure that we are dealing with a list from
15495 * "getmatches()". */
15496 li = l->lv_first;
15497 while (li != NULL)
15499 if (li->li_tv.v_type != VAR_DICT
15500 || (d = li->li_tv.vval.v_dict) == NULL)
15502 EMSG(_(e_invarg));
15503 return;
15505 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15506 && dict_find(d, (char_u *)"pattern", -1) != NULL
15507 && dict_find(d, (char_u *)"priority", -1) != NULL
15508 && dict_find(d, (char_u *)"id", -1) != NULL))
15510 EMSG(_(e_invarg));
15511 return;
15513 li = li->li_next;
15516 clear_matches(curwin);
15517 li = l->lv_first;
15518 while (li != NULL)
15520 d = li->li_tv.vval.v_dict;
15521 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15522 get_dict_string(d, (char_u *)"pattern", FALSE),
15523 (int)get_dict_number(d, (char_u *)"priority"),
15524 (int)get_dict_number(d, (char_u *)"id"));
15525 li = li->li_next;
15527 rettv->vval.v_number = 0;
15529 #endif
15533 * "setpos()" function
15535 static void
15536 f_setpos(argvars, rettv)
15537 typval_T *argvars;
15538 typval_T *rettv;
15540 pos_T pos;
15541 int fnum;
15542 char_u *name;
15544 rettv->vval.v_number = -1;
15545 name = get_tv_string_chk(argvars);
15546 if (name != NULL)
15548 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15550 --pos.col;
15551 if (name[0] == '.' && name[1] == NUL)
15553 /* set cursor */
15554 if (fnum == curbuf->b_fnum)
15556 curwin->w_cursor = pos;
15557 check_cursor();
15558 rettv->vval.v_number = 0;
15560 else
15561 EMSG(_(e_invarg));
15563 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15565 /* set mark */
15566 if (setmark_pos(name[1], &pos, fnum) == OK)
15567 rettv->vval.v_number = 0;
15569 else
15570 EMSG(_(e_invarg));
15576 * "setqflist()" function
15578 static void
15579 f_setqflist(argvars, rettv)
15580 typval_T *argvars;
15581 typval_T *rettv;
15583 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15587 * "setreg()" function
15589 static void
15590 f_setreg(argvars, rettv)
15591 typval_T *argvars;
15592 typval_T *rettv;
15594 int regname;
15595 char_u *strregname;
15596 char_u *stropt;
15597 char_u *strval;
15598 int append;
15599 char_u yank_type;
15600 long block_len;
15602 block_len = -1;
15603 yank_type = MAUTO;
15604 append = FALSE;
15606 strregname = get_tv_string_chk(argvars);
15607 rettv->vval.v_number = 1; /* FAIL is default */
15609 if (strregname == NULL)
15610 return; /* type error; errmsg already given */
15611 regname = *strregname;
15612 if (regname == 0 || regname == '@')
15613 regname = '"';
15614 else if (regname == '=')
15615 return;
15617 if (argvars[2].v_type != VAR_UNKNOWN)
15619 stropt = get_tv_string_chk(&argvars[2]);
15620 if (stropt == NULL)
15621 return; /* type error */
15622 for (; *stropt != NUL; ++stropt)
15623 switch (*stropt)
15625 case 'a': case 'A': /* append */
15626 append = TRUE;
15627 break;
15628 case 'v': case 'c': /* character-wise selection */
15629 yank_type = MCHAR;
15630 break;
15631 case 'V': case 'l': /* line-wise selection */
15632 yank_type = MLINE;
15633 break;
15634 #ifdef FEAT_VISUAL
15635 case 'b': case Ctrl_V: /* block-wise selection */
15636 yank_type = MBLOCK;
15637 if (VIM_ISDIGIT(stropt[1]))
15639 ++stropt;
15640 block_len = getdigits(&stropt) - 1;
15641 --stropt;
15643 break;
15644 #endif
15648 strval = get_tv_string_chk(&argvars[1]);
15649 if (strval != NULL)
15650 write_reg_contents_ex(regname, strval, -1,
15651 append, yank_type, block_len);
15652 rettv->vval.v_number = 0;
15656 * "settabwinvar()" function
15658 static void
15659 f_settabwinvar(argvars, rettv)
15660 typval_T *argvars;
15661 typval_T *rettv;
15663 setwinvar(argvars, rettv, 1);
15667 * "setwinvar()" function
15669 static void
15670 f_setwinvar(argvars, rettv)
15671 typval_T *argvars;
15672 typval_T *rettv;
15674 setwinvar(argvars, rettv, 0);
15678 * "setwinvar()" and "settabwinvar()" functions
15680 static void
15681 setwinvar(argvars, rettv, off)
15682 typval_T *argvars;
15683 typval_T *rettv UNUSED;
15684 int off;
15686 win_T *win;
15687 #ifdef FEAT_WINDOWS
15688 win_T *save_curwin;
15689 tabpage_T *save_curtab;
15690 #endif
15691 char_u *varname, *winvarname;
15692 typval_T *varp;
15693 char_u nbuf[NUMBUFLEN];
15694 tabpage_T *tp;
15696 if (check_restricted() || check_secure())
15697 return;
15699 #ifdef FEAT_WINDOWS
15700 if (off == 1)
15701 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15702 else
15703 tp = curtab;
15704 #endif
15705 win = find_win_by_nr(&argvars[off], tp);
15706 varname = get_tv_string_chk(&argvars[off + 1]);
15707 varp = &argvars[off + 2];
15709 if (win != NULL && varname != NULL && varp != NULL)
15711 #ifdef FEAT_WINDOWS
15712 /* set curwin to be our win, temporarily */
15713 save_curwin = curwin;
15714 save_curtab = curtab;
15715 goto_tabpage_tp(tp);
15716 if (!win_valid(win))
15717 return;
15718 curwin = win;
15719 curbuf = curwin->w_buffer;
15720 #endif
15722 if (*varname == '&')
15724 long numval;
15725 char_u *strval;
15726 int error = FALSE;
15728 ++varname;
15729 numval = get_tv_number_chk(varp, &error);
15730 strval = get_tv_string_buf_chk(varp, nbuf);
15731 if (!error && strval != NULL)
15732 set_option_value(varname, numval, strval, OPT_LOCAL);
15734 else
15736 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15737 if (winvarname != NULL)
15739 STRCPY(winvarname, "w:");
15740 STRCPY(winvarname + 2, varname);
15741 set_var(winvarname, varp, TRUE);
15742 vim_free(winvarname);
15746 #ifdef FEAT_WINDOWS
15747 /* Restore current tabpage and window, if still valid (autocomands can
15748 * make them invalid). */
15749 if (valid_tabpage(save_curtab))
15750 goto_tabpage_tp(save_curtab);
15751 if (win_valid(save_curwin))
15753 curwin = save_curwin;
15754 curbuf = curwin->w_buffer;
15756 #endif
15761 * "shellescape({string})" function
15763 static void
15764 f_shellescape(argvars, rettv)
15765 typval_T *argvars;
15766 typval_T *rettv;
15768 rettv->vval.v_string = vim_strsave_shellescape(
15769 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15770 rettv->v_type = VAR_STRING;
15774 * "simplify()" function
15776 static void
15777 f_simplify(argvars, rettv)
15778 typval_T *argvars;
15779 typval_T *rettv;
15781 char_u *p;
15783 p = get_tv_string(&argvars[0]);
15784 rettv->vval.v_string = vim_strsave(p);
15785 simplify_filename(rettv->vval.v_string); /* simplify in place */
15786 rettv->v_type = VAR_STRING;
15789 #ifdef FEAT_FLOAT
15791 * "sin()" function
15793 static void
15794 f_sin(argvars, rettv)
15795 typval_T *argvars;
15796 typval_T *rettv;
15798 float_T f;
15800 rettv->v_type = VAR_FLOAT;
15801 if (get_float_arg(argvars, &f) == OK)
15802 rettv->vval.v_float = sin(f);
15803 else
15804 rettv->vval.v_float = 0.0;
15806 #endif
15808 static int
15809 #ifdef __BORLANDC__
15810 _RTLENTRYF
15811 #endif
15812 item_compare __ARGS((const void *s1, const void *s2));
15813 static int
15814 #ifdef __BORLANDC__
15815 _RTLENTRYF
15816 #endif
15817 item_compare2 __ARGS((const void *s1, const void *s2));
15819 static int item_compare_ic;
15820 static char_u *item_compare_func;
15821 static int item_compare_func_err;
15822 #define ITEM_COMPARE_FAIL 999
15825 * Compare functions for f_sort() below.
15827 static int
15828 #ifdef __BORLANDC__
15829 _RTLENTRYF
15830 #endif
15831 item_compare(s1, s2)
15832 const void *s1;
15833 const void *s2;
15835 char_u *p1, *p2;
15836 char_u *tofree1, *tofree2;
15837 int res;
15838 char_u numbuf1[NUMBUFLEN];
15839 char_u numbuf2[NUMBUFLEN];
15841 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
15842 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
15843 if (p1 == NULL)
15844 p1 = (char_u *)"";
15845 if (p2 == NULL)
15846 p2 = (char_u *)"";
15847 if (item_compare_ic)
15848 res = STRICMP(p1, p2);
15849 else
15850 res = STRCMP(p1, p2);
15851 vim_free(tofree1);
15852 vim_free(tofree2);
15853 return res;
15856 static int
15857 #ifdef __BORLANDC__
15858 _RTLENTRYF
15859 #endif
15860 item_compare2(s1, s2)
15861 const void *s1;
15862 const void *s2;
15864 int res;
15865 typval_T rettv;
15866 typval_T argv[3];
15867 int dummy;
15869 /* shortcut after failure in previous call; compare all items equal */
15870 if (item_compare_func_err)
15871 return 0;
15873 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
15874 * in the copy without changing the original list items. */
15875 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
15876 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
15878 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
15879 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
15880 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
15881 clear_tv(&argv[0]);
15882 clear_tv(&argv[1]);
15884 if (res == FAIL)
15885 res = ITEM_COMPARE_FAIL;
15886 else
15887 res = get_tv_number_chk(&rettv, &item_compare_func_err);
15888 if (item_compare_func_err)
15889 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
15890 clear_tv(&rettv);
15891 return res;
15895 * "sort({list})" function
15897 static void
15898 f_sort(argvars, rettv)
15899 typval_T *argvars;
15900 typval_T *rettv;
15902 list_T *l;
15903 listitem_T *li;
15904 listitem_T **ptrs;
15905 long len;
15906 long i;
15908 if (argvars[0].v_type != VAR_LIST)
15909 EMSG2(_(e_listarg), "sort()");
15910 else
15912 l = argvars[0].vval.v_list;
15913 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
15914 return;
15915 rettv->vval.v_list = l;
15916 rettv->v_type = VAR_LIST;
15917 ++l->lv_refcount;
15919 len = list_len(l);
15920 if (len <= 1)
15921 return; /* short list sorts pretty quickly */
15923 item_compare_ic = FALSE;
15924 item_compare_func = NULL;
15925 if (argvars[1].v_type != VAR_UNKNOWN)
15927 if (argvars[1].v_type == VAR_FUNC)
15928 item_compare_func = argvars[1].vval.v_string;
15929 else
15931 int error = FALSE;
15933 i = get_tv_number_chk(&argvars[1], &error);
15934 if (error)
15935 return; /* type error; errmsg already given */
15936 if (i == 1)
15937 item_compare_ic = TRUE;
15938 else
15939 item_compare_func = get_tv_string(&argvars[1]);
15943 /* Make an array with each entry pointing to an item in the List. */
15944 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
15945 if (ptrs == NULL)
15946 return;
15947 i = 0;
15948 for (li = l->lv_first; li != NULL; li = li->li_next)
15949 ptrs[i++] = li;
15951 item_compare_func_err = FALSE;
15952 /* test the compare function */
15953 if (item_compare_func != NULL
15954 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
15955 == ITEM_COMPARE_FAIL)
15956 EMSG(_("E702: Sort compare function failed"));
15957 else
15959 /* Sort the array with item pointers. */
15960 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
15961 item_compare_func == NULL ? item_compare : item_compare2);
15963 if (!item_compare_func_err)
15965 /* Clear the List and append the items in the sorted order. */
15966 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
15967 l->lv_len = 0;
15968 for (i = 0; i < len; ++i)
15969 list_append(l, ptrs[i]);
15973 vim_free(ptrs);
15978 * "soundfold({word})" function
15980 static void
15981 f_soundfold(argvars, rettv)
15982 typval_T *argvars;
15983 typval_T *rettv;
15985 char_u *s;
15987 rettv->v_type = VAR_STRING;
15988 s = get_tv_string(&argvars[0]);
15989 #ifdef FEAT_SPELL
15990 rettv->vval.v_string = eval_soundfold(s);
15991 #else
15992 rettv->vval.v_string = vim_strsave(s);
15993 #endif
15997 * "spellbadword()" function
15999 static void
16000 f_spellbadword(argvars, rettv)
16001 typval_T *argvars UNUSED;
16002 typval_T *rettv;
16004 char_u *word = (char_u *)"";
16005 hlf_T attr = HLF_COUNT;
16006 int len = 0;
16008 if (rettv_list_alloc(rettv) == FAIL)
16009 return;
16011 #ifdef FEAT_SPELL
16012 if (argvars[0].v_type == VAR_UNKNOWN)
16014 /* Find the start and length of the badly spelled word. */
16015 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16016 if (len != 0)
16017 word = ml_get_cursor();
16019 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16021 char_u *str = get_tv_string_chk(&argvars[0]);
16022 int capcol = -1;
16024 if (str != NULL)
16026 /* Check the argument for spelling. */
16027 while (*str != NUL)
16029 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16030 if (attr != HLF_COUNT)
16032 word = str;
16033 break;
16035 str += len;
16039 #endif
16041 list_append_string(rettv->vval.v_list, word, len);
16042 list_append_string(rettv->vval.v_list, (char_u *)(
16043 attr == HLF_SPB ? "bad" :
16044 attr == HLF_SPR ? "rare" :
16045 attr == HLF_SPL ? "local" :
16046 attr == HLF_SPC ? "caps" :
16047 ""), -1);
16051 * "spellsuggest()" function
16053 static void
16054 f_spellsuggest(argvars, rettv)
16055 typval_T *argvars UNUSED;
16056 typval_T *rettv;
16058 #ifdef FEAT_SPELL
16059 char_u *str;
16060 int typeerr = FALSE;
16061 int maxcount;
16062 garray_T ga;
16063 int i;
16064 listitem_T *li;
16065 int need_capital = FALSE;
16066 #endif
16068 if (rettv_list_alloc(rettv) == FAIL)
16069 return;
16071 #ifdef FEAT_SPELL
16072 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16074 str = get_tv_string(&argvars[0]);
16075 if (argvars[1].v_type != VAR_UNKNOWN)
16077 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16078 if (maxcount <= 0)
16079 return;
16080 if (argvars[2].v_type != VAR_UNKNOWN)
16082 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16083 if (typeerr)
16084 return;
16087 else
16088 maxcount = 25;
16090 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16092 for (i = 0; i < ga.ga_len; ++i)
16094 str = ((char_u **)ga.ga_data)[i];
16096 li = listitem_alloc();
16097 if (li == NULL)
16098 vim_free(str);
16099 else
16101 li->li_tv.v_type = VAR_STRING;
16102 li->li_tv.v_lock = 0;
16103 li->li_tv.vval.v_string = str;
16104 list_append(rettv->vval.v_list, li);
16107 ga_clear(&ga);
16109 #endif
16112 static void
16113 f_split(argvars, rettv)
16114 typval_T *argvars;
16115 typval_T *rettv;
16117 char_u *str;
16118 char_u *end;
16119 char_u *pat = NULL;
16120 regmatch_T regmatch;
16121 char_u patbuf[NUMBUFLEN];
16122 char_u *save_cpo;
16123 int match;
16124 colnr_T col = 0;
16125 int keepempty = FALSE;
16126 int typeerr = FALSE;
16128 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16129 save_cpo = p_cpo;
16130 p_cpo = (char_u *)"";
16132 str = get_tv_string(&argvars[0]);
16133 if (argvars[1].v_type != VAR_UNKNOWN)
16135 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16136 if (pat == NULL)
16137 typeerr = TRUE;
16138 if (argvars[2].v_type != VAR_UNKNOWN)
16139 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16141 if (pat == NULL || *pat == NUL)
16142 pat = (char_u *)"[\\x01- ]\\+";
16144 if (rettv_list_alloc(rettv) == FAIL)
16145 return;
16146 if (typeerr)
16147 return;
16149 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16150 if (regmatch.regprog != NULL)
16152 regmatch.rm_ic = FALSE;
16153 while (*str != NUL || keepempty)
16155 if (*str == NUL)
16156 match = FALSE; /* empty item at the end */
16157 else
16158 match = vim_regexec_nl(&regmatch, str, col);
16159 if (match)
16160 end = regmatch.startp[0];
16161 else
16162 end = str + STRLEN(str);
16163 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16164 && *str != NUL && match && end < regmatch.endp[0]))
16166 if (list_append_string(rettv->vval.v_list, str,
16167 (int)(end - str)) == FAIL)
16168 break;
16170 if (!match)
16171 break;
16172 /* Advance to just after the match. */
16173 if (regmatch.endp[0] > str)
16174 col = 0;
16175 else
16177 /* Don't get stuck at the same match. */
16178 #ifdef FEAT_MBYTE
16179 col = (*mb_ptr2len)(regmatch.endp[0]);
16180 #else
16181 col = 1;
16182 #endif
16184 str = regmatch.endp[0];
16187 vim_free(regmatch.regprog);
16190 p_cpo = save_cpo;
16193 #ifdef FEAT_FLOAT
16195 * "sqrt()" function
16197 static void
16198 f_sqrt(argvars, rettv)
16199 typval_T *argvars;
16200 typval_T *rettv;
16202 float_T f;
16204 rettv->v_type = VAR_FLOAT;
16205 if (get_float_arg(argvars, &f) == OK)
16206 rettv->vval.v_float = sqrt(f);
16207 else
16208 rettv->vval.v_float = 0.0;
16212 * "str2float()" function
16214 static void
16215 f_str2float(argvars, rettv)
16216 typval_T *argvars;
16217 typval_T *rettv;
16219 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16221 if (*p == '+')
16222 p = skipwhite(p + 1);
16223 (void)string2float(p, &rettv->vval.v_float);
16224 rettv->v_type = VAR_FLOAT;
16226 #endif
16229 * "str2nr()" function
16231 static void
16232 f_str2nr(argvars, rettv)
16233 typval_T *argvars;
16234 typval_T *rettv;
16236 int base = 10;
16237 char_u *p;
16238 long n;
16240 if (argvars[1].v_type != VAR_UNKNOWN)
16242 base = get_tv_number(&argvars[1]);
16243 if (base != 8 && base != 10 && base != 16)
16245 EMSG(_(e_invarg));
16246 return;
16250 p = skipwhite(get_tv_string(&argvars[0]));
16251 if (*p == '+')
16252 p = skipwhite(p + 1);
16253 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16254 rettv->vval.v_number = n;
16257 #ifdef HAVE_STRFTIME
16259 * "strftime({format}[, {time}])" function
16261 static void
16262 f_strftime(argvars, rettv)
16263 typval_T *argvars;
16264 typval_T *rettv;
16266 char_u result_buf[256];
16267 struct tm *curtime;
16268 time_t seconds;
16269 char_u *p;
16271 rettv->v_type = VAR_STRING;
16273 p = get_tv_string(&argvars[0]);
16274 if (argvars[1].v_type == VAR_UNKNOWN)
16275 seconds = time(NULL);
16276 else
16277 seconds = (time_t)get_tv_number(&argvars[1]);
16278 curtime = localtime(&seconds);
16279 /* MSVC returns NULL for an invalid value of seconds. */
16280 if (curtime == NULL)
16281 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16282 else
16284 # ifdef FEAT_MBYTE
16285 vimconv_T conv;
16286 char_u *enc;
16288 conv.vc_type = CONV_NONE;
16289 enc = enc_locale();
16290 convert_setup(&conv, p_enc, enc);
16291 if (conv.vc_type != CONV_NONE)
16292 p = string_convert(&conv, p, NULL);
16293 # endif
16294 if (p != NULL)
16295 (void)strftime((char *)result_buf, sizeof(result_buf),
16296 (char *)p, curtime);
16297 else
16298 result_buf[0] = NUL;
16300 # ifdef FEAT_MBYTE
16301 if (conv.vc_type != CONV_NONE)
16302 vim_free(p);
16303 convert_setup(&conv, enc, p_enc);
16304 if (conv.vc_type != CONV_NONE)
16305 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16306 else
16307 # endif
16308 rettv->vval.v_string = vim_strsave(result_buf);
16310 # ifdef FEAT_MBYTE
16311 /* Release conversion descriptors */
16312 convert_setup(&conv, NULL, NULL);
16313 vim_free(enc);
16314 # endif
16317 #endif
16320 * "stridx()" function
16322 static void
16323 f_stridx(argvars, rettv)
16324 typval_T *argvars;
16325 typval_T *rettv;
16327 char_u buf[NUMBUFLEN];
16328 char_u *needle;
16329 char_u *haystack;
16330 char_u *save_haystack;
16331 char_u *pos;
16332 int start_idx;
16334 needle = get_tv_string_chk(&argvars[1]);
16335 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16336 rettv->vval.v_number = -1;
16337 if (needle == NULL || haystack == NULL)
16338 return; /* type error; errmsg already given */
16340 if (argvars[2].v_type != VAR_UNKNOWN)
16342 int error = FALSE;
16344 start_idx = get_tv_number_chk(&argvars[2], &error);
16345 if (error || start_idx >= (int)STRLEN(haystack))
16346 return;
16347 if (start_idx >= 0)
16348 haystack += start_idx;
16351 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16352 if (pos != NULL)
16353 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16357 * "string()" function
16359 static void
16360 f_string(argvars, rettv)
16361 typval_T *argvars;
16362 typval_T *rettv;
16364 char_u *tofree;
16365 char_u numbuf[NUMBUFLEN];
16367 rettv->v_type = VAR_STRING;
16368 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16369 /* Make a copy if we have a value but it's not in allocated memory. */
16370 if (rettv->vval.v_string != NULL && tofree == NULL)
16371 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16375 * "strlen()" function
16377 static void
16378 f_strlen(argvars, rettv)
16379 typval_T *argvars;
16380 typval_T *rettv;
16382 rettv->vval.v_number = (varnumber_T)(STRLEN(
16383 get_tv_string(&argvars[0])));
16387 * "strpart()" function
16389 static void
16390 f_strpart(argvars, rettv)
16391 typval_T *argvars;
16392 typval_T *rettv;
16394 char_u *p;
16395 int n;
16396 int len;
16397 int slen;
16398 int error = FALSE;
16400 p = get_tv_string(&argvars[0]);
16401 slen = (int)STRLEN(p);
16403 n = get_tv_number_chk(&argvars[1], &error);
16404 if (error)
16405 len = 0;
16406 else if (argvars[2].v_type != VAR_UNKNOWN)
16407 len = get_tv_number(&argvars[2]);
16408 else
16409 len = slen - n; /* default len: all bytes that are available. */
16412 * Only return the overlap between the specified part and the actual
16413 * string.
16415 if (n < 0)
16417 len += n;
16418 n = 0;
16420 else if (n > slen)
16421 n = slen;
16422 if (len < 0)
16423 len = 0;
16424 else if (n + len > slen)
16425 len = slen - n;
16427 rettv->v_type = VAR_STRING;
16428 rettv->vval.v_string = vim_strnsave(p + n, len);
16432 * "strridx()" function
16434 static void
16435 f_strridx(argvars, rettv)
16436 typval_T *argvars;
16437 typval_T *rettv;
16439 char_u buf[NUMBUFLEN];
16440 char_u *needle;
16441 char_u *haystack;
16442 char_u *rest;
16443 char_u *lastmatch = NULL;
16444 int haystack_len, end_idx;
16446 needle = get_tv_string_chk(&argvars[1]);
16447 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16449 rettv->vval.v_number = -1;
16450 if (needle == NULL || haystack == NULL)
16451 return; /* type error; errmsg already given */
16453 haystack_len = (int)STRLEN(haystack);
16454 if (argvars[2].v_type != VAR_UNKNOWN)
16456 /* Third argument: upper limit for index */
16457 end_idx = get_tv_number_chk(&argvars[2], NULL);
16458 if (end_idx < 0)
16459 return; /* can never find a match */
16461 else
16462 end_idx = haystack_len;
16464 if (*needle == NUL)
16466 /* Empty string matches past the end. */
16467 lastmatch = haystack + end_idx;
16469 else
16471 for (rest = haystack; *rest != '\0'; ++rest)
16473 rest = (char_u *)strstr((char *)rest, (char *)needle);
16474 if (rest == NULL || rest > haystack + end_idx)
16475 break;
16476 lastmatch = rest;
16480 if (lastmatch == NULL)
16481 rettv->vval.v_number = -1;
16482 else
16483 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16487 * "strtrans()" function
16489 static void
16490 f_strtrans(argvars, rettv)
16491 typval_T *argvars;
16492 typval_T *rettv;
16494 rettv->v_type = VAR_STRING;
16495 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16499 * "submatch()" function
16501 static void
16502 f_submatch(argvars, rettv)
16503 typval_T *argvars;
16504 typval_T *rettv;
16506 rettv->v_type = VAR_STRING;
16507 rettv->vval.v_string =
16508 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16512 * "substitute()" function
16514 static void
16515 f_substitute(argvars, rettv)
16516 typval_T *argvars;
16517 typval_T *rettv;
16519 char_u patbuf[NUMBUFLEN];
16520 char_u subbuf[NUMBUFLEN];
16521 char_u flagsbuf[NUMBUFLEN];
16523 char_u *str = get_tv_string_chk(&argvars[0]);
16524 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16525 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16526 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16528 rettv->v_type = VAR_STRING;
16529 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16530 rettv->vval.v_string = NULL;
16531 else
16532 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16536 * "synID(lnum, col, trans)" function
16538 static void
16539 f_synID(argvars, rettv)
16540 typval_T *argvars UNUSED;
16541 typval_T *rettv;
16543 int id = 0;
16544 #ifdef FEAT_SYN_HL
16545 long lnum;
16546 long col;
16547 int trans;
16548 int transerr = FALSE;
16550 lnum = get_tv_lnum(argvars); /* -1 on type error */
16551 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16552 trans = get_tv_number_chk(&argvars[2], &transerr);
16554 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16555 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16556 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16557 #endif
16559 rettv->vval.v_number = id;
16563 * "synIDattr(id, what [, mode])" function
16565 static void
16566 f_synIDattr(argvars, rettv)
16567 typval_T *argvars UNUSED;
16568 typval_T *rettv;
16570 char_u *p = NULL;
16571 #ifdef FEAT_SYN_HL
16572 int id;
16573 char_u *what;
16574 char_u *mode;
16575 char_u modebuf[NUMBUFLEN];
16576 int modec;
16578 id = get_tv_number(&argvars[0]);
16579 what = get_tv_string(&argvars[1]);
16580 if (argvars[2].v_type != VAR_UNKNOWN)
16582 mode = get_tv_string_buf(&argvars[2], modebuf);
16583 modec = TOLOWER_ASC(mode[0]);
16584 if (modec != 't' && modec != 'c'
16585 #ifdef FEAT_GUI
16586 && modec != 'g'
16587 #endif
16589 modec = 0; /* replace invalid with current */
16591 else
16593 #ifdef FEAT_GUI
16594 if (gui.in_use)
16595 modec = 'g';
16596 else
16597 #endif
16598 if (t_colors > 1)
16599 modec = 'c';
16600 else
16601 modec = 't';
16605 switch (TOLOWER_ASC(what[0]))
16607 case 'b':
16608 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16609 p = highlight_color(id, what, modec);
16610 else /* bold */
16611 p = highlight_has_attr(id, HL_BOLD, modec);
16612 break;
16614 case 'f': /* fg[#] */
16615 p = highlight_color(id, what, modec);
16616 break;
16618 case 'i':
16619 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16620 p = highlight_has_attr(id, HL_INVERSE, modec);
16621 else /* italic */
16622 p = highlight_has_attr(id, HL_ITALIC, modec);
16623 break;
16625 case 'n': /* name */
16626 p = get_highlight_name(NULL, id - 1);
16627 break;
16629 case 'r': /* reverse */
16630 p = highlight_has_attr(id, HL_INVERSE, modec);
16631 break;
16633 case 's':
16634 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16635 p = highlight_color(id, what, modec);
16636 else /* standout */
16637 p = highlight_has_attr(id, HL_STANDOUT, modec);
16638 break;
16640 case 'u':
16641 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16642 /* underline */
16643 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16644 else
16645 /* undercurl */
16646 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16647 break;
16650 if (p != NULL)
16651 p = vim_strsave(p);
16652 #endif
16653 rettv->v_type = VAR_STRING;
16654 rettv->vval.v_string = p;
16658 * "synIDtrans(id)" function
16660 static void
16661 f_synIDtrans(argvars, rettv)
16662 typval_T *argvars UNUSED;
16663 typval_T *rettv;
16665 int id;
16667 #ifdef FEAT_SYN_HL
16668 id = get_tv_number(&argvars[0]);
16670 if (id > 0)
16671 id = syn_get_final_id(id);
16672 else
16673 #endif
16674 id = 0;
16676 rettv->vval.v_number = id;
16680 * "synstack(lnum, col)" function
16682 static void
16683 f_synstack(argvars, rettv)
16684 typval_T *argvars UNUSED;
16685 typval_T *rettv;
16687 #ifdef FEAT_SYN_HL
16688 long lnum;
16689 long col;
16690 int i;
16691 int id;
16692 #endif
16694 rettv->v_type = VAR_LIST;
16695 rettv->vval.v_list = NULL;
16697 #ifdef FEAT_SYN_HL
16698 lnum = get_tv_lnum(argvars); /* -1 on type error */
16699 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16701 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16702 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16703 && rettv_list_alloc(rettv) != FAIL)
16705 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16706 for (i = 0; ; ++i)
16708 id = syn_get_stack_item(i);
16709 if (id < 0)
16710 break;
16711 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16712 break;
16715 #endif
16719 * "system()" function
16721 static void
16722 f_system(argvars, rettv)
16723 typval_T *argvars;
16724 typval_T *rettv;
16726 char_u *res = NULL;
16727 char_u *p;
16728 char_u *infile = NULL;
16729 char_u buf[NUMBUFLEN];
16730 int err = FALSE;
16731 FILE *fd;
16733 if (check_restricted() || check_secure())
16734 goto done;
16736 if (argvars[1].v_type != VAR_UNKNOWN)
16739 * Write the string to a temp file, to be used for input of the shell
16740 * command.
16742 if ((infile = vim_tempname('i')) == NULL)
16744 EMSG(_(e_notmp));
16745 goto done;
16748 fd = mch_fopen((char *)infile, WRITEBIN);
16749 if (fd == NULL)
16751 EMSG2(_(e_notopen), infile);
16752 goto done;
16754 p = get_tv_string_buf_chk(&argvars[1], buf);
16755 if (p == NULL)
16757 fclose(fd);
16758 goto done; /* type error; errmsg already given */
16760 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16761 err = TRUE;
16762 if (fclose(fd) != 0)
16763 err = TRUE;
16764 if (err)
16766 EMSG(_("E677: Error writing temp file"));
16767 goto done;
16771 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16772 SHELL_SILENT | SHELL_COOKED);
16774 #ifdef USE_CR
16775 /* translate <CR> into <NL> */
16776 if (res != NULL)
16778 char_u *s;
16780 for (s = res; *s; ++s)
16782 if (*s == CAR)
16783 *s = NL;
16786 #else
16787 # ifdef USE_CRNL
16788 /* translate <CR><NL> into <NL> */
16789 if (res != NULL)
16791 char_u *s, *d;
16793 d = res;
16794 for (s = res; *s; ++s)
16796 if (s[0] == CAR && s[1] == NL)
16797 ++s;
16798 *d++ = *s;
16800 *d = NUL;
16802 # endif
16803 #endif
16805 done:
16806 if (infile != NULL)
16808 mch_remove(infile);
16809 vim_free(infile);
16811 rettv->v_type = VAR_STRING;
16812 rettv->vval.v_string = res;
16816 * "tabpagebuflist()" function
16818 static void
16819 f_tabpagebuflist(argvars, rettv)
16820 typval_T *argvars UNUSED;
16821 typval_T *rettv UNUSED;
16823 #ifdef FEAT_WINDOWS
16824 tabpage_T *tp;
16825 win_T *wp = NULL;
16827 if (argvars[0].v_type == VAR_UNKNOWN)
16828 wp = firstwin;
16829 else
16831 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16832 if (tp != NULL)
16833 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16835 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
16837 for (; wp != NULL; wp = wp->w_next)
16838 if (list_append_number(rettv->vval.v_list,
16839 wp->w_buffer->b_fnum) == FAIL)
16840 break;
16842 #endif
16847 * "tabpagenr()" function
16849 static void
16850 f_tabpagenr(argvars, rettv)
16851 typval_T *argvars UNUSED;
16852 typval_T *rettv;
16854 int nr = 1;
16855 #ifdef FEAT_WINDOWS
16856 char_u *arg;
16858 if (argvars[0].v_type != VAR_UNKNOWN)
16860 arg = get_tv_string_chk(&argvars[0]);
16861 nr = 0;
16862 if (arg != NULL)
16864 if (STRCMP(arg, "$") == 0)
16865 nr = tabpage_index(NULL) - 1;
16866 else
16867 EMSG2(_(e_invexpr2), arg);
16870 else
16871 nr = tabpage_index(curtab);
16872 #endif
16873 rettv->vval.v_number = nr;
16877 #ifdef FEAT_WINDOWS
16878 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
16881 * Common code for tabpagewinnr() and winnr().
16883 static int
16884 get_winnr(tp, argvar)
16885 tabpage_T *tp;
16886 typval_T *argvar;
16888 win_T *twin;
16889 int nr = 1;
16890 win_T *wp;
16891 char_u *arg;
16893 twin = (tp == curtab) ? curwin : tp->tp_curwin;
16894 if (argvar->v_type != VAR_UNKNOWN)
16896 arg = get_tv_string_chk(argvar);
16897 if (arg == NULL)
16898 nr = 0; /* type error; errmsg already given */
16899 else if (STRCMP(arg, "$") == 0)
16900 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
16901 else if (STRCMP(arg, "#") == 0)
16903 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
16904 if (twin == NULL)
16905 nr = 0;
16907 else
16909 EMSG2(_(e_invexpr2), arg);
16910 nr = 0;
16914 if (nr > 0)
16915 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
16916 wp != twin; wp = wp->w_next)
16918 if (wp == NULL)
16920 /* didn't find it in this tabpage */
16921 nr = 0;
16922 break;
16924 ++nr;
16926 return nr;
16928 #endif
16931 * "tabpagewinnr()" function
16933 static void
16934 f_tabpagewinnr(argvars, rettv)
16935 typval_T *argvars UNUSED;
16936 typval_T *rettv;
16938 int nr = 1;
16939 #ifdef FEAT_WINDOWS
16940 tabpage_T *tp;
16942 tp = find_tabpage((int)get_tv_number(&argvars[0]));
16943 if (tp == NULL)
16944 nr = 0;
16945 else
16946 nr = get_winnr(tp, &argvars[1]);
16947 #endif
16948 rettv->vval.v_number = nr;
16953 * "tagfiles()" function
16955 static void
16956 f_tagfiles(argvars, rettv)
16957 typval_T *argvars UNUSED;
16958 typval_T *rettv;
16960 char_u fname[MAXPATHL + 1];
16961 tagname_T tn;
16962 int first;
16964 if (rettv_list_alloc(rettv) == FAIL)
16965 return;
16967 for (first = TRUE; ; first = FALSE)
16968 if (get_tagfname(&tn, first, fname) == FAIL
16969 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
16970 break;
16971 tagname_free(&tn);
16975 * "taglist()" function
16977 static void
16978 f_taglist(argvars, rettv)
16979 typval_T *argvars;
16980 typval_T *rettv;
16982 char_u *tag_pattern;
16984 tag_pattern = get_tv_string(&argvars[0]);
16986 rettv->vval.v_number = FALSE;
16987 if (*tag_pattern == NUL)
16988 return;
16990 if (rettv_list_alloc(rettv) == OK)
16991 (void)get_tags(rettv->vval.v_list, tag_pattern);
16995 * "tempname()" function
16997 static void
16998 f_tempname(argvars, rettv)
16999 typval_T *argvars UNUSED;
17000 typval_T *rettv;
17002 static int x = 'A';
17004 rettv->v_type = VAR_STRING;
17005 rettv->vval.v_string = vim_tempname(x);
17007 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17008 * names. Skip 'I' and 'O', they are used for shell redirection. */
17011 if (x == 'Z')
17012 x = '0';
17013 else if (x == '9')
17014 x = 'A';
17015 else
17017 #ifdef EBCDIC
17018 if (x == 'I')
17019 x = 'J';
17020 else if (x == 'R')
17021 x = 'S';
17022 else
17023 #endif
17024 ++x;
17026 } while (x == 'I' || x == 'O');
17030 * "test(list)" function: Just checking the walls...
17032 static void
17033 f_test(argvars, rettv)
17034 typval_T *argvars UNUSED;
17035 typval_T *rettv UNUSED;
17037 /* Used for unit testing. Change the code below to your liking. */
17038 #if 0
17039 listitem_T *li;
17040 list_T *l;
17041 char_u *bad, *good;
17043 if (argvars[0].v_type != VAR_LIST)
17044 return;
17045 l = argvars[0].vval.v_list;
17046 if (l == NULL)
17047 return;
17048 li = l->lv_first;
17049 if (li == NULL)
17050 return;
17051 bad = get_tv_string(&li->li_tv);
17052 li = li->li_next;
17053 if (li == NULL)
17054 return;
17055 good = get_tv_string(&li->li_tv);
17056 rettv->vval.v_number = test_edit_score(bad, good);
17057 #endif
17061 * "tolower(string)" function
17063 static void
17064 f_tolower(argvars, rettv)
17065 typval_T *argvars;
17066 typval_T *rettv;
17068 char_u *p;
17070 p = vim_strsave(get_tv_string(&argvars[0]));
17071 rettv->v_type = VAR_STRING;
17072 rettv->vval.v_string = p;
17074 if (p != NULL)
17075 while (*p != NUL)
17077 #ifdef FEAT_MBYTE
17078 int l;
17080 if (enc_utf8)
17082 int c, lc;
17084 c = utf_ptr2char(p);
17085 lc = utf_tolower(c);
17086 l = utf_ptr2len(p);
17087 /* TODO: reallocate string when byte count changes. */
17088 if (utf_char2len(lc) == l)
17089 utf_char2bytes(lc, p);
17090 p += l;
17092 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17093 p += l; /* skip multi-byte character */
17094 else
17095 #endif
17097 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17098 ++p;
17104 * "toupper(string)" function
17106 static void
17107 f_toupper(argvars, rettv)
17108 typval_T *argvars;
17109 typval_T *rettv;
17111 rettv->v_type = VAR_STRING;
17112 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17116 * "tr(string, fromstr, tostr)" function
17118 static void
17119 f_tr(argvars, rettv)
17120 typval_T *argvars;
17121 typval_T *rettv;
17123 char_u *instr;
17124 char_u *fromstr;
17125 char_u *tostr;
17126 char_u *p;
17127 #ifdef FEAT_MBYTE
17128 int inlen;
17129 int fromlen;
17130 int tolen;
17131 int idx;
17132 char_u *cpstr;
17133 int cplen;
17134 int first = TRUE;
17135 #endif
17136 char_u buf[NUMBUFLEN];
17137 char_u buf2[NUMBUFLEN];
17138 garray_T ga;
17140 instr = get_tv_string(&argvars[0]);
17141 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17142 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17144 /* Default return value: empty string. */
17145 rettv->v_type = VAR_STRING;
17146 rettv->vval.v_string = NULL;
17147 if (fromstr == NULL || tostr == NULL)
17148 return; /* type error; errmsg already given */
17149 ga_init2(&ga, (int)sizeof(char), 80);
17151 #ifdef FEAT_MBYTE
17152 if (!has_mbyte)
17153 #endif
17154 /* not multi-byte: fromstr and tostr must be the same length */
17155 if (STRLEN(fromstr) != STRLEN(tostr))
17157 #ifdef FEAT_MBYTE
17158 error:
17159 #endif
17160 EMSG2(_(e_invarg2), fromstr);
17161 ga_clear(&ga);
17162 return;
17165 /* fromstr and tostr have to contain the same number of chars */
17166 while (*instr != NUL)
17168 #ifdef FEAT_MBYTE
17169 if (has_mbyte)
17171 inlen = (*mb_ptr2len)(instr);
17172 cpstr = instr;
17173 cplen = inlen;
17174 idx = 0;
17175 for (p = fromstr; *p != NUL; p += fromlen)
17177 fromlen = (*mb_ptr2len)(p);
17178 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17180 for (p = tostr; *p != NUL; p += tolen)
17182 tolen = (*mb_ptr2len)(p);
17183 if (idx-- == 0)
17185 cplen = tolen;
17186 cpstr = p;
17187 break;
17190 if (*p == NUL) /* tostr is shorter than fromstr */
17191 goto error;
17192 break;
17194 ++idx;
17197 if (first && cpstr == instr)
17199 /* Check that fromstr and tostr have the same number of
17200 * (multi-byte) characters. Done only once when a character
17201 * of instr doesn't appear in fromstr. */
17202 first = FALSE;
17203 for (p = tostr; *p != NUL; p += tolen)
17205 tolen = (*mb_ptr2len)(p);
17206 --idx;
17208 if (idx != 0)
17209 goto error;
17212 ga_grow(&ga, cplen);
17213 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17214 ga.ga_len += cplen;
17216 instr += inlen;
17218 else
17219 #endif
17221 /* When not using multi-byte chars we can do it faster. */
17222 p = vim_strchr(fromstr, *instr);
17223 if (p != NULL)
17224 ga_append(&ga, tostr[p - fromstr]);
17225 else
17226 ga_append(&ga, *instr);
17227 ++instr;
17231 /* add a terminating NUL */
17232 ga_grow(&ga, 1);
17233 ga_append(&ga, NUL);
17235 rettv->vval.v_string = ga.ga_data;
17238 #ifdef FEAT_FLOAT
17240 * "trunc({float})" function
17242 static void
17243 f_trunc(argvars, rettv)
17244 typval_T *argvars;
17245 typval_T *rettv;
17247 float_T f;
17249 rettv->v_type = VAR_FLOAT;
17250 if (get_float_arg(argvars, &f) == OK)
17251 /* trunc() is not in C90, use floor() or ceil() instead. */
17252 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17253 else
17254 rettv->vval.v_float = 0.0;
17256 #endif
17259 * "type(expr)" function
17261 static void
17262 f_type(argvars, rettv)
17263 typval_T *argvars;
17264 typval_T *rettv;
17266 int n;
17268 switch (argvars[0].v_type)
17270 case VAR_NUMBER: n = 0; break;
17271 case VAR_STRING: n = 1; break;
17272 case VAR_FUNC: n = 2; break;
17273 case VAR_LIST: n = 3; break;
17274 case VAR_DICT: n = 4; break;
17275 #ifdef FEAT_FLOAT
17276 case VAR_FLOAT: n = 5; break;
17277 #endif
17278 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17280 rettv->vval.v_number = n;
17284 * "values(dict)" function
17286 static void
17287 f_values(argvars, rettv)
17288 typval_T *argvars;
17289 typval_T *rettv;
17291 dict_list(argvars, rettv, 1);
17295 * "virtcol(string)" function
17297 static void
17298 f_virtcol(argvars, rettv)
17299 typval_T *argvars;
17300 typval_T *rettv;
17302 colnr_T vcol = 0;
17303 pos_T *fp;
17304 int fnum = curbuf->b_fnum;
17306 fp = var2fpos(&argvars[0], FALSE, &fnum);
17307 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17308 && fnum == curbuf->b_fnum)
17310 getvvcol(curwin, fp, NULL, NULL, &vcol);
17311 ++vcol;
17314 rettv->vval.v_number = vcol;
17318 * "visualmode()" function
17320 static void
17321 f_visualmode(argvars, rettv)
17322 typval_T *argvars UNUSED;
17323 typval_T *rettv UNUSED;
17325 #ifdef FEAT_VISUAL
17326 char_u str[2];
17328 rettv->v_type = VAR_STRING;
17329 str[0] = curbuf->b_visual_mode_eval;
17330 str[1] = NUL;
17331 rettv->vval.v_string = vim_strsave(str);
17333 /* A non-zero number or non-empty string argument: reset mode. */
17334 if (non_zero_arg(&argvars[0]))
17335 curbuf->b_visual_mode_eval = NUL;
17336 #endif
17340 * "winbufnr(nr)" function
17342 static void
17343 f_winbufnr(argvars, rettv)
17344 typval_T *argvars;
17345 typval_T *rettv;
17347 win_T *wp;
17349 wp = find_win_by_nr(&argvars[0], NULL);
17350 if (wp == NULL)
17351 rettv->vval.v_number = -1;
17352 else
17353 rettv->vval.v_number = wp->w_buffer->b_fnum;
17357 * "wincol()" function
17359 static void
17360 f_wincol(argvars, rettv)
17361 typval_T *argvars UNUSED;
17362 typval_T *rettv;
17364 validate_cursor();
17365 rettv->vval.v_number = curwin->w_wcol + 1;
17369 * "winheight(nr)" function
17371 static void
17372 f_winheight(argvars, rettv)
17373 typval_T *argvars;
17374 typval_T *rettv;
17376 win_T *wp;
17378 wp = find_win_by_nr(&argvars[0], NULL);
17379 if (wp == NULL)
17380 rettv->vval.v_number = -1;
17381 else
17382 rettv->vval.v_number = wp->w_height;
17386 * "winline()" function
17388 static void
17389 f_winline(argvars, rettv)
17390 typval_T *argvars UNUSED;
17391 typval_T *rettv;
17393 validate_cursor();
17394 rettv->vval.v_number = curwin->w_wrow + 1;
17398 * "winnr()" function
17400 static void
17401 f_winnr(argvars, rettv)
17402 typval_T *argvars UNUSED;
17403 typval_T *rettv;
17405 int nr = 1;
17407 #ifdef FEAT_WINDOWS
17408 nr = get_winnr(curtab, &argvars[0]);
17409 #endif
17410 rettv->vval.v_number = nr;
17414 * "winrestcmd()" function
17416 static void
17417 f_winrestcmd(argvars, rettv)
17418 typval_T *argvars UNUSED;
17419 typval_T *rettv;
17421 #ifdef FEAT_WINDOWS
17422 win_T *wp;
17423 int winnr = 1;
17424 garray_T ga;
17425 char_u buf[50];
17427 ga_init2(&ga, (int)sizeof(char), 70);
17428 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17430 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17431 ga_concat(&ga, buf);
17432 # ifdef FEAT_VERTSPLIT
17433 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17434 ga_concat(&ga, buf);
17435 # endif
17436 ++winnr;
17438 ga_append(&ga, NUL);
17440 rettv->vval.v_string = ga.ga_data;
17441 #else
17442 rettv->vval.v_string = NULL;
17443 #endif
17444 rettv->v_type = VAR_STRING;
17448 * "winrestview()" function
17450 static void
17451 f_winrestview(argvars, rettv)
17452 typval_T *argvars;
17453 typval_T *rettv UNUSED;
17455 dict_T *dict;
17457 if (argvars[0].v_type != VAR_DICT
17458 || (dict = argvars[0].vval.v_dict) == NULL)
17459 EMSG(_(e_invarg));
17460 else
17462 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17463 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17464 #ifdef FEAT_VIRTUALEDIT
17465 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17466 #endif
17467 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17468 curwin->w_set_curswant = FALSE;
17470 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17471 #ifdef FEAT_DIFF
17472 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17473 #endif
17474 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17475 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17477 check_cursor();
17478 changed_cline_bef_curs();
17479 invalidate_botline();
17480 redraw_later(VALID);
17482 if (curwin->w_topline == 0)
17483 curwin->w_topline = 1;
17484 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17485 curwin->w_topline = curbuf->b_ml.ml_line_count;
17486 #ifdef FEAT_DIFF
17487 check_topfill(curwin, TRUE);
17488 #endif
17493 * "winsaveview()" function
17495 static void
17496 f_winsaveview(argvars, rettv)
17497 typval_T *argvars UNUSED;
17498 typval_T *rettv;
17500 dict_T *dict;
17502 dict = dict_alloc();
17503 if (dict == NULL)
17504 return;
17505 rettv->v_type = VAR_DICT;
17506 rettv->vval.v_dict = dict;
17507 ++dict->dv_refcount;
17509 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17510 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17511 #ifdef FEAT_VIRTUALEDIT
17512 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17513 #endif
17514 update_curswant();
17515 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17517 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17518 #ifdef FEAT_DIFF
17519 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17520 #endif
17521 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17522 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17526 * "winwidth(nr)" function
17528 static void
17529 f_winwidth(argvars, rettv)
17530 typval_T *argvars;
17531 typval_T *rettv;
17533 win_T *wp;
17535 wp = find_win_by_nr(&argvars[0], NULL);
17536 if (wp == NULL)
17537 rettv->vval.v_number = -1;
17538 else
17539 #ifdef FEAT_VERTSPLIT
17540 rettv->vval.v_number = wp->w_width;
17541 #else
17542 rettv->vval.v_number = Columns;
17543 #endif
17547 * "writefile()" function
17549 static void
17550 f_writefile(argvars, rettv)
17551 typval_T *argvars;
17552 typval_T *rettv;
17554 int binary = FALSE;
17555 char_u *fname;
17556 FILE *fd;
17557 listitem_T *li;
17558 char_u *s;
17559 int ret = 0;
17560 int c;
17562 if (check_restricted() || check_secure())
17563 return;
17565 if (argvars[0].v_type != VAR_LIST)
17567 EMSG2(_(e_listarg), "writefile()");
17568 return;
17570 if (argvars[0].vval.v_list == NULL)
17571 return;
17573 if (argvars[2].v_type != VAR_UNKNOWN
17574 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17575 binary = TRUE;
17577 /* Always open the file in binary mode, library functions have a mind of
17578 * their own about CR-LF conversion. */
17579 fname = get_tv_string(&argvars[1]);
17580 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17582 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17583 ret = -1;
17585 else
17587 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17588 li = li->li_next)
17590 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17592 if (*s == '\n')
17593 c = putc(NUL, fd);
17594 else
17595 c = putc(*s, fd);
17596 if (c == EOF)
17598 ret = -1;
17599 break;
17602 if (!binary || li->li_next != NULL)
17603 if (putc('\n', fd) == EOF)
17605 ret = -1;
17606 break;
17608 if (ret < 0)
17610 EMSG(_(e_write));
17611 break;
17614 fclose(fd);
17617 rettv->vval.v_number = ret;
17621 * Translate a String variable into a position.
17622 * Returns NULL when there is an error.
17624 static pos_T *
17625 var2fpos(varp, dollar_lnum, fnum)
17626 typval_T *varp;
17627 int dollar_lnum; /* TRUE when $ is last line */
17628 int *fnum; /* set to fnum for '0, 'A, etc. */
17630 char_u *name;
17631 static pos_T pos;
17632 pos_T *pp;
17634 /* Argument can be [lnum, col, coladd]. */
17635 if (varp->v_type == VAR_LIST)
17637 list_T *l;
17638 int len;
17639 int error = FALSE;
17640 listitem_T *li;
17642 l = varp->vval.v_list;
17643 if (l == NULL)
17644 return NULL;
17646 /* Get the line number */
17647 pos.lnum = list_find_nr(l, 0L, &error);
17648 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17649 return NULL; /* invalid line number */
17651 /* Get the column number */
17652 pos.col = list_find_nr(l, 1L, &error);
17653 if (error)
17654 return NULL;
17655 len = (long)STRLEN(ml_get(pos.lnum));
17657 /* We accept "$" for the column number: last column. */
17658 li = list_find(l, 1L);
17659 if (li != NULL && li->li_tv.v_type == VAR_STRING
17660 && li->li_tv.vval.v_string != NULL
17661 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17662 pos.col = len + 1;
17664 /* Accept a position up to the NUL after the line. */
17665 if (pos.col == 0 || (int)pos.col > len + 1)
17666 return NULL; /* invalid column number */
17667 --pos.col;
17669 #ifdef FEAT_VIRTUALEDIT
17670 /* Get the virtual offset. Defaults to zero. */
17671 pos.coladd = list_find_nr(l, 2L, &error);
17672 if (error)
17673 pos.coladd = 0;
17674 #endif
17676 return &pos;
17679 name = get_tv_string_chk(varp);
17680 if (name == NULL)
17681 return NULL;
17682 if (name[0] == '.') /* cursor */
17683 return &curwin->w_cursor;
17684 #ifdef FEAT_VISUAL
17685 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17687 if (VIsual_active)
17688 return &VIsual;
17689 return &curwin->w_cursor;
17691 #endif
17692 if (name[0] == '\'') /* mark */
17694 pp = getmark_fnum(name[1], FALSE, fnum);
17695 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17696 return NULL;
17697 return pp;
17700 #ifdef FEAT_VIRTUALEDIT
17701 pos.coladd = 0;
17702 #endif
17704 if (name[0] == 'w' && dollar_lnum)
17706 pos.col = 0;
17707 if (name[1] == '0') /* "w0": first visible line */
17709 update_topline();
17710 pos.lnum = curwin->w_topline;
17711 return &pos;
17713 else if (name[1] == '$') /* "w$": last visible line */
17715 validate_botline();
17716 pos.lnum = curwin->w_botline - 1;
17717 return &pos;
17720 else if (name[0] == '$') /* last column or line */
17722 if (dollar_lnum)
17724 pos.lnum = curbuf->b_ml.ml_line_count;
17725 pos.col = 0;
17727 else
17729 pos.lnum = curwin->w_cursor.lnum;
17730 pos.col = (colnr_T)STRLEN(ml_get_curline());
17732 return &pos;
17734 return NULL;
17738 * Convert list in "arg" into a position and optional file number.
17739 * When "fnump" is NULL there is no file number, only 3 items.
17740 * Note that the column is passed on as-is, the caller may want to decrement
17741 * it to use 1 for the first column.
17742 * Return FAIL when conversion is not possible, doesn't check the position for
17743 * validity.
17745 static int
17746 list2fpos(arg, posp, fnump)
17747 typval_T *arg;
17748 pos_T *posp;
17749 int *fnump;
17751 list_T *l = arg->vval.v_list;
17752 long i = 0;
17753 long n;
17755 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17756 * when "fnump" isn't NULL and "coladd" is optional. */
17757 if (arg->v_type != VAR_LIST
17758 || l == NULL
17759 || l->lv_len < (fnump == NULL ? 2 : 3)
17760 || l->lv_len > (fnump == NULL ? 3 : 4))
17761 return FAIL;
17763 if (fnump != NULL)
17765 n = list_find_nr(l, i++, NULL); /* fnum */
17766 if (n < 0)
17767 return FAIL;
17768 if (n == 0)
17769 n = curbuf->b_fnum; /* current buffer */
17770 *fnump = n;
17773 n = list_find_nr(l, i++, NULL); /* lnum */
17774 if (n < 0)
17775 return FAIL;
17776 posp->lnum = n;
17778 n = list_find_nr(l, i++, NULL); /* col */
17779 if (n < 0)
17780 return FAIL;
17781 posp->col = n;
17783 #ifdef FEAT_VIRTUALEDIT
17784 n = list_find_nr(l, i, NULL);
17785 if (n < 0)
17786 posp->coladd = 0;
17787 else
17788 posp->coladd = n;
17789 #endif
17791 return OK;
17795 * Get the length of an environment variable name.
17796 * Advance "arg" to the first character after the name.
17797 * Return 0 for error.
17799 static int
17800 get_env_len(arg)
17801 char_u **arg;
17803 char_u *p;
17804 int len;
17806 for (p = *arg; vim_isIDc(*p); ++p)
17808 if (p == *arg) /* no name found */
17809 return 0;
17811 len = (int)(p - *arg);
17812 *arg = p;
17813 return len;
17817 * Get the length of the name of a function or internal variable.
17818 * "arg" is advanced to the first non-white character after the name.
17819 * Return 0 if something is wrong.
17821 static int
17822 get_id_len(arg)
17823 char_u **arg;
17825 char_u *p;
17826 int len;
17828 /* Find the end of the name. */
17829 for (p = *arg; eval_isnamec(*p); ++p)
17831 if (p == *arg) /* no name found */
17832 return 0;
17834 len = (int)(p - *arg);
17835 *arg = skipwhite(p);
17837 return len;
17841 * Get the length of the name of a variable or function.
17842 * Only the name is recognized, does not handle ".key" or "[idx]".
17843 * "arg" is advanced to the first non-white character after the name.
17844 * Return -1 if curly braces expansion failed.
17845 * Return 0 if something else is wrong.
17846 * If the name contains 'magic' {}'s, expand them and return the
17847 * expanded name in an allocated string via 'alias' - caller must free.
17849 static int
17850 get_name_len(arg, alias, evaluate, verbose)
17851 char_u **arg;
17852 char_u **alias;
17853 int evaluate;
17854 int verbose;
17856 int len;
17857 char_u *p;
17858 char_u *expr_start;
17859 char_u *expr_end;
17861 *alias = NULL; /* default to no alias */
17863 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
17864 && (*arg)[2] == (int)KE_SNR)
17866 /* hard coded <SNR>, already translated */
17867 *arg += 3;
17868 return get_id_len(arg) + 3;
17870 len = eval_fname_script(*arg);
17871 if (len > 0)
17873 /* literal "<SID>", "s:" or "<SNR>" */
17874 *arg += len;
17878 * Find the end of the name; check for {} construction.
17880 p = find_name_end(*arg, &expr_start, &expr_end,
17881 len > 0 ? 0 : FNE_CHECK_START);
17882 if (expr_start != NULL)
17884 char_u *temp_string;
17886 if (!evaluate)
17888 len += (int)(p - *arg);
17889 *arg = skipwhite(p);
17890 return len;
17894 * Include any <SID> etc in the expanded string:
17895 * Thus the -len here.
17897 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
17898 if (temp_string == NULL)
17899 return -1;
17900 *alias = temp_string;
17901 *arg = skipwhite(p);
17902 return (int)STRLEN(temp_string);
17905 len += get_id_len(arg);
17906 if (len == 0 && verbose)
17907 EMSG2(_(e_invexpr2), *arg);
17909 return len;
17913 * Find the end of a variable or function name, taking care of magic braces.
17914 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
17915 * start and end of the first magic braces item.
17916 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
17917 * Return a pointer to just after the name. Equal to "arg" if there is no
17918 * valid name.
17920 static char_u *
17921 find_name_end(arg, expr_start, expr_end, flags)
17922 char_u *arg;
17923 char_u **expr_start;
17924 char_u **expr_end;
17925 int flags;
17927 int mb_nest = 0;
17928 int br_nest = 0;
17929 char_u *p;
17931 if (expr_start != NULL)
17933 *expr_start = NULL;
17934 *expr_end = NULL;
17937 /* Quick check for valid starting character. */
17938 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
17939 return arg;
17941 for (p = arg; *p != NUL
17942 && (eval_isnamec(*p)
17943 || *p == '{'
17944 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
17945 || mb_nest != 0
17946 || br_nest != 0); mb_ptr_adv(p))
17948 if (*p == '\'')
17950 /* skip over 'string' to avoid counting [ and ] inside it. */
17951 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
17953 if (*p == NUL)
17954 break;
17956 else if (*p == '"')
17958 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
17959 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
17960 if (*p == '\\' && p[1] != NUL)
17961 ++p;
17962 if (*p == NUL)
17963 break;
17966 if (mb_nest == 0)
17968 if (*p == '[')
17969 ++br_nest;
17970 else if (*p == ']')
17971 --br_nest;
17974 if (br_nest == 0)
17976 if (*p == '{')
17978 mb_nest++;
17979 if (expr_start != NULL && *expr_start == NULL)
17980 *expr_start = p;
17982 else if (*p == '}')
17984 mb_nest--;
17985 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
17986 *expr_end = p;
17991 return p;
17995 * Expands out the 'magic' {}'s in a variable/function name.
17996 * Note that this can call itself recursively, to deal with
17997 * constructs like foo{bar}{baz}{bam}
17998 * The four pointer arguments point to "foo{expre}ss{ion}bar"
17999 * "in_start" ^
18000 * "expr_start" ^
18001 * "expr_end" ^
18002 * "in_end" ^
18004 * Returns a new allocated string, which the caller must free.
18005 * Returns NULL for failure.
18007 static char_u *
18008 make_expanded_name(in_start, expr_start, expr_end, in_end)
18009 char_u *in_start;
18010 char_u *expr_start;
18011 char_u *expr_end;
18012 char_u *in_end;
18014 char_u c1;
18015 char_u *retval = NULL;
18016 char_u *temp_result;
18017 char_u *nextcmd = NULL;
18019 if (expr_end == NULL || in_end == NULL)
18020 return NULL;
18021 *expr_start = NUL;
18022 *expr_end = NUL;
18023 c1 = *in_end;
18024 *in_end = NUL;
18026 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18027 if (temp_result != NULL && nextcmd == NULL)
18029 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18030 + (in_end - expr_end) + 1));
18031 if (retval != NULL)
18033 STRCPY(retval, in_start);
18034 STRCAT(retval, temp_result);
18035 STRCAT(retval, expr_end + 1);
18038 vim_free(temp_result);
18040 *in_end = c1; /* put char back for error messages */
18041 *expr_start = '{';
18042 *expr_end = '}';
18044 if (retval != NULL)
18046 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18047 if (expr_start != NULL)
18049 /* Further expansion! */
18050 temp_result = make_expanded_name(retval, expr_start,
18051 expr_end, temp_result);
18052 vim_free(retval);
18053 retval = temp_result;
18057 return retval;
18061 * Return TRUE if character "c" can be used in a variable or function name.
18062 * Does not include '{' or '}' for magic braces.
18064 static int
18065 eval_isnamec(c)
18066 int c;
18068 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18072 * Return TRUE if character "c" can be used as the first character in a
18073 * variable or function name (excluding '{' and '}').
18075 static int
18076 eval_isnamec1(c)
18077 int c;
18079 return (ASCII_ISALPHA(c) || c == '_');
18083 * Set number v: variable to "val".
18085 void
18086 set_vim_var_nr(idx, val)
18087 int idx;
18088 long val;
18090 vimvars[idx].vv_nr = val;
18094 * Get number v: variable value.
18096 long
18097 get_vim_var_nr(idx)
18098 int idx;
18100 return vimvars[idx].vv_nr;
18104 * Get string v: variable value. Uses a static buffer, can only be used once.
18106 char_u *
18107 get_vim_var_str(idx)
18108 int idx;
18110 return get_tv_string(&vimvars[idx].vv_tv);
18114 * Get List v: variable value. Caller must take care of reference count when
18115 * needed.
18117 list_T *
18118 get_vim_var_list(idx)
18119 int idx;
18121 return vimvars[idx].vv_list;
18125 * Set v:char to character "c".
18127 void
18128 set_vim_var_char(c)
18129 int c;
18131 #ifdef FEAT_MBYTE
18132 char_u buf[MB_MAXBYTES];
18133 #else
18134 char_u buf[2];
18135 #endif
18137 #ifdef FEAT_MBYTE
18138 if (has_mbyte)
18139 buf[(*mb_char2bytes)(c, buf)] = NUL;
18140 else
18141 #endif
18143 buf[0] = c;
18144 buf[1] = NUL;
18146 set_vim_var_string(VV_CHAR, buf, -1);
18150 * Set v:count to "count" and v:count1 to "count1".
18151 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18153 void
18154 set_vcount(count, count1, set_prevcount)
18155 long count;
18156 long count1;
18157 int set_prevcount;
18159 if (set_prevcount)
18160 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18161 vimvars[VV_COUNT].vv_nr = count;
18162 vimvars[VV_COUNT1].vv_nr = count1;
18166 * Set string v: variable to a copy of "val".
18168 void
18169 set_vim_var_string(idx, val, len)
18170 int idx;
18171 char_u *val;
18172 int len; /* length of "val" to use or -1 (whole string) */
18174 /* Need to do this (at least) once, since we can't initialize a union.
18175 * Will always be invoked when "v:progname" is set. */
18176 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18178 vim_free(vimvars[idx].vv_str);
18179 if (val == NULL)
18180 vimvars[idx].vv_str = NULL;
18181 else if (len == -1)
18182 vimvars[idx].vv_str = vim_strsave(val);
18183 else
18184 vimvars[idx].vv_str = vim_strnsave(val, len);
18188 * Set List v: variable to "val".
18190 void
18191 set_vim_var_list(idx, val)
18192 int idx;
18193 list_T *val;
18195 list_unref(vimvars[idx].vv_list);
18196 vimvars[idx].vv_list = val;
18197 if (val != NULL)
18198 ++val->lv_refcount;
18202 * Set v:register if needed.
18204 void
18205 set_reg_var(c)
18206 int c;
18208 char_u regname;
18210 if (c == 0 || c == ' ')
18211 regname = '"';
18212 else
18213 regname = c;
18214 /* Avoid free/alloc when the value is already right. */
18215 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18216 set_vim_var_string(VV_REG, &regname, 1);
18220 * Get or set v:exception. If "oldval" == NULL, return the current value.
18221 * Otherwise, restore the value to "oldval" and return NULL.
18222 * Must always be called in pairs to save and restore v:exception! Does not
18223 * take care of memory allocations.
18225 char_u *
18226 v_exception(oldval)
18227 char_u *oldval;
18229 if (oldval == NULL)
18230 return vimvars[VV_EXCEPTION].vv_str;
18232 vimvars[VV_EXCEPTION].vv_str = oldval;
18233 return NULL;
18237 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18238 * Otherwise, restore the value to "oldval" and return NULL.
18239 * Must always be called in pairs to save and restore v:throwpoint! Does not
18240 * take care of memory allocations.
18242 char_u *
18243 v_throwpoint(oldval)
18244 char_u *oldval;
18246 if (oldval == NULL)
18247 return vimvars[VV_THROWPOINT].vv_str;
18249 vimvars[VV_THROWPOINT].vv_str = oldval;
18250 return NULL;
18253 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18255 * Set v:cmdarg.
18256 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18257 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18258 * Must always be called in pairs!
18260 char_u *
18261 set_cmdarg(eap, oldarg)
18262 exarg_T *eap;
18263 char_u *oldarg;
18265 char_u *oldval;
18266 char_u *newval;
18267 unsigned len;
18269 oldval = vimvars[VV_CMDARG].vv_str;
18270 if (eap == NULL)
18272 vim_free(oldval);
18273 vimvars[VV_CMDARG].vv_str = oldarg;
18274 return NULL;
18277 if (eap->force_bin == FORCE_BIN)
18278 len = 6;
18279 else if (eap->force_bin == FORCE_NOBIN)
18280 len = 8;
18281 else
18282 len = 0;
18284 if (eap->read_edit)
18285 len += 7;
18287 if (eap->force_ff != 0)
18288 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18289 # ifdef FEAT_MBYTE
18290 if (eap->force_enc != 0)
18291 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18292 if (eap->bad_char != 0)
18293 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18294 # endif
18296 newval = alloc(len + 1);
18297 if (newval == NULL)
18298 return NULL;
18300 if (eap->force_bin == FORCE_BIN)
18301 sprintf((char *)newval, " ++bin");
18302 else if (eap->force_bin == FORCE_NOBIN)
18303 sprintf((char *)newval, " ++nobin");
18304 else
18305 *newval = NUL;
18307 if (eap->read_edit)
18308 STRCAT(newval, " ++edit");
18310 if (eap->force_ff != 0)
18311 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18312 eap->cmd + eap->force_ff);
18313 # ifdef FEAT_MBYTE
18314 if (eap->force_enc != 0)
18315 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18316 eap->cmd + eap->force_enc);
18317 if (eap->bad_char != 0)
18318 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18319 eap->cmd + eap->bad_char);
18320 # endif
18321 vimvars[VV_CMDARG].vv_str = newval;
18322 return oldval;
18324 #endif
18327 * Get the value of internal variable "name".
18328 * Return OK or FAIL.
18330 static int
18331 get_var_tv(name, len, rettv, verbose)
18332 char_u *name;
18333 int len; /* length of "name" */
18334 typval_T *rettv; /* NULL when only checking existence */
18335 int verbose; /* may give error message */
18337 int ret = OK;
18338 typval_T *tv = NULL;
18339 typval_T atv;
18340 dictitem_T *v;
18341 int cc;
18343 /* truncate the name, so that we can use strcmp() */
18344 cc = name[len];
18345 name[len] = NUL;
18348 * Check for "b:changedtick".
18350 if (STRCMP(name, "b:changedtick") == 0)
18352 atv.v_type = VAR_NUMBER;
18353 atv.vval.v_number = curbuf->b_changedtick;
18354 tv = &atv;
18358 * Check for user-defined variables.
18360 else
18362 v = find_var(name, NULL);
18363 if (v != NULL)
18364 tv = &v->di_tv;
18367 if (tv == NULL)
18369 if (rettv != NULL && verbose)
18370 EMSG2(_(e_undefvar), name);
18371 ret = FAIL;
18373 else if (rettv != NULL)
18374 copy_tv(tv, rettv);
18376 name[len] = cc;
18378 return ret;
18382 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18383 * Also handle function call with Funcref variable: func(expr)
18384 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18386 static int
18387 handle_subscript(arg, rettv, evaluate, verbose)
18388 char_u **arg;
18389 typval_T *rettv;
18390 int evaluate; /* do more than finding the end */
18391 int verbose; /* give error messages */
18393 int ret = OK;
18394 dict_T *selfdict = NULL;
18395 char_u *s;
18396 int len;
18397 typval_T functv;
18399 while (ret == OK
18400 && (**arg == '['
18401 || (**arg == '.' && rettv->v_type == VAR_DICT)
18402 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18403 && !vim_iswhite(*(*arg - 1)))
18405 if (**arg == '(')
18407 /* need to copy the funcref so that we can clear rettv */
18408 functv = *rettv;
18409 rettv->v_type = VAR_UNKNOWN;
18411 /* Invoke the function. Recursive! */
18412 s = functv.vval.v_string;
18413 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18414 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18415 &len, evaluate, selfdict);
18417 /* Clear the funcref afterwards, so that deleting it while
18418 * evaluating the arguments is possible (see test55). */
18419 clear_tv(&functv);
18421 /* Stop the expression evaluation when immediately aborting on
18422 * error, or when an interrupt occurred or an exception was thrown
18423 * but not caught. */
18424 if (aborting())
18426 if (ret == OK)
18427 clear_tv(rettv);
18428 ret = FAIL;
18430 dict_unref(selfdict);
18431 selfdict = NULL;
18433 else /* **arg == '[' || **arg == '.' */
18435 dict_unref(selfdict);
18436 if (rettv->v_type == VAR_DICT)
18438 selfdict = rettv->vval.v_dict;
18439 if (selfdict != NULL)
18440 ++selfdict->dv_refcount;
18442 else
18443 selfdict = NULL;
18444 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18446 clear_tv(rettv);
18447 ret = FAIL;
18451 dict_unref(selfdict);
18452 return ret;
18456 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18457 * value).
18459 static typval_T *
18460 alloc_tv()
18462 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18466 * Allocate memory for a variable type-value, and assign a string to it.
18467 * The string "s" must have been allocated, it is consumed.
18468 * Return NULL for out of memory, the variable otherwise.
18470 static typval_T *
18471 alloc_string_tv(s)
18472 char_u *s;
18474 typval_T *rettv;
18476 rettv = alloc_tv();
18477 if (rettv != NULL)
18479 rettv->v_type = VAR_STRING;
18480 rettv->vval.v_string = s;
18482 else
18483 vim_free(s);
18484 return rettv;
18488 * Free the memory for a variable type-value.
18490 void
18491 free_tv(varp)
18492 typval_T *varp;
18494 if (varp != NULL)
18496 switch (varp->v_type)
18498 case VAR_FUNC:
18499 func_unref(varp->vval.v_string);
18500 /*FALLTHROUGH*/
18501 case VAR_STRING:
18502 vim_free(varp->vval.v_string);
18503 break;
18504 case VAR_LIST:
18505 list_unref(varp->vval.v_list);
18506 break;
18507 case VAR_DICT:
18508 dict_unref(varp->vval.v_dict);
18509 break;
18510 case VAR_NUMBER:
18511 #ifdef FEAT_FLOAT
18512 case VAR_FLOAT:
18513 #endif
18514 case VAR_UNKNOWN:
18515 break;
18516 default:
18517 EMSG2(_(e_intern2), "free_tv()");
18518 break;
18520 vim_free(varp);
18525 * Free the memory for a variable value and set the value to NULL or 0.
18527 void
18528 clear_tv(varp)
18529 typval_T *varp;
18531 if (varp != NULL)
18533 switch (varp->v_type)
18535 case VAR_FUNC:
18536 func_unref(varp->vval.v_string);
18537 /*FALLTHROUGH*/
18538 case VAR_STRING:
18539 vim_free(varp->vval.v_string);
18540 varp->vval.v_string = NULL;
18541 break;
18542 case VAR_LIST:
18543 list_unref(varp->vval.v_list);
18544 varp->vval.v_list = NULL;
18545 break;
18546 case VAR_DICT:
18547 dict_unref(varp->vval.v_dict);
18548 varp->vval.v_dict = NULL;
18549 break;
18550 case VAR_NUMBER:
18551 varp->vval.v_number = 0;
18552 break;
18553 #ifdef FEAT_FLOAT
18554 case VAR_FLOAT:
18555 varp->vval.v_float = 0.0;
18556 break;
18557 #endif
18558 case VAR_UNKNOWN:
18559 break;
18560 default:
18561 EMSG2(_(e_intern2), "clear_tv()");
18563 varp->v_lock = 0;
18568 * Set the value of a variable to NULL without freeing items.
18570 static void
18571 init_tv(varp)
18572 typval_T *varp;
18574 if (varp != NULL)
18575 vim_memset(varp, 0, sizeof(typval_T));
18579 * Get the number value of a variable.
18580 * If it is a String variable, uses vim_str2nr().
18581 * For incompatible types, return 0.
18582 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18583 * caller of incompatible types: it sets *denote to TRUE if "denote"
18584 * is not NULL or returns -1 otherwise.
18586 static long
18587 get_tv_number(varp)
18588 typval_T *varp;
18590 int error = FALSE;
18592 return get_tv_number_chk(varp, &error); /* return 0L on error */
18595 long
18596 get_tv_number_chk(varp, denote)
18597 typval_T *varp;
18598 int *denote;
18600 long n = 0L;
18602 switch (varp->v_type)
18604 case VAR_NUMBER:
18605 return (long)(varp->vval.v_number);
18606 #ifdef FEAT_FLOAT
18607 case VAR_FLOAT:
18608 EMSG(_("E805: Using a Float as a Number"));
18609 break;
18610 #endif
18611 case VAR_FUNC:
18612 EMSG(_("E703: Using a Funcref as a Number"));
18613 break;
18614 case VAR_STRING:
18615 if (varp->vval.v_string != NULL)
18616 vim_str2nr(varp->vval.v_string, NULL, NULL,
18617 TRUE, TRUE, &n, NULL);
18618 return n;
18619 case VAR_LIST:
18620 EMSG(_("E745: Using a List as a Number"));
18621 break;
18622 case VAR_DICT:
18623 EMSG(_("E728: Using a Dictionary as a Number"));
18624 break;
18625 default:
18626 EMSG2(_(e_intern2), "get_tv_number()");
18627 break;
18629 if (denote == NULL) /* useful for values that must be unsigned */
18630 n = -1;
18631 else
18632 *denote = TRUE;
18633 return n;
18637 * Get the lnum from the first argument.
18638 * Also accepts ".", "$", etc., but that only works for the current buffer.
18639 * Returns -1 on error.
18641 static linenr_T
18642 get_tv_lnum(argvars)
18643 typval_T *argvars;
18645 typval_T rettv;
18646 linenr_T lnum;
18648 lnum = get_tv_number_chk(&argvars[0], NULL);
18649 if (lnum == 0) /* no valid number, try using line() */
18651 rettv.v_type = VAR_NUMBER;
18652 f_line(argvars, &rettv);
18653 lnum = rettv.vval.v_number;
18654 clear_tv(&rettv);
18656 return lnum;
18660 * Get the lnum from the first argument.
18661 * Also accepts "$", then "buf" is used.
18662 * Returns 0 on error.
18664 static linenr_T
18665 get_tv_lnum_buf(argvars, buf)
18666 typval_T *argvars;
18667 buf_T *buf;
18669 if (argvars[0].v_type == VAR_STRING
18670 && argvars[0].vval.v_string != NULL
18671 && argvars[0].vval.v_string[0] == '$'
18672 && buf != NULL)
18673 return buf->b_ml.ml_line_count;
18674 return get_tv_number_chk(&argvars[0], NULL);
18678 * Get the string value of a variable.
18679 * If it is a Number variable, the number is converted into a string.
18680 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18681 * get_tv_string_buf() uses a given buffer.
18682 * If the String variable has never been set, return an empty string.
18683 * Never returns NULL;
18684 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18685 * NULL on error.
18687 static char_u *
18688 get_tv_string(varp)
18689 typval_T *varp;
18691 static char_u mybuf[NUMBUFLEN];
18693 return get_tv_string_buf(varp, mybuf);
18696 static char_u *
18697 get_tv_string_buf(varp, buf)
18698 typval_T *varp;
18699 char_u *buf;
18701 char_u *res = get_tv_string_buf_chk(varp, buf);
18703 return res != NULL ? res : (char_u *)"";
18706 char_u *
18707 get_tv_string_chk(varp)
18708 typval_T *varp;
18710 static char_u mybuf[NUMBUFLEN];
18712 return get_tv_string_buf_chk(varp, mybuf);
18715 static char_u *
18716 get_tv_string_buf_chk(varp, buf)
18717 typval_T *varp;
18718 char_u *buf;
18720 switch (varp->v_type)
18722 case VAR_NUMBER:
18723 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18724 return buf;
18725 case VAR_FUNC:
18726 EMSG(_("E729: using Funcref as a String"));
18727 break;
18728 case VAR_LIST:
18729 EMSG(_("E730: using List as a String"));
18730 break;
18731 case VAR_DICT:
18732 EMSG(_("E731: using Dictionary as a String"));
18733 break;
18734 #ifdef FEAT_FLOAT
18735 case VAR_FLOAT:
18736 EMSG(_("E806: using Float as a String"));
18737 break;
18738 #endif
18739 case VAR_STRING:
18740 if (varp->vval.v_string != NULL)
18741 return varp->vval.v_string;
18742 return (char_u *)"";
18743 default:
18744 EMSG2(_(e_intern2), "get_tv_string_buf()");
18745 break;
18747 return NULL;
18751 * Find variable "name" in the list of variables.
18752 * Return a pointer to it if found, NULL if not found.
18753 * Careful: "a:0" variables don't have a name.
18754 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18755 * hashtab_T used.
18757 static dictitem_T *
18758 find_var(name, htp)
18759 char_u *name;
18760 hashtab_T **htp;
18762 char_u *varname;
18763 hashtab_T *ht;
18765 ht = find_var_ht(name, &varname);
18766 if (htp != NULL)
18767 *htp = ht;
18768 if (ht == NULL)
18769 return NULL;
18770 return find_var_in_ht(ht, varname, htp != NULL);
18774 * Find variable "varname" in hashtab "ht".
18775 * Returns NULL if not found.
18777 static dictitem_T *
18778 find_var_in_ht(ht, varname, writing)
18779 hashtab_T *ht;
18780 char_u *varname;
18781 int writing;
18783 hashitem_T *hi;
18785 if (*varname == NUL)
18787 /* Must be something like "s:", otherwise "ht" would be NULL. */
18788 switch (varname[-2])
18790 case 's': return &SCRIPT_SV(current_SID).sv_var;
18791 case 'g': return &globvars_var;
18792 case 'v': return &vimvars_var;
18793 case 'b': return &curbuf->b_bufvar;
18794 case 'w': return &curwin->w_winvar;
18795 #ifdef FEAT_WINDOWS
18796 case 't': return &curtab->tp_winvar;
18797 #endif
18798 case 'l': return current_funccal == NULL
18799 ? NULL : &current_funccal->l_vars_var;
18800 case 'a': return current_funccal == NULL
18801 ? NULL : &current_funccal->l_avars_var;
18803 return NULL;
18806 hi = hash_find(ht, varname);
18807 if (HASHITEM_EMPTY(hi))
18809 /* For global variables we may try auto-loading the script. If it
18810 * worked find the variable again. Don't auto-load a script if it was
18811 * loaded already, otherwise it would be loaded every time when
18812 * checking if a function name is a Funcref variable. */
18813 if (ht == &globvarht && !writing
18814 && script_autoload(varname, FALSE) && !aborting())
18815 hi = hash_find(ht, varname);
18816 if (HASHITEM_EMPTY(hi))
18817 return NULL;
18819 return HI2DI(hi);
18823 * Find the hashtab used for a variable name.
18824 * Set "varname" to the start of name without ':'.
18826 static hashtab_T *
18827 find_var_ht(name, varname)
18828 char_u *name;
18829 char_u **varname;
18831 hashitem_T *hi;
18833 if (name[1] != ':')
18835 /* The name must not start with a colon or #. */
18836 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
18837 return NULL;
18838 *varname = name;
18840 /* "version" is "v:version" in all scopes */
18841 hi = hash_find(&compat_hashtab, name);
18842 if (!HASHITEM_EMPTY(hi))
18843 return &compat_hashtab;
18845 if (current_funccal == NULL)
18846 return &globvarht; /* global variable */
18847 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
18849 *varname = name + 2;
18850 if (*name == 'g') /* global variable */
18851 return &globvarht;
18852 /* There must be no ':' or '#' in the rest of the name, unless g: is used
18854 if (vim_strchr(name + 2, ':') != NULL
18855 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
18856 return NULL;
18857 if (*name == 'b') /* buffer variable */
18858 return &curbuf->b_vars.dv_hashtab;
18859 if (*name == 'w') /* window variable */
18860 return &curwin->w_vars.dv_hashtab;
18861 #ifdef FEAT_WINDOWS
18862 if (*name == 't') /* tab page variable */
18863 return &curtab->tp_vars.dv_hashtab;
18864 #endif
18865 if (*name == 'v') /* v: variable */
18866 return &vimvarht;
18867 if (*name == 'a' && current_funccal != NULL) /* function argument */
18868 return &current_funccal->l_avars.dv_hashtab;
18869 if (*name == 'l' && current_funccal != NULL) /* local function variable */
18870 return &current_funccal->l_vars.dv_hashtab;
18871 if (*name == 's' /* script variable */
18872 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
18873 return &SCRIPT_VARS(current_SID);
18874 return NULL;
18878 * Get the string value of a (global/local) variable.
18879 * Returns NULL when it doesn't exist.
18881 char_u *
18882 get_var_value(name)
18883 char_u *name;
18885 dictitem_T *v;
18887 v = find_var(name, NULL);
18888 if (v == NULL)
18889 return NULL;
18890 return get_tv_string(&v->di_tv);
18894 * Allocate a new hashtab for a sourced script. It will be used while
18895 * sourcing this script and when executing functions defined in the script.
18897 void
18898 new_script_vars(id)
18899 scid_T id;
18901 int i;
18902 hashtab_T *ht;
18903 scriptvar_T *sv;
18905 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
18907 /* Re-allocating ga_data means that an ht_array pointing to
18908 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
18909 * at its init value. Also reset "v_dict", it's always the same. */
18910 for (i = 1; i <= ga_scripts.ga_len; ++i)
18912 ht = &SCRIPT_VARS(i);
18913 if (ht->ht_mask == HT_INIT_SIZE - 1)
18914 ht->ht_array = ht->ht_smallarray;
18915 sv = &SCRIPT_SV(i);
18916 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
18919 while (ga_scripts.ga_len < id)
18921 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
18922 init_var_dict(&sv->sv_dict, &sv->sv_var);
18923 ++ga_scripts.ga_len;
18929 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
18930 * point to it.
18932 void
18933 init_var_dict(dict, dict_var)
18934 dict_T *dict;
18935 dictitem_T *dict_var;
18937 hash_init(&dict->dv_hashtab);
18938 dict->dv_refcount = DO_NOT_FREE_CNT;
18939 dict->dv_copyID = 0;
18940 dict_var->di_tv.vval.v_dict = dict;
18941 dict_var->di_tv.v_type = VAR_DICT;
18942 dict_var->di_tv.v_lock = VAR_FIXED;
18943 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
18944 dict_var->di_key[0] = NUL;
18948 * Clean up a list of internal variables.
18949 * Frees all allocated variables and the value they contain.
18950 * Clears hashtab "ht", does not free it.
18952 void
18953 vars_clear(ht)
18954 hashtab_T *ht;
18956 vars_clear_ext(ht, TRUE);
18960 * Like vars_clear(), but only free the value if "free_val" is TRUE.
18962 static void
18963 vars_clear_ext(ht, free_val)
18964 hashtab_T *ht;
18965 int free_val;
18967 int todo;
18968 hashitem_T *hi;
18969 dictitem_T *v;
18971 hash_lock(ht);
18972 todo = (int)ht->ht_used;
18973 for (hi = ht->ht_array; todo > 0; ++hi)
18975 if (!HASHITEM_EMPTY(hi))
18977 --todo;
18979 /* Free the variable. Don't remove it from the hashtab,
18980 * ht_array might change then. hash_clear() takes care of it
18981 * later. */
18982 v = HI2DI(hi);
18983 if (free_val)
18984 clear_tv(&v->di_tv);
18985 if ((v->di_flags & DI_FLAGS_FIX) == 0)
18986 vim_free(v);
18989 hash_clear(ht);
18990 ht->ht_used = 0;
18994 * Delete a variable from hashtab "ht" at item "hi".
18995 * Clear the variable value and free the dictitem.
18997 static void
18998 delete_var(ht, hi)
18999 hashtab_T *ht;
19000 hashitem_T *hi;
19002 dictitem_T *di = HI2DI(hi);
19004 hash_remove(ht, hi);
19005 clear_tv(&di->di_tv);
19006 vim_free(di);
19010 * List the value of one internal variable.
19012 static void
19013 list_one_var(v, prefix, first)
19014 dictitem_T *v;
19015 char_u *prefix;
19016 int *first;
19018 char_u *tofree;
19019 char_u *s;
19020 char_u numbuf[NUMBUFLEN];
19022 current_copyID += COPYID_INC;
19023 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19024 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19025 s == NULL ? (char_u *)"" : s, first);
19026 vim_free(tofree);
19029 static void
19030 list_one_var_a(prefix, name, type, string, first)
19031 char_u *prefix;
19032 char_u *name;
19033 int type;
19034 char_u *string;
19035 int *first; /* when TRUE clear rest of screen and set to FALSE */
19037 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19038 msg_start();
19039 msg_puts(prefix);
19040 if (name != NULL) /* "a:" vars don't have a name stored */
19041 msg_puts(name);
19042 msg_putchar(' ');
19043 msg_advance(22);
19044 if (type == VAR_NUMBER)
19045 msg_putchar('#');
19046 else if (type == VAR_FUNC)
19047 msg_putchar('*');
19048 else if (type == VAR_LIST)
19050 msg_putchar('[');
19051 if (*string == '[')
19052 ++string;
19054 else if (type == VAR_DICT)
19056 msg_putchar('{');
19057 if (*string == '{')
19058 ++string;
19060 else
19061 msg_putchar(' ');
19063 msg_outtrans(string);
19065 if (type == VAR_FUNC)
19066 msg_puts((char_u *)"()");
19067 if (*first)
19069 msg_clr_eos();
19070 *first = FALSE;
19075 * Set variable "name" to value in "tv".
19076 * If the variable already exists, the value is updated.
19077 * Otherwise the variable is created.
19079 static void
19080 set_var(name, tv, copy)
19081 char_u *name;
19082 typval_T *tv;
19083 int copy; /* make copy of value in "tv" */
19085 dictitem_T *v;
19086 char_u *varname;
19087 hashtab_T *ht;
19088 char_u *p;
19090 if (tv->v_type == VAR_FUNC)
19092 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19093 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19094 ? name[2] : name[0]))
19096 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19097 return;
19099 if (function_exists(name))
19101 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19102 name);
19103 return;
19107 ht = find_var_ht(name, &varname);
19108 if (ht == NULL || *varname == NUL)
19110 EMSG2(_(e_illvar), name);
19111 return;
19114 v = find_var_in_ht(ht, varname, TRUE);
19115 if (v != NULL)
19117 /* existing variable, need to clear the value */
19118 if (var_check_ro(v->di_flags, name)
19119 || tv_check_lock(v->di_tv.v_lock, name))
19120 return;
19121 if (v->di_tv.v_type != tv->v_type
19122 && !((v->di_tv.v_type == VAR_STRING
19123 || v->di_tv.v_type == VAR_NUMBER)
19124 && (tv->v_type == VAR_STRING
19125 || tv->v_type == VAR_NUMBER))
19126 #ifdef FEAT_FLOAT
19127 && !((v->di_tv.v_type == VAR_NUMBER
19128 || v->di_tv.v_type == VAR_FLOAT)
19129 && (tv->v_type == VAR_NUMBER
19130 || tv->v_type == VAR_FLOAT))
19131 #endif
19134 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19135 return;
19139 * Handle setting internal v: variables separately: we don't change
19140 * the type.
19142 if (ht == &vimvarht)
19144 if (v->di_tv.v_type == VAR_STRING)
19146 vim_free(v->di_tv.vval.v_string);
19147 if (copy || tv->v_type != VAR_STRING)
19148 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19149 else
19151 /* Take over the string to avoid an extra alloc/free. */
19152 v->di_tv.vval.v_string = tv->vval.v_string;
19153 tv->vval.v_string = NULL;
19156 else if (v->di_tv.v_type != VAR_NUMBER)
19157 EMSG2(_(e_intern2), "set_var()");
19158 else
19160 v->di_tv.vval.v_number = get_tv_number(tv);
19161 if (STRCMP(varname, "searchforward") == 0)
19162 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19164 return;
19167 clear_tv(&v->di_tv);
19169 else /* add a new variable */
19171 /* Can't add "v:" variable. */
19172 if (ht == &vimvarht)
19174 EMSG2(_(e_illvar), name);
19175 return;
19178 /* Make sure the variable name is valid. */
19179 for (p = varname; *p != NUL; ++p)
19180 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19181 && *p != AUTOLOAD_CHAR)
19183 EMSG2(_(e_illvar), varname);
19184 return;
19187 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19188 + STRLEN(varname)));
19189 if (v == NULL)
19190 return;
19191 STRCPY(v->di_key, varname);
19192 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19194 vim_free(v);
19195 return;
19197 v->di_flags = 0;
19200 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19201 copy_tv(tv, &v->di_tv);
19202 else
19204 v->di_tv = *tv;
19205 v->di_tv.v_lock = 0;
19206 init_tv(tv);
19211 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19212 * Also give an error message.
19214 static int
19215 var_check_ro(flags, name)
19216 int flags;
19217 char_u *name;
19219 if (flags & DI_FLAGS_RO)
19221 EMSG2(_(e_readonlyvar), name);
19222 return TRUE;
19224 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19226 EMSG2(_(e_readonlysbx), name);
19227 return TRUE;
19229 return FALSE;
19233 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19234 * Also give an error message.
19236 static int
19237 var_check_fixed(flags, name)
19238 int flags;
19239 char_u *name;
19241 if (flags & DI_FLAGS_FIX)
19243 EMSG2(_("E795: Cannot delete variable %s"), name);
19244 return TRUE;
19246 return FALSE;
19250 * Return TRUE if typeval "tv" is set to be locked (immutable).
19251 * Also give an error message, using "name".
19253 static int
19254 tv_check_lock(lock, name)
19255 int lock;
19256 char_u *name;
19258 if (lock & VAR_LOCKED)
19260 EMSG2(_("E741: Value is locked: %s"),
19261 name == NULL ? (char_u *)_("Unknown") : name);
19262 return TRUE;
19264 if (lock & VAR_FIXED)
19266 EMSG2(_("E742: Cannot change value of %s"),
19267 name == NULL ? (char_u *)_("Unknown") : name);
19268 return TRUE;
19270 return FALSE;
19274 * Copy the values from typval_T "from" to typval_T "to".
19275 * When needed allocates string or increases reference count.
19276 * Does not make a copy of a list or dict but copies the reference!
19277 * It is OK for "from" and "to" to point to the same item. This is used to
19278 * make a copy later.
19280 static void
19281 copy_tv(from, to)
19282 typval_T *from;
19283 typval_T *to;
19285 to->v_type = from->v_type;
19286 to->v_lock = 0;
19287 switch (from->v_type)
19289 case VAR_NUMBER:
19290 to->vval.v_number = from->vval.v_number;
19291 break;
19292 #ifdef FEAT_FLOAT
19293 case VAR_FLOAT:
19294 to->vval.v_float = from->vval.v_float;
19295 break;
19296 #endif
19297 case VAR_STRING:
19298 case VAR_FUNC:
19299 if (from->vval.v_string == NULL)
19300 to->vval.v_string = NULL;
19301 else
19303 to->vval.v_string = vim_strsave(from->vval.v_string);
19304 if (from->v_type == VAR_FUNC)
19305 func_ref(to->vval.v_string);
19307 break;
19308 case VAR_LIST:
19309 if (from->vval.v_list == NULL)
19310 to->vval.v_list = NULL;
19311 else
19313 to->vval.v_list = from->vval.v_list;
19314 ++to->vval.v_list->lv_refcount;
19316 break;
19317 case VAR_DICT:
19318 if (from->vval.v_dict == NULL)
19319 to->vval.v_dict = NULL;
19320 else
19322 to->vval.v_dict = from->vval.v_dict;
19323 ++to->vval.v_dict->dv_refcount;
19325 break;
19326 default:
19327 EMSG2(_(e_intern2), "copy_tv()");
19328 break;
19333 * Make a copy of an item.
19334 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19335 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19336 * reference to an already copied list/dict can be used.
19337 * Returns FAIL or OK.
19339 static int
19340 item_copy(from, to, deep, copyID)
19341 typval_T *from;
19342 typval_T *to;
19343 int deep;
19344 int copyID;
19346 static int recurse = 0;
19347 int ret = OK;
19349 if (recurse >= DICT_MAXNEST)
19351 EMSG(_("E698: variable nested too deep for making a copy"));
19352 return FAIL;
19354 ++recurse;
19356 switch (from->v_type)
19358 case VAR_NUMBER:
19359 #ifdef FEAT_FLOAT
19360 case VAR_FLOAT:
19361 #endif
19362 case VAR_STRING:
19363 case VAR_FUNC:
19364 copy_tv(from, to);
19365 break;
19366 case VAR_LIST:
19367 to->v_type = VAR_LIST;
19368 to->v_lock = 0;
19369 if (from->vval.v_list == NULL)
19370 to->vval.v_list = NULL;
19371 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19373 /* use the copy made earlier */
19374 to->vval.v_list = from->vval.v_list->lv_copylist;
19375 ++to->vval.v_list->lv_refcount;
19377 else
19378 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19379 if (to->vval.v_list == NULL)
19380 ret = FAIL;
19381 break;
19382 case VAR_DICT:
19383 to->v_type = VAR_DICT;
19384 to->v_lock = 0;
19385 if (from->vval.v_dict == NULL)
19386 to->vval.v_dict = NULL;
19387 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19389 /* use the copy made earlier */
19390 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19391 ++to->vval.v_dict->dv_refcount;
19393 else
19394 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19395 if (to->vval.v_dict == NULL)
19396 ret = FAIL;
19397 break;
19398 default:
19399 EMSG2(_(e_intern2), "item_copy()");
19400 ret = FAIL;
19402 --recurse;
19403 return ret;
19407 * ":echo expr1 ..." print each argument separated with a space, add a
19408 * newline at the end.
19409 * ":echon expr1 ..." print each argument plain.
19411 void
19412 ex_echo(eap)
19413 exarg_T *eap;
19415 char_u *arg = eap->arg;
19416 typval_T rettv;
19417 char_u *tofree;
19418 char_u *p;
19419 int needclr = TRUE;
19420 int atstart = TRUE;
19421 char_u numbuf[NUMBUFLEN];
19423 if (eap->skip)
19424 ++emsg_skip;
19425 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19427 /* If eval1() causes an error message the text from the command may
19428 * still need to be cleared. E.g., "echo 22,44". */
19429 need_clr_eos = needclr;
19431 p = arg;
19432 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19435 * Report the invalid expression unless the expression evaluation
19436 * has been cancelled due to an aborting error, an interrupt, or an
19437 * exception.
19439 if (!aborting())
19440 EMSG2(_(e_invexpr2), p);
19441 need_clr_eos = FALSE;
19442 break;
19444 need_clr_eos = FALSE;
19446 if (!eap->skip)
19448 if (atstart)
19450 atstart = FALSE;
19451 /* Call msg_start() after eval1(), evaluating the expression
19452 * may cause a message to appear. */
19453 if (eap->cmdidx == CMD_echo)
19454 msg_start();
19456 else if (eap->cmdidx == CMD_echo)
19457 msg_puts_attr((char_u *)" ", echo_attr);
19458 current_copyID += COPYID_INC;
19459 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19460 if (p != NULL)
19461 for ( ; *p != NUL && !got_int; ++p)
19463 if (*p == '\n' || *p == '\r' || *p == TAB)
19465 if (*p != TAB && needclr)
19467 /* remove any text still there from the command */
19468 msg_clr_eos();
19469 needclr = FALSE;
19471 msg_putchar_attr(*p, echo_attr);
19473 else
19475 #ifdef FEAT_MBYTE
19476 if (has_mbyte)
19478 int i = (*mb_ptr2len)(p);
19480 (void)msg_outtrans_len_attr(p, i, echo_attr);
19481 p += i - 1;
19483 else
19484 #endif
19485 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19488 vim_free(tofree);
19490 clear_tv(&rettv);
19491 arg = skipwhite(arg);
19493 eap->nextcmd = check_nextcmd(arg);
19495 if (eap->skip)
19496 --emsg_skip;
19497 else
19499 /* remove text that may still be there from the command */
19500 if (needclr)
19501 msg_clr_eos();
19502 if (eap->cmdidx == CMD_echo)
19503 msg_end();
19508 * ":echohl {name}".
19510 void
19511 ex_echohl(eap)
19512 exarg_T *eap;
19514 int id;
19516 id = syn_name2id(eap->arg);
19517 if (id == 0)
19518 echo_attr = 0;
19519 else
19520 echo_attr = syn_id2attr(id);
19524 * ":execute expr1 ..." execute the result of an expression.
19525 * ":echomsg expr1 ..." Print a message
19526 * ":echoerr expr1 ..." Print an error
19527 * Each gets spaces around each argument and a newline at the end for
19528 * echo commands
19530 void
19531 ex_execute(eap)
19532 exarg_T *eap;
19534 char_u *arg = eap->arg;
19535 typval_T rettv;
19536 int ret = OK;
19537 char_u *p;
19538 garray_T ga;
19539 int len;
19540 int save_did_emsg;
19542 ga_init2(&ga, 1, 80);
19544 if (eap->skip)
19545 ++emsg_skip;
19546 while (*arg != NUL && *arg != '|' && *arg != '\n')
19548 p = arg;
19549 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19552 * Report the invalid expression unless the expression evaluation
19553 * has been cancelled due to an aborting error, an interrupt, or an
19554 * exception.
19556 if (!aborting())
19557 EMSG2(_(e_invexpr2), p);
19558 ret = FAIL;
19559 break;
19562 if (!eap->skip)
19564 p = get_tv_string(&rettv);
19565 len = (int)STRLEN(p);
19566 if (ga_grow(&ga, len + 2) == FAIL)
19568 clear_tv(&rettv);
19569 ret = FAIL;
19570 break;
19572 if (ga.ga_len)
19573 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19574 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19575 ga.ga_len += len;
19578 clear_tv(&rettv);
19579 arg = skipwhite(arg);
19582 if (ret != FAIL && ga.ga_data != NULL)
19584 if (eap->cmdidx == CMD_echomsg)
19586 MSG_ATTR(ga.ga_data, echo_attr);
19587 out_flush();
19589 else if (eap->cmdidx == CMD_echoerr)
19591 /* We don't want to abort following commands, restore did_emsg. */
19592 save_did_emsg = did_emsg;
19593 EMSG((char_u *)ga.ga_data);
19594 if (!force_abort)
19595 did_emsg = save_did_emsg;
19597 else if (eap->cmdidx == CMD_execute)
19598 do_cmdline((char_u *)ga.ga_data,
19599 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19602 ga_clear(&ga);
19604 if (eap->skip)
19605 --emsg_skip;
19607 eap->nextcmd = check_nextcmd(arg);
19611 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19612 * "arg" points to the "&" or '+' when called, to "option" when returning.
19613 * Returns NULL when no option name found. Otherwise pointer to the char
19614 * after the option name.
19616 static char_u *
19617 find_option_end(arg, opt_flags)
19618 char_u **arg;
19619 int *opt_flags;
19621 char_u *p = *arg;
19623 ++p;
19624 if (*p == 'g' && p[1] == ':')
19626 *opt_flags = OPT_GLOBAL;
19627 p += 2;
19629 else if (*p == 'l' && p[1] == ':')
19631 *opt_flags = OPT_LOCAL;
19632 p += 2;
19634 else
19635 *opt_flags = 0;
19637 if (!ASCII_ISALPHA(*p))
19638 return NULL;
19639 *arg = p;
19641 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19642 p += 4; /* termcap option */
19643 else
19644 while (ASCII_ISALPHA(*p))
19645 ++p;
19646 return p;
19650 * ":function"
19652 void
19653 ex_function(eap)
19654 exarg_T *eap;
19656 char_u *theline;
19657 int j;
19658 int c;
19659 int saved_did_emsg;
19660 char_u *name = NULL;
19661 char_u *p;
19662 char_u *arg;
19663 char_u *line_arg = NULL;
19664 garray_T newargs;
19665 garray_T newlines;
19666 int varargs = FALSE;
19667 int mustend = FALSE;
19668 int flags = 0;
19669 ufunc_T *fp;
19670 int indent;
19671 int nesting;
19672 char_u *skip_until = NULL;
19673 dictitem_T *v;
19674 funcdict_T fudi;
19675 static int func_nr = 0; /* number for nameless function */
19676 int paren;
19677 hashtab_T *ht;
19678 int todo;
19679 hashitem_T *hi;
19680 int sourcing_lnum_off;
19683 * ":function" without argument: list functions.
19685 if (ends_excmd(*eap->arg))
19687 if (!eap->skip)
19689 todo = (int)func_hashtab.ht_used;
19690 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19692 if (!HASHITEM_EMPTY(hi))
19694 --todo;
19695 fp = HI2UF(hi);
19696 if (!isdigit(*fp->uf_name))
19697 list_func_head(fp, FALSE);
19701 eap->nextcmd = check_nextcmd(eap->arg);
19702 return;
19706 * ":function /pat": list functions matching pattern.
19708 if (*eap->arg == '/')
19710 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19711 if (!eap->skip)
19713 regmatch_T regmatch;
19715 c = *p;
19716 *p = NUL;
19717 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19718 *p = c;
19719 if (regmatch.regprog != NULL)
19721 regmatch.rm_ic = p_ic;
19723 todo = (int)func_hashtab.ht_used;
19724 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19726 if (!HASHITEM_EMPTY(hi))
19728 --todo;
19729 fp = HI2UF(hi);
19730 if (!isdigit(*fp->uf_name)
19731 && vim_regexec(&regmatch, fp->uf_name, 0))
19732 list_func_head(fp, FALSE);
19735 vim_free(regmatch.regprog);
19738 if (*p == '/')
19739 ++p;
19740 eap->nextcmd = check_nextcmd(p);
19741 return;
19745 * Get the function name. There are these situations:
19746 * func normal function name
19747 * "name" == func, "fudi.fd_dict" == NULL
19748 * dict.func new dictionary entry
19749 * "name" == NULL, "fudi.fd_dict" set,
19750 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19751 * dict.func existing dict entry with a Funcref
19752 * "name" == func, "fudi.fd_dict" set,
19753 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19754 * dict.func existing dict entry that's not a Funcref
19755 * "name" == NULL, "fudi.fd_dict" set,
19756 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19758 p = eap->arg;
19759 name = trans_function_name(&p, eap->skip, 0, &fudi);
19760 paren = (vim_strchr(p, '(') != NULL);
19761 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19764 * Return on an invalid expression in braces, unless the expression
19765 * evaluation has been cancelled due to an aborting error, an
19766 * interrupt, or an exception.
19768 if (!aborting())
19770 if (!eap->skip && fudi.fd_newkey != NULL)
19771 EMSG2(_(e_dictkey), fudi.fd_newkey);
19772 vim_free(fudi.fd_newkey);
19773 return;
19775 else
19776 eap->skip = TRUE;
19779 /* An error in a function call during evaluation of an expression in magic
19780 * braces should not cause the function not to be defined. */
19781 saved_did_emsg = did_emsg;
19782 did_emsg = FALSE;
19785 * ":function func" with only function name: list function.
19787 if (!paren)
19789 if (!ends_excmd(*skipwhite(p)))
19791 EMSG(_(e_trailing));
19792 goto ret_free;
19794 eap->nextcmd = check_nextcmd(p);
19795 if (eap->nextcmd != NULL)
19796 *p = NUL;
19797 if (!eap->skip && !got_int)
19799 fp = find_func(name);
19800 if (fp != NULL)
19802 list_func_head(fp, TRUE);
19803 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19805 if (FUNCLINE(fp, j) == NULL)
19806 continue;
19807 msg_putchar('\n');
19808 msg_outnum((long)(j + 1));
19809 if (j < 9)
19810 msg_putchar(' ');
19811 if (j < 99)
19812 msg_putchar(' ');
19813 msg_prt_line(FUNCLINE(fp, j), FALSE);
19814 out_flush(); /* show a line at a time */
19815 ui_breakcheck();
19817 if (!got_int)
19819 msg_putchar('\n');
19820 msg_puts((char_u *)" endfunction");
19823 else
19824 emsg_funcname(N_("E123: Undefined function: %s"), name);
19826 goto ret_free;
19830 * ":function name(arg1, arg2)" Define function.
19832 p = skipwhite(p);
19833 if (*p != '(')
19835 if (!eap->skip)
19837 EMSG2(_("E124: Missing '(': %s"), eap->arg);
19838 goto ret_free;
19840 /* attempt to continue by skipping some text */
19841 if (vim_strchr(p, '(') != NULL)
19842 p = vim_strchr(p, '(');
19844 p = skipwhite(p + 1);
19846 ga_init2(&newargs, (int)sizeof(char_u *), 3);
19847 ga_init2(&newlines, (int)sizeof(char_u *), 3);
19849 if (!eap->skip)
19851 /* Check the name of the function. Unless it's a dictionary function
19852 * (that we are overwriting). */
19853 if (name != NULL)
19854 arg = name;
19855 else
19856 arg = fudi.fd_newkey;
19857 if (arg != NULL && (fudi.fd_di == NULL
19858 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
19860 if (*arg == K_SPECIAL)
19861 j = 3;
19862 else
19863 j = 0;
19864 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
19865 : eval_isnamec(arg[j])))
19866 ++j;
19867 if (arg[j] != NUL)
19868 emsg_funcname((char *)e_invarg2, arg);
19873 * Isolate the arguments: "arg1, arg2, ...)"
19875 while (*p != ')')
19877 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
19879 varargs = TRUE;
19880 p += 3;
19881 mustend = TRUE;
19883 else
19885 arg = p;
19886 while (ASCII_ISALNUM(*p) || *p == '_')
19887 ++p;
19888 if (arg == p || isdigit(*arg)
19889 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
19890 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
19892 if (!eap->skip)
19893 EMSG2(_("E125: Illegal argument: %s"), arg);
19894 break;
19896 if (ga_grow(&newargs, 1) == FAIL)
19897 goto erret;
19898 c = *p;
19899 *p = NUL;
19900 arg = vim_strsave(arg);
19901 if (arg == NULL)
19902 goto erret;
19903 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
19904 *p = c;
19905 newargs.ga_len++;
19906 if (*p == ',')
19907 ++p;
19908 else
19909 mustend = TRUE;
19911 p = skipwhite(p);
19912 if (mustend && *p != ')')
19914 if (!eap->skip)
19915 EMSG2(_(e_invarg2), eap->arg);
19916 break;
19919 ++p; /* skip the ')' */
19921 /* find extra arguments "range", "dict" and "abort" */
19922 for (;;)
19924 p = skipwhite(p);
19925 if (STRNCMP(p, "range", 5) == 0)
19927 flags |= FC_RANGE;
19928 p += 5;
19930 else if (STRNCMP(p, "dict", 4) == 0)
19932 flags |= FC_DICT;
19933 p += 4;
19935 else if (STRNCMP(p, "abort", 5) == 0)
19937 flags |= FC_ABORT;
19938 p += 5;
19940 else
19941 break;
19944 /* When there is a line break use what follows for the function body.
19945 * Makes 'exe "func Test()\n...\nendfunc"' work. */
19946 if (*p == '\n')
19947 line_arg = p + 1;
19948 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
19949 EMSG(_(e_trailing));
19952 * Read the body of the function, until ":endfunction" is found.
19954 if (KeyTyped)
19956 /* Check if the function already exists, don't let the user type the
19957 * whole function before telling him it doesn't work! For a script we
19958 * need to skip the body to be able to find what follows. */
19959 if (!eap->skip && !eap->forceit)
19961 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
19962 EMSG(_(e_funcdict));
19963 else if (name != NULL && find_func(name) != NULL)
19964 emsg_funcname(e_funcexts, name);
19967 if (!eap->skip && did_emsg)
19968 goto erret;
19970 msg_putchar('\n'); /* don't overwrite the function name */
19971 cmdline_row = msg_row;
19974 indent = 2;
19975 nesting = 0;
19976 for (;;)
19978 msg_scroll = TRUE;
19979 need_wait_return = FALSE;
19980 sourcing_lnum_off = sourcing_lnum;
19982 if (line_arg != NULL)
19984 /* Use eap->arg, split up in parts by line breaks. */
19985 theline = line_arg;
19986 p = vim_strchr(theline, '\n');
19987 if (p == NULL)
19988 line_arg += STRLEN(line_arg);
19989 else
19991 *p = NUL;
19992 line_arg = p + 1;
19995 else if (eap->getline == NULL)
19996 theline = getcmdline(':', 0L, indent);
19997 else
19998 theline = eap->getline(':', eap->cookie, indent);
19999 if (KeyTyped)
20000 lines_left = Rows - 1;
20001 if (theline == NULL)
20003 EMSG(_("E126: Missing :endfunction"));
20004 goto erret;
20007 /* Detect line continuation: sourcing_lnum increased more than one. */
20008 if (sourcing_lnum > sourcing_lnum_off + 1)
20009 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20010 else
20011 sourcing_lnum_off = 0;
20013 if (skip_until != NULL)
20015 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20016 * don't check for ":endfunc". */
20017 if (STRCMP(theline, skip_until) == 0)
20019 vim_free(skip_until);
20020 skip_until = NULL;
20023 else
20025 /* skip ':' and blanks*/
20026 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20029 /* Check for "endfunction". */
20030 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20032 if (line_arg == NULL)
20033 vim_free(theline);
20034 break;
20037 /* Increase indent inside "if", "while", "for" and "try", decrease
20038 * at "end". */
20039 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20040 indent -= 2;
20041 else if (STRNCMP(p, "if", 2) == 0
20042 || STRNCMP(p, "wh", 2) == 0
20043 || STRNCMP(p, "for", 3) == 0
20044 || STRNCMP(p, "try", 3) == 0)
20045 indent += 2;
20047 /* Check for defining a function inside this function. */
20048 if (checkforcmd(&p, "function", 2))
20050 if (*p == '!')
20051 p = skipwhite(p + 1);
20052 p += eval_fname_script(p);
20053 if (ASCII_ISALPHA(*p))
20055 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20056 if (*skipwhite(p) == '(')
20058 ++nesting;
20059 indent += 2;
20064 /* Check for ":append" or ":insert". */
20065 p = skip_range(p, NULL);
20066 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20067 || (p[0] == 'i'
20068 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20069 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20070 skip_until = vim_strsave((char_u *)".");
20072 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20073 arg = skipwhite(skiptowhite(p));
20074 if (arg[0] == '<' && arg[1] =='<'
20075 && ((p[0] == 'p' && p[1] == 'y'
20076 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20077 || (p[0] == 'p' && p[1] == 'e'
20078 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20079 || (p[0] == 't' && p[1] == 'c'
20080 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20081 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20082 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20083 || (p[0] == 'm' && p[1] == 'z'
20084 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20087 /* ":python <<" continues until a dot, like ":append" */
20088 p = skipwhite(arg + 2);
20089 if (*p == NUL)
20090 skip_until = vim_strsave((char_u *)".");
20091 else
20092 skip_until = vim_strsave(p);
20096 /* Add the line to the function. */
20097 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20099 if (line_arg == NULL)
20100 vim_free(theline);
20101 goto erret;
20104 /* Copy the line to newly allocated memory. get_one_sourceline()
20105 * allocates 250 bytes per line, this saves 80% on average. The cost
20106 * is an extra alloc/free. */
20107 p = vim_strsave(theline);
20108 if (p != NULL)
20110 if (line_arg == NULL)
20111 vim_free(theline);
20112 theline = p;
20115 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20117 /* Add NULL lines for continuation lines, so that the line count is
20118 * equal to the index in the growarray. */
20119 while (sourcing_lnum_off-- > 0)
20120 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20122 /* Check for end of eap->arg. */
20123 if (line_arg != NULL && *line_arg == NUL)
20124 line_arg = NULL;
20127 /* Don't define the function when skipping commands or when an error was
20128 * detected. */
20129 if (eap->skip || did_emsg)
20130 goto erret;
20133 * If there are no errors, add the function
20135 if (fudi.fd_dict == NULL)
20137 v = find_var(name, &ht);
20138 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20140 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20141 name);
20142 goto erret;
20145 fp = find_func(name);
20146 if (fp != NULL)
20148 if (!eap->forceit)
20150 emsg_funcname(e_funcexts, name);
20151 goto erret;
20153 if (fp->uf_calls > 0)
20155 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20156 name);
20157 goto erret;
20159 /* redefine existing function */
20160 ga_clear_strings(&(fp->uf_args));
20161 ga_clear_strings(&(fp->uf_lines));
20162 vim_free(name);
20163 name = NULL;
20166 else
20168 char numbuf[20];
20170 fp = NULL;
20171 if (fudi.fd_newkey == NULL && !eap->forceit)
20173 EMSG(_(e_funcdict));
20174 goto erret;
20176 if (fudi.fd_di == NULL)
20178 /* Can't add a function to a locked dictionary */
20179 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20180 goto erret;
20182 /* Can't change an existing function if it is locked */
20183 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20184 goto erret;
20186 /* Give the function a sequential number. Can only be used with a
20187 * Funcref! */
20188 vim_free(name);
20189 sprintf(numbuf, "%d", ++func_nr);
20190 name = vim_strsave((char_u *)numbuf);
20191 if (name == NULL)
20192 goto erret;
20195 if (fp == NULL)
20197 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20199 int slen, plen;
20200 char_u *scriptname;
20202 /* Check that the autoload name matches the script name. */
20203 j = FAIL;
20204 if (sourcing_name != NULL)
20206 scriptname = autoload_name(name);
20207 if (scriptname != NULL)
20209 p = vim_strchr(scriptname, '/');
20210 plen = (int)STRLEN(p);
20211 slen = (int)STRLEN(sourcing_name);
20212 if (slen > plen && fnamecmp(p,
20213 sourcing_name + slen - plen) == 0)
20214 j = OK;
20215 vim_free(scriptname);
20218 if (j == FAIL)
20220 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20221 goto erret;
20225 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20226 if (fp == NULL)
20227 goto erret;
20229 if (fudi.fd_dict != NULL)
20231 if (fudi.fd_di == NULL)
20233 /* add new dict entry */
20234 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20235 if (fudi.fd_di == NULL)
20237 vim_free(fp);
20238 goto erret;
20240 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20242 vim_free(fudi.fd_di);
20243 vim_free(fp);
20244 goto erret;
20247 else
20248 /* overwrite existing dict entry */
20249 clear_tv(&fudi.fd_di->di_tv);
20250 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20251 fudi.fd_di->di_tv.v_lock = 0;
20252 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20253 fp->uf_refcount = 1;
20255 /* behave like "dict" was used */
20256 flags |= FC_DICT;
20259 /* insert the new function in the function list */
20260 STRCPY(fp->uf_name, name);
20261 hash_add(&func_hashtab, UF2HIKEY(fp));
20263 fp->uf_args = newargs;
20264 fp->uf_lines = newlines;
20265 #ifdef FEAT_PROFILE
20266 fp->uf_tml_count = NULL;
20267 fp->uf_tml_total = NULL;
20268 fp->uf_tml_self = NULL;
20269 fp->uf_profiling = FALSE;
20270 if (prof_def_func())
20271 func_do_profile(fp);
20272 #endif
20273 fp->uf_varargs = varargs;
20274 fp->uf_flags = flags;
20275 fp->uf_calls = 0;
20276 fp->uf_script_ID = current_SID;
20277 goto ret_free;
20279 erret:
20280 ga_clear_strings(&newargs);
20281 ga_clear_strings(&newlines);
20282 ret_free:
20283 vim_free(skip_until);
20284 vim_free(fudi.fd_newkey);
20285 vim_free(name);
20286 did_emsg |= saved_did_emsg;
20290 * Get a function name, translating "<SID>" and "<SNR>".
20291 * Also handles a Funcref in a List or Dictionary.
20292 * Returns the function name in allocated memory, or NULL for failure.
20293 * flags:
20294 * TFN_INT: internal function name OK
20295 * TFN_QUIET: be quiet
20296 * Advances "pp" to just after the function name (if no error).
20298 static char_u *
20299 trans_function_name(pp, skip, flags, fdp)
20300 char_u **pp;
20301 int skip; /* only find the end, don't evaluate */
20302 int flags;
20303 funcdict_T *fdp; /* return: info about dictionary used */
20305 char_u *name = NULL;
20306 char_u *start;
20307 char_u *end;
20308 int lead;
20309 char_u sid_buf[20];
20310 int len;
20311 lval_T lv;
20313 if (fdp != NULL)
20314 vim_memset(fdp, 0, sizeof(funcdict_T));
20315 start = *pp;
20317 /* Check for hard coded <SNR>: already translated function ID (from a user
20318 * command). */
20319 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20320 && (*pp)[2] == (int)KE_SNR)
20322 *pp += 3;
20323 len = get_id_len(pp) + 3;
20324 return vim_strnsave(start, len);
20327 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20328 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20329 lead = eval_fname_script(start);
20330 if (lead > 2)
20331 start += lead;
20333 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20334 lead > 2 ? 0 : FNE_CHECK_START);
20335 if (end == start)
20337 if (!skip)
20338 EMSG(_("E129: Function name required"));
20339 goto theend;
20341 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20344 * Report an invalid expression in braces, unless the expression
20345 * evaluation has been cancelled due to an aborting error, an
20346 * interrupt, or an exception.
20348 if (!aborting())
20350 if (end != NULL)
20351 EMSG2(_(e_invarg2), start);
20353 else
20354 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20355 goto theend;
20358 if (lv.ll_tv != NULL)
20360 if (fdp != NULL)
20362 fdp->fd_dict = lv.ll_dict;
20363 fdp->fd_newkey = lv.ll_newkey;
20364 lv.ll_newkey = NULL;
20365 fdp->fd_di = lv.ll_di;
20367 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20369 name = vim_strsave(lv.ll_tv->vval.v_string);
20370 *pp = end;
20372 else
20374 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20375 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20376 EMSG(_(e_funcref));
20377 else
20378 *pp = end;
20379 name = NULL;
20381 goto theend;
20384 if (lv.ll_name == NULL)
20386 /* Error found, but continue after the function name. */
20387 *pp = end;
20388 goto theend;
20391 /* Check if the name is a Funcref. If so, use the value. */
20392 if (lv.ll_exp_name != NULL)
20394 len = (int)STRLEN(lv.ll_exp_name);
20395 name = deref_func_name(lv.ll_exp_name, &len);
20396 if (name == lv.ll_exp_name)
20397 name = NULL;
20399 else
20401 len = (int)(end - *pp);
20402 name = deref_func_name(*pp, &len);
20403 if (name == *pp)
20404 name = NULL;
20406 if (name != NULL)
20408 name = vim_strsave(name);
20409 *pp = end;
20410 goto theend;
20413 if (lv.ll_exp_name != NULL)
20415 len = (int)STRLEN(lv.ll_exp_name);
20416 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20417 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20419 /* When there was "s:" already or the name expanded to get a
20420 * leading "s:" then remove it. */
20421 lv.ll_name += 2;
20422 len -= 2;
20423 lead = 2;
20426 else
20428 if (lead == 2) /* skip over "s:" */
20429 lv.ll_name += 2;
20430 len = (int)(end - lv.ll_name);
20434 * Copy the function name to allocated memory.
20435 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20436 * Accept <SNR>123_name() outside a script.
20438 if (skip)
20439 lead = 0; /* do nothing */
20440 else if (lead > 0)
20442 lead = 3;
20443 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20444 || eval_fname_sid(*pp))
20446 /* It's "s:" or "<SID>" */
20447 if (current_SID <= 0)
20449 EMSG(_(e_usingsid));
20450 goto theend;
20452 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20453 lead += (int)STRLEN(sid_buf);
20456 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20458 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20459 goto theend;
20461 name = alloc((unsigned)(len + lead + 1));
20462 if (name != NULL)
20464 if (lead > 0)
20466 name[0] = K_SPECIAL;
20467 name[1] = KS_EXTRA;
20468 name[2] = (int)KE_SNR;
20469 if (lead > 3) /* If it's "<SID>" */
20470 STRCPY(name + 3, sid_buf);
20472 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20473 name[len + lead] = NUL;
20475 *pp = end;
20477 theend:
20478 clear_lval(&lv);
20479 return name;
20483 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20484 * Return 2 if "p" starts with "s:".
20485 * Return 0 otherwise.
20487 static int
20488 eval_fname_script(p)
20489 char_u *p;
20491 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20492 || STRNICMP(p + 1, "SNR>", 4) == 0))
20493 return 5;
20494 if (p[0] == 's' && p[1] == ':')
20495 return 2;
20496 return 0;
20500 * Return TRUE if "p" starts with "<SID>" or "s:".
20501 * Only works if eval_fname_script() returned non-zero for "p"!
20503 static int
20504 eval_fname_sid(p)
20505 char_u *p;
20507 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20511 * List the head of the function: "name(arg1, arg2)".
20513 static void
20514 list_func_head(fp, indent)
20515 ufunc_T *fp;
20516 int indent;
20518 int j;
20520 msg_start();
20521 if (indent)
20522 MSG_PUTS(" ");
20523 MSG_PUTS("function ");
20524 if (fp->uf_name[0] == K_SPECIAL)
20526 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20527 msg_puts(fp->uf_name + 3);
20529 else
20530 msg_puts(fp->uf_name);
20531 msg_putchar('(');
20532 for (j = 0; j < fp->uf_args.ga_len; ++j)
20534 if (j)
20535 MSG_PUTS(", ");
20536 msg_puts(FUNCARG(fp, j));
20538 if (fp->uf_varargs)
20540 if (j)
20541 MSG_PUTS(", ");
20542 MSG_PUTS("...");
20544 msg_putchar(')');
20545 msg_clr_eos();
20546 if (p_verbose > 0)
20547 last_set_msg(fp->uf_script_ID);
20551 * Find a function by name, return pointer to it in ufuncs.
20552 * Return NULL for unknown function.
20554 static ufunc_T *
20555 find_func(name)
20556 char_u *name;
20558 hashitem_T *hi;
20560 hi = hash_find(&func_hashtab, name);
20561 if (!HASHITEM_EMPTY(hi))
20562 return HI2UF(hi);
20563 return NULL;
20566 #if defined(EXITFREE) || defined(PROTO)
20567 void
20568 free_all_functions()
20570 hashitem_T *hi;
20572 /* Need to start all over every time, because func_free() may change the
20573 * hash table. */
20574 while (func_hashtab.ht_used > 0)
20575 for (hi = func_hashtab.ht_array; ; ++hi)
20576 if (!HASHITEM_EMPTY(hi))
20578 func_free(HI2UF(hi));
20579 break;
20582 #endif
20585 * Return TRUE if a function "name" exists.
20587 static int
20588 function_exists(name)
20589 char_u *name;
20591 char_u *nm = name;
20592 char_u *p;
20593 int n = FALSE;
20595 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20596 nm = skipwhite(nm);
20598 /* Only accept "funcname", "funcname ", "funcname (..." and
20599 * "funcname(...", not "funcname!...". */
20600 if (p != NULL && (*nm == NUL || *nm == '('))
20602 if (builtin_function(p))
20603 n = (find_internal_func(p) >= 0);
20604 else
20605 n = (find_func(p) != NULL);
20607 vim_free(p);
20608 return n;
20612 * Return TRUE if "name" looks like a builtin function name: starts with a
20613 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20615 static int
20616 builtin_function(name)
20617 char_u *name;
20619 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20620 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20623 #if defined(FEAT_PROFILE) || defined(PROTO)
20625 * Start profiling function "fp".
20627 static void
20628 func_do_profile(fp)
20629 ufunc_T *fp;
20631 fp->uf_tm_count = 0;
20632 profile_zero(&fp->uf_tm_self);
20633 profile_zero(&fp->uf_tm_total);
20634 if (fp->uf_tml_count == NULL)
20635 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20636 (sizeof(int) * fp->uf_lines.ga_len));
20637 if (fp->uf_tml_total == NULL)
20638 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20639 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20640 if (fp->uf_tml_self == NULL)
20641 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20642 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20643 fp->uf_tml_idx = -1;
20644 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20645 || fp->uf_tml_self == NULL)
20646 return; /* out of memory */
20648 fp->uf_profiling = TRUE;
20652 * Dump the profiling results for all functions in file "fd".
20654 void
20655 func_dump_profile(fd)
20656 FILE *fd;
20658 hashitem_T *hi;
20659 int todo;
20660 ufunc_T *fp;
20661 int i;
20662 ufunc_T **sorttab;
20663 int st_len = 0;
20665 todo = (int)func_hashtab.ht_used;
20666 if (todo == 0)
20667 return; /* nothing to dump */
20669 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20671 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20673 if (!HASHITEM_EMPTY(hi))
20675 --todo;
20676 fp = HI2UF(hi);
20677 if (fp->uf_profiling)
20679 if (sorttab != NULL)
20680 sorttab[st_len++] = fp;
20682 if (fp->uf_name[0] == K_SPECIAL)
20683 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20684 else
20685 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20686 if (fp->uf_tm_count == 1)
20687 fprintf(fd, "Called 1 time\n");
20688 else
20689 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20690 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20691 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20692 fprintf(fd, "\n");
20693 fprintf(fd, "count total (s) self (s)\n");
20695 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20697 if (FUNCLINE(fp, i) == NULL)
20698 continue;
20699 prof_func_line(fd, fp->uf_tml_count[i],
20700 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20701 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20703 fprintf(fd, "\n");
20708 if (sorttab != NULL && st_len > 0)
20710 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20711 prof_total_cmp);
20712 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20713 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20714 prof_self_cmp);
20715 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20718 vim_free(sorttab);
20721 static void
20722 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20723 FILE *fd;
20724 ufunc_T **sorttab;
20725 int st_len;
20726 char *title;
20727 int prefer_self; /* when equal print only self time */
20729 int i;
20730 ufunc_T *fp;
20732 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20733 fprintf(fd, "count total (s) self (s) function\n");
20734 for (i = 0; i < 20 && i < st_len; ++i)
20736 fp = sorttab[i];
20737 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20738 prefer_self);
20739 if (fp->uf_name[0] == K_SPECIAL)
20740 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20741 else
20742 fprintf(fd, " %s()\n", fp->uf_name);
20744 fprintf(fd, "\n");
20748 * Print the count and times for one function or function line.
20750 static void
20751 prof_func_line(fd, count, total, self, prefer_self)
20752 FILE *fd;
20753 int count;
20754 proftime_T *total;
20755 proftime_T *self;
20756 int prefer_self; /* when equal print only self time */
20758 if (count > 0)
20760 fprintf(fd, "%5d ", count);
20761 if (prefer_self && profile_equal(total, self))
20762 fprintf(fd, " ");
20763 else
20764 fprintf(fd, "%s ", profile_msg(total));
20765 if (!prefer_self && profile_equal(total, self))
20766 fprintf(fd, " ");
20767 else
20768 fprintf(fd, "%s ", profile_msg(self));
20770 else
20771 fprintf(fd, " ");
20775 * Compare function for total time sorting.
20777 static int
20778 #ifdef __BORLANDC__
20779 _RTLENTRYF
20780 #endif
20781 prof_total_cmp(s1, s2)
20782 const void *s1;
20783 const void *s2;
20785 ufunc_T *p1, *p2;
20787 p1 = *(ufunc_T **)s1;
20788 p2 = *(ufunc_T **)s2;
20789 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20793 * Compare function for self time sorting.
20795 static int
20796 #ifdef __BORLANDC__
20797 _RTLENTRYF
20798 #endif
20799 prof_self_cmp(s1, s2)
20800 const void *s1;
20801 const void *s2;
20803 ufunc_T *p1, *p2;
20805 p1 = *(ufunc_T **)s1;
20806 p2 = *(ufunc_T **)s2;
20807 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
20810 #endif
20813 * If "name" has a package name try autoloading the script for it.
20814 * Return TRUE if a package was loaded.
20816 static int
20817 script_autoload(name, reload)
20818 char_u *name;
20819 int reload; /* load script again when already loaded */
20821 char_u *p;
20822 char_u *scriptname, *tofree;
20823 int ret = FALSE;
20824 int i;
20826 /* If there is no '#' after name[0] there is no package name. */
20827 p = vim_strchr(name, AUTOLOAD_CHAR);
20828 if (p == NULL || p == name)
20829 return FALSE;
20831 tofree = scriptname = autoload_name(name);
20833 /* Find the name in the list of previously loaded package names. Skip
20834 * "autoload/", it's always the same. */
20835 for (i = 0; i < ga_loaded.ga_len; ++i)
20836 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
20837 break;
20838 if (!reload && i < ga_loaded.ga_len)
20839 ret = FALSE; /* was loaded already */
20840 else
20842 /* Remember the name if it wasn't loaded already. */
20843 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
20845 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
20846 tofree = NULL;
20849 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
20850 if (source_runtime(scriptname, FALSE) == OK)
20851 ret = TRUE;
20854 vim_free(tofree);
20855 return ret;
20859 * Return the autoload script name for a function or variable name.
20860 * Returns NULL when out of memory.
20862 static char_u *
20863 autoload_name(name)
20864 char_u *name;
20866 char_u *p;
20867 char_u *scriptname;
20869 /* Get the script file name: replace '#' with '/', append ".vim". */
20870 scriptname = alloc((unsigned)(STRLEN(name) + 14));
20871 if (scriptname == NULL)
20872 return FALSE;
20873 STRCPY(scriptname, "autoload/");
20874 STRCAT(scriptname, name);
20875 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
20876 STRCAT(scriptname, ".vim");
20877 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
20878 *p = '/';
20879 return scriptname;
20882 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
20885 * Function given to ExpandGeneric() to obtain the list of user defined
20886 * function names.
20888 char_u *
20889 get_user_func_name(xp, idx)
20890 expand_T *xp;
20891 int idx;
20893 static long_u done;
20894 static hashitem_T *hi;
20895 ufunc_T *fp;
20897 if (idx == 0)
20899 done = 0;
20900 hi = func_hashtab.ht_array;
20902 if (done < func_hashtab.ht_used)
20904 if (done++ > 0)
20905 ++hi;
20906 while (HASHITEM_EMPTY(hi))
20907 ++hi;
20908 fp = HI2UF(hi);
20910 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
20911 return fp->uf_name; /* prevents overflow */
20913 cat_func_name(IObuff, fp);
20914 if (xp->xp_context != EXPAND_USER_FUNC)
20916 STRCAT(IObuff, "(");
20917 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
20918 STRCAT(IObuff, ")");
20920 return IObuff;
20922 return NULL;
20925 #endif /* FEAT_CMDL_COMPL */
20928 * Copy the function name of "fp" to buffer "buf".
20929 * "buf" must be able to hold the function name plus three bytes.
20930 * Takes care of script-local function names.
20932 static void
20933 cat_func_name(buf, fp)
20934 char_u *buf;
20935 ufunc_T *fp;
20937 if (fp->uf_name[0] == K_SPECIAL)
20939 STRCPY(buf, "<SNR>");
20940 STRCAT(buf, fp->uf_name + 3);
20942 else
20943 STRCPY(buf, fp->uf_name);
20947 * ":delfunction {name}"
20949 void
20950 ex_delfunction(eap)
20951 exarg_T *eap;
20953 ufunc_T *fp = NULL;
20954 char_u *p;
20955 char_u *name;
20956 funcdict_T fudi;
20958 p = eap->arg;
20959 name = trans_function_name(&p, eap->skip, 0, &fudi);
20960 vim_free(fudi.fd_newkey);
20961 if (name == NULL)
20963 if (fudi.fd_dict != NULL && !eap->skip)
20964 EMSG(_(e_funcref));
20965 return;
20967 if (!ends_excmd(*skipwhite(p)))
20969 vim_free(name);
20970 EMSG(_(e_trailing));
20971 return;
20973 eap->nextcmd = check_nextcmd(p);
20974 if (eap->nextcmd != NULL)
20975 *p = NUL;
20977 if (!eap->skip)
20978 fp = find_func(name);
20979 vim_free(name);
20981 if (!eap->skip)
20983 if (fp == NULL)
20985 EMSG2(_(e_nofunc), eap->arg);
20986 return;
20988 if (fp->uf_calls > 0)
20990 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
20991 return;
20994 if (fudi.fd_dict != NULL)
20996 /* Delete the dict item that refers to the function, it will
20997 * invoke func_unref() and possibly delete the function. */
20998 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21000 else
21001 func_free(fp);
21006 * Free a function and remove it from the list of functions.
21008 static void
21009 func_free(fp)
21010 ufunc_T *fp;
21012 hashitem_T *hi;
21014 /* clear this function */
21015 ga_clear_strings(&(fp->uf_args));
21016 ga_clear_strings(&(fp->uf_lines));
21017 #ifdef FEAT_PROFILE
21018 vim_free(fp->uf_tml_count);
21019 vim_free(fp->uf_tml_total);
21020 vim_free(fp->uf_tml_self);
21021 #endif
21023 /* remove the function from the function hashtable */
21024 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21025 if (HASHITEM_EMPTY(hi))
21026 EMSG2(_(e_intern2), "func_free()");
21027 else
21028 hash_remove(&func_hashtab, hi);
21030 vim_free(fp);
21034 * Unreference a Function: decrement the reference count and free it when it
21035 * becomes zero. Only for numbered functions.
21037 static void
21038 func_unref(name)
21039 char_u *name;
21041 ufunc_T *fp;
21043 if (name != NULL && isdigit(*name))
21045 fp = find_func(name);
21046 if (fp == NULL)
21047 EMSG2(_(e_intern2), "func_unref()");
21048 else if (--fp->uf_refcount <= 0)
21050 /* Only delete it when it's not being used. Otherwise it's done
21051 * when "uf_calls" becomes zero. */
21052 if (fp->uf_calls == 0)
21053 func_free(fp);
21059 * Count a reference to a Function.
21061 static void
21062 func_ref(name)
21063 char_u *name;
21065 ufunc_T *fp;
21067 if (name != NULL && isdigit(*name))
21069 fp = find_func(name);
21070 if (fp == NULL)
21071 EMSG2(_(e_intern2), "func_ref()");
21072 else
21073 ++fp->uf_refcount;
21078 * Call a user function.
21080 static void
21081 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21082 ufunc_T *fp; /* pointer to function */
21083 int argcount; /* nr of args */
21084 typval_T *argvars; /* arguments */
21085 typval_T *rettv; /* return value */
21086 linenr_T firstline; /* first line of range */
21087 linenr_T lastline; /* last line of range */
21088 dict_T *selfdict; /* Dictionary for "self" */
21090 char_u *save_sourcing_name;
21091 linenr_T save_sourcing_lnum;
21092 scid_T save_current_SID;
21093 funccall_T *fc;
21094 int save_did_emsg;
21095 static int depth = 0;
21096 dictitem_T *v;
21097 int fixvar_idx = 0; /* index in fixvar[] */
21098 int i;
21099 int ai;
21100 char_u numbuf[NUMBUFLEN];
21101 char_u *name;
21102 #ifdef FEAT_PROFILE
21103 proftime_T wait_start;
21104 proftime_T call_start;
21105 #endif
21107 /* If depth of calling is getting too high, don't execute the function */
21108 if (depth >= p_mfd)
21110 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21111 rettv->v_type = VAR_NUMBER;
21112 rettv->vval.v_number = -1;
21113 return;
21115 ++depth;
21117 line_breakcheck(); /* check for CTRL-C hit */
21119 fc = (funccall_T *)alloc(sizeof(funccall_T));
21120 fc->caller = current_funccal;
21121 current_funccal = fc;
21122 fc->func = fp;
21123 fc->rettv = rettv;
21124 rettv->vval.v_number = 0;
21125 fc->linenr = 0;
21126 fc->returned = FALSE;
21127 fc->level = ex_nesting_level;
21128 /* Check if this function has a breakpoint. */
21129 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21130 fc->dbg_tick = debug_tick;
21133 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21134 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21135 * each argument variable and saves a lot of time.
21138 * Init l: variables.
21140 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21141 if (selfdict != NULL)
21143 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21144 * some compiler that checks the destination size. */
21145 v = &fc->fixvar[fixvar_idx++].var;
21146 name = v->di_key;
21147 STRCPY(name, "self");
21148 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21149 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21150 v->di_tv.v_type = VAR_DICT;
21151 v->di_tv.v_lock = 0;
21152 v->di_tv.vval.v_dict = selfdict;
21153 ++selfdict->dv_refcount;
21157 * Init a: variables.
21158 * Set a:0 to "argcount".
21159 * Set a:000 to a list with room for the "..." arguments.
21161 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21162 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21163 (varnumber_T)(argcount - fp->uf_args.ga_len));
21164 /* Use "name" to avoid a warning from some compiler that checks the
21165 * destination size. */
21166 v = &fc->fixvar[fixvar_idx++].var;
21167 name = v->di_key;
21168 STRCPY(name, "000");
21169 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21170 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21171 v->di_tv.v_type = VAR_LIST;
21172 v->di_tv.v_lock = VAR_FIXED;
21173 v->di_tv.vval.v_list = &fc->l_varlist;
21174 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21175 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21176 fc->l_varlist.lv_lock = VAR_FIXED;
21179 * Set a:firstline to "firstline" and a:lastline to "lastline".
21180 * Set a:name to named arguments.
21181 * Set a:N to the "..." arguments.
21183 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21184 (varnumber_T)firstline);
21185 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21186 (varnumber_T)lastline);
21187 for (i = 0; i < argcount; ++i)
21189 ai = i - fp->uf_args.ga_len;
21190 if (ai < 0)
21191 /* named argument a:name */
21192 name = FUNCARG(fp, i);
21193 else
21195 /* "..." argument a:1, a:2, etc. */
21196 sprintf((char *)numbuf, "%d", ai + 1);
21197 name = numbuf;
21199 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21201 v = &fc->fixvar[fixvar_idx++].var;
21202 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21204 else
21206 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21207 + STRLEN(name)));
21208 if (v == NULL)
21209 break;
21210 v->di_flags = DI_FLAGS_RO;
21212 STRCPY(v->di_key, name);
21213 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21215 /* Note: the values are copied directly to avoid alloc/free.
21216 * "argvars" must have VAR_FIXED for v_lock. */
21217 v->di_tv = argvars[i];
21218 v->di_tv.v_lock = VAR_FIXED;
21220 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21222 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21223 fc->l_listitems[ai].li_tv = argvars[i];
21224 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21228 /* Don't redraw while executing the function. */
21229 ++RedrawingDisabled;
21230 save_sourcing_name = sourcing_name;
21231 save_sourcing_lnum = sourcing_lnum;
21232 sourcing_lnum = 1;
21233 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21234 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21235 if (sourcing_name != NULL)
21237 if (save_sourcing_name != NULL
21238 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21239 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21240 else
21241 STRCPY(sourcing_name, "function ");
21242 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21244 if (p_verbose >= 12)
21246 ++no_wait_return;
21247 verbose_enter_scroll();
21249 smsg((char_u *)_("calling %s"), sourcing_name);
21250 if (p_verbose >= 14)
21252 char_u buf[MSG_BUF_LEN];
21253 char_u numbuf2[NUMBUFLEN];
21254 char_u *tofree;
21255 char_u *s;
21257 msg_puts((char_u *)"(");
21258 for (i = 0; i < argcount; ++i)
21260 if (i > 0)
21261 msg_puts((char_u *)", ");
21262 if (argvars[i].v_type == VAR_NUMBER)
21263 msg_outnum((long)argvars[i].vval.v_number);
21264 else
21266 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21267 if (s != NULL)
21269 trunc_string(s, buf, MSG_BUF_CLEN);
21270 msg_puts(buf);
21271 vim_free(tofree);
21275 msg_puts((char_u *)")");
21277 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21279 verbose_leave_scroll();
21280 --no_wait_return;
21283 #ifdef FEAT_PROFILE
21284 if (do_profiling == PROF_YES)
21286 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21287 func_do_profile(fp);
21288 if (fp->uf_profiling
21289 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21291 ++fp->uf_tm_count;
21292 profile_start(&call_start);
21293 profile_zero(&fp->uf_tm_children);
21295 script_prof_save(&wait_start);
21297 #endif
21299 save_current_SID = current_SID;
21300 current_SID = fp->uf_script_ID;
21301 save_did_emsg = did_emsg;
21302 did_emsg = FALSE;
21304 /* call do_cmdline() to execute the lines */
21305 do_cmdline(NULL, get_func_line, (void *)fc,
21306 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21308 --RedrawingDisabled;
21310 /* when the function was aborted because of an error, return -1 */
21311 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21313 clear_tv(rettv);
21314 rettv->v_type = VAR_NUMBER;
21315 rettv->vval.v_number = -1;
21318 #ifdef FEAT_PROFILE
21319 if (do_profiling == PROF_YES && (fp->uf_profiling
21320 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21322 profile_end(&call_start);
21323 profile_sub_wait(&wait_start, &call_start);
21324 profile_add(&fp->uf_tm_total, &call_start);
21325 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21326 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21328 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21329 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21332 #endif
21334 /* when being verbose, mention the return value */
21335 if (p_verbose >= 12)
21337 ++no_wait_return;
21338 verbose_enter_scroll();
21340 if (aborting())
21341 smsg((char_u *)_("%s aborted"), sourcing_name);
21342 else if (fc->rettv->v_type == VAR_NUMBER)
21343 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21344 (long)fc->rettv->vval.v_number);
21345 else
21347 char_u buf[MSG_BUF_LEN];
21348 char_u numbuf2[NUMBUFLEN];
21349 char_u *tofree;
21350 char_u *s;
21352 /* The value may be very long. Skip the middle part, so that we
21353 * have some idea how it starts and ends. smsg() would always
21354 * truncate it at the end. */
21355 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21356 if (s != NULL)
21358 trunc_string(s, buf, MSG_BUF_CLEN);
21359 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21360 vim_free(tofree);
21363 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21365 verbose_leave_scroll();
21366 --no_wait_return;
21369 vim_free(sourcing_name);
21370 sourcing_name = save_sourcing_name;
21371 sourcing_lnum = save_sourcing_lnum;
21372 current_SID = save_current_SID;
21373 #ifdef FEAT_PROFILE
21374 if (do_profiling == PROF_YES)
21375 script_prof_restore(&wait_start);
21376 #endif
21378 if (p_verbose >= 12 && sourcing_name != NULL)
21380 ++no_wait_return;
21381 verbose_enter_scroll();
21383 smsg((char_u *)_("continuing in %s"), sourcing_name);
21384 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21386 verbose_leave_scroll();
21387 --no_wait_return;
21390 did_emsg |= save_did_emsg;
21391 current_funccal = fc->caller;
21392 --depth;
21394 /* If the a:000 list and the l: and a: dicts are not referenced we can
21395 * free the funccall_T and what's in it. */
21396 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21397 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21398 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21400 free_funccal(fc, FALSE);
21402 else
21404 hashitem_T *hi;
21405 listitem_T *li;
21406 int todo;
21408 /* "fc" is still in use. This can happen when returning "a:000" or
21409 * assigning "l:" to a global variable.
21410 * Link "fc" in the list for garbage collection later. */
21411 fc->caller = previous_funccal;
21412 previous_funccal = fc;
21414 /* Make a copy of the a: variables, since we didn't do that above. */
21415 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21416 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21418 if (!HASHITEM_EMPTY(hi))
21420 --todo;
21421 v = HI2DI(hi);
21422 copy_tv(&v->di_tv, &v->di_tv);
21426 /* Make a copy of the a:000 items, since we didn't do that above. */
21427 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21428 copy_tv(&li->li_tv, &li->li_tv);
21433 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21434 * referenced from anywhere that is in use.
21436 static int
21437 can_free_funccal(fc, copyID)
21438 funccall_T *fc;
21439 int copyID;
21441 return (fc->l_varlist.lv_copyID != copyID
21442 && fc->l_vars.dv_copyID != copyID
21443 && fc->l_avars.dv_copyID != copyID);
21447 * Free "fc" and what it contains.
21449 static void
21450 free_funccal(fc, free_val)
21451 funccall_T *fc;
21452 int free_val; /* a: vars were allocated */
21454 listitem_T *li;
21456 /* The a: variables typevals may not have been allocated, only free the
21457 * allocated variables. */
21458 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21460 /* free all l: variables */
21461 vars_clear(&fc->l_vars.dv_hashtab);
21463 /* Free the a:000 variables if they were allocated. */
21464 if (free_val)
21465 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21466 clear_tv(&li->li_tv);
21468 vim_free(fc);
21472 * Add a number variable "name" to dict "dp" with value "nr".
21474 static void
21475 add_nr_var(dp, v, name, nr)
21476 dict_T *dp;
21477 dictitem_T *v;
21478 char *name;
21479 varnumber_T nr;
21481 STRCPY(v->di_key, name);
21482 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21483 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21484 v->di_tv.v_type = VAR_NUMBER;
21485 v->di_tv.v_lock = VAR_FIXED;
21486 v->di_tv.vval.v_number = nr;
21490 * ":return [expr]"
21492 void
21493 ex_return(eap)
21494 exarg_T *eap;
21496 char_u *arg = eap->arg;
21497 typval_T rettv;
21498 int returning = FALSE;
21500 if (current_funccal == NULL)
21502 EMSG(_("E133: :return not inside a function"));
21503 return;
21506 if (eap->skip)
21507 ++emsg_skip;
21509 eap->nextcmd = NULL;
21510 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21511 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21513 if (!eap->skip)
21514 returning = do_return(eap, FALSE, TRUE, &rettv);
21515 else
21516 clear_tv(&rettv);
21518 /* It's safer to return also on error. */
21519 else if (!eap->skip)
21522 * Return unless the expression evaluation has been cancelled due to an
21523 * aborting error, an interrupt, or an exception.
21525 if (!aborting())
21526 returning = do_return(eap, FALSE, TRUE, NULL);
21529 /* When skipping or the return gets pending, advance to the next command
21530 * in this line (!returning). Otherwise, ignore the rest of the line.
21531 * Following lines will be ignored by get_func_line(). */
21532 if (returning)
21533 eap->nextcmd = NULL;
21534 else if (eap->nextcmd == NULL) /* no argument */
21535 eap->nextcmd = check_nextcmd(arg);
21537 if (eap->skip)
21538 --emsg_skip;
21542 * Return from a function. Possibly makes the return pending. Also called
21543 * for a pending return at the ":endtry" or after returning from an extra
21544 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21545 * when called due to a ":return" command. "rettv" may point to a typval_T
21546 * with the return rettv. Returns TRUE when the return can be carried out,
21547 * FALSE when the return gets pending.
21550 do_return(eap, reanimate, is_cmd, rettv)
21551 exarg_T *eap;
21552 int reanimate;
21553 int is_cmd;
21554 void *rettv;
21556 int idx;
21557 struct condstack *cstack = eap->cstack;
21559 if (reanimate)
21560 /* Undo the return. */
21561 current_funccal->returned = FALSE;
21564 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21565 * not in its finally clause (which then is to be executed next) is found.
21566 * In this case, make the ":return" pending for execution at the ":endtry".
21567 * Otherwise, return normally.
21569 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21570 if (idx >= 0)
21572 cstack->cs_pending[idx] = CSTP_RETURN;
21574 if (!is_cmd && !reanimate)
21575 /* A pending return again gets pending. "rettv" points to an
21576 * allocated variable with the rettv of the original ":return"'s
21577 * argument if present or is NULL else. */
21578 cstack->cs_rettv[idx] = rettv;
21579 else
21581 /* When undoing a return in order to make it pending, get the stored
21582 * return rettv. */
21583 if (reanimate)
21584 rettv = current_funccal->rettv;
21586 if (rettv != NULL)
21588 /* Store the value of the pending return. */
21589 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21590 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21591 else
21592 EMSG(_(e_outofmem));
21594 else
21595 cstack->cs_rettv[idx] = NULL;
21597 if (reanimate)
21599 /* The pending return value could be overwritten by a ":return"
21600 * without argument in a finally clause; reset the default
21601 * return value. */
21602 current_funccal->rettv->v_type = VAR_NUMBER;
21603 current_funccal->rettv->vval.v_number = 0;
21606 report_make_pending(CSTP_RETURN, rettv);
21608 else
21610 current_funccal->returned = TRUE;
21612 /* If the return is carried out now, store the return value. For
21613 * a return immediately after reanimation, the value is already
21614 * there. */
21615 if (!reanimate && rettv != NULL)
21617 clear_tv(current_funccal->rettv);
21618 *current_funccal->rettv = *(typval_T *)rettv;
21619 if (!is_cmd)
21620 vim_free(rettv);
21624 return idx < 0;
21628 * Free the variable with a pending return value.
21630 void
21631 discard_pending_return(rettv)
21632 void *rettv;
21634 free_tv((typval_T *)rettv);
21638 * Generate a return command for producing the value of "rettv". The result
21639 * is an allocated string. Used by report_pending() for verbose messages.
21641 char_u *
21642 get_return_cmd(rettv)
21643 void *rettv;
21645 char_u *s = NULL;
21646 char_u *tofree = NULL;
21647 char_u numbuf[NUMBUFLEN];
21649 if (rettv != NULL)
21650 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21651 if (s == NULL)
21652 s = (char_u *)"";
21654 STRCPY(IObuff, ":return ");
21655 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21656 if (STRLEN(s) + 8 >= IOSIZE)
21657 STRCPY(IObuff + IOSIZE - 4, "...");
21658 vim_free(tofree);
21659 return vim_strsave(IObuff);
21663 * Get next function line.
21664 * Called by do_cmdline() to get the next line.
21665 * Returns allocated string, or NULL for end of function.
21667 char_u *
21668 get_func_line(c, cookie, indent)
21669 int c UNUSED;
21670 void *cookie;
21671 int indent UNUSED;
21673 funccall_T *fcp = (funccall_T *)cookie;
21674 ufunc_T *fp = fcp->func;
21675 char_u *retval;
21676 garray_T *gap; /* growarray with function lines */
21678 /* If breakpoints have been added/deleted need to check for it. */
21679 if (fcp->dbg_tick != debug_tick)
21681 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21682 sourcing_lnum);
21683 fcp->dbg_tick = debug_tick;
21685 #ifdef FEAT_PROFILE
21686 if (do_profiling == PROF_YES)
21687 func_line_end(cookie);
21688 #endif
21690 gap = &fp->uf_lines;
21691 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21692 || fcp->returned)
21693 retval = NULL;
21694 else
21696 /* Skip NULL lines (continuation lines). */
21697 while (fcp->linenr < gap->ga_len
21698 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21699 ++fcp->linenr;
21700 if (fcp->linenr >= gap->ga_len)
21701 retval = NULL;
21702 else
21704 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21705 sourcing_lnum = fcp->linenr;
21706 #ifdef FEAT_PROFILE
21707 if (do_profiling == PROF_YES)
21708 func_line_start(cookie);
21709 #endif
21713 /* Did we encounter a breakpoint? */
21714 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21716 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21717 /* Find next breakpoint. */
21718 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21719 sourcing_lnum);
21720 fcp->dbg_tick = debug_tick;
21723 return retval;
21726 #if defined(FEAT_PROFILE) || defined(PROTO)
21728 * Called when starting to read a function line.
21729 * "sourcing_lnum" must be correct!
21730 * When skipping lines it may not actually be executed, but we won't find out
21731 * until later and we need to store the time now.
21733 void
21734 func_line_start(cookie)
21735 void *cookie;
21737 funccall_T *fcp = (funccall_T *)cookie;
21738 ufunc_T *fp = fcp->func;
21740 if (fp->uf_profiling && sourcing_lnum >= 1
21741 && sourcing_lnum <= fp->uf_lines.ga_len)
21743 fp->uf_tml_idx = sourcing_lnum - 1;
21744 /* Skip continuation lines. */
21745 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21746 --fp->uf_tml_idx;
21747 fp->uf_tml_execed = FALSE;
21748 profile_start(&fp->uf_tml_start);
21749 profile_zero(&fp->uf_tml_children);
21750 profile_get_wait(&fp->uf_tml_wait);
21755 * Called when actually executing a function line.
21757 void
21758 func_line_exec(cookie)
21759 void *cookie;
21761 funccall_T *fcp = (funccall_T *)cookie;
21762 ufunc_T *fp = fcp->func;
21764 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21765 fp->uf_tml_execed = TRUE;
21769 * Called when done with a function line.
21771 void
21772 func_line_end(cookie)
21773 void *cookie;
21775 funccall_T *fcp = (funccall_T *)cookie;
21776 ufunc_T *fp = fcp->func;
21778 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21780 if (fp->uf_tml_execed)
21782 ++fp->uf_tml_count[fp->uf_tml_idx];
21783 profile_end(&fp->uf_tml_start);
21784 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21785 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21786 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21787 &fp->uf_tml_children);
21789 fp->uf_tml_idx = -1;
21792 #endif
21795 * Return TRUE if the currently active function should be ended, because a
21796 * return was encountered or an error occurred. Used inside a ":while".
21799 func_has_ended(cookie)
21800 void *cookie;
21802 funccall_T *fcp = (funccall_T *)cookie;
21804 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21805 * an error inside a try conditional. */
21806 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21807 || fcp->returned);
21811 * return TRUE if cookie indicates a function which "abort"s on errors.
21814 func_has_abort(cookie)
21815 void *cookie;
21817 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
21820 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
21821 typedef enum
21823 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
21824 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
21825 VAR_FLAVOUR_VIMINFO /* all uppercase */
21826 } var_flavour_T;
21828 static var_flavour_T var_flavour __ARGS((char_u *varname));
21830 static var_flavour_T
21831 var_flavour(varname)
21832 char_u *varname;
21834 char_u *p = varname;
21836 if (ASCII_ISUPPER(*p))
21838 while (*(++p))
21839 if (ASCII_ISLOWER(*p))
21840 return VAR_FLAVOUR_SESSION;
21841 return VAR_FLAVOUR_VIMINFO;
21843 else
21844 return VAR_FLAVOUR_DEFAULT;
21846 #endif
21848 #if defined(FEAT_VIMINFO) || defined(PROTO)
21850 * Restore global vars that start with a capital from the viminfo file
21853 read_viminfo_varlist(virp, writing)
21854 vir_T *virp;
21855 int writing;
21857 char_u *tab;
21858 int type = VAR_NUMBER;
21859 typval_T tv;
21861 if (!writing && (find_viminfo_parameter('!') != NULL))
21863 tab = vim_strchr(virp->vir_line + 1, '\t');
21864 if (tab != NULL)
21866 *tab++ = '\0'; /* isolate the variable name */
21867 if (*tab == 'S') /* string var */
21868 type = VAR_STRING;
21869 #ifdef FEAT_FLOAT
21870 else if (*tab == 'F')
21871 type = VAR_FLOAT;
21872 #endif
21874 tab = vim_strchr(tab, '\t');
21875 if (tab != NULL)
21877 tv.v_type = type;
21878 if (type == VAR_STRING)
21879 tv.vval.v_string = viminfo_readstring(virp,
21880 (int)(tab - virp->vir_line + 1), TRUE);
21881 #ifdef FEAT_FLOAT
21882 else if (type == VAR_FLOAT)
21883 (void)string2float(tab + 1, &tv.vval.v_float);
21884 #endif
21885 else
21886 tv.vval.v_number = atol((char *)tab + 1);
21887 set_var(virp->vir_line + 1, &tv, FALSE);
21888 if (type == VAR_STRING)
21889 vim_free(tv.vval.v_string);
21894 return viminfo_readline(virp);
21898 * Write global vars that start with a capital to the viminfo file
21900 void
21901 write_viminfo_varlist(fp)
21902 FILE *fp;
21904 hashitem_T *hi;
21905 dictitem_T *this_var;
21906 int todo;
21907 char *s;
21908 char_u *p;
21909 char_u *tofree;
21910 char_u numbuf[NUMBUFLEN];
21912 if (find_viminfo_parameter('!') == NULL)
21913 return;
21915 fprintf(fp, _("\n# global variables:\n"));
21917 todo = (int)globvarht.ht_used;
21918 for (hi = globvarht.ht_array; todo > 0; ++hi)
21920 if (!HASHITEM_EMPTY(hi))
21922 --todo;
21923 this_var = HI2DI(hi);
21924 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
21926 switch (this_var->di_tv.v_type)
21928 case VAR_STRING: s = "STR"; break;
21929 case VAR_NUMBER: s = "NUM"; break;
21930 #ifdef FEAT_FLOAT
21931 case VAR_FLOAT: s = "FLO"; break;
21932 #endif
21933 default: continue;
21935 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
21936 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
21937 if (p != NULL)
21938 viminfo_writestring(fp, p);
21939 vim_free(tofree);
21944 #endif
21946 #if defined(FEAT_SESSION) || defined(PROTO)
21948 store_session_globals(fd)
21949 FILE *fd;
21951 hashitem_T *hi;
21952 dictitem_T *this_var;
21953 int todo;
21954 char_u *p, *t;
21956 todo = (int)globvarht.ht_used;
21957 for (hi = globvarht.ht_array; todo > 0; ++hi)
21959 if (!HASHITEM_EMPTY(hi))
21961 --todo;
21962 this_var = HI2DI(hi);
21963 if ((this_var->di_tv.v_type == VAR_NUMBER
21964 || this_var->di_tv.v_type == VAR_STRING)
21965 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21967 /* Escape special characters with a backslash. Turn a LF and
21968 * CR into \n and \r. */
21969 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
21970 (char_u *)"\\\"\n\r");
21971 if (p == NULL) /* out of memory */
21972 break;
21973 for (t = p; *t != NUL; ++t)
21974 if (*t == '\n')
21975 *t = 'n';
21976 else if (*t == '\r')
21977 *t = 'r';
21978 if ((fprintf(fd, "let %s = %c%s%c",
21979 this_var->di_key,
21980 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21981 : ' ',
21983 (this_var->di_tv.v_type == VAR_STRING) ? '"'
21984 : ' ') < 0)
21985 || put_eol(fd) == FAIL)
21987 vim_free(p);
21988 return FAIL;
21990 vim_free(p);
21992 #ifdef FEAT_FLOAT
21993 else if (this_var->di_tv.v_type == VAR_FLOAT
21994 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
21996 float_T f = this_var->di_tv.vval.v_float;
21997 int sign = ' ';
21999 if (f < 0)
22001 f = -f;
22002 sign = '-';
22004 if ((fprintf(fd, "let %s = %c&%f",
22005 this_var->di_key, sign, f) < 0)
22006 || put_eol(fd) == FAIL)
22007 return FAIL;
22009 #endif
22012 return OK;
22014 #endif
22017 * Display script name where an item was last set.
22018 * Should only be invoked when 'verbose' is non-zero.
22020 void
22021 last_set_msg(scriptID)
22022 scid_T scriptID;
22024 char_u *p;
22026 if (scriptID != 0)
22028 p = home_replace_save(NULL, get_scriptname(scriptID));
22029 if (p != NULL)
22031 verbose_enter();
22032 MSG_PUTS(_("\n\tLast set from "));
22033 MSG_PUTS(p);
22034 vim_free(p);
22035 verbose_leave();
22041 * List v:oldfiles in a nice way.
22043 void
22044 ex_oldfiles(eap)
22045 exarg_T *eap UNUSED;
22047 list_T *l = vimvars[VV_OLDFILES].vv_list;
22048 listitem_T *li;
22049 int nr = 0;
22051 if (l == NULL)
22052 msg((char_u *)_("No old files"));
22053 else
22055 msg_start();
22056 msg_scroll = TRUE;
22057 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22059 msg_outnum((long)++nr);
22060 MSG_PUTS(": ");
22061 msg_outtrans(get_tv_string(&li->li_tv));
22062 msg_putchar('\n');
22063 out_flush(); /* output one line at a time */
22064 ui_breakcheck();
22066 /* Assume "got_int" was set to truncate the listing. */
22067 got_int = FALSE;
22069 #ifdef FEAT_BROWSE_CMD
22070 if (cmdmod.browse)
22072 quit_more = FALSE;
22073 nr = prompt_for_number(FALSE);
22074 msg_starthere();
22075 if (nr > 0)
22077 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22078 (long)nr);
22080 if (p != NULL)
22082 p = expand_env_save(p);
22083 eap->arg = p;
22084 eap->cmdidx = CMD_edit;
22085 cmdmod.browse = FALSE;
22086 do_exedit(eap, NULL);
22087 vim_free(p);
22091 #endif
22095 #endif /* FEAT_EVAL */
22098 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22100 #ifdef WIN3264
22102 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22104 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22105 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22106 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22109 * Get the short path (8.3) for the filename in "fnamep".
22110 * Only works for a valid file name.
22111 * When the path gets longer "fnamep" is changed and the allocated buffer
22112 * is put in "bufp".
22113 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22114 * Returns OK on success, FAIL on failure.
22116 static int
22117 get_short_pathname(fnamep, bufp, fnamelen)
22118 char_u **fnamep;
22119 char_u **bufp;
22120 int *fnamelen;
22122 int l, len;
22123 char_u *newbuf;
22125 len = *fnamelen;
22126 l = GetShortPathName(*fnamep, *fnamep, len);
22127 if (l > len - 1)
22129 /* If that doesn't work (not enough space), then save the string
22130 * and try again with a new buffer big enough. */
22131 newbuf = vim_strnsave(*fnamep, l);
22132 if (newbuf == NULL)
22133 return FAIL;
22135 vim_free(*bufp);
22136 *fnamep = *bufp = newbuf;
22138 /* Really should always succeed, as the buffer is big enough. */
22139 l = GetShortPathName(*fnamep, *fnamep, l+1);
22142 *fnamelen = l;
22143 return OK;
22147 * Get the short path (8.3) for the filename in "fname". The converted
22148 * path is returned in "bufp".
22150 * Some of the directories specified in "fname" may not exist. This function
22151 * will shorten the existing directories at the beginning of the path and then
22152 * append the remaining non-existing path.
22154 * fname - Pointer to the filename to shorten. On return, contains the
22155 * pointer to the shortened pathname
22156 * bufp - Pointer to an allocated buffer for the filename.
22157 * fnamelen - Length of the filename pointed to by fname
22159 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22161 static int
22162 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22163 char_u **fname;
22164 char_u **bufp;
22165 int *fnamelen;
22167 char_u *short_fname, *save_fname, *pbuf_unused;
22168 char_u *endp, *save_endp;
22169 char_u ch;
22170 int old_len, len;
22171 int new_len, sfx_len;
22172 int retval = OK;
22174 /* Make a copy */
22175 old_len = *fnamelen;
22176 save_fname = vim_strnsave(*fname, old_len);
22177 pbuf_unused = NULL;
22178 short_fname = NULL;
22180 endp = save_fname + old_len - 1; /* Find the end of the copy */
22181 save_endp = endp;
22184 * Try shortening the supplied path till it succeeds by removing one
22185 * directory at a time from the tail of the path.
22187 len = 0;
22188 for (;;)
22190 /* go back one path-separator */
22191 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22192 --endp;
22193 if (endp <= save_fname)
22194 break; /* processed the complete path */
22197 * Replace the path separator with a NUL and try to shorten the
22198 * resulting path.
22200 ch = *endp;
22201 *endp = 0;
22202 short_fname = save_fname;
22203 len = (int)STRLEN(short_fname) + 1;
22204 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22206 retval = FAIL;
22207 goto theend;
22209 *endp = ch; /* preserve the string */
22211 if (len > 0)
22212 break; /* successfully shortened the path */
22214 /* failed to shorten the path. Skip the path separator */
22215 --endp;
22218 if (len > 0)
22221 * Succeeded in shortening the path. Now concatenate the shortened
22222 * path with the remaining path at the tail.
22225 /* Compute the length of the new path. */
22226 sfx_len = (int)(save_endp - endp) + 1;
22227 new_len = len + sfx_len;
22229 *fnamelen = new_len;
22230 vim_free(*bufp);
22231 if (new_len > old_len)
22233 /* There is not enough space in the currently allocated string,
22234 * copy it to a buffer big enough. */
22235 *fname = *bufp = vim_strnsave(short_fname, new_len);
22236 if (*fname == NULL)
22238 retval = FAIL;
22239 goto theend;
22242 else
22244 /* Transfer short_fname to the main buffer (it's big enough),
22245 * unless get_short_pathname() did its work in-place. */
22246 *fname = *bufp = save_fname;
22247 if (short_fname != save_fname)
22248 vim_strncpy(save_fname, short_fname, len);
22249 save_fname = NULL;
22252 /* concat the not-shortened part of the path */
22253 vim_strncpy(*fname + len, endp, sfx_len);
22254 (*fname)[new_len] = NUL;
22257 theend:
22258 vim_free(pbuf_unused);
22259 vim_free(save_fname);
22261 return retval;
22265 * Get a pathname for a partial path.
22266 * Returns OK for success, FAIL for failure.
22268 static int
22269 shortpath_for_partial(fnamep, bufp, fnamelen)
22270 char_u **fnamep;
22271 char_u **bufp;
22272 int *fnamelen;
22274 int sepcount, len, tflen;
22275 char_u *p;
22276 char_u *pbuf, *tfname;
22277 int hasTilde;
22279 /* Count up the path separators from the RHS.. so we know which part
22280 * of the path to return. */
22281 sepcount = 0;
22282 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22283 if (vim_ispathsep(*p))
22284 ++sepcount;
22286 /* Need full path first (use expand_env() to remove a "~/") */
22287 hasTilde = (**fnamep == '~');
22288 if (hasTilde)
22289 pbuf = tfname = expand_env_save(*fnamep);
22290 else
22291 pbuf = tfname = FullName_save(*fnamep, FALSE);
22293 len = tflen = (int)STRLEN(tfname);
22295 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22296 return FAIL;
22298 if (len == 0)
22300 /* Don't have a valid filename, so shorten the rest of the
22301 * path if we can. This CAN give us invalid 8.3 filenames, but
22302 * there's not a lot of point in guessing what it might be.
22304 len = tflen;
22305 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22306 return FAIL;
22309 /* Count the paths backward to find the beginning of the desired string. */
22310 for (p = tfname + len - 1; p >= tfname; --p)
22312 #ifdef FEAT_MBYTE
22313 if (has_mbyte)
22314 p -= mb_head_off(tfname, p);
22315 #endif
22316 if (vim_ispathsep(*p))
22318 if (sepcount == 0 || (hasTilde && sepcount == 1))
22319 break;
22320 else
22321 sepcount --;
22324 if (hasTilde)
22326 --p;
22327 if (p >= tfname)
22328 *p = '~';
22329 else
22330 return FAIL;
22332 else
22333 ++p;
22335 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22336 vim_free(*bufp);
22337 *fnamelen = (int)STRLEN(p);
22338 *bufp = pbuf;
22339 *fnamep = p;
22341 return OK;
22343 #endif /* WIN3264 */
22346 * Adjust a filename, according to a string of modifiers.
22347 * *fnamep must be NUL terminated when called. When returning, the length is
22348 * determined by *fnamelen.
22349 * Returns VALID_ flags or -1 for failure.
22350 * When there is an error, *fnamep is set to NULL.
22353 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22354 char_u *src; /* string with modifiers */
22355 int *usedlen; /* characters after src that are used */
22356 char_u **fnamep; /* file name so far */
22357 char_u **bufp; /* buffer for allocated file name or NULL */
22358 int *fnamelen; /* length of fnamep */
22360 int valid = 0;
22361 char_u *tail;
22362 char_u *s, *p, *pbuf;
22363 char_u dirname[MAXPATHL];
22364 int c;
22365 int has_fullname = 0;
22366 #ifdef WIN3264
22367 int has_shortname = 0;
22368 #endif
22370 repeat:
22371 /* ":p" - full path/file_name */
22372 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22374 has_fullname = 1;
22376 valid |= VALID_PATH;
22377 *usedlen += 2;
22379 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22380 if ((*fnamep)[0] == '~'
22381 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22382 && ((*fnamep)[1] == '/'
22383 # ifdef BACKSLASH_IN_FILENAME
22384 || (*fnamep)[1] == '\\'
22385 # endif
22386 || (*fnamep)[1] == NUL)
22388 #endif
22391 *fnamep = expand_env_save(*fnamep);
22392 vim_free(*bufp); /* free any allocated file name */
22393 *bufp = *fnamep;
22394 if (*fnamep == NULL)
22395 return -1;
22398 /* When "/." or "/.." is used: force expansion to get rid of it. */
22399 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22401 if (vim_ispathsep(*p)
22402 && p[1] == '.'
22403 && (p[2] == NUL
22404 || vim_ispathsep(p[2])
22405 || (p[2] == '.'
22406 && (p[3] == NUL || vim_ispathsep(p[3])))))
22407 break;
22410 /* FullName_save() is slow, don't use it when not needed. */
22411 if (*p != NUL || !vim_isAbsName(*fnamep))
22413 *fnamep = FullName_save(*fnamep, *p != NUL);
22414 vim_free(*bufp); /* free any allocated file name */
22415 *bufp = *fnamep;
22416 if (*fnamep == NULL)
22417 return -1;
22420 /* Append a path separator to a directory. */
22421 if (mch_isdir(*fnamep))
22423 /* Make room for one or two extra characters. */
22424 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22425 vim_free(*bufp); /* free any allocated file name */
22426 *bufp = *fnamep;
22427 if (*fnamep == NULL)
22428 return -1;
22429 add_pathsep(*fnamep);
22433 /* ":." - path relative to the current directory */
22434 /* ":~" - path relative to the home directory */
22435 /* ":8" - shortname path - postponed till after */
22436 while (src[*usedlen] == ':'
22437 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22439 *usedlen += 2;
22440 if (c == '8')
22442 #ifdef WIN3264
22443 has_shortname = 1; /* Postpone this. */
22444 #endif
22445 continue;
22447 pbuf = NULL;
22448 /* Need full path first (use expand_env() to remove a "~/") */
22449 if (!has_fullname)
22451 if (c == '.' && **fnamep == '~')
22452 p = pbuf = expand_env_save(*fnamep);
22453 else
22454 p = pbuf = FullName_save(*fnamep, FALSE);
22456 else
22457 p = *fnamep;
22459 has_fullname = 0;
22461 if (p != NULL)
22463 if (c == '.')
22465 mch_dirname(dirname, MAXPATHL);
22466 s = shorten_fname(p, dirname);
22467 if (s != NULL)
22469 *fnamep = s;
22470 if (pbuf != NULL)
22472 vim_free(*bufp); /* free any allocated file name */
22473 *bufp = pbuf;
22474 pbuf = NULL;
22478 else
22480 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22481 /* Only replace it when it starts with '~' */
22482 if (*dirname == '~')
22484 s = vim_strsave(dirname);
22485 if (s != NULL)
22487 *fnamep = s;
22488 vim_free(*bufp);
22489 *bufp = s;
22493 vim_free(pbuf);
22497 tail = gettail(*fnamep);
22498 *fnamelen = (int)STRLEN(*fnamep);
22500 /* ":h" - head, remove "/file_name", can be repeated */
22501 /* Don't remove the first "/" or "c:\" */
22502 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22504 valid |= VALID_HEAD;
22505 *usedlen += 2;
22506 s = get_past_head(*fnamep);
22507 while (tail > s && after_pathsep(s, tail))
22508 mb_ptr_back(*fnamep, tail);
22509 *fnamelen = (int)(tail - *fnamep);
22510 #ifdef VMS
22511 if (*fnamelen > 0)
22512 *fnamelen += 1; /* the path separator is part of the path */
22513 #endif
22514 if (*fnamelen == 0)
22516 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22517 p = vim_strsave((char_u *)".");
22518 if (p == NULL)
22519 return -1;
22520 vim_free(*bufp);
22521 *bufp = *fnamep = tail = p;
22522 *fnamelen = 1;
22524 else
22526 while (tail > s && !after_pathsep(s, tail))
22527 mb_ptr_back(*fnamep, tail);
22531 /* ":8" - shortname */
22532 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22534 *usedlen += 2;
22535 #ifdef WIN3264
22536 has_shortname = 1;
22537 #endif
22540 #ifdef WIN3264
22541 /* Check shortname after we have done 'heads' and before we do 'tails'
22543 if (has_shortname)
22545 pbuf = NULL;
22546 /* Copy the string if it is shortened by :h */
22547 if (*fnamelen < (int)STRLEN(*fnamep))
22549 p = vim_strnsave(*fnamep, *fnamelen);
22550 if (p == 0)
22551 return -1;
22552 vim_free(*bufp);
22553 *bufp = *fnamep = p;
22556 /* Split into two implementations - makes it easier. First is where
22557 * there isn't a full name already, second is where there is.
22559 if (!has_fullname && !vim_isAbsName(*fnamep))
22561 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22562 return -1;
22564 else
22566 int l;
22568 /* Simple case, already have the full-name
22569 * Nearly always shorter, so try first time. */
22570 l = *fnamelen;
22571 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22572 return -1;
22574 if (l == 0)
22576 /* Couldn't find the filename.. search the paths.
22578 l = *fnamelen;
22579 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22580 return -1;
22582 *fnamelen = l;
22585 #endif /* WIN3264 */
22587 /* ":t" - tail, just the basename */
22588 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22590 *usedlen += 2;
22591 *fnamelen -= (int)(tail - *fnamep);
22592 *fnamep = tail;
22595 /* ":e" - extension, can be repeated */
22596 /* ":r" - root, without extension, can be repeated */
22597 while (src[*usedlen] == ':'
22598 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22600 /* find a '.' in the tail:
22601 * - for second :e: before the current fname
22602 * - otherwise: The last '.'
22604 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22605 s = *fnamep - 2;
22606 else
22607 s = *fnamep + *fnamelen - 1;
22608 for ( ; s > tail; --s)
22609 if (s[0] == '.')
22610 break;
22611 if (src[*usedlen + 1] == 'e') /* :e */
22613 if (s > tail)
22615 *fnamelen += (int)(*fnamep - (s + 1));
22616 *fnamep = s + 1;
22617 #ifdef VMS
22618 /* cut version from the extension */
22619 s = *fnamep + *fnamelen - 1;
22620 for ( ; s > *fnamep; --s)
22621 if (s[0] == ';')
22622 break;
22623 if (s > *fnamep)
22624 *fnamelen = s - *fnamep;
22625 #endif
22627 else if (*fnamep <= tail)
22628 *fnamelen = 0;
22630 else /* :r */
22632 if (s > tail) /* remove one extension */
22633 *fnamelen = (int)(s - *fnamep);
22635 *usedlen += 2;
22638 /* ":s?pat?foo?" - substitute */
22639 /* ":gs?pat?foo?" - global substitute */
22640 if (src[*usedlen] == ':'
22641 && (src[*usedlen + 1] == 's'
22642 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22644 char_u *str;
22645 char_u *pat;
22646 char_u *sub;
22647 int sep;
22648 char_u *flags;
22649 int didit = FALSE;
22651 flags = (char_u *)"";
22652 s = src + *usedlen + 2;
22653 if (src[*usedlen + 1] == 'g')
22655 flags = (char_u *)"g";
22656 ++s;
22659 sep = *s++;
22660 if (sep)
22662 /* find end of pattern */
22663 p = vim_strchr(s, sep);
22664 if (p != NULL)
22666 pat = vim_strnsave(s, (int)(p - s));
22667 if (pat != NULL)
22669 s = p + 1;
22670 /* find end of substitution */
22671 p = vim_strchr(s, sep);
22672 if (p != NULL)
22674 sub = vim_strnsave(s, (int)(p - s));
22675 str = vim_strnsave(*fnamep, *fnamelen);
22676 if (sub != NULL && str != NULL)
22678 *usedlen = (int)(p + 1 - src);
22679 s = do_string_sub(str, pat, sub, flags);
22680 if (s != NULL)
22682 *fnamep = s;
22683 *fnamelen = (int)STRLEN(s);
22684 vim_free(*bufp);
22685 *bufp = s;
22686 didit = TRUE;
22689 vim_free(sub);
22690 vim_free(str);
22692 vim_free(pat);
22695 /* after using ":s", repeat all the modifiers */
22696 if (didit)
22697 goto repeat;
22701 return valid;
22705 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22706 * "flags" can be "g" to do a global substitute.
22707 * Returns an allocated string, NULL for error.
22709 char_u *
22710 do_string_sub(str, pat, sub, flags)
22711 char_u *str;
22712 char_u *pat;
22713 char_u *sub;
22714 char_u *flags;
22716 int sublen;
22717 regmatch_T regmatch;
22718 int i;
22719 int do_all;
22720 char_u *tail;
22721 garray_T ga;
22722 char_u *ret;
22723 char_u *save_cpo;
22725 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22726 save_cpo = p_cpo;
22727 p_cpo = empty_option;
22729 ga_init2(&ga, 1, 200);
22731 do_all = (flags[0] == 'g');
22733 regmatch.rm_ic = p_ic;
22734 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22735 if (regmatch.regprog != NULL)
22737 tail = str;
22738 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22741 * Get some space for a temporary buffer to do the substitution
22742 * into. It will contain:
22743 * - The text up to where the match is.
22744 * - The substituted text.
22745 * - The text after the match.
22747 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22748 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22749 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22751 ga_clear(&ga);
22752 break;
22755 /* copy the text up to where the match is */
22756 i = (int)(regmatch.startp[0] - tail);
22757 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22758 /* add the substituted text */
22759 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22760 + ga.ga_len + i, TRUE, TRUE, FALSE);
22761 ga.ga_len += i + sublen - 1;
22762 /* avoid getting stuck on a match with an empty string */
22763 if (tail == regmatch.endp[0])
22765 if (*tail == NUL)
22766 break;
22767 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22768 ++ga.ga_len;
22770 else
22772 tail = regmatch.endp[0];
22773 if (*tail == NUL)
22774 break;
22776 if (!do_all)
22777 break;
22780 if (ga.ga_data != NULL)
22781 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22783 vim_free(regmatch.regprog);
22786 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22787 ga_clear(&ga);
22788 if (p_cpo == empty_option)
22789 p_cpo = save_cpo;
22790 else
22791 /* Darn, evaluating {sub} expression changed the value. */
22792 free_string_option(save_cpo);
22794 return ret;
22797 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */