Merge branch 'vim' into feat/float-point-ext
[vim_extended.git] / src / eval.c
blob9691d40b18e7222fa049ba96a0352f9e4ddef6e8
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));
478 /* Below are the 10 added FP functions - I've kept them together */
479 /* here and in their definitions later on. Because the functions[] */
480 /* table must be in ASCII order, they are scattered there - WJMc */
482 static void f_acos __ARGS((typval_T *argvars, typval_T *rettv));
483 static void f_asin __ARGS((typval_T *argvars, typval_T *rettv));
484 static void f_atan2 __ARGS((typval_T *argvars, typval_T *rettv)); /* 2 args */
485 static void f_cosh __ARGS((typval_T *argvars, typval_T *rettv));
486 static void f_exp __ARGS((typval_T *argvars, typval_T *rettv));
487 static void f_fmod __ARGS((typval_T *argvars, typval_T *rettv)); /* 2 args */
488 static void f_log __ARGS((typval_T *argvars, typval_T *rettv));
489 static void f_sinh __ARGS((typval_T *argvars, typval_T *rettv));
490 static void f_tan __ARGS((typval_T *argvars, typval_T *rettv));
491 static void f_tanh __ARGS((typval_T *argvars, typval_T *rettv));
492 #endif
493 static void f_add __ARGS((typval_T *argvars, typval_T *rettv));
494 static void f_append __ARGS((typval_T *argvars, typval_T *rettv));
495 static void f_argc __ARGS((typval_T *argvars, typval_T *rettv));
496 static void f_argidx __ARGS((typval_T *argvars, typval_T *rettv));
497 static void f_argv __ARGS((typval_T *argvars, typval_T *rettv));
498 #ifdef FEAT_FLOAT
499 static void f_atan __ARGS((typval_T *argvars, typval_T *rettv));
500 #endif
501 static void f_browse __ARGS((typval_T *argvars, typval_T *rettv));
502 static void f_browsedir __ARGS((typval_T *argvars, typval_T *rettv));
503 static void f_bufexists __ARGS((typval_T *argvars, typval_T *rettv));
504 static void f_buflisted __ARGS((typval_T *argvars, typval_T *rettv));
505 static void f_bufloaded __ARGS((typval_T *argvars, typval_T *rettv));
506 static void f_bufname __ARGS((typval_T *argvars, typval_T *rettv));
507 static void f_bufnr __ARGS((typval_T *argvars, typval_T *rettv));
508 static void f_bufwinnr __ARGS((typval_T *argvars, typval_T *rettv));
509 static void f_byte2line __ARGS((typval_T *argvars, typval_T *rettv));
510 static void f_byteidx __ARGS((typval_T *argvars, typval_T *rettv));
511 static void f_call __ARGS((typval_T *argvars, typval_T *rettv));
512 #ifdef FEAT_FLOAT
513 static void f_ceil __ARGS((typval_T *argvars, typval_T *rettv));
514 #endif
515 static void f_changenr __ARGS((typval_T *argvars, typval_T *rettv));
516 static void f_char2nr __ARGS((typval_T *argvars, typval_T *rettv));
517 static void f_cindent __ARGS((typval_T *argvars, typval_T *rettv));
518 static void f_clearmatches __ARGS((typval_T *argvars, typval_T *rettv));
519 static void f_col __ARGS((typval_T *argvars, typval_T *rettv));
520 #if defined(FEAT_INS_EXPAND)
521 static void f_complete __ARGS((typval_T *argvars, typval_T *rettv));
522 static void f_complete_add __ARGS((typval_T *argvars, typval_T *rettv));
523 static void f_complete_check __ARGS((typval_T *argvars, typval_T *rettv));
524 #endif
525 static void f_confirm __ARGS((typval_T *argvars, typval_T *rettv));
526 static void f_copy __ARGS((typval_T *argvars, typval_T *rettv));
527 #ifdef FEAT_FLOAT
528 static void f_cos __ARGS((typval_T *argvars, typval_T *rettv));
529 #endif
530 static void f_count __ARGS((typval_T *argvars, typval_T *rettv));
531 static void f_cscope_connection __ARGS((typval_T *argvars, typval_T *rettv));
532 static void f_cursor __ARGS((typval_T *argsvars, typval_T *rettv));
533 static void f_deepcopy __ARGS((typval_T *argvars, typval_T *rettv));
534 static void f_delete __ARGS((typval_T *argvars, typval_T *rettv));
535 static void f_did_filetype __ARGS((typval_T *argvars, typval_T *rettv));
536 static void f_diff_filler __ARGS((typval_T *argvars, typval_T *rettv));
537 static void f_diff_hlID __ARGS((typval_T *argvars, typval_T *rettv));
538 static void f_empty __ARGS((typval_T *argvars, typval_T *rettv));
539 static void f_escape __ARGS((typval_T *argvars, typval_T *rettv));
540 static void f_eval __ARGS((typval_T *argvars, typval_T *rettv));
541 static void f_eventhandler __ARGS((typval_T *argvars, typval_T *rettv));
542 static void f_executable __ARGS((typval_T *argvars, typval_T *rettv));
543 static void f_exists __ARGS((typval_T *argvars, typval_T *rettv));
544 static void f_expand __ARGS((typval_T *argvars, typval_T *rettv));
545 static void f_extend __ARGS((typval_T *argvars, typval_T *rettv));
546 static void f_feedkeys __ARGS((typval_T *argvars, typval_T *rettv));
547 static void f_filereadable __ARGS((typval_T *argvars, typval_T *rettv));
548 static void f_filewritable __ARGS((typval_T *argvars, typval_T *rettv));
549 static void f_filter __ARGS((typval_T *argvars, typval_T *rettv));
550 static void f_finddir __ARGS((typval_T *argvars, typval_T *rettv));
551 static void f_findfile __ARGS((typval_T *argvars, typval_T *rettv));
552 #ifdef FEAT_FLOAT
553 static void f_float2nr __ARGS((typval_T *argvars, typval_T *rettv));
554 static void f_floor __ARGS((typval_T *argvars, typval_T *rettv));
555 #endif
556 static void f_fnameescape __ARGS((typval_T *argvars, typval_T *rettv));
557 static void f_fnamemodify __ARGS((typval_T *argvars, typval_T *rettv));
558 static void f_foldclosed __ARGS((typval_T *argvars, typval_T *rettv));
559 static void f_foldclosedend __ARGS((typval_T *argvars, typval_T *rettv));
560 static void f_foldlevel __ARGS((typval_T *argvars, typval_T *rettv));
561 static void f_foldtext __ARGS((typval_T *argvars, typval_T *rettv));
562 static void f_foldtextresult __ARGS((typval_T *argvars, typval_T *rettv));
563 static void f_foreground __ARGS((typval_T *argvars, typval_T *rettv));
564 static void f_function __ARGS((typval_T *argvars, typval_T *rettv));
565 static void f_garbagecollect __ARGS((typval_T *argvars, typval_T *rettv));
566 static void f_get __ARGS((typval_T *argvars, typval_T *rettv));
567 static void f_getbufline __ARGS((typval_T *argvars, typval_T *rettv));
568 static void f_getbufvar __ARGS((typval_T *argvars, typval_T *rettv));
569 static void f_getchar __ARGS((typval_T *argvars, typval_T *rettv));
570 static void f_getcharmod __ARGS((typval_T *argvars, typval_T *rettv));
571 static void f_getcmdline __ARGS((typval_T *argvars, typval_T *rettv));
572 static void f_getcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
573 static void f_getcmdtype __ARGS((typval_T *argvars, typval_T *rettv));
574 static void f_getcwd __ARGS((typval_T *argvars, typval_T *rettv));
575 static void f_getfontname __ARGS((typval_T *argvars, typval_T *rettv));
576 static void f_getfperm __ARGS((typval_T *argvars, typval_T *rettv));
577 static void f_getfsize __ARGS((typval_T *argvars, typval_T *rettv));
578 static void f_getftime __ARGS((typval_T *argvars, typval_T *rettv));
579 static void f_getftype __ARGS((typval_T *argvars, typval_T *rettv));
580 static void f_getline __ARGS((typval_T *argvars, typval_T *rettv));
581 static void f_getmatches __ARGS((typval_T *argvars, typval_T *rettv));
582 static void f_getpid __ARGS((typval_T *argvars, typval_T *rettv));
583 static void f_getpos __ARGS((typval_T *argvars, typval_T *rettv));
584 static void f_getqflist __ARGS((typval_T *argvars, typval_T *rettv));
585 static void f_getreg __ARGS((typval_T *argvars, typval_T *rettv));
586 static void f_getregtype __ARGS((typval_T *argvars, typval_T *rettv));
587 static void f_gettabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
588 static void f_getwinposx __ARGS((typval_T *argvars, typval_T *rettv));
589 static void f_getwinposy __ARGS((typval_T *argvars, typval_T *rettv));
590 static void f_getwinvar __ARGS((typval_T *argvars, typval_T *rettv));
591 static void f_glob __ARGS((typval_T *argvars, typval_T *rettv));
592 static void f_globpath __ARGS((typval_T *argvars, typval_T *rettv));
593 static void f_has __ARGS((typval_T *argvars, typval_T *rettv));
594 static void f_has_key __ARGS((typval_T *argvars, typval_T *rettv));
595 static void f_haslocaldir __ARGS((typval_T *argvars, typval_T *rettv));
596 static void f_hasmapto __ARGS((typval_T *argvars, typval_T *rettv));
597 static void f_histadd __ARGS((typval_T *argvars, typval_T *rettv));
598 static void f_histdel __ARGS((typval_T *argvars, typval_T *rettv));
599 static void f_histget __ARGS((typval_T *argvars, typval_T *rettv));
600 static void f_histnr __ARGS((typval_T *argvars, typval_T *rettv));
601 static void f_hlID __ARGS((typval_T *argvars, typval_T *rettv));
602 static void f_hlexists __ARGS((typval_T *argvars, typval_T *rettv));
603 static void f_hostname __ARGS((typval_T *argvars, typval_T *rettv));
604 static void f_iconv __ARGS((typval_T *argvars, typval_T *rettv));
605 static void f_indent __ARGS((typval_T *argvars, typval_T *rettv));
606 static void f_index __ARGS((typval_T *argvars, typval_T *rettv));
607 static void f_input __ARGS((typval_T *argvars, typval_T *rettv));
608 static void f_inputdialog __ARGS((typval_T *argvars, typval_T *rettv));
609 static void f_inputlist __ARGS((typval_T *argvars, typval_T *rettv));
610 static void f_inputrestore __ARGS((typval_T *argvars, typval_T *rettv));
611 static void f_inputsave __ARGS((typval_T *argvars, typval_T *rettv));
612 static void f_inputsecret __ARGS((typval_T *argvars, typval_T *rettv));
613 static void f_insert __ARGS((typval_T *argvars, typval_T *rettv));
614 static void f_isdirectory __ARGS((typval_T *argvars, typval_T *rettv));
615 static void f_islocked __ARGS((typval_T *argvars, typval_T *rettv));
616 static void f_items __ARGS((typval_T *argvars, typval_T *rettv));
617 static void f_join __ARGS((typval_T *argvars, typval_T *rettv));
618 static void f_keys __ARGS((typval_T *argvars, typval_T *rettv));
619 static void f_last_buffer_nr __ARGS((typval_T *argvars, typval_T *rettv));
620 static void f_len __ARGS((typval_T *argvars, typval_T *rettv));
621 static void f_libcall __ARGS((typval_T *argvars, typval_T *rettv));
622 static void f_libcallnr __ARGS((typval_T *argvars, typval_T *rettv));
623 static void f_line __ARGS((typval_T *argvars, typval_T *rettv));
624 static void f_line2byte __ARGS((typval_T *argvars, typval_T *rettv));
625 static void f_lispindent __ARGS((typval_T *argvars, typval_T *rettv));
626 static void f_localtime __ARGS((typval_T *argvars, typval_T *rettv));
627 #ifdef FEAT_FLOAT
628 static void f_log10 __ARGS((typval_T *argvars, typval_T *rettv));
629 #endif
630 static void f_map __ARGS((typval_T *argvars, typval_T *rettv));
631 static void f_maparg __ARGS((typval_T *argvars, typval_T *rettv));
632 static void f_mapcheck __ARGS((typval_T *argvars, typval_T *rettv));
633 static void f_match __ARGS((typval_T *argvars, typval_T *rettv));
634 static void f_matchadd __ARGS((typval_T *argvars, typval_T *rettv));
635 static void f_matcharg __ARGS((typval_T *argvars, typval_T *rettv));
636 static void f_matchdelete __ARGS((typval_T *argvars, typval_T *rettv));
637 static void f_matchend __ARGS((typval_T *argvars, typval_T *rettv));
638 static void f_matchlist __ARGS((typval_T *argvars, typval_T *rettv));
639 static void f_matchstr __ARGS((typval_T *argvars, typval_T *rettv));
640 static void f_max __ARGS((typval_T *argvars, typval_T *rettv));
641 static void f_min __ARGS((typval_T *argvars, typval_T *rettv));
642 #ifdef vim_mkdir
643 static void f_mkdir __ARGS((typval_T *argvars, typval_T *rettv));
644 #endif
645 static void f_mode __ARGS((typval_T *argvars, typval_T *rettv));
646 static void f_nextnonblank __ARGS((typval_T *argvars, typval_T *rettv));
647 static void f_nr2char __ARGS((typval_T *argvars, typval_T *rettv));
648 static void f_pathshorten __ARGS((typval_T *argvars, typval_T *rettv));
649 #ifdef FEAT_FLOAT
650 static void f_pow __ARGS((typval_T *argvars, typval_T *rettv));
651 #endif
652 static void f_prevnonblank __ARGS((typval_T *argvars, typval_T *rettv));
653 static void f_printf __ARGS((typval_T *argvars, typval_T *rettv));
654 static void f_pumvisible __ARGS((typval_T *argvars, typval_T *rettv));
655 static void f_range __ARGS((typval_T *argvars, typval_T *rettv));
656 static void f_readfile __ARGS((typval_T *argvars, typval_T *rettv));
657 static void f_reltime __ARGS((typval_T *argvars, typval_T *rettv));
658 static void f_reltimestr __ARGS((typval_T *argvars, typval_T *rettv));
659 static void f_remote_expr __ARGS((typval_T *argvars, typval_T *rettv));
660 static void f_remote_foreground __ARGS((typval_T *argvars, typval_T *rettv));
661 static void f_remote_peek __ARGS((typval_T *argvars, typval_T *rettv));
662 static void f_remote_read __ARGS((typval_T *argvars, typval_T *rettv));
663 static void f_remote_send __ARGS((typval_T *argvars, typval_T *rettv));
664 static void f_remove __ARGS((typval_T *argvars, typval_T *rettv));
665 static void f_rename __ARGS((typval_T *argvars, typval_T *rettv));
666 static void f_repeat __ARGS((typval_T *argvars, typval_T *rettv));
667 static void f_resolve __ARGS((typval_T *argvars, typval_T *rettv));
668 static void f_reverse __ARGS((typval_T *argvars, typval_T *rettv));
669 #ifdef FEAT_FLOAT
670 static void f_round __ARGS((typval_T *argvars, typval_T *rettv));
671 #endif
672 static void f_search __ARGS((typval_T *argvars, typval_T *rettv));
673 static void f_searchdecl __ARGS((typval_T *argvars, typval_T *rettv));
674 static void f_searchpair __ARGS((typval_T *argvars, typval_T *rettv));
675 static void f_searchpairpos __ARGS((typval_T *argvars, typval_T *rettv));
676 static void f_searchpos __ARGS((typval_T *argvars, typval_T *rettv));
677 static void f_server2client __ARGS((typval_T *argvars, typval_T *rettv));
678 static void f_serverlist __ARGS((typval_T *argvars, typval_T *rettv));
679 static void f_setbufvar __ARGS((typval_T *argvars, typval_T *rettv));
680 static void f_setcmdpos __ARGS((typval_T *argvars, typval_T *rettv));
681 static void f_setline __ARGS((typval_T *argvars, typval_T *rettv));
682 static void f_setloclist __ARGS((typval_T *argvars, typval_T *rettv));
683 static void f_setmatches __ARGS((typval_T *argvars, typval_T *rettv));
684 static void f_setpos __ARGS((typval_T *argvars, typval_T *rettv));
685 static void f_setqflist __ARGS((typval_T *argvars, typval_T *rettv));
686 static void f_setreg __ARGS((typval_T *argvars, typval_T *rettv));
687 static void f_settabwinvar __ARGS((typval_T *argvars, typval_T *rettv));
688 static void f_setwinvar __ARGS((typval_T *argvars, typval_T *rettv));
689 static void f_shellescape __ARGS((typval_T *argvars, typval_T *rettv));
690 static void f_simplify __ARGS((typval_T *argvars, typval_T *rettv));
691 #ifdef FEAT_FLOAT
692 static void f_sin __ARGS((typval_T *argvars, typval_T *rettv));
693 #endif
694 static void f_sort __ARGS((typval_T *argvars, typval_T *rettv));
695 static void f_soundfold __ARGS((typval_T *argvars, typval_T *rettv));
696 static void f_spellbadword __ARGS((typval_T *argvars, typval_T *rettv));
697 static void f_spellsuggest __ARGS((typval_T *argvars, typval_T *rettv));
698 static void f_split __ARGS((typval_T *argvars, typval_T *rettv));
699 #ifdef FEAT_FLOAT
700 static void f_sqrt __ARGS((typval_T *argvars, typval_T *rettv));
701 static void f_str2float __ARGS((typval_T *argvars, typval_T *rettv));
702 #endif
703 static void f_str2nr __ARGS((typval_T *argvars, typval_T *rettv));
704 #ifdef HAVE_STRFTIME
705 static void f_strftime __ARGS((typval_T *argvars, typval_T *rettv));
706 #endif
707 static void f_stridx __ARGS((typval_T *argvars, typval_T *rettv));
708 static void f_string __ARGS((typval_T *argvars, typval_T *rettv));
709 static void f_strlen __ARGS((typval_T *argvars, typval_T *rettv));
710 static void f_strpart __ARGS((typval_T *argvars, typval_T *rettv));
711 static void f_strridx __ARGS((typval_T *argvars, typval_T *rettv));
712 static void f_strtrans __ARGS((typval_T *argvars, typval_T *rettv));
713 static void f_submatch __ARGS((typval_T *argvars, typval_T *rettv));
714 static void f_substitute __ARGS((typval_T *argvars, typval_T *rettv));
715 static void f_synID __ARGS((typval_T *argvars, typval_T *rettv));
716 static void f_synIDattr __ARGS((typval_T *argvars, typval_T *rettv));
717 static void f_synIDtrans __ARGS((typval_T *argvars, typval_T *rettv));
718 static void f_synstack __ARGS((typval_T *argvars, typval_T *rettv));
719 static void f_system __ARGS((typval_T *argvars, typval_T *rettv));
720 static void f_tabpagebuflist __ARGS((typval_T *argvars, typval_T *rettv));
721 static void f_tabpagenr __ARGS((typval_T *argvars, typval_T *rettv));
722 static void f_tabpagewinnr __ARGS((typval_T *argvars, typval_T *rettv));
723 static void f_taglist __ARGS((typval_T *argvars, typval_T *rettv));
724 static void f_tagfiles __ARGS((typval_T *argvars, typval_T *rettv));
725 static void f_tempname __ARGS((typval_T *argvars, typval_T *rettv));
726 static void f_test __ARGS((typval_T *argvars, typval_T *rettv));
727 static void f_tolower __ARGS((typval_T *argvars, typval_T *rettv));
728 static void f_toupper __ARGS((typval_T *argvars, typval_T *rettv));
729 static void f_tr __ARGS((typval_T *argvars, typval_T *rettv));
730 #ifdef FEAT_FLOAT
731 static void f_trunc __ARGS((typval_T *argvars, typval_T *rettv));
732 #endif
733 static void f_type __ARGS((typval_T *argvars, typval_T *rettv));
734 static void f_values __ARGS((typval_T *argvars, typval_T *rettv));
735 static void f_virtcol __ARGS((typval_T *argvars, typval_T *rettv));
736 static void f_visualmode __ARGS((typval_T *argvars, typval_T *rettv));
737 static void f_winbufnr __ARGS((typval_T *argvars, typval_T *rettv));
738 static void f_wincol __ARGS((typval_T *argvars, typval_T *rettv));
739 static void f_winheight __ARGS((typval_T *argvars, typval_T *rettv));
740 static void f_winline __ARGS((typval_T *argvars, typval_T *rettv));
741 static void f_winnr __ARGS((typval_T *argvars, typval_T *rettv));
742 static void f_winrestcmd __ARGS((typval_T *argvars, typval_T *rettv));
743 static void f_winrestview __ARGS((typval_T *argvars, typval_T *rettv));
744 static void f_winsaveview __ARGS((typval_T *argvars, typval_T *rettv));
745 static void f_winwidth __ARGS((typval_T *argvars, typval_T *rettv));
746 static void f_writefile __ARGS((typval_T *argvars, typval_T *rettv));
748 static int list2fpos __ARGS((typval_T *arg, pos_T *posp, int *fnump));
749 static pos_T *var2fpos __ARGS((typval_T *varp, int dollar_lnum, int *fnum));
750 static int get_env_len __ARGS((char_u **arg));
751 static int get_id_len __ARGS((char_u **arg));
752 static int get_name_len __ARGS((char_u **arg, char_u **alias, int evaluate, int verbose));
753 static char_u *find_name_end __ARGS((char_u *arg, char_u **expr_start, char_u **expr_end, int flags));
754 #define FNE_INCL_BR 1 /* find_name_end(): include [] in name */
755 #define FNE_CHECK_START 2 /* find_name_end(): check name starts with
756 valid character */
757 static char_u * make_expanded_name __ARGS((char_u *in_start, char_u *expr_start, char_u *expr_end, char_u *in_end));
758 static int eval_isnamec __ARGS((int c));
759 static int eval_isnamec1 __ARGS((int c));
760 static int get_var_tv __ARGS((char_u *name, int len, typval_T *rettv, int verbose));
761 static int handle_subscript __ARGS((char_u **arg, typval_T *rettv, int evaluate, int verbose));
762 static typval_T *alloc_tv __ARGS((void));
763 static typval_T *alloc_string_tv __ARGS((char_u *string));
764 static void init_tv __ARGS((typval_T *varp));
765 static long get_tv_number __ARGS((typval_T *varp));
766 static linenr_T get_tv_lnum __ARGS((typval_T *argvars));
767 static linenr_T get_tv_lnum_buf __ARGS((typval_T *argvars, buf_T *buf));
768 static char_u *get_tv_string __ARGS((typval_T *varp));
769 static char_u *get_tv_string_buf __ARGS((typval_T *varp, char_u *buf));
770 static char_u *get_tv_string_buf_chk __ARGS((typval_T *varp, char_u *buf));
771 static dictitem_T *find_var __ARGS((char_u *name, hashtab_T **htp));
772 static dictitem_T *find_var_in_ht __ARGS((hashtab_T *ht, char_u *varname, int writing));
773 static hashtab_T *find_var_ht __ARGS((char_u *name, char_u **varname));
774 static void vars_clear_ext __ARGS((hashtab_T *ht, int free_val));
775 static void delete_var __ARGS((hashtab_T *ht, hashitem_T *hi));
776 static void list_one_var __ARGS((dictitem_T *v, char_u *prefix, int *first));
777 static void list_one_var_a __ARGS((char_u *prefix, char_u *name, int type, char_u *string, int *first));
778 static void set_var __ARGS((char_u *name, typval_T *varp, int copy));
779 static int var_check_ro __ARGS((int flags, char_u *name));
780 static int var_check_fixed __ARGS((int flags, char_u *name));
781 static int tv_check_lock __ARGS((int lock, char_u *name));
782 static void copy_tv __ARGS((typval_T *from, typval_T *to));
783 static int item_copy __ARGS((typval_T *from, typval_T *to, int deep, int copyID));
784 static char_u *find_option_end __ARGS((char_u **arg, int *opt_flags));
785 static char_u *trans_function_name __ARGS((char_u **pp, int skip, int flags, funcdict_T *fd));
786 static int eval_fname_script __ARGS((char_u *p));
787 static int eval_fname_sid __ARGS((char_u *p));
788 static void list_func_head __ARGS((ufunc_T *fp, int indent));
789 static ufunc_T *find_func __ARGS((char_u *name));
790 static int function_exists __ARGS((char_u *name));
791 static int builtin_function __ARGS((char_u *name));
792 #ifdef FEAT_PROFILE
793 static void func_do_profile __ARGS((ufunc_T *fp));
794 static void prof_sort_list __ARGS((FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self));
795 static void prof_func_line __ARGS((FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self));
796 static int
797 # ifdef __BORLANDC__
798 _RTLENTRYF
799 # endif
800 prof_total_cmp __ARGS((const void *s1, const void *s2));
801 static int
802 # ifdef __BORLANDC__
803 _RTLENTRYF
804 # endif
805 prof_self_cmp __ARGS((const void *s1, const void *s2));
806 #endif
807 static int script_autoload __ARGS((char_u *name, int reload));
808 static char_u *autoload_name __ARGS((char_u *name));
809 static void cat_func_name __ARGS((char_u *buf, ufunc_T *fp));
810 static void func_free __ARGS((ufunc_T *fp));
811 static void func_unref __ARGS((char_u *name));
812 static void func_ref __ARGS((char_u *name));
813 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));
814 static int can_free_funccal __ARGS((funccall_T *fc, int copyID)) ;
815 static void free_funccal __ARGS((funccall_T *fc, int free_val));
816 static void add_nr_var __ARGS((dict_T *dp, dictitem_T *v, char *name, varnumber_T nr));
817 static win_T *find_win_by_nr __ARGS((typval_T *vp, tabpage_T *tp));
818 static void getwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
819 static int searchpair_cmn __ARGS((typval_T *argvars, pos_T *match_pos));
820 static int search_cmn __ARGS((typval_T *argvars, pos_T *match_pos, int *flagsp));
821 static void setwinvar __ARGS((typval_T *argvars, typval_T *rettv, int off));
823 /* Character used as separated in autoload function/variable names. */
824 #define AUTOLOAD_CHAR '#'
827 * Initialize the global and v: variables.
829 void
830 eval_init()
832 int i;
833 struct vimvar *p;
835 init_var_dict(&globvardict, &globvars_var);
836 init_var_dict(&vimvardict, &vimvars_var);
837 hash_init(&compat_hashtab);
838 hash_init(&func_hashtab);
840 for (i = 0; i < VV_LEN; ++i)
842 p = &vimvars[i];
843 STRCPY(p->vv_di.di_key, p->vv_name);
844 if (p->vv_flags & VV_RO)
845 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
846 else if (p->vv_flags & VV_RO_SBX)
847 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
848 else
849 p->vv_di.di_flags = DI_FLAGS_FIX;
851 /* add to v: scope dict, unless the value is not always available */
852 if (p->vv_type != VAR_UNKNOWN)
853 hash_add(&vimvarht, p->vv_di.di_key);
854 if (p->vv_flags & VV_COMPAT)
855 /* add to compat scope dict */
856 hash_add(&compat_hashtab, p->vv_di.di_key);
858 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
861 #if defined(EXITFREE) || defined(PROTO)
862 void
863 eval_clear()
865 int i;
866 struct vimvar *p;
868 for (i = 0; i < VV_LEN; ++i)
870 p = &vimvars[i];
871 if (p->vv_di.di_tv.v_type == VAR_STRING)
873 vim_free(p->vv_str);
874 p->vv_str = NULL;
876 else if (p->vv_di.di_tv.v_type == VAR_LIST)
878 list_unref(p->vv_list);
879 p->vv_list = NULL;
882 hash_clear(&vimvarht);
883 hash_init(&vimvarht); /* garbage_collect() will access it */
884 hash_clear(&compat_hashtab);
886 /* script-local variables */
887 for (i = 1; i <= ga_scripts.ga_len; ++i)
888 vars_clear(&SCRIPT_VARS(i));
889 ga_clear(&ga_scripts);
890 free_scriptnames();
892 /* global variables */
893 vars_clear(&globvarht);
895 /* autoloaded script names */
896 ga_clear_strings(&ga_loaded);
898 /* unreferenced lists and dicts */
899 (void)garbage_collect();
901 /* functions */
902 free_all_functions();
903 hash_clear(&func_hashtab);
905 #endif
908 * Return the name of the executed function.
910 char_u *
911 func_name(cookie)
912 void *cookie;
914 return ((funccall_T *)cookie)->func->uf_name;
918 * Return the address holding the next breakpoint line for a funccall cookie.
920 linenr_T *
921 func_breakpoint(cookie)
922 void *cookie;
924 return &((funccall_T *)cookie)->breakpoint;
928 * Return the address holding the debug tick for a funccall cookie.
930 int *
931 func_dbg_tick(cookie)
932 void *cookie;
934 return &((funccall_T *)cookie)->dbg_tick;
938 * Return the nesting level for a funccall cookie.
941 func_level(cookie)
942 void *cookie;
944 return ((funccall_T *)cookie)->level;
947 /* pointer to funccal for currently active function */
948 funccall_T *current_funccal = NULL;
950 /* pointer to list of previously used funccal, still around because some
951 * item in it is still being used. */
952 funccall_T *previous_funccal = NULL;
955 * Return TRUE when a function was ended by a ":return" command.
958 current_func_returned()
960 return current_funccal->returned;
965 * Set an internal variable to a string value. Creates the variable if it does
966 * not already exist.
968 void
969 set_internal_string_var(name, value)
970 char_u *name;
971 char_u *value;
973 char_u *val;
974 typval_T *tvp;
976 val = vim_strsave(value);
977 if (val != NULL)
979 tvp = alloc_string_tv(val);
980 if (tvp != NULL)
982 set_var(name, tvp, FALSE);
983 free_tv(tvp);
988 static lval_T *redir_lval = NULL;
989 static garray_T redir_ga; /* only valid when redir_lval is not NULL */
990 static char_u *redir_endp = NULL;
991 static char_u *redir_varname = NULL;
994 * Start recording command output to a variable
995 * Returns OK if successfully completed the setup. FAIL otherwise.
998 var_redir_start(name, append)
999 char_u *name;
1000 int append; /* append to an existing variable */
1002 int save_emsg;
1003 int err;
1004 typval_T tv;
1006 /* Catch a bad name early. */
1007 if (!eval_isnamec1(*name))
1009 EMSG(_(e_invarg));
1010 return FAIL;
1013 /* Make a copy of the name, it is used in redir_lval until redir ends. */
1014 redir_varname = vim_strsave(name);
1015 if (redir_varname == NULL)
1016 return FAIL;
1018 redir_lval = (lval_T *)alloc_clear((unsigned)sizeof(lval_T));
1019 if (redir_lval == NULL)
1021 var_redir_stop();
1022 return FAIL;
1025 /* The output is stored in growarray "redir_ga" until redirection ends. */
1026 ga_init2(&redir_ga, (int)sizeof(char), 500);
1028 /* Parse the variable name (can be a dict or list entry). */
1029 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, FALSE,
1030 FNE_CHECK_START);
1031 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
1033 if (redir_endp != NULL && *redir_endp != NUL)
1034 /* Trailing characters are present after the variable name */
1035 EMSG(_(e_trailing));
1036 else
1037 EMSG(_(e_invarg));
1038 redir_endp = NULL; /* don't store a value, only cleanup */
1039 var_redir_stop();
1040 return FAIL;
1043 /* check if we can write to the variable: set it to or append an empty
1044 * string */
1045 save_emsg = did_emsg;
1046 did_emsg = FALSE;
1047 tv.v_type = VAR_STRING;
1048 tv.vval.v_string = (char_u *)"";
1049 if (append)
1050 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)".");
1051 else
1052 set_var_lval(redir_lval, redir_endp, &tv, TRUE, (char_u *)"=");
1053 err = did_emsg;
1054 did_emsg |= save_emsg;
1055 if (err)
1057 redir_endp = NULL; /* don't store a value, only cleanup */
1058 var_redir_stop();
1059 return FAIL;
1061 if (redir_lval->ll_newkey != NULL)
1063 /* Dictionary item was created, don't do it again. */
1064 vim_free(redir_lval->ll_newkey);
1065 redir_lval->ll_newkey = NULL;
1068 return OK;
1072 * Append "value[value_len]" to the variable set by var_redir_start().
1073 * The actual appending is postponed until redirection ends, because the value
1074 * appended may in fact be the string we write to, changing it may cause freed
1075 * memory to be used:
1076 * :redir => foo
1077 * :let foo
1078 * :redir END
1080 void
1081 var_redir_str(value, value_len)
1082 char_u *value;
1083 int value_len;
1085 int len;
1087 if (redir_lval == NULL)
1088 return;
1090 if (value_len == -1)
1091 len = (int)STRLEN(value); /* Append the entire string */
1092 else
1093 len = value_len; /* Append only "value_len" characters */
1095 if (ga_grow(&redir_ga, len) == OK)
1097 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
1098 redir_ga.ga_len += len;
1100 else
1101 var_redir_stop();
1105 * Stop redirecting command output to a variable.
1106 * Frees the allocated memory.
1108 void
1109 var_redir_stop()
1111 typval_T tv;
1113 if (redir_lval != NULL)
1115 /* If there was no error: assign the text to the variable. */
1116 if (redir_endp != NULL)
1118 ga_append(&redir_ga, NUL); /* Append the trailing NUL. */
1119 tv.v_type = VAR_STRING;
1120 tv.vval.v_string = redir_ga.ga_data;
1121 set_var_lval(redir_lval, redir_endp, &tv, FALSE, (char_u *)".");
1124 /* free the collected output */
1125 vim_free(redir_ga.ga_data);
1126 redir_ga.ga_data = NULL;
1128 clear_lval(redir_lval);
1129 vim_free(redir_lval);
1130 redir_lval = NULL;
1132 vim_free(redir_varname);
1133 redir_varname = NULL;
1136 # if defined(FEAT_MBYTE) || defined(PROTO)
1138 eval_charconvert(enc_from, enc_to, fname_from, fname_to)
1139 char_u *enc_from;
1140 char_u *enc_to;
1141 char_u *fname_from;
1142 char_u *fname_to;
1144 int err = FALSE;
1146 set_vim_var_string(VV_CC_FROM, enc_from, -1);
1147 set_vim_var_string(VV_CC_TO, enc_to, -1);
1148 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
1149 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
1150 if (eval_to_bool(p_ccv, &err, NULL, FALSE))
1151 err = TRUE;
1152 set_vim_var_string(VV_CC_FROM, NULL, -1);
1153 set_vim_var_string(VV_CC_TO, NULL, -1);
1154 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1155 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1157 if (err)
1158 return FAIL;
1159 return OK;
1161 # endif
1163 # if defined(FEAT_POSTSCRIPT) || defined(PROTO)
1165 eval_printexpr(fname, args)
1166 char_u *fname;
1167 char_u *args;
1169 int err = FALSE;
1171 set_vim_var_string(VV_FNAME_IN, fname, -1);
1172 set_vim_var_string(VV_CMDARG, args, -1);
1173 if (eval_to_bool(p_pexpr, &err, NULL, FALSE))
1174 err = TRUE;
1175 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1176 set_vim_var_string(VV_CMDARG, NULL, -1);
1178 if (err)
1180 mch_remove(fname);
1181 return FAIL;
1183 return OK;
1185 # endif
1187 # if defined(FEAT_DIFF) || defined(PROTO)
1188 void
1189 eval_diff(origfile, newfile, outfile)
1190 char_u *origfile;
1191 char_u *newfile;
1192 char_u *outfile;
1194 int err = FALSE;
1196 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1197 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
1198 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1199 (void)eval_to_bool(p_dex, &err, NULL, FALSE);
1200 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1201 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
1202 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1205 void
1206 eval_patch(origfile, difffile, outfile)
1207 char_u *origfile;
1208 char_u *difffile;
1209 char_u *outfile;
1211 int err;
1213 set_vim_var_string(VV_FNAME_IN, origfile, -1);
1214 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
1215 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
1216 (void)eval_to_bool(p_pex, &err, NULL, FALSE);
1217 set_vim_var_string(VV_FNAME_IN, NULL, -1);
1218 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
1219 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
1221 # endif
1224 * Top level evaluation function, returning a boolean.
1225 * Sets "error" to TRUE if there was an error.
1226 * Return TRUE or FALSE.
1229 eval_to_bool(arg, error, nextcmd, skip)
1230 char_u *arg;
1231 int *error;
1232 char_u **nextcmd;
1233 int skip; /* only parse, don't execute */
1235 typval_T tv;
1236 int retval = FALSE;
1238 if (skip)
1239 ++emsg_skip;
1240 if (eval0(arg, &tv, nextcmd, !skip) == FAIL)
1241 *error = TRUE;
1242 else
1244 *error = FALSE;
1245 if (!skip)
1247 retval = (get_tv_number_chk(&tv, error) != 0);
1248 clear_tv(&tv);
1251 if (skip)
1252 --emsg_skip;
1254 return retval;
1258 * Top level evaluation function, returning a string. If "skip" is TRUE,
1259 * only parsing to "nextcmd" is done, without reporting errors. Return
1260 * pointer to allocated memory, or NULL for failure or when "skip" is TRUE.
1262 char_u *
1263 eval_to_string_skip(arg, nextcmd, skip)
1264 char_u *arg;
1265 char_u **nextcmd;
1266 int skip; /* only parse, don't execute */
1268 typval_T tv;
1269 char_u *retval;
1271 if (skip)
1272 ++emsg_skip;
1273 if (eval0(arg, &tv, nextcmd, !skip) == FAIL || skip)
1274 retval = NULL;
1275 else
1277 retval = vim_strsave(get_tv_string(&tv));
1278 clear_tv(&tv);
1280 if (skip)
1281 --emsg_skip;
1283 return retval;
1287 * Skip over an expression at "*pp".
1288 * Return FAIL for an error, OK otherwise.
1291 skip_expr(pp)
1292 char_u **pp;
1294 typval_T rettv;
1296 *pp = skipwhite(*pp);
1297 return eval1(pp, &rettv, FALSE);
1301 * Top level evaluation function, returning a string.
1302 * When "convert" is TRUE convert a List into a sequence of lines and convert
1303 * a Float to a String.
1304 * Return pointer to allocated memory, or NULL for failure.
1306 char_u *
1307 eval_to_string(arg, nextcmd, convert)
1308 char_u *arg;
1309 char_u **nextcmd;
1310 int convert;
1312 typval_T tv;
1313 char_u *retval;
1314 garray_T ga;
1315 #ifdef FEAT_FLOAT
1316 char_u numbuf[NUMBUFLEN];
1317 #endif
1319 if (eval0(arg, &tv, nextcmd, TRUE) == FAIL)
1320 retval = NULL;
1321 else
1323 if (convert && tv.v_type == VAR_LIST)
1325 ga_init2(&ga, (int)sizeof(char), 80);
1326 if (tv.vval.v_list != NULL)
1327 list_join(&ga, tv.vval.v_list, (char_u *)"\n", TRUE, 0);
1328 ga_append(&ga, NUL);
1329 retval = (char_u *)ga.ga_data;
1331 #ifdef FEAT_FLOAT
1332 else if (convert && tv.v_type == VAR_FLOAT)
1334 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv.vval.v_float);
1335 retval = vim_strsave(numbuf);
1337 #endif
1338 else
1339 retval = vim_strsave(get_tv_string(&tv));
1340 clear_tv(&tv);
1343 return retval;
1347 * Call eval_to_string() without using current local variables and using
1348 * textlock. When "use_sandbox" is TRUE use the sandbox.
1350 char_u *
1351 eval_to_string_safe(arg, nextcmd, use_sandbox)
1352 char_u *arg;
1353 char_u **nextcmd;
1354 int use_sandbox;
1356 char_u *retval;
1357 void *save_funccalp;
1359 save_funccalp = save_funccal();
1360 if (use_sandbox)
1361 ++sandbox;
1362 ++textlock;
1363 retval = eval_to_string(arg, nextcmd, FALSE);
1364 if (use_sandbox)
1365 --sandbox;
1366 --textlock;
1367 restore_funccal(save_funccalp);
1368 return retval;
1372 * Top level evaluation function, returning a number.
1373 * Evaluates "expr" silently.
1374 * Returns -1 for an error.
1377 eval_to_number(expr)
1378 char_u *expr;
1380 typval_T rettv;
1381 int retval;
1382 char_u *p = skipwhite(expr);
1384 ++emsg_off;
1386 if (eval1(&p, &rettv, TRUE) == FAIL)
1387 retval = -1;
1388 else
1390 retval = get_tv_number_chk(&rettv, NULL);
1391 clear_tv(&rettv);
1393 --emsg_off;
1395 return retval;
1399 * Prepare v: variable "idx" to be used.
1400 * Save the current typeval in "save_tv".
1401 * When not used yet add the variable to the v: hashtable.
1403 static void
1404 prepare_vimvar(idx, save_tv)
1405 int idx;
1406 typval_T *save_tv;
1408 *save_tv = vimvars[idx].vv_tv;
1409 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1410 hash_add(&vimvarht, vimvars[idx].vv_di.di_key);
1414 * Restore v: variable "idx" to typeval "save_tv".
1415 * When no longer defined, remove the variable from the v: hashtable.
1417 static void
1418 restore_vimvar(idx, save_tv)
1419 int idx;
1420 typval_T *save_tv;
1422 hashitem_T *hi;
1424 vimvars[idx].vv_tv = *save_tv;
1425 if (vimvars[idx].vv_type == VAR_UNKNOWN)
1427 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
1428 if (HASHITEM_EMPTY(hi))
1429 EMSG2(_(e_intern2), "restore_vimvar()");
1430 else
1431 hash_remove(&vimvarht, hi);
1435 #if defined(FEAT_SPELL) || defined(PROTO)
1437 * Evaluate an expression to a list with suggestions.
1438 * For the "expr:" part of 'spellsuggest'.
1439 * Returns NULL when there is an error.
1441 list_T *
1442 eval_spell_expr(badword, expr)
1443 char_u *badword;
1444 char_u *expr;
1446 typval_T save_val;
1447 typval_T rettv;
1448 list_T *list = NULL;
1449 char_u *p = skipwhite(expr);
1451 /* Set "v:val" to the bad word. */
1452 prepare_vimvar(VV_VAL, &save_val);
1453 vimvars[VV_VAL].vv_type = VAR_STRING;
1454 vimvars[VV_VAL].vv_str = badword;
1455 if (p_verbose == 0)
1456 ++emsg_off;
1458 if (eval1(&p, &rettv, TRUE) == OK)
1460 if (rettv.v_type != VAR_LIST)
1461 clear_tv(&rettv);
1462 else
1463 list = rettv.vval.v_list;
1466 if (p_verbose == 0)
1467 --emsg_off;
1468 restore_vimvar(VV_VAL, &save_val);
1470 return list;
1474 * "list" is supposed to contain two items: a word and a number. Return the
1475 * word in "pp" and the number as the return value.
1476 * Return -1 if anything isn't right.
1477 * Used to get the good word and score from the eval_spell_expr() result.
1480 get_spellword(list, pp)
1481 list_T *list;
1482 char_u **pp;
1484 listitem_T *li;
1486 li = list->lv_first;
1487 if (li == NULL)
1488 return -1;
1489 *pp = get_tv_string(&li->li_tv);
1491 li = li->li_next;
1492 if (li == NULL)
1493 return -1;
1494 return get_tv_number(&li->li_tv);
1496 #endif
1499 * Top level evaluation function.
1500 * Returns an allocated typval_T with the result.
1501 * Returns NULL when there is an error.
1503 typval_T *
1504 eval_expr(arg, nextcmd)
1505 char_u *arg;
1506 char_u **nextcmd;
1508 typval_T *tv;
1510 tv = (typval_T *)alloc(sizeof(typval_T));
1511 if (tv != NULL && eval0(arg, tv, nextcmd, TRUE) == FAIL)
1513 vim_free(tv);
1514 tv = NULL;
1517 return tv;
1521 #if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) \
1522 || defined(FEAT_COMPL_FUNC) || defined(PROTO)
1524 * Call some vimL function and return the result in "*rettv".
1525 * Uses argv[argc] for the function arguments. Only Number and String
1526 * arguments are currently supported.
1527 * Returns OK or FAIL.
1529 static int
1530 call_vim_function(func, argc, argv, safe, rettv)
1531 char_u *func;
1532 int argc;
1533 char_u **argv;
1534 int safe; /* use the sandbox */
1535 typval_T *rettv;
1537 typval_T *argvars;
1538 long n;
1539 int len;
1540 int i;
1541 int doesrange;
1542 void *save_funccalp = NULL;
1543 int ret;
1545 argvars = (typval_T *)alloc((unsigned)((argc + 1) * sizeof(typval_T)));
1546 if (argvars == NULL)
1547 return FAIL;
1549 for (i = 0; i < argc; i++)
1551 /* Pass a NULL or empty argument as an empty string */
1552 if (argv[i] == NULL || *argv[i] == NUL)
1554 argvars[i].v_type = VAR_STRING;
1555 argvars[i].vval.v_string = (char_u *)"";
1556 continue;
1559 /* Recognize a number argument, the others must be strings. */
1560 vim_str2nr(argv[i], NULL, &len, TRUE, TRUE, &n, NULL);
1561 if (len != 0 && len == (int)STRLEN(argv[i]))
1563 argvars[i].v_type = VAR_NUMBER;
1564 argvars[i].vval.v_number = n;
1566 else
1568 argvars[i].v_type = VAR_STRING;
1569 argvars[i].vval.v_string = argv[i];
1573 if (safe)
1575 save_funccalp = save_funccal();
1576 ++sandbox;
1579 rettv->v_type = VAR_UNKNOWN; /* clear_tv() uses this */
1580 ret = call_func(func, (int)STRLEN(func), rettv, argc, argvars,
1581 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1582 &doesrange, TRUE, NULL);
1583 if (safe)
1585 --sandbox;
1586 restore_funccal(save_funccalp);
1588 vim_free(argvars);
1590 if (ret == FAIL)
1591 clear_tv(rettv);
1593 return ret;
1596 # if (defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)) || defined(PROTO)
1598 * Call vimL function "func" and return the result as a string.
1599 * Returns NULL when calling the function fails.
1600 * Uses argv[argc] for the function arguments.
1602 void *
1603 call_func_retstr(func, argc, argv, safe)
1604 char_u *func;
1605 int argc;
1606 char_u **argv;
1607 int safe; /* use the sandbox */
1609 typval_T rettv;
1610 char_u *retval;
1612 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1613 return NULL;
1615 retval = vim_strsave(get_tv_string(&rettv));
1616 clear_tv(&rettv);
1617 return retval;
1619 # endif
1621 # if defined(FEAT_COMPL_FUNC) || defined(PROTO)
1623 * Call vimL function "func" and return the result as a number.
1624 * Returns -1 when calling the function fails.
1625 * Uses argv[argc] for the function arguments.
1627 long
1628 call_func_retnr(func, argc, argv, safe)
1629 char_u *func;
1630 int argc;
1631 char_u **argv;
1632 int safe; /* use the sandbox */
1634 typval_T rettv;
1635 long retval;
1637 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1638 return -1;
1640 retval = get_tv_number_chk(&rettv, NULL);
1641 clear_tv(&rettv);
1642 return retval;
1644 # endif
1647 * Call vimL function "func" and return the result as a List.
1648 * Uses argv[argc] for the function arguments.
1649 * Returns NULL when there is something wrong.
1651 void *
1652 call_func_retlist(func, argc, argv, safe)
1653 char_u *func;
1654 int argc;
1655 char_u **argv;
1656 int safe; /* use the sandbox */
1658 typval_T rettv;
1660 if (call_vim_function(func, argc, argv, safe, &rettv) == FAIL)
1661 return NULL;
1663 if (rettv.v_type != VAR_LIST)
1665 clear_tv(&rettv);
1666 return NULL;
1669 return rettv.vval.v_list;
1671 #endif
1675 * Save the current function call pointer, and set it to NULL.
1676 * Used when executing autocommands and for ":source".
1678 void *
1679 save_funccal()
1681 funccall_T *fc = current_funccal;
1683 current_funccal = NULL;
1684 return (void *)fc;
1687 void
1688 restore_funccal(vfc)
1689 void *vfc;
1691 funccall_T *fc = (funccall_T *)vfc;
1693 current_funccal = fc;
1696 #if defined(FEAT_PROFILE) || defined(PROTO)
1698 * Prepare profiling for entering a child or something else that is not
1699 * counted for the script/function itself.
1700 * Should always be called in pair with prof_child_exit().
1702 void
1703 prof_child_enter(tm)
1704 proftime_T *tm; /* place to store waittime */
1706 funccall_T *fc = current_funccal;
1708 if (fc != NULL && fc->func->uf_profiling)
1709 profile_start(&fc->prof_child);
1710 script_prof_save(tm);
1714 * Take care of time spent in a child.
1715 * Should always be called after prof_child_enter().
1717 void
1718 prof_child_exit(tm)
1719 proftime_T *tm; /* where waittime was stored */
1721 funccall_T *fc = current_funccal;
1723 if (fc != NULL && fc->func->uf_profiling)
1725 profile_end(&fc->prof_child);
1726 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
1727 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
1728 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
1730 script_prof_restore(tm);
1732 #endif
1735 #ifdef FEAT_FOLDING
1737 * Evaluate 'foldexpr'. Returns the foldlevel, and any character preceding
1738 * it in "*cp". Doesn't give error messages.
1741 eval_foldexpr(arg, cp)
1742 char_u *arg;
1743 int *cp;
1745 typval_T tv;
1746 int retval;
1747 char_u *s;
1748 int use_sandbox = was_set_insecurely((char_u *)"foldexpr",
1749 OPT_LOCAL);
1751 ++emsg_off;
1752 if (use_sandbox)
1753 ++sandbox;
1754 ++textlock;
1755 *cp = NUL;
1756 if (eval0(arg, &tv, NULL, TRUE) == FAIL)
1757 retval = 0;
1758 else
1760 /* If the result is a number, just return the number. */
1761 if (tv.v_type == VAR_NUMBER)
1762 retval = tv.vval.v_number;
1763 else if (tv.v_type != VAR_STRING || tv.vval.v_string == NULL)
1764 retval = 0;
1765 else
1767 /* If the result is a string, check if there is a non-digit before
1768 * the number. */
1769 s = tv.vval.v_string;
1770 if (!VIM_ISDIGIT(*s) && *s != '-')
1771 *cp = *s++;
1772 retval = atol((char *)s);
1774 clear_tv(&tv);
1776 --emsg_off;
1777 if (use_sandbox)
1778 --sandbox;
1779 --textlock;
1781 return retval;
1783 #endif
1786 * ":let" list all variable values
1787 * ":let var1 var2" list variable values
1788 * ":let var = expr" assignment command.
1789 * ":let var += expr" assignment command.
1790 * ":let var -= expr" assignment command.
1791 * ":let var .= expr" assignment command.
1792 * ":let [var1, var2] = expr" unpack list.
1794 void
1795 ex_let(eap)
1796 exarg_T *eap;
1798 char_u *arg = eap->arg;
1799 char_u *expr = NULL;
1800 typval_T rettv;
1801 int i;
1802 int var_count = 0;
1803 int semicolon = 0;
1804 char_u op[2];
1805 char_u *argend;
1806 int first = TRUE;
1808 argend = skip_var_list(arg, &var_count, &semicolon);
1809 if (argend == NULL)
1810 return;
1811 if (argend > arg && argend[-1] == '.') /* for var.='str' */
1812 --argend;
1813 expr = vim_strchr(argend, '=');
1814 if (expr == NULL)
1817 * ":let" without "=": list variables
1819 if (*arg == '[')
1820 EMSG(_(e_invarg));
1821 else if (!ends_excmd(*arg))
1822 /* ":let var1 var2" */
1823 arg = list_arg_vars(eap, arg, &first);
1824 else if (!eap->skip)
1826 /* ":let" */
1827 list_glob_vars(&first);
1828 list_buf_vars(&first);
1829 list_win_vars(&first);
1830 #ifdef FEAT_WINDOWS
1831 list_tab_vars(&first);
1832 #endif
1833 list_script_vars(&first);
1834 list_func_vars(&first);
1835 list_vim_vars(&first);
1837 eap->nextcmd = check_nextcmd(arg);
1839 else
1841 op[0] = '=';
1842 op[1] = NUL;
1843 if (expr > argend)
1845 if (vim_strchr((char_u *)"+-.", expr[-1]) != NULL)
1846 op[0] = expr[-1]; /* +=, -= or .= */
1848 expr = skipwhite(expr + 1);
1850 if (eap->skip)
1851 ++emsg_skip;
1852 i = eval0(expr, &rettv, &eap->nextcmd, !eap->skip);
1853 if (eap->skip)
1855 if (i != FAIL)
1856 clear_tv(&rettv);
1857 --emsg_skip;
1859 else if (i != FAIL)
1861 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1862 op);
1863 clear_tv(&rettv);
1869 * Assign the typevalue "tv" to the variable or variables at "arg_start".
1870 * Handles both "var" with any type and "[var, var; var]" with a list type.
1871 * When "nextchars" is not NULL it points to a string with characters that
1872 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1873 * or concatenate.
1874 * Returns OK or FAIL;
1876 static int
1877 ex_let_vars(arg_start, tv, copy, semicolon, var_count, nextchars)
1878 char_u *arg_start;
1879 typval_T *tv;
1880 int copy; /* copy values from "tv", don't move */
1881 int semicolon; /* from skip_var_list() */
1882 int var_count; /* from skip_var_list() */
1883 char_u *nextchars;
1885 char_u *arg = arg_start;
1886 list_T *l;
1887 int i;
1888 listitem_T *item;
1889 typval_T ltv;
1891 if (*arg != '[')
1894 * ":let var = expr" or ":for var in list"
1896 if (ex_let_one(arg, tv, copy, nextchars, nextchars) == NULL)
1897 return FAIL;
1898 return OK;
1902 * ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1904 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1906 EMSG(_(e_listreq));
1907 return FAIL;
1910 i = list_len(l);
1911 if (semicolon == 0 && var_count < i)
1913 EMSG(_("E687: Less targets than List items"));
1914 return FAIL;
1916 if (var_count - semicolon > i)
1918 EMSG(_("E688: More targets than List items"));
1919 return FAIL;
1922 item = l->lv_first;
1923 while (*arg != ']')
1925 arg = skipwhite(arg + 1);
1926 arg = ex_let_one(arg, &item->li_tv, TRUE, (char_u *)",;]", nextchars);
1927 item = item->li_next;
1928 if (arg == NULL)
1929 return FAIL;
1931 arg = skipwhite(arg);
1932 if (*arg == ';')
1934 /* Put the rest of the list (may be empty) in the var after ';'.
1935 * Create a new list for this. */
1936 l = list_alloc();
1937 if (l == NULL)
1938 return FAIL;
1939 while (item != NULL)
1941 list_append_tv(l, &item->li_tv);
1942 item = item->li_next;
1945 ltv.v_type = VAR_LIST;
1946 ltv.v_lock = 0;
1947 ltv.vval.v_list = l;
1948 l->lv_refcount = 1;
1950 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1951 (char_u *)"]", nextchars);
1952 clear_tv(&ltv);
1953 if (arg == NULL)
1954 return FAIL;
1955 break;
1957 else if (*arg != ',' && *arg != ']')
1959 EMSG2(_(e_intern2), "ex_let_vars()");
1960 return FAIL;
1964 return OK;
1968 * Skip over assignable variable "var" or list of variables "[var, var]".
1969 * Used for ":let varvar = expr" and ":for varvar in expr".
1970 * For "[var, var]" increment "*var_count" for each variable.
1971 * for "[var, var; var]" set "semicolon".
1972 * Return NULL for an error.
1974 static char_u *
1975 skip_var_list(arg, var_count, semicolon)
1976 char_u *arg;
1977 int *var_count;
1978 int *semicolon;
1980 char_u *p, *s;
1982 if (*arg == '[')
1984 /* "[var, var]": find the matching ']'. */
1985 p = arg;
1986 for (;;)
1988 p = skipwhite(p + 1); /* skip whites after '[', ';' or ',' */
1989 s = skip_var_one(p);
1990 if (s == p)
1992 EMSG2(_(e_invarg2), p);
1993 return NULL;
1995 ++*var_count;
1997 p = skipwhite(s);
1998 if (*p == ']')
1999 break;
2000 else if (*p == ';')
2002 if (*semicolon == 1)
2004 EMSG(_("Double ; in list of variables"));
2005 return NULL;
2007 *semicolon = 1;
2009 else if (*p != ',')
2011 EMSG2(_(e_invarg2), p);
2012 return NULL;
2015 return p + 1;
2017 else
2018 return skip_var_one(arg);
2022 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
2023 * l[idx].
2025 static char_u *
2026 skip_var_one(arg)
2027 char_u *arg;
2029 if (*arg == '@' && arg[1] != NUL)
2030 return arg + 2;
2031 return find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
2032 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2036 * List variables for hashtab "ht" with prefix "prefix".
2037 * If "empty" is TRUE also list NULL strings as empty strings.
2039 static void
2040 list_hashtable_vars(ht, prefix, empty, first)
2041 hashtab_T *ht;
2042 char_u *prefix;
2043 int empty;
2044 int *first;
2046 hashitem_T *hi;
2047 dictitem_T *di;
2048 int todo;
2050 todo = (int)ht->ht_used;
2051 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
2053 if (!HASHITEM_EMPTY(hi))
2055 --todo;
2056 di = HI2DI(hi);
2057 if (empty || di->di_tv.v_type != VAR_STRING
2058 || di->di_tv.vval.v_string != NULL)
2059 list_one_var(di, prefix, first);
2065 * List global variables.
2067 static void
2068 list_glob_vars(first)
2069 int *first;
2071 list_hashtable_vars(&globvarht, (char_u *)"", TRUE, first);
2075 * List buffer variables.
2077 static void
2078 list_buf_vars(first)
2079 int *first;
2081 char_u numbuf[NUMBUFLEN];
2083 list_hashtable_vars(&curbuf->b_vars.dv_hashtab, (char_u *)"b:",
2084 TRUE, first);
2086 sprintf((char *)numbuf, "%ld", (long)curbuf->b_changedtick);
2087 list_one_var_a((char_u *)"b:", (char_u *)"changedtick", VAR_NUMBER,
2088 numbuf, first);
2092 * List window variables.
2094 static void
2095 list_win_vars(first)
2096 int *first;
2098 list_hashtable_vars(&curwin->w_vars.dv_hashtab,
2099 (char_u *)"w:", TRUE, first);
2102 #ifdef FEAT_WINDOWS
2104 * List tab page variables.
2106 static void
2107 list_tab_vars(first)
2108 int *first;
2110 list_hashtable_vars(&curtab->tp_vars.dv_hashtab,
2111 (char_u *)"t:", TRUE, first);
2113 #endif
2116 * List Vim variables.
2118 static void
2119 list_vim_vars(first)
2120 int *first;
2122 list_hashtable_vars(&vimvarht, (char_u *)"v:", FALSE, first);
2126 * List script-local variables, if there is a script.
2128 static void
2129 list_script_vars(first)
2130 int *first;
2132 if (current_SID > 0 && current_SID <= ga_scripts.ga_len)
2133 list_hashtable_vars(&SCRIPT_VARS(current_SID),
2134 (char_u *)"s:", FALSE, first);
2138 * List function variables, if there is a function.
2140 static void
2141 list_func_vars(first)
2142 int *first;
2144 if (current_funccal != NULL)
2145 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
2146 (char_u *)"l:", FALSE, first);
2150 * List variables in "arg".
2152 static char_u *
2153 list_arg_vars(eap, arg, first)
2154 exarg_T *eap;
2155 char_u *arg;
2156 int *first;
2158 int error = FALSE;
2159 int len;
2160 char_u *name;
2161 char_u *name_start;
2162 char_u *arg_subsc;
2163 char_u *tofree;
2164 typval_T tv;
2166 while (!ends_excmd(*arg) && !got_int)
2168 if (error || eap->skip)
2170 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
2171 if (!vim_iswhite(*arg) && !ends_excmd(*arg))
2173 emsg_severe = TRUE;
2174 EMSG(_(e_trailing));
2175 break;
2178 else
2180 /* get_name_len() takes care of expanding curly braces */
2181 name_start = name = arg;
2182 len = get_name_len(&arg, &tofree, TRUE, TRUE);
2183 if (len <= 0)
2185 /* This is mainly to keep test 49 working: when expanding
2186 * curly braces fails overrule the exception error message. */
2187 if (len < 0 && !aborting())
2189 emsg_severe = TRUE;
2190 EMSG2(_(e_invarg2), arg);
2191 break;
2193 error = TRUE;
2195 else
2197 if (tofree != NULL)
2198 name = tofree;
2199 if (get_var_tv(name, len, &tv, TRUE) == FAIL)
2200 error = TRUE;
2201 else
2203 /* handle d.key, l[idx], f(expr) */
2204 arg_subsc = arg;
2205 if (handle_subscript(&arg, &tv, TRUE, TRUE) == FAIL)
2206 error = TRUE;
2207 else
2209 if (arg == arg_subsc && len == 2 && name[1] == ':')
2211 switch (*name)
2213 case 'g': list_glob_vars(first); break;
2214 case 'b': list_buf_vars(first); break;
2215 case 'w': list_win_vars(first); break;
2216 #ifdef FEAT_WINDOWS
2217 case 't': list_tab_vars(first); break;
2218 #endif
2219 case 'v': list_vim_vars(first); break;
2220 case 's': list_script_vars(first); break;
2221 case 'l': list_func_vars(first); break;
2222 default:
2223 EMSG2(_("E738: Can't list variables for %s"), name);
2226 else
2228 char_u numbuf[NUMBUFLEN];
2229 char_u *tf;
2230 int c;
2231 char_u *s;
2233 s = echo_string(&tv, &tf, numbuf, 0);
2234 c = *arg;
2235 *arg = NUL;
2236 list_one_var_a((char_u *)"",
2237 arg == arg_subsc ? name : name_start,
2238 tv.v_type,
2239 s == NULL ? (char_u *)"" : s,
2240 first);
2241 *arg = c;
2242 vim_free(tf);
2244 clear_tv(&tv);
2249 vim_free(tofree);
2252 arg = skipwhite(arg);
2255 return arg;
2259 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
2260 * Returns a pointer to the char just after the var name.
2261 * Returns NULL if there is an error.
2263 static char_u *
2264 ex_let_one(arg, tv, copy, endchars, op)
2265 char_u *arg; /* points to variable name */
2266 typval_T *tv; /* value to assign to variable */
2267 int copy; /* copy value from "tv" */
2268 char_u *endchars; /* valid chars after variable name or NULL */
2269 char_u *op; /* "+", "-", "." or NULL*/
2271 int c1;
2272 char_u *name;
2273 char_u *p;
2274 char_u *arg_end = NULL;
2275 int len;
2276 int opt_flags;
2277 char_u *tofree = NULL;
2280 * ":let $VAR = expr": Set environment variable.
2282 if (*arg == '$')
2284 /* Find the end of the name. */
2285 ++arg;
2286 name = arg;
2287 len = get_env_len(&arg);
2288 if (len == 0)
2289 EMSG2(_(e_invarg2), name - 1);
2290 else
2292 if (op != NULL && (*op == '+' || *op == '-'))
2293 EMSG2(_(e_letwrong), op);
2294 else if (endchars != NULL
2295 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
2296 EMSG(_(e_letunexp));
2297 else
2299 c1 = name[len];
2300 name[len] = NUL;
2301 p = get_tv_string_chk(tv);
2302 if (p != NULL && op != NULL && *op == '.')
2304 int mustfree = FALSE;
2305 char_u *s = vim_getenv(name, &mustfree);
2307 if (s != NULL)
2309 p = tofree = concat_str(s, p);
2310 if (mustfree)
2311 vim_free(s);
2314 if (p != NULL)
2316 vim_setenv(name, p);
2317 if (STRICMP(name, "HOME") == 0)
2318 init_homedir();
2319 else if (didset_vim && STRICMP(name, "VIM") == 0)
2320 didset_vim = FALSE;
2321 else if (didset_vimruntime
2322 && STRICMP(name, "VIMRUNTIME") == 0)
2323 didset_vimruntime = FALSE;
2324 arg_end = arg;
2326 name[len] = c1;
2327 vim_free(tofree);
2333 * ":let &option = expr": Set option value.
2334 * ":let &l:option = expr": Set local option value.
2335 * ":let &g:option = expr": Set global option value.
2337 else if (*arg == '&')
2339 /* Find the end of the name. */
2340 p = find_option_end(&arg, &opt_flags);
2341 if (p == NULL || (endchars != NULL
2342 && vim_strchr(endchars, *skipwhite(p)) == NULL))
2343 EMSG(_(e_letunexp));
2344 else
2346 long n;
2347 int opt_type;
2348 long numval;
2349 char_u *stringval = NULL;
2350 char_u *s;
2352 c1 = *p;
2353 *p = NUL;
2355 n = get_tv_number(tv);
2356 s = get_tv_string_chk(tv); /* != NULL if number or string */
2357 if (s != NULL && op != NULL && *op != '=')
2359 opt_type = get_option_value(arg, &numval,
2360 &stringval, opt_flags);
2361 if ((opt_type == 1 && *op == '.')
2362 || (opt_type == 0 && *op != '.'))
2363 EMSG2(_(e_letwrong), op);
2364 else
2366 if (opt_type == 1) /* number */
2368 if (*op == '+')
2369 n = numval + n;
2370 else
2371 n = numval - n;
2373 else if (opt_type == 0 && stringval != NULL) /* string */
2375 s = concat_str(stringval, s);
2376 vim_free(stringval);
2377 stringval = s;
2381 if (s != NULL)
2383 set_option_value(arg, n, s, opt_flags);
2384 arg_end = p;
2386 *p = c1;
2387 vim_free(stringval);
2392 * ":let @r = expr": Set register contents.
2394 else if (*arg == '@')
2396 ++arg;
2397 if (op != NULL && (*op == '+' || *op == '-'))
2398 EMSG2(_(e_letwrong), op);
2399 else if (endchars != NULL
2400 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
2401 EMSG(_(e_letunexp));
2402 else
2404 char_u *ptofree = NULL;
2405 char_u *s;
2407 p = get_tv_string_chk(tv);
2408 if (p != NULL && op != NULL && *op == '.')
2410 s = get_reg_contents(*arg == '@' ? '"' : *arg, TRUE, TRUE);
2411 if (s != NULL)
2413 p = ptofree = concat_str(s, p);
2414 vim_free(s);
2417 if (p != NULL)
2419 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
2420 arg_end = arg + 1;
2422 vim_free(ptofree);
2427 * ":let var = expr": Set internal variable.
2428 * ":let {expr} = expr": Idem, name made with curly braces
2430 else if (eval_isnamec1(*arg) || *arg == '{')
2432 lval_T lv;
2434 p = get_lval(arg, tv, &lv, FALSE, FALSE, FALSE, FNE_CHECK_START);
2435 if (p != NULL && lv.ll_name != NULL)
2437 if (endchars != NULL && vim_strchr(endchars, *skipwhite(p)) == NULL)
2438 EMSG(_(e_letunexp));
2439 else
2441 set_var_lval(&lv, p, tv, copy, op);
2442 arg_end = p;
2445 clear_lval(&lv);
2448 else
2449 EMSG2(_(e_invarg2), arg);
2451 return arg_end;
2455 * If "arg" is equal to "b:changedtick" give an error and return TRUE.
2457 static int
2458 check_changedtick(arg)
2459 char_u *arg;
2461 if (STRNCMP(arg, "b:changedtick", 13) == 0 && !eval_isnamec(arg[13]))
2463 EMSG2(_(e_readonlyvar), arg);
2464 return TRUE;
2466 return FALSE;
2470 * Get an lval: variable, Dict item or List item that can be assigned a value
2471 * to: "name", "na{me}", "name[expr]", "name[expr:expr]", "name[expr][expr]",
2472 * "name.key", "name.key[expr]" etc.
2473 * Indexing only works if "name" is an existing List or Dictionary.
2474 * "name" points to the start of the name.
2475 * If "rettv" is not NULL it points to the value to be assigned.
2476 * "unlet" is TRUE for ":unlet": slightly different behavior when something is
2477 * wrong; must end in space or cmd separator.
2479 * Returns a pointer to just after the name, including indexes.
2480 * When an evaluation error occurs "lp->ll_name" is NULL;
2481 * Returns NULL for a parsing error. Still need to free items in "lp"!
2483 static char_u *
2484 get_lval(name, rettv, lp, unlet, skip, quiet, fne_flags)
2485 char_u *name;
2486 typval_T *rettv;
2487 lval_T *lp;
2488 int unlet;
2489 int skip;
2490 int quiet; /* don't give error messages */
2491 int fne_flags; /* flags for find_name_end() */
2493 char_u *p;
2494 char_u *expr_start, *expr_end;
2495 int cc;
2496 dictitem_T *v;
2497 typval_T var1;
2498 typval_T var2;
2499 int empty1 = FALSE;
2500 listitem_T *ni;
2501 char_u *key = NULL;
2502 int len;
2503 hashtab_T *ht;
2505 /* Clear everything in "lp". */
2506 vim_memset(lp, 0, sizeof(lval_T));
2508 if (skip)
2510 /* When skipping just find the end of the name. */
2511 lp->ll_name = name;
2512 return find_name_end(name, NULL, NULL, FNE_INCL_BR | fne_flags);
2515 /* Find the end of the name. */
2516 p = find_name_end(name, &expr_start, &expr_end, fne_flags);
2517 if (expr_start != NULL)
2519 /* Don't expand the name when we already know there is an error. */
2520 if (unlet && !vim_iswhite(*p) && !ends_excmd(*p)
2521 && *p != '[' && *p != '.')
2523 EMSG(_(e_trailing));
2524 return NULL;
2527 lp->ll_exp_name = make_expanded_name(name, expr_start, expr_end, p);
2528 if (lp->ll_exp_name == NULL)
2530 /* Report an invalid expression in braces, unless the
2531 * expression evaluation has been cancelled due to an
2532 * aborting error, an interrupt, or an exception. */
2533 if (!aborting() && !quiet)
2535 emsg_severe = TRUE;
2536 EMSG2(_(e_invarg2), name);
2537 return NULL;
2540 lp->ll_name = lp->ll_exp_name;
2542 else
2543 lp->ll_name = name;
2545 /* Without [idx] or .key we are done. */
2546 if ((*p != '[' && *p != '.') || lp->ll_name == NULL)
2547 return p;
2549 cc = *p;
2550 *p = NUL;
2551 v = find_var(lp->ll_name, &ht);
2552 if (v == NULL && !quiet)
2553 EMSG2(_(e_undefvar), lp->ll_name);
2554 *p = cc;
2555 if (v == NULL)
2556 return NULL;
2559 * Loop until no more [idx] or .key is following.
2561 lp->ll_tv = &v->di_tv;
2562 while (*p == '[' || (*p == '.' && lp->ll_tv->v_type == VAR_DICT))
2564 if (!(lp->ll_tv->v_type == VAR_LIST && lp->ll_tv->vval.v_list != NULL)
2565 && !(lp->ll_tv->v_type == VAR_DICT
2566 && lp->ll_tv->vval.v_dict != NULL))
2568 if (!quiet)
2569 EMSG(_("E689: Can only index a List or Dictionary"));
2570 return NULL;
2572 if (lp->ll_range)
2574 if (!quiet)
2575 EMSG(_("E708: [:] must come last"));
2576 return NULL;
2579 len = -1;
2580 if (*p == '.')
2582 key = p + 1;
2583 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
2585 if (len == 0)
2587 if (!quiet)
2588 EMSG(_(e_emptykey));
2589 return NULL;
2591 p = key + len;
2593 else
2595 /* Get the index [expr] or the first index [expr: ]. */
2596 p = skipwhite(p + 1);
2597 if (*p == ':')
2598 empty1 = TRUE;
2599 else
2601 empty1 = FALSE;
2602 if (eval1(&p, &var1, TRUE) == FAIL) /* recursive! */
2603 return NULL;
2604 if (get_tv_string_chk(&var1) == NULL)
2606 /* not a number or string */
2607 clear_tv(&var1);
2608 return NULL;
2612 /* Optionally get the second index [ :expr]. */
2613 if (*p == ':')
2615 if (lp->ll_tv->v_type == VAR_DICT)
2617 if (!quiet)
2618 EMSG(_(e_dictrange));
2619 if (!empty1)
2620 clear_tv(&var1);
2621 return NULL;
2623 if (rettv != NULL && (rettv->v_type != VAR_LIST
2624 || rettv->vval.v_list == NULL))
2626 if (!quiet)
2627 EMSG(_("E709: [:] requires a List value"));
2628 if (!empty1)
2629 clear_tv(&var1);
2630 return NULL;
2632 p = skipwhite(p + 1);
2633 if (*p == ']')
2634 lp->ll_empty2 = TRUE;
2635 else
2637 lp->ll_empty2 = FALSE;
2638 if (eval1(&p, &var2, TRUE) == FAIL) /* recursive! */
2640 if (!empty1)
2641 clear_tv(&var1);
2642 return NULL;
2644 if (get_tv_string_chk(&var2) == NULL)
2646 /* not a number or string */
2647 if (!empty1)
2648 clear_tv(&var1);
2649 clear_tv(&var2);
2650 return NULL;
2653 lp->ll_range = TRUE;
2655 else
2656 lp->ll_range = FALSE;
2658 if (*p != ']')
2660 if (!quiet)
2661 EMSG(_(e_missbrac));
2662 if (!empty1)
2663 clear_tv(&var1);
2664 if (lp->ll_range && !lp->ll_empty2)
2665 clear_tv(&var2);
2666 return NULL;
2669 /* Skip to past ']'. */
2670 ++p;
2673 if (lp->ll_tv->v_type == VAR_DICT)
2675 if (len == -1)
2677 /* "[key]": get key from "var1" */
2678 key = get_tv_string(&var1); /* is number or string */
2679 if (*key == NUL)
2681 if (!quiet)
2682 EMSG(_(e_emptykey));
2683 clear_tv(&var1);
2684 return NULL;
2687 lp->ll_list = NULL;
2688 lp->ll_dict = lp->ll_tv->vval.v_dict;
2689 lp->ll_di = dict_find(lp->ll_dict, key, len);
2690 if (lp->ll_di == NULL)
2692 /* Key does not exist in dict: may need to add it. */
2693 if (*p == '[' || *p == '.' || unlet)
2695 if (!quiet)
2696 EMSG2(_(e_dictkey), key);
2697 if (len == -1)
2698 clear_tv(&var1);
2699 return NULL;
2701 if (len == -1)
2702 lp->ll_newkey = vim_strsave(key);
2703 else
2704 lp->ll_newkey = vim_strnsave(key, len);
2705 if (len == -1)
2706 clear_tv(&var1);
2707 if (lp->ll_newkey == NULL)
2708 p = NULL;
2709 break;
2711 if (len == -1)
2712 clear_tv(&var1);
2713 lp->ll_tv = &lp->ll_di->di_tv;
2715 else
2718 * Get the number and item for the only or first index of the List.
2720 if (empty1)
2721 lp->ll_n1 = 0;
2722 else
2724 lp->ll_n1 = get_tv_number(&var1); /* is number or string */
2725 clear_tv(&var1);
2727 lp->ll_dict = NULL;
2728 lp->ll_list = lp->ll_tv->vval.v_list;
2729 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2730 if (lp->ll_li == NULL)
2732 if (lp->ll_n1 < 0)
2734 lp->ll_n1 = 0;
2735 lp->ll_li = list_find(lp->ll_list, lp->ll_n1);
2738 if (lp->ll_li == NULL)
2740 if (lp->ll_range && !lp->ll_empty2)
2741 clear_tv(&var2);
2742 return NULL;
2746 * May need to find the item or absolute index for the second
2747 * index of a range.
2748 * When no index given: "lp->ll_empty2" is TRUE.
2749 * Otherwise "lp->ll_n2" is set to the second index.
2751 if (lp->ll_range && !lp->ll_empty2)
2753 lp->ll_n2 = get_tv_number(&var2); /* is number or string */
2754 clear_tv(&var2);
2755 if (lp->ll_n2 < 0)
2757 ni = list_find(lp->ll_list, lp->ll_n2);
2758 if (ni == NULL)
2759 return NULL;
2760 lp->ll_n2 = list_idx_of_item(lp->ll_list, ni);
2763 /* Check that lp->ll_n2 isn't before lp->ll_n1. */
2764 if (lp->ll_n1 < 0)
2765 lp->ll_n1 = list_idx_of_item(lp->ll_list, lp->ll_li);
2766 if (lp->ll_n2 < lp->ll_n1)
2767 return NULL;
2770 lp->ll_tv = &lp->ll_li->li_tv;
2774 return p;
2778 * Clear lval "lp" that was filled by get_lval().
2780 static void
2781 clear_lval(lp)
2782 lval_T *lp;
2784 vim_free(lp->ll_exp_name);
2785 vim_free(lp->ll_newkey);
2789 * Set a variable that was parsed by get_lval() to "rettv".
2790 * "endp" points to just after the parsed name.
2791 * "op" is NULL, "+" for "+=", "-" for "-=", "." for ".=" or "=" for "=".
2793 static void
2794 set_var_lval(lp, endp, rettv, copy, op)
2795 lval_T *lp;
2796 char_u *endp;
2797 typval_T *rettv;
2798 int copy;
2799 char_u *op;
2801 int cc;
2802 listitem_T *ri;
2803 dictitem_T *di;
2805 if (lp->ll_tv == NULL)
2807 if (!check_changedtick(lp->ll_name))
2809 cc = *endp;
2810 *endp = NUL;
2811 if (op != NULL && *op != '=')
2813 typval_T tv;
2815 /* handle +=, -= and .= */
2816 if (get_var_tv(lp->ll_name, (int)STRLEN(lp->ll_name),
2817 &tv, TRUE) == OK)
2819 if (tv_op(&tv, rettv, op) == OK)
2820 set_var(lp->ll_name, &tv, FALSE);
2821 clear_tv(&tv);
2824 else
2825 set_var(lp->ll_name, rettv, copy);
2826 *endp = cc;
2829 else if (tv_check_lock(lp->ll_newkey == NULL
2830 ? lp->ll_tv->v_lock
2831 : lp->ll_tv->vval.v_dict->dv_lock, lp->ll_name))
2833 else if (lp->ll_range)
2836 * Assign the List values to the list items.
2838 for (ri = rettv->vval.v_list->lv_first; ri != NULL; )
2840 if (op != NULL && *op != '=')
2841 tv_op(&lp->ll_li->li_tv, &ri->li_tv, op);
2842 else
2844 clear_tv(&lp->ll_li->li_tv);
2845 copy_tv(&ri->li_tv, &lp->ll_li->li_tv);
2847 ri = ri->li_next;
2848 if (ri == NULL || (!lp->ll_empty2 && lp->ll_n2 == lp->ll_n1))
2849 break;
2850 if (lp->ll_li->li_next == NULL)
2852 /* Need to add an empty item. */
2853 if (list_append_number(lp->ll_list, 0) == FAIL)
2855 ri = NULL;
2856 break;
2859 lp->ll_li = lp->ll_li->li_next;
2860 ++lp->ll_n1;
2862 if (ri != NULL)
2863 EMSG(_("E710: List value has more items than target"));
2864 else if (lp->ll_empty2
2865 ? (lp->ll_li != NULL && lp->ll_li->li_next != NULL)
2866 : lp->ll_n1 != lp->ll_n2)
2867 EMSG(_("E711: List value has not enough items"));
2869 else
2872 * Assign to a List or Dictionary item.
2874 if (lp->ll_newkey != NULL)
2876 if (op != NULL && *op != '=')
2878 EMSG2(_(e_letwrong), op);
2879 return;
2882 /* Need to add an item to the Dictionary. */
2883 di = dictitem_alloc(lp->ll_newkey);
2884 if (di == NULL)
2885 return;
2886 if (dict_add(lp->ll_tv->vval.v_dict, di) == FAIL)
2888 vim_free(di);
2889 return;
2891 lp->ll_tv = &di->di_tv;
2893 else if (op != NULL && *op != '=')
2895 tv_op(lp->ll_tv, rettv, op);
2896 return;
2898 else
2899 clear_tv(lp->ll_tv);
2902 * Assign the value to the variable or list item.
2904 if (copy)
2905 copy_tv(rettv, lp->ll_tv);
2906 else
2908 *lp->ll_tv = *rettv;
2909 lp->ll_tv->v_lock = 0;
2910 init_tv(rettv);
2916 * Handle "tv1 += tv2", "tv1 -= tv2" and "tv1 .= tv2"
2917 * Returns OK or FAIL.
2919 static int
2920 tv_op(tv1, tv2, op)
2921 typval_T *tv1;
2922 typval_T *tv2;
2923 char_u *op;
2925 long n;
2926 char_u numbuf[NUMBUFLEN];
2927 char_u *s;
2929 /* Can't do anything with a Funcref or a Dict on the right. */
2930 if (tv2->v_type != VAR_FUNC && tv2->v_type != VAR_DICT)
2932 switch (tv1->v_type)
2934 case VAR_DICT:
2935 case VAR_FUNC:
2936 break;
2938 case VAR_LIST:
2939 if (*op != '+' || tv2->v_type != VAR_LIST)
2940 break;
2941 /* List += List */
2942 if (tv1->vval.v_list != NULL && tv2->vval.v_list != NULL)
2943 list_extend(tv1->vval.v_list, tv2->vval.v_list, NULL);
2944 return OK;
2946 case VAR_NUMBER:
2947 case VAR_STRING:
2948 if (tv2->v_type == VAR_LIST)
2949 break;
2950 if (*op == '+' || *op == '-')
2952 /* nr += nr or nr -= nr*/
2953 n = get_tv_number(tv1);
2954 #ifdef FEAT_FLOAT
2955 if (tv2->v_type == VAR_FLOAT)
2957 float_T f = n;
2959 if (*op == '+')
2960 f += tv2->vval.v_float;
2961 else
2962 f -= tv2->vval.v_float;
2963 clear_tv(tv1);
2964 tv1->v_type = VAR_FLOAT;
2965 tv1->vval.v_float = f;
2967 else
2968 #endif
2970 if (*op == '+')
2971 n += get_tv_number(tv2);
2972 else
2973 n -= get_tv_number(tv2);
2974 clear_tv(tv1);
2975 tv1->v_type = VAR_NUMBER;
2976 tv1->vval.v_number = n;
2979 else
2981 if (tv2->v_type == VAR_FLOAT)
2982 break;
2984 /* str .= str */
2985 s = get_tv_string(tv1);
2986 s = concat_str(s, get_tv_string_buf(tv2, numbuf));
2987 clear_tv(tv1);
2988 tv1->v_type = VAR_STRING;
2989 tv1->vval.v_string = s;
2991 return OK;
2993 #ifdef FEAT_FLOAT
2994 case VAR_FLOAT:
2996 float_T f;
2998 if (*op == '.' || (tv2->v_type != VAR_FLOAT
2999 && tv2->v_type != VAR_NUMBER
3000 && tv2->v_type != VAR_STRING))
3001 break;
3002 if (tv2->v_type == VAR_FLOAT)
3003 f = tv2->vval.v_float;
3004 else
3005 f = get_tv_number(tv2);
3006 if (*op == '+')
3007 tv1->vval.v_float += f;
3008 else
3009 tv1->vval.v_float -= f;
3011 return OK;
3012 #endif
3016 EMSG2(_(e_letwrong), op);
3017 return FAIL;
3021 * Add a watcher to a list.
3023 static void
3024 list_add_watch(l, lw)
3025 list_T *l;
3026 listwatch_T *lw;
3028 lw->lw_next = l->lv_watch;
3029 l->lv_watch = lw;
3033 * Remove a watcher from a list.
3034 * No warning when it isn't found...
3036 static void
3037 list_rem_watch(l, lwrem)
3038 list_T *l;
3039 listwatch_T *lwrem;
3041 listwatch_T *lw, **lwp;
3043 lwp = &l->lv_watch;
3044 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3046 if (lw == lwrem)
3048 *lwp = lw->lw_next;
3049 break;
3051 lwp = &lw->lw_next;
3056 * Just before removing an item from a list: advance watchers to the next
3057 * item.
3059 static void
3060 list_fix_watch(l, item)
3061 list_T *l;
3062 listitem_T *item;
3064 listwatch_T *lw;
3066 for (lw = l->lv_watch; lw != NULL; lw = lw->lw_next)
3067 if (lw->lw_item == item)
3068 lw->lw_item = item->li_next;
3072 * Evaluate the expression used in a ":for var in expr" command.
3073 * "arg" points to "var".
3074 * Set "*errp" to TRUE for an error, FALSE otherwise;
3075 * Return a pointer that holds the info. Null when there is an error.
3077 void *
3078 eval_for_line(arg, errp, nextcmdp, skip)
3079 char_u *arg;
3080 int *errp;
3081 char_u **nextcmdp;
3082 int skip;
3084 forinfo_T *fi;
3085 char_u *expr;
3086 typval_T tv;
3087 list_T *l;
3089 *errp = TRUE; /* default: there is an error */
3091 fi = (forinfo_T *)alloc_clear(sizeof(forinfo_T));
3092 if (fi == NULL)
3093 return NULL;
3095 expr = skip_var_list(arg, &fi->fi_varcount, &fi->fi_semicolon);
3096 if (expr == NULL)
3097 return fi;
3099 expr = skipwhite(expr);
3100 if (expr[0] != 'i' || expr[1] != 'n' || !vim_iswhite(expr[2]))
3102 EMSG(_("E690: Missing \"in\" after :for"));
3103 return fi;
3106 if (skip)
3107 ++emsg_skip;
3108 if (eval0(skipwhite(expr + 2), &tv, nextcmdp, !skip) == OK)
3110 *errp = FALSE;
3111 if (!skip)
3113 l = tv.vval.v_list;
3114 if (tv.v_type != VAR_LIST || l == NULL)
3116 EMSG(_(e_listreq));
3117 clear_tv(&tv);
3119 else
3121 /* No need to increment the refcount, it's already set for the
3122 * list being used in "tv". */
3123 fi->fi_list = l;
3124 list_add_watch(l, &fi->fi_lw);
3125 fi->fi_lw.lw_item = l->lv_first;
3129 if (skip)
3130 --emsg_skip;
3132 return fi;
3136 * Use the first item in a ":for" list. Advance to the next.
3137 * Assign the values to the variable (list). "arg" points to the first one.
3138 * Return TRUE when a valid item was found, FALSE when at end of list or
3139 * something wrong.
3142 next_for_item(fi_void, arg)
3143 void *fi_void;
3144 char_u *arg;
3146 forinfo_T *fi = (forinfo_T *)fi_void;
3147 int result;
3148 listitem_T *item;
3150 item = fi->fi_lw.lw_item;
3151 if (item == NULL)
3152 result = FALSE;
3153 else
3155 fi->fi_lw.lw_item = item->li_next;
3156 result = (ex_let_vars(arg, &item->li_tv, TRUE,
3157 fi->fi_semicolon, fi->fi_varcount, NULL) == OK);
3159 return result;
3163 * Free the structure used to store info used by ":for".
3165 void
3166 free_for_info(fi_void)
3167 void *fi_void;
3169 forinfo_T *fi = (forinfo_T *)fi_void;
3171 if (fi != NULL && fi->fi_list != NULL)
3173 list_rem_watch(fi->fi_list, &fi->fi_lw);
3174 list_unref(fi->fi_list);
3176 vim_free(fi);
3179 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3181 void
3182 set_context_for_expression(xp, arg, cmdidx)
3183 expand_T *xp;
3184 char_u *arg;
3185 cmdidx_T cmdidx;
3187 int got_eq = FALSE;
3188 int c;
3189 char_u *p;
3191 if (cmdidx == CMD_let)
3193 xp->xp_context = EXPAND_USER_VARS;
3194 if (vim_strpbrk(arg, (char_u *)"\"'+-*/%.=!?~|&$([<>,#") == NULL)
3196 /* ":let var1 var2 ...": find last space. */
3197 for (p = arg + STRLEN(arg); p >= arg; )
3199 xp->xp_pattern = p;
3200 mb_ptr_back(arg, p);
3201 if (vim_iswhite(*p))
3202 break;
3204 return;
3207 else
3208 xp->xp_context = cmdidx == CMD_call ? EXPAND_FUNCTIONS
3209 : EXPAND_EXPRESSION;
3210 while ((xp->xp_pattern = vim_strpbrk(arg,
3211 (char_u *)"\"'+-*/%.=!?~|&$([<>,#")) != NULL)
3213 c = *xp->xp_pattern;
3214 if (c == '&')
3216 c = xp->xp_pattern[1];
3217 if (c == '&')
3219 ++xp->xp_pattern;
3220 xp->xp_context = cmdidx != CMD_let || got_eq
3221 ? EXPAND_EXPRESSION : EXPAND_NOTHING;
3223 else if (c != ' ')
3225 xp->xp_context = EXPAND_SETTINGS;
3226 if ((c == 'l' || c == 'g') && xp->xp_pattern[2] == ':')
3227 xp->xp_pattern += 2;
3231 else if (c == '$')
3233 /* environment variable */
3234 xp->xp_context = EXPAND_ENV_VARS;
3236 else if (c == '=')
3238 got_eq = TRUE;
3239 xp->xp_context = EXPAND_EXPRESSION;
3241 else if (c == '<'
3242 && xp->xp_context == EXPAND_FUNCTIONS
3243 && vim_strchr(xp->xp_pattern, '(') == NULL)
3245 /* Function name can start with "<SNR>" */
3246 break;
3248 else if (cmdidx != CMD_let || got_eq)
3250 if (c == '"') /* string */
3252 while ((c = *++xp->xp_pattern) != NUL && c != '"')
3253 if (c == '\\' && xp->xp_pattern[1] != NUL)
3254 ++xp->xp_pattern;
3255 xp->xp_context = EXPAND_NOTHING;
3257 else if (c == '\'') /* literal string */
3259 /* Trick: '' is like stopping and starting a literal string. */
3260 while ((c = *++xp->xp_pattern) != NUL && c != '\'')
3261 /* skip */ ;
3262 xp->xp_context = EXPAND_NOTHING;
3264 else if (c == '|')
3266 if (xp->xp_pattern[1] == '|')
3268 ++xp->xp_pattern;
3269 xp->xp_context = EXPAND_EXPRESSION;
3271 else
3272 xp->xp_context = EXPAND_COMMANDS;
3274 else
3275 xp->xp_context = EXPAND_EXPRESSION;
3277 else
3278 /* Doesn't look like something valid, expand as an expression
3279 * anyway. */
3280 xp->xp_context = EXPAND_EXPRESSION;
3281 arg = xp->xp_pattern;
3282 if (*arg != NUL)
3283 while ((c = *++arg) != NUL && (c == ' ' || c == '\t'))
3284 /* skip */ ;
3286 xp->xp_pattern = arg;
3289 #endif /* FEAT_CMDL_COMPL */
3292 * ":1,25call func(arg1, arg2)" function call.
3294 void
3295 ex_call(eap)
3296 exarg_T *eap;
3298 char_u *arg = eap->arg;
3299 char_u *startarg;
3300 char_u *name;
3301 char_u *tofree;
3302 int len;
3303 typval_T rettv;
3304 linenr_T lnum;
3305 int doesrange;
3306 int failed = FALSE;
3307 funcdict_T fudi;
3309 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi);
3310 if (fudi.fd_newkey != NULL)
3312 /* Still need to give an error message for missing key. */
3313 EMSG2(_(e_dictkey), fudi.fd_newkey);
3314 vim_free(fudi.fd_newkey);
3316 if (tofree == NULL)
3317 return;
3319 /* Increase refcount on dictionary, it could get deleted when evaluating
3320 * the arguments. */
3321 if (fudi.fd_dict != NULL)
3322 ++fudi.fd_dict->dv_refcount;
3324 /* If it is the name of a variable of type VAR_FUNC use its contents. */
3325 len = (int)STRLEN(tofree);
3326 name = deref_func_name(tofree, &len);
3328 /* Skip white space to allow ":call func ()". Not good, but required for
3329 * backward compatibility. */
3330 startarg = skipwhite(arg);
3331 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3333 if (*startarg != '(')
3335 EMSG2(_("E107: Missing parentheses: %s"), eap->arg);
3336 goto end;
3340 * When skipping, evaluate the function once, to find the end of the
3341 * arguments.
3342 * When the function takes a range, this is discovered after the first
3343 * call, and the loop is broken.
3345 if (eap->skip)
3347 ++emsg_skip;
3348 lnum = eap->line2; /* do it once, also with an invalid range */
3350 else
3351 lnum = eap->line1;
3352 for ( ; lnum <= eap->line2; ++lnum)
3354 if (!eap->skip && eap->addr_count > 0)
3356 curwin->w_cursor.lnum = lnum;
3357 curwin->w_cursor.col = 0;
3359 arg = startarg;
3360 if (get_func_tv(name, (int)STRLEN(name), &rettv, &arg,
3361 eap->line1, eap->line2, &doesrange,
3362 !eap->skip, fudi.fd_dict) == FAIL)
3364 failed = TRUE;
3365 break;
3368 /* Handle a function returning a Funcref, Dictionary or List. */
3369 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3371 failed = TRUE;
3372 break;
3375 clear_tv(&rettv);
3376 if (doesrange || eap->skip)
3377 break;
3379 /* Stop when immediately aborting on error, or when an interrupt
3380 * occurred or an exception was thrown but not caught.
3381 * get_func_tv() returned OK, so that the check for trailing
3382 * characters below is executed. */
3383 if (aborting())
3384 break;
3386 if (eap->skip)
3387 --emsg_skip;
3389 if (!failed)
3391 /* Check for trailing illegal characters and a following command. */
3392 if (!ends_excmd(*arg))
3394 emsg_severe = TRUE;
3395 EMSG(_(e_trailing));
3397 else
3398 eap->nextcmd = check_nextcmd(arg);
3401 end:
3402 dict_unref(fudi.fd_dict);
3403 vim_free(tofree);
3407 * ":unlet[!] var1 ... " command.
3409 void
3410 ex_unlet(eap)
3411 exarg_T *eap;
3413 ex_unletlock(eap, eap->arg, 0);
3417 * ":lockvar" and ":unlockvar" commands
3419 void
3420 ex_lockvar(eap)
3421 exarg_T *eap;
3423 char_u *arg = eap->arg;
3424 int deep = 2;
3426 if (eap->forceit)
3427 deep = -1;
3428 else if (vim_isdigit(*arg))
3430 deep = getdigits(&arg);
3431 arg = skipwhite(arg);
3434 ex_unletlock(eap, arg, deep);
3438 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
3440 static void
3441 ex_unletlock(eap, argstart, deep)
3442 exarg_T *eap;
3443 char_u *argstart;
3444 int deep;
3446 char_u *arg = argstart;
3447 char_u *name_end;
3448 int error = FALSE;
3449 lval_T lv;
3453 /* Parse the name and find the end. */
3454 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error, FALSE,
3455 FNE_CHECK_START);
3456 if (lv.ll_name == NULL)
3457 error = TRUE; /* error but continue parsing */
3458 if (name_end == NULL || (!vim_iswhite(*name_end)
3459 && !ends_excmd(*name_end)))
3461 if (name_end != NULL)
3463 emsg_severe = TRUE;
3464 EMSG(_(e_trailing));
3466 if (!(eap->skip || error))
3467 clear_lval(&lv);
3468 break;
3471 if (!error && !eap->skip)
3473 if (eap->cmdidx == CMD_unlet)
3475 if (do_unlet_var(&lv, name_end, eap->forceit) == FAIL)
3476 error = TRUE;
3478 else
3480 if (do_lock_var(&lv, name_end, deep,
3481 eap->cmdidx == CMD_lockvar) == FAIL)
3482 error = TRUE;
3486 if (!eap->skip)
3487 clear_lval(&lv);
3489 arg = skipwhite(name_end);
3490 } while (!ends_excmd(*arg));
3492 eap->nextcmd = check_nextcmd(arg);
3495 static int
3496 do_unlet_var(lp, name_end, forceit)
3497 lval_T *lp;
3498 char_u *name_end;
3499 int forceit;
3501 int ret = OK;
3502 int cc;
3504 if (lp->ll_tv == NULL)
3506 cc = *name_end;
3507 *name_end = NUL;
3509 /* Normal name or expanded name. */
3510 if (check_changedtick(lp->ll_name))
3511 ret = FAIL;
3512 else if (do_unlet(lp->ll_name, forceit) == FAIL)
3513 ret = FAIL;
3514 *name_end = cc;
3516 else if (tv_check_lock(lp->ll_tv->v_lock, lp->ll_name))
3517 return FAIL;
3518 else if (lp->ll_range)
3520 listitem_T *li;
3522 /* Delete a range of List items. */
3523 while (lp->ll_li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3525 li = lp->ll_li->li_next;
3526 listitem_remove(lp->ll_list, lp->ll_li);
3527 lp->ll_li = li;
3528 ++lp->ll_n1;
3531 else
3533 if (lp->ll_list != NULL)
3534 /* unlet a List item. */
3535 listitem_remove(lp->ll_list, lp->ll_li);
3536 else
3537 /* unlet a Dictionary item. */
3538 dictitem_remove(lp->ll_dict, lp->ll_di);
3541 return ret;
3545 * "unlet" a variable. Return OK if it existed, FAIL if not.
3546 * When "forceit" is TRUE don't complain if the variable doesn't exist.
3549 do_unlet(name, forceit)
3550 char_u *name;
3551 int forceit;
3553 hashtab_T *ht;
3554 hashitem_T *hi;
3555 char_u *varname;
3556 dictitem_T *di;
3558 ht = find_var_ht(name, &varname);
3559 if (ht != NULL && *varname != NUL)
3561 hi = hash_find(ht, varname);
3562 if (!HASHITEM_EMPTY(hi))
3564 di = HI2DI(hi);
3565 if (var_check_fixed(di->di_flags, name)
3566 || var_check_ro(di->di_flags, name))
3567 return FAIL;
3568 delete_var(ht, hi);
3569 return OK;
3572 if (forceit)
3573 return OK;
3574 EMSG2(_("E108: No such variable: \"%s\""), name);
3575 return FAIL;
3579 * Lock or unlock variable indicated by "lp".
3580 * "deep" is the levels to go (-1 for unlimited);
3581 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
3583 static int
3584 do_lock_var(lp, name_end, deep, lock)
3585 lval_T *lp;
3586 char_u *name_end;
3587 int deep;
3588 int lock;
3590 int ret = OK;
3591 int cc;
3592 dictitem_T *di;
3594 if (deep == 0) /* nothing to do */
3595 return OK;
3597 if (lp->ll_tv == NULL)
3599 cc = *name_end;
3600 *name_end = NUL;
3602 /* Normal name or expanded name. */
3603 if (check_changedtick(lp->ll_name))
3604 ret = FAIL;
3605 else
3607 di = find_var(lp->ll_name, NULL);
3608 if (di == NULL)
3609 ret = FAIL;
3610 else
3612 if (lock)
3613 di->di_flags |= DI_FLAGS_LOCK;
3614 else
3615 di->di_flags &= ~DI_FLAGS_LOCK;
3616 item_lock(&di->di_tv, deep, lock);
3619 *name_end = cc;
3621 else if (lp->ll_range)
3623 listitem_T *li = lp->ll_li;
3625 /* (un)lock a range of List items. */
3626 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
3628 item_lock(&li->li_tv, deep, lock);
3629 li = li->li_next;
3630 ++lp->ll_n1;
3633 else if (lp->ll_list != NULL)
3634 /* (un)lock a List item. */
3635 item_lock(&lp->ll_li->li_tv, deep, lock);
3636 else
3637 /* un(lock) a Dictionary item. */
3638 item_lock(&lp->ll_di->di_tv, deep, lock);
3640 return ret;
3644 * Lock or unlock an item. "deep" is nr of levels to go.
3646 static void
3647 item_lock(tv, deep, lock)
3648 typval_T *tv;
3649 int deep;
3650 int lock;
3652 static int recurse = 0;
3653 list_T *l;
3654 listitem_T *li;
3655 dict_T *d;
3656 hashitem_T *hi;
3657 int todo;
3659 if (recurse >= DICT_MAXNEST)
3661 EMSG(_("E743: variable nested too deep for (un)lock"));
3662 return;
3664 if (deep == 0)
3665 return;
3666 ++recurse;
3668 /* lock/unlock the item itself */
3669 if (lock)
3670 tv->v_lock |= VAR_LOCKED;
3671 else
3672 tv->v_lock &= ~VAR_LOCKED;
3674 switch (tv->v_type)
3676 case VAR_LIST:
3677 if ((l = tv->vval.v_list) != NULL)
3679 if (lock)
3680 l->lv_lock |= VAR_LOCKED;
3681 else
3682 l->lv_lock &= ~VAR_LOCKED;
3683 if (deep < 0 || deep > 1)
3684 /* recursive: lock/unlock the items the List contains */
3685 for (li = l->lv_first; li != NULL; li = li->li_next)
3686 item_lock(&li->li_tv, deep - 1, lock);
3688 break;
3689 case VAR_DICT:
3690 if ((d = tv->vval.v_dict) != NULL)
3692 if (lock)
3693 d->dv_lock |= VAR_LOCKED;
3694 else
3695 d->dv_lock &= ~VAR_LOCKED;
3696 if (deep < 0 || deep > 1)
3698 /* recursive: lock/unlock the items the List contains */
3699 todo = (int)d->dv_hashtab.ht_used;
3700 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
3702 if (!HASHITEM_EMPTY(hi))
3704 --todo;
3705 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock);
3711 --recurse;
3715 * Return TRUE if typeval "tv" is locked: Either that value is locked itself
3716 * or it refers to a List or Dictionary that is locked.
3718 static int
3719 tv_islocked(tv)
3720 typval_T *tv;
3722 return (tv->v_lock & VAR_LOCKED)
3723 || (tv->v_type == VAR_LIST
3724 && tv->vval.v_list != NULL
3725 && (tv->vval.v_list->lv_lock & VAR_LOCKED))
3726 || (tv->v_type == VAR_DICT
3727 && tv->vval.v_dict != NULL
3728 && (tv->vval.v_dict->dv_lock & VAR_LOCKED));
3731 #if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
3733 * Delete all "menutrans_" variables.
3735 void
3736 del_menutrans_vars()
3738 hashitem_T *hi;
3739 int todo;
3741 hash_lock(&globvarht);
3742 todo = (int)globvarht.ht_used;
3743 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
3745 if (!HASHITEM_EMPTY(hi))
3747 --todo;
3748 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
3749 delete_var(&globvarht, hi);
3752 hash_unlock(&globvarht);
3754 #endif
3756 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3759 * Local string buffer for the next two functions to store a variable name
3760 * with its prefix. Allocated in cat_prefix_varname(), freed later in
3761 * get_user_var_name().
3764 static char_u *cat_prefix_varname __ARGS((int prefix, char_u *name));
3766 static char_u *varnamebuf = NULL;
3767 static int varnamebuflen = 0;
3770 * Function to concatenate a prefix and a variable name.
3772 static char_u *
3773 cat_prefix_varname(prefix, name)
3774 int prefix;
3775 char_u *name;
3777 int len;
3779 len = (int)STRLEN(name) + 3;
3780 if (len > varnamebuflen)
3782 vim_free(varnamebuf);
3783 len += 10; /* some additional space */
3784 varnamebuf = alloc(len);
3785 if (varnamebuf == NULL)
3787 varnamebuflen = 0;
3788 return NULL;
3790 varnamebuflen = len;
3792 *varnamebuf = prefix;
3793 varnamebuf[1] = ':';
3794 STRCPY(varnamebuf + 2, name);
3795 return varnamebuf;
3799 * Function given to ExpandGeneric() to obtain the list of user defined
3800 * (global/buffer/window/built-in) variable names.
3802 char_u *
3803 get_user_var_name(xp, idx)
3804 expand_T *xp;
3805 int idx;
3807 static long_u gdone;
3808 static long_u bdone;
3809 static long_u wdone;
3810 #ifdef FEAT_WINDOWS
3811 static long_u tdone;
3812 #endif
3813 static int vidx;
3814 static hashitem_T *hi;
3815 hashtab_T *ht;
3817 if (idx == 0)
3819 gdone = bdone = wdone = vidx = 0;
3820 #ifdef FEAT_WINDOWS
3821 tdone = 0;
3822 #endif
3825 /* Global variables */
3826 if (gdone < globvarht.ht_used)
3828 if (gdone++ == 0)
3829 hi = globvarht.ht_array;
3830 else
3831 ++hi;
3832 while (HASHITEM_EMPTY(hi))
3833 ++hi;
3834 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
3835 return cat_prefix_varname('g', hi->hi_key);
3836 return hi->hi_key;
3839 /* b: variables */
3840 ht = &curbuf->b_vars.dv_hashtab;
3841 if (bdone < ht->ht_used)
3843 if (bdone++ == 0)
3844 hi = ht->ht_array;
3845 else
3846 ++hi;
3847 while (HASHITEM_EMPTY(hi))
3848 ++hi;
3849 return cat_prefix_varname('b', hi->hi_key);
3851 if (bdone == ht->ht_used)
3853 ++bdone;
3854 return (char_u *)"b:changedtick";
3857 /* w: variables */
3858 ht = &curwin->w_vars.dv_hashtab;
3859 if (wdone < ht->ht_used)
3861 if (wdone++ == 0)
3862 hi = ht->ht_array;
3863 else
3864 ++hi;
3865 while (HASHITEM_EMPTY(hi))
3866 ++hi;
3867 return cat_prefix_varname('w', hi->hi_key);
3870 #ifdef FEAT_WINDOWS
3871 /* t: variables */
3872 ht = &curtab->tp_vars.dv_hashtab;
3873 if (tdone < ht->ht_used)
3875 if (tdone++ == 0)
3876 hi = ht->ht_array;
3877 else
3878 ++hi;
3879 while (HASHITEM_EMPTY(hi))
3880 ++hi;
3881 return cat_prefix_varname('t', hi->hi_key);
3883 #endif
3885 /* v: variables */
3886 if (vidx < VV_LEN)
3887 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
3889 vim_free(varnamebuf);
3890 varnamebuf = NULL;
3891 varnamebuflen = 0;
3892 return NULL;
3895 #endif /* FEAT_CMDL_COMPL */
3898 * types for expressions.
3900 typedef enum
3902 TYPE_UNKNOWN = 0
3903 , TYPE_EQUAL /* == */
3904 , TYPE_NEQUAL /* != */
3905 , TYPE_GREATER /* > */
3906 , TYPE_GEQUAL /* >= */
3907 , TYPE_SMALLER /* < */
3908 , TYPE_SEQUAL /* <= */
3909 , TYPE_MATCH /* =~ */
3910 , TYPE_NOMATCH /* !~ */
3911 } exptype_T;
3914 * The "evaluate" argument: When FALSE, the argument is only parsed but not
3915 * executed. The function may return OK, but the rettv will be of type
3916 * VAR_UNKNOWN. The function still returns FAIL for a syntax error.
3920 * Handle zero level expression.
3921 * This calls eval1() and handles error message and nextcmd.
3922 * Put the result in "rettv" when returning OK and "evaluate" is TRUE.
3923 * Note: "rettv.v_lock" is not set.
3924 * Return OK or FAIL.
3926 static int
3927 eval0(arg, rettv, nextcmd, evaluate)
3928 char_u *arg;
3929 typval_T *rettv;
3930 char_u **nextcmd;
3931 int evaluate;
3933 int ret;
3934 char_u *p;
3936 p = skipwhite(arg);
3937 ret = eval1(&p, rettv, evaluate);
3938 if (ret == FAIL || !ends_excmd(*p))
3940 if (ret != FAIL)
3941 clear_tv(rettv);
3943 * Report the invalid expression unless the expression evaluation has
3944 * been cancelled due to an aborting error, an interrupt, or an
3945 * exception.
3947 if (!aborting())
3948 EMSG2(_(e_invexpr2), arg);
3949 ret = FAIL;
3951 if (nextcmd != NULL)
3952 *nextcmd = check_nextcmd(p);
3954 return ret;
3958 * Handle top level expression:
3959 * expr2 ? expr1 : expr1
3961 * "arg" must point to the first non-white of the expression.
3962 * "arg" is advanced to the next non-white after the recognized expression.
3964 * Note: "rettv.v_lock" is not set.
3966 * Return OK or FAIL.
3968 static int
3969 eval1(arg, rettv, evaluate)
3970 char_u **arg;
3971 typval_T *rettv;
3972 int evaluate;
3974 int result;
3975 typval_T var2;
3978 * Get the first variable.
3980 if (eval2(arg, rettv, evaluate) == FAIL)
3981 return FAIL;
3983 if ((*arg)[0] == '?')
3985 result = FALSE;
3986 if (evaluate)
3988 int error = FALSE;
3990 if (get_tv_number_chk(rettv, &error) != 0)
3991 result = TRUE;
3992 clear_tv(rettv);
3993 if (error)
3994 return FAIL;
3998 * Get the second variable.
4000 *arg = skipwhite(*arg + 1);
4001 if (eval1(arg, rettv, evaluate && result) == FAIL) /* recursive! */
4002 return FAIL;
4005 * Check for the ":".
4007 if ((*arg)[0] != ':')
4009 EMSG(_("E109: Missing ':' after '?'"));
4010 if (evaluate && result)
4011 clear_tv(rettv);
4012 return FAIL;
4016 * Get the third variable.
4018 *arg = skipwhite(*arg + 1);
4019 if (eval1(arg, &var2, evaluate && !result) == FAIL) /* recursive! */
4021 if (evaluate && result)
4022 clear_tv(rettv);
4023 return FAIL;
4025 if (evaluate && !result)
4026 *rettv = var2;
4029 return OK;
4033 * Handle first level expression:
4034 * expr2 || expr2 || expr2 logical OR
4036 * "arg" must point to the first non-white of the expression.
4037 * "arg" is advanced to the next non-white after the recognized expression.
4039 * Return OK or FAIL.
4041 static int
4042 eval2(arg, rettv, evaluate)
4043 char_u **arg;
4044 typval_T *rettv;
4045 int evaluate;
4047 typval_T var2;
4048 long result;
4049 int first;
4050 int error = FALSE;
4053 * Get the first variable.
4055 if (eval3(arg, rettv, evaluate) == FAIL)
4056 return FAIL;
4059 * Repeat until there is no following "||".
4061 first = TRUE;
4062 result = FALSE;
4063 while ((*arg)[0] == '|' && (*arg)[1] == '|')
4065 if (evaluate && first)
4067 if (get_tv_number_chk(rettv, &error) != 0)
4068 result = TRUE;
4069 clear_tv(rettv);
4070 if (error)
4071 return FAIL;
4072 first = FALSE;
4076 * Get the second variable.
4078 *arg = skipwhite(*arg + 2);
4079 if (eval3(arg, &var2, evaluate && !result) == FAIL)
4080 return FAIL;
4083 * Compute the result.
4085 if (evaluate && !result)
4087 if (get_tv_number_chk(&var2, &error) != 0)
4088 result = TRUE;
4089 clear_tv(&var2);
4090 if (error)
4091 return FAIL;
4093 if (evaluate)
4095 rettv->v_type = VAR_NUMBER;
4096 rettv->vval.v_number = result;
4100 return OK;
4104 * Handle second level expression:
4105 * expr3 && expr3 && expr3 logical AND
4107 * "arg" must point to the first non-white of the expression.
4108 * "arg" is advanced to the next non-white after the recognized expression.
4110 * Return OK or FAIL.
4112 static int
4113 eval3(arg, rettv, evaluate)
4114 char_u **arg;
4115 typval_T *rettv;
4116 int evaluate;
4118 typval_T var2;
4119 long result;
4120 int first;
4121 int error = FALSE;
4124 * Get the first variable.
4126 if (eval4(arg, rettv, evaluate) == FAIL)
4127 return FAIL;
4130 * Repeat until there is no following "&&".
4132 first = TRUE;
4133 result = TRUE;
4134 while ((*arg)[0] == '&' && (*arg)[1] == '&')
4136 if (evaluate && first)
4138 if (get_tv_number_chk(rettv, &error) == 0)
4139 result = FALSE;
4140 clear_tv(rettv);
4141 if (error)
4142 return FAIL;
4143 first = FALSE;
4147 * Get the second variable.
4149 *arg = skipwhite(*arg + 2);
4150 if (eval4(arg, &var2, evaluate && result) == FAIL)
4151 return FAIL;
4154 * Compute the result.
4156 if (evaluate && result)
4158 if (get_tv_number_chk(&var2, &error) == 0)
4159 result = FALSE;
4160 clear_tv(&var2);
4161 if (error)
4162 return FAIL;
4164 if (evaluate)
4166 rettv->v_type = VAR_NUMBER;
4167 rettv->vval.v_number = result;
4171 return OK;
4175 * Handle third level expression:
4176 * var1 == var2
4177 * var1 =~ var2
4178 * var1 != var2
4179 * var1 !~ var2
4180 * var1 > var2
4181 * var1 >= var2
4182 * var1 < var2
4183 * var1 <= var2
4184 * var1 is var2
4185 * var1 isnot var2
4187 * "arg" must point to the first non-white of the expression.
4188 * "arg" is advanced to the next non-white after the recognized expression.
4190 * Return OK or FAIL.
4192 static int
4193 eval4(arg, rettv, evaluate)
4194 char_u **arg;
4195 typval_T *rettv;
4196 int evaluate;
4198 typval_T var2;
4199 char_u *p;
4200 int i;
4201 exptype_T type = TYPE_UNKNOWN;
4202 int type_is = FALSE; /* TRUE for "is" and "isnot" */
4203 int len = 2;
4204 long n1, n2;
4205 char_u *s1, *s2;
4206 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4207 regmatch_T regmatch;
4208 int ic;
4209 char_u *save_cpo;
4212 * Get the first variable.
4214 if (eval5(arg, rettv, evaluate) == FAIL)
4215 return FAIL;
4217 p = *arg;
4218 switch (p[0])
4220 case '=': if (p[1] == '=')
4221 type = TYPE_EQUAL;
4222 else if (p[1] == '~')
4223 type = TYPE_MATCH;
4224 break;
4225 case '!': if (p[1] == '=')
4226 type = TYPE_NEQUAL;
4227 else if (p[1] == '~')
4228 type = TYPE_NOMATCH;
4229 break;
4230 case '>': if (p[1] != '=')
4232 type = TYPE_GREATER;
4233 len = 1;
4235 else
4236 type = TYPE_GEQUAL;
4237 break;
4238 case '<': if (p[1] != '=')
4240 type = TYPE_SMALLER;
4241 len = 1;
4243 else
4244 type = TYPE_SEQUAL;
4245 break;
4246 case 'i': if (p[1] == 's')
4248 if (p[2] == 'n' && p[3] == 'o' && p[4] == 't')
4249 len = 5;
4250 if (!vim_isIDc(p[len]))
4252 type = len == 2 ? TYPE_EQUAL : TYPE_NEQUAL;
4253 type_is = TRUE;
4256 break;
4260 * If there is a comparative operator, use it.
4262 if (type != TYPE_UNKNOWN)
4264 /* extra question mark appended: ignore case */
4265 if (p[len] == '?')
4267 ic = TRUE;
4268 ++len;
4270 /* extra '#' appended: match case */
4271 else if (p[len] == '#')
4273 ic = FALSE;
4274 ++len;
4276 /* nothing appended: use 'ignorecase' */
4277 else
4278 ic = p_ic;
4281 * Get the second variable.
4283 *arg = skipwhite(p + len);
4284 if (eval5(arg, &var2, evaluate) == FAIL)
4286 clear_tv(rettv);
4287 return FAIL;
4290 if (evaluate)
4292 if (type_is && rettv->v_type != var2.v_type)
4294 /* For "is" a different type always means FALSE, for "notis"
4295 * it means TRUE. */
4296 n1 = (type == TYPE_NEQUAL);
4298 else if (rettv->v_type == VAR_LIST || var2.v_type == VAR_LIST)
4300 if (type_is)
4302 n1 = (rettv->v_type == var2.v_type
4303 && rettv->vval.v_list == var2.vval.v_list);
4304 if (type == TYPE_NEQUAL)
4305 n1 = !n1;
4307 else if (rettv->v_type != var2.v_type
4308 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4310 if (rettv->v_type != var2.v_type)
4311 EMSG(_("E691: Can only compare List with List"));
4312 else
4313 EMSG(_("E692: Invalid operation for Lists"));
4314 clear_tv(rettv);
4315 clear_tv(&var2);
4316 return FAIL;
4318 else
4320 /* Compare two Lists for being equal or unequal. */
4321 n1 = list_equal(rettv->vval.v_list, var2.vval.v_list, ic);
4322 if (type == TYPE_NEQUAL)
4323 n1 = !n1;
4327 else if (rettv->v_type == VAR_DICT || var2.v_type == VAR_DICT)
4329 if (type_is)
4331 n1 = (rettv->v_type == var2.v_type
4332 && rettv->vval.v_dict == var2.vval.v_dict);
4333 if (type == TYPE_NEQUAL)
4334 n1 = !n1;
4336 else if (rettv->v_type != var2.v_type
4337 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4339 if (rettv->v_type != var2.v_type)
4340 EMSG(_("E735: Can only compare Dictionary with Dictionary"));
4341 else
4342 EMSG(_("E736: Invalid operation for Dictionary"));
4343 clear_tv(rettv);
4344 clear_tv(&var2);
4345 return FAIL;
4347 else
4349 /* Compare two Dictionaries for being equal or unequal. */
4350 n1 = dict_equal(rettv->vval.v_dict, var2.vval.v_dict, ic);
4351 if (type == TYPE_NEQUAL)
4352 n1 = !n1;
4356 else if (rettv->v_type == VAR_FUNC || var2.v_type == VAR_FUNC)
4358 if (rettv->v_type != var2.v_type
4359 || (type != TYPE_EQUAL && type != TYPE_NEQUAL))
4361 if (rettv->v_type != var2.v_type)
4362 EMSG(_("E693: Can only compare Funcref with Funcref"));
4363 else
4364 EMSG(_("E694: Invalid operation for Funcrefs"));
4365 clear_tv(rettv);
4366 clear_tv(&var2);
4367 return FAIL;
4369 else
4371 /* Compare two Funcrefs for being equal or unequal. */
4372 if (rettv->vval.v_string == NULL
4373 || var2.vval.v_string == NULL)
4374 n1 = FALSE;
4375 else
4376 n1 = STRCMP(rettv->vval.v_string,
4377 var2.vval.v_string) == 0;
4378 if (type == TYPE_NEQUAL)
4379 n1 = !n1;
4383 #ifdef FEAT_FLOAT
4385 * If one of the two variables is a float, compare as a float.
4386 * When using "=~" or "!~", always compare as string.
4388 else if ((rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4389 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4391 float_T f1, f2;
4393 if (rettv->v_type == VAR_FLOAT)
4394 f1 = rettv->vval.v_float;
4395 else
4396 f1 = get_tv_number(rettv);
4397 if (var2.v_type == VAR_FLOAT)
4398 f2 = var2.vval.v_float;
4399 else
4400 f2 = get_tv_number(&var2);
4401 n1 = FALSE;
4402 switch (type)
4404 case TYPE_EQUAL: n1 = (f1 == f2); break;
4405 case TYPE_NEQUAL: n1 = (f1 != f2); break;
4406 case TYPE_GREATER: n1 = (f1 > f2); break;
4407 case TYPE_GEQUAL: n1 = (f1 >= f2); break;
4408 case TYPE_SMALLER: n1 = (f1 < f2); break;
4409 case TYPE_SEQUAL: n1 = (f1 <= f2); break;
4410 case TYPE_UNKNOWN:
4411 case TYPE_MATCH:
4412 case TYPE_NOMATCH: break; /* avoid gcc warning */
4415 #endif
4418 * If one of the two variables is a number, compare as a number.
4419 * When using "=~" or "!~", always compare as string.
4421 else if ((rettv->v_type == VAR_NUMBER || var2.v_type == VAR_NUMBER)
4422 && type != TYPE_MATCH && type != TYPE_NOMATCH)
4424 n1 = get_tv_number(rettv);
4425 n2 = get_tv_number(&var2);
4426 switch (type)
4428 case TYPE_EQUAL: n1 = (n1 == n2); break;
4429 case TYPE_NEQUAL: n1 = (n1 != n2); break;
4430 case TYPE_GREATER: n1 = (n1 > n2); break;
4431 case TYPE_GEQUAL: n1 = (n1 >= n2); break;
4432 case TYPE_SMALLER: n1 = (n1 < n2); break;
4433 case TYPE_SEQUAL: n1 = (n1 <= n2); break;
4434 case TYPE_UNKNOWN:
4435 case TYPE_MATCH:
4436 case TYPE_NOMATCH: break; /* avoid gcc warning */
4439 else
4441 s1 = get_tv_string_buf(rettv, buf1);
4442 s2 = get_tv_string_buf(&var2, buf2);
4443 if (type != TYPE_MATCH && type != TYPE_NOMATCH)
4444 i = ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2);
4445 else
4446 i = 0;
4447 n1 = FALSE;
4448 switch (type)
4450 case TYPE_EQUAL: n1 = (i == 0); break;
4451 case TYPE_NEQUAL: n1 = (i != 0); break;
4452 case TYPE_GREATER: n1 = (i > 0); break;
4453 case TYPE_GEQUAL: n1 = (i >= 0); break;
4454 case TYPE_SMALLER: n1 = (i < 0); break;
4455 case TYPE_SEQUAL: n1 = (i <= 0); break;
4457 case TYPE_MATCH:
4458 case TYPE_NOMATCH:
4459 /* avoid 'l' flag in 'cpoptions' */
4460 save_cpo = p_cpo;
4461 p_cpo = (char_u *)"";
4462 regmatch.regprog = vim_regcomp(s2,
4463 RE_MAGIC + RE_STRING);
4464 regmatch.rm_ic = ic;
4465 if (regmatch.regprog != NULL)
4467 n1 = vim_regexec_nl(&regmatch, s1, (colnr_T)0);
4468 vim_free(regmatch.regprog);
4469 if (type == TYPE_NOMATCH)
4470 n1 = !n1;
4472 p_cpo = save_cpo;
4473 break;
4475 case TYPE_UNKNOWN: break; /* avoid gcc warning */
4478 clear_tv(rettv);
4479 clear_tv(&var2);
4480 rettv->v_type = VAR_NUMBER;
4481 rettv->vval.v_number = n1;
4485 return OK;
4489 * Handle fourth level expression:
4490 * + number addition
4491 * - number subtraction
4492 * . string concatenation
4494 * "arg" must point to the first non-white of the expression.
4495 * "arg" is advanced to the next non-white after the recognized expression.
4497 * Return OK or FAIL.
4499 static int
4500 eval5(arg, rettv, evaluate)
4501 char_u **arg;
4502 typval_T *rettv;
4503 int evaluate;
4505 typval_T var2;
4506 typval_T var3;
4507 int op;
4508 long n1, n2;
4509 #ifdef FEAT_FLOAT
4510 float_T f1 = 0, f2 = 0;
4511 #endif
4512 char_u *s1, *s2;
4513 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
4514 char_u *p;
4517 * Get the first variable.
4519 if (eval6(arg, rettv, evaluate, FALSE) == FAIL)
4520 return FAIL;
4523 * Repeat computing, until no '+', '-' or '.' is following.
4525 for (;;)
4527 op = **arg;
4528 if (op != '+' && op != '-' && op != '.')
4529 break;
4531 if ((op != '+' || rettv->v_type != VAR_LIST)
4532 #ifdef FEAT_FLOAT
4533 && (op == '.' || rettv->v_type != VAR_FLOAT)
4534 #endif
4537 /* For "list + ...", an illegal use of the first operand as
4538 * a number cannot be determined before evaluating the 2nd
4539 * operand: if this is also a list, all is ok.
4540 * For "something . ...", "something - ..." or "non-list + ...",
4541 * we know that the first operand needs to be a string or number
4542 * without evaluating the 2nd operand. So check before to avoid
4543 * side effects after an error. */
4544 if (evaluate && get_tv_string_chk(rettv) == NULL)
4546 clear_tv(rettv);
4547 return FAIL;
4552 * Get the second variable.
4554 *arg = skipwhite(*arg + 1);
4555 if (eval6(arg, &var2, evaluate, op == '.') == FAIL)
4557 clear_tv(rettv);
4558 return FAIL;
4561 if (evaluate)
4564 * Compute the result.
4566 if (op == '.')
4568 s1 = get_tv_string_buf(rettv, buf1); /* already checked */
4569 s2 = get_tv_string_buf_chk(&var2, buf2);
4570 if (s2 == NULL) /* type error ? */
4572 clear_tv(rettv);
4573 clear_tv(&var2);
4574 return FAIL;
4576 p = concat_str(s1, s2);
4577 clear_tv(rettv);
4578 rettv->v_type = VAR_STRING;
4579 rettv->vval.v_string = p;
4581 else if (op == '+' && rettv->v_type == VAR_LIST
4582 && var2.v_type == VAR_LIST)
4584 /* concatenate Lists */
4585 if (list_concat(rettv->vval.v_list, var2.vval.v_list,
4586 &var3) == FAIL)
4588 clear_tv(rettv);
4589 clear_tv(&var2);
4590 return FAIL;
4592 clear_tv(rettv);
4593 *rettv = var3;
4595 else
4597 int error = FALSE;
4599 #ifdef FEAT_FLOAT
4600 if (rettv->v_type == VAR_FLOAT)
4602 f1 = rettv->vval.v_float;
4603 n1 = 0;
4605 else
4606 #endif
4608 n1 = get_tv_number_chk(rettv, &error);
4609 if (error)
4611 /* This can only happen for "list + non-list". For
4612 * "non-list + ..." or "something - ...", we returned
4613 * before evaluating the 2nd operand. */
4614 clear_tv(rettv);
4615 return FAIL;
4617 #ifdef FEAT_FLOAT
4618 if (var2.v_type == VAR_FLOAT)
4619 f1 = n1;
4620 #endif
4622 #ifdef FEAT_FLOAT
4623 if (var2.v_type == VAR_FLOAT)
4625 f2 = var2.vval.v_float;
4626 n2 = 0;
4628 else
4629 #endif
4631 n2 = get_tv_number_chk(&var2, &error);
4632 if (error)
4634 clear_tv(rettv);
4635 clear_tv(&var2);
4636 return FAIL;
4638 #ifdef FEAT_FLOAT
4639 if (rettv->v_type == VAR_FLOAT)
4640 f2 = n2;
4641 #endif
4643 clear_tv(rettv);
4645 #ifdef FEAT_FLOAT
4646 /* If there is a float on either side the result is a float. */
4647 if (rettv->v_type == VAR_FLOAT || var2.v_type == VAR_FLOAT)
4649 if (op == '+')
4650 f1 = f1 + f2;
4651 else
4652 f1 = f1 - f2;
4653 rettv->v_type = VAR_FLOAT;
4654 rettv->vval.v_float = f1;
4656 else
4657 #endif
4659 if (op == '+')
4660 n1 = n1 + n2;
4661 else
4662 n1 = n1 - n2;
4663 rettv->v_type = VAR_NUMBER;
4664 rettv->vval.v_number = n1;
4667 clear_tv(&var2);
4670 return OK;
4674 * Handle fifth level expression:
4675 * * number multiplication
4676 * / number division
4677 * % number modulo
4679 * "arg" must point to the first non-white of the expression.
4680 * "arg" is advanced to the next non-white after the recognized expression.
4682 * Return OK or FAIL.
4684 static int
4685 eval6(arg, rettv, evaluate, want_string)
4686 char_u **arg;
4687 typval_T *rettv;
4688 int evaluate;
4689 int want_string; /* after "." operator */
4691 typval_T var2;
4692 int op;
4693 long n1, n2;
4694 #ifdef FEAT_FLOAT
4695 int use_float = FALSE;
4696 float_T f1 = 0, f2;
4697 #endif
4698 int error = FALSE;
4701 * Get the first variable.
4703 if (eval7(arg, rettv, evaluate, want_string) == FAIL)
4704 return FAIL;
4707 * Repeat computing, until no '*', '/' or '%' is following.
4709 for (;;)
4711 op = **arg;
4712 if (op != '*' && op != '/' && op != '%')
4713 break;
4715 if (evaluate)
4717 #ifdef FEAT_FLOAT
4718 if (rettv->v_type == VAR_FLOAT)
4720 f1 = rettv->vval.v_float;
4721 use_float = TRUE;
4722 n1 = 0;
4724 else
4725 #endif
4726 n1 = get_tv_number_chk(rettv, &error);
4727 clear_tv(rettv);
4728 if (error)
4729 return FAIL;
4731 else
4732 n1 = 0;
4735 * Get the second variable.
4737 *arg = skipwhite(*arg + 1);
4738 if (eval7(arg, &var2, evaluate, FALSE) == FAIL)
4739 return FAIL;
4741 if (evaluate)
4743 #ifdef FEAT_FLOAT
4744 if (var2.v_type == VAR_FLOAT)
4746 if (!use_float)
4748 f1 = n1;
4749 use_float = TRUE;
4751 f2 = var2.vval.v_float;
4752 n2 = 0;
4754 else
4755 #endif
4757 n2 = get_tv_number_chk(&var2, &error);
4758 clear_tv(&var2);
4759 if (error)
4760 return FAIL;
4761 #ifdef FEAT_FLOAT
4762 if (use_float)
4763 f2 = n2;
4764 #endif
4768 * Compute the result.
4769 * When either side is a float the result is a float.
4771 #ifdef FEAT_FLOAT
4772 if (use_float)
4774 if (op == '*')
4775 f1 = f1 * f2;
4776 else if (op == '/')
4778 /* We rely on the floating point library to handle divide
4779 * by zero to result in "inf" and not a crash. */
4780 f1 = f1 / f2;
4782 else
4784 EMSG(_("E804: Cannot use '%' with Float"));
4785 return FAIL;
4787 rettv->v_type = VAR_FLOAT;
4788 rettv->vval.v_float = f1;
4790 else
4791 #endif
4793 if (op == '*')
4794 n1 = n1 * n2;
4795 else if (op == '/')
4797 if (n2 == 0) /* give an error message? */
4799 if (n1 == 0)
4800 n1 = -0x7fffffffL - 1L; /* similar to NaN */
4801 else if (n1 < 0)
4802 n1 = -0x7fffffffL;
4803 else
4804 n1 = 0x7fffffffL;
4806 else
4807 n1 = n1 / n2;
4809 else
4811 if (n2 == 0) /* give an error message? */
4812 n1 = 0;
4813 else
4814 n1 = n1 % n2;
4816 rettv->v_type = VAR_NUMBER;
4817 rettv->vval.v_number = n1;
4822 return OK;
4826 * Handle sixth level expression:
4827 * number number constant
4828 * "string" string constant
4829 * 'string' literal string constant
4830 * &option-name option value
4831 * @r register contents
4832 * identifier variable value
4833 * function() function call
4834 * $VAR environment variable
4835 * (expression) nested expression
4836 * [expr, expr] List
4837 * {key: val, key: val} Dictionary
4839 * Also handle:
4840 * ! in front logical NOT
4841 * - in front unary minus
4842 * + in front unary plus (ignored)
4843 * trailing [] subscript in String or List
4844 * trailing .name entry in Dictionary
4846 * "arg" must point to the first non-white of the expression.
4847 * "arg" is advanced to the next non-white after the recognized expression.
4849 * Return OK or FAIL.
4851 static int
4852 eval7(arg, rettv, evaluate, want_string)
4853 char_u **arg;
4854 typval_T *rettv;
4855 int evaluate;
4856 int want_string; /* after "." operator */
4858 long n;
4859 int len;
4860 char_u *s;
4861 char_u *start_leader, *end_leader;
4862 int ret = OK;
4863 char_u *alias;
4866 * Initialise variable so that clear_tv() can't mistake this for a
4867 * string and free a string that isn't there.
4869 rettv->v_type = VAR_UNKNOWN;
4872 * Skip '!' and '-' characters. They are handled later.
4874 start_leader = *arg;
4875 while (**arg == '!' || **arg == '-' || **arg == '+')
4876 *arg = skipwhite(*arg + 1);
4877 end_leader = *arg;
4879 switch (**arg)
4882 * Number constant.
4884 case '0':
4885 case '1':
4886 case '2':
4887 case '3':
4888 case '4':
4889 case '5':
4890 case '6':
4891 case '7':
4892 case '8':
4893 case '9':
4895 #ifdef FEAT_FLOAT
4896 char_u *p = skipdigits(*arg + 1);
4897 int get_float = FALSE;
4899 /* We accept a float when the format matches
4900 * "[0-9]\+\.[0-9]\+\([eE][+-]\?[0-9]\+\)\?". This is very
4901 * strict to avoid backwards compatibility problems.
4902 * Don't look for a float after the "." operator, so that
4903 * ":let vers = 1.2.3" doesn't fail. */
4904 if (!want_string && p[0] == '.' && vim_isdigit(p[1]))
4906 get_float = TRUE;
4907 p = skipdigits(p + 2);
4908 if (*p == 'e' || *p == 'E')
4910 ++p;
4911 if (*p == '-' || *p == '+')
4912 ++p;
4913 if (!vim_isdigit(*p))
4914 get_float = FALSE;
4915 else
4916 p = skipdigits(p + 1);
4918 if (ASCII_ISALPHA(*p) || *p == '.')
4919 get_float = FALSE;
4921 if (get_float)
4923 float_T f;
4925 *arg += string2float(*arg, &f);
4926 if (evaluate)
4928 rettv->v_type = VAR_FLOAT;
4929 rettv->vval.v_float = f;
4932 else
4933 #endif
4935 vim_str2nr(*arg, NULL, &len, TRUE, TRUE, &n, NULL);
4936 *arg += len;
4937 if (evaluate)
4939 rettv->v_type = VAR_NUMBER;
4940 rettv->vval.v_number = n;
4943 break;
4947 * String constant: "string".
4949 case '"': ret = get_string_tv(arg, rettv, evaluate);
4950 break;
4953 * Literal string constant: 'str''ing'.
4955 case '\'': ret = get_lit_string_tv(arg, rettv, evaluate);
4956 break;
4959 * List: [expr, expr]
4961 case '[': ret = get_list_tv(arg, rettv, evaluate);
4962 break;
4965 * Dictionary: {key: val, key: val}
4967 case '{': ret = get_dict_tv(arg, rettv, evaluate);
4968 break;
4971 * Option value: &name
4973 case '&': ret = get_option_tv(arg, rettv, evaluate);
4974 break;
4977 * Environment variable: $VAR.
4979 case '$': ret = get_env_tv(arg, rettv, evaluate);
4980 break;
4983 * Register contents: @r.
4985 case '@': ++*arg;
4986 if (evaluate)
4988 rettv->v_type = VAR_STRING;
4989 rettv->vval.v_string = get_reg_contents(**arg, TRUE, TRUE);
4991 if (**arg != NUL)
4992 ++*arg;
4993 break;
4996 * nested expression: (expression).
4998 case '(': *arg = skipwhite(*arg + 1);
4999 ret = eval1(arg, rettv, evaluate); /* recursive! */
5000 if (**arg == ')')
5001 ++*arg;
5002 else if (ret == OK)
5004 EMSG(_("E110: Missing ')'"));
5005 clear_tv(rettv);
5006 ret = FAIL;
5008 break;
5010 default: ret = NOTDONE;
5011 break;
5014 if (ret == NOTDONE)
5017 * Must be a variable or function name.
5018 * Can also be a curly-braces kind of name: {expr}.
5020 s = *arg;
5021 len = get_name_len(arg, &alias, evaluate, TRUE);
5022 if (alias != NULL)
5023 s = alias;
5025 if (len <= 0)
5026 ret = FAIL;
5027 else
5029 if (**arg == '(') /* recursive! */
5031 /* If "s" is the name of a variable of type VAR_FUNC
5032 * use its contents. */
5033 s = deref_func_name(s, &len);
5035 /* Invoke the function. */
5036 ret = get_func_tv(s, len, rettv, arg,
5037 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
5038 &len, evaluate, NULL);
5039 /* Stop the expression evaluation when immediately
5040 * aborting on error, or when an interrupt occurred or
5041 * an exception was thrown but not caught. */
5042 if (aborting())
5044 if (ret == OK)
5045 clear_tv(rettv);
5046 ret = FAIL;
5049 else if (evaluate)
5050 ret = get_var_tv(s, len, rettv, TRUE);
5051 else
5052 ret = OK;
5055 if (alias != NULL)
5056 vim_free(alias);
5059 *arg = skipwhite(*arg);
5061 /* Handle following '[', '(' and '.' for expr[expr], expr.name,
5062 * expr(expr). */
5063 if (ret == OK)
5064 ret = handle_subscript(arg, rettv, evaluate, TRUE);
5067 * Apply logical NOT and unary '-', from right to left, ignore '+'.
5069 if (ret == OK && evaluate && end_leader > start_leader)
5071 int error = FALSE;
5072 int val = 0;
5073 #ifdef FEAT_FLOAT
5074 float_T f = 0.0;
5076 if (rettv->v_type == VAR_FLOAT)
5077 f = rettv->vval.v_float;
5078 else
5079 #endif
5080 val = get_tv_number_chk(rettv, &error);
5081 if (error)
5083 clear_tv(rettv);
5084 ret = FAIL;
5086 else
5088 while (end_leader > start_leader)
5090 --end_leader;
5091 if (*end_leader == '!')
5093 #ifdef FEAT_FLOAT
5094 if (rettv->v_type == VAR_FLOAT)
5095 f = !f;
5096 else
5097 #endif
5098 val = !val;
5100 else if (*end_leader == '-')
5102 #ifdef FEAT_FLOAT
5103 if (rettv->v_type == VAR_FLOAT)
5104 f = -f;
5105 else
5106 #endif
5107 val = -val;
5110 #ifdef FEAT_FLOAT
5111 if (rettv->v_type == VAR_FLOAT)
5113 clear_tv(rettv);
5114 rettv->vval.v_float = f;
5116 else
5117 #endif
5119 clear_tv(rettv);
5120 rettv->v_type = VAR_NUMBER;
5121 rettv->vval.v_number = val;
5126 return ret;
5130 * Evaluate an "[expr]" or "[expr:expr]" index. Also "dict.key".
5131 * "*arg" points to the '[' or '.'.
5132 * Returns FAIL or OK. "*arg" is advanced to after the ']'.
5134 static int
5135 eval_index(arg, rettv, evaluate, verbose)
5136 char_u **arg;
5137 typval_T *rettv;
5138 int evaluate;
5139 int verbose; /* give error messages */
5141 int empty1 = FALSE, empty2 = FALSE;
5142 typval_T var1, var2;
5143 long n1, n2 = 0;
5144 long len = -1;
5145 int range = FALSE;
5146 char_u *s;
5147 char_u *key = NULL;
5149 if (rettv->v_type == VAR_FUNC
5150 #ifdef FEAT_FLOAT
5151 || rettv->v_type == VAR_FLOAT
5152 #endif
5155 if (verbose)
5156 EMSG(_("E695: Cannot index a Funcref"));
5157 return FAIL;
5160 if (**arg == '.')
5163 * dict.name
5165 key = *arg + 1;
5166 for (len = 0; ASCII_ISALNUM(key[len]) || key[len] == '_'; ++len)
5168 if (len == 0)
5169 return FAIL;
5170 *arg = skipwhite(key + len);
5172 else
5175 * something[idx]
5177 * Get the (first) variable from inside the [].
5179 *arg = skipwhite(*arg + 1);
5180 if (**arg == ':')
5181 empty1 = TRUE;
5182 else if (eval1(arg, &var1, evaluate) == FAIL) /* recursive! */
5183 return FAIL;
5184 else if (evaluate && get_tv_string_chk(&var1) == NULL)
5186 /* not a number or string */
5187 clear_tv(&var1);
5188 return FAIL;
5192 * Get the second variable from inside the [:].
5194 if (**arg == ':')
5196 range = TRUE;
5197 *arg = skipwhite(*arg + 1);
5198 if (**arg == ']')
5199 empty2 = TRUE;
5200 else if (eval1(arg, &var2, evaluate) == FAIL) /* recursive! */
5202 if (!empty1)
5203 clear_tv(&var1);
5204 return FAIL;
5206 else if (evaluate && get_tv_string_chk(&var2) == NULL)
5208 /* not a number or string */
5209 if (!empty1)
5210 clear_tv(&var1);
5211 clear_tv(&var2);
5212 return FAIL;
5216 /* Check for the ']'. */
5217 if (**arg != ']')
5219 if (verbose)
5220 EMSG(_(e_missbrac));
5221 clear_tv(&var1);
5222 if (range)
5223 clear_tv(&var2);
5224 return FAIL;
5226 *arg = skipwhite(*arg + 1); /* skip the ']' */
5229 if (evaluate)
5231 n1 = 0;
5232 if (!empty1 && rettv->v_type != VAR_DICT)
5234 n1 = get_tv_number(&var1);
5235 clear_tv(&var1);
5237 if (range)
5239 if (empty2)
5240 n2 = -1;
5241 else
5243 n2 = get_tv_number(&var2);
5244 clear_tv(&var2);
5248 switch (rettv->v_type)
5250 case VAR_NUMBER:
5251 case VAR_STRING:
5252 s = get_tv_string(rettv);
5253 len = (long)STRLEN(s);
5254 if (range)
5256 /* The resulting variable is a substring. If the indexes
5257 * are out of range the result is empty. */
5258 if (n1 < 0)
5260 n1 = len + n1;
5261 if (n1 < 0)
5262 n1 = 0;
5264 if (n2 < 0)
5265 n2 = len + n2;
5266 else if (n2 >= len)
5267 n2 = len;
5268 if (n1 >= len || n2 < 0 || n1 > n2)
5269 s = NULL;
5270 else
5271 s = vim_strnsave(s + n1, (int)(n2 - n1 + 1));
5273 else
5275 /* The resulting variable is a string of a single
5276 * character. If the index is too big or negative the
5277 * result is empty. */
5278 if (n1 >= len || n1 < 0)
5279 s = NULL;
5280 else
5281 s = vim_strnsave(s + n1, 1);
5283 clear_tv(rettv);
5284 rettv->v_type = VAR_STRING;
5285 rettv->vval.v_string = s;
5286 break;
5288 case VAR_LIST:
5289 len = list_len(rettv->vval.v_list);
5290 if (n1 < 0)
5291 n1 = len + n1;
5292 if (!empty1 && (n1 < 0 || n1 >= len))
5294 /* For a range we allow invalid values and return an empty
5295 * list. A list index out of range is an error. */
5296 if (!range)
5298 if (verbose)
5299 EMSGN(_(e_listidx), n1);
5300 return FAIL;
5302 n1 = len;
5304 if (range)
5306 list_T *l;
5307 listitem_T *item;
5309 if (n2 < 0)
5310 n2 = len + n2;
5311 else if (n2 >= len)
5312 n2 = len - 1;
5313 if (!empty2 && (n2 < 0 || n2 + 1 < n1))
5314 n2 = -1;
5315 l = list_alloc();
5316 if (l == NULL)
5317 return FAIL;
5318 for (item = list_find(rettv->vval.v_list, n1);
5319 n1 <= n2; ++n1)
5321 if (list_append_tv(l, &item->li_tv) == FAIL)
5323 list_free(l, TRUE);
5324 return FAIL;
5326 item = item->li_next;
5328 clear_tv(rettv);
5329 rettv->v_type = VAR_LIST;
5330 rettv->vval.v_list = l;
5331 ++l->lv_refcount;
5333 else
5335 copy_tv(&list_find(rettv->vval.v_list, n1)->li_tv, &var1);
5336 clear_tv(rettv);
5337 *rettv = var1;
5339 break;
5341 case VAR_DICT:
5342 if (range)
5344 if (verbose)
5345 EMSG(_(e_dictrange));
5346 if (len == -1)
5347 clear_tv(&var1);
5348 return FAIL;
5351 dictitem_T *item;
5353 if (len == -1)
5355 key = get_tv_string(&var1);
5356 if (*key == NUL)
5358 if (verbose)
5359 EMSG(_(e_emptykey));
5360 clear_tv(&var1);
5361 return FAIL;
5365 item = dict_find(rettv->vval.v_dict, key, (int)len);
5367 if (item == NULL && verbose)
5368 EMSG2(_(e_dictkey), key);
5369 if (len == -1)
5370 clear_tv(&var1);
5371 if (item == NULL)
5372 return FAIL;
5374 copy_tv(&item->di_tv, &var1);
5375 clear_tv(rettv);
5376 *rettv = var1;
5378 break;
5382 return OK;
5386 * Get an option value.
5387 * "arg" points to the '&' or '+' before the option name.
5388 * "arg" is advanced to character after the option name.
5389 * Return OK or FAIL.
5391 static int
5392 get_option_tv(arg, rettv, evaluate)
5393 char_u **arg;
5394 typval_T *rettv; /* when NULL, only check if option exists */
5395 int evaluate;
5397 char_u *option_end;
5398 long numval;
5399 char_u *stringval;
5400 int opt_type;
5401 int c;
5402 int working = (**arg == '+'); /* has("+option") */
5403 int ret = OK;
5404 int opt_flags;
5407 * Isolate the option name and find its value.
5409 option_end = find_option_end(arg, &opt_flags);
5410 if (option_end == NULL)
5412 if (rettv != NULL)
5413 EMSG2(_("E112: Option name missing: %s"), *arg);
5414 return FAIL;
5417 if (!evaluate)
5419 *arg = option_end;
5420 return OK;
5423 c = *option_end;
5424 *option_end = NUL;
5425 opt_type = get_option_value(*arg, &numval,
5426 rettv == NULL ? NULL : &stringval, opt_flags);
5428 if (opt_type == -3) /* invalid name */
5430 if (rettv != NULL)
5431 EMSG2(_("E113: Unknown option: %s"), *arg);
5432 ret = FAIL;
5434 else if (rettv != NULL)
5436 if (opt_type == -2) /* hidden string option */
5438 rettv->v_type = VAR_STRING;
5439 rettv->vval.v_string = NULL;
5441 else if (opt_type == -1) /* hidden number option */
5443 rettv->v_type = VAR_NUMBER;
5444 rettv->vval.v_number = 0;
5446 else if (opt_type == 1) /* number option */
5448 rettv->v_type = VAR_NUMBER;
5449 rettv->vval.v_number = numval;
5451 else /* string option */
5453 rettv->v_type = VAR_STRING;
5454 rettv->vval.v_string = stringval;
5457 else if (working && (opt_type == -2 || opt_type == -1))
5458 ret = FAIL;
5460 *option_end = c; /* put back for error messages */
5461 *arg = option_end;
5463 return ret;
5467 * Allocate a variable for a string constant.
5468 * Return OK or FAIL.
5470 static int
5471 get_string_tv(arg, rettv, evaluate)
5472 char_u **arg;
5473 typval_T *rettv;
5474 int evaluate;
5476 char_u *p;
5477 char_u *name;
5478 int extra = 0;
5481 * Find the end of the string, skipping backslashed characters.
5483 for (p = *arg + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
5485 if (*p == '\\' && p[1] != NUL)
5487 ++p;
5488 /* A "\<x>" form occupies at least 4 characters, and produces up
5489 * to 6 characters: reserve space for 2 extra */
5490 if (*p == '<')
5491 extra += 2;
5495 if (*p != '"')
5497 EMSG2(_("E114: Missing quote: %s"), *arg);
5498 return FAIL;
5501 /* If only parsing, set *arg and return here */
5502 if (!evaluate)
5504 *arg = p + 1;
5505 return OK;
5509 * Copy the string into allocated memory, handling backslashed
5510 * characters.
5512 name = alloc((unsigned)(p - *arg + extra));
5513 if (name == NULL)
5514 return FAIL;
5515 rettv->v_type = VAR_STRING;
5516 rettv->vval.v_string = name;
5518 for (p = *arg + 1; *p != NUL && *p != '"'; )
5520 if (*p == '\\')
5522 switch (*++p)
5524 case 'b': *name++ = BS; ++p; break;
5525 case 'e': *name++ = ESC; ++p; break;
5526 case 'f': *name++ = FF; ++p; break;
5527 case 'n': *name++ = NL; ++p; break;
5528 case 'r': *name++ = CAR; ++p; break;
5529 case 't': *name++ = TAB; ++p; break;
5531 case 'X': /* hex: "\x1", "\x12" */
5532 case 'x':
5533 case 'u': /* Unicode: "\u0023" */
5534 case 'U':
5535 if (vim_isxdigit(p[1]))
5537 int n, nr;
5538 int c = toupper(*p);
5540 if (c == 'X')
5541 n = 2;
5542 else
5543 n = 4;
5544 nr = 0;
5545 while (--n >= 0 && vim_isxdigit(p[1]))
5547 ++p;
5548 nr = (nr << 4) + hex2nr(*p);
5550 ++p;
5551 #ifdef FEAT_MBYTE
5552 /* For "\u" store the number according to
5553 * 'encoding'. */
5554 if (c != 'X')
5555 name += (*mb_char2bytes)(nr, name);
5556 else
5557 #endif
5558 *name++ = nr;
5560 break;
5562 /* octal: "\1", "\12", "\123" */
5563 case '0':
5564 case '1':
5565 case '2':
5566 case '3':
5567 case '4':
5568 case '5':
5569 case '6':
5570 case '7': *name = *p++ - '0';
5571 if (*p >= '0' && *p <= '7')
5573 *name = (*name << 3) + *p++ - '0';
5574 if (*p >= '0' && *p <= '7')
5575 *name = (*name << 3) + *p++ - '0';
5577 ++name;
5578 break;
5580 /* Special key, e.g.: "\<C-W>" */
5581 case '<': extra = trans_special(&p, name, TRUE);
5582 if (extra != 0)
5584 name += extra;
5585 break;
5587 /* FALLTHROUGH */
5589 default: MB_COPY_CHAR(p, name);
5590 break;
5593 else
5594 MB_COPY_CHAR(p, name);
5597 *name = NUL;
5598 *arg = p + 1;
5600 return OK;
5604 * Allocate a variable for a 'str''ing' constant.
5605 * Return OK or FAIL.
5607 static int
5608 get_lit_string_tv(arg, rettv, evaluate)
5609 char_u **arg;
5610 typval_T *rettv;
5611 int evaluate;
5613 char_u *p;
5614 char_u *str;
5615 int reduce = 0;
5618 * Find the end of the string, skipping ''.
5620 for (p = *arg + 1; *p != NUL; mb_ptr_adv(p))
5622 if (*p == '\'')
5624 if (p[1] != '\'')
5625 break;
5626 ++reduce;
5627 ++p;
5631 if (*p != '\'')
5633 EMSG2(_("E115: Missing quote: %s"), *arg);
5634 return FAIL;
5637 /* If only parsing return after setting "*arg" */
5638 if (!evaluate)
5640 *arg = p + 1;
5641 return OK;
5645 * Copy the string into allocated memory, handling '' to ' reduction.
5647 str = alloc((unsigned)((p - *arg) - reduce));
5648 if (str == NULL)
5649 return FAIL;
5650 rettv->v_type = VAR_STRING;
5651 rettv->vval.v_string = str;
5653 for (p = *arg + 1; *p != NUL; )
5655 if (*p == '\'')
5657 if (p[1] != '\'')
5658 break;
5659 ++p;
5661 MB_COPY_CHAR(p, str);
5663 *str = NUL;
5664 *arg = p + 1;
5666 return OK;
5670 * Allocate a variable for a List and fill it from "*arg".
5671 * Return OK or FAIL.
5673 static int
5674 get_list_tv(arg, rettv, evaluate)
5675 char_u **arg;
5676 typval_T *rettv;
5677 int evaluate;
5679 list_T *l = NULL;
5680 typval_T tv;
5681 listitem_T *item;
5683 if (evaluate)
5685 l = list_alloc();
5686 if (l == NULL)
5687 return FAIL;
5690 *arg = skipwhite(*arg + 1);
5691 while (**arg != ']' && **arg != NUL)
5693 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
5694 goto failret;
5695 if (evaluate)
5697 item = listitem_alloc();
5698 if (item != NULL)
5700 item->li_tv = tv;
5701 item->li_tv.v_lock = 0;
5702 list_append(l, item);
5704 else
5705 clear_tv(&tv);
5708 if (**arg == ']')
5709 break;
5710 if (**arg != ',')
5712 EMSG2(_("E696: Missing comma in List: %s"), *arg);
5713 goto failret;
5715 *arg = skipwhite(*arg + 1);
5718 if (**arg != ']')
5720 EMSG2(_("E697: Missing end of List ']': %s"), *arg);
5721 failret:
5722 if (evaluate)
5723 list_free(l, TRUE);
5724 return FAIL;
5727 *arg = skipwhite(*arg + 1);
5728 if (evaluate)
5730 rettv->v_type = VAR_LIST;
5731 rettv->vval.v_list = l;
5732 ++l->lv_refcount;
5735 return OK;
5739 * Allocate an empty header for a list.
5740 * Caller should take care of the reference count.
5742 list_T *
5743 list_alloc()
5745 list_T *l;
5747 l = (list_T *)alloc_clear(sizeof(list_T));
5748 if (l != NULL)
5750 /* Prepend the list to the list of lists for garbage collection. */
5751 if (first_list != NULL)
5752 first_list->lv_used_prev = l;
5753 l->lv_used_prev = NULL;
5754 l->lv_used_next = first_list;
5755 first_list = l;
5757 return l;
5761 * Allocate an empty list for a return value.
5762 * Returns OK or FAIL.
5764 static int
5765 rettv_list_alloc(rettv)
5766 typval_T *rettv;
5768 list_T *l = list_alloc();
5770 if (l == NULL)
5771 return FAIL;
5773 rettv->vval.v_list = l;
5774 rettv->v_type = VAR_LIST;
5775 ++l->lv_refcount;
5776 return OK;
5780 * Unreference a list: decrement the reference count and free it when it
5781 * becomes zero.
5783 void
5784 list_unref(l)
5785 list_T *l;
5787 if (l != NULL && --l->lv_refcount <= 0)
5788 list_free(l, TRUE);
5792 * Free a list, including all items it points to.
5793 * Ignores the reference count.
5795 void
5796 list_free(l, recurse)
5797 list_T *l;
5798 int recurse; /* Free Lists and Dictionaries recursively. */
5800 listitem_T *item;
5802 /* Remove the list from the list of lists for garbage collection. */
5803 if (l->lv_used_prev == NULL)
5804 first_list = l->lv_used_next;
5805 else
5806 l->lv_used_prev->lv_used_next = l->lv_used_next;
5807 if (l->lv_used_next != NULL)
5808 l->lv_used_next->lv_used_prev = l->lv_used_prev;
5810 for (item = l->lv_first; item != NULL; item = l->lv_first)
5812 /* Remove the item before deleting it. */
5813 l->lv_first = item->li_next;
5814 if (recurse || (item->li_tv.v_type != VAR_LIST
5815 && item->li_tv.v_type != VAR_DICT))
5816 clear_tv(&item->li_tv);
5817 vim_free(item);
5819 vim_free(l);
5823 * Allocate a list item.
5825 static listitem_T *
5826 listitem_alloc()
5828 return (listitem_T *)alloc(sizeof(listitem_T));
5832 * Free a list item. Also clears the value. Does not notify watchers.
5834 static void
5835 listitem_free(item)
5836 listitem_T *item;
5838 clear_tv(&item->li_tv);
5839 vim_free(item);
5843 * Remove a list item from a List and free it. Also clears the value.
5845 static void
5846 listitem_remove(l, item)
5847 list_T *l;
5848 listitem_T *item;
5850 list_remove(l, item, item);
5851 listitem_free(item);
5855 * Get the number of items in a list.
5857 static long
5858 list_len(l)
5859 list_T *l;
5861 if (l == NULL)
5862 return 0L;
5863 return l->lv_len;
5867 * Return TRUE when two lists have exactly the same values.
5869 static int
5870 list_equal(l1, l2, ic)
5871 list_T *l1;
5872 list_T *l2;
5873 int ic; /* ignore case for strings */
5875 listitem_T *item1, *item2;
5877 if (l1 == NULL || l2 == NULL)
5878 return FALSE;
5879 if (l1 == l2)
5880 return TRUE;
5881 if (list_len(l1) != list_len(l2))
5882 return FALSE;
5884 for (item1 = l1->lv_first, item2 = l2->lv_first;
5885 item1 != NULL && item2 != NULL;
5886 item1 = item1->li_next, item2 = item2->li_next)
5887 if (!tv_equal(&item1->li_tv, &item2->li_tv, ic))
5888 return FALSE;
5889 return item1 == NULL && item2 == NULL;
5892 #if defined(FEAT_PYTHON) || defined(FEAT_MZSCHEME) || defined(PROTO)
5894 * Return the dictitem that an entry in a hashtable points to.
5896 dictitem_T *
5897 dict_lookup(hi)
5898 hashitem_T *hi;
5900 return HI2DI(hi);
5902 #endif
5905 * Return TRUE when two dictionaries have exactly the same key/values.
5907 static int
5908 dict_equal(d1, d2, ic)
5909 dict_T *d1;
5910 dict_T *d2;
5911 int ic; /* ignore case for strings */
5913 hashitem_T *hi;
5914 dictitem_T *item2;
5915 int todo;
5917 if (d1 == NULL || d2 == NULL)
5918 return FALSE;
5919 if (d1 == d2)
5920 return TRUE;
5921 if (dict_len(d1) != dict_len(d2))
5922 return FALSE;
5924 todo = (int)d1->dv_hashtab.ht_used;
5925 for (hi = d1->dv_hashtab.ht_array; todo > 0; ++hi)
5927 if (!HASHITEM_EMPTY(hi))
5929 item2 = dict_find(d2, hi->hi_key, -1);
5930 if (item2 == NULL)
5931 return FALSE;
5932 if (!tv_equal(&HI2DI(hi)->di_tv, &item2->di_tv, ic))
5933 return FALSE;
5934 --todo;
5937 return TRUE;
5941 * Return TRUE if "tv1" and "tv2" have the same value.
5942 * Compares the items just like "==" would compare them, but strings and
5943 * numbers are different. Floats and numbers are also different.
5945 static int
5946 tv_equal(tv1, tv2, ic)
5947 typval_T *tv1;
5948 typval_T *tv2;
5949 int ic; /* ignore case */
5951 char_u buf1[NUMBUFLEN], buf2[NUMBUFLEN];
5952 char_u *s1, *s2;
5953 static int recursive = 0; /* cach recursive loops */
5954 int r;
5956 if (tv1->v_type != tv2->v_type)
5957 return FALSE;
5958 /* Catch lists and dicts that have an endless loop by limiting
5959 * recursiveness to 1000. We guess they are equal then. */
5960 if (recursive >= 1000)
5961 return TRUE;
5963 switch (tv1->v_type)
5965 case VAR_LIST:
5966 ++recursive;
5967 r = list_equal(tv1->vval.v_list, tv2->vval.v_list, ic);
5968 --recursive;
5969 return r;
5971 case VAR_DICT:
5972 ++recursive;
5973 r = dict_equal(tv1->vval.v_dict, tv2->vval.v_dict, ic);
5974 --recursive;
5975 return r;
5977 case VAR_FUNC:
5978 return (tv1->vval.v_string != NULL
5979 && tv2->vval.v_string != NULL
5980 && STRCMP(tv1->vval.v_string, tv2->vval.v_string) == 0);
5982 case VAR_NUMBER:
5983 return tv1->vval.v_number == tv2->vval.v_number;
5985 #ifdef FEAT_FLOAT
5986 case VAR_FLOAT:
5987 return tv1->vval.v_float == tv2->vval.v_float;
5988 #endif
5990 case VAR_STRING:
5991 s1 = get_tv_string_buf(tv1, buf1);
5992 s2 = get_tv_string_buf(tv2, buf2);
5993 return ((ic ? MB_STRICMP(s1, s2) : STRCMP(s1, s2)) == 0);
5996 EMSG2(_(e_intern2), "tv_equal()");
5997 return TRUE;
6001 * Locate item with index "n" in list "l" and return it.
6002 * A negative index is counted from the end; -1 is the last item.
6003 * Returns NULL when "n" is out of range.
6005 static listitem_T *
6006 list_find(l, n)
6007 list_T *l;
6008 long n;
6010 listitem_T *item;
6011 long idx;
6013 if (l == NULL)
6014 return NULL;
6016 /* Negative index is relative to the end. */
6017 if (n < 0)
6018 n = l->lv_len + n;
6020 /* Check for index out of range. */
6021 if (n < 0 || n >= l->lv_len)
6022 return NULL;
6024 /* When there is a cached index may start search from there. */
6025 if (l->lv_idx_item != NULL)
6027 if (n < l->lv_idx / 2)
6029 /* closest to the start of the list */
6030 item = l->lv_first;
6031 idx = 0;
6033 else if (n > (l->lv_idx + l->lv_len) / 2)
6035 /* closest to the end of the list */
6036 item = l->lv_last;
6037 idx = l->lv_len - 1;
6039 else
6041 /* closest to the cached index */
6042 item = l->lv_idx_item;
6043 idx = l->lv_idx;
6046 else
6048 if (n < l->lv_len / 2)
6050 /* closest to the start of the list */
6051 item = l->lv_first;
6052 idx = 0;
6054 else
6056 /* closest to the end of the list */
6057 item = l->lv_last;
6058 idx = l->lv_len - 1;
6062 while (n > idx)
6064 /* search forward */
6065 item = item->li_next;
6066 ++idx;
6068 while (n < idx)
6070 /* search backward */
6071 item = item->li_prev;
6072 --idx;
6075 /* cache the used index */
6076 l->lv_idx = idx;
6077 l->lv_idx_item = item;
6079 return item;
6083 * Get list item "l[idx]" as a number.
6085 static long
6086 list_find_nr(l, idx, errorp)
6087 list_T *l;
6088 long idx;
6089 int *errorp; /* set to TRUE when something wrong */
6091 listitem_T *li;
6093 li = list_find(l, idx);
6094 if (li == NULL)
6096 if (errorp != NULL)
6097 *errorp = TRUE;
6098 return -1L;
6100 return get_tv_number_chk(&li->li_tv, errorp);
6104 * Get list item "l[idx - 1]" as a string. Returns NULL for failure.
6106 char_u *
6107 list_find_str(l, idx)
6108 list_T *l;
6109 long idx;
6111 listitem_T *li;
6113 li = list_find(l, idx - 1);
6114 if (li == NULL)
6116 EMSGN(_(e_listidx), idx);
6117 return NULL;
6119 return get_tv_string(&li->li_tv);
6123 * Locate "item" list "l" and return its index.
6124 * Returns -1 when "item" is not in the list.
6126 static long
6127 list_idx_of_item(l, item)
6128 list_T *l;
6129 listitem_T *item;
6131 long idx = 0;
6132 listitem_T *li;
6134 if (l == NULL)
6135 return -1;
6136 idx = 0;
6137 for (li = l->lv_first; li != NULL && li != item; li = li->li_next)
6138 ++idx;
6139 if (li == NULL)
6140 return -1;
6141 return idx;
6145 * Append item "item" to the end of list "l".
6147 static void
6148 list_append(l, item)
6149 list_T *l;
6150 listitem_T *item;
6152 if (l->lv_last == NULL)
6154 /* empty list */
6155 l->lv_first = item;
6156 l->lv_last = item;
6157 item->li_prev = NULL;
6159 else
6161 l->lv_last->li_next = item;
6162 item->li_prev = l->lv_last;
6163 l->lv_last = item;
6165 ++l->lv_len;
6166 item->li_next = NULL;
6170 * Append typval_T "tv" to the end of list "l".
6171 * Return FAIL when out of memory.
6173 static int
6174 list_append_tv(l, tv)
6175 list_T *l;
6176 typval_T *tv;
6178 listitem_T *li = listitem_alloc();
6180 if (li == NULL)
6181 return FAIL;
6182 copy_tv(tv, &li->li_tv);
6183 list_append(l, li);
6184 return OK;
6188 * Add a dictionary to a list. Used by getqflist().
6189 * Return FAIL when out of memory.
6192 list_append_dict(list, dict)
6193 list_T *list;
6194 dict_T *dict;
6196 listitem_T *li = listitem_alloc();
6198 if (li == NULL)
6199 return FAIL;
6200 li->li_tv.v_type = VAR_DICT;
6201 li->li_tv.v_lock = 0;
6202 li->li_tv.vval.v_dict = dict;
6203 list_append(list, li);
6204 ++dict->dv_refcount;
6205 return OK;
6209 * Make a copy of "str" and append it as an item to list "l".
6210 * When "len" >= 0 use "str[len]".
6211 * Returns FAIL when out of memory.
6214 list_append_string(l, str, len)
6215 list_T *l;
6216 char_u *str;
6217 int len;
6219 listitem_T *li = listitem_alloc();
6221 if (li == NULL)
6222 return FAIL;
6223 list_append(l, li);
6224 li->li_tv.v_type = VAR_STRING;
6225 li->li_tv.v_lock = 0;
6226 if (str == NULL)
6227 li->li_tv.vval.v_string = NULL;
6228 else if ((li->li_tv.vval.v_string = (len >= 0 ? vim_strnsave(str, len)
6229 : vim_strsave(str))) == NULL)
6230 return FAIL;
6231 return OK;
6235 * Append "n" to list "l".
6236 * Returns FAIL when out of memory.
6238 static int
6239 list_append_number(l, n)
6240 list_T *l;
6241 varnumber_T n;
6243 listitem_T *li;
6245 li = listitem_alloc();
6246 if (li == NULL)
6247 return FAIL;
6248 li->li_tv.v_type = VAR_NUMBER;
6249 li->li_tv.v_lock = 0;
6250 li->li_tv.vval.v_number = n;
6251 list_append(l, li);
6252 return OK;
6256 * Insert typval_T "tv" in list "l" before "item".
6257 * If "item" is NULL append at the end.
6258 * Return FAIL when out of memory.
6260 static int
6261 list_insert_tv(l, tv, item)
6262 list_T *l;
6263 typval_T *tv;
6264 listitem_T *item;
6266 listitem_T *ni = listitem_alloc();
6268 if (ni == NULL)
6269 return FAIL;
6270 copy_tv(tv, &ni->li_tv);
6271 if (item == NULL)
6272 /* Append new item at end of list. */
6273 list_append(l, ni);
6274 else
6276 /* Insert new item before existing item. */
6277 ni->li_prev = item->li_prev;
6278 ni->li_next = item;
6279 if (item->li_prev == NULL)
6281 l->lv_first = ni;
6282 ++l->lv_idx;
6284 else
6286 item->li_prev->li_next = ni;
6287 l->lv_idx_item = NULL;
6289 item->li_prev = ni;
6290 ++l->lv_len;
6292 return OK;
6296 * Extend "l1" with "l2".
6297 * If "bef" is NULL append at the end, otherwise insert before this item.
6298 * Returns FAIL when out of memory.
6300 static int
6301 list_extend(l1, l2, bef)
6302 list_T *l1;
6303 list_T *l2;
6304 listitem_T *bef;
6306 listitem_T *item;
6307 int todo = l2->lv_len;
6309 /* We also quit the loop when we have inserted the original item count of
6310 * the list, avoid a hang when we extend a list with itself. */
6311 for (item = l2->lv_first; item != NULL && --todo >= 0; item = item->li_next)
6312 if (list_insert_tv(l1, &item->li_tv, bef) == FAIL)
6313 return FAIL;
6314 return OK;
6318 * Concatenate lists "l1" and "l2" into a new list, stored in "tv".
6319 * Return FAIL when out of memory.
6321 static int
6322 list_concat(l1, l2, tv)
6323 list_T *l1;
6324 list_T *l2;
6325 typval_T *tv;
6327 list_T *l;
6329 if (l1 == NULL || l2 == NULL)
6330 return FAIL;
6332 /* make a copy of the first list. */
6333 l = list_copy(l1, FALSE, 0);
6334 if (l == NULL)
6335 return FAIL;
6336 tv->v_type = VAR_LIST;
6337 tv->vval.v_list = l;
6339 /* append all items from the second list */
6340 return list_extend(l, l2, NULL);
6344 * Make a copy of list "orig". Shallow if "deep" is FALSE.
6345 * The refcount of the new list is set to 1.
6346 * See item_copy() for "copyID".
6347 * Returns NULL when out of memory.
6349 static list_T *
6350 list_copy(orig, deep, copyID)
6351 list_T *orig;
6352 int deep;
6353 int copyID;
6355 list_T *copy;
6356 listitem_T *item;
6357 listitem_T *ni;
6359 if (orig == NULL)
6360 return NULL;
6362 copy = list_alloc();
6363 if (copy != NULL)
6365 if (copyID != 0)
6367 /* Do this before adding the items, because one of the items may
6368 * refer back to this list. */
6369 orig->lv_copyID = copyID;
6370 orig->lv_copylist = copy;
6372 for (item = orig->lv_first; item != NULL && !got_int;
6373 item = item->li_next)
6375 ni = listitem_alloc();
6376 if (ni == NULL)
6377 break;
6378 if (deep)
6380 if (item_copy(&item->li_tv, &ni->li_tv, deep, copyID) == FAIL)
6382 vim_free(ni);
6383 break;
6386 else
6387 copy_tv(&item->li_tv, &ni->li_tv);
6388 list_append(copy, ni);
6390 ++copy->lv_refcount;
6391 if (item != NULL)
6393 list_unref(copy);
6394 copy = NULL;
6398 return copy;
6402 * Remove items "item" to "item2" from list "l".
6403 * Does not free the listitem or the value!
6405 static void
6406 list_remove(l, item, item2)
6407 list_T *l;
6408 listitem_T *item;
6409 listitem_T *item2;
6411 listitem_T *ip;
6413 /* notify watchers */
6414 for (ip = item; ip != NULL; ip = ip->li_next)
6416 --l->lv_len;
6417 list_fix_watch(l, ip);
6418 if (ip == item2)
6419 break;
6422 if (item2->li_next == NULL)
6423 l->lv_last = item->li_prev;
6424 else
6425 item2->li_next->li_prev = item->li_prev;
6426 if (item->li_prev == NULL)
6427 l->lv_first = item2->li_next;
6428 else
6429 item->li_prev->li_next = item2->li_next;
6430 l->lv_idx_item = NULL;
6434 * Return an allocated string with the string representation of a list.
6435 * May return NULL.
6437 static char_u *
6438 list2string(tv, copyID)
6439 typval_T *tv;
6440 int copyID;
6442 garray_T ga;
6444 if (tv->vval.v_list == NULL)
6445 return NULL;
6446 ga_init2(&ga, (int)sizeof(char), 80);
6447 ga_append(&ga, '[');
6448 if (list_join(&ga, tv->vval.v_list, (char_u *)", ", FALSE, copyID) == FAIL)
6450 vim_free(ga.ga_data);
6451 return NULL;
6453 ga_append(&ga, ']');
6454 ga_append(&ga, NUL);
6455 return (char_u *)ga.ga_data;
6459 * Join list "l" into a string in "*gap", using separator "sep".
6460 * When "echo" is TRUE use String as echoed, otherwise as inside a List.
6461 * Return FAIL or OK.
6463 static int
6464 list_join(gap, l, sep, echo, copyID)
6465 garray_T *gap;
6466 list_T *l;
6467 char_u *sep;
6468 int echo;
6469 int copyID;
6471 int first = TRUE;
6472 char_u *tofree;
6473 char_u numbuf[NUMBUFLEN];
6474 listitem_T *item;
6475 char_u *s;
6477 for (item = l->lv_first; item != NULL && !got_int; item = item->li_next)
6479 if (first)
6480 first = FALSE;
6481 else
6482 ga_concat(gap, sep);
6484 if (echo)
6485 s = echo_string(&item->li_tv, &tofree, numbuf, copyID);
6486 else
6487 s = tv2string(&item->li_tv, &tofree, numbuf, copyID);
6488 if (s != NULL)
6489 ga_concat(gap, s);
6490 vim_free(tofree);
6491 if (s == NULL)
6492 return FAIL;
6494 return OK;
6498 * Garbage collection for lists and dictionaries.
6500 * We use reference counts to be able to free most items right away when they
6501 * are no longer used. But for composite items it's possible that it becomes
6502 * unused while the reference count is > 0: When there is a recursive
6503 * reference. Example:
6504 * :let l = [1, 2, 3]
6505 * :let d = {9: l}
6506 * :let l[1] = d
6508 * Since this is quite unusual we handle this with garbage collection: every
6509 * once in a while find out which lists and dicts are not referenced from any
6510 * variable.
6512 * Here is a good reference text about garbage collection (refers to Python
6513 * but it applies to all reference-counting mechanisms):
6514 * http://python.ca/nas/python/gc/
6518 * Do garbage collection for lists and dicts.
6519 * Return TRUE if some memory was freed.
6522 garbage_collect()
6524 int copyID;
6525 buf_T *buf;
6526 win_T *wp;
6527 int i;
6528 funccall_T *fc, **pfc;
6529 int did_free;
6530 int did_free_funccal = FALSE;
6531 #ifdef FEAT_WINDOWS
6532 tabpage_T *tp;
6533 #endif
6535 /* Only do this once. */
6536 want_garbage_collect = FALSE;
6537 may_garbage_collect = FALSE;
6538 garbage_collect_at_exit = FALSE;
6540 /* We advance by two because we add one for items referenced through
6541 * previous_funccal. */
6542 current_copyID += COPYID_INC;
6543 copyID = current_copyID;
6546 * 1. Go through all accessible variables and mark all lists and dicts
6547 * with copyID.
6550 /* Don't free variables in the previous_funccal list unless they are only
6551 * referenced through previous_funccal. This must be first, because if
6552 * the item is referenced elsewhere the funccal must not be freed. */
6553 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
6555 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1);
6556 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1);
6559 /* script-local variables */
6560 for (i = 1; i <= ga_scripts.ga_len; ++i)
6561 set_ref_in_ht(&SCRIPT_VARS(i), copyID);
6563 /* buffer-local variables */
6564 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6565 set_ref_in_ht(&buf->b_vars.dv_hashtab, copyID);
6567 /* window-local variables */
6568 FOR_ALL_TAB_WINDOWS(tp, wp)
6569 set_ref_in_ht(&wp->w_vars.dv_hashtab, copyID);
6571 #ifdef FEAT_WINDOWS
6572 /* tabpage-local variables */
6573 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
6574 set_ref_in_ht(&tp->tp_vars.dv_hashtab, copyID);
6575 #endif
6577 /* global variables */
6578 set_ref_in_ht(&globvarht, copyID);
6580 /* function-local variables */
6581 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6583 set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID);
6584 set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID);
6587 /* v: vars */
6588 set_ref_in_ht(&vimvarht, copyID);
6591 * 2. Free lists and dictionaries that are not referenced.
6593 did_free = free_unref_items(copyID);
6596 * 3. Check if any funccal can be freed now.
6598 for (pfc = &previous_funccal; *pfc != NULL; )
6600 if (can_free_funccal(*pfc, copyID))
6602 fc = *pfc;
6603 *pfc = fc->caller;
6604 free_funccal(fc, TRUE);
6605 did_free = TRUE;
6606 did_free_funccal = TRUE;
6608 else
6609 pfc = &(*pfc)->caller;
6611 if (did_free_funccal)
6612 /* When a funccal was freed some more items might be garbage
6613 * collected, so run again. */
6614 (void)garbage_collect();
6616 return did_free;
6620 * Free lists and dictionaries that are no longer referenced.
6622 static int
6623 free_unref_items(copyID)
6624 int copyID;
6626 dict_T *dd;
6627 list_T *ll;
6628 int did_free = FALSE;
6631 * Go through the list of dicts and free items without the copyID.
6633 for (dd = first_dict; dd != NULL; )
6634 if ((dd->dv_copyID & COPYID_MASK) != (copyID & COPYID_MASK))
6636 /* Free the Dictionary and ordinary items it contains, but don't
6637 * recurse into Lists and Dictionaries, they will be in the list
6638 * of dicts or list of lists. */
6639 dict_free(dd, FALSE);
6640 did_free = TRUE;
6642 /* restart, next dict may also have been freed */
6643 dd = first_dict;
6645 else
6646 dd = dd->dv_used_next;
6649 * Go through the list of lists and free items without the copyID.
6650 * But don't free a list that has a watcher (used in a for loop), these
6651 * are not referenced anywhere.
6653 for (ll = first_list; ll != NULL; )
6654 if ((ll->lv_copyID & COPYID_MASK) != (copyID & COPYID_MASK)
6655 && ll->lv_watch == NULL)
6657 /* Free the List and ordinary items it contains, but don't recurse
6658 * into Lists and Dictionaries, they will be in the list of dicts
6659 * or list of lists. */
6660 list_free(ll, FALSE);
6661 did_free = TRUE;
6663 /* restart, next list may also have been freed */
6664 ll = first_list;
6666 else
6667 ll = ll->lv_used_next;
6669 return did_free;
6673 * Mark all lists and dicts referenced through hashtab "ht" with "copyID".
6675 static void
6676 set_ref_in_ht(ht, copyID)
6677 hashtab_T *ht;
6678 int copyID;
6680 int todo;
6681 hashitem_T *hi;
6683 todo = (int)ht->ht_used;
6684 for (hi = ht->ht_array; todo > 0; ++hi)
6685 if (!HASHITEM_EMPTY(hi))
6687 --todo;
6688 set_ref_in_item(&HI2DI(hi)->di_tv, copyID);
6693 * Mark all lists and dicts referenced through list "l" with "copyID".
6695 static void
6696 set_ref_in_list(l, copyID)
6697 list_T *l;
6698 int copyID;
6700 listitem_T *li;
6702 for (li = l->lv_first; li != NULL; li = li->li_next)
6703 set_ref_in_item(&li->li_tv, copyID);
6707 * Mark all lists and dicts referenced through typval "tv" with "copyID".
6709 static void
6710 set_ref_in_item(tv, copyID)
6711 typval_T *tv;
6712 int copyID;
6714 dict_T *dd;
6715 list_T *ll;
6717 switch (tv->v_type)
6719 case VAR_DICT:
6720 dd = tv->vval.v_dict;
6721 if (dd != NULL && dd->dv_copyID != copyID)
6723 /* Didn't see this dict yet. */
6724 dd->dv_copyID = copyID;
6725 set_ref_in_ht(&dd->dv_hashtab, copyID);
6727 break;
6729 case VAR_LIST:
6730 ll = tv->vval.v_list;
6731 if (ll != NULL && ll->lv_copyID != copyID)
6733 /* Didn't see this list yet. */
6734 ll->lv_copyID = copyID;
6735 set_ref_in_list(ll, copyID);
6737 break;
6739 return;
6743 * Allocate an empty header for a dictionary.
6745 dict_T *
6746 dict_alloc()
6748 dict_T *d;
6750 d = (dict_T *)alloc(sizeof(dict_T));
6751 if (d != NULL)
6753 /* Add the list to the list of dicts for garbage collection. */
6754 if (first_dict != NULL)
6755 first_dict->dv_used_prev = d;
6756 d->dv_used_next = first_dict;
6757 d->dv_used_prev = NULL;
6758 first_dict = d;
6760 hash_init(&d->dv_hashtab);
6761 d->dv_lock = 0;
6762 d->dv_refcount = 0;
6763 d->dv_copyID = 0;
6765 return d;
6769 * Unreference a Dictionary: decrement the reference count and free it when it
6770 * becomes zero.
6772 static void
6773 dict_unref(d)
6774 dict_T *d;
6776 if (d != NULL && --d->dv_refcount <= 0)
6777 dict_free(d, TRUE);
6781 * Free a Dictionary, including all items it contains.
6782 * Ignores the reference count.
6784 static void
6785 dict_free(d, recurse)
6786 dict_T *d;
6787 int recurse; /* Free Lists and Dictionaries recursively. */
6789 int todo;
6790 hashitem_T *hi;
6791 dictitem_T *di;
6793 /* Remove the dict from the list of dicts for garbage collection. */
6794 if (d->dv_used_prev == NULL)
6795 first_dict = d->dv_used_next;
6796 else
6797 d->dv_used_prev->dv_used_next = d->dv_used_next;
6798 if (d->dv_used_next != NULL)
6799 d->dv_used_next->dv_used_prev = d->dv_used_prev;
6801 /* Lock the hashtab, we don't want it to resize while freeing items. */
6802 hash_lock(&d->dv_hashtab);
6803 todo = (int)d->dv_hashtab.ht_used;
6804 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
6806 if (!HASHITEM_EMPTY(hi))
6808 /* Remove the item before deleting it, just in case there is
6809 * something recursive causing trouble. */
6810 di = HI2DI(hi);
6811 hash_remove(&d->dv_hashtab, hi);
6812 if (recurse || (di->di_tv.v_type != VAR_LIST
6813 && di->di_tv.v_type != VAR_DICT))
6814 clear_tv(&di->di_tv);
6815 vim_free(di);
6816 --todo;
6819 hash_clear(&d->dv_hashtab);
6820 vim_free(d);
6824 * Allocate a Dictionary item.
6825 * The "key" is copied to the new item.
6826 * Note that the value of the item "di_tv" still needs to be initialized!
6827 * Returns NULL when out of memory.
6829 static dictitem_T *
6830 dictitem_alloc(key)
6831 char_u *key;
6833 dictitem_T *di;
6835 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T) + STRLEN(key)));
6836 if (di != NULL)
6838 STRCPY(di->di_key, key);
6839 di->di_flags = 0;
6841 return di;
6845 * Make a copy of a Dictionary item.
6847 static dictitem_T *
6848 dictitem_copy(org)
6849 dictitem_T *org;
6851 dictitem_T *di;
6853 di = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
6854 + STRLEN(org->di_key)));
6855 if (di != NULL)
6857 STRCPY(di->di_key, org->di_key);
6858 di->di_flags = 0;
6859 copy_tv(&org->di_tv, &di->di_tv);
6861 return di;
6865 * Remove item "item" from Dictionary "dict" and free it.
6867 static void
6868 dictitem_remove(dict, item)
6869 dict_T *dict;
6870 dictitem_T *item;
6872 hashitem_T *hi;
6874 hi = hash_find(&dict->dv_hashtab, item->di_key);
6875 if (HASHITEM_EMPTY(hi))
6876 EMSG2(_(e_intern2), "dictitem_remove()");
6877 else
6878 hash_remove(&dict->dv_hashtab, hi);
6879 dictitem_free(item);
6883 * Free a dict item. Also clears the value.
6885 static void
6886 dictitem_free(item)
6887 dictitem_T *item;
6889 clear_tv(&item->di_tv);
6890 vim_free(item);
6894 * Make a copy of dict "d". Shallow if "deep" is FALSE.
6895 * The refcount of the new dict is set to 1.
6896 * See item_copy() for "copyID".
6897 * Returns NULL when out of memory.
6899 static dict_T *
6900 dict_copy(orig, deep, copyID)
6901 dict_T *orig;
6902 int deep;
6903 int copyID;
6905 dict_T *copy;
6906 dictitem_T *di;
6907 int todo;
6908 hashitem_T *hi;
6910 if (orig == NULL)
6911 return NULL;
6913 copy = dict_alloc();
6914 if (copy != NULL)
6916 if (copyID != 0)
6918 orig->dv_copyID = copyID;
6919 orig->dv_copydict = copy;
6921 todo = (int)orig->dv_hashtab.ht_used;
6922 for (hi = orig->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
6924 if (!HASHITEM_EMPTY(hi))
6926 --todo;
6928 di = dictitem_alloc(hi->hi_key);
6929 if (di == NULL)
6930 break;
6931 if (deep)
6933 if (item_copy(&HI2DI(hi)->di_tv, &di->di_tv, deep,
6934 copyID) == FAIL)
6936 vim_free(di);
6937 break;
6940 else
6941 copy_tv(&HI2DI(hi)->di_tv, &di->di_tv);
6942 if (dict_add(copy, di) == FAIL)
6944 dictitem_free(di);
6945 break;
6950 ++copy->dv_refcount;
6951 if (todo > 0)
6953 dict_unref(copy);
6954 copy = NULL;
6958 return copy;
6962 * Add item "item" to Dictionary "d".
6963 * Returns FAIL when out of memory and when key already existed.
6965 static int
6966 dict_add(d, item)
6967 dict_T *d;
6968 dictitem_T *item;
6970 return hash_add(&d->dv_hashtab, item->di_key);
6974 * Add a number or string entry to dictionary "d".
6975 * When "str" is NULL use number "nr", otherwise use "str".
6976 * Returns FAIL when out of memory and when key already exists.
6979 dict_add_nr_str(d, key, nr, str)
6980 dict_T *d;
6981 char *key;
6982 long nr;
6983 char_u *str;
6985 dictitem_T *item;
6987 item = dictitem_alloc((char_u *)key);
6988 if (item == NULL)
6989 return FAIL;
6990 item->di_tv.v_lock = 0;
6991 if (str == NULL)
6993 item->di_tv.v_type = VAR_NUMBER;
6994 item->di_tv.vval.v_number = nr;
6996 else
6998 item->di_tv.v_type = VAR_STRING;
6999 item->di_tv.vval.v_string = vim_strsave(str);
7001 if (dict_add(d, item) == FAIL)
7003 dictitem_free(item);
7004 return FAIL;
7006 return OK;
7010 * Get the number of items in a Dictionary.
7012 static long
7013 dict_len(d)
7014 dict_T *d;
7016 if (d == NULL)
7017 return 0L;
7018 return (long)d->dv_hashtab.ht_used;
7022 * Find item "key[len]" in Dictionary "d".
7023 * If "len" is negative use strlen(key).
7024 * Returns NULL when not found.
7026 static dictitem_T *
7027 dict_find(d, key, len)
7028 dict_T *d;
7029 char_u *key;
7030 int len;
7032 #define AKEYLEN 200
7033 char_u buf[AKEYLEN];
7034 char_u *akey;
7035 char_u *tofree = NULL;
7036 hashitem_T *hi;
7038 if (len < 0)
7039 akey = key;
7040 else if (len >= AKEYLEN)
7042 tofree = akey = vim_strnsave(key, len);
7043 if (akey == NULL)
7044 return NULL;
7046 else
7048 /* Avoid a malloc/free by using buf[]. */
7049 vim_strncpy(buf, key, len);
7050 akey = buf;
7053 hi = hash_find(&d->dv_hashtab, akey);
7054 vim_free(tofree);
7055 if (HASHITEM_EMPTY(hi))
7056 return NULL;
7057 return HI2DI(hi);
7061 * Get a string item from a dictionary.
7062 * When "save" is TRUE allocate memory for it.
7063 * Returns NULL if the entry doesn't exist or out of memory.
7065 char_u *
7066 get_dict_string(d, key, save)
7067 dict_T *d;
7068 char_u *key;
7069 int save;
7071 dictitem_T *di;
7072 char_u *s;
7074 di = dict_find(d, key, -1);
7075 if (di == NULL)
7076 return NULL;
7077 s = get_tv_string(&di->di_tv);
7078 if (save && s != NULL)
7079 s = vim_strsave(s);
7080 return s;
7084 * Get a number item from a dictionary.
7085 * Returns 0 if the entry doesn't exist or out of memory.
7087 long
7088 get_dict_number(d, key)
7089 dict_T *d;
7090 char_u *key;
7092 dictitem_T *di;
7094 di = dict_find(d, key, -1);
7095 if (di == NULL)
7096 return 0;
7097 return get_tv_number(&di->di_tv);
7101 * Return an allocated string with the string representation of a Dictionary.
7102 * May return NULL.
7104 static char_u *
7105 dict2string(tv, copyID)
7106 typval_T *tv;
7107 int copyID;
7109 garray_T ga;
7110 int first = TRUE;
7111 char_u *tofree;
7112 char_u numbuf[NUMBUFLEN];
7113 hashitem_T *hi;
7114 char_u *s;
7115 dict_T *d;
7116 int todo;
7118 if ((d = tv->vval.v_dict) == NULL)
7119 return NULL;
7120 ga_init2(&ga, (int)sizeof(char), 80);
7121 ga_append(&ga, '{');
7123 todo = (int)d->dv_hashtab.ht_used;
7124 for (hi = d->dv_hashtab.ht_array; todo > 0 && !got_int; ++hi)
7126 if (!HASHITEM_EMPTY(hi))
7128 --todo;
7130 if (first)
7131 first = FALSE;
7132 else
7133 ga_concat(&ga, (char_u *)", ");
7135 tofree = string_quote(hi->hi_key, FALSE);
7136 if (tofree != NULL)
7138 ga_concat(&ga, tofree);
7139 vim_free(tofree);
7141 ga_concat(&ga, (char_u *)": ");
7142 s = tv2string(&HI2DI(hi)->di_tv, &tofree, numbuf, copyID);
7143 if (s != NULL)
7144 ga_concat(&ga, s);
7145 vim_free(tofree);
7146 if (s == NULL)
7147 break;
7150 if (todo > 0)
7152 vim_free(ga.ga_data);
7153 return NULL;
7156 ga_append(&ga, '}');
7157 ga_append(&ga, NUL);
7158 return (char_u *)ga.ga_data;
7162 * Allocate a variable for a Dictionary and fill it from "*arg".
7163 * Return OK or FAIL. Returns NOTDONE for {expr}.
7165 static int
7166 get_dict_tv(arg, rettv, evaluate)
7167 char_u **arg;
7168 typval_T *rettv;
7169 int evaluate;
7171 dict_T *d = NULL;
7172 typval_T tvkey;
7173 typval_T tv;
7174 char_u *key = NULL;
7175 dictitem_T *item;
7176 char_u *start = skipwhite(*arg + 1);
7177 char_u buf[NUMBUFLEN];
7180 * First check if it's not a curly-braces thing: {expr}.
7181 * Must do this without evaluating, otherwise a function may be called
7182 * twice. Unfortunately this means we need to call eval1() twice for the
7183 * first item.
7184 * But {} is an empty Dictionary.
7186 if (*start != '}')
7188 if (eval1(&start, &tv, FALSE) == FAIL) /* recursive! */
7189 return FAIL;
7190 if (*start == '}')
7191 return NOTDONE;
7194 if (evaluate)
7196 d = dict_alloc();
7197 if (d == NULL)
7198 return FAIL;
7200 tvkey.v_type = VAR_UNKNOWN;
7201 tv.v_type = VAR_UNKNOWN;
7203 *arg = skipwhite(*arg + 1);
7204 while (**arg != '}' && **arg != NUL)
7206 if (eval1(arg, &tvkey, evaluate) == FAIL) /* recursive! */
7207 goto failret;
7208 if (**arg != ':')
7210 EMSG2(_("E720: Missing colon in Dictionary: %s"), *arg);
7211 clear_tv(&tvkey);
7212 goto failret;
7214 if (evaluate)
7216 key = get_tv_string_buf_chk(&tvkey, buf);
7217 if (key == NULL || *key == NUL)
7219 /* "key" is NULL when get_tv_string_buf_chk() gave an errmsg */
7220 if (key != NULL)
7221 EMSG(_(e_emptykey));
7222 clear_tv(&tvkey);
7223 goto failret;
7227 *arg = skipwhite(*arg + 1);
7228 if (eval1(arg, &tv, evaluate) == FAIL) /* recursive! */
7230 if (evaluate)
7231 clear_tv(&tvkey);
7232 goto failret;
7234 if (evaluate)
7236 item = dict_find(d, key, -1);
7237 if (item != NULL)
7239 EMSG2(_("E721: Duplicate key in Dictionary: \"%s\""), key);
7240 clear_tv(&tvkey);
7241 clear_tv(&tv);
7242 goto failret;
7244 item = dictitem_alloc(key);
7245 clear_tv(&tvkey);
7246 if (item != NULL)
7248 item->di_tv = tv;
7249 item->di_tv.v_lock = 0;
7250 if (dict_add(d, item) == FAIL)
7251 dictitem_free(item);
7255 if (**arg == '}')
7256 break;
7257 if (**arg != ',')
7259 EMSG2(_("E722: Missing comma in Dictionary: %s"), *arg);
7260 goto failret;
7262 *arg = skipwhite(*arg + 1);
7265 if (**arg != '}')
7267 EMSG2(_("E723: Missing end of Dictionary '}': %s"), *arg);
7268 failret:
7269 if (evaluate)
7270 dict_free(d, TRUE);
7271 return FAIL;
7274 *arg = skipwhite(*arg + 1);
7275 if (evaluate)
7277 rettv->v_type = VAR_DICT;
7278 rettv->vval.v_dict = d;
7279 ++d->dv_refcount;
7282 return OK;
7286 * Return a string with the string representation of a variable.
7287 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7288 * "numbuf" is used for a number.
7289 * Does not put quotes around strings, as ":echo" displays values.
7290 * When "copyID" is not NULL replace recursive lists and dicts with "...".
7291 * May return NULL.
7293 static char_u *
7294 echo_string(tv, tofree, numbuf, copyID)
7295 typval_T *tv;
7296 char_u **tofree;
7297 char_u *numbuf;
7298 int copyID;
7300 static int recurse = 0;
7301 char_u *r = NULL;
7303 if (recurse >= DICT_MAXNEST)
7305 EMSG(_("E724: variable nested too deep for displaying"));
7306 *tofree = NULL;
7307 return NULL;
7309 ++recurse;
7311 switch (tv->v_type)
7313 case VAR_FUNC:
7314 *tofree = NULL;
7315 r = tv->vval.v_string;
7316 break;
7318 case VAR_LIST:
7319 if (tv->vval.v_list == NULL)
7321 *tofree = NULL;
7322 r = NULL;
7324 else if (copyID != 0 && tv->vval.v_list->lv_copyID == copyID)
7326 *tofree = NULL;
7327 r = (char_u *)"[...]";
7329 else
7331 tv->vval.v_list->lv_copyID = copyID;
7332 *tofree = list2string(tv, copyID);
7333 r = *tofree;
7335 break;
7337 case VAR_DICT:
7338 if (tv->vval.v_dict == NULL)
7340 *tofree = NULL;
7341 r = NULL;
7343 else if (copyID != 0 && tv->vval.v_dict->dv_copyID == copyID)
7345 *tofree = NULL;
7346 r = (char_u *)"{...}";
7348 else
7350 tv->vval.v_dict->dv_copyID = copyID;
7351 *tofree = dict2string(tv, copyID);
7352 r = *tofree;
7354 break;
7356 case VAR_STRING:
7357 case VAR_NUMBER:
7358 *tofree = NULL;
7359 r = get_tv_string_buf(tv, numbuf);
7360 break;
7362 #ifdef FEAT_FLOAT
7363 case VAR_FLOAT:
7364 *tofree = NULL;
7365 vim_snprintf((char *)numbuf, NUMBUFLEN, "%g", tv->vval.v_float);
7366 r = numbuf;
7367 break;
7368 #endif
7370 default:
7371 EMSG2(_(e_intern2), "echo_string()");
7372 *tofree = NULL;
7375 --recurse;
7376 return r;
7380 * Return a string with the string representation of a variable.
7381 * If the memory is allocated "tofree" is set to it, otherwise NULL.
7382 * "numbuf" is used for a number.
7383 * Puts quotes around strings, so that they can be parsed back by eval().
7384 * May return NULL.
7386 static char_u *
7387 tv2string(tv, tofree, numbuf, copyID)
7388 typval_T *tv;
7389 char_u **tofree;
7390 char_u *numbuf;
7391 int copyID;
7393 switch (tv->v_type)
7395 case VAR_FUNC:
7396 *tofree = string_quote(tv->vval.v_string, TRUE);
7397 return *tofree;
7398 case VAR_STRING:
7399 *tofree = string_quote(tv->vval.v_string, FALSE);
7400 return *tofree;
7401 #ifdef FEAT_FLOAT
7402 case VAR_FLOAT:
7403 *tofree = NULL;
7404 vim_snprintf((char *)numbuf, NUMBUFLEN - 1, "%g", tv->vval.v_float);
7405 return numbuf;
7406 #endif
7407 case VAR_NUMBER:
7408 case VAR_LIST:
7409 case VAR_DICT:
7410 break;
7411 default:
7412 EMSG2(_(e_intern2), "tv2string()");
7414 return echo_string(tv, tofree, numbuf, copyID);
7418 * Return string "str" in ' quotes, doubling ' characters.
7419 * If "str" is NULL an empty string is assumed.
7420 * If "function" is TRUE make it function('string').
7422 static char_u *
7423 string_quote(str, function)
7424 char_u *str;
7425 int function;
7427 unsigned len;
7428 char_u *p, *r, *s;
7430 len = (function ? 13 : 3);
7431 if (str != NULL)
7433 len += (unsigned)STRLEN(str);
7434 for (p = str; *p != NUL; mb_ptr_adv(p))
7435 if (*p == '\'')
7436 ++len;
7438 s = r = alloc(len);
7439 if (r != NULL)
7441 if (function)
7443 STRCPY(r, "function('");
7444 r += 10;
7446 else
7447 *r++ = '\'';
7448 if (str != NULL)
7449 for (p = str; *p != NUL; )
7451 if (*p == '\'')
7452 *r++ = '\'';
7453 MB_COPY_CHAR(p, r);
7455 *r++ = '\'';
7456 if (function)
7457 *r++ = ')';
7458 *r++ = NUL;
7460 return s;
7463 #ifdef FEAT_FLOAT
7465 * Convert the string "text" to a floating point number.
7466 * This uses strtod(). setlocale(LC_NUMERIC, "C") has been used to make sure
7467 * this always uses a decimal point.
7468 * Returns the length of the text that was consumed.
7470 static int
7471 string2float(text, value)
7472 char_u *text;
7473 float_T *value; /* result stored here */
7475 char *s = (char *)text;
7476 float_T f;
7478 f = strtod(s, &s);
7479 *value = f;
7480 return (int)((char_u *)s - text);
7482 #endif
7485 * Get the value of an environment variable.
7486 * "arg" is pointing to the '$'. It is advanced to after the name.
7487 * If the environment variable was not set, silently assume it is empty.
7488 * Always return OK.
7490 static int
7491 get_env_tv(arg, rettv, evaluate)
7492 char_u **arg;
7493 typval_T *rettv;
7494 int evaluate;
7496 char_u *string = NULL;
7497 int len;
7498 int cc;
7499 char_u *name;
7500 int mustfree = FALSE;
7502 ++*arg;
7503 name = *arg;
7504 len = get_env_len(arg);
7505 if (evaluate)
7507 if (len != 0)
7509 cc = name[len];
7510 name[len] = NUL;
7511 /* first try vim_getenv(), fast for normal environment vars */
7512 string = vim_getenv(name, &mustfree);
7513 if (string != NULL && *string != NUL)
7515 if (!mustfree)
7516 string = vim_strsave(string);
7518 else
7520 if (mustfree)
7521 vim_free(string);
7523 /* next try expanding things like $VIM and ${HOME} */
7524 string = expand_env_save(name - 1);
7525 if (string != NULL && *string == '$')
7527 vim_free(string);
7528 string = NULL;
7531 name[len] = cc;
7533 rettv->v_type = VAR_STRING;
7534 rettv->vval.v_string = string;
7537 return OK;
7541 * Array with names and number of arguments of all internal functions
7542 * MUST BE KEPT SORTED IN strcmp() ORDER FOR BINARY SEARCH!
7544 static struct fst
7546 char *f_name; /* function name */
7547 char f_min_argc; /* minimal number of arguments */
7548 char f_max_argc; /* maximal number of arguments */
7549 void (*f_func) __ARGS((typval_T *args, typval_T *rvar));
7550 /* implementation of function */
7551 } functions[] =
7553 #ifdef FEAT_FLOAT
7554 {"abs", 1, 1, f_abs},
7555 {"acos", 1, 1, f_acos}, /* WJMc */
7556 #endif
7557 {"add", 2, 2, f_add},
7558 {"append", 2, 2, f_append},
7559 {"argc", 0, 0, f_argc},
7560 {"argidx", 0, 0, f_argidx},
7561 {"argv", 0, 1, f_argv},
7562 #ifdef FEAT_FLOAT
7563 {"asin", 1, 1, f_asin}, /* WJMc */
7564 {"atan", 1, 1, f_atan},
7565 {"atan2", 2, 2, f_atan2}, /* WJMc */
7566 #endif
7567 {"browse", 4, 4, f_browse},
7568 {"browsedir", 2, 2, f_browsedir},
7569 {"bufexists", 1, 1, f_bufexists},
7570 {"buffer_exists", 1, 1, f_bufexists}, /* obsolete */
7571 {"buffer_name", 1, 1, f_bufname}, /* obsolete */
7572 {"buffer_number", 1, 1, f_bufnr}, /* obsolete */
7573 {"buflisted", 1, 1, f_buflisted},
7574 {"bufloaded", 1, 1, f_bufloaded},
7575 {"bufname", 1, 1, f_bufname},
7576 {"bufnr", 1, 2, f_bufnr},
7577 {"bufwinnr", 1, 1, f_bufwinnr},
7578 {"byte2line", 1, 1, f_byte2line},
7579 {"byteidx", 2, 2, f_byteidx},
7580 {"call", 2, 3, f_call},
7581 #ifdef FEAT_FLOAT
7582 {"ceil", 1, 1, f_ceil},
7583 #endif
7584 {"changenr", 0, 0, f_changenr},
7585 {"char2nr", 1, 1, f_char2nr},
7586 {"cindent", 1, 1, f_cindent},
7587 {"clearmatches", 0, 0, f_clearmatches},
7588 {"col", 1, 1, f_col},
7589 #if defined(FEAT_INS_EXPAND)
7590 {"complete", 2, 2, f_complete},
7591 {"complete_add", 1, 1, f_complete_add},
7592 {"complete_check", 0, 0, f_complete_check},
7593 #endif
7594 {"confirm", 1, 4, f_confirm},
7595 {"copy", 1, 1, f_copy},
7596 #ifdef FEAT_FLOAT
7597 {"cos", 1, 1, f_cos},
7598 {"cosh", 1, 1, f_cosh}, /* WJMc */
7599 #endif
7600 {"count", 2, 4, f_count},
7601 {"cscope_connection",0,3, f_cscope_connection},
7602 {"cursor", 1, 3, f_cursor},
7603 {"deepcopy", 1, 2, f_deepcopy},
7604 {"delete", 1, 1, f_delete},
7605 {"did_filetype", 0, 0, f_did_filetype},
7606 {"diff_filler", 1, 1, f_diff_filler},
7607 {"diff_hlID", 2, 2, f_diff_hlID},
7608 {"empty", 1, 1, f_empty},
7609 {"escape", 2, 2, f_escape},
7610 {"eval", 1, 1, f_eval},
7611 {"eventhandler", 0, 0, f_eventhandler},
7612 {"executable", 1, 1, f_executable},
7613 {"exists", 1, 1, f_exists},
7614 #ifdef FEAT_FLOAT
7615 {"exp", 1, 1, f_exp}, /* WJMc */
7616 #endif
7617 {"expand", 1, 2, f_expand},
7618 {"extend", 2, 3, f_extend},
7619 {"feedkeys", 1, 2, f_feedkeys},
7620 {"file_readable", 1, 1, f_filereadable}, /* obsolete */
7621 {"filereadable", 1, 1, f_filereadable},
7622 {"filewritable", 1, 1, f_filewritable},
7623 {"filter", 2, 2, f_filter},
7624 {"finddir", 1, 3, f_finddir},
7625 {"findfile", 1, 3, f_findfile},
7626 #ifdef FEAT_FLOAT
7627 {"float2nr", 1, 1, f_float2nr},
7628 {"floor", 1, 1, f_floor},
7629 {"fmod", 2, 2, f_fmod}, /* WJMc */
7630 #endif
7631 {"fnameescape", 1, 1, f_fnameescape},
7632 {"fnamemodify", 2, 2, f_fnamemodify},
7633 {"foldclosed", 1, 1, f_foldclosed},
7634 {"foldclosedend", 1, 1, f_foldclosedend},
7635 {"foldlevel", 1, 1, f_foldlevel},
7636 {"foldtext", 0, 0, f_foldtext},
7637 {"foldtextresult", 1, 1, f_foldtextresult},
7638 {"foreground", 0, 0, f_foreground},
7639 {"function", 1, 1, f_function},
7640 {"garbagecollect", 0, 1, f_garbagecollect},
7641 {"get", 2, 3, f_get},
7642 {"getbufline", 2, 3, f_getbufline},
7643 {"getbufvar", 2, 2, f_getbufvar},
7644 {"getchar", 0, 1, f_getchar},
7645 {"getcharmod", 0, 0, f_getcharmod},
7646 {"getcmdline", 0, 0, f_getcmdline},
7647 {"getcmdpos", 0, 0, f_getcmdpos},
7648 {"getcmdtype", 0, 0, f_getcmdtype},
7649 {"getcwd", 0, 0, f_getcwd},
7650 {"getfontname", 0, 1, f_getfontname},
7651 {"getfperm", 1, 1, f_getfperm},
7652 {"getfsize", 1, 1, f_getfsize},
7653 {"getftime", 1, 1, f_getftime},
7654 {"getftype", 1, 1, f_getftype},
7655 {"getline", 1, 2, f_getline},
7656 {"getloclist", 1, 1, f_getqflist},
7657 {"getmatches", 0, 0, f_getmatches},
7658 {"getpid", 0, 0, f_getpid},
7659 {"getpos", 1, 1, f_getpos},
7660 {"getqflist", 0, 0, f_getqflist},
7661 {"getreg", 0, 2, f_getreg},
7662 {"getregtype", 0, 1, f_getregtype},
7663 {"gettabwinvar", 3, 3, f_gettabwinvar},
7664 {"getwinposx", 0, 0, f_getwinposx},
7665 {"getwinposy", 0, 0, f_getwinposy},
7666 {"getwinvar", 2, 2, f_getwinvar},
7667 {"glob", 1, 2, f_glob},
7668 {"globpath", 2, 3, f_globpath},
7669 {"has", 1, 1, f_has},
7670 {"has_key", 2, 2, f_has_key},
7671 {"haslocaldir", 0, 0, f_haslocaldir},
7672 {"hasmapto", 1, 3, f_hasmapto},
7673 {"highlightID", 1, 1, f_hlID}, /* obsolete */
7674 {"highlight_exists",1, 1, f_hlexists}, /* obsolete */
7675 {"histadd", 2, 2, f_histadd},
7676 {"histdel", 1, 2, f_histdel},
7677 {"histget", 1, 2, f_histget},
7678 {"histnr", 1, 1, f_histnr},
7679 {"hlID", 1, 1, f_hlID},
7680 {"hlexists", 1, 1, f_hlexists},
7681 {"hostname", 0, 0, f_hostname},
7682 {"iconv", 3, 3, f_iconv},
7683 {"indent", 1, 1, f_indent},
7684 {"index", 2, 4, f_index},
7685 {"input", 1, 3, f_input},
7686 {"inputdialog", 1, 3, f_inputdialog},
7687 {"inputlist", 1, 1, f_inputlist},
7688 {"inputrestore", 0, 0, f_inputrestore},
7689 {"inputsave", 0, 0, f_inputsave},
7690 {"inputsecret", 1, 2, f_inputsecret},
7691 {"insert", 2, 3, f_insert},
7692 {"isdirectory", 1, 1, f_isdirectory},
7693 {"islocked", 1, 1, f_islocked},
7694 {"items", 1, 1, f_items},
7695 {"join", 1, 2, f_join},
7696 {"keys", 1, 1, f_keys},
7697 {"last_buffer_nr", 0, 0, f_last_buffer_nr},/* obsolete */
7698 {"len", 1, 1, f_len},
7699 {"libcall", 3, 3, f_libcall},
7700 {"libcallnr", 3, 3, f_libcallnr},
7701 {"line", 1, 1, f_line},
7702 {"line2byte", 1, 1, f_line2byte},
7703 {"lispindent", 1, 1, f_lispindent},
7704 {"localtime", 0, 0, f_localtime},
7705 #ifdef FEAT_FLOAT
7706 {"log", 1, 1, f_log}, /* WJMc */
7707 {"log10", 1, 1, f_log10},
7708 #endif
7709 {"map", 2, 2, f_map},
7710 {"maparg", 1, 3, f_maparg},
7711 {"mapcheck", 1, 3, f_mapcheck},
7712 {"match", 2, 4, f_match},
7713 {"matchadd", 2, 4, f_matchadd},
7714 {"matcharg", 1, 1, f_matcharg},
7715 {"matchdelete", 1, 1, f_matchdelete},
7716 {"matchend", 2, 4, f_matchend},
7717 {"matchlist", 2, 4, f_matchlist},
7718 {"matchstr", 2, 4, f_matchstr},
7719 {"max", 1, 1, f_max},
7720 {"min", 1, 1, f_min},
7721 #ifdef vim_mkdir
7722 {"mkdir", 1, 3, f_mkdir},
7723 #endif
7724 {"mode", 0, 1, f_mode},
7725 {"nextnonblank", 1, 1, f_nextnonblank},
7726 {"nr2char", 1, 1, f_nr2char},
7727 {"pathshorten", 1, 1, f_pathshorten},
7728 #ifdef FEAT_FLOAT
7729 {"pow", 2, 2, f_pow},
7730 #endif
7731 {"prevnonblank", 1, 1, f_prevnonblank},
7732 {"printf", 2, 19, f_printf},
7733 {"pumvisible", 0, 0, f_pumvisible},
7734 {"range", 1, 3, f_range},
7735 {"readfile", 1, 3, f_readfile},
7736 {"reltime", 0, 2, f_reltime},
7737 {"reltimestr", 1, 1, f_reltimestr},
7738 {"remote_expr", 2, 3, f_remote_expr},
7739 {"remote_foreground", 1, 1, f_remote_foreground},
7740 {"remote_peek", 1, 2, f_remote_peek},
7741 {"remote_read", 1, 1, f_remote_read},
7742 {"remote_send", 2, 3, f_remote_send},
7743 {"remove", 2, 3, f_remove},
7744 {"rename", 2, 2, f_rename},
7745 {"repeat", 2, 2, f_repeat},
7746 {"resolve", 1, 1, f_resolve},
7747 {"reverse", 1, 1, f_reverse},
7748 #ifdef FEAT_FLOAT
7749 {"round", 1, 1, f_round},
7750 #endif
7751 {"search", 1, 4, f_search},
7752 {"searchdecl", 1, 3, f_searchdecl},
7753 {"searchpair", 3, 7, f_searchpair},
7754 {"searchpairpos", 3, 7, f_searchpairpos},
7755 {"searchpos", 1, 4, f_searchpos},
7756 {"server2client", 2, 2, f_server2client},
7757 {"serverlist", 0, 0, f_serverlist},
7758 {"setbufvar", 3, 3, f_setbufvar},
7759 {"setcmdpos", 1, 1, f_setcmdpos},
7760 {"setline", 2, 2, f_setline},
7761 {"setloclist", 2, 3, f_setloclist},
7762 {"setmatches", 1, 1, f_setmatches},
7763 {"setpos", 2, 2, f_setpos},
7764 {"setqflist", 1, 2, f_setqflist},
7765 {"setreg", 2, 3, f_setreg},
7766 {"settabwinvar", 4, 4, f_settabwinvar},
7767 {"setwinvar", 3, 3, f_setwinvar},
7768 {"shellescape", 1, 2, f_shellescape},
7769 {"simplify", 1, 1, f_simplify},
7770 #ifdef FEAT_FLOAT
7771 {"sin", 1, 1, f_sin},
7772 {"sinh", 1, 1, f_sinh}, /* WJMc */
7773 #endif
7774 {"sort", 1, 2, f_sort},
7775 {"soundfold", 1, 1, f_soundfold},
7776 {"spellbadword", 0, 1, f_spellbadword},
7777 {"spellsuggest", 1, 3, f_spellsuggest},
7778 {"split", 1, 3, f_split},
7779 #ifdef FEAT_FLOAT
7780 {"sqrt", 1, 1, f_sqrt},
7781 {"str2float", 1, 1, f_str2float},
7782 #endif
7783 {"str2nr", 1, 2, f_str2nr},
7784 #ifdef HAVE_STRFTIME
7785 {"strftime", 1, 2, f_strftime},
7786 #endif
7787 {"stridx", 2, 3, f_stridx},
7788 {"string", 1, 1, f_string},
7789 {"strlen", 1, 1, f_strlen},
7790 {"strpart", 2, 3, f_strpart},
7791 {"strridx", 2, 3, f_strridx},
7792 {"strtrans", 1, 1, f_strtrans},
7793 {"submatch", 1, 1, f_submatch},
7794 {"substitute", 4, 4, f_substitute},
7795 {"synID", 3, 3, f_synID},
7796 {"synIDattr", 2, 3, f_synIDattr},
7797 {"synIDtrans", 1, 1, f_synIDtrans},
7798 {"synstack", 2, 2, f_synstack},
7799 {"system", 1, 2, f_system},
7800 {"tabpagebuflist", 0, 1, f_tabpagebuflist},
7801 {"tabpagenr", 0, 1, f_tabpagenr},
7802 {"tabpagewinnr", 1, 2, f_tabpagewinnr},
7803 {"tagfiles", 0, 0, f_tagfiles},
7804 {"taglist", 1, 1, f_taglist},
7805 {"tan", 1, 1, f_tan}, /* WJMc */
7806 {"tanh", 1, 1, f_tanh}, /* WJMc */
7807 {"tempname", 0, 0, f_tempname},
7808 {"test", 1, 1, f_test},
7809 {"tolower", 1, 1, f_tolower},
7810 {"toupper", 1, 1, f_toupper},
7811 {"tr", 3, 3, f_tr},
7812 #ifdef FEAT_FLOAT
7813 {"trunc", 1, 1, f_trunc},
7814 #endif
7815 {"type", 1, 1, f_type},
7816 {"values", 1, 1, f_values},
7817 {"virtcol", 1, 1, f_virtcol},
7818 {"visualmode", 0, 1, f_visualmode},
7819 {"winbufnr", 1, 1, f_winbufnr},
7820 {"wincol", 0, 0, f_wincol},
7821 {"winheight", 1, 1, f_winheight},
7822 {"winline", 0, 0, f_winline},
7823 {"winnr", 0, 1, f_winnr},
7824 {"winrestcmd", 0, 0, f_winrestcmd},
7825 {"winrestview", 1, 1, f_winrestview},
7826 {"winsaveview", 0, 0, f_winsaveview},
7827 {"winwidth", 1, 1, f_winwidth},
7828 {"writefile", 2, 3, f_writefile},
7831 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7834 * Function given to ExpandGeneric() to obtain the list of internal
7835 * or user defined function names.
7837 char_u *
7838 get_function_name(xp, idx)
7839 expand_T *xp;
7840 int idx;
7842 static int intidx = -1;
7843 char_u *name;
7845 if (idx == 0)
7846 intidx = -1;
7847 if (intidx < 0)
7849 name = get_user_func_name(xp, idx);
7850 if (name != NULL)
7851 return name;
7853 if (++intidx < (int)(sizeof(functions) / sizeof(struct fst)))
7855 STRCPY(IObuff, functions[intidx].f_name);
7856 STRCAT(IObuff, "(");
7857 if (functions[intidx].f_max_argc == 0)
7858 STRCAT(IObuff, ")");
7859 return IObuff;
7862 return NULL;
7866 * Function given to ExpandGeneric() to obtain the list of internal or
7867 * user defined variable or function names.
7869 char_u *
7870 get_expr_name(xp, idx)
7871 expand_T *xp;
7872 int idx;
7874 static int intidx = -1;
7875 char_u *name;
7877 if (idx == 0)
7878 intidx = -1;
7879 if (intidx < 0)
7881 name = get_function_name(xp, idx);
7882 if (name != NULL)
7883 return name;
7885 return get_user_var_name(xp, ++intidx);
7888 #endif /* FEAT_CMDL_COMPL */
7891 * Find internal function in table above.
7892 * Return index, or -1 if not found
7894 static int
7895 find_internal_func(name)
7896 char_u *name; /* name of the function */
7898 int first = 0;
7899 int last = (int)(sizeof(functions) / sizeof(struct fst)) - 1;
7900 int cmp;
7901 int x;
7904 * Find the function name in the table. Binary search.
7906 while (first <= last)
7908 x = first + ((unsigned)(last - first) >> 1);
7909 cmp = STRCMP(name, functions[x].f_name);
7910 if (cmp < 0)
7911 last = x - 1;
7912 else if (cmp > 0)
7913 first = x + 1;
7914 else
7915 return x;
7917 return -1;
7921 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
7922 * name it contains, otherwise return "name".
7924 static char_u *
7925 deref_func_name(name, lenp)
7926 char_u *name;
7927 int *lenp;
7929 dictitem_T *v;
7930 int cc;
7932 cc = name[*lenp];
7933 name[*lenp] = NUL;
7934 v = find_var(name, NULL);
7935 name[*lenp] = cc;
7936 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
7938 if (v->di_tv.vval.v_string == NULL)
7940 *lenp = 0;
7941 return (char_u *)""; /* just in case */
7943 *lenp = (int)STRLEN(v->di_tv.vval.v_string);
7944 return v->di_tv.vval.v_string;
7947 return name;
7951 * Allocate a variable for the result of a function.
7952 * Return OK or FAIL.
7954 static int
7955 get_func_tv(name, len, rettv, arg, firstline, lastline, doesrange,
7956 evaluate, selfdict)
7957 char_u *name; /* name of the function */
7958 int len; /* length of "name" */
7959 typval_T *rettv;
7960 char_u **arg; /* argument, pointing to the '(' */
7961 linenr_T firstline; /* first line of range */
7962 linenr_T lastline; /* last line of range */
7963 int *doesrange; /* return: function handled range */
7964 int evaluate;
7965 dict_T *selfdict; /* Dictionary for "self" */
7967 char_u *argp;
7968 int ret = OK;
7969 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
7970 int argcount = 0; /* number of arguments found */
7973 * Get the arguments.
7975 argp = *arg;
7976 while (argcount < MAX_FUNC_ARGS)
7978 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
7979 if (*argp == ')' || *argp == ',' || *argp == NUL)
7980 break;
7981 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
7983 ret = FAIL;
7984 break;
7986 ++argcount;
7987 if (*argp != ',')
7988 break;
7990 if (*argp == ')')
7991 ++argp;
7992 else
7993 ret = FAIL;
7995 if (ret == OK)
7996 ret = call_func(name, len, rettv, argcount, argvars,
7997 firstline, lastline, doesrange, evaluate, selfdict);
7998 else if (!aborting())
8000 if (argcount == MAX_FUNC_ARGS)
8001 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
8002 else
8003 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
8006 while (--argcount >= 0)
8007 clear_tv(&argvars[argcount]);
8009 *arg = skipwhite(argp);
8010 return ret;
8015 * Call a function with its resolved parameters
8016 * Return OK when the function can't be called, FAIL otherwise.
8017 * Also returns OK when an error was encountered while executing the function.
8019 static int
8020 call_func(name, len, rettv, argcount, argvars, firstline, lastline,
8021 doesrange, evaluate, selfdict)
8022 char_u *name; /* name of the function */
8023 int len; /* length of "name" */
8024 typval_T *rettv; /* return value goes here */
8025 int argcount; /* number of "argvars" */
8026 typval_T *argvars; /* vars for arguments, must have "argcount"
8027 PLUS ONE elements! */
8028 linenr_T firstline; /* first line of range */
8029 linenr_T lastline; /* last line of range */
8030 int *doesrange; /* return: function handled range */
8031 int evaluate;
8032 dict_T *selfdict; /* Dictionary for "self" */
8034 int ret = FAIL;
8035 #define ERROR_UNKNOWN 0
8036 #define ERROR_TOOMANY 1
8037 #define ERROR_TOOFEW 2
8038 #define ERROR_SCRIPT 3
8039 #define ERROR_DICT 4
8040 #define ERROR_NONE 5
8041 #define ERROR_OTHER 6
8042 int error = ERROR_NONE;
8043 int i;
8044 int llen;
8045 ufunc_T *fp;
8046 int cc;
8047 #define FLEN_FIXED 40
8048 char_u fname_buf[FLEN_FIXED + 1];
8049 char_u *fname;
8052 * In a script change <SID>name() and s:name() to K_SNR 123_name().
8053 * Change <SNR>123_name() to K_SNR 123_name().
8054 * Use fname_buf[] when it fits, otherwise allocate memory (slow).
8056 cc = name[len];
8057 name[len] = NUL;
8058 llen = eval_fname_script(name);
8059 if (llen > 0)
8061 fname_buf[0] = K_SPECIAL;
8062 fname_buf[1] = KS_EXTRA;
8063 fname_buf[2] = (int)KE_SNR;
8064 i = 3;
8065 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
8067 if (current_SID <= 0)
8068 error = ERROR_SCRIPT;
8069 else
8071 sprintf((char *)fname_buf + 3, "%ld_", (long)current_SID);
8072 i = (int)STRLEN(fname_buf);
8075 if (i + STRLEN(name + llen) < FLEN_FIXED)
8077 STRCPY(fname_buf + i, name + llen);
8078 fname = fname_buf;
8080 else
8082 fname = alloc((unsigned)(i + STRLEN(name + llen) + 1));
8083 if (fname == NULL)
8084 error = ERROR_OTHER;
8085 else
8087 mch_memmove(fname, fname_buf, (size_t)i);
8088 STRCPY(fname + i, name + llen);
8092 else
8093 fname = name;
8095 *doesrange = FALSE;
8098 /* execute the function if no errors detected and executing */
8099 if (evaluate && error == ERROR_NONE)
8101 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
8102 rettv->vval.v_number = 0;
8103 error = ERROR_UNKNOWN;
8105 if (!builtin_function(fname))
8108 * User defined function.
8110 fp = find_func(fname);
8112 #ifdef FEAT_AUTOCMD
8113 /* Trigger FuncUndefined event, may load the function. */
8114 if (fp == NULL
8115 && apply_autocmds(EVENT_FUNCUNDEFINED,
8116 fname, fname, TRUE, NULL)
8117 && !aborting())
8119 /* executed an autocommand, search for the function again */
8120 fp = find_func(fname);
8122 #endif
8123 /* Try loading a package. */
8124 if (fp == NULL && script_autoload(fname, TRUE) && !aborting())
8126 /* loaded a package, search for the function again */
8127 fp = find_func(fname);
8130 if (fp != NULL)
8132 if (fp->uf_flags & FC_RANGE)
8133 *doesrange = TRUE;
8134 if (argcount < fp->uf_args.ga_len)
8135 error = ERROR_TOOFEW;
8136 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
8137 error = ERROR_TOOMANY;
8138 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
8139 error = ERROR_DICT;
8140 else
8143 * Call the user function.
8144 * Save and restore search patterns, script variables and
8145 * redo buffer.
8147 save_search_patterns();
8148 saveRedobuff();
8149 ++fp->uf_calls;
8150 call_user_func(fp, argcount, argvars, rettv,
8151 firstline, lastline,
8152 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
8153 if (--fp->uf_calls <= 0 && isdigit(*fp->uf_name)
8154 && fp->uf_refcount <= 0)
8155 /* Function was unreferenced while being used, free it
8156 * now. */
8157 func_free(fp);
8158 restoreRedobuff();
8159 restore_search_patterns();
8160 error = ERROR_NONE;
8164 else
8167 * Find the function name in the table, call its implementation.
8169 i = find_internal_func(fname);
8170 if (i >= 0)
8172 if (argcount < functions[i].f_min_argc)
8173 error = ERROR_TOOFEW;
8174 else if (argcount > functions[i].f_max_argc)
8175 error = ERROR_TOOMANY;
8176 else
8178 argvars[argcount].v_type = VAR_UNKNOWN;
8179 functions[i].f_func(argvars, rettv);
8180 error = ERROR_NONE;
8185 * The function call (or "FuncUndefined" autocommand sequence) might
8186 * have been aborted by an error, an interrupt, or an explicitly thrown
8187 * exception that has not been caught so far. This situation can be
8188 * tested for by calling aborting(). For an error in an internal
8189 * function or for the "E132" error in call_user_func(), however, the
8190 * throw point at which the "force_abort" flag (temporarily reset by
8191 * emsg()) is normally updated has not been reached yet. We need to
8192 * update that flag first to make aborting() reliable.
8194 update_force_abort();
8196 if (error == ERROR_NONE)
8197 ret = OK;
8200 * Report an error unless the argument evaluation or function call has been
8201 * cancelled due to an aborting error, an interrupt, or an exception.
8203 if (!aborting())
8205 switch (error)
8207 case ERROR_UNKNOWN:
8208 emsg_funcname(N_("E117: Unknown function: %s"), name);
8209 break;
8210 case ERROR_TOOMANY:
8211 emsg_funcname(e_toomanyarg, name);
8212 break;
8213 case ERROR_TOOFEW:
8214 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
8215 name);
8216 break;
8217 case ERROR_SCRIPT:
8218 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
8219 name);
8220 break;
8221 case ERROR_DICT:
8222 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
8223 name);
8224 break;
8228 name[len] = cc;
8229 if (fname != name && fname != fname_buf)
8230 vim_free(fname);
8232 return ret;
8236 * Give an error message with a function name. Handle <SNR> things.
8237 * "ermsg" is to be passed without translation, use N_() instead of _().
8239 static void
8240 emsg_funcname(ermsg, name)
8241 char *ermsg;
8242 char_u *name;
8244 char_u *p;
8246 if (*name == K_SPECIAL)
8247 p = concat_str((char_u *)"<SNR>", name + 3);
8248 else
8249 p = name;
8250 EMSG2(_(ermsg), p);
8251 if (p != name)
8252 vim_free(p);
8256 * Return TRUE for a non-zero Number and a non-empty String.
8258 static int
8259 non_zero_arg(argvars)
8260 typval_T *argvars;
8262 return ((argvars[0].v_type == VAR_NUMBER
8263 && argvars[0].vval.v_number != 0)
8264 || (argvars[0].v_type == VAR_STRING
8265 && argvars[0].vval.v_string != NULL
8266 && *argvars[0].vval.v_string != NUL));
8269 /*********************************************
8270 * Implementation of the built-in functions
8273 #ifdef FEAT_FLOAT
8275 * "abs(expr)" function
8277 static void
8278 f_abs(argvars, rettv)
8279 typval_T *argvars;
8280 typval_T *rettv;
8282 if (argvars[0].v_type == VAR_FLOAT)
8284 rettv->v_type = VAR_FLOAT;
8285 rettv->vval.v_float = fabs(argvars[0].vval.v_float);
8287 else
8289 varnumber_T n;
8290 int error = FALSE;
8292 n = get_tv_number_chk(&argvars[0], &error);
8293 if (error)
8294 rettv->vval.v_number = -1;
8295 else if (n > 0)
8296 rettv->vval.v_number = n;
8297 else
8298 rettv->vval.v_number = -n;
8301 #endif
8304 * "add(list, item)" function
8306 static void
8307 f_add(argvars, rettv)
8308 typval_T *argvars;
8309 typval_T *rettv;
8311 list_T *l;
8313 rettv->vval.v_number = 1; /* Default: Failed */
8314 if (argvars[0].v_type == VAR_LIST)
8316 if ((l = argvars[0].vval.v_list) != NULL
8317 && !tv_check_lock(l->lv_lock, (char_u *)"add()")
8318 && list_append_tv(l, &argvars[1]) == OK)
8319 copy_tv(&argvars[0], rettv);
8321 else
8322 EMSG(_(e_listreq));
8326 * "append(lnum, string/list)" function
8328 static void
8329 f_append(argvars, rettv)
8330 typval_T *argvars;
8331 typval_T *rettv;
8333 long lnum;
8334 char_u *line;
8335 list_T *l = NULL;
8336 listitem_T *li = NULL;
8337 typval_T *tv;
8338 long added = 0;
8340 lnum = get_tv_lnum(argvars);
8341 if (lnum >= 0
8342 && lnum <= curbuf->b_ml.ml_line_count
8343 && u_save(lnum, lnum + 1) == OK)
8345 if (argvars[1].v_type == VAR_LIST)
8347 l = argvars[1].vval.v_list;
8348 if (l == NULL)
8349 return;
8350 li = l->lv_first;
8352 for (;;)
8354 if (l == NULL)
8355 tv = &argvars[1]; /* append a string */
8356 else if (li == NULL)
8357 break; /* end of list */
8358 else
8359 tv = &li->li_tv; /* append item from list */
8360 line = get_tv_string_chk(tv);
8361 if (line == NULL) /* type error */
8363 rettv->vval.v_number = 1; /* Failed */
8364 break;
8366 ml_append(lnum + added, line, (colnr_T)0, FALSE);
8367 ++added;
8368 if (l == NULL)
8369 break;
8370 li = li->li_next;
8373 appended_lines_mark(lnum, added);
8374 if (curwin->w_cursor.lnum > lnum)
8375 curwin->w_cursor.lnum += added;
8377 else
8378 rettv->vval.v_number = 1; /* Failed */
8382 * "argc()" function
8384 static void
8385 f_argc(argvars, rettv)
8386 typval_T *argvars UNUSED;
8387 typval_T *rettv;
8389 rettv->vval.v_number = ARGCOUNT;
8393 * "argidx()" function
8395 static void
8396 f_argidx(argvars, rettv)
8397 typval_T *argvars UNUSED;
8398 typval_T *rettv;
8400 rettv->vval.v_number = curwin->w_arg_idx;
8404 * "argv(nr)" function
8406 static void
8407 f_argv(argvars, rettv)
8408 typval_T *argvars;
8409 typval_T *rettv;
8411 int idx;
8413 if (argvars[0].v_type != VAR_UNKNOWN)
8415 idx = get_tv_number_chk(&argvars[0], NULL);
8416 if (idx >= 0 && idx < ARGCOUNT)
8417 rettv->vval.v_string = vim_strsave(alist_name(&ARGLIST[idx]));
8418 else
8419 rettv->vval.v_string = NULL;
8420 rettv->v_type = VAR_STRING;
8422 else if (rettv_list_alloc(rettv) == OK)
8423 for (idx = 0; idx < ARGCOUNT; ++idx)
8424 list_append_string(rettv->vval.v_list,
8425 alist_name(&ARGLIST[idx]), -1);
8428 #ifdef FEAT_FLOAT
8429 static int get_float_arg __ARGS((typval_T *argvars, float_T *f));
8432 * Get the float value of "argvars[0]" into "f".
8433 * Returns FAIL when the argument is not a Number or Float.
8435 static int
8436 get_float_arg(argvars, f)
8437 typval_T *argvars;
8438 float_T *f;
8440 if (argvars[0].v_type == VAR_FLOAT)
8442 *f = argvars[0].vval.v_float;
8443 return OK;
8445 if (argvars[0].v_type == VAR_NUMBER)
8447 *f = (float_T)argvars[0].vval.v_number;
8448 return OK;
8450 EMSG(_("E808: Number or Float required"));
8451 return FAIL;
8454 /* The 10 added FP functions are defined immediately before atan() - WJMc */
8457 * "acos()" function
8459 static void
8460 f_acos(argvars, rettv)
8461 typval_T *argvars;
8462 typval_T *rettv;
8464 float_T f;
8466 rettv->v_type = VAR_FLOAT;
8467 if (get_float_arg(argvars, &f) == OK)
8468 rettv->vval.v_float = acos(f);
8469 else
8470 rettv->vval.v_float = 0.0;
8474 * "asin()" function
8476 static void
8477 f_asin(argvars, rettv)
8478 typval_T *argvars;
8479 typval_T *rettv;
8481 float_T f;
8483 rettv->v_type = VAR_FLOAT;
8484 if (get_float_arg(argvars, &f) == OK)
8485 rettv->vval.v_float = asin(f);
8486 else
8487 rettv->vval.v_float = 0.0;
8491 * "atan2()" function
8493 static void
8494 f_atan2(argvars, rettv)
8495 typval_T *argvars;
8496 typval_T *rettv;
8498 float_T fx, fy;
8500 rettv->v_type = VAR_FLOAT;
8501 if (get_float_arg(argvars, &fx) == OK
8502 && get_float_arg(&argvars[1], &fy) == OK)
8503 rettv->vval.v_float = atan2(fx, fy);
8504 else
8505 rettv->vval.v_float = 0.0;
8509 * "cosh()" function
8511 static void
8512 f_cosh(argvars, rettv)
8513 typval_T *argvars;
8514 typval_T *rettv;
8516 float_T f;
8518 rettv->v_type = VAR_FLOAT;
8519 if (get_float_arg(argvars, &f) == OK)
8520 rettv->vval.v_float = cosh(f);
8521 else
8522 rettv->vval.v_float = 0.0;
8526 * "exp()" function
8528 static void
8529 f_exp(argvars, rettv)
8530 typval_T *argvars;
8531 typval_T *rettv;
8533 float_T f;
8535 rettv->v_type = VAR_FLOAT;
8536 if (get_float_arg(argvars, &f) == OK)
8537 rettv->vval.v_float = exp(f);
8538 else
8539 rettv->vval.v_float = 0.0;
8543 * "fmod()" function
8545 static void
8546 f_fmod(argvars, rettv)
8547 typval_T *argvars;
8548 typval_T *rettv;
8550 float_T fx, fy;
8552 rettv->v_type = VAR_FLOAT;
8553 if (get_float_arg(argvars, &fx) == OK
8554 && get_float_arg(&argvars[1], &fy) == OK)
8555 rettv->vval.v_float = fmod(fx, fy);
8556 else
8557 rettv->vval.v_float = 0.0;
8561 * "log()" function
8563 static void
8564 f_log(argvars, rettv)
8565 typval_T *argvars;
8566 typval_T *rettv;
8568 float_T f;
8570 rettv->v_type = VAR_FLOAT;
8571 if (get_float_arg(argvars, &f) == OK)
8572 rettv->vval.v_float = log(f);
8573 else
8574 rettv->vval.v_float = 0.0;
8578 * "sinh()" function
8580 static void
8581 f_sinh(argvars, rettv)
8582 typval_T *argvars;
8583 typval_T *rettv;
8585 float_T f;
8587 rettv->v_type = VAR_FLOAT;
8588 if (get_float_arg(argvars, &f) == OK)
8589 rettv->vval.v_float = sinh(f);
8590 else
8591 rettv->vval.v_float = 0.0;
8595 * "tan()" function
8597 static void
8598 f_tan(argvars, rettv)
8599 typval_T *argvars;
8600 typval_T *rettv;
8602 float_T f;
8604 rettv->v_type = VAR_FLOAT;
8605 if (get_float_arg(argvars, &f) == OK)
8606 rettv->vval.v_float = tan(f);
8607 else
8608 rettv->vval.v_float = 0.0;
8612 * "tanh()" function
8614 static void
8615 f_tanh(argvars, rettv)
8616 typval_T *argvars;
8617 typval_T *rettv;
8619 float_T f;
8621 rettv->v_type = VAR_FLOAT;
8622 if (get_float_arg(argvars, &f) == OK)
8623 rettv->vval.v_float = tanh(f);
8624 else
8625 rettv->vval.v_float = 0.0;
8628 /* End of the 10 added FP functions - WJMc */
8631 * "atan()" function
8633 static void
8634 f_atan(argvars, rettv)
8635 typval_T *argvars;
8636 typval_T *rettv;
8638 float_T f;
8640 rettv->v_type = VAR_FLOAT;
8641 if (get_float_arg(argvars, &f) == OK)
8642 rettv->vval.v_float = atan(f);
8643 else
8644 rettv->vval.v_float = 0.0;
8646 #endif
8649 * "browse(save, title, initdir, default)" function
8651 static void
8652 f_browse(argvars, rettv)
8653 typval_T *argvars UNUSED;
8654 typval_T *rettv;
8656 #ifdef FEAT_BROWSE
8657 int save;
8658 char_u *title;
8659 char_u *initdir;
8660 char_u *defname;
8661 char_u buf[NUMBUFLEN];
8662 char_u buf2[NUMBUFLEN];
8663 int error = FALSE;
8665 save = get_tv_number_chk(&argvars[0], &error);
8666 title = get_tv_string_chk(&argvars[1]);
8667 initdir = get_tv_string_buf_chk(&argvars[2], buf);
8668 defname = get_tv_string_buf_chk(&argvars[3], buf2);
8670 if (error || title == NULL || initdir == NULL || defname == NULL)
8671 rettv->vval.v_string = NULL;
8672 else
8673 rettv->vval.v_string =
8674 do_browse(save ? BROWSE_SAVE : 0,
8675 title, defname, NULL, initdir, NULL, curbuf);
8676 #else
8677 rettv->vval.v_string = NULL;
8678 #endif
8679 rettv->v_type = VAR_STRING;
8683 * "browsedir(title, initdir)" function
8685 static void
8686 f_browsedir(argvars, rettv)
8687 typval_T *argvars UNUSED;
8688 typval_T *rettv;
8690 #ifdef FEAT_BROWSE
8691 char_u *title;
8692 char_u *initdir;
8693 char_u buf[NUMBUFLEN];
8695 title = get_tv_string_chk(&argvars[0]);
8696 initdir = get_tv_string_buf_chk(&argvars[1], buf);
8698 if (title == NULL || initdir == NULL)
8699 rettv->vval.v_string = NULL;
8700 else
8701 rettv->vval.v_string = do_browse(BROWSE_DIR,
8702 title, NULL, NULL, initdir, NULL, curbuf);
8703 #else
8704 rettv->vval.v_string = NULL;
8705 #endif
8706 rettv->v_type = VAR_STRING;
8709 static buf_T *find_buffer __ARGS((typval_T *avar));
8712 * Find a buffer by number or exact name.
8714 static buf_T *
8715 find_buffer(avar)
8716 typval_T *avar;
8718 buf_T *buf = NULL;
8720 if (avar->v_type == VAR_NUMBER)
8721 buf = buflist_findnr((int)avar->vval.v_number);
8722 else if (avar->v_type == VAR_STRING && avar->vval.v_string != NULL)
8724 buf = buflist_findname_exp(avar->vval.v_string);
8725 if (buf == NULL)
8727 /* No full path name match, try a match with a URL or a "nofile"
8728 * buffer, these don't use the full path. */
8729 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
8730 if (buf->b_fname != NULL
8731 && (path_with_url(buf->b_fname)
8732 #ifdef FEAT_QUICKFIX
8733 || bt_nofile(buf)
8734 #endif
8736 && STRCMP(buf->b_fname, avar->vval.v_string) == 0)
8737 break;
8740 return buf;
8744 * "bufexists(expr)" function
8746 static void
8747 f_bufexists(argvars, rettv)
8748 typval_T *argvars;
8749 typval_T *rettv;
8751 rettv->vval.v_number = (find_buffer(&argvars[0]) != NULL);
8755 * "buflisted(expr)" function
8757 static void
8758 f_buflisted(argvars, rettv)
8759 typval_T *argvars;
8760 typval_T *rettv;
8762 buf_T *buf;
8764 buf = find_buffer(&argvars[0]);
8765 rettv->vval.v_number = (buf != NULL && buf->b_p_bl);
8769 * "bufloaded(expr)" function
8771 static void
8772 f_bufloaded(argvars, rettv)
8773 typval_T *argvars;
8774 typval_T *rettv;
8776 buf_T *buf;
8778 buf = find_buffer(&argvars[0]);
8779 rettv->vval.v_number = (buf != NULL && buf->b_ml.ml_mfp != NULL);
8782 static buf_T *get_buf_tv __ARGS((typval_T *tv));
8785 * Get buffer by number or pattern.
8787 static buf_T *
8788 get_buf_tv(tv)
8789 typval_T *tv;
8791 char_u *name = tv->vval.v_string;
8792 int save_magic;
8793 char_u *save_cpo;
8794 buf_T *buf;
8796 if (tv->v_type == VAR_NUMBER)
8797 return buflist_findnr((int)tv->vval.v_number);
8798 if (tv->v_type != VAR_STRING)
8799 return NULL;
8800 if (name == NULL || *name == NUL)
8801 return curbuf;
8802 if (name[0] == '$' && name[1] == NUL)
8803 return lastbuf;
8805 /* Ignore 'magic' and 'cpoptions' here to make scripts portable */
8806 save_magic = p_magic;
8807 p_magic = TRUE;
8808 save_cpo = p_cpo;
8809 p_cpo = (char_u *)"";
8811 buf = buflist_findnr(buflist_findpat(name, name + STRLEN(name),
8812 TRUE, FALSE));
8814 p_magic = save_magic;
8815 p_cpo = save_cpo;
8817 /* If not found, try expanding the name, like done for bufexists(). */
8818 if (buf == NULL)
8819 buf = find_buffer(tv);
8821 return buf;
8825 * "bufname(expr)" function
8827 static void
8828 f_bufname(argvars, rettv)
8829 typval_T *argvars;
8830 typval_T *rettv;
8832 buf_T *buf;
8834 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8835 ++emsg_off;
8836 buf = get_buf_tv(&argvars[0]);
8837 rettv->v_type = VAR_STRING;
8838 if (buf != NULL && buf->b_fname != NULL)
8839 rettv->vval.v_string = vim_strsave(buf->b_fname);
8840 else
8841 rettv->vval.v_string = NULL;
8842 --emsg_off;
8846 * "bufnr(expr)" function
8848 static void
8849 f_bufnr(argvars, rettv)
8850 typval_T *argvars;
8851 typval_T *rettv;
8853 buf_T *buf;
8854 int error = FALSE;
8855 char_u *name;
8857 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8858 ++emsg_off;
8859 buf = get_buf_tv(&argvars[0]);
8860 --emsg_off;
8862 /* If the buffer isn't found and the second argument is not zero create a
8863 * new buffer. */
8864 if (buf == NULL
8865 && argvars[1].v_type != VAR_UNKNOWN
8866 && get_tv_number_chk(&argvars[1], &error) != 0
8867 && !error
8868 && (name = get_tv_string_chk(&argvars[0])) != NULL
8869 && !error)
8870 buf = buflist_new(name, NULL, (linenr_T)1, 0);
8872 if (buf != NULL)
8873 rettv->vval.v_number = buf->b_fnum;
8874 else
8875 rettv->vval.v_number = -1;
8879 * "bufwinnr(nr)" function
8881 static void
8882 f_bufwinnr(argvars, rettv)
8883 typval_T *argvars;
8884 typval_T *rettv;
8886 #ifdef FEAT_WINDOWS
8887 win_T *wp;
8888 int winnr = 0;
8889 #endif
8890 buf_T *buf;
8892 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
8893 ++emsg_off;
8894 buf = get_buf_tv(&argvars[0]);
8895 #ifdef FEAT_WINDOWS
8896 for (wp = firstwin; wp; wp = wp->w_next)
8898 ++winnr;
8899 if (wp->w_buffer == buf)
8900 break;
8902 rettv->vval.v_number = (wp != NULL ? winnr : -1);
8903 #else
8904 rettv->vval.v_number = (curwin->w_buffer == buf ? 1 : -1);
8905 #endif
8906 --emsg_off;
8910 * "byte2line(byte)" function
8912 static void
8913 f_byte2line(argvars, rettv)
8914 typval_T *argvars UNUSED;
8915 typval_T *rettv;
8917 #ifndef FEAT_BYTEOFF
8918 rettv->vval.v_number = -1;
8919 #else
8920 long boff = 0;
8922 boff = get_tv_number(&argvars[0]) - 1; /* boff gets -1 on type error */
8923 if (boff < 0)
8924 rettv->vval.v_number = -1;
8925 else
8926 rettv->vval.v_number = ml_find_line_or_offset(curbuf,
8927 (linenr_T)0, &boff);
8928 #endif
8932 * "byteidx()" function
8934 static void
8935 f_byteidx(argvars, rettv)
8936 typval_T *argvars;
8937 typval_T *rettv;
8939 #ifdef FEAT_MBYTE
8940 char_u *t;
8941 #endif
8942 char_u *str;
8943 long idx;
8945 str = get_tv_string_chk(&argvars[0]);
8946 idx = get_tv_number_chk(&argvars[1], NULL);
8947 rettv->vval.v_number = -1;
8948 if (str == NULL || idx < 0)
8949 return;
8951 #ifdef FEAT_MBYTE
8952 t = str;
8953 for ( ; idx > 0; idx--)
8955 if (*t == NUL) /* EOL reached */
8956 return;
8957 t += (*mb_ptr2len)(t);
8959 rettv->vval.v_number = (varnumber_T)(t - str);
8960 #else
8961 if ((size_t)idx <= STRLEN(str))
8962 rettv->vval.v_number = idx;
8963 #endif
8967 * "call(func, arglist)" function
8969 static void
8970 f_call(argvars, rettv)
8971 typval_T *argvars;
8972 typval_T *rettv;
8974 char_u *func;
8975 typval_T argv[MAX_FUNC_ARGS + 1];
8976 int argc = 0;
8977 listitem_T *item;
8978 int dummy;
8979 dict_T *selfdict = NULL;
8981 if (argvars[1].v_type != VAR_LIST)
8983 EMSG(_(e_listreq));
8984 return;
8986 if (argvars[1].vval.v_list == NULL)
8987 return;
8989 if (argvars[0].v_type == VAR_FUNC)
8990 func = argvars[0].vval.v_string;
8991 else
8992 func = get_tv_string(&argvars[0]);
8993 if (*func == NUL)
8994 return; /* type error or empty name */
8996 if (argvars[2].v_type != VAR_UNKNOWN)
8998 if (argvars[2].v_type != VAR_DICT)
9000 EMSG(_(e_dictreq));
9001 return;
9003 selfdict = argvars[2].vval.v_dict;
9006 for (item = argvars[1].vval.v_list->lv_first; item != NULL;
9007 item = item->li_next)
9009 if (argc == MAX_FUNC_ARGS)
9011 EMSG(_("E699: Too many arguments"));
9012 break;
9014 /* Make a copy of each argument. This is needed to be able to set
9015 * v_lock to VAR_FIXED in the copy without changing the original list.
9017 copy_tv(&item->li_tv, &argv[argc++]);
9020 if (item == NULL)
9021 (void)call_func(func, (int)STRLEN(func), rettv, argc, argv,
9022 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
9023 &dummy, TRUE, selfdict);
9025 /* Free the arguments. */
9026 while (argc > 0)
9027 clear_tv(&argv[--argc]);
9030 #ifdef FEAT_FLOAT
9032 * "ceil({float})" function
9034 static void
9035 f_ceil(argvars, rettv)
9036 typval_T *argvars;
9037 typval_T *rettv;
9039 float_T f;
9041 rettv->v_type = VAR_FLOAT;
9042 if (get_float_arg(argvars, &f) == OK)
9043 rettv->vval.v_float = ceil(f);
9044 else
9045 rettv->vval.v_float = 0.0;
9047 #endif
9050 * "changenr()" function
9052 static void
9053 f_changenr(argvars, rettv)
9054 typval_T *argvars UNUSED;
9055 typval_T *rettv;
9057 rettv->vval.v_number = curbuf->b_u_seq_cur;
9061 * "char2nr(string)" function
9063 static void
9064 f_char2nr(argvars, rettv)
9065 typval_T *argvars;
9066 typval_T *rettv;
9068 #ifdef FEAT_MBYTE
9069 if (has_mbyte)
9070 rettv->vval.v_number = (*mb_ptr2char)(get_tv_string(&argvars[0]));
9071 else
9072 #endif
9073 rettv->vval.v_number = get_tv_string(&argvars[0])[0];
9077 * "cindent(lnum)" function
9079 static void
9080 f_cindent(argvars, rettv)
9081 typval_T *argvars;
9082 typval_T *rettv;
9084 #ifdef FEAT_CINDENT
9085 pos_T pos;
9086 linenr_T lnum;
9088 pos = curwin->w_cursor;
9089 lnum = get_tv_lnum(argvars);
9090 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
9092 curwin->w_cursor.lnum = lnum;
9093 rettv->vval.v_number = get_c_indent();
9094 curwin->w_cursor = pos;
9096 else
9097 #endif
9098 rettv->vval.v_number = -1;
9102 * "clearmatches()" function
9104 static void
9105 f_clearmatches(argvars, rettv)
9106 typval_T *argvars UNUSED;
9107 typval_T *rettv UNUSED;
9109 #ifdef FEAT_SEARCH_EXTRA
9110 clear_matches(curwin);
9111 #endif
9115 * "col(string)" function
9117 static void
9118 f_col(argvars, rettv)
9119 typval_T *argvars;
9120 typval_T *rettv;
9122 colnr_T col = 0;
9123 pos_T *fp;
9124 int fnum = curbuf->b_fnum;
9126 fp = var2fpos(&argvars[0], FALSE, &fnum);
9127 if (fp != NULL && fnum == curbuf->b_fnum)
9129 if (fp->col == MAXCOL)
9131 /* '> can be MAXCOL, get the length of the line then */
9132 if (fp->lnum <= curbuf->b_ml.ml_line_count)
9133 col = (colnr_T)STRLEN(ml_get(fp->lnum)) + 1;
9134 else
9135 col = MAXCOL;
9137 else
9139 col = fp->col + 1;
9140 #ifdef FEAT_VIRTUALEDIT
9141 /* col(".") when the cursor is on the NUL at the end of the line
9142 * because of "coladd" can be seen as an extra column. */
9143 if (virtual_active() && fp == &curwin->w_cursor)
9145 char_u *p = ml_get_cursor();
9147 if (curwin->w_cursor.coladd >= (colnr_T)chartabsize(p,
9148 curwin->w_virtcol - curwin->w_cursor.coladd))
9150 # ifdef FEAT_MBYTE
9151 int l;
9153 if (*p != NUL && p[(l = (*mb_ptr2len)(p))] == NUL)
9154 col += l;
9155 # else
9156 if (*p != NUL && p[1] == NUL)
9157 ++col;
9158 # endif
9161 #endif
9164 rettv->vval.v_number = col;
9167 #if defined(FEAT_INS_EXPAND)
9169 * "complete()" function
9171 static void
9172 f_complete(argvars, rettv)
9173 typval_T *argvars;
9174 typval_T *rettv UNUSED;
9176 int startcol;
9178 if ((State & INSERT) == 0)
9180 EMSG(_("E785: complete() can only be used in Insert mode"));
9181 return;
9184 /* Check for undo allowed here, because if something was already inserted
9185 * the line was already saved for undo and this check isn't done. */
9186 if (!undo_allowed())
9187 return;
9189 if (argvars[1].v_type != VAR_LIST || argvars[1].vval.v_list == NULL)
9191 EMSG(_(e_invarg));
9192 return;
9195 startcol = get_tv_number_chk(&argvars[0], NULL);
9196 if (startcol <= 0)
9197 return;
9199 set_completion(startcol - 1, argvars[1].vval.v_list);
9203 * "complete_add()" function
9205 static void
9206 f_complete_add(argvars, rettv)
9207 typval_T *argvars;
9208 typval_T *rettv;
9210 rettv->vval.v_number = ins_compl_add_tv(&argvars[0], 0);
9214 * "complete_check()" function
9216 static void
9217 f_complete_check(argvars, rettv)
9218 typval_T *argvars UNUSED;
9219 typval_T *rettv;
9221 int saved = RedrawingDisabled;
9223 RedrawingDisabled = 0;
9224 ins_compl_check_keys(0);
9225 rettv->vval.v_number = compl_interrupted;
9226 RedrawingDisabled = saved;
9228 #endif
9231 * "confirm(message, buttons[, default [, type]])" function
9233 static void
9234 f_confirm(argvars, rettv)
9235 typval_T *argvars UNUSED;
9236 typval_T *rettv UNUSED;
9238 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
9239 char_u *message;
9240 char_u *buttons = NULL;
9241 char_u buf[NUMBUFLEN];
9242 char_u buf2[NUMBUFLEN];
9243 int def = 1;
9244 int type = VIM_GENERIC;
9245 char_u *typestr;
9246 int error = FALSE;
9248 message = get_tv_string_chk(&argvars[0]);
9249 if (message == NULL)
9250 error = TRUE;
9251 if (argvars[1].v_type != VAR_UNKNOWN)
9253 buttons = get_tv_string_buf_chk(&argvars[1], buf);
9254 if (buttons == NULL)
9255 error = TRUE;
9256 if (argvars[2].v_type != VAR_UNKNOWN)
9258 def = get_tv_number_chk(&argvars[2], &error);
9259 if (argvars[3].v_type != VAR_UNKNOWN)
9261 typestr = get_tv_string_buf_chk(&argvars[3], buf2);
9262 if (typestr == NULL)
9263 error = TRUE;
9264 else
9266 switch (TOUPPER_ASC(*typestr))
9268 case 'E': type = VIM_ERROR; break;
9269 case 'Q': type = VIM_QUESTION; break;
9270 case 'I': type = VIM_INFO; break;
9271 case 'W': type = VIM_WARNING; break;
9272 case 'G': type = VIM_GENERIC; break;
9279 if (buttons == NULL || *buttons == NUL)
9280 buttons = (char_u *)_("&Ok");
9282 if (!error)
9283 rettv->vval.v_number = do_dialog(type, NULL, message, buttons,
9284 def, NULL);
9285 #endif
9289 * "copy()" function
9291 static void
9292 f_copy(argvars, rettv)
9293 typval_T *argvars;
9294 typval_T *rettv;
9296 item_copy(&argvars[0], rettv, FALSE, 0);
9299 #ifdef FEAT_FLOAT
9301 * "cos()" function
9303 static void
9304 f_cos(argvars, rettv)
9305 typval_T *argvars;
9306 typval_T *rettv;
9308 float_T f;
9310 rettv->v_type = VAR_FLOAT;
9311 if (get_float_arg(argvars, &f) == OK)
9312 rettv->vval.v_float = cos(f);
9313 else
9314 rettv->vval.v_float = 0.0;
9316 #endif
9319 * "count()" function
9321 static void
9322 f_count(argvars, rettv)
9323 typval_T *argvars;
9324 typval_T *rettv;
9326 long n = 0;
9327 int ic = FALSE;
9329 if (argvars[0].v_type == VAR_LIST)
9331 listitem_T *li;
9332 list_T *l;
9333 long idx;
9335 if ((l = argvars[0].vval.v_list) != NULL)
9337 li = l->lv_first;
9338 if (argvars[2].v_type != VAR_UNKNOWN)
9340 int error = FALSE;
9342 ic = get_tv_number_chk(&argvars[2], &error);
9343 if (argvars[3].v_type != VAR_UNKNOWN)
9345 idx = get_tv_number_chk(&argvars[3], &error);
9346 if (!error)
9348 li = list_find(l, idx);
9349 if (li == NULL)
9350 EMSGN(_(e_listidx), idx);
9353 if (error)
9354 li = NULL;
9357 for ( ; li != NULL; li = li->li_next)
9358 if (tv_equal(&li->li_tv, &argvars[1], ic))
9359 ++n;
9362 else if (argvars[0].v_type == VAR_DICT)
9364 int todo;
9365 dict_T *d;
9366 hashitem_T *hi;
9368 if ((d = argvars[0].vval.v_dict) != NULL)
9370 int error = FALSE;
9372 if (argvars[2].v_type != VAR_UNKNOWN)
9374 ic = get_tv_number_chk(&argvars[2], &error);
9375 if (argvars[3].v_type != VAR_UNKNOWN)
9376 EMSG(_(e_invarg));
9379 todo = error ? 0 : (int)d->dv_hashtab.ht_used;
9380 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
9382 if (!HASHITEM_EMPTY(hi))
9384 --todo;
9385 if (tv_equal(&HI2DI(hi)->di_tv, &argvars[1], ic))
9386 ++n;
9391 else
9392 EMSG2(_(e_listdictarg), "count()");
9393 rettv->vval.v_number = n;
9397 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
9399 * Checks the existence of a cscope connection.
9401 static void
9402 f_cscope_connection(argvars, rettv)
9403 typval_T *argvars UNUSED;
9404 typval_T *rettv UNUSED;
9406 #ifdef FEAT_CSCOPE
9407 int num = 0;
9408 char_u *dbpath = NULL;
9409 char_u *prepend = NULL;
9410 char_u buf[NUMBUFLEN];
9412 if (argvars[0].v_type != VAR_UNKNOWN
9413 && argvars[1].v_type != VAR_UNKNOWN)
9415 num = (int)get_tv_number(&argvars[0]);
9416 dbpath = get_tv_string(&argvars[1]);
9417 if (argvars[2].v_type != VAR_UNKNOWN)
9418 prepend = get_tv_string_buf(&argvars[2], buf);
9421 rettv->vval.v_number = cs_connection(num, dbpath, prepend);
9422 #endif
9426 * "cursor(lnum, col)" function
9428 * Moves the cursor to the specified line and column.
9429 * Returns 0 when the position could be set, -1 otherwise.
9431 static void
9432 f_cursor(argvars, rettv)
9433 typval_T *argvars;
9434 typval_T *rettv;
9436 long line, col;
9437 #ifdef FEAT_VIRTUALEDIT
9438 long coladd = 0;
9439 #endif
9441 rettv->vval.v_number = -1;
9442 if (argvars[1].v_type == VAR_UNKNOWN)
9444 pos_T pos;
9446 if (list2fpos(argvars, &pos, NULL) == FAIL)
9447 return;
9448 line = pos.lnum;
9449 col = pos.col;
9450 #ifdef FEAT_VIRTUALEDIT
9451 coladd = pos.coladd;
9452 #endif
9454 else
9456 line = get_tv_lnum(argvars);
9457 col = get_tv_number_chk(&argvars[1], NULL);
9458 #ifdef FEAT_VIRTUALEDIT
9459 if (argvars[2].v_type != VAR_UNKNOWN)
9460 coladd = get_tv_number_chk(&argvars[2], NULL);
9461 #endif
9463 if (line < 0 || col < 0
9464 #ifdef FEAT_VIRTUALEDIT
9465 || coladd < 0
9466 #endif
9468 return; /* type error; errmsg already given */
9469 if (line > 0)
9470 curwin->w_cursor.lnum = line;
9471 if (col > 0)
9472 curwin->w_cursor.col = col - 1;
9473 #ifdef FEAT_VIRTUALEDIT
9474 curwin->w_cursor.coladd = coladd;
9475 #endif
9477 /* Make sure the cursor is in a valid position. */
9478 check_cursor();
9479 #ifdef FEAT_MBYTE
9480 /* Correct cursor for multi-byte character. */
9481 if (has_mbyte)
9482 mb_adjust_cursor();
9483 #endif
9485 curwin->w_set_curswant = TRUE;
9486 rettv->vval.v_number = 0;
9490 * "deepcopy()" function
9492 static void
9493 f_deepcopy(argvars, rettv)
9494 typval_T *argvars;
9495 typval_T *rettv;
9497 int noref = 0;
9499 if (argvars[1].v_type != VAR_UNKNOWN)
9500 noref = get_tv_number_chk(&argvars[1], NULL);
9501 if (noref < 0 || noref > 1)
9502 EMSG(_(e_invarg));
9503 else
9505 current_copyID += COPYID_INC;
9506 item_copy(&argvars[0], rettv, TRUE, noref == 0 ? current_copyID : 0);
9511 * "delete()" function
9513 static void
9514 f_delete(argvars, rettv)
9515 typval_T *argvars;
9516 typval_T *rettv;
9518 if (check_restricted() || check_secure())
9519 rettv->vval.v_number = -1;
9520 else
9521 rettv->vval.v_number = mch_remove(get_tv_string(&argvars[0]));
9525 * "did_filetype()" function
9527 static void
9528 f_did_filetype(argvars, rettv)
9529 typval_T *argvars UNUSED;
9530 typval_T *rettv UNUSED;
9532 #ifdef FEAT_AUTOCMD
9533 rettv->vval.v_number = did_filetype;
9534 #endif
9538 * "diff_filler()" function
9540 static void
9541 f_diff_filler(argvars, rettv)
9542 typval_T *argvars UNUSED;
9543 typval_T *rettv UNUSED;
9545 #ifdef FEAT_DIFF
9546 rettv->vval.v_number = diff_check_fill(curwin, get_tv_lnum(argvars));
9547 #endif
9551 * "diff_hlID()" function
9553 static void
9554 f_diff_hlID(argvars, rettv)
9555 typval_T *argvars UNUSED;
9556 typval_T *rettv UNUSED;
9558 #ifdef FEAT_DIFF
9559 linenr_T lnum = get_tv_lnum(argvars);
9560 static linenr_T prev_lnum = 0;
9561 static int changedtick = 0;
9562 static int fnum = 0;
9563 static int change_start = 0;
9564 static int change_end = 0;
9565 static hlf_T hlID = (hlf_T)0;
9566 int filler_lines;
9567 int col;
9569 if (lnum < 0) /* ignore type error in {lnum} arg */
9570 lnum = 0;
9571 if (lnum != prev_lnum
9572 || changedtick != curbuf->b_changedtick
9573 || fnum != curbuf->b_fnum)
9575 /* New line, buffer, change: need to get the values. */
9576 filler_lines = diff_check(curwin, lnum);
9577 if (filler_lines < 0)
9579 if (filler_lines == -1)
9581 change_start = MAXCOL;
9582 change_end = -1;
9583 if (diff_find_change(curwin, lnum, &change_start, &change_end))
9584 hlID = HLF_ADD; /* added line */
9585 else
9586 hlID = HLF_CHD; /* changed line */
9588 else
9589 hlID = HLF_ADD; /* added line */
9591 else
9592 hlID = (hlf_T)0;
9593 prev_lnum = lnum;
9594 changedtick = curbuf->b_changedtick;
9595 fnum = curbuf->b_fnum;
9598 if (hlID == HLF_CHD || hlID == HLF_TXD)
9600 col = get_tv_number(&argvars[1]) - 1; /* ignore type error in {col} */
9601 if (col >= change_start && col <= change_end)
9602 hlID = HLF_TXD; /* changed text */
9603 else
9604 hlID = HLF_CHD; /* changed line */
9606 rettv->vval.v_number = hlID == (hlf_T)0 ? 0 : (int)hlID;
9607 #endif
9611 * "empty({expr})" function
9613 static void
9614 f_empty(argvars, rettv)
9615 typval_T *argvars;
9616 typval_T *rettv;
9618 int n;
9620 switch (argvars[0].v_type)
9622 case VAR_STRING:
9623 case VAR_FUNC:
9624 n = argvars[0].vval.v_string == NULL
9625 || *argvars[0].vval.v_string == NUL;
9626 break;
9627 case VAR_NUMBER:
9628 n = argvars[0].vval.v_number == 0;
9629 break;
9630 #ifdef FEAT_FLOAT
9631 case VAR_FLOAT:
9632 n = argvars[0].vval.v_float == 0.0;
9633 break;
9634 #endif
9635 case VAR_LIST:
9636 n = argvars[0].vval.v_list == NULL
9637 || argvars[0].vval.v_list->lv_first == NULL;
9638 break;
9639 case VAR_DICT:
9640 n = argvars[0].vval.v_dict == NULL
9641 || argvars[0].vval.v_dict->dv_hashtab.ht_used == 0;
9642 break;
9643 default:
9644 EMSG2(_(e_intern2), "f_empty()");
9645 n = 0;
9648 rettv->vval.v_number = n;
9652 * "escape({string}, {chars})" function
9654 static void
9655 f_escape(argvars, rettv)
9656 typval_T *argvars;
9657 typval_T *rettv;
9659 char_u buf[NUMBUFLEN];
9661 rettv->vval.v_string = vim_strsave_escaped(get_tv_string(&argvars[0]),
9662 get_tv_string_buf(&argvars[1], buf));
9663 rettv->v_type = VAR_STRING;
9667 * "eval()" function
9669 static void
9670 f_eval(argvars, rettv)
9671 typval_T *argvars;
9672 typval_T *rettv;
9674 char_u *s;
9676 s = get_tv_string_chk(&argvars[0]);
9677 if (s != NULL)
9678 s = skipwhite(s);
9680 if (s == NULL || eval1(&s, rettv, TRUE) == FAIL)
9682 rettv->v_type = VAR_NUMBER;
9683 rettv->vval.v_number = 0;
9685 else if (*s != NUL)
9686 EMSG(_(e_trailing));
9690 * "eventhandler()" function
9692 static void
9693 f_eventhandler(argvars, rettv)
9694 typval_T *argvars UNUSED;
9695 typval_T *rettv;
9697 rettv->vval.v_number = vgetc_busy;
9701 * "executable()" function
9703 static void
9704 f_executable(argvars, rettv)
9705 typval_T *argvars;
9706 typval_T *rettv;
9708 rettv->vval.v_number = mch_can_exe(get_tv_string(&argvars[0]));
9712 * "exists()" function
9714 static void
9715 f_exists(argvars, rettv)
9716 typval_T *argvars;
9717 typval_T *rettv;
9719 char_u *p;
9720 char_u *name;
9721 int n = FALSE;
9722 int len = 0;
9724 p = get_tv_string(&argvars[0]);
9725 if (*p == '$') /* environment variable */
9727 /* first try "normal" environment variables (fast) */
9728 if (mch_getenv(p + 1) != NULL)
9729 n = TRUE;
9730 else
9732 /* try expanding things like $VIM and ${HOME} */
9733 p = expand_env_save(p);
9734 if (p != NULL && *p != '$')
9735 n = TRUE;
9736 vim_free(p);
9739 else if (*p == '&' || *p == '+') /* option */
9741 n = (get_option_tv(&p, NULL, TRUE) == OK);
9742 if (*skipwhite(p) != NUL)
9743 n = FALSE; /* trailing garbage */
9745 else if (*p == '*') /* internal or user defined function */
9747 n = function_exists(p + 1);
9749 else if (*p == ':')
9751 n = cmd_exists(p + 1);
9753 else if (*p == '#')
9755 #ifdef FEAT_AUTOCMD
9756 if (p[1] == '#')
9757 n = autocmd_supported(p + 2);
9758 else
9759 n = au_exists(p + 1);
9760 #endif
9762 else /* internal variable */
9764 char_u *tofree;
9765 typval_T tv;
9767 /* get_name_len() takes care of expanding curly braces */
9768 name = p;
9769 len = get_name_len(&p, &tofree, TRUE, FALSE);
9770 if (len > 0)
9772 if (tofree != NULL)
9773 name = tofree;
9774 n = (get_var_tv(name, len, &tv, FALSE) == OK);
9775 if (n)
9777 /* handle d.key, l[idx], f(expr) */
9778 n = (handle_subscript(&p, &tv, TRUE, FALSE) == OK);
9779 if (n)
9780 clear_tv(&tv);
9783 if (*p != NUL)
9784 n = FALSE;
9786 vim_free(tofree);
9789 rettv->vval.v_number = n;
9793 * "expand()" function
9795 static void
9796 f_expand(argvars, rettv)
9797 typval_T *argvars;
9798 typval_T *rettv;
9800 char_u *s;
9801 int len;
9802 char_u *errormsg;
9803 int flags = WILD_SILENT|WILD_USE_NL|WILD_LIST_NOTFOUND;
9804 expand_T xpc;
9805 int error = FALSE;
9807 rettv->v_type = VAR_STRING;
9808 s = get_tv_string(&argvars[0]);
9809 if (*s == '%' || *s == '#' || *s == '<')
9811 ++emsg_off;
9812 rettv->vval.v_string = eval_vars(s, s, &len, NULL, &errormsg, NULL);
9813 --emsg_off;
9815 else
9817 /* When the optional second argument is non-zero, don't remove matches
9818 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
9819 if (argvars[1].v_type != VAR_UNKNOWN
9820 && get_tv_number_chk(&argvars[1], &error))
9821 flags |= WILD_KEEP_ALL;
9822 if (!error)
9824 ExpandInit(&xpc);
9825 xpc.xp_context = EXPAND_FILES;
9826 rettv->vval.v_string = ExpandOne(&xpc, s, NULL, flags, WILD_ALL);
9828 else
9829 rettv->vval.v_string = NULL;
9834 * "extend(list, list [, idx])" function
9835 * "extend(dict, dict [, action])" function
9837 static void
9838 f_extend(argvars, rettv)
9839 typval_T *argvars;
9840 typval_T *rettv;
9842 if (argvars[0].v_type == VAR_LIST && argvars[1].v_type == VAR_LIST)
9844 list_T *l1, *l2;
9845 listitem_T *item;
9846 long before;
9847 int error = FALSE;
9849 l1 = argvars[0].vval.v_list;
9850 l2 = argvars[1].vval.v_list;
9851 if (l1 != NULL && !tv_check_lock(l1->lv_lock, (char_u *)"extend()")
9852 && l2 != NULL)
9854 if (argvars[2].v_type != VAR_UNKNOWN)
9856 before = get_tv_number_chk(&argvars[2], &error);
9857 if (error)
9858 return; /* type error; errmsg already given */
9860 if (before == l1->lv_len)
9861 item = NULL;
9862 else
9864 item = list_find(l1, before);
9865 if (item == NULL)
9867 EMSGN(_(e_listidx), before);
9868 return;
9872 else
9873 item = NULL;
9874 list_extend(l1, l2, item);
9876 copy_tv(&argvars[0], rettv);
9879 else if (argvars[0].v_type == VAR_DICT && argvars[1].v_type == VAR_DICT)
9881 dict_T *d1, *d2;
9882 dictitem_T *di1;
9883 char_u *action;
9884 int i;
9885 hashitem_T *hi2;
9886 int todo;
9888 d1 = argvars[0].vval.v_dict;
9889 d2 = argvars[1].vval.v_dict;
9890 if (d1 != NULL && !tv_check_lock(d1->dv_lock, (char_u *)"extend()")
9891 && d2 != NULL)
9893 /* Check the third argument. */
9894 if (argvars[2].v_type != VAR_UNKNOWN)
9896 static char *(av[]) = {"keep", "force", "error"};
9898 action = get_tv_string_chk(&argvars[2]);
9899 if (action == NULL)
9900 return; /* type error; errmsg already given */
9901 for (i = 0; i < 3; ++i)
9902 if (STRCMP(action, av[i]) == 0)
9903 break;
9904 if (i == 3)
9906 EMSG2(_(e_invarg2), action);
9907 return;
9910 else
9911 action = (char_u *)"force";
9913 /* Go over all entries in the second dict and add them to the
9914 * first dict. */
9915 todo = (int)d2->dv_hashtab.ht_used;
9916 for (hi2 = d2->dv_hashtab.ht_array; todo > 0; ++hi2)
9918 if (!HASHITEM_EMPTY(hi2))
9920 --todo;
9921 di1 = dict_find(d1, hi2->hi_key, -1);
9922 if (di1 == NULL)
9924 di1 = dictitem_copy(HI2DI(hi2));
9925 if (di1 != NULL && dict_add(d1, di1) == FAIL)
9926 dictitem_free(di1);
9928 else if (*action == 'e')
9930 EMSG2(_("E737: Key already exists: %s"), hi2->hi_key);
9931 break;
9933 else if (*action == 'f')
9935 clear_tv(&di1->di_tv);
9936 copy_tv(&HI2DI(hi2)->di_tv, &di1->di_tv);
9941 copy_tv(&argvars[0], rettv);
9944 else
9945 EMSG2(_(e_listdictarg), "extend()");
9949 * "feedkeys()" function
9951 static void
9952 f_feedkeys(argvars, rettv)
9953 typval_T *argvars;
9954 typval_T *rettv UNUSED;
9956 int remap = TRUE;
9957 char_u *keys, *flags;
9958 char_u nbuf[NUMBUFLEN];
9959 int typed = FALSE;
9960 char_u *keys_esc;
9962 /* This is not allowed in the sandbox. If the commands would still be
9963 * executed in the sandbox it would be OK, but it probably happens later,
9964 * when "sandbox" is no longer set. */
9965 if (check_secure())
9966 return;
9968 keys = get_tv_string(&argvars[0]);
9969 if (*keys != NUL)
9971 if (argvars[1].v_type != VAR_UNKNOWN)
9973 flags = get_tv_string_buf(&argvars[1], nbuf);
9974 for ( ; *flags != NUL; ++flags)
9976 switch (*flags)
9978 case 'n': remap = FALSE; break;
9979 case 'm': remap = TRUE; break;
9980 case 't': typed = TRUE; break;
9985 /* Need to escape K_SPECIAL and CSI before putting the string in the
9986 * typeahead buffer. */
9987 keys_esc = vim_strsave_escape_csi(keys);
9988 if (keys_esc != NULL)
9990 ins_typebuf(keys_esc, (remap ? REMAP_YES : REMAP_NONE),
9991 typebuf.tb_len, !typed, FALSE);
9992 vim_free(keys_esc);
9993 if (vgetc_busy)
9994 typebuf_was_filled = TRUE;
10000 * "filereadable()" function
10002 static void
10003 f_filereadable(argvars, rettv)
10004 typval_T *argvars;
10005 typval_T *rettv;
10007 int fd;
10008 char_u *p;
10009 int n;
10011 #ifndef O_NONBLOCK
10012 # define O_NONBLOCK 0
10013 #endif
10014 p = get_tv_string(&argvars[0]);
10015 if (*p && !mch_isdir(p) && (fd = mch_open((char *)p,
10016 O_RDONLY | O_NONBLOCK, 0)) >= 0)
10018 n = TRUE;
10019 close(fd);
10021 else
10022 n = FALSE;
10024 rettv->vval.v_number = n;
10028 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
10029 * rights to write into.
10031 static void
10032 f_filewritable(argvars, rettv)
10033 typval_T *argvars;
10034 typval_T *rettv;
10036 rettv->vval.v_number = filewritable(get_tv_string(&argvars[0]));
10039 static void findfilendir __ARGS((typval_T *argvars, typval_T *rettv, int find_what));
10041 static void
10042 findfilendir(argvars, rettv, find_what)
10043 typval_T *argvars;
10044 typval_T *rettv;
10045 int find_what;
10047 #ifdef FEAT_SEARCHPATH
10048 char_u *fname;
10049 char_u *fresult = NULL;
10050 char_u *path = *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path;
10051 char_u *p;
10052 char_u pathbuf[NUMBUFLEN];
10053 int count = 1;
10054 int first = TRUE;
10055 int error = FALSE;
10056 #endif
10058 rettv->vval.v_string = NULL;
10059 rettv->v_type = VAR_STRING;
10061 #ifdef FEAT_SEARCHPATH
10062 fname = get_tv_string(&argvars[0]);
10064 if (argvars[1].v_type != VAR_UNKNOWN)
10066 p = get_tv_string_buf_chk(&argvars[1], pathbuf);
10067 if (p == NULL)
10068 error = TRUE;
10069 else
10071 if (*p != NUL)
10072 path = p;
10074 if (argvars[2].v_type != VAR_UNKNOWN)
10075 count = get_tv_number_chk(&argvars[2], &error);
10079 if (count < 0 && rettv_list_alloc(rettv) == FAIL)
10080 error = TRUE;
10082 if (*fname != NUL && !error)
10086 if (rettv->v_type == VAR_STRING)
10087 vim_free(fresult);
10088 fresult = find_file_in_path_option(first ? fname : NULL,
10089 first ? (int)STRLEN(fname) : 0,
10090 0, first, path,
10091 find_what,
10092 curbuf->b_ffname,
10093 find_what == FINDFILE_DIR
10094 ? (char_u *)"" : curbuf->b_p_sua);
10095 first = FALSE;
10097 if (fresult != NULL && rettv->v_type == VAR_LIST)
10098 list_append_string(rettv->vval.v_list, fresult, -1);
10100 } while ((rettv->v_type == VAR_LIST || --count > 0) && fresult != NULL);
10103 if (rettv->v_type == VAR_STRING)
10104 rettv->vval.v_string = fresult;
10105 #endif
10108 static void filter_map __ARGS((typval_T *argvars, typval_T *rettv, int map));
10109 static int filter_map_one __ARGS((typval_T *tv, char_u *expr, int map, int *remp));
10112 * Implementation of map() and filter().
10114 static void
10115 filter_map(argvars, rettv, map)
10116 typval_T *argvars;
10117 typval_T *rettv;
10118 int map;
10120 char_u buf[NUMBUFLEN];
10121 char_u *expr;
10122 listitem_T *li, *nli;
10123 list_T *l = NULL;
10124 dictitem_T *di;
10125 hashtab_T *ht;
10126 hashitem_T *hi;
10127 dict_T *d = NULL;
10128 typval_T save_val;
10129 typval_T save_key;
10130 int rem;
10131 int todo;
10132 char_u *ermsg = map ? (char_u *)"map()" : (char_u *)"filter()";
10133 int save_did_emsg;
10135 if (argvars[0].v_type == VAR_LIST)
10137 if ((l = argvars[0].vval.v_list) == NULL
10138 || (map && tv_check_lock(l->lv_lock, ermsg)))
10139 return;
10141 else if (argvars[0].v_type == VAR_DICT)
10143 if ((d = argvars[0].vval.v_dict) == NULL
10144 || (map && tv_check_lock(d->dv_lock, ermsg)))
10145 return;
10147 else
10149 EMSG2(_(e_listdictarg), ermsg);
10150 return;
10153 expr = get_tv_string_buf_chk(&argvars[1], buf);
10154 /* On type errors, the preceding call has already displayed an error
10155 * message. Avoid a misleading error message for an empty string that
10156 * was not passed as argument. */
10157 if (expr != NULL)
10159 prepare_vimvar(VV_VAL, &save_val);
10160 expr = skipwhite(expr);
10162 /* We reset "did_emsg" to be able to detect whether an error
10163 * occurred during evaluation of the expression. */
10164 save_did_emsg = did_emsg;
10165 did_emsg = FALSE;
10167 if (argvars[0].v_type == VAR_DICT)
10169 prepare_vimvar(VV_KEY, &save_key);
10170 vimvars[VV_KEY].vv_type = VAR_STRING;
10172 ht = &d->dv_hashtab;
10173 hash_lock(ht);
10174 todo = (int)ht->ht_used;
10175 for (hi = ht->ht_array; todo > 0; ++hi)
10177 if (!HASHITEM_EMPTY(hi))
10179 --todo;
10180 di = HI2DI(hi);
10181 if (tv_check_lock(di->di_tv.v_lock, ermsg))
10182 break;
10183 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
10184 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
10185 || did_emsg)
10186 break;
10187 if (!map && rem)
10188 dictitem_remove(d, di);
10189 clear_tv(&vimvars[VV_KEY].vv_tv);
10192 hash_unlock(ht);
10194 restore_vimvar(VV_KEY, &save_key);
10196 else
10198 for (li = l->lv_first; li != NULL; li = nli)
10200 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10201 break;
10202 nli = li->li_next;
10203 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10204 || did_emsg)
10205 break;
10206 if (!map && rem)
10207 listitem_remove(l, li);
10211 restore_vimvar(VV_VAL, &save_val);
10213 did_emsg |= save_did_emsg;
10216 copy_tv(&argvars[0], rettv);
10219 static int
10220 filter_map_one(tv, expr, map, remp)
10221 typval_T *tv;
10222 char_u *expr;
10223 int map;
10224 int *remp;
10226 typval_T rettv;
10227 char_u *s;
10228 int retval = FAIL;
10230 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10231 s = expr;
10232 if (eval1(&s, &rettv, TRUE) == FAIL)
10233 goto theend;
10234 if (*s != NUL) /* check for trailing chars after expr */
10236 EMSG2(_(e_invexpr2), s);
10237 goto theend;
10239 if (map)
10241 /* map(): replace the list item value */
10242 clear_tv(tv);
10243 rettv.v_lock = 0;
10244 *tv = rettv;
10246 else
10248 int error = FALSE;
10250 /* filter(): when expr is zero remove the item */
10251 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10252 clear_tv(&rettv);
10253 /* On type error, nothing has been removed; return FAIL to stop the
10254 * loop. The error message was given by get_tv_number_chk(). */
10255 if (error)
10256 goto theend;
10258 retval = OK;
10259 theend:
10260 clear_tv(&vimvars[VV_VAL].vv_tv);
10261 return retval;
10265 * "filter()" function
10267 static void
10268 f_filter(argvars, rettv)
10269 typval_T *argvars;
10270 typval_T *rettv;
10272 filter_map(argvars, rettv, FALSE);
10276 * "finddir({fname}[, {path}[, {count}]])" function
10278 static void
10279 f_finddir(argvars, rettv)
10280 typval_T *argvars;
10281 typval_T *rettv;
10283 findfilendir(argvars, rettv, FINDFILE_DIR);
10287 * "findfile({fname}[, {path}[, {count}]])" function
10289 static void
10290 f_findfile(argvars, rettv)
10291 typval_T *argvars;
10292 typval_T *rettv;
10294 findfilendir(argvars, rettv, FINDFILE_FILE);
10297 #ifdef FEAT_FLOAT
10299 * "float2nr({float})" function
10301 static void
10302 f_float2nr(argvars, rettv)
10303 typval_T *argvars;
10304 typval_T *rettv;
10306 float_T f;
10308 if (get_float_arg(argvars, &f) == OK)
10310 if (f < -0x7fffffff)
10311 rettv->vval.v_number = -0x7fffffff;
10312 else if (f > 0x7fffffff)
10313 rettv->vval.v_number = 0x7fffffff;
10314 else
10315 rettv->vval.v_number = (varnumber_T)f;
10320 * "floor({float})" function
10322 static void
10323 f_floor(argvars, rettv)
10324 typval_T *argvars;
10325 typval_T *rettv;
10327 float_T f;
10329 rettv->v_type = VAR_FLOAT;
10330 if (get_float_arg(argvars, &f) == OK)
10331 rettv->vval.v_float = floor(f);
10332 else
10333 rettv->vval.v_float = 0.0;
10335 #endif
10338 * "fnameescape({string})" function
10340 static void
10341 f_fnameescape(argvars, rettv)
10342 typval_T *argvars;
10343 typval_T *rettv;
10345 rettv->vval.v_string = vim_strsave_fnameescape(
10346 get_tv_string(&argvars[0]), FALSE);
10347 rettv->v_type = VAR_STRING;
10351 * "fnamemodify({fname}, {mods})" function
10353 static void
10354 f_fnamemodify(argvars, rettv)
10355 typval_T *argvars;
10356 typval_T *rettv;
10358 char_u *fname;
10359 char_u *mods;
10360 int usedlen = 0;
10361 int len;
10362 char_u *fbuf = NULL;
10363 char_u buf[NUMBUFLEN];
10365 fname = get_tv_string_chk(&argvars[0]);
10366 mods = get_tv_string_buf_chk(&argvars[1], buf);
10367 if (fname == NULL || mods == NULL)
10368 fname = NULL;
10369 else
10371 len = (int)STRLEN(fname);
10372 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10375 rettv->v_type = VAR_STRING;
10376 if (fname == NULL)
10377 rettv->vval.v_string = NULL;
10378 else
10379 rettv->vval.v_string = vim_strnsave(fname, len);
10380 vim_free(fbuf);
10383 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10386 * "foldclosed()" function
10388 static void
10389 foldclosed_both(argvars, rettv, end)
10390 typval_T *argvars;
10391 typval_T *rettv;
10392 int end;
10394 #ifdef FEAT_FOLDING
10395 linenr_T lnum;
10396 linenr_T first, last;
10398 lnum = get_tv_lnum(argvars);
10399 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10401 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10403 if (end)
10404 rettv->vval.v_number = (varnumber_T)last;
10405 else
10406 rettv->vval.v_number = (varnumber_T)first;
10407 return;
10410 #endif
10411 rettv->vval.v_number = -1;
10415 * "foldclosed()" function
10417 static void
10418 f_foldclosed(argvars, rettv)
10419 typval_T *argvars;
10420 typval_T *rettv;
10422 foldclosed_both(argvars, rettv, FALSE);
10426 * "foldclosedend()" function
10428 static void
10429 f_foldclosedend(argvars, rettv)
10430 typval_T *argvars;
10431 typval_T *rettv;
10433 foldclosed_both(argvars, rettv, TRUE);
10437 * "foldlevel()" function
10439 static void
10440 f_foldlevel(argvars, rettv)
10441 typval_T *argvars;
10442 typval_T *rettv;
10444 #ifdef FEAT_FOLDING
10445 linenr_T lnum;
10447 lnum = get_tv_lnum(argvars);
10448 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10449 rettv->vval.v_number = foldLevel(lnum);
10450 #endif
10454 * "foldtext()" function
10456 static void
10457 f_foldtext(argvars, rettv)
10458 typval_T *argvars UNUSED;
10459 typval_T *rettv;
10461 #ifdef FEAT_FOLDING
10462 linenr_T lnum;
10463 char_u *s;
10464 char_u *r;
10465 int len;
10466 char *txt;
10467 #endif
10469 rettv->v_type = VAR_STRING;
10470 rettv->vval.v_string = NULL;
10471 #ifdef FEAT_FOLDING
10472 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10473 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10474 <= curbuf->b_ml.ml_line_count
10475 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10477 /* Find first non-empty line in the fold. */
10478 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10479 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10481 if (!linewhite(lnum))
10482 break;
10483 ++lnum;
10486 /* Find interesting text in this line. */
10487 s = skipwhite(ml_get(lnum));
10488 /* skip C comment-start */
10489 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10491 s = skipwhite(s + 2);
10492 if (*skipwhite(s) == NUL
10493 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10495 s = skipwhite(ml_get(lnum + 1));
10496 if (*s == '*')
10497 s = skipwhite(s + 1);
10500 txt = _("+-%s%3ld lines: ");
10501 r = alloc((unsigned)(STRLEN(txt)
10502 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10503 + 20 /* for %3ld */
10504 + STRLEN(s))); /* concatenated */
10505 if (r != NULL)
10507 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10508 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10509 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10510 len = (int)STRLEN(r);
10511 STRCAT(r, s);
10512 /* remove 'foldmarker' and 'commentstring' */
10513 foldtext_cleanup(r + len);
10514 rettv->vval.v_string = r;
10517 #endif
10521 * "foldtextresult(lnum)" function
10523 static void
10524 f_foldtextresult(argvars, rettv)
10525 typval_T *argvars UNUSED;
10526 typval_T *rettv;
10528 #ifdef FEAT_FOLDING
10529 linenr_T lnum;
10530 char_u *text;
10531 char_u buf[51];
10532 foldinfo_T foldinfo;
10533 int fold_count;
10534 #endif
10536 rettv->v_type = VAR_STRING;
10537 rettv->vval.v_string = NULL;
10538 #ifdef FEAT_FOLDING
10539 lnum = get_tv_lnum(argvars);
10540 /* treat illegal types and illegal string values for {lnum} the same */
10541 if (lnum < 0)
10542 lnum = 0;
10543 fold_count = foldedCount(curwin, lnum, &foldinfo);
10544 if (fold_count > 0)
10546 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10547 &foldinfo, buf);
10548 if (text == buf)
10549 text = vim_strsave(text);
10550 rettv->vval.v_string = text;
10552 #endif
10556 * "foreground()" function
10558 static void
10559 f_foreground(argvars, rettv)
10560 typval_T *argvars UNUSED;
10561 typval_T *rettv UNUSED;
10563 #ifdef FEAT_GUI
10564 if (gui.in_use)
10565 gui_mch_set_foreground();
10566 #else
10567 # ifdef WIN32
10568 win32_set_foreground();
10569 # endif
10570 #endif
10574 * "function()" function
10576 static void
10577 f_function(argvars, rettv)
10578 typval_T *argvars;
10579 typval_T *rettv;
10581 char_u *s;
10583 s = get_tv_string(&argvars[0]);
10584 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10585 EMSG2(_(e_invarg2), s);
10586 /* Don't check an autoload name for existence here. */
10587 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10588 EMSG2(_("E700: Unknown function: %s"), s);
10589 else
10591 rettv->vval.v_string = vim_strsave(s);
10592 rettv->v_type = VAR_FUNC;
10597 * "garbagecollect()" function
10599 static void
10600 f_garbagecollect(argvars, rettv)
10601 typval_T *argvars;
10602 typval_T *rettv UNUSED;
10604 /* This is postponed until we are back at the toplevel, because we may be
10605 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10606 want_garbage_collect = TRUE;
10608 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10609 garbage_collect_at_exit = TRUE;
10613 * "get()" function
10615 static void
10616 f_get(argvars, rettv)
10617 typval_T *argvars;
10618 typval_T *rettv;
10620 listitem_T *li;
10621 list_T *l;
10622 dictitem_T *di;
10623 dict_T *d;
10624 typval_T *tv = NULL;
10626 if (argvars[0].v_type == VAR_LIST)
10628 if ((l = argvars[0].vval.v_list) != NULL)
10630 int error = FALSE;
10632 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10633 if (!error && li != NULL)
10634 tv = &li->li_tv;
10637 else if (argvars[0].v_type == VAR_DICT)
10639 if ((d = argvars[0].vval.v_dict) != NULL)
10641 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10642 if (di != NULL)
10643 tv = &di->di_tv;
10646 else
10647 EMSG2(_(e_listdictarg), "get()");
10649 if (tv == NULL)
10651 if (argvars[2].v_type != VAR_UNKNOWN)
10652 copy_tv(&argvars[2], rettv);
10654 else
10655 copy_tv(tv, rettv);
10658 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10661 * Get line or list of lines from buffer "buf" into "rettv".
10662 * Return a range (from start to end) of lines in rettv from the specified
10663 * buffer.
10664 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10666 static void
10667 get_buffer_lines(buf, start, end, retlist, rettv)
10668 buf_T *buf;
10669 linenr_T start;
10670 linenr_T end;
10671 int retlist;
10672 typval_T *rettv;
10674 char_u *p;
10676 if (retlist && rettv_list_alloc(rettv) == FAIL)
10677 return;
10679 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10680 return;
10682 if (!retlist)
10684 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10685 p = ml_get_buf(buf, start, FALSE);
10686 else
10687 p = (char_u *)"";
10689 rettv->v_type = VAR_STRING;
10690 rettv->vval.v_string = vim_strsave(p);
10692 else
10694 if (end < start)
10695 return;
10697 if (start < 1)
10698 start = 1;
10699 if (end > buf->b_ml.ml_line_count)
10700 end = buf->b_ml.ml_line_count;
10701 while (start <= end)
10702 if (list_append_string(rettv->vval.v_list,
10703 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10704 break;
10709 * "getbufline()" function
10711 static void
10712 f_getbufline(argvars, rettv)
10713 typval_T *argvars;
10714 typval_T *rettv;
10716 linenr_T lnum;
10717 linenr_T end;
10718 buf_T *buf;
10720 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10721 ++emsg_off;
10722 buf = get_buf_tv(&argvars[0]);
10723 --emsg_off;
10725 lnum = get_tv_lnum_buf(&argvars[1], buf);
10726 if (argvars[2].v_type == VAR_UNKNOWN)
10727 end = lnum;
10728 else
10729 end = get_tv_lnum_buf(&argvars[2], buf);
10731 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10735 * "getbufvar()" function
10737 static void
10738 f_getbufvar(argvars, rettv)
10739 typval_T *argvars;
10740 typval_T *rettv;
10742 buf_T *buf;
10743 buf_T *save_curbuf;
10744 char_u *varname;
10745 dictitem_T *v;
10747 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10748 varname = get_tv_string_chk(&argvars[1]);
10749 ++emsg_off;
10750 buf = get_buf_tv(&argvars[0]);
10752 rettv->v_type = VAR_STRING;
10753 rettv->vval.v_string = NULL;
10755 if (buf != NULL && varname != NULL)
10757 /* set curbuf to be our buf, temporarily */
10758 save_curbuf = curbuf;
10759 curbuf = buf;
10761 if (*varname == '&') /* buffer-local-option */
10762 get_option_tv(&varname, rettv, TRUE);
10763 else
10765 if (*varname == NUL)
10766 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10767 * scope prefix before the NUL byte is required by
10768 * find_var_in_ht(). */
10769 varname = (char_u *)"b:" + 2;
10770 /* look up the variable */
10771 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10772 if (v != NULL)
10773 copy_tv(&v->di_tv, rettv);
10776 /* restore previous notion of curbuf */
10777 curbuf = save_curbuf;
10780 --emsg_off;
10784 * "getchar()" function
10786 static void
10787 f_getchar(argvars, rettv)
10788 typval_T *argvars;
10789 typval_T *rettv;
10791 varnumber_T n;
10792 int error = FALSE;
10794 /* Position the cursor. Needed after a message that ends in a space. */
10795 windgoto(msg_row, msg_col);
10797 ++no_mapping;
10798 ++allow_keys;
10799 for (;;)
10801 if (argvars[0].v_type == VAR_UNKNOWN)
10802 /* getchar(): blocking wait. */
10803 n = safe_vgetc();
10804 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10805 /* getchar(1): only check if char avail */
10806 n = vpeekc();
10807 else if (error || vpeekc() == NUL)
10808 /* illegal argument or getchar(0) and no char avail: return zero */
10809 n = 0;
10810 else
10811 /* getchar(0) and char avail: return char */
10812 n = safe_vgetc();
10813 if (n == K_IGNORE)
10814 continue;
10815 break;
10817 --no_mapping;
10818 --allow_keys;
10820 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10821 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10822 vimvars[VV_MOUSE_COL].vv_nr = 0;
10824 rettv->vval.v_number = n;
10825 if (IS_SPECIAL(n) || mod_mask != 0)
10827 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10828 int i = 0;
10830 /* Turn a special key into three bytes, plus modifier. */
10831 if (mod_mask != 0)
10833 temp[i++] = K_SPECIAL;
10834 temp[i++] = KS_MODIFIER;
10835 temp[i++] = mod_mask;
10837 if (IS_SPECIAL(n))
10839 temp[i++] = K_SPECIAL;
10840 temp[i++] = K_SECOND(n);
10841 temp[i++] = K_THIRD(n);
10843 #ifdef FEAT_MBYTE
10844 else if (has_mbyte)
10845 i += (*mb_char2bytes)(n, temp + i);
10846 #endif
10847 else
10848 temp[i++] = n;
10849 temp[i++] = NUL;
10850 rettv->v_type = VAR_STRING;
10851 rettv->vval.v_string = vim_strsave(temp);
10853 #ifdef FEAT_MOUSE
10854 if (n == K_LEFTMOUSE
10855 || n == K_LEFTMOUSE_NM
10856 || n == K_LEFTDRAG
10857 || n == K_LEFTRELEASE
10858 || n == K_LEFTRELEASE_NM
10859 || n == K_MIDDLEMOUSE
10860 || n == K_MIDDLEDRAG
10861 || n == K_MIDDLERELEASE
10862 || n == K_RIGHTMOUSE
10863 || n == K_RIGHTDRAG
10864 || n == K_RIGHTRELEASE
10865 || n == K_X1MOUSE
10866 || n == K_X1DRAG
10867 || n == K_X1RELEASE
10868 || n == K_X2MOUSE
10869 || n == K_X2DRAG
10870 || n == K_X2RELEASE
10871 || n == K_MOUSEDOWN
10872 || n == K_MOUSEUP)
10874 int row = mouse_row;
10875 int col = mouse_col;
10876 win_T *win;
10877 linenr_T lnum;
10878 # ifdef FEAT_WINDOWS
10879 win_T *wp;
10880 # endif
10881 int winnr = 1;
10883 if (row >= 0 && col >= 0)
10885 /* Find the window at the mouse coordinates and compute the
10886 * text position. */
10887 win = mouse_find_win(&row, &col);
10888 (void)mouse_comp_pos(win, &row, &col, &lnum);
10889 # ifdef FEAT_WINDOWS
10890 for (wp = firstwin; wp != win; wp = wp->w_next)
10891 ++winnr;
10892 # endif
10893 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10894 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10895 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10898 #endif
10903 * "getcharmod()" function
10905 static void
10906 f_getcharmod(argvars, rettv)
10907 typval_T *argvars UNUSED;
10908 typval_T *rettv;
10910 rettv->vval.v_number = mod_mask;
10914 * "getcmdline()" function
10916 static void
10917 f_getcmdline(argvars, rettv)
10918 typval_T *argvars UNUSED;
10919 typval_T *rettv;
10921 rettv->v_type = VAR_STRING;
10922 rettv->vval.v_string = get_cmdline_str();
10926 * "getcmdpos()" function
10928 static void
10929 f_getcmdpos(argvars, rettv)
10930 typval_T *argvars UNUSED;
10931 typval_T *rettv;
10933 rettv->vval.v_number = get_cmdline_pos() + 1;
10937 * "getcmdtype()" function
10939 static void
10940 f_getcmdtype(argvars, rettv)
10941 typval_T *argvars UNUSED;
10942 typval_T *rettv;
10944 rettv->v_type = VAR_STRING;
10945 rettv->vval.v_string = alloc(2);
10946 if (rettv->vval.v_string != NULL)
10948 rettv->vval.v_string[0] = get_cmdline_type();
10949 rettv->vval.v_string[1] = NUL;
10954 * "getcwd()" function
10956 static void
10957 f_getcwd(argvars, rettv)
10958 typval_T *argvars UNUSED;
10959 typval_T *rettv;
10961 char_u cwd[MAXPATHL];
10963 rettv->v_type = VAR_STRING;
10964 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10965 rettv->vval.v_string = NULL;
10966 else
10968 rettv->vval.v_string = vim_strsave(cwd);
10969 #ifdef BACKSLASH_IN_FILENAME
10970 if (rettv->vval.v_string != NULL)
10971 slash_adjust(rettv->vval.v_string);
10972 #endif
10977 * "getfontname()" function
10979 static void
10980 f_getfontname(argvars, rettv)
10981 typval_T *argvars UNUSED;
10982 typval_T *rettv;
10984 rettv->v_type = VAR_STRING;
10985 rettv->vval.v_string = NULL;
10986 #ifdef FEAT_GUI
10987 if (gui.in_use)
10989 GuiFont font;
10990 char_u *name = NULL;
10992 if (argvars[0].v_type == VAR_UNKNOWN)
10994 /* Get the "Normal" font. Either the name saved by
10995 * hl_set_font_name() or from the font ID. */
10996 font = gui.norm_font;
10997 name = hl_get_font_name();
10999 else
11001 name = get_tv_string(&argvars[0]);
11002 if (STRCMP(name, "*") == 0) /* don't use font dialog */
11003 return;
11004 font = gui_mch_get_font(name, FALSE);
11005 if (font == NOFONT)
11006 return; /* Invalid font name, return empty string. */
11008 rettv->vval.v_string = gui_mch_get_fontname(font, name);
11009 if (argvars[0].v_type != VAR_UNKNOWN)
11010 gui_mch_free_font(font);
11012 #endif
11016 * "getfperm({fname})" function
11018 static void
11019 f_getfperm(argvars, rettv)
11020 typval_T *argvars;
11021 typval_T *rettv;
11023 char_u *fname;
11024 struct stat st;
11025 char_u *perm = NULL;
11026 char_u flags[] = "rwx";
11027 int i;
11029 fname = get_tv_string(&argvars[0]);
11031 rettv->v_type = VAR_STRING;
11032 if (mch_stat((char *)fname, &st) >= 0)
11034 perm = vim_strsave((char_u *)"---------");
11035 if (perm != NULL)
11037 for (i = 0; i < 9; i++)
11039 if (st.st_mode & (1 << (8 - i)))
11040 perm[i] = flags[i % 3];
11044 rettv->vval.v_string = perm;
11048 * "getfsize({fname})" function
11050 static void
11051 f_getfsize(argvars, rettv)
11052 typval_T *argvars;
11053 typval_T *rettv;
11055 char_u *fname;
11056 struct stat st;
11058 fname = get_tv_string(&argvars[0]);
11060 rettv->v_type = VAR_NUMBER;
11062 if (mch_stat((char *)fname, &st) >= 0)
11064 if (mch_isdir(fname))
11065 rettv->vval.v_number = 0;
11066 else
11068 rettv->vval.v_number = (varnumber_T)st.st_size;
11070 /* non-perfect check for overflow */
11071 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
11072 rettv->vval.v_number = -2;
11075 else
11076 rettv->vval.v_number = -1;
11080 * "getftime({fname})" function
11082 static void
11083 f_getftime(argvars, rettv)
11084 typval_T *argvars;
11085 typval_T *rettv;
11087 char_u *fname;
11088 struct stat st;
11090 fname = get_tv_string(&argvars[0]);
11092 if (mch_stat((char *)fname, &st) >= 0)
11093 rettv->vval.v_number = (varnumber_T)st.st_mtime;
11094 else
11095 rettv->vval.v_number = -1;
11099 * "getftype({fname})" function
11101 static void
11102 f_getftype(argvars, rettv)
11103 typval_T *argvars;
11104 typval_T *rettv;
11106 char_u *fname;
11107 struct stat st;
11108 char_u *type = NULL;
11109 char *t;
11111 fname = get_tv_string(&argvars[0]);
11113 rettv->v_type = VAR_STRING;
11114 if (mch_lstat((char *)fname, &st) >= 0)
11116 #ifdef S_ISREG
11117 if (S_ISREG(st.st_mode))
11118 t = "file";
11119 else if (S_ISDIR(st.st_mode))
11120 t = "dir";
11121 # ifdef S_ISLNK
11122 else if (S_ISLNK(st.st_mode))
11123 t = "link";
11124 # endif
11125 # ifdef S_ISBLK
11126 else if (S_ISBLK(st.st_mode))
11127 t = "bdev";
11128 # endif
11129 # ifdef S_ISCHR
11130 else if (S_ISCHR(st.st_mode))
11131 t = "cdev";
11132 # endif
11133 # ifdef S_ISFIFO
11134 else if (S_ISFIFO(st.st_mode))
11135 t = "fifo";
11136 # endif
11137 # ifdef S_ISSOCK
11138 else if (S_ISSOCK(st.st_mode))
11139 t = "fifo";
11140 # endif
11141 else
11142 t = "other";
11143 #else
11144 # ifdef S_IFMT
11145 switch (st.st_mode & S_IFMT)
11147 case S_IFREG: t = "file"; break;
11148 case S_IFDIR: t = "dir"; break;
11149 # ifdef S_IFLNK
11150 case S_IFLNK: t = "link"; break;
11151 # endif
11152 # ifdef S_IFBLK
11153 case S_IFBLK: t = "bdev"; break;
11154 # endif
11155 # ifdef S_IFCHR
11156 case S_IFCHR: t = "cdev"; break;
11157 # endif
11158 # ifdef S_IFIFO
11159 case S_IFIFO: t = "fifo"; break;
11160 # endif
11161 # ifdef S_IFSOCK
11162 case S_IFSOCK: t = "socket"; break;
11163 # endif
11164 default: t = "other";
11166 # else
11167 if (mch_isdir(fname))
11168 t = "dir";
11169 else
11170 t = "file";
11171 # endif
11172 #endif
11173 type = vim_strsave((char_u *)t);
11175 rettv->vval.v_string = type;
11179 * "getline(lnum, [end])" function
11181 static void
11182 f_getline(argvars, rettv)
11183 typval_T *argvars;
11184 typval_T *rettv;
11186 linenr_T lnum;
11187 linenr_T end;
11188 int retlist;
11190 lnum = get_tv_lnum(argvars);
11191 if (argvars[1].v_type == VAR_UNKNOWN)
11193 end = 0;
11194 retlist = FALSE;
11196 else
11198 end = get_tv_lnum(&argvars[1]);
11199 retlist = TRUE;
11202 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11206 * "getmatches()" function
11208 static void
11209 f_getmatches(argvars, rettv)
11210 typval_T *argvars UNUSED;
11211 typval_T *rettv;
11213 #ifdef FEAT_SEARCH_EXTRA
11214 dict_T *dict;
11215 matchitem_T *cur = curwin->w_match_head;
11217 if (rettv_list_alloc(rettv) == OK)
11219 while (cur != NULL)
11221 dict = dict_alloc();
11222 if (dict == NULL)
11223 return;
11224 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11225 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11226 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11227 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11228 list_append_dict(rettv->vval.v_list, dict);
11229 cur = cur->next;
11232 #endif
11236 * "getpid()" function
11238 static void
11239 f_getpid(argvars, rettv)
11240 typval_T *argvars UNUSED;
11241 typval_T *rettv;
11243 rettv->vval.v_number = mch_get_pid();
11247 * "getpos(string)" function
11249 static void
11250 f_getpos(argvars, rettv)
11251 typval_T *argvars;
11252 typval_T *rettv;
11254 pos_T *fp;
11255 list_T *l;
11256 int fnum = -1;
11258 if (rettv_list_alloc(rettv) == OK)
11260 l = rettv->vval.v_list;
11261 fp = var2fpos(&argvars[0], TRUE, &fnum);
11262 if (fnum != -1)
11263 list_append_number(l, (varnumber_T)fnum);
11264 else
11265 list_append_number(l, (varnumber_T)0);
11266 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11267 : (varnumber_T)0);
11268 list_append_number(l, (fp != NULL)
11269 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11270 : (varnumber_T)0);
11271 list_append_number(l,
11272 #ifdef FEAT_VIRTUALEDIT
11273 (fp != NULL) ? (varnumber_T)fp->coladd :
11274 #endif
11275 (varnumber_T)0);
11277 else
11278 rettv->vval.v_number = FALSE;
11282 * "getqflist()" and "getloclist()" functions
11284 static void
11285 f_getqflist(argvars, rettv)
11286 typval_T *argvars UNUSED;
11287 typval_T *rettv UNUSED;
11289 #ifdef FEAT_QUICKFIX
11290 win_T *wp;
11291 #endif
11293 #ifdef FEAT_QUICKFIX
11294 if (rettv_list_alloc(rettv) == OK)
11296 wp = NULL;
11297 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11299 wp = find_win_by_nr(&argvars[0], NULL);
11300 if (wp == NULL)
11301 return;
11304 (void)get_errorlist(wp, rettv->vval.v_list);
11306 #endif
11310 * "getreg()" function
11312 static void
11313 f_getreg(argvars, rettv)
11314 typval_T *argvars;
11315 typval_T *rettv;
11317 char_u *strregname;
11318 int regname;
11319 int arg2 = FALSE;
11320 int error = FALSE;
11322 if (argvars[0].v_type != VAR_UNKNOWN)
11324 strregname = get_tv_string_chk(&argvars[0]);
11325 error = strregname == NULL;
11326 if (argvars[1].v_type != VAR_UNKNOWN)
11327 arg2 = get_tv_number_chk(&argvars[1], &error);
11329 else
11330 strregname = vimvars[VV_REG].vv_str;
11331 regname = (strregname == NULL ? '"' : *strregname);
11332 if (regname == 0)
11333 regname = '"';
11335 rettv->v_type = VAR_STRING;
11336 rettv->vval.v_string = error ? NULL :
11337 get_reg_contents(regname, TRUE, arg2);
11341 * "getregtype()" function
11343 static void
11344 f_getregtype(argvars, rettv)
11345 typval_T *argvars;
11346 typval_T *rettv;
11348 char_u *strregname;
11349 int regname;
11350 char_u buf[NUMBUFLEN + 2];
11351 long reglen = 0;
11353 if (argvars[0].v_type != VAR_UNKNOWN)
11355 strregname = get_tv_string_chk(&argvars[0]);
11356 if (strregname == NULL) /* type error; errmsg already given */
11358 rettv->v_type = VAR_STRING;
11359 rettv->vval.v_string = NULL;
11360 return;
11363 else
11364 /* Default to v:register */
11365 strregname = vimvars[VV_REG].vv_str;
11367 regname = (strregname == NULL ? '"' : *strregname);
11368 if (regname == 0)
11369 regname = '"';
11371 buf[0] = NUL;
11372 buf[1] = NUL;
11373 switch (get_reg_type(regname, &reglen))
11375 case MLINE: buf[0] = 'V'; break;
11376 case MCHAR: buf[0] = 'v'; break;
11377 #ifdef FEAT_VISUAL
11378 case MBLOCK:
11379 buf[0] = Ctrl_V;
11380 sprintf((char *)buf + 1, "%ld", reglen + 1);
11381 break;
11382 #endif
11384 rettv->v_type = VAR_STRING;
11385 rettv->vval.v_string = vim_strsave(buf);
11389 * "gettabwinvar()" function
11391 static void
11392 f_gettabwinvar(argvars, rettv)
11393 typval_T *argvars;
11394 typval_T *rettv;
11396 getwinvar(argvars, rettv, 1);
11400 * "getwinposx()" function
11402 static void
11403 f_getwinposx(argvars, rettv)
11404 typval_T *argvars UNUSED;
11405 typval_T *rettv;
11407 rettv->vval.v_number = -1;
11408 #ifdef FEAT_GUI
11409 if (gui.in_use)
11411 int x, y;
11413 if (gui_mch_get_winpos(&x, &y) == OK)
11414 rettv->vval.v_number = x;
11416 #endif
11420 * "getwinposy()" function
11422 static void
11423 f_getwinposy(argvars, rettv)
11424 typval_T *argvars UNUSED;
11425 typval_T *rettv;
11427 rettv->vval.v_number = -1;
11428 #ifdef FEAT_GUI
11429 if (gui.in_use)
11431 int x, y;
11433 if (gui_mch_get_winpos(&x, &y) == OK)
11434 rettv->vval.v_number = y;
11436 #endif
11440 * Find window specified by "vp" in tabpage "tp".
11442 static win_T *
11443 find_win_by_nr(vp, tp)
11444 typval_T *vp;
11445 tabpage_T *tp; /* NULL for current tab page */
11447 #ifdef FEAT_WINDOWS
11448 win_T *wp;
11449 #endif
11450 int nr;
11452 nr = get_tv_number_chk(vp, NULL);
11454 #ifdef FEAT_WINDOWS
11455 if (nr < 0)
11456 return NULL;
11457 if (nr == 0)
11458 return curwin;
11460 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11461 wp != NULL; wp = wp->w_next)
11462 if (--nr <= 0)
11463 break;
11464 return wp;
11465 #else
11466 if (nr == 0 || nr == 1)
11467 return curwin;
11468 return NULL;
11469 #endif
11473 * "getwinvar()" function
11475 static void
11476 f_getwinvar(argvars, rettv)
11477 typval_T *argvars;
11478 typval_T *rettv;
11480 getwinvar(argvars, rettv, 0);
11484 * getwinvar() and gettabwinvar()
11486 static void
11487 getwinvar(argvars, rettv, off)
11488 typval_T *argvars;
11489 typval_T *rettv;
11490 int off; /* 1 for gettabwinvar() */
11492 win_T *win, *oldcurwin;
11493 char_u *varname;
11494 dictitem_T *v;
11495 tabpage_T *tp;
11497 #ifdef FEAT_WINDOWS
11498 if (off == 1)
11499 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11500 else
11501 tp = curtab;
11502 #endif
11503 win = find_win_by_nr(&argvars[off], tp);
11504 varname = get_tv_string_chk(&argvars[off + 1]);
11505 ++emsg_off;
11507 rettv->v_type = VAR_STRING;
11508 rettv->vval.v_string = NULL;
11510 if (win != NULL && varname != NULL)
11512 /* Set curwin to be our win, temporarily. Also set curbuf, so
11513 * that we can get buffer-local options. */
11514 oldcurwin = curwin;
11515 curwin = win;
11516 curbuf = win->w_buffer;
11518 if (*varname == '&') /* window-local-option */
11519 get_option_tv(&varname, rettv, 1);
11520 else
11522 if (*varname == NUL)
11523 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11524 * scope prefix before the NUL byte is required by
11525 * find_var_in_ht(). */
11526 varname = (char_u *)"w:" + 2;
11527 /* look up the variable */
11528 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11529 if (v != NULL)
11530 copy_tv(&v->di_tv, rettv);
11533 /* restore previous notion of curwin */
11534 curwin = oldcurwin;
11535 curbuf = curwin->w_buffer;
11538 --emsg_off;
11542 * "glob()" function
11544 static void
11545 f_glob(argvars, rettv)
11546 typval_T *argvars;
11547 typval_T *rettv;
11549 int flags = WILD_SILENT|WILD_USE_NL;
11550 expand_T xpc;
11551 int error = FALSE;
11553 /* When the optional second argument is non-zero, don't remove matches
11554 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11555 if (argvars[1].v_type != VAR_UNKNOWN
11556 && get_tv_number_chk(&argvars[1], &error))
11557 flags |= WILD_KEEP_ALL;
11558 rettv->v_type = VAR_STRING;
11559 if (!error)
11561 ExpandInit(&xpc);
11562 xpc.xp_context = EXPAND_FILES;
11563 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11564 NULL, flags, WILD_ALL);
11566 else
11567 rettv->vval.v_string = NULL;
11571 * "globpath()" function
11573 static void
11574 f_globpath(argvars, rettv)
11575 typval_T *argvars;
11576 typval_T *rettv;
11578 int flags = 0;
11579 char_u buf1[NUMBUFLEN];
11580 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11581 int error = FALSE;
11583 /* When the optional second argument is non-zero, don't remove matches
11584 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11585 if (argvars[2].v_type != VAR_UNKNOWN
11586 && get_tv_number_chk(&argvars[2], &error))
11587 flags |= WILD_KEEP_ALL;
11588 rettv->v_type = VAR_STRING;
11589 if (file == NULL || error)
11590 rettv->vval.v_string = NULL;
11591 else
11592 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11593 flags);
11597 * "has()" function
11599 static void
11600 f_has(argvars, rettv)
11601 typval_T *argvars;
11602 typval_T *rettv;
11604 int i;
11605 char_u *name;
11606 int n = FALSE;
11607 static char *(has_list[]) =
11609 #ifdef AMIGA
11610 "amiga",
11611 # ifdef FEAT_ARP
11612 "arp",
11613 # endif
11614 #endif
11615 #ifdef __BEOS__
11616 "beos",
11617 #endif
11618 #ifdef MSDOS
11619 # ifdef DJGPP
11620 "dos32",
11621 # else
11622 "dos16",
11623 # endif
11624 #endif
11625 #ifdef MACOS
11626 "mac",
11627 #endif
11628 #if defined(MACOS_X_UNIX)
11629 "macunix",
11630 #endif
11631 #ifdef OS2
11632 "os2",
11633 #endif
11634 #ifdef __QNX__
11635 "qnx",
11636 #endif
11637 #ifdef RISCOS
11638 "riscos",
11639 #endif
11640 #ifdef UNIX
11641 "unix",
11642 #endif
11643 #ifdef VMS
11644 "vms",
11645 #endif
11646 #ifdef WIN16
11647 "win16",
11648 #endif
11649 #ifdef WIN32
11650 "win32",
11651 #endif
11652 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11653 "win32unix",
11654 #endif
11655 #ifdef WIN64
11656 "win64",
11657 #endif
11658 #ifdef EBCDIC
11659 "ebcdic",
11660 #endif
11661 #ifndef CASE_INSENSITIVE_FILENAME
11662 "fname_case",
11663 #endif
11664 #ifdef FEAT_ARABIC
11665 "arabic",
11666 #endif
11667 #ifdef FEAT_AUTOCMD
11668 "autocmd",
11669 #endif
11670 #ifdef FEAT_BEVAL
11671 "balloon_eval",
11672 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11673 "balloon_multiline",
11674 # endif
11675 #endif
11676 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11677 "builtin_terms",
11678 # ifdef ALL_BUILTIN_TCAPS
11679 "all_builtin_terms",
11680 # endif
11681 #endif
11682 #ifdef FEAT_BYTEOFF
11683 "byte_offset",
11684 #endif
11685 #ifdef FEAT_CINDENT
11686 "cindent",
11687 #endif
11688 #ifdef FEAT_CLIENTSERVER
11689 "clientserver",
11690 #endif
11691 #ifdef FEAT_CLIPBOARD
11692 "clipboard",
11693 #endif
11694 #ifdef FEAT_CMDL_COMPL
11695 "cmdline_compl",
11696 #endif
11697 #ifdef FEAT_CMDHIST
11698 "cmdline_hist",
11699 #endif
11700 #ifdef FEAT_COMMENTS
11701 "comments",
11702 #endif
11703 #ifdef FEAT_CRYPT
11704 "cryptv",
11705 #endif
11706 #ifdef FEAT_CSCOPE
11707 "cscope",
11708 #endif
11709 #ifdef CURSOR_SHAPE
11710 "cursorshape",
11711 #endif
11712 #ifdef DEBUG
11713 "debug",
11714 #endif
11715 #ifdef FEAT_CON_DIALOG
11716 "dialog_con",
11717 #endif
11718 #ifdef FEAT_GUI_DIALOG
11719 "dialog_gui",
11720 #endif
11721 #ifdef FEAT_DIFF
11722 "diff",
11723 #endif
11724 #ifdef FEAT_DIGRAPHS
11725 "digraphs",
11726 #endif
11727 #ifdef FEAT_DND
11728 "dnd",
11729 #endif
11730 #ifdef FEAT_EMACS_TAGS
11731 "emacs_tags",
11732 #endif
11733 "eval", /* always present, of course! */
11734 #ifdef FEAT_EX_EXTRA
11735 "ex_extra",
11736 #endif
11737 #ifdef FEAT_SEARCH_EXTRA
11738 "extra_search",
11739 #endif
11740 #ifdef FEAT_FKMAP
11741 "farsi",
11742 #endif
11743 #ifdef FEAT_SEARCHPATH
11744 "file_in_path",
11745 #endif
11746 #if defined(UNIX) && !defined(USE_SYSTEM)
11747 "filterpipe",
11748 #endif
11749 #ifdef FEAT_FIND_ID
11750 "find_in_path",
11751 #endif
11752 #ifdef FEAT_FLOAT
11753 "float",
11754 #endif
11755 #ifdef FEAT_FOLDING
11756 "folding",
11757 #endif
11758 #ifdef FEAT_FOOTER
11759 "footer",
11760 #endif
11761 #if !defined(USE_SYSTEM) && defined(UNIX)
11762 "fork",
11763 #endif
11764 #ifdef FEAT_GETTEXT
11765 "gettext",
11766 #endif
11767 #ifdef FEAT_GUI
11768 "gui",
11769 #endif
11770 #ifdef FEAT_GUI_ATHENA
11771 # ifdef FEAT_GUI_NEXTAW
11772 "gui_neXtaw",
11773 # else
11774 "gui_athena",
11775 # endif
11776 #endif
11777 #ifdef FEAT_GUI_GTK
11778 "gui_gtk",
11779 # ifdef HAVE_GTK2
11780 "gui_gtk2",
11781 # endif
11782 #endif
11783 #ifdef FEAT_GUI_GNOME
11784 "gui_gnome",
11785 #endif
11786 #ifdef FEAT_GUI_MAC
11787 "gui_mac",
11788 #endif
11789 #ifdef FEAT_GUI_MOTIF
11790 "gui_motif",
11791 #endif
11792 #ifdef FEAT_GUI_PHOTON
11793 "gui_photon",
11794 #endif
11795 #ifdef FEAT_GUI_W16
11796 "gui_win16",
11797 #endif
11798 #ifdef FEAT_GUI_W32
11799 "gui_win32",
11800 #endif
11801 #ifdef FEAT_HANGULIN
11802 "hangul_input",
11803 #endif
11804 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11805 "iconv",
11806 #endif
11807 #ifdef FEAT_INS_EXPAND
11808 "insert_expand",
11809 #endif
11810 #ifdef FEAT_JUMPLIST
11811 "jumplist",
11812 #endif
11813 #ifdef FEAT_KEYMAP
11814 "keymap",
11815 #endif
11816 #ifdef FEAT_LANGMAP
11817 "langmap",
11818 #endif
11819 #ifdef FEAT_LIBCALL
11820 "libcall",
11821 #endif
11822 #ifdef FEAT_LINEBREAK
11823 "linebreak",
11824 #endif
11825 #ifdef FEAT_LISP
11826 "lispindent",
11827 #endif
11828 #ifdef FEAT_LISTCMDS
11829 "listcmds",
11830 #endif
11831 #ifdef FEAT_LOCALMAP
11832 "localmap",
11833 #endif
11834 #ifdef FEAT_MENU
11835 "menu",
11836 #endif
11837 #ifdef FEAT_SESSION
11838 "mksession",
11839 #endif
11840 #ifdef FEAT_MODIFY_FNAME
11841 "modify_fname",
11842 #endif
11843 #ifdef FEAT_MOUSE
11844 "mouse",
11845 #endif
11846 #ifdef FEAT_MOUSESHAPE
11847 "mouseshape",
11848 #endif
11849 #if defined(UNIX) || defined(VMS)
11850 # ifdef FEAT_MOUSE_DEC
11851 "mouse_dec",
11852 # endif
11853 # ifdef FEAT_MOUSE_GPM
11854 "mouse_gpm",
11855 # endif
11856 # ifdef FEAT_MOUSE_JSB
11857 "mouse_jsbterm",
11858 # endif
11859 # ifdef FEAT_MOUSE_NET
11860 "mouse_netterm",
11861 # endif
11862 # ifdef FEAT_MOUSE_PTERM
11863 "mouse_pterm",
11864 # endif
11865 # ifdef FEAT_SYSMOUSE
11866 "mouse_sysmouse",
11867 # endif
11868 # ifdef FEAT_MOUSE_XTERM
11869 "mouse_xterm",
11870 # endif
11871 #endif
11872 #ifdef FEAT_MBYTE
11873 "multi_byte",
11874 #endif
11875 #ifdef FEAT_MBYTE_IME
11876 "multi_byte_ime",
11877 #endif
11878 #ifdef FEAT_MULTI_LANG
11879 "multi_lang",
11880 #endif
11881 #ifdef FEAT_MZSCHEME
11882 #ifndef DYNAMIC_MZSCHEME
11883 "mzscheme",
11884 #endif
11885 #endif
11886 #ifdef FEAT_OLE
11887 "ole",
11888 #endif
11889 #ifdef FEAT_OSFILETYPE
11890 "osfiletype",
11891 #endif
11892 #ifdef FEAT_PATH_EXTRA
11893 "path_extra",
11894 #endif
11895 #ifdef FEAT_PERL
11896 #ifndef DYNAMIC_PERL
11897 "perl",
11898 #endif
11899 #endif
11900 #ifdef FEAT_PYTHON
11901 #ifndef DYNAMIC_PYTHON
11902 "python",
11903 #endif
11904 #endif
11905 #ifdef FEAT_POSTSCRIPT
11906 "postscript",
11907 #endif
11908 #ifdef FEAT_PRINTER
11909 "printer",
11910 #endif
11911 #ifdef FEAT_PROFILE
11912 "profile",
11913 #endif
11914 #ifdef FEAT_RELTIME
11915 "reltime",
11916 #endif
11917 #ifdef FEAT_QUICKFIX
11918 "quickfix",
11919 #endif
11920 #ifdef FEAT_RIGHTLEFT
11921 "rightleft",
11922 #endif
11923 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11924 "ruby",
11925 #endif
11926 #ifdef FEAT_SCROLLBIND
11927 "scrollbind",
11928 #endif
11929 #ifdef FEAT_CMDL_INFO
11930 "showcmd",
11931 "cmdline_info",
11932 #endif
11933 #ifdef FEAT_SIGNS
11934 "signs",
11935 #endif
11936 #ifdef FEAT_SMARTINDENT
11937 "smartindent",
11938 #endif
11939 #ifdef FEAT_SNIFF
11940 "sniff",
11941 #endif
11942 #ifdef FEAT_STL_OPT
11943 "statusline",
11944 #endif
11945 #ifdef FEAT_SUN_WORKSHOP
11946 "sun_workshop",
11947 #endif
11948 #ifdef FEAT_NETBEANS_INTG
11949 "netbeans_intg",
11950 #endif
11951 #ifdef FEAT_SPELL
11952 "spell",
11953 #endif
11954 #ifdef FEAT_SYN_HL
11955 "syntax",
11956 #endif
11957 #if defined(USE_SYSTEM) || !defined(UNIX)
11958 "system",
11959 #endif
11960 #ifdef FEAT_TAG_BINS
11961 "tag_binary",
11962 #endif
11963 #ifdef FEAT_TAG_OLDSTATIC
11964 "tag_old_static",
11965 #endif
11966 #ifdef FEAT_TAG_ANYWHITE
11967 "tag_any_white",
11968 #endif
11969 #ifdef FEAT_TCL
11970 # ifndef DYNAMIC_TCL
11971 "tcl",
11972 # endif
11973 #endif
11974 #ifdef TERMINFO
11975 "terminfo",
11976 #endif
11977 #ifdef FEAT_TERMRESPONSE
11978 "termresponse",
11979 #endif
11980 #ifdef FEAT_TEXTOBJ
11981 "textobjects",
11982 #endif
11983 #ifdef HAVE_TGETENT
11984 "tgetent",
11985 #endif
11986 #ifdef FEAT_TITLE
11987 "title",
11988 #endif
11989 #ifdef FEAT_TOOLBAR
11990 "toolbar",
11991 #endif
11992 #ifdef FEAT_USR_CMDS
11993 "user-commands", /* was accidentally included in 5.4 */
11994 "user_commands",
11995 #endif
11996 #ifdef FEAT_VIMINFO
11997 "viminfo",
11998 #endif
11999 #ifdef FEAT_VERTSPLIT
12000 "vertsplit",
12001 #endif
12002 #ifdef FEAT_VIRTUALEDIT
12003 "virtualedit",
12004 #endif
12005 #ifdef FEAT_VISUAL
12006 "visual",
12007 #endif
12008 #ifdef FEAT_VISUALEXTRA
12009 "visualextra",
12010 #endif
12011 #ifdef FEAT_VREPLACE
12012 "vreplace",
12013 #endif
12014 #ifdef FEAT_WILDIGN
12015 "wildignore",
12016 #endif
12017 #ifdef FEAT_WILDMENU
12018 "wildmenu",
12019 #endif
12020 #ifdef FEAT_WINDOWS
12021 "windows",
12022 #endif
12023 #ifdef FEAT_WAK
12024 "winaltkeys",
12025 #endif
12026 #ifdef FEAT_WRITEBACKUP
12027 "writebackup",
12028 #endif
12029 #ifdef FEAT_XIM
12030 "xim",
12031 #endif
12032 #ifdef FEAT_XFONTSET
12033 "xfontset",
12034 #endif
12035 #ifdef USE_XSMP
12036 "xsmp",
12037 #endif
12038 #ifdef USE_XSMP_INTERACT
12039 "xsmp_interact",
12040 #endif
12041 #ifdef FEAT_XCLIPBOARD
12042 "xterm_clipboard",
12043 #endif
12044 #ifdef FEAT_XTERM_SAVE
12045 "xterm_save",
12046 #endif
12047 #if defined(UNIX) && defined(FEAT_X11)
12048 "X11",
12049 #endif
12050 NULL
12053 name = get_tv_string(&argvars[0]);
12054 for (i = 0; has_list[i] != NULL; ++i)
12055 if (STRICMP(name, has_list[i]) == 0)
12057 n = TRUE;
12058 break;
12061 if (n == FALSE)
12063 if (STRNICMP(name, "patch", 5) == 0)
12064 n = has_patch(atoi((char *)name + 5));
12065 else if (STRICMP(name, "vim_starting") == 0)
12066 n = (starting != 0);
12067 #ifdef FEAT_MBYTE
12068 else if (STRICMP(name, "multi_byte_encoding") == 0)
12069 n = has_mbyte;
12070 #endif
12071 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
12072 else if (STRICMP(name, "balloon_multiline") == 0)
12073 n = multiline_balloon_available();
12074 #endif
12075 #ifdef DYNAMIC_TCL
12076 else if (STRICMP(name, "tcl") == 0)
12077 n = tcl_enabled(FALSE);
12078 #endif
12079 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
12080 else if (STRICMP(name, "iconv") == 0)
12081 n = iconv_enabled(FALSE);
12082 #endif
12083 #ifdef DYNAMIC_MZSCHEME
12084 else if (STRICMP(name, "mzscheme") == 0)
12085 n = mzscheme_enabled(FALSE);
12086 #endif
12087 #ifdef DYNAMIC_RUBY
12088 else if (STRICMP(name, "ruby") == 0)
12089 n = ruby_enabled(FALSE);
12090 #endif
12091 #ifdef DYNAMIC_PYTHON
12092 else if (STRICMP(name, "python") == 0)
12093 n = python_enabled(FALSE);
12094 #endif
12095 #ifdef DYNAMIC_PERL
12096 else if (STRICMP(name, "perl") == 0)
12097 n = perl_enabled(FALSE);
12098 #endif
12099 #ifdef FEAT_GUI
12100 else if (STRICMP(name, "gui_running") == 0)
12101 n = (gui.in_use || gui.starting);
12102 # ifdef FEAT_GUI_W32
12103 else if (STRICMP(name, "gui_win32s") == 0)
12104 n = gui_is_win32s();
12105 # endif
12106 # ifdef FEAT_BROWSE
12107 else if (STRICMP(name, "browse") == 0)
12108 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
12109 # endif
12110 #endif
12111 #ifdef FEAT_SYN_HL
12112 else if (STRICMP(name, "syntax_items") == 0)
12113 n = syntax_present(curbuf);
12114 #endif
12115 #if defined(WIN3264)
12116 else if (STRICMP(name, "win95") == 0)
12117 n = mch_windows95();
12118 #endif
12119 #ifdef FEAT_NETBEANS_INTG
12120 else if (STRICMP(name, "netbeans_enabled") == 0)
12121 n = usingNetbeans;
12122 #endif
12125 rettv->vval.v_number = n;
12129 * "has_key()" function
12131 static void
12132 f_has_key(argvars, rettv)
12133 typval_T *argvars;
12134 typval_T *rettv;
12136 if (argvars[0].v_type != VAR_DICT)
12138 EMSG(_(e_dictreq));
12139 return;
12141 if (argvars[0].vval.v_dict == NULL)
12142 return;
12144 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
12145 get_tv_string(&argvars[1]), -1) != NULL;
12149 * "haslocaldir()" function
12151 static void
12152 f_haslocaldir(argvars, rettv)
12153 typval_T *argvars UNUSED;
12154 typval_T *rettv;
12156 rettv->vval.v_number = (curwin->w_localdir != NULL);
12160 * "hasmapto()" function
12162 static void
12163 f_hasmapto(argvars, rettv)
12164 typval_T *argvars;
12165 typval_T *rettv;
12167 char_u *name;
12168 char_u *mode;
12169 char_u buf[NUMBUFLEN];
12170 int abbr = FALSE;
12172 name = get_tv_string(&argvars[0]);
12173 if (argvars[1].v_type == VAR_UNKNOWN)
12174 mode = (char_u *)"nvo";
12175 else
12177 mode = get_tv_string_buf(&argvars[1], buf);
12178 if (argvars[2].v_type != VAR_UNKNOWN)
12179 abbr = get_tv_number(&argvars[2]);
12182 if (map_to_exists(name, mode, abbr))
12183 rettv->vval.v_number = TRUE;
12184 else
12185 rettv->vval.v_number = FALSE;
12189 * "histadd()" function
12191 static void
12192 f_histadd(argvars, rettv)
12193 typval_T *argvars UNUSED;
12194 typval_T *rettv;
12196 #ifdef FEAT_CMDHIST
12197 int histype;
12198 char_u *str;
12199 char_u buf[NUMBUFLEN];
12200 #endif
12202 rettv->vval.v_number = FALSE;
12203 if (check_restricted() || check_secure())
12204 return;
12205 #ifdef FEAT_CMDHIST
12206 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12207 histype = str != NULL ? get_histtype(str) : -1;
12208 if (histype >= 0)
12210 str = get_tv_string_buf(&argvars[1], buf);
12211 if (*str != NUL)
12213 add_to_history(histype, str, FALSE, NUL);
12214 rettv->vval.v_number = TRUE;
12215 return;
12218 #endif
12222 * "histdel()" function
12224 static void
12225 f_histdel(argvars, rettv)
12226 typval_T *argvars UNUSED;
12227 typval_T *rettv UNUSED;
12229 #ifdef FEAT_CMDHIST
12230 int n;
12231 char_u buf[NUMBUFLEN];
12232 char_u *str;
12234 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12235 if (str == NULL)
12236 n = 0;
12237 else if (argvars[1].v_type == VAR_UNKNOWN)
12238 /* only one argument: clear entire history */
12239 n = clr_history(get_histtype(str));
12240 else if (argvars[1].v_type == VAR_NUMBER)
12241 /* index given: remove that entry */
12242 n = del_history_idx(get_histtype(str),
12243 (int)get_tv_number(&argvars[1]));
12244 else
12245 /* string given: remove all matching entries */
12246 n = del_history_entry(get_histtype(str),
12247 get_tv_string_buf(&argvars[1], buf));
12248 rettv->vval.v_number = n;
12249 #endif
12253 * "histget()" function
12255 static void
12256 f_histget(argvars, rettv)
12257 typval_T *argvars UNUSED;
12258 typval_T *rettv;
12260 #ifdef FEAT_CMDHIST
12261 int type;
12262 int idx;
12263 char_u *str;
12265 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12266 if (str == NULL)
12267 rettv->vval.v_string = NULL;
12268 else
12270 type = get_histtype(str);
12271 if (argvars[1].v_type == VAR_UNKNOWN)
12272 idx = get_history_idx(type);
12273 else
12274 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12275 /* -1 on type error */
12276 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12278 #else
12279 rettv->vval.v_string = NULL;
12280 #endif
12281 rettv->v_type = VAR_STRING;
12285 * "histnr()" function
12287 static void
12288 f_histnr(argvars, rettv)
12289 typval_T *argvars UNUSED;
12290 typval_T *rettv;
12292 int i;
12294 #ifdef FEAT_CMDHIST
12295 char_u *history = get_tv_string_chk(&argvars[0]);
12297 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12298 if (i >= HIST_CMD && i < HIST_COUNT)
12299 i = get_history_idx(i);
12300 else
12301 #endif
12302 i = -1;
12303 rettv->vval.v_number = i;
12307 * "highlightID(name)" function
12309 static void
12310 f_hlID(argvars, rettv)
12311 typval_T *argvars;
12312 typval_T *rettv;
12314 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12318 * "highlight_exists()" function
12320 static void
12321 f_hlexists(argvars, rettv)
12322 typval_T *argvars;
12323 typval_T *rettv;
12325 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12329 * "hostname()" function
12331 static void
12332 f_hostname(argvars, rettv)
12333 typval_T *argvars UNUSED;
12334 typval_T *rettv;
12336 char_u hostname[256];
12338 mch_get_host_name(hostname, 256);
12339 rettv->v_type = VAR_STRING;
12340 rettv->vval.v_string = vim_strsave(hostname);
12344 * iconv() function
12346 static void
12347 f_iconv(argvars, rettv)
12348 typval_T *argvars UNUSED;
12349 typval_T *rettv;
12351 #ifdef FEAT_MBYTE
12352 char_u buf1[NUMBUFLEN];
12353 char_u buf2[NUMBUFLEN];
12354 char_u *from, *to, *str;
12355 vimconv_T vimconv;
12356 #endif
12358 rettv->v_type = VAR_STRING;
12359 rettv->vval.v_string = NULL;
12361 #ifdef FEAT_MBYTE
12362 str = get_tv_string(&argvars[0]);
12363 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12364 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12365 vimconv.vc_type = CONV_NONE;
12366 convert_setup(&vimconv, from, to);
12368 /* If the encodings are equal, no conversion needed. */
12369 if (vimconv.vc_type == CONV_NONE)
12370 rettv->vval.v_string = vim_strsave(str);
12371 else
12372 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12374 convert_setup(&vimconv, NULL, NULL);
12375 vim_free(from);
12376 vim_free(to);
12377 #endif
12381 * "indent()" function
12383 static void
12384 f_indent(argvars, rettv)
12385 typval_T *argvars;
12386 typval_T *rettv;
12388 linenr_T lnum;
12390 lnum = get_tv_lnum(argvars);
12391 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12392 rettv->vval.v_number = get_indent_lnum(lnum);
12393 else
12394 rettv->vval.v_number = -1;
12398 * "index()" function
12400 static void
12401 f_index(argvars, rettv)
12402 typval_T *argvars;
12403 typval_T *rettv;
12405 list_T *l;
12406 listitem_T *item;
12407 long idx = 0;
12408 int ic = FALSE;
12410 rettv->vval.v_number = -1;
12411 if (argvars[0].v_type != VAR_LIST)
12413 EMSG(_(e_listreq));
12414 return;
12416 l = argvars[0].vval.v_list;
12417 if (l != NULL)
12419 item = l->lv_first;
12420 if (argvars[2].v_type != VAR_UNKNOWN)
12422 int error = FALSE;
12424 /* Start at specified item. Use the cached index that list_find()
12425 * sets, so that a negative number also works. */
12426 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12427 idx = l->lv_idx;
12428 if (argvars[3].v_type != VAR_UNKNOWN)
12429 ic = get_tv_number_chk(&argvars[3], &error);
12430 if (error)
12431 item = NULL;
12434 for ( ; item != NULL; item = item->li_next, ++idx)
12435 if (tv_equal(&item->li_tv, &argvars[1], ic))
12437 rettv->vval.v_number = idx;
12438 break;
12443 static int inputsecret_flag = 0;
12445 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12448 * This function is used by f_input() and f_inputdialog() functions. The third
12449 * argument to f_input() specifies the type of completion to use at the
12450 * prompt. The third argument to f_inputdialog() specifies the value to return
12451 * when the user cancels the prompt.
12453 static void
12454 get_user_input(argvars, rettv, inputdialog)
12455 typval_T *argvars;
12456 typval_T *rettv;
12457 int inputdialog;
12459 char_u *prompt = get_tv_string_chk(&argvars[0]);
12460 char_u *p = NULL;
12461 int c;
12462 char_u buf[NUMBUFLEN];
12463 int cmd_silent_save = cmd_silent;
12464 char_u *defstr = (char_u *)"";
12465 int xp_type = EXPAND_NOTHING;
12466 char_u *xp_arg = NULL;
12468 rettv->v_type = VAR_STRING;
12469 rettv->vval.v_string = NULL;
12471 #ifdef NO_CONSOLE_INPUT
12472 /* While starting up, there is no place to enter text. */
12473 if (no_console_input())
12474 return;
12475 #endif
12477 cmd_silent = FALSE; /* Want to see the prompt. */
12478 if (prompt != NULL)
12480 /* Only the part of the message after the last NL is considered as
12481 * prompt for the command line */
12482 p = vim_strrchr(prompt, '\n');
12483 if (p == NULL)
12484 p = prompt;
12485 else
12487 ++p;
12488 c = *p;
12489 *p = NUL;
12490 msg_start();
12491 msg_clr_eos();
12492 msg_puts_attr(prompt, echo_attr);
12493 msg_didout = FALSE;
12494 msg_starthere();
12495 *p = c;
12497 cmdline_row = msg_row;
12499 if (argvars[1].v_type != VAR_UNKNOWN)
12501 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12502 if (defstr != NULL)
12503 stuffReadbuffSpec(defstr);
12505 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12507 char_u *xp_name;
12508 int xp_namelen;
12509 long argt;
12511 rettv->vval.v_string = NULL;
12513 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12514 if (xp_name == NULL)
12515 return;
12517 xp_namelen = (int)STRLEN(xp_name);
12519 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12520 &xp_arg) == FAIL)
12521 return;
12525 if (defstr != NULL)
12526 rettv->vval.v_string =
12527 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12528 xp_type, xp_arg);
12530 vim_free(xp_arg);
12532 /* since the user typed this, no need to wait for return */
12533 need_wait_return = FALSE;
12534 msg_didout = FALSE;
12536 cmd_silent = cmd_silent_save;
12540 * "input()" function
12541 * Also handles inputsecret() when inputsecret is set.
12543 static void
12544 f_input(argvars, rettv)
12545 typval_T *argvars;
12546 typval_T *rettv;
12548 get_user_input(argvars, rettv, FALSE);
12552 * "inputdialog()" function
12554 static void
12555 f_inputdialog(argvars, rettv)
12556 typval_T *argvars;
12557 typval_T *rettv;
12559 #if defined(FEAT_GUI_TEXTDIALOG)
12560 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12561 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12563 char_u *message;
12564 char_u buf[NUMBUFLEN];
12565 char_u *defstr = (char_u *)"";
12567 message = get_tv_string_chk(&argvars[0]);
12568 if (argvars[1].v_type != VAR_UNKNOWN
12569 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12570 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12571 else
12572 IObuff[0] = NUL;
12573 if (message != NULL && defstr != NULL
12574 && do_dialog(VIM_QUESTION, NULL, message,
12575 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12576 rettv->vval.v_string = vim_strsave(IObuff);
12577 else
12579 if (message != NULL && defstr != NULL
12580 && argvars[1].v_type != VAR_UNKNOWN
12581 && argvars[2].v_type != VAR_UNKNOWN)
12582 rettv->vval.v_string = vim_strsave(
12583 get_tv_string_buf(&argvars[2], buf));
12584 else
12585 rettv->vval.v_string = NULL;
12587 rettv->v_type = VAR_STRING;
12589 else
12590 #endif
12591 get_user_input(argvars, rettv, TRUE);
12595 * "inputlist()" function
12597 static void
12598 f_inputlist(argvars, rettv)
12599 typval_T *argvars;
12600 typval_T *rettv;
12602 listitem_T *li;
12603 int selected;
12604 int mouse_used;
12606 #ifdef NO_CONSOLE_INPUT
12607 /* While starting up, there is no place to enter text. */
12608 if (no_console_input())
12609 return;
12610 #endif
12611 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12613 EMSG2(_(e_listarg), "inputlist()");
12614 return;
12617 msg_start();
12618 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12619 lines_left = Rows; /* avoid more prompt */
12620 msg_scroll = TRUE;
12621 msg_clr_eos();
12623 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12625 msg_puts(get_tv_string(&li->li_tv));
12626 msg_putchar('\n');
12629 /* Ask for choice. */
12630 selected = prompt_for_number(&mouse_used);
12631 if (mouse_used)
12632 selected -= lines_left;
12634 rettv->vval.v_number = selected;
12638 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12641 * "inputrestore()" function
12643 static void
12644 f_inputrestore(argvars, rettv)
12645 typval_T *argvars UNUSED;
12646 typval_T *rettv;
12648 if (ga_userinput.ga_len > 0)
12650 --ga_userinput.ga_len;
12651 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12652 + ga_userinput.ga_len);
12653 /* default return is zero == OK */
12655 else if (p_verbose > 1)
12657 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12658 rettv->vval.v_number = 1; /* Failed */
12663 * "inputsave()" function
12665 static void
12666 f_inputsave(argvars, rettv)
12667 typval_T *argvars UNUSED;
12668 typval_T *rettv;
12670 /* Add an entry to the stack of typeahead storage. */
12671 if (ga_grow(&ga_userinput, 1) == OK)
12673 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12674 + ga_userinput.ga_len);
12675 ++ga_userinput.ga_len;
12676 /* default return is zero == OK */
12678 else
12679 rettv->vval.v_number = 1; /* Failed */
12683 * "inputsecret()" function
12685 static void
12686 f_inputsecret(argvars, rettv)
12687 typval_T *argvars;
12688 typval_T *rettv;
12690 ++cmdline_star;
12691 ++inputsecret_flag;
12692 f_input(argvars, rettv);
12693 --cmdline_star;
12694 --inputsecret_flag;
12698 * "insert()" function
12700 static void
12701 f_insert(argvars, rettv)
12702 typval_T *argvars;
12703 typval_T *rettv;
12705 long before = 0;
12706 listitem_T *item;
12707 list_T *l;
12708 int error = FALSE;
12710 if (argvars[0].v_type != VAR_LIST)
12711 EMSG2(_(e_listarg), "insert()");
12712 else if ((l = argvars[0].vval.v_list) != NULL
12713 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12715 if (argvars[2].v_type != VAR_UNKNOWN)
12716 before = get_tv_number_chk(&argvars[2], &error);
12717 if (error)
12718 return; /* type error; errmsg already given */
12720 if (before == l->lv_len)
12721 item = NULL;
12722 else
12724 item = list_find(l, before);
12725 if (item == NULL)
12727 EMSGN(_(e_listidx), before);
12728 l = NULL;
12731 if (l != NULL)
12733 list_insert_tv(l, &argvars[1], item);
12734 copy_tv(&argvars[0], rettv);
12740 * "isdirectory()" function
12742 static void
12743 f_isdirectory(argvars, rettv)
12744 typval_T *argvars;
12745 typval_T *rettv;
12747 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12751 * "islocked()" function
12753 static void
12754 f_islocked(argvars, rettv)
12755 typval_T *argvars;
12756 typval_T *rettv;
12758 lval_T lv;
12759 char_u *end;
12760 dictitem_T *di;
12762 rettv->vval.v_number = -1;
12763 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12764 FNE_CHECK_START);
12765 if (end != NULL && lv.ll_name != NULL)
12767 if (*end != NUL)
12768 EMSG(_(e_trailing));
12769 else
12771 if (lv.ll_tv == NULL)
12773 if (check_changedtick(lv.ll_name))
12774 rettv->vval.v_number = 1; /* always locked */
12775 else
12777 di = find_var(lv.ll_name, NULL);
12778 if (di != NULL)
12780 /* Consider a variable locked when:
12781 * 1. the variable itself is locked
12782 * 2. the value of the variable is locked.
12783 * 3. the List or Dict value is locked.
12785 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12786 || tv_islocked(&di->di_tv));
12790 else if (lv.ll_range)
12791 EMSG(_("E786: Range not allowed"));
12792 else if (lv.ll_newkey != NULL)
12793 EMSG2(_(e_dictkey), lv.ll_newkey);
12794 else if (lv.ll_list != NULL)
12795 /* List item. */
12796 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12797 else
12798 /* Dictionary item. */
12799 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12803 clear_lval(&lv);
12806 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12809 * Turn a dict into a list:
12810 * "what" == 0: list of keys
12811 * "what" == 1: list of values
12812 * "what" == 2: list of items
12814 static void
12815 dict_list(argvars, rettv, what)
12816 typval_T *argvars;
12817 typval_T *rettv;
12818 int what;
12820 list_T *l2;
12821 dictitem_T *di;
12822 hashitem_T *hi;
12823 listitem_T *li;
12824 listitem_T *li2;
12825 dict_T *d;
12826 int todo;
12828 if (argvars[0].v_type != VAR_DICT)
12830 EMSG(_(e_dictreq));
12831 return;
12833 if ((d = argvars[0].vval.v_dict) == NULL)
12834 return;
12836 if (rettv_list_alloc(rettv) == FAIL)
12837 return;
12839 todo = (int)d->dv_hashtab.ht_used;
12840 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12842 if (!HASHITEM_EMPTY(hi))
12844 --todo;
12845 di = HI2DI(hi);
12847 li = listitem_alloc();
12848 if (li == NULL)
12849 break;
12850 list_append(rettv->vval.v_list, li);
12852 if (what == 0)
12854 /* keys() */
12855 li->li_tv.v_type = VAR_STRING;
12856 li->li_tv.v_lock = 0;
12857 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12859 else if (what == 1)
12861 /* values() */
12862 copy_tv(&di->di_tv, &li->li_tv);
12864 else
12866 /* items() */
12867 l2 = list_alloc();
12868 li->li_tv.v_type = VAR_LIST;
12869 li->li_tv.v_lock = 0;
12870 li->li_tv.vval.v_list = l2;
12871 if (l2 == NULL)
12872 break;
12873 ++l2->lv_refcount;
12875 li2 = listitem_alloc();
12876 if (li2 == NULL)
12877 break;
12878 list_append(l2, li2);
12879 li2->li_tv.v_type = VAR_STRING;
12880 li2->li_tv.v_lock = 0;
12881 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12883 li2 = listitem_alloc();
12884 if (li2 == NULL)
12885 break;
12886 list_append(l2, li2);
12887 copy_tv(&di->di_tv, &li2->li_tv);
12894 * "items(dict)" function
12896 static void
12897 f_items(argvars, rettv)
12898 typval_T *argvars;
12899 typval_T *rettv;
12901 dict_list(argvars, rettv, 2);
12905 * "join()" function
12907 static void
12908 f_join(argvars, rettv)
12909 typval_T *argvars;
12910 typval_T *rettv;
12912 garray_T ga;
12913 char_u *sep;
12915 if (argvars[0].v_type != VAR_LIST)
12917 EMSG(_(e_listreq));
12918 return;
12920 if (argvars[0].vval.v_list == NULL)
12921 return;
12922 if (argvars[1].v_type == VAR_UNKNOWN)
12923 sep = (char_u *)" ";
12924 else
12925 sep = get_tv_string_chk(&argvars[1]);
12927 rettv->v_type = VAR_STRING;
12929 if (sep != NULL)
12931 ga_init2(&ga, (int)sizeof(char), 80);
12932 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12933 ga_append(&ga, NUL);
12934 rettv->vval.v_string = (char_u *)ga.ga_data;
12936 else
12937 rettv->vval.v_string = NULL;
12941 * "keys()" function
12943 static void
12944 f_keys(argvars, rettv)
12945 typval_T *argvars;
12946 typval_T *rettv;
12948 dict_list(argvars, rettv, 0);
12952 * "last_buffer_nr()" function.
12954 static void
12955 f_last_buffer_nr(argvars, rettv)
12956 typval_T *argvars UNUSED;
12957 typval_T *rettv;
12959 int n = 0;
12960 buf_T *buf;
12962 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12963 if (n < buf->b_fnum)
12964 n = buf->b_fnum;
12966 rettv->vval.v_number = n;
12970 * "len()" function
12972 static void
12973 f_len(argvars, rettv)
12974 typval_T *argvars;
12975 typval_T *rettv;
12977 switch (argvars[0].v_type)
12979 case VAR_STRING:
12980 case VAR_NUMBER:
12981 rettv->vval.v_number = (varnumber_T)STRLEN(
12982 get_tv_string(&argvars[0]));
12983 break;
12984 case VAR_LIST:
12985 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12986 break;
12987 case VAR_DICT:
12988 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12989 break;
12990 default:
12991 EMSG(_("E701: Invalid type for len()"));
12992 break;
12996 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
12998 static void
12999 libcall_common(argvars, rettv, type)
13000 typval_T *argvars;
13001 typval_T *rettv;
13002 int type;
13004 #ifdef FEAT_LIBCALL
13005 char_u *string_in;
13006 char_u **string_result;
13007 int nr_result;
13008 #endif
13010 rettv->v_type = type;
13011 if (type != VAR_NUMBER)
13012 rettv->vval.v_string = NULL;
13014 if (check_restricted() || check_secure())
13015 return;
13017 #ifdef FEAT_LIBCALL
13018 /* The first two args must be strings, otherwise its meaningless */
13019 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
13021 string_in = NULL;
13022 if (argvars[2].v_type == VAR_STRING)
13023 string_in = argvars[2].vval.v_string;
13024 if (type == VAR_NUMBER)
13025 string_result = NULL;
13026 else
13027 string_result = &rettv->vval.v_string;
13028 if (mch_libcall(argvars[0].vval.v_string,
13029 argvars[1].vval.v_string,
13030 string_in,
13031 argvars[2].vval.v_number,
13032 string_result,
13033 &nr_result) == OK
13034 && type == VAR_NUMBER)
13035 rettv->vval.v_number = nr_result;
13037 #endif
13041 * "libcall()" function
13043 static void
13044 f_libcall(argvars, rettv)
13045 typval_T *argvars;
13046 typval_T *rettv;
13048 libcall_common(argvars, rettv, VAR_STRING);
13052 * "libcallnr()" function
13054 static void
13055 f_libcallnr(argvars, rettv)
13056 typval_T *argvars;
13057 typval_T *rettv;
13059 libcall_common(argvars, rettv, VAR_NUMBER);
13063 * "line(string)" function
13065 static void
13066 f_line(argvars, rettv)
13067 typval_T *argvars;
13068 typval_T *rettv;
13070 linenr_T lnum = 0;
13071 pos_T *fp;
13072 int fnum;
13074 fp = var2fpos(&argvars[0], TRUE, &fnum);
13075 if (fp != NULL)
13076 lnum = fp->lnum;
13077 rettv->vval.v_number = lnum;
13081 * "line2byte(lnum)" function
13083 static void
13084 f_line2byte(argvars, rettv)
13085 typval_T *argvars UNUSED;
13086 typval_T *rettv;
13088 #ifndef FEAT_BYTEOFF
13089 rettv->vval.v_number = -1;
13090 #else
13091 linenr_T lnum;
13093 lnum = get_tv_lnum(argvars);
13094 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
13095 rettv->vval.v_number = -1;
13096 else
13097 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
13098 if (rettv->vval.v_number >= 0)
13099 ++rettv->vval.v_number;
13100 #endif
13104 * "lispindent(lnum)" function
13106 static void
13107 f_lispindent(argvars, rettv)
13108 typval_T *argvars;
13109 typval_T *rettv;
13111 #ifdef FEAT_LISP
13112 pos_T pos;
13113 linenr_T lnum;
13115 pos = curwin->w_cursor;
13116 lnum = get_tv_lnum(argvars);
13117 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
13119 curwin->w_cursor.lnum = lnum;
13120 rettv->vval.v_number = get_lisp_indent();
13121 curwin->w_cursor = pos;
13123 else
13124 #endif
13125 rettv->vval.v_number = -1;
13129 * "localtime()" function
13131 static void
13132 f_localtime(argvars, rettv)
13133 typval_T *argvars UNUSED;
13134 typval_T *rettv;
13136 rettv->vval.v_number = (varnumber_T)time(NULL);
13139 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
13141 static void
13142 get_maparg(argvars, rettv, exact)
13143 typval_T *argvars;
13144 typval_T *rettv;
13145 int exact;
13147 char_u *keys;
13148 char_u *which;
13149 char_u buf[NUMBUFLEN];
13150 char_u *keys_buf = NULL;
13151 char_u *rhs;
13152 int mode;
13153 garray_T ga;
13154 int abbr = FALSE;
13156 /* return empty string for failure */
13157 rettv->v_type = VAR_STRING;
13158 rettv->vval.v_string = NULL;
13160 keys = get_tv_string(&argvars[0]);
13161 if (*keys == NUL)
13162 return;
13164 if (argvars[1].v_type != VAR_UNKNOWN)
13166 which = get_tv_string_buf_chk(&argvars[1], buf);
13167 if (argvars[2].v_type != VAR_UNKNOWN)
13168 abbr = get_tv_number(&argvars[2]);
13170 else
13171 which = (char_u *)"";
13172 if (which == NULL)
13173 return;
13175 mode = get_map_mode(&which, 0);
13177 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
13178 rhs = check_map(keys, mode, exact, FALSE, abbr);
13179 vim_free(keys_buf);
13180 if (rhs != NULL)
13182 ga_init(&ga);
13183 ga.ga_itemsize = 1;
13184 ga.ga_growsize = 40;
13186 while (*rhs != NUL)
13187 ga_concat(&ga, str2special(&rhs, FALSE));
13189 ga_append(&ga, NUL);
13190 rettv->vval.v_string = (char_u *)ga.ga_data;
13194 #ifdef FEAT_FLOAT
13196 * "log10()" function
13198 static void
13199 f_log10(argvars, rettv)
13200 typval_T *argvars;
13201 typval_T *rettv;
13203 float_T f;
13205 rettv->v_type = VAR_FLOAT;
13206 if (get_float_arg(argvars, &f) == OK)
13207 rettv->vval.v_float = log10(f);
13208 else
13209 rettv->vval.v_float = 0.0;
13211 #endif
13214 * "map()" function
13216 static void
13217 f_map(argvars, rettv)
13218 typval_T *argvars;
13219 typval_T *rettv;
13221 filter_map(argvars, rettv, TRUE);
13225 * "maparg()" function
13227 static void
13228 f_maparg(argvars, rettv)
13229 typval_T *argvars;
13230 typval_T *rettv;
13232 get_maparg(argvars, rettv, TRUE);
13236 * "mapcheck()" function
13238 static void
13239 f_mapcheck(argvars, rettv)
13240 typval_T *argvars;
13241 typval_T *rettv;
13243 get_maparg(argvars, rettv, FALSE);
13246 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13248 static void
13249 find_some_match(argvars, rettv, type)
13250 typval_T *argvars;
13251 typval_T *rettv;
13252 int type;
13254 char_u *str = NULL;
13255 char_u *expr = NULL;
13256 char_u *pat;
13257 regmatch_T regmatch;
13258 char_u patbuf[NUMBUFLEN];
13259 char_u strbuf[NUMBUFLEN];
13260 char_u *save_cpo;
13261 long start = 0;
13262 long nth = 1;
13263 colnr_T startcol = 0;
13264 int match = 0;
13265 list_T *l = NULL;
13266 listitem_T *li = NULL;
13267 long idx = 0;
13268 char_u *tofree = NULL;
13270 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13271 save_cpo = p_cpo;
13272 p_cpo = (char_u *)"";
13274 rettv->vval.v_number = -1;
13275 if (type == 3)
13277 /* return empty list when there are no matches */
13278 if (rettv_list_alloc(rettv) == FAIL)
13279 goto theend;
13281 else if (type == 2)
13283 rettv->v_type = VAR_STRING;
13284 rettv->vval.v_string = NULL;
13287 if (argvars[0].v_type == VAR_LIST)
13289 if ((l = argvars[0].vval.v_list) == NULL)
13290 goto theend;
13291 li = l->lv_first;
13293 else
13294 expr = str = get_tv_string(&argvars[0]);
13296 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13297 if (pat == NULL)
13298 goto theend;
13300 if (argvars[2].v_type != VAR_UNKNOWN)
13302 int error = FALSE;
13304 start = get_tv_number_chk(&argvars[2], &error);
13305 if (error)
13306 goto theend;
13307 if (l != NULL)
13309 li = list_find(l, start);
13310 if (li == NULL)
13311 goto theend;
13312 idx = l->lv_idx; /* use the cached index */
13314 else
13316 if (start < 0)
13317 start = 0;
13318 if (start > (long)STRLEN(str))
13319 goto theend;
13320 /* When "count" argument is there ignore matches before "start",
13321 * otherwise skip part of the string. Differs when pattern is "^"
13322 * or "\<". */
13323 if (argvars[3].v_type != VAR_UNKNOWN)
13324 startcol = start;
13325 else
13326 str += start;
13329 if (argvars[3].v_type != VAR_UNKNOWN)
13330 nth = get_tv_number_chk(&argvars[3], &error);
13331 if (error)
13332 goto theend;
13335 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13336 if (regmatch.regprog != NULL)
13338 regmatch.rm_ic = p_ic;
13340 for (;;)
13342 if (l != NULL)
13344 if (li == NULL)
13346 match = FALSE;
13347 break;
13349 vim_free(tofree);
13350 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13351 if (str == NULL)
13352 break;
13355 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13357 if (match && --nth <= 0)
13358 break;
13359 if (l == NULL && !match)
13360 break;
13362 /* Advance to just after the match. */
13363 if (l != NULL)
13365 li = li->li_next;
13366 ++idx;
13368 else
13370 #ifdef FEAT_MBYTE
13371 startcol = (colnr_T)(regmatch.startp[0]
13372 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13373 #else
13374 startcol = regmatch.startp[0] + 1 - str;
13375 #endif
13379 if (match)
13381 if (type == 3)
13383 int i;
13385 /* return list with matched string and submatches */
13386 for (i = 0; i < NSUBEXP; ++i)
13388 if (regmatch.endp[i] == NULL)
13390 if (list_append_string(rettv->vval.v_list,
13391 (char_u *)"", 0) == FAIL)
13392 break;
13394 else if (list_append_string(rettv->vval.v_list,
13395 regmatch.startp[i],
13396 (int)(regmatch.endp[i] - regmatch.startp[i]))
13397 == FAIL)
13398 break;
13401 else if (type == 2)
13403 /* return matched string */
13404 if (l != NULL)
13405 copy_tv(&li->li_tv, rettv);
13406 else
13407 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13408 (int)(regmatch.endp[0] - regmatch.startp[0]));
13410 else if (l != NULL)
13411 rettv->vval.v_number = idx;
13412 else
13414 if (type != 0)
13415 rettv->vval.v_number =
13416 (varnumber_T)(regmatch.startp[0] - str);
13417 else
13418 rettv->vval.v_number =
13419 (varnumber_T)(regmatch.endp[0] - str);
13420 rettv->vval.v_number += (varnumber_T)(str - expr);
13423 vim_free(regmatch.regprog);
13426 theend:
13427 vim_free(tofree);
13428 p_cpo = save_cpo;
13432 * "match()" function
13434 static void
13435 f_match(argvars, rettv)
13436 typval_T *argvars;
13437 typval_T *rettv;
13439 find_some_match(argvars, rettv, 1);
13443 * "matchadd()" function
13445 static void
13446 f_matchadd(argvars, rettv)
13447 typval_T *argvars;
13448 typval_T *rettv;
13450 #ifdef FEAT_SEARCH_EXTRA
13451 char_u buf[NUMBUFLEN];
13452 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13453 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13454 int prio = 10; /* default priority */
13455 int id = -1;
13456 int error = FALSE;
13458 rettv->vval.v_number = -1;
13460 if (grp == NULL || pat == NULL)
13461 return;
13462 if (argvars[2].v_type != VAR_UNKNOWN)
13464 prio = get_tv_number_chk(&argvars[2], &error);
13465 if (argvars[3].v_type != VAR_UNKNOWN)
13466 id = get_tv_number_chk(&argvars[3], &error);
13468 if (error == TRUE)
13469 return;
13470 if (id >= 1 && id <= 3)
13472 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13473 return;
13476 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13477 #endif
13481 * "matcharg()" function
13483 static void
13484 f_matcharg(argvars, rettv)
13485 typval_T *argvars;
13486 typval_T *rettv;
13488 if (rettv_list_alloc(rettv) == OK)
13490 #ifdef FEAT_SEARCH_EXTRA
13491 int id = get_tv_number(&argvars[0]);
13492 matchitem_T *m;
13494 if (id >= 1 && id <= 3)
13496 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13498 list_append_string(rettv->vval.v_list,
13499 syn_id2name(m->hlg_id), -1);
13500 list_append_string(rettv->vval.v_list, m->pattern, -1);
13502 else
13504 list_append_string(rettv->vval.v_list, NUL, -1);
13505 list_append_string(rettv->vval.v_list, NUL, -1);
13508 #endif
13513 * "matchdelete()" function
13515 static void
13516 f_matchdelete(argvars, rettv)
13517 typval_T *argvars;
13518 typval_T *rettv;
13520 #ifdef FEAT_SEARCH_EXTRA
13521 rettv->vval.v_number = match_delete(curwin,
13522 (int)get_tv_number(&argvars[0]), TRUE);
13523 #endif
13527 * "matchend()" function
13529 static void
13530 f_matchend(argvars, rettv)
13531 typval_T *argvars;
13532 typval_T *rettv;
13534 find_some_match(argvars, rettv, 0);
13538 * "matchlist()" function
13540 static void
13541 f_matchlist(argvars, rettv)
13542 typval_T *argvars;
13543 typval_T *rettv;
13545 find_some_match(argvars, rettv, 3);
13549 * "matchstr()" function
13551 static void
13552 f_matchstr(argvars, rettv)
13553 typval_T *argvars;
13554 typval_T *rettv;
13556 find_some_match(argvars, rettv, 2);
13559 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13561 static void
13562 max_min(argvars, rettv, domax)
13563 typval_T *argvars;
13564 typval_T *rettv;
13565 int domax;
13567 long n = 0;
13568 long i;
13569 int error = FALSE;
13571 if (argvars[0].v_type == VAR_LIST)
13573 list_T *l;
13574 listitem_T *li;
13576 l = argvars[0].vval.v_list;
13577 if (l != NULL)
13579 li = l->lv_first;
13580 if (li != NULL)
13582 n = get_tv_number_chk(&li->li_tv, &error);
13583 for (;;)
13585 li = li->li_next;
13586 if (li == NULL)
13587 break;
13588 i = get_tv_number_chk(&li->li_tv, &error);
13589 if (domax ? i > n : i < n)
13590 n = i;
13595 else if (argvars[0].v_type == VAR_DICT)
13597 dict_T *d;
13598 int first = TRUE;
13599 hashitem_T *hi;
13600 int todo;
13602 d = argvars[0].vval.v_dict;
13603 if (d != NULL)
13605 todo = (int)d->dv_hashtab.ht_used;
13606 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13608 if (!HASHITEM_EMPTY(hi))
13610 --todo;
13611 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13612 if (first)
13614 n = i;
13615 first = FALSE;
13617 else if (domax ? i > n : i < n)
13618 n = i;
13623 else
13624 EMSG(_(e_listdictarg));
13625 rettv->vval.v_number = error ? 0 : n;
13629 * "max()" function
13631 static void
13632 f_max(argvars, rettv)
13633 typval_T *argvars;
13634 typval_T *rettv;
13636 max_min(argvars, rettv, TRUE);
13640 * "min()" function
13642 static void
13643 f_min(argvars, rettv)
13644 typval_T *argvars;
13645 typval_T *rettv;
13647 max_min(argvars, rettv, FALSE);
13650 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13653 * Create the directory in which "dir" is located, and higher levels when
13654 * needed.
13656 static int
13657 mkdir_recurse(dir, prot)
13658 char_u *dir;
13659 int prot;
13661 char_u *p;
13662 char_u *updir;
13663 int r = FAIL;
13665 /* Get end of directory name in "dir".
13666 * We're done when it's "/" or "c:/". */
13667 p = gettail_sep(dir);
13668 if (p <= get_past_head(dir))
13669 return OK;
13671 /* If the directory exists we're done. Otherwise: create it.*/
13672 updir = vim_strnsave(dir, (int)(p - dir));
13673 if (updir == NULL)
13674 return FAIL;
13675 if (mch_isdir(updir))
13676 r = OK;
13677 else if (mkdir_recurse(updir, prot) == OK)
13678 r = vim_mkdir_emsg(updir, prot);
13679 vim_free(updir);
13680 return r;
13683 #ifdef vim_mkdir
13685 * "mkdir()" function
13687 static void
13688 f_mkdir(argvars, rettv)
13689 typval_T *argvars;
13690 typval_T *rettv;
13692 char_u *dir;
13693 char_u buf[NUMBUFLEN];
13694 int prot = 0755;
13696 rettv->vval.v_number = FAIL;
13697 if (check_restricted() || check_secure())
13698 return;
13700 dir = get_tv_string_buf(&argvars[0], buf);
13701 if (argvars[1].v_type != VAR_UNKNOWN)
13703 if (argvars[2].v_type != VAR_UNKNOWN)
13704 prot = get_tv_number_chk(&argvars[2], NULL);
13705 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13706 mkdir_recurse(dir, prot);
13708 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13710 #endif
13713 * "mode()" function
13715 static void
13716 f_mode(argvars, rettv)
13717 typval_T *argvars;
13718 typval_T *rettv;
13720 char_u buf[3];
13722 buf[1] = NUL;
13723 buf[2] = NUL;
13725 #ifdef FEAT_VISUAL
13726 if (VIsual_active)
13728 if (VIsual_select)
13729 buf[0] = VIsual_mode + 's' - 'v';
13730 else
13731 buf[0] = VIsual_mode;
13733 else
13734 #endif
13735 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13736 || State == CONFIRM)
13738 buf[0] = 'r';
13739 if (State == ASKMORE)
13740 buf[1] = 'm';
13741 else if (State == CONFIRM)
13742 buf[1] = '?';
13744 else if (State == EXTERNCMD)
13745 buf[0] = '!';
13746 else if (State & INSERT)
13748 #ifdef FEAT_VREPLACE
13749 if (State & VREPLACE_FLAG)
13751 buf[0] = 'R';
13752 buf[1] = 'v';
13754 else
13755 #endif
13756 if (State & REPLACE_FLAG)
13757 buf[0] = 'R';
13758 else
13759 buf[0] = 'i';
13761 else if (State & CMDLINE)
13763 buf[0] = 'c';
13764 if (exmode_active)
13765 buf[1] = 'v';
13767 else if (exmode_active)
13769 buf[0] = 'c';
13770 buf[1] = 'e';
13772 else
13774 buf[0] = 'n';
13775 if (finish_op)
13776 buf[1] = 'o';
13779 /* Clear out the minor mode when the argument is not a non-zero number or
13780 * non-empty string. */
13781 if (!non_zero_arg(&argvars[0]))
13782 buf[1] = NUL;
13784 rettv->vval.v_string = vim_strsave(buf);
13785 rettv->v_type = VAR_STRING;
13789 * "nextnonblank()" function
13791 static void
13792 f_nextnonblank(argvars, rettv)
13793 typval_T *argvars;
13794 typval_T *rettv;
13796 linenr_T lnum;
13798 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13800 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13802 lnum = 0;
13803 break;
13805 if (*skipwhite(ml_get(lnum)) != NUL)
13806 break;
13808 rettv->vval.v_number = lnum;
13812 * "nr2char()" function
13814 static void
13815 f_nr2char(argvars, rettv)
13816 typval_T *argvars;
13817 typval_T *rettv;
13819 char_u buf[NUMBUFLEN];
13821 #ifdef FEAT_MBYTE
13822 if (has_mbyte)
13823 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13824 else
13825 #endif
13827 buf[0] = (char_u)get_tv_number(&argvars[0]);
13828 buf[1] = NUL;
13830 rettv->v_type = VAR_STRING;
13831 rettv->vval.v_string = vim_strsave(buf);
13835 * "pathshorten()" function
13837 static void
13838 f_pathshorten(argvars, rettv)
13839 typval_T *argvars;
13840 typval_T *rettv;
13842 char_u *p;
13844 rettv->v_type = VAR_STRING;
13845 p = get_tv_string_chk(&argvars[0]);
13846 if (p == NULL)
13847 rettv->vval.v_string = NULL;
13848 else
13850 p = vim_strsave(p);
13851 rettv->vval.v_string = p;
13852 if (p != NULL)
13853 shorten_dir(p);
13857 #ifdef FEAT_FLOAT
13859 * "pow()" function
13861 static void
13862 f_pow(argvars, rettv)
13863 typval_T *argvars;
13864 typval_T *rettv;
13866 float_T fx, fy;
13868 rettv->v_type = VAR_FLOAT;
13869 if (get_float_arg(argvars, &fx) == OK
13870 && get_float_arg(&argvars[1], &fy) == OK)
13871 rettv->vval.v_float = pow(fx, fy);
13872 else
13873 rettv->vval.v_float = 0.0;
13875 #endif
13878 * "prevnonblank()" function
13880 static void
13881 f_prevnonblank(argvars, rettv)
13882 typval_T *argvars;
13883 typval_T *rettv;
13885 linenr_T lnum;
13887 lnum = get_tv_lnum(argvars);
13888 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13889 lnum = 0;
13890 else
13891 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13892 --lnum;
13893 rettv->vval.v_number = lnum;
13896 #ifdef HAVE_STDARG_H
13897 /* This dummy va_list is here because:
13898 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13899 * - locally in the function results in a "used before set" warning
13900 * - using va_start() to initialize it gives "function with fixed args" error */
13901 static va_list ap;
13902 #endif
13905 * "printf()" function
13907 static void
13908 f_printf(argvars, rettv)
13909 typval_T *argvars;
13910 typval_T *rettv;
13912 rettv->v_type = VAR_STRING;
13913 rettv->vval.v_string = NULL;
13914 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13916 char_u buf[NUMBUFLEN];
13917 int len;
13918 char_u *s;
13919 int saved_did_emsg = did_emsg;
13920 char *fmt;
13922 /* Get the required length, allocate the buffer and do it for real. */
13923 did_emsg = FALSE;
13924 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13925 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13926 if (!did_emsg)
13928 s = alloc(len + 1);
13929 if (s != NULL)
13931 rettv->vval.v_string = s;
13932 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13935 did_emsg |= saved_did_emsg;
13937 #endif
13941 * "pumvisible()" function
13943 static void
13944 f_pumvisible(argvars, rettv)
13945 typval_T *argvars UNUSED;
13946 typval_T *rettv UNUSED;
13948 #ifdef FEAT_INS_EXPAND
13949 if (pum_visible())
13950 rettv->vval.v_number = 1;
13951 #endif
13955 * "range()" function
13957 static void
13958 f_range(argvars, rettv)
13959 typval_T *argvars;
13960 typval_T *rettv;
13962 long start;
13963 long end;
13964 long stride = 1;
13965 long i;
13966 int error = FALSE;
13968 start = get_tv_number_chk(&argvars[0], &error);
13969 if (argvars[1].v_type == VAR_UNKNOWN)
13971 end = start - 1;
13972 start = 0;
13974 else
13976 end = get_tv_number_chk(&argvars[1], &error);
13977 if (argvars[2].v_type != VAR_UNKNOWN)
13978 stride = get_tv_number_chk(&argvars[2], &error);
13981 if (error)
13982 return; /* type error; errmsg already given */
13983 if (stride == 0)
13984 EMSG(_("E726: Stride is zero"));
13985 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13986 EMSG(_("E727: Start past end"));
13987 else
13989 if (rettv_list_alloc(rettv) == OK)
13990 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13991 if (list_append_number(rettv->vval.v_list,
13992 (varnumber_T)i) == FAIL)
13993 break;
13998 * "readfile()" function
14000 static void
14001 f_readfile(argvars, rettv)
14002 typval_T *argvars;
14003 typval_T *rettv;
14005 int binary = FALSE;
14006 char_u *fname;
14007 FILE *fd;
14008 listitem_T *li;
14009 #define FREAD_SIZE 200 /* optimized for text lines */
14010 char_u buf[FREAD_SIZE];
14011 int readlen; /* size of last fread() */
14012 int buflen; /* nr of valid chars in buf[] */
14013 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
14014 int tolist; /* first byte in buf[] still to be put in list */
14015 int chop; /* how many CR to chop off */
14016 char_u *prev = NULL; /* previously read bytes, if any */
14017 int prevlen = 0; /* length of "prev" if not NULL */
14018 char_u *s;
14019 int len;
14020 long maxline = MAXLNUM;
14021 long cnt = 0;
14023 if (argvars[1].v_type != VAR_UNKNOWN)
14025 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
14026 binary = TRUE;
14027 if (argvars[2].v_type != VAR_UNKNOWN)
14028 maxline = get_tv_number(&argvars[2]);
14031 if (rettv_list_alloc(rettv) == FAIL)
14032 return;
14034 /* Always open the file in binary mode, library functions have a mind of
14035 * their own about CR-LF conversion. */
14036 fname = get_tv_string(&argvars[0]);
14037 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
14039 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
14040 return;
14043 filtd = 0;
14044 while (cnt < maxline || maxline < 0)
14046 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
14047 buflen = filtd + readlen;
14048 tolist = 0;
14049 for ( ; filtd < buflen || readlen <= 0; ++filtd)
14051 if (buf[filtd] == '\n' || readlen <= 0)
14053 /* Only when in binary mode add an empty list item when the
14054 * last line ends in a '\n'. */
14055 if (!binary && readlen == 0 && filtd == 0)
14056 break;
14058 /* Found end-of-line or end-of-file: add a text line to the
14059 * list. */
14060 chop = 0;
14061 if (!binary)
14062 while (filtd - chop - 1 >= tolist
14063 && buf[filtd - chop - 1] == '\r')
14064 ++chop;
14065 len = filtd - tolist - chop;
14066 if (prev == NULL)
14067 s = vim_strnsave(buf + tolist, len);
14068 else
14070 s = alloc((unsigned)(prevlen + len + 1));
14071 if (s != NULL)
14073 mch_memmove(s, prev, prevlen);
14074 vim_free(prev);
14075 prev = NULL;
14076 mch_memmove(s + prevlen, buf + tolist, len);
14077 s[prevlen + len] = NUL;
14080 tolist = filtd + 1;
14082 li = listitem_alloc();
14083 if (li == NULL)
14085 vim_free(s);
14086 break;
14088 li->li_tv.v_type = VAR_STRING;
14089 li->li_tv.v_lock = 0;
14090 li->li_tv.vval.v_string = s;
14091 list_append(rettv->vval.v_list, li);
14093 if (++cnt >= maxline && maxline >= 0)
14094 break;
14095 if (readlen <= 0)
14096 break;
14098 else if (buf[filtd] == NUL)
14099 buf[filtd] = '\n';
14101 if (readlen <= 0)
14102 break;
14104 if (tolist == 0)
14106 /* "buf" is full, need to move text to an allocated buffer */
14107 if (prev == NULL)
14109 prev = vim_strnsave(buf, buflen);
14110 prevlen = buflen;
14112 else
14114 s = alloc((unsigned)(prevlen + buflen));
14115 if (s != NULL)
14117 mch_memmove(s, prev, prevlen);
14118 mch_memmove(s + prevlen, buf, buflen);
14119 vim_free(prev);
14120 prev = s;
14121 prevlen += buflen;
14124 filtd = 0;
14126 else
14128 mch_memmove(buf, buf + tolist, buflen - tolist);
14129 filtd -= tolist;
14134 * For a negative line count use only the lines at the end of the file,
14135 * free the rest.
14137 if (maxline < 0)
14138 while (cnt > -maxline)
14140 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
14141 --cnt;
14144 vim_free(prev);
14145 fclose(fd);
14148 #if defined(FEAT_RELTIME)
14149 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
14152 * Convert a List to proftime_T.
14153 * Return FAIL when there is something wrong.
14155 static int
14156 list2proftime(arg, tm)
14157 typval_T *arg;
14158 proftime_T *tm;
14160 long n1, n2;
14161 int error = FALSE;
14163 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
14164 || arg->vval.v_list->lv_len != 2)
14165 return FAIL;
14166 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14167 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14168 # ifdef WIN3264
14169 tm->HighPart = n1;
14170 tm->LowPart = n2;
14171 # else
14172 tm->tv_sec = n1;
14173 tm->tv_usec = n2;
14174 # endif
14175 return error ? FAIL : OK;
14177 #endif /* FEAT_RELTIME */
14180 * "reltime()" function
14182 static void
14183 f_reltime(argvars, rettv)
14184 typval_T *argvars;
14185 typval_T *rettv;
14187 #ifdef FEAT_RELTIME
14188 proftime_T res;
14189 proftime_T start;
14191 if (argvars[0].v_type == VAR_UNKNOWN)
14193 /* No arguments: get current time. */
14194 profile_start(&res);
14196 else if (argvars[1].v_type == VAR_UNKNOWN)
14198 if (list2proftime(&argvars[0], &res) == FAIL)
14199 return;
14200 profile_end(&res);
14202 else
14204 /* Two arguments: compute the difference. */
14205 if (list2proftime(&argvars[0], &start) == FAIL
14206 || list2proftime(&argvars[1], &res) == FAIL)
14207 return;
14208 profile_sub(&res, &start);
14211 if (rettv_list_alloc(rettv) == OK)
14213 long n1, n2;
14215 # ifdef WIN3264
14216 n1 = res.HighPart;
14217 n2 = res.LowPart;
14218 # else
14219 n1 = res.tv_sec;
14220 n2 = res.tv_usec;
14221 # endif
14222 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14223 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14225 #endif
14229 * "reltimestr()" function
14231 static void
14232 f_reltimestr(argvars, rettv)
14233 typval_T *argvars;
14234 typval_T *rettv;
14236 #ifdef FEAT_RELTIME
14237 proftime_T tm;
14238 #endif
14240 rettv->v_type = VAR_STRING;
14241 rettv->vval.v_string = NULL;
14242 #ifdef FEAT_RELTIME
14243 if (list2proftime(&argvars[0], &tm) == OK)
14244 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14245 #endif
14248 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14249 static void make_connection __ARGS((void));
14250 static int check_connection __ARGS((void));
14252 static void
14253 make_connection()
14255 if (X_DISPLAY == NULL
14256 # ifdef FEAT_GUI
14257 && !gui.in_use
14258 # endif
14261 x_force_connect = TRUE;
14262 setup_term_clip();
14263 x_force_connect = FALSE;
14267 static int
14268 check_connection()
14270 make_connection();
14271 if (X_DISPLAY == NULL)
14273 EMSG(_("E240: No connection to Vim server"));
14274 return FAIL;
14276 return OK;
14278 #endif
14280 #ifdef FEAT_CLIENTSERVER
14281 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14283 static void
14284 remote_common(argvars, rettv, expr)
14285 typval_T *argvars;
14286 typval_T *rettv;
14287 int expr;
14289 char_u *server_name;
14290 char_u *keys;
14291 char_u *r = NULL;
14292 char_u buf[NUMBUFLEN];
14293 # ifdef WIN32
14294 HWND w;
14295 # else
14296 Window w;
14297 # endif
14299 if (check_restricted() || check_secure())
14300 return;
14302 # ifdef FEAT_X11
14303 if (check_connection() == FAIL)
14304 return;
14305 # endif
14307 server_name = get_tv_string_chk(&argvars[0]);
14308 if (server_name == NULL)
14309 return; /* type error; errmsg already given */
14310 keys = get_tv_string_buf(&argvars[1], buf);
14311 # ifdef WIN32
14312 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14313 # else
14314 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14315 < 0)
14316 # endif
14318 if (r != NULL)
14319 EMSG(r); /* sending worked but evaluation failed */
14320 else
14321 EMSG2(_("E241: Unable to send to %s"), server_name);
14322 return;
14325 rettv->vval.v_string = r;
14327 if (argvars[2].v_type != VAR_UNKNOWN)
14329 dictitem_T v;
14330 char_u str[30];
14331 char_u *idvar;
14333 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14334 v.di_tv.v_type = VAR_STRING;
14335 v.di_tv.vval.v_string = vim_strsave(str);
14336 idvar = get_tv_string_chk(&argvars[2]);
14337 if (idvar != NULL)
14338 set_var(idvar, &v.di_tv, FALSE);
14339 vim_free(v.di_tv.vval.v_string);
14342 #endif
14345 * "remote_expr()" function
14347 static void
14348 f_remote_expr(argvars, rettv)
14349 typval_T *argvars UNUSED;
14350 typval_T *rettv;
14352 rettv->v_type = VAR_STRING;
14353 rettv->vval.v_string = NULL;
14354 #ifdef FEAT_CLIENTSERVER
14355 remote_common(argvars, rettv, TRUE);
14356 #endif
14360 * "remote_foreground()" function
14362 static void
14363 f_remote_foreground(argvars, rettv)
14364 typval_T *argvars UNUSED;
14365 typval_T *rettv UNUSED;
14367 #ifdef FEAT_CLIENTSERVER
14368 # ifdef WIN32
14369 /* On Win32 it's done in this application. */
14371 char_u *server_name = get_tv_string_chk(&argvars[0]);
14373 if (server_name != NULL)
14374 serverForeground(server_name);
14376 # else
14377 /* Send a foreground() expression to the server. */
14378 argvars[1].v_type = VAR_STRING;
14379 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14380 argvars[2].v_type = VAR_UNKNOWN;
14381 remote_common(argvars, rettv, TRUE);
14382 vim_free(argvars[1].vval.v_string);
14383 # endif
14384 #endif
14387 static void
14388 f_remote_peek(argvars, rettv)
14389 typval_T *argvars UNUSED;
14390 typval_T *rettv;
14392 #ifdef FEAT_CLIENTSERVER
14393 dictitem_T v;
14394 char_u *s = NULL;
14395 # ifdef WIN32
14396 long_u n = 0;
14397 # endif
14398 char_u *serverid;
14400 if (check_restricted() || check_secure())
14402 rettv->vval.v_number = -1;
14403 return;
14405 serverid = get_tv_string_chk(&argvars[0]);
14406 if (serverid == NULL)
14408 rettv->vval.v_number = -1;
14409 return; /* type error; errmsg already given */
14411 # ifdef WIN32
14412 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14413 if (n == 0)
14414 rettv->vval.v_number = -1;
14415 else
14417 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14418 rettv->vval.v_number = (s != NULL);
14420 # else
14421 if (check_connection() == FAIL)
14422 return;
14424 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14425 serverStrToWin(serverid), &s);
14426 # endif
14428 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14430 char_u *retvar;
14432 v.di_tv.v_type = VAR_STRING;
14433 v.di_tv.vval.v_string = vim_strsave(s);
14434 retvar = get_tv_string_chk(&argvars[1]);
14435 if (retvar != NULL)
14436 set_var(retvar, &v.di_tv, FALSE);
14437 vim_free(v.di_tv.vval.v_string);
14439 #else
14440 rettv->vval.v_number = -1;
14441 #endif
14444 static void
14445 f_remote_read(argvars, rettv)
14446 typval_T *argvars UNUSED;
14447 typval_T *rettv;
14449 char_u *r = NULL;
14451 #ifdef FEAT_CLIENTSERVER
14452 char_u *serverid = get_tv_string_chk(&argvars[0]);
14454 if (serverid != NULL && !check_restricted() && !check_secure())
14456 # ifdef WIN32
14457 /* The server's HWND is encoded in the 'id' parameter */
14458 long_u n = 0;
14460 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14461 if (n != 0)
14462 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14463 if (r == NULL)
14464 # else
14465 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14466 serverStrToWin(serverid), &r, FALSE) < 0)
14467 # endif
14468 EMSG(_("E277: Unable to read a server reply"));
14470 #endif
14471 rettv->v_type = VAR_STRING;
14472 rettv->vval.v_string = r;
14476 * "remote_send()" function
14478 static void
14479 f_remote_send(argvars, rettv)
14480 typval_T *argvars UNUSED;
14481 typval_T *rettv;
14483 rettv->v_type = VAR_STRING;
14484 rettv->vval.v_string = NULL;
14485 #ifdef FEAT_CLIENTSERVER
14486 remote_common(argvars, rettv, FALSE);
14487 #endif
14491 * "remove()" function
14493 static void
14494 f_remove(argvars, rettv)
14495 typval_T *argvars;
14496 typval_T *rettv;
14498 list_T *l;
14499 listitem_T *item, *item2;
14500 listitem_T *li;
14501 long idx;
14502 long end;
14503 char_u *key;
14504 dict_T *d;
14505 dictitem_T *di;
14507 if (argvars[0].v_type == VAR_DICT)
14509 if (argvars[2].v_type != VAR_UNKNOWN)
14510 EMSG2(_(e_toomanyarg), "remove()");
14511 else if ((d = argvars[0].vval.v_dict) != NULL
14512 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14514 key = get_tv_string_chk(&argvars[1]);
14515 if (key != NULL)
14517 di = dict_find(d, key, -1);
14518 if (di == NULL)
14519 EMSG2(_(e_dictkey), key);
14520 else
14522 *rettv = di->di_tv;
14523 init_tv(&di->di_tv);
14524 dictitem_remove(d, di);
14529 else if (argvars[0].v_type != VAR_LIST)
14530 EMSG2(_(e_listdictarg), "remove()");
14531 else if ((l = argvars[0].vval.v_list) != NULL
14532 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14534 int error = FALSE;
14536 idx = get_tv_number_chk(&argvars[1], &error);
14537 if (error)
14538 ; /* type error: do nothing, errmsg already given */
14539 else if ((item = list_find(l, idx)) == NULL)
14540 EMSGN(_(e_listidx), idx);
14541 else
14543 if (argvars[2].v_type == VAR_UNKNOWN)
14545 /* Remove one item, return its value. */
14546 list_remove(l, item, item);
14547 *rettv = item->li_tv;
14548 vim_free(item);
14550 else
14552 /* Remove range of items, return list with values. */
14553 end = get_tv_number_chk(&argvars[2], &error);
14554 if (error)
14555 ; /* type error: do nothing */
14556 else if ((item2 = list_find(l, end)) == NULL)
14557 EMSGN(_(e_listidx), end);
14558 else
14560 int cnt = 0;
14562 for (li = item; li != NULL; li = li->li_next)
14564 ++cnt;
14565 if (li == item2)
14566 break;
14568 if (li == NULL) /* didn't find "item2" after "item" */
14569 EMSG(_(e_invrange));
14570 else
14572 list_remove(l, item, item2);
14573 if (rettv_list_alloc(rettv) == OK)
14575 l = rettv->vval.v_list;
14576 l->lv_first = item;
14577 l->lv_last = item2;
14578 item->li_prev = NULL;
14579 item2->li_next = NULL;
14580 l->lv_len = cnt;
14590 * "rename({from}, {to})" function
14592 static void
14593 f_rename(argvars, rettv)
14594 typval_T *argvars;
14595 typval_T *rettv;
14597 char_u buf[NUMBUFLEN];
14599 if (check_restricted() || check_secure())
14600 rettv->vval.v_number = -1;
14601 else
14602 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14603 get_tv_string_buf(&argvars[1], buf));
14607 * "repeat()" function
14609 static void
14610 f_repeat(argvars, rettv)
14611 typval_T *argvars;
14612 typval_T *rettv;
14614 char_u *p;
14615 int n;
14616 int slen;
14617 int len;
14618 char_u *r;
14619 int i;
14621 n = get_tv_number(&argvars[1]);
14622 if (argvars[0].v_type == VAR_LIST)
14624 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14625 while (n-- > 0)
14626 if (list_extend(rettv->vval.v_list,
14627 argvars[0].vval.v_list, NULL) == FAIL)
14628 break;
14630 else
14632 p = get_tv_string(&argvars[0]);
14633 rettv->v_type = VAR_STRING;
14634 rettv->vval.v_string = NULL;
14636 slen = (int)STRLEN(p);
14637 len = slen * n;
14638 if (len <= 0)
14639 return;
14641 r = alloc(len + 1);
14642 if (r != NULL)
14644 for (i = 0; i < n; i++)
14645 mch_memmove(r + i * slen, p, (size_t)slen);
14646 r[len] = NUL;
14649 rettv->vval.v_string = r;
14654 * "resolve()" function
14656 static void
14657 f_resolve(argvars, rettv)
14658 typval_T *argvars;
14659 typval_T *rettv;
14661 char_u *p;
14663 p = get_tv_string(&argvars[0]);
14664 #ifdef FEAT_SHORTCUT
14666 char_u *v = NULL;
14668 v = mch_resolve_shortcut(p);
14669 if (v != NULL)
14670 rettv->vval.v_string = v;
14671 else
14672 rettv->vval.v_string = vim_strsave(p);
14674 #else
14675 # ifdef HAVE_READLINK
14677 char_u buf[MAXPATHL + 1];
14678 char_u *cpy;
14679 int len;
14680 char_u *remain = NULL;
14681 char_u *q;
14682 int is_relative_to_current = FALSE;
14683 int has_trailing_pathsep = FALSE;
14684 int limit = 100;
14686 p = vim_strsave(p);
14688 if (p[0] == '.' && (vim_ispathsep(p[1])
14689 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14690 is_relative_to_current = TRUE;
14692 len = STRLEN(p);
14693 if (len > 0 && after_pathsep(p, p + len))
14694 has_trailing_pathsep = TRUE;
14696 q = getnextcomp(p);
14697 if (*q != NUL)
14699 /* Separate the first path component in "p", and keep the
14700 * remainder (beginning with the path separator). */
14701 remain = vim_strsave(q - 1);
14702 q[-1] = NUL;
14705 for (;;)
14707 for (;;)
14709 len = readlink((char *)p, (char *)buf, MAXPATHL);
14710 if (len <= 0)
14711 break;
14712 buf[len] = NUL;
14714 if (limit-- == 0)
14716 vim_free(p);
14717 vim_free(remain);
14718 EMSG(_("E655: Too many symbolic links (cycle?)"));
14719 rettv->vval.v_string = NULL;
14720 goto fail;
14723 /* Ensure that the result will have a trailing path separator
14724 * if the argument has one. */
14725 if (remain == NULL && has_trailing_pathsep)
14726 add_pathsep(buf);
14728 /* Separate the first path component in the link value and
14729 * concatenate the remainders. */
14730 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14731 if (*q != NUL)
14733 if (remain == NULL)
14734 remain = vim_strsave(q - 1);
14735 else
14737 cpy = concat_str(q - 1, remain);
14738 if (cpy != NULL)
14740 vim_free(remain);
14741 remain = cpy;
14744 q[-1] = NUL;
14747 q = gettail(p);
14748 if (q > p && *q == NUL)
14750 /* Ignore trailing path separator. */
14751 q[-1] = NUL;
14752 q = gettail(p);
14754 if (q > p && !mch_isFullName(buf))
14756 /* symlink is relative to directory of argument */
14757 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14758 if (cpy != NULL)
14760 STRCPY(cpy, p);
14761 STRCPY(gettail(cpy), buf);
14762 vim_free(p);
14763 p = cpy;
14766 else
14768 vim_free(p);
14769 p = vim_strsave(buf);
14773 if (remain == NULL)
14774 break;
14776 /* Append the first path component of "remain" to "p". */
14777 q = getnextcomp(remain + 1);
14778 len = q - remain - (*q != NUL);
14779 cpy = vim_strnsave(p, STRLEN(p) + len);
14780 if (cpy != NULL)
14782 STRNCAT(cpy, remain, len);
14783 vim_free(p);
14784 p = cpy;
14786 /* Shorten "remain". */
14787 if (*q != NUL)
14788 STRMOVE(remain, q - 1);
14789 else
14791 vim_free(remain);
14792 remain = NULL;
14796 /* If the result is a relative path name, make it explicitly relative to
14797 * the current directory if and only if the argument had this form. */
14798 if (!vim_ispathsep(*p))
14800 if (is_relative_to_current
14801 && *p != NUL
14802 && !(p[0] == '.'
14803 && (p[1] == NUL
14804 || vim_ispathsep(p[1])
14805 || (p[1] == '.'
14806 && (p[2] == NUL
14807 || vim_ispathsep(p[2]))))))
14809 /* Prepend "./". */
14810 cpy = concat_str((char_u *)"./", p);
14811 if (cpy != NULL)
14813 vim_free(p);
14814 p = cpy;
14817 else if (!is_relative_to_current)
14819 /* Strip leading "./". */
14820 q = p;
14821 while (q[0] == '.' && vim_ispathsep(q[1]))
14822 q += 2;
14823 if (q > p)
14824 STRMOVE(p, p + 2);
14828 /* Ensure that the result will have no trailing path separator
14829 * if the argument had none. But keep "/" or "//". */
14830 if (!has_trailing_pathsep)
14832 q = p + STRLEN(p);
14833 if (after_pathsep(p, q))
14834 *gettail_sep(p) = NUL;
14837 rettv->vval.v_string = p;
14839 # else
14840 rettv->vval.v_string = vim_strsave(p);
14841 # endif
14842 #endif
14844 simplify_filename(rettv->vval.v_string);
14846 #ifdef HAVE_READLINK
14847 fail:
14848 #endif
14849 rettv->v_type = VAR_STRING;
14853 * "reverse({list})" function
14855 static void
14856 f_reverse(argvars, rettv)
14857 typval_T *argvars;
14858 typval_T *rettv;
14860 list_T *l;
14861 listitem_T *li, *ni;
14863 if (argvars[0].v_type != VAR_LIST)
14864 EMSG2(_(e_listarg), "reverse()");
14865 else if ((l = argvars[0].vval.v_list) != NULL
14866 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14868 li = l->lv_last;
14869 l->lv_first = l->lv_last = NULL;
14870 l->lv_len = 0;
14871 while (li != NULL)
14873 ni = li->li_prev;
14874 list_append(l, li);
14875 li = ni;
14877 rettv->vval.v_list = l;
14878 rettv->v_type = VAR_LIST;
14879 ++l->lv_refcount;
14880 l->lv_idx = l->lv_len - l->lv_idx - 1;
14884 #define SP_NOMOVE 0x01 /* don't move cursor */
14885 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14886 #define SP_RETCOUNT 0x04 /* return matchcount */
14887 #define SP_SETPCMARK 0x08 /* set previous context mark */
14888 #define SP_START 0x10 /* accept match at start position */
14889 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14890 #define SP_END 0x40 /* leave cursor at end of match */
14892 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14895 * Get flags for a search function.
14896 * Possibly sets "p_ws".
14897 * Returns BACKWARD, FORWARD or zero (for an error).
14899 static int
14900 get_search_arg(varp, flagsp)
14901 typval_T *varp;
14902 int *flagsp;
14904 int dir = FORWARD;
14905 char_u *flags;
14906 char_u nbuf[NUMBUFLEN];
14907 int mask;
14909 if (varp->v_type != VAR_UNKNOWN)
14911 flags = get_tv_string_buf_chk(varp, nbuf);
14912 if (flags == NULL)
14913 return 0; /* type error; errmsg already given */
14914 while (*flags != NUL)
14916 switch (*flags)
14918 case 'b': dir = BACKWARD; break;
14919 case 'w': p_ws = TRUE; break;
14920 case 'W': p_ws = FALSE; break;
14921 default: mask = 0;
14922 if (flagsp != NULL)
14923 switch (*flags)
14925 case 'c': mask = SP_START; break;
14926 case 'e': mask = SP_END; break;
14927 case 'm': mask = SP_RETCOUNT; break;
14928 case 'n': mask = SP_NOMOVE; break;
14929 case 'p': mask = SP_SUBPAT; break;
14930 case 'r': mask = SP_REPEAT; break;
14931 case 's': mask = SP_SETPCMARK; break;
14933 if (mask == 0)
14935 EMSG2(_(e_invarg2), flags);
14936 dir = 0;
14938 else
14939 *flagsp |= mask;
14941 if (dir == 0)
14942 break;
14943 ++flags;
14946 return dir;
14950 * Shared by search() and searchpos() functions
14952 static int
14953 search_cmn(argvars, match_pos, flagsp)
14954 typval_T *argvars;
14955 pos_T *match_pos;
14956 int *flagsp;
14958 int flags;
14959 char_u *pat;
14960 pos_T pos;
14961 pos_T save_cursor;
14962 int save_p_ws = p_ws;
14963 int dir;
14964 int retval = 0; /* default: FAIL */
14965 long lnum_stop = 0;
14966 proftime_T tm;
14967 #ifdef FEAT_RELTIME
14968 long time_limit = 0;
14969 #endif
14970 int options = SEARCH_KEEP;
14971 int subpatnum;
14973 pat = get_tv_string(&argvars[0]);
14974 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14975 if (dir == 0)
14976 goto theend;
14977 flags = *flagsp;
14978 if (flags & SP_START)
14979 options |= SEARCH_START;
14980 if (flags & SP_END)
14981 options |= SEARCH_END;
14983 /* Optional arguments: line number to stop searching and timeout. */
14984 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14986 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14987 if (lnum_stop < 0)
14988 goto theend;
14989 #ifdef FEAT_RELTIME
14990 if (argvars[3].v_type != VAR_UNKNOWN)
14992 time_limit = get_tv_number_chk(&argvars[3], NULL);
14993 if (time_limit < 0)
14994 goto theend;
14996 #endif
14999 #ifdef FEAT_RELTIME
15000 /* Set the time limit, if there is one. */
15001 profile_setlimit(time_limit, &tm);
15002 #endif
15005 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
15006 * Check to make sure only those flags are set.
15007 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
15008 * flags cannot be set. Check for that condition also.
15010 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
15011 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15013 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
15014 goto theend;
15017 pos = save_cursor = curwin->w_cursor;
15018 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15019 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
15020 if (subpatnum != FAIL)
15022 if (flags & SP_SUBPAT)
15023 retval = subpatnum;
15024 else
15025 retval = pos.lnum;
15026 if (flags & SP_SETPCMARK)
15027 setpcmark();
15028 curwin->w_cursor = pos;
15029 if (match_pos != NULL)
15031 /* Store the match cursor position */
15032 match_pos->lnum = pos.lnum;
15033 match_pos->col = pos.col + 1;
15035 /* "/$" will put the cursor after the end of the line, may need to
15036 * correct that here */
15037 check_cursor();
15040 /* If 'n' flag is used: restore cursor position. */
15041 if (flags & SP_NOMOVE)
15042 curwin->w_cursor = save_cursor;
15043 else
15044 curwin->w_set_curswant = TRUE;
15045 theend:
15046 p_ws = save_p_ws;
15048 return retval;
15051 #ifdef FEAT_FLOAT
15053 * "round({float})" function
15055 static void
15056 f_round(argvars, rettv)
15057 typval_T *argvars;
15058 typval_T *rettv;
15060 float_T f;
15062 rettv->v_type = VAR_FLOAT;
15063 if (get_float_arg(argvars, &f) == OK)
15064 /* round() is not in C90, use ceil() or floor() instead. */
15065 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
15066 else
15067 rettv->vval.v_float = 0.0;
15069 #endif
15072 * "search()" function
15074 static void
15075 f_search(argvars, rettv)
15076 typval_T *argvars;
15077 typval_T *rettv;
15079 int flags = 0;
15081 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
15085 * "searchdecl()" function
15087 static void
15088 f_searchdecl(argvars, rettv)
15089 typval_T *argvars;
15090 typval_T *rettv;
15092 int locally = 1;
15093 int thisblock = 0;
15094 int error = FALSE;
15095 char_u *name;
15097 rettv->vval.v_number = 1; /* default: FAIL */
15099 name = get_tv_string_chk(&argvars[0]);
15100 if (argvars[1].v_type != VAR_UNKNOWN)
15102 locally = get_tv_number_chk(&argvars[1], &error) == 0;
15103 if (!error && argvars[2].v_type != VAR_UNKNOWN)
15104 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
15106 if (!error && name != NULL)
15107 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
15108 locally, thisblock, SEARCH_KEEP) == FAIL;
15112 * Used by searchpair() and searchpairpos()
15114 static int
15115 searchpair_cmn(argvars, match_pos)
15116 typval_T *argvars;
15117 pos_T *match_pos;
15119 char_u *spat, *mpat, *epat;
15120 char_u *skip;
15121 int save_p_ws = p_ws;
15122 int dir;
15123 int flags = 0;
15124 char_u nbuf1[NUMBUFLEN];
15125 char_u nbuf2[NUMBUFLEN];
15126 char_u nbuf3[NUMBUFLEN];
15127 int retval = 0; /* default: FAIL */
15128 long lnum_stop = 0;
15129 long time_limit = 0;
15131 /* Get the three pattern arguments: start, middle, end. */
15132 spat = get_tv_string_chk(&argvars[0]);
15133 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
15134 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
15135 if (spat == NULL || mpat == NULL || epat == NULL)
15136 goto theend; /* type error */
15138 /* Handle the optional fourth argument: flags */
15139 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
15140 if (dir == 0)
15141 goto theend;
15143 /* Don't accept SP_END or SP_SUBPAT.
15144 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
15146 if ((flags & (SP_END | SP_SUBPAT)) != 0
15147 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15149 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
15150 goto theend;
15153 /* Using 'r' implies 'W', otherwise it doesn't work. */
15154 if (flags & SP_REPEAT)
15155 p_ws = FALSE;
15157 /* Optional fifth argument: skip expression */
15158 if (argvars[3].v_type == VAR_UNKNOWN
15159 || argvars[4].v_type == VAR_UNKNOWN)
15160 skip = (char_u *)"";
15161 else
15163 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15164 if (argvars[5].v_type != VAR_UNKNOWN)
15166 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15167 if (lnum_stop < 0)
15168 goto theend;
15169 #ifdef FEAT_RELTIME
15170 if (argvars[6].v_type != VAR_UNKNOWN)
15172 time_limit = get_tv_number_chk(&argvars[6], NULL);
15173 if (time_limit < 0)
15174 goto theend;
15176 #endif
15179 if (skip == NULL)
15180 goto theend; /* type error */
15182 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15183 match_pos, lnum_stop, time_limit);
15185 theend:
15186 p_ws = save_p_ws;
15188 return retval;
15192 * "searchpair()" function
15194 static void
15195 f_searchpair(argvars, rettv)
15196 typval_T *argvars;
15197 typval_T *rettv;
15199 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15203 * "searchpairpos()" function
15205 static void
15206 f_searchpairpos(argvars, rettv)
15207 typval_T *argvars;
15208 typval_T *rettv;
15210 pos_T match_pos;
15211 int lnum = 0;
15212 int col = 0;
15214 if (rettv_list_alloc(rettv) == FAIL)
15215 return;
15217 if (searchpair_cmn(argvars, &match_pos) > 0)
15219 lnum = match_pos.lnum;
15220 col = match_pos.col;
15223 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15224 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15228 * Search for a start/middle/end thing.
15229 * Used by searchpair(), see its documentation for the details.
15230 * Returns 0 or -1 for no match,
15232 long
15233 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15234 lnum_stop, time_limit)
15235 char_u *spat; /* start pattern */
15236 char_u *mpat; /* middle pattern */
15237 char_u *epat; /* end pattern */
15238 int dir; /* BACKWARD or FORWARD */
15239 char_u *skip; /* skip expression */
15240 int flags; /* SP_SETPCMARK and other SP_ values */
15241 pos_T *match_pos;
15242 linenr_T lnum_stop; /* stop at this line if not zero */
15243 long time_limit; /* stop after this many msec */
15245 char_u *save_cpo;
15246 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15247 long retval = 0;
15248 pos_T pos;
15249 pos_T firstpos;
15250 pos_T foundpos;
15251 pos_T save_cursor;
15252 pos_T save_pos;
15253 int n;
15254 int r;
15255 int nest = 1;
15256 int err;
15257 int options = SEARCH_KEEP;
15258 proftime_T tm;
15260 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15261 save_cpo = p_cpo;
15262 p_cpo = empty_option;
15264 #ifdef FEAT_RELTIME
15265 /* Set the time limit, if there is one. */
15266 profile_setlimit(time_limit, &tm);
15267 #endif
15269 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15270 * start/middle/end (pat3, for the top pair). */
15271 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15272 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15273 if (pat2 == NULL || pat3 == NULL)
15274 goto theend;
15275 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15276 if (*mpat == NUL)
15277 STRCPY(pat3, pat2);
15278 else
15279 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15280 spat, epat, mpat);
15281 if (flags & SP_START)
15282 options |= SEARCH_START;
15284 save_cursor = curwin->w_cursor;
15285 pos = curwin->w_cursor;
15286 clearpos(&firstpos);
15287 clearpos(&foundpos);
15288 pat = pat3;
15289 for (;;)
15291 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15292 options, RE_SEARCH, lnum_stop, &tm);
15293 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15294 /* didn't find it or found the first match again: FAIL */
15295 break;
15297 if (firstpos.lnum == 0)
15298 firstpos = pos;
15299 if (equalpos(pos, foundpos))
15301 /* Found the same position again. Can happen with a pattern that
15302 * has "\zs" at the end and searching backwards. Advance one
15303 * character and try again. */
15304 if (dir == BACKWARD)
15305 decl(&pos);
15306 else
15307 incl(&pos);
15309 foundpos = pos;
15311 /* clear the start flag to avoid getting stuck here */
15312 options &= ~SEARCH_START;
15314 /* If the skip pattern matches, ignore this match. */
15315 if (*skip != NUL)
15317 save_pos = curwin->w_cursor;
15318 curwin->w_cursor = pos;
15319 r = eval_to_bool(skip, &err, NULL, FALSE);
15320 curwin->w_cursor = save_pos;
15321 if (err)
15323 /* Evaluating {skip} caused an error, break here. */
15324 curwin->w_cursor = save_cursor;
15325 retval = -1;
15326 break;
15328 if (r)
15329 continue;
15332 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15334 /* Found end when searching backwards or start when searching
15335 * forward: nested pair. */
15336 ++nest;
15337 pat = pat2; /* nested, don't search for middle */
15339 else
15341 /* Found end when searching forward or start when searching
15342 * backward: end of (nested) pair; or found middle in outer pair. */
15343 if (--nest == 1)
15344 pat = pat3; /* outer level, search for middle */
15347 if (nest == 0)
15349 /* Found the match: return matchcount or line number. */
15350 if (flags & SP_RETCOUNT)
15351 ++retval;
15352 else
15353 retval = pos.lnum;
15354 if (flags & SP_SETPCMARK)
15355 setpcmark();
15356 curwin->w_cursor = pos;
15357 if (!(flags & SP_REPEAT))
15358 break;
15359 nest = 1; /* search for next unmatched */
15363 if (match_pos != NULL)
15365 /* Store the match cursor position */
15366 match_pos->lnum = curwin->w_cursor.lnum;
15367 match_pos->col = curwin->w_cursor.col + 1;
15370 /* If 'n' flag is used or search failed: restore cursor position. */
15371 if ((flags & SP_NOMOVE) || retval == 0)
15372 curwin->w_cursor = save_cursor;
15374 theend:
15375 vim_free(pat2);
15376 vim_free(pat3);
15377 if (p_cpo == empty_option)
15378 p_cpo = save_cpo;
15379 else
15380 /* Darn, evaluating the {skip} expression changed the value. */
15381 free_string_option(save_cpo);
15383 return retval;
15387 * "searchpos()" function
15389 static void
15390 f_searchpos(argvars, rettv)
15391 typval_T *argvars;
15392 typval_T *rettv;
15394 pos_T match_pos;
15395 int lnum = 0;
15396 int col = 0;
15397 int n;
15398 int flags = 0;
15400 if (rettv_list_alloc(rettv) == FAIL)
15401 return;
15403 n = search_cmn(argvars, &match_pos, &flags);
15404 if (n > 0)
15406 lnum = match_pos.lnum;
15407 col = match_pos.col;
15410 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15411 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15412 if (flags & SP_SUBPAT)
15413 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15417 static void
15418 f_server2client(argvars, rettv)
15419 typval_T *argvars UNUSED;
15420 typval_T *rettv;
15422 #ifdef FEAT_CLIENTSERVER
15423 char_u buf[NUMBUFLEN];
15424 char_u *server = get_tv_string_chk(&argvars[0]);
15425 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15427 rettv->vval.v_number = -1;
15428 if (server == NULL || reply == NULL)
15429 return;
15430 if (check_restricted() || check_secure())
15431 return;
15432 # ifdef FEAT_X11
15433 if (check_connection() == FAIL)
15434 return;
15435 # endif
15437 if (serverSendReply(server, reply) < 0)
15439 EMSG(_("E258: Unable to send to client"));
15440 return;
15442 rettv->vval.v_number = 0;
15443 #else
15444 rettv->vval.v_number = -1;
15445 #endif
15448 static void
15449 f_serverlist(argvars, rettv)
15450 typval_T *argvars UNUSED;
15451 typval_T *rettv;
15453 char_u *r = NULL;
15455 #ifdef FEAT_CLIENTSERVER
15456 # ifdef WIN32
15457 r = serverGetVimNames();
15458 # else
15459 make_connection();
15460 if (X_DISPLAY != NULL)
15461 r = serverGetVimNames(X_DISPLAY);
15462 # endif
15463 #endif
15464 rettv->v_type = VAR_STRING;
15465 rettv->vval.v_string = r;
15469 * "setbufvar()" function
15471 static void
15472 f_setbufvar(argvars, rettv)
15473 typval_T *argvars;
15474 typval_T *rettv UNUSED;
15476 buf_T *buf;
15477 aco_save_T aco;
15478 char_u *varname, *bufvarname;
15479 typval_T *varp;
15480 char_u nbuf[NUMBUFLEN];
15482 if (check_restricted() || check_secure())
15483 return;
15484 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15485 varname = get_tv_string_chk(&argvars[1]);
15486 buf = get_buf_tv(&argvars[0]);
15487 varp = &argvars[2];
15489 if (buf != NULL && varname != NULL && varp != NULL)
15491 /* set curbuf to be our buf, temporarily */
15492 aucmd_prepbuf(&aco, buf);
15494 if (*varname == '&')
15496 long numval;
15497 char_u *strval;
15498 int error = FALSE;
15500 ++varname;
15501 numval = get_tv_number_chk(varp, &error);
15502 strval = get_tv_string_buf_chk(varp, nbuf);
15503 if (!error && strval != NULL)
15504 set_option_value(varname, numval, strval, OPT_LOCAL);
15506 else
15508 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15509 if (bufvarname != NULL)
15511 STRCPY(bufvarname, "b:");
15512 STRCPY(bufvarname + 2, varname);
15513 set_var(bufvarname, varp, TRUE);
15514 vim_free(bufvarname);
15518 /* reset notion of buffer */
15519 aucmd_restbuf(&aco);
15524 * "setcmdpos()" function
15526 static void
15527 f_setcmdpos(argvars, rettv)
15528 typval_T *argvars;
15529 typval_T *rettv;
15531 int pos = (int)get_tv_number(&argvars[0]) - 1;
15533 if (pos >= 0)
15534 rettv->vval.v_number = set_cmdline_pos(pos);
15538 * "setline()" function
15540 static void
15541 f_setline(argvars, rettv)
15542 typval_T *argvars;
15543 typval_T *rettv;
15545 linenr_T lnum;
15546 char_u *line = NULL;
15547 list_T *l = NULL;
15548 listitem_T *li = NULL;
15549 long added = 0;
15550 linenr_T lcount = curbuf->b_ml.ml_line_count;
15552 lnum = get_tv_lnum(&argvars[0]);
15553 if (argvars[1].v_type == VAR_LIST)
15555 l = argvars[1].vval.v_list;
15556 li = l->lv_first;
15558 else
15559 line = get_tv_string_chk(&argvars[1]);
15561 /* default result is zero == OK */
15562 for (;;)
15564 if (l != NULL)
15566 /* list argument, get next string */
15567 if (li == NULL)
15568 break;
15569 line = get_tv_string_chk(&li->li_tv);
15570 li = li->li_next;
15573 rettv->vval.v_number = 1; /* FAIL */
15574 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15575 break;
15576 if (lnum <= curbuf->b_ml.ml_line_count)
15578 /* existing line, replace it */
15579 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15581 changed_bytes(lnum, 0);
15582 if (lnum == curwin->w_cursor.lnum)
15583 check_cursor_col();
15584 rettv->vval.v_number = 0; /* OK */
15587 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15589 /* lnum is one past the last line, append the line */
15590 ++added;
15591 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15592 rettv->vval.v_number = 0; /* OK */
15595 if (l == NULL) /* only one string argument */
15596 break;
15597 ++lnum;
15600 if (added > 0)
15601 appended_lines_mark(lcount, added);
15604 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15607 * Used by "setqflist()" and "setloclist()" functions
15609 static void
15610 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15611 win_T *wp UNUSED;
15612 typval_T *list_arg UNUSED;
15613 typval_T *action_arg UNUSED;
15614 typval_T *rettv;
15616 #ifdef FEAT_QUICKFIX
15617 char_u *act;
15618 int action = ' ';
15619 #endif
15621 rettv->vval.v_number = -1;
15623 #ifdef FEAT_QUICKFIX
15624 if (list_arg->v_type != VAR_LIST)
15625 EMSG(_(e_listreq));
15626 else
15628 list_T *l = list_arg->vval.v_list;
15630 if (action_arg->v_type == VAR_STRING)
15632 act = get_tv_string_chk(action_arg);
15633 if (act == NULL)
15634 return; /* type error; errmsg already given */
15635 if (*act == 'a' || *act == 'r')
15636 action = *act;
15639 if (l != NULL && set_errorlist(wp, l, action) == OK)
15640 rettv->vval.v_number = 0;
15642 #endif
15646 * "setloclist()" function
15648 static void
15649 f_setloclist(argvars, rettv)
15650 typval_T *argvars;
15651 typval_T *rettv;
15653 win_T *win;
15655 rettv->vval.v_number = -1;
15657 win = find_win_by_nr(&argvars[0], NULL);
15658 if (win != NULL)
15659 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15663 * "setmatches()" function
15665 static void
15666 f_setmatches(argvars, rettv)
15667 typval_T *argvars;
15668 typval_T *rettv;
15670 #ifdef FEAT_SEARCH_EXTRA
15671 list_T *l;
15672 listitem_T *li;
15673 dict_T *d;
15675 rettv->vval.v_number = -1;
15676 if (argvars[0].v_type != VAR_LIST)
15678 EMSG(_(e_listreq));
15679 return;
15681 if ((l = argvars[0].vval.v_list) != NULL)
15684 /* To some extent make sure that we are dealing with a list from
15685 * "getmatches()". */
15686 li = l->lv_first;
15687 while (li != NULL)
15689 if (li->li_tv.v_type != VAR_DICT
15690 || (d = li->li_tv.vval.v_dict) == NULL)
15692 EMSG(_(e_invarg));
15693 return;
15695 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15696 && dict_find(d, (char_u *)"pattern", -1) != NULL
15697 && dict_find(d, (char_u *)"priority", -1) != NULL
15698 && dict_find(d, (char_u *)"id", -1) != NULL))
15700 EMSG(_(e_invarg));
15701 return;
15703 li = li->li_next;
15706 clear_matches(curwin);
15707 li = l->lv_first;
15708 while (li != NULL)
15710 d = li->li_tv.vval.v_dict;
15711 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15712 get_dict_string(d, (char_u *)"pattern", FALSE),
15713 (int)get_dict_number(d, (char_u *)"priority"),
15714 (int)get_dict_number(d, (char_u *)"id"));
15715 li = li->li_next;
15717 rettv->vval.v_number = 0;
15719 #endif
15723 * "setpos()" function
15725 static void
15726 f_setpos(argvars, rettv)
15727 typval_T *argvars;
15728 typval_T *rettv;
15730 pos_T pos;
15731 int fnum;
15732 char_u *name;
15734 rettv->vval.v_number = -1;
15735 name = get_tv_string_chk(argvars);
15736 if (name != NULL)
15738 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15740 --pos.col;
15741 if (name[0] == '.' && name[1] == NUL)
15743 /* set cursor */
15744 if (fnum == curbuf->b_fnum)
15746 curwin->w_cursor = pos;
15747 check_cursor();
15748 rettv->vval.v_number = 0;
15750 else
15751 EMSG(_(e_invarg));
15753 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15755 /* set mark */
15756 if (setmark_pos(name[1], &pos, fnum) == OK)
15757 rettv->vval.v_number = 0;
15759 else
15760 EMSG(_(e_invarg));
15766 * "setqflist()" function
15768 static void
15769 f_setqflist(argvars, rettv)
15770 typval_T *argvars;
15771 typval_T *rettv;
15773 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15777 * "setreg()" function
15779 static void
15780 f_setreg(argvars, rettv)
15781 typval_T *argvars;
15782 typval_T *rettv;
15784 int regname;
15785 char_u *strregname;
15786 char_u *stropt;
15787 char_u *strval;
15788 int append;
15789 char_u yank_type;
15790 long block_len;
15792 block_len = -1;
15793 yank_type = MAUTO;
15794 append = FALSE;
15796 strregname = get_tv_string_chk(argvars);
15797 rettv->vval.v_number = 1; /* FAIL is default */
15799 if (strregname == NULL)
15800 return; /* type error; errmsg already given */
15801 regname = *strregname;
15802 if (regname == 0 || regname == '@')
15803 regname = '"';
15804 else if (regname == '=')
15805 return;
15807 if (argvars[2].v_type != VAR_UNKNOWN)
15809 stropt = get_tv_string_chk(&argvars[2]);
15810 if (stropt == NULL)
15811 return; /* type error */
15812 for (; *stropt != NUL; ++stropt)
15813 switch (*stropt)
15815 case 'a': case 'A': /* append */
15816 append = TRUE;
15817 break;
15818 case 'v': case 'c': /* character-wise selection */
15819 yank_type = MCHAR;
15820 break;
15821 case 'V': case 'l': /* line-wise selection */
15822 yank_type = MLINE;
15823 break;
15824 #ifdef FEAT_VISUAL
15825 case 'b': case Ctrl_V: /* block-wise selection */
15826 yank_type = MBLOCK;
15827 if (VIM_ISDIGIT(stropt[1]))
15829 ++stropt;
15830 block_len = getdigits(&stropt) - 1;
15831 --stropt;
15833 break;
15834 #endif
15838 strval = get_tv_string_chk(&argvars[1]);
15839 if (strval != NULL)
15840 write_reg_contents_ex(regname, strval, -1,
15841 append, yank_type, block_len);
15842 rettv->vval.v_number = 0;
15846 * "settabwinvar()" function
15848 static void
15849 f_settabwinvar(argvars, rettv)
15850 typval_T *argvars;
15851 typval_T *rettv;
15853 setwinvar(argvars, rettv, 1);
15857 * "setwinvar()" function
15859 static void
15860 f_setwinvar(argvars, rettv)
15861 typval_T *argvars;
15862 typval_T *rettv;
15864 setwinvar(argvars, rettv, 0);
15868 * "setwinvar()" and "settabwinvar()" functions
15870 static void
15871 setwinvar(argvars, rettv, off)
15872 typval_T *argvars;
15873 typval_T *rettv UNUSED;
15874 int off;
15876 win_T *win;
15877 #ifdef FEAT_WINDOWS
15878 win_T *save_curwin;
15879 tabpage_T *save_curtab;
15880 #endif
15881 char_u *varname, *winvarname;
15882 typval_T *varp;
15883 char_u nbuf[NUMBUFLEN];
15884 tabpage_T *tp;
15886 if (check_restricted() || check_secure())
15887 return;
15889 #ifdef FEAT_WINDOWS
15890 if (off == 1)
15891 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15892 else
15893 tp = curtab;
15894 #endif
15895 win = find_win_by_nr(&argvars[off], tp);
15896 varname = get_tv_string_chk(&argvars[off + 1]);
15897 varp = &argvars[off + 2];
15899 if (win != NULL && varname != NULL && varp != NULL)
15901 #ifdef FEAT_WINDOWS
15902 /* set curwin to be our win, temporarily */
15903 save_curwin = curwin;
15904 save_curtab = curtab;
15905 goto_tabpage_tp(tp);
15906 if (!win_valid(win))
15907 return;
15908 curwin = win;
15909 curbuf = curwin->w_buffer;
15910 #endif
15912 if (*varname == '&')
15914 long numval;
15915 char_u *strval;
15916 int error = FALSE;
15918 ++varname;
15919 numval = get_tv_number_chk(varp, &error);
15920 strval = get_tv_string_buf_chk(varp, nbuf);
15921 if (!error && strval != NULL)
15922 set_option_value(varname, numval, strval, OPT_LOCAL);
15924 else
15926 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15927 if (winvarname != NULL)
15929 STRCPY(winvarname, "w:");
15930 STRCPY(winvarname + 2, varname);
15931 set_var(winvarname, varp, TRUE);
15932 vim_free(winvarname);
15936 #ifdef FEAT_WINDOWS
15937 /* Restore current tabpage and window, if still valid (autocomands can
15938 * make them invalid). */
15939 if (valid_tabpage(save_curtab))
15940 goto_tabpage_tp(save_curtab);
15941 if (win_valid(save_curwin))
15943 curwin = save_curwin;
15944 curbuf = curwin->w_buffer;
15946 #endif
15951 * "shellescape({string})" function
15953 static void
15954 f_shellescape(argvars, rettv)
15955 typval_T *argvars;
15956 typval_T *rettv;
15958 rettv->vval.v_string = vim_strsave_shellescape(
15959 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15960 rettv->v_type = VAR_STRING;
15964 * "simplify()" function
15966 static void
15967 f_simplify(argvars, rettv)
15968 typval_T *argvars;
15969 typval_T *rettv;
15971 char_u *p;
15973 p = get_tv_string(&argvars[0]);
15974 rettv->vval.v_string = vim_strsave(p);
15975 simplify_filename(rettv->vval.v_string); /* simplify in place */
15976 rettv->v_type = VAR_STRING;
15979 #ifdef FEAT_FLOAT
15981 * "sin()" function
15983 static void
15984 f_sin(argvars, rettv)
15985 typval_T *argvars;
15986 typval_T *rettv;
15988 float_T f;
15990 rettv->v_type = VAR_FLOAT;
15991 if (get_float_arg(argvars, &f) == OK)
15992 rettv->vval.v_float = sin(f);
15993 else
15994 rettv->vval.v_float = 0.0;
15996 #endif
15998 static int
15999 #ifdef __BORLANDC__
16000 _RTLENTRYF
16001 #endif
16002 item_compare __ARGS((const void *s1, const void *s2));
16003 static int
16004 #ifdef __BORLANDC__
16005 _RTLENTRYF
16006 #endif
16007 item_compare2 __ARGS((const void *s1, const void *s2));
16009 static int item_compare_ic;
16010 static char_u *item_compare_func;
16011 static int item_compare_func_err;
16012 #define ITEM_COMPARE_FAIL 999
16015 * Compare functions for f_sort() below.
16017 static int
16018 #ifdef __BORLANDC__
16019 _RTLENTRYF
16020 #endif
16021 item_compare(s1, s2)
16022 const void *s1;
16023 const void *s2;
16025 char_u *p1, *p2;
16026 char_u *tofree1, *tofree2;
16027 int res;
16028 char_u numbuf1[NUMBUFLEN];
16029 char_u numbuf2[NUMBUFLEN];
16031 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
16032 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
16033 if (p1 == NULL)
16034 p1 = (char_u *)"";
16035 if (p2 == NULL)
16036 p2 = (char_u *)"";
16037 if (item_compare_ic)
16038 res = STRICMP(p1, p2);
16039 else
16040 res = STRCMP(p1, p2);
16041 vim_free(tofree1);
16042 vim_free(tofree2);
16043 return res;
16046 static int
16047 #ifdef __BORLANDC__
16048 _RTLENTRYF
16049 #endif
16050 item_compare2(s1, s2)
16051 const void *s1;
16052 const void *s2;
16054 int res;
16055 typval_T rettv;
16056 typval_T argv[3];
16057 int dummy;
16059 /* shortcut after failure in previous call; compare all items equal */
16060 if (item_compare_func_err)
16061 return 0;
16063 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
16064 * in the copy without changing the original list items. */
16065 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
16066 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
16068 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
16069 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
16070 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
16071 clear_tv(&argv[0]);
16072 clear_tv(&argv[1]);
16074 if (res == FAIL)
16075 res = ITEM_COMPARE_FAIL;
16076 else
16077 res = get_tv_number_chk(&rettv, &item_compare_func_err);
16078 if (item_compare_func_err)
16079 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
16080 clear_tv(&rettv);
16081 return res;
16085 * "sort({list})" function
16087 static void
16088 f_sort(argvars, rettv)
16089 typval_T *argvars;
16090 typval_T *rettv;
16092 list_T *l;
16093 listitem_T *li;
16094 listitem_T **ptrs;
16095 long len;
16096 long i;
16098 if (argvars[0].v_type != VAR_LIST)
16099 EMSG2(_(e_listarg), "sort()");
16100 else
16102 l = argvars[0].vval.v_list;
16103 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
16104 return;
16105 rettv->vval.v_list = l;
16106 rettv->v_type = VAR_LIST;
16107 ++l->lv_refcount;
16109 len = list_len(l);
16110 if (len <= 1)
16111 return; /* short list sorts pretty quickly */
16113 item_compare_ic = FALSE;
16114 item_compare_func = NULL;
16115 if (argvars[1].v_type != VAR_UNKNOWN)
16117 if (argvars[1].v_type == VAR_FUNC)
16118 item_compare_func = argvars[1].vval.v_string;
16119 else
16121 int error = FALSE;
16123 i = get_tv_number_chk(&argvars[1], &error);
16124 if (error)
16125 return; /* type error; errmsg already given */
16126 if (i == 1)
16127 item_compare_ic = TRUE;
16128 else
16129 item_compare_func = get_tv_string(&argvars[1]);
16133 /* Make an array with each entry pointing to an item in the List. */
16134 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
16135 if (ptrs == NULL)
16136 return;
16137 i = 0;
16138 for (li = l->lv_first; li != NULL; li = li->li_next)
16139 ptrs[i++] = li;
16141 item_compare_func_err = FALSE;
16142 /* test the compare function */
16143 if (item_compare_func != NULL
16144 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
16145 == ITEM_COMPARE_FAIL)
16146 EMSG(_("E702: Sort compare function failed"));
16147 else
16149 /* Sort the array with item pointers. */
16150 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
16151 item_compare_func == NULL ? item_compare : item_compare2);
16153 if (!item_compare_func_err)
16155 /* Clear the List and append the items in the sorted order. */
16156 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16157 l->lv_len = 0;
16158 for (i = 0; i < len; ++i)
16159 list_append(l, ptrs[i]);
16163 vim_free(ptrs);
16168 * "soundfold({word})" function
16170 static void
16171 f_soundfold(argvars, rettv)
16172 typval_T *argvars;
16173 typval_T *rettv;
16175 char_u *s;
16177 rettv->v_type = VAR_STRING;
16178 s = get_tv_string(&argvars[0]);
16179 #ifdef FEAT_SPELL
16180 rettv->vval.v_string = eval_soundfold(s);
16181 #else
16182 rettv->vval.v_string = vim_strsave(s);
16183 #endif
16187 * "spellbadword()" function
16189 static void
16190 f_spellbadword(argvars, rettv)
16191 typval_T *argvars UNUSED;
16192 typval_T *rettv;
16194 char_u *word = (char_u *)"";
16195 hlf_T attr = HLF_COUNT;
16196 int len = 0;
16198 if (rettv_list_alloc(rettv) == FAIL)
16199 return;
16201 #ifdef FEAT_SPELL
16202 if (argvars[0].v_type == VAR_UNKNOWN)
16204 /* Find the start and length of the badly spelled word. */
16205 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16206 if (len != 0)
16207 word = ml_get_cursor();
16209 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16211 char_u *str = get_tv_string_chk(&argvars[0]);
16212 int capcol = -1;
16214 if (str != NULL)
16216 /* Check the argument for spelling. */
16217 while (*str != NUL)
16219 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16220 if (attr != HLF_COUNT)
16222 word = str;
16223 break;
16225 str += len;
16229 #endif
16231 list_append_string(rettv->vval.v_list, word, len);
16232 list_append_string(rettv->vval.v_list, (char_u *)(
16233 attr == HLF_SPB ? "bad" :
16234 attr == HLF_SPR ? "rare" :
16235 attr == HLF_SPL ? "local" :
16236 attr == HLF_SPC ? "caps" :
16237 ""), -1);
16241 * "spellsuggest()" function
16243 static void
16244 f_spellsuggest(argvars, rettv)
16245 typval_T *argvars UNUSED;
16246 typval_T *rettv;
16248 #ifdef FEAT_SPELL
16249 char_u *str;
16250 int typeerr = FALSE;
16251 int maxcount;
16252 garray_T ga;
16253 int i;
16254 listitem_T *li;
16255 int need_capital = FALSE;
16256 #endif
16258 if (rettv_list_alloc(rettv) == FAIL)
16259 return;
16261 #ifdef FEAT_SPELL
16262 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16264 str = get_tv_string(&argvars[0]);
16265 if (argvars[1].v_type != VAR_UNKNOWN)
16267 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16268 if (maxcount <= 0)
16269 return;
16270 if (argvars[2].v_type != VAR_UNKNOWN)
16272 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16273 if (typeerr)
16274 return;
16277 else
16278 maxcount = 25;
16280 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16282 for (i = 0; i < ga.ga_len; ++i)
16284 str = ((char_u **)ga.ga_data)[i];
16286 li = listitem_alloc();
16287 if (li == NULL)
16288 vim_free(str);
16289 else
16291 li->li_tv.v_type = VAR_STRING;
16292 li->li_tv.v_lock = 0;
16293 li->li_tv.vval.v_string = str;
16294 list_append(rettv->vval.v_list, li);
16297 ga_clear(&ga);
16299 #endif
16302 static void
16303 f_split(argvars, rettv)
16304 typval_T *argvars;
16305 typval_T *rettv;
16307 char_u *str;
16308 char_u *end;
16309 char_u *pat = NULL;
16310 regmatch_T regmatch;
16311 char_u patbuf[NUMBUFLEN];
16312 char_u *save_cpo;
16313 int match;
16314 colnr_T col = 0;
16315 int keepempty = FALSE;
16316 int typeerr = FALSE;
16318 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16319 save_cpo = p_cpo;
16320 p_cpo = (char_u *)"";
16322 str = get_tv_string(&argvars[0]);
16323 if (argvars[1].v_type != VAR_UNKNOWN)
16325 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16326 if (pat == NULL)
16327 typeerr = TRUE;
16328 if (argvars[2].v_type != VAR_UNKNOWN)
16329 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16331 if (pat == NULL || *pat == NUL)
16332 pat = (char_u *)"[\\x01- ]\\+";
16334 if (rettv_list_alloc(rettv) == FAIL)
16335 return;
16336 if (typeerr)
16337 return;
16339 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16340 if (regmatch.regprog != NULL)
16342 regmatch.rm_ic = FALSE;
16343 while (*str != NUL || keepempty)
16345 if (*str == NUL)
16346 match = FALSE; /* empty item at the end */
16347 else
16348 match = vim_regexec_nl(&regmatch, str, col);
16349 if (match)
16350 end = regmatch.startp[0];
16351 else
16352 end = str + STRLEN(str);
16353 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16354 && *str != NUL && match && end < regmatch.endp[0]))
16356 if (list_append_string(rettv->vval.v_list, str,
16357 (int)(end - str)) == FAIL)
16358 break;
16360 if (!match)
16361 break;
16362 /* Advance to just after the match. */
16363 if (regmatch.endp[0] > str)
16364 col = 0;
16365 else
16367 /* Don't get stuck at the same match. */
16368 #ifdef FEAT_MBYTE
16369 col = (*mb_ptr2len)(regmatch.endp[0]);
16370 #else
16371 col = 1;
16372 #endif
16374 str = regmatch.endp[0];
16377 vim_free(regmatch.regprog);
16380 p_cpo = save_cpo;
16383 #ifdef FEAT_FLOAT
16385 * "sqrt()" function
16387 static void
16388 f_sqrt(argvars, rettv)
16389 typval_T *argvars;
16390 typval_T *rettv;
16392 float_T f;
16394 rettv->v_type = VAR_FLOAT;
16395 if (get_float_arg(argvars, &f) == OK)
16396 rettv->vval.v_float = sqrt(f);
16397 else
16398 rettv->vval.v_float = 0.0;
16402 * "str2float()" function
16404 static void
16405 f_str2float(argvars, rettv)
16406 typval_T *argvars;
16407 typval_T *rettv;
16409 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16411 if (*p == '+')
16412 p = skipwhite(p + 1);
16413 (void)string2float(p, &rettv->vval.v_float);
16414 rettv->v_type = VAR_FLOAT;
16416 #endif
16419 * "str2nr()" function
16421 static void
16422 f_str2nr(argvars, rettv)
16423 typval_T *argvars;
16424 typval_T *rettv;
16426 int base = 10;
16427 char_u *p;
16428 long n;
16430 if (argvars[1].v_type != VAR_UNKNOWN)
16432 base = get_tv_number(&argvars[1]);
16433 if (base != 8 && base != 10 && base != 16)
16435 EMSG(_(e_invarg));
16436 return;
16440 p = skipwhite(get_tv_string(&argvars[0]));
16441 if (*p == '+')
16442 p = skipwhite(p + 1);
16443 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16444 rettv->vval.v_number = n;
16447 #ifdef HAVE_STRFTIME
16449 * "strftime({format}[, {time}])" function
16451 static void
16452 f_strftime(argvars, rettv)
16453 typval_T *argvars;
16454 typval_T *rettv;
16456 char_u result_buf[256];
16457 struct tm *curtime;
16458 time_t seconds;
16459 char_u *p;
16461 rettv->v_type = VAR_STRING;
16463 p = get_tv_string(&argvars[0]);
16464 if (argvars[1].v_type == VAR_UNKNOWN)
16465 seconds = time(NULL);
16466 else
16467 seconds = (time_t)get_tv_number(&argvars[1]);
16468 curtime = localtime(&seconds);
16469 /* MSVC returns NULL for an invalid value of seconds. */
16470 if (curtime == NULL)
16471 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16472 else
16474 # ifdef FEAT_MBYTE
16475 vimconv_T conv;
16476 char_u *enc;
16478 conv.vc_type = CONV_NONE;
16479 enc = enc_locale();
16480 convert_setup(&conv, p_enc, enc);
16481 if (conv.vc_type != CONV_NONE)
16482 p = string_convert(&conv, p, NULL);
16483 # endif
16484 if (p != NULL)
16485 (void)strftime((char *)result_buf, sizeof(result_buf),
16486 (char *)p, curtime);
16487 else
16488 result_buf[0] = NUL;
16490 # ifdef FEAT_MBYTE
16491 if (conv.vc_type != CONV_NONE)
16492 vim_free(p);
16493 convert_setup(&conv, enc, p_enc);
16494 if (conv.vc_type != CONV_NONE)
16495 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16496 else
16497 # endif
16498 rettv->vval.v_string = vim_strsave(result_buf);
16500 # ifdef FEAT_MBYTE
16501 /* Release conversion descriptors */
16502 convert_setup(&conv, NULL, NULL);
16503 vim_free(enc);
16504 # endif
16507 #endif
16510 * "stridx()" function
16512 static void
16513 f_stridx(argvars, rettv)
16514 typval_T *argvars;
16515 typval_T *rettv;
16517 char_u buf[NUMBUFLEN];
16518 char_u *needle;
16519 char_u *haystack;
16520 char_u *save_haystack;
16521 char_u *pos;
16522 int start_idx;
16524 needle = get_tv_string_chk(&argvars[1]);
16525 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16526 rettv->vval.v_number = -1;
16527 if (needle == NULL || haystack == NULL)
16528 return; /* type error; errmsg already given */
16530 if (argvars[2].v_type != VAR_UNKNOWN)
16532 int error = FALSE;
16534 start_idx = get_tv_number_chk(&argvars[2], &error);
16535 if (error || start_idx >= (int)STRLEN(haystack))
16536 return;
16537 if (start_idx >= 0)
16538 haystack += start_idx;
16541 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16542 if (pos != NULL)
16543 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16547 * "string()" function
16549 static void
16550 f_string(argvars, rettv)
16551 typval_T *argvars;
16552 typval_T *rettv;
16554 char_u *tofree;
16555 char_u numbuf[NUMBUFLEN];
16557 rettv->v_type = VAR_STRING;
16558 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16559 /* Make a copy if we have a value but it's not in allocated memory. */
16560 if (rettv->vval.v_string != NULL && tofree == NULL)
16561 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16565 * "strlen()" function
16567 static void
16568 f_strlen(argvars, rettv)
16569 typval_T *argvars;
16570 typval_T *rettv;
16572 rettv->vval.v_number = (varnumber_T)(STRLEN(
16573 get_tv_string(&argvars[0])));
16577 * "strpart()" function
16579 static void
16580 f_strpart(argvars, rettv)
16581 typval_T *argvars;
16582 typval_T *rettv;
16584 char_u *p;
16585 int n;
16586 int len;
16587 int slen;
16588 int error = FALSE;
16590 p = get_tv_string(&argvars[0]);
16591 slen = (int)STRLEN(p);
16593 n = get_tv_number_chk(&argvars[1], &error);
16594 if (error)
16595 len = 0;
16596 else if (argvars[2].v_type != VAR_UNKNOWN)
16597 len = get_tv_number(&argvars[2]);
16598 else
16599 len = slen - n; /* default len: all bytes that are available. */
16602 * Only return the overlap between the specified part and the actual
16603 * string.
16605 if (n < 0)
16607 len += n;
16608 n = 0;
16610 else if (n > slen)
16611 n = slen;
16612 if (len < 0)
16613 len = 0;
16614 else if (n + len > slen)
16615 len = slen - n;
16617 rettv->v_type = VAR_STRING;
16618 rettv->vval.v_string = vim_strnsave(p + n, len);
16622 * "strridx()" function
16624 static void
16625 f_strridx(argvars, rettv)
16626 typval_T *argvars;
16627 typval_T *rettv;
16629 char_u buf[NUMBUFLEN];
16630 char_u *needle;
16631 char_u *haystack;
16632 char_u *rest;
16633 char_u *lastmatch = NULL;
16634 int haystack_len, end_idx;
16636 needle = get_tv_string_chk(&argvars[1]);
16637 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16639 rettv->vval.v_number = -1;
16640 if (needle == NULL || haystack == NULL)
16641 return; /* type error; errmsg already given */
16643 haystack_len = (int)STRLEN(haystack);
16644 if (argvars[2].v_type != VAR_UNKNOWN)
16646 /* Third argument: upper limit for index */
16647 end_idx = get_tv_number_chk(&argvars[2], NULL);
16648 if (end_idx < 0)
16649 return; /* can never find a match */
16651 else
16652 end_idx = haystack_len;
16654 if (*needle == NUL)
16656 /* Empty string matches past the end. */
16657 lastmatch = haystack + end_idx;
16659 else
16661 for (rest = haystack; *rest != '\0'; ++rest)
16663 rest = (char_u *)strstr((char *)rest, (char *)needle);
16664 if (rest == NULL || rest > haystack + end_idx)
16665 break;
16666 lastmatch = rest;
16670 if (lastmatch == NULL)
16671 rettv->vval.v_number = -1;
16672 else
16673 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16677 * "strtrans()" function
16679 static void
16680 f_strtrans(argvars, rettv)
16681 typval_T *argvars;
16682 typval_T *rettv;
16684 rettv->v_type = VAR_STRING;
16685 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16689 * "submatch()" function
16691 static void
16692 f_submatch(argvars, rettv)
16693 typval_T *argvars;
16694 typval_T *rettv;
16696 rettv->v_type = VAR_STRING;
16697 rettv->vval.v_string =
16698 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16702 * "substitute()" function
16704 static void
16705 f_substitute(argvars, rettv)
16706 typval_T *argvars;
16707 typval_T *rettv;
16709 char_u patbuf[NUMBUFLEN];
16710 char_u subbuf[NUMBUFLEN];
16711 char_u flagsbuf[NUMBUFLEN];
16713 char_u *str = get_tv_string_chk(&argvars[0]);
16714 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16715 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16716 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16718 rettv->v_type = VAR_STRING;
16719 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16720 rettv->vval.v_string = NULL;
16721 else
16722 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16726 * "synID(lnum, col, trans)" function
16728 static void
16729 f_synID(argvars, rettv)
16730 typval_T *argvars UNUSED;
16731 typval_T *rettv;
16733 int id = 0;
16734 #ifdef FEAT_SYN_HL
16735 long lnum;
16736 long col;
16737 int trans;
16738 int transerr = FALSE;
16740 lnum = get_tv_lnum(argvars); /* -1 on type error */
16741 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16742 trans = get_tv_number_chk(&argvars[2], &transerr);
16744 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16745 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16746 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16747 #endif
16749 rettv->vval.v_number = id;
16753 * "synIDattr(id, what [, mode])" function
16755 static void
16756 f_synIDattr(argvars, rettv)
16757 typval_T *argvars UNUSED;
16758 typval_T *rettv;
16760 char_u *p = NULL;
16761 #ifdef FEAT_SYN_HL
16762 int id;
16763 char_u *what;
16764 char_u *mode;
16765 char_u modebuf[NUMBUFLEN];
16766 int modec;
16768 id = get_tv_number(&argvars[0]);
16769 what = get_tv_string(&argvars[1]);
16770 if (argvars[2].v_type != VAR_UNKNOWN)
16772 mode = get_tv_string_buf(&argvars[2], modebuf);
16773 modec = TOLOWER_ASC(mode[0]);
16774 if (modec != 't' && modec != 'c'
16775 #ifdef FEAT_GUI
16776 && modec != 'g'
16777 #endif
16779 modec = 0; /* replace invalid with current */
16781 else
16783 #ifdef FEAT_GUI
16784 if (gui.in_use)
16785 modec = 'g';
16786 else
16787 #endif
16788 if (t_colors > 1)
16789 modec = 'c';
16790 else
16791 modec = 't';
16795 switch (TOLOWER_ASC(what[0]))
16797 case 'b':
16798 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16799 p = highlight_color(id, what, modec);
16800 else /* bold */
16801 p = highlight_has_attr(id, HL_BOLD, modec);
16802 break;
16804 case 'f': /* fg[#] */
16805 p = highlight_color(id, what, modec);
16806 break;
16808 case 'i':
16809 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16810 p = highlight_has_attr(id, HL_INVERSE, modec);
16811 else /* italic */
16812 p = highlight_has_attr(id, HL_ITALIC, modec);
16813 break;
16815 case 'n': /* name */
16816 p = get_highlight_name(NULL, id - 1);
16817 break;
16819 case 'r': /* reverse */
16820 p = highlight_has_attr(id, HL_INVERSE, modec);
16821 break;
16823 case 's':
16824 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16825 p = highlight_color(id, what, modec);
16826 else /* standout */
16827 p = highlight_has_attr(id, HL_STANDOUT, modec);
16828 break;
16830 case 'u':
16831 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16832 /* underline */
16833 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16834 else
16835 /* undercurl */
16836 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16837 break;
16840 if (p != NULL)
16841 p = vim_strsave(p);
16842 #endif
16843 rettv->v_type = VAR_STRING;
16844 rettv->vval.v_string = p;
16848 * "synIDtrans(id)" function
16850 static void
16851 f_synIDtrans(argvars, rettv)
16852 typval_T *argvars UNUSED;
16853 typval_T *rettv;
16855 int id;
16857 #ifdef FEAT_SYN_HL
16858 id = get_tv_number(&argvars[0]);
16860 if (id > 0)
16861 id = syn_get_final_id(id);
16862 else
16863 #endif
16864 id = 0;
16866 rettv->vval.v_number = id;
16870 * "synstack(lnum, col)" function
16872 static void
16873 f_synstack(argvars, rettv)
16874 typval_T *argvars UNUSED;
16875 typval_T *rettv;
16877 #ifdef FEAT_SYN_HL
16878 long lnum;
16879 long col;
16880 int i;
16881 int id;
16882 #endif
16884 rettv->v_type = VAR_LIST;
16885 rettv->vval.v_list = NULL;
16887 #ifdef FEAT_SYN_HL
16888 lnum = get_tv_lnum(argvars); /* -1 on type error */
16889 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16891 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16892 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16893 && rettv_list_alloc(rettv) != FAIL)
16895 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16896 for (i = 0; ; ++i)
16898 id = syn_get_stack_item(i);
16899 if (id < 0)
16900 break;
16901 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16902 break;
16905 #endif
16909 * "system()" function
16911 static void
16912 f_system(argvars, rettv)
16913 typval_T *argvars;
16914 typval_T *rettv;
16916 char_u *res = NULL;
16917 char_u *p;
16918 char_u *infile = NULL;
16919 char_u buf[NUMBUFLEN];
16920 int err = FALSE;
16921 FILE *fd;
16923 if (check_restricted() || check_secure())
16924 goto done;
16926 if (argvars[1].v_type != VAR_UNKNOWN)
16929 * Write the string to a temp file, to be used for input of the shell
16930 * command.
16932 if ((infile = vim_tempname('i')) == NULL)
16934 EMSG(_(e_notmp));
16935 goto done;
16938 fd = mch_fopen((char *)infile, WRITEBIN);
16939 if (fd == NULL)
16941 EMSG2(_(e_notopen), infile);
16942 goto done;
16944 p = get_tv_string_buf_chk(&argvars[1], buf);
16945 if (p == NULL)
16947 fclose(fd);
16948 goto done; /* type error; errmsg already given */
16950 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16951 err = TRUE;
16952 if (fclose(fd) != 0)
16953 err = TRUE;
16954 if (err)
16956 EMSG(_("E677: Error writing temp file"));
16957 goto done;
16961 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16962 SHELL_SILENT | SHELL_COOKED);
16964 #ifdef USE_CR
16965 /* translate <CR> into <NL> */
16966 if (res != NULL)
16968 char_u *s;
16970 for (s = res; *s; ++s)
16972 if (*s == CAR)
16973 *s = NL;
16976 #else
16977 # ifdef USE_CRNL
16978 /* translate <CR><NL> into <NL> */
16979 if (res != NULL)
16981 char_u *s, *d;
16983 d = res;
16984 for (s = res; *s; ++s)
16986 if (s[0] == CAR && s[1] == NL)
16987 ++s;
16988 *d++ = *s;
16990 *d = NUL;
16992 # endif
16993 #endif
16995 done:
16996 if (infile != NULL)
16998 mch_remove(infile);
16999 vim_free(infile);
17001 rettv->v_type = VAR_STRING;
17002 rettv->vval.v_string = res;
17006 * "tabpagebuflist()" function
17008 static void
17009 f_tabpagebuflist(argvars, rettv)
17010 typval_T *argvars UNUSED;
17011 typval_T *rettv UNUSED;
17013 #ifdef FEAT_WINDOWS
17014 tabpage_T *tp;
17015 win_T *wp = NULL;
17017 if (argvars[0].v_type == VAR_UNKNOWN)
17018 wp = firstwin;
17019 else
17021 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17022 if (tp != NULL)
17023 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
17025 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
17027 for (; wp != NULL; wp = wp->w_next)
17028 if (list_append_number(rettv->vval.v_list,
17029 wp->w_buffer->b_fnum) == FAIL)
17030 break;
17032 #endif
17037 * "tabpagenr()" function
17039 static void
17040 f_tabpagenr(argvars, rettv)
17041 typval_T *argvars UNUSED;
17042 typval_T *rettv;
17044 int nr = 1;
17045 #ifdef FEAT_WINDOWS
17046 char_u *arg;
17048 if (argvars[0].v_type != VAR_UNKNOWN)
17050 arg = get_tv_string_chk(&argvars[0]);
17051 nr = 0;
17052 if (arg != NULL)
17054 if (STRCMP(arg, "$") == 0)
17055 nr = tabpage_index(NULL) - 1;
17056 else
17057 EMSG2(_(e_invexpr2), arg);
17060 else
17061 nr = tabpage_index(curtab);
17062 #endif
17063 rettv->vval.v_number = nr;
17067 #ifdef FEAT_WINDOWS
17068 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
17071 * Common code for tabpagewinnr() and winnr().
17073 static int
17074 get_winnr(tp, argvar)
17075 tabpage_T *tp;
17076 typval_T *argvar;
17078 win_T *twin;
17079 int nr = 1;
17080 win_T *wp;
17081 char_u *arg;
17083 twin = (tp == curtab) ? curwin : tp->tp_curwin;
17084 if (argvar->v_type != VAR_UNKNOWN)
17086 arg = get_tv_string_chk(argvar);
17087 if (arg == NULL)
17088 nr = 0; /* type error; errmsg already given */
17089 else if (STRCMP(arg, "$") == 0)
17090 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
17091 else if (STRCMP(arg, "#") == 0)
17093 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
17094 if (twin == NULL)
17095 nr = 0;
17097 else
17099 EMSG2(_(e_invexpr2), arg);
17100 nr = 0;
17104 if (nr > 0)
17105 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
17106 wp != twin; wp = wp->w_next)
17108 if (wp == NULL)
17110 /* didn't find it in this tabpage */
17111 nr = 0;
17112 break;
17114 ++nr;
17116 return nr;
17118 #endif
17121 * "tabpagewinnr()" function
17123 static void
17124 f_tabpagewinnr(argvars, rettv)
17125 typval_T *argvars UNUSED;
17126 typval_T *rettv;
17128 int nr = 1;
17129 #ifdef FEAT_WINDOWS
17130 tabpage_T *tp;
17132 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17133 if (tp == NULL)
17134 nr = 0;
17135 else
17136 nr = get_winnr(tp, &argvars[1]);
17137 #endif
17138 rettv->vval.v_number = nr;
17143 * "tagfiles()" function
17145 static void
17146 f_tagfiles(argvars, rettv)
17147 typval_T *argvars UNUSED;
17148 typval_T *rettv;
17150 char_u fname[MAXPATHL + 1];
17151 tagname_T tn;
17152 int first;
17154 if (rettv_list_alloc(rettv) == FAIL)
17155 return;
17157 for (first = TRUE; ; first = FALSE)
17158 if (get_tagfname(&tn, first, fname) == FAIL
17159 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17160 break;
17161 tagname_free(&tn);
17165 * "taglist()" function
17167 static void
17168 f_taglist(argvars, rettv)
17169 typval_T *argvars;
17170 typval_T *rettv;
17172 char_u *tag_pattern;
17174 tag_pattern = get_tv_string(&argvars[0]);
17176 rettv->vval.v_number = FALSE;
17177 if (*tag_pattern == NUL)
17178 return;
17180 if (rettv_list_alloc(rettv) == OK)
17181 (void)get_tags(rettv->vval.v_list, tag_pattern);
17185 * "tempname()" function
17187 static void
17188 f_tempname(argvars, rettv)
17189 typval_T *argvars UNUSED;
17190 typval_T *rettv;
17192 static int x = 'A';
17194 rettv->v_type = VAR_STRING;
17195 rettv->vval.v_string = vim_tempname(x);
17197 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17198 * names. Skip 'I' and 'O', they are used for shell redirection. */
17201 if (x == 'Z')
17202 x = '0';
17203 else if (x == '9')
17204 x = 'A';
17205 else
17207 #ifdef EBCDIC
17208 if (x == 'I')
17209 x = 'J';
17210 else if (x == 'R')
17211 x = 'S';
17212 else
17213 #endif
17214 ++x;
17216 } while (x == 'I' || x == 'O');
17220 * "test(list)" function: Just checking the walls...
17222 static void
17223 f_test(argvars, rettv)
17224 typval_T *argvars UNUSED;
17225 typval_T *rettv UNUSED;
17227 /* Used for unit testing. Change the code below to your liking. */
17228 #if 0
17229 listitem_T *li;
17230 list_T *l;
17231 char_u *bad, *good;
17233 if (argvars[0].v_type != VAR_LIST)
17234 return;
17235 l = argvars[0].vval.v_list;
17236 if (l == NULL)
17237 return;
17238 li = l->lv_first;
17239 if (li == NULL)
17240 return;
17241 bad = get_tv_string(&li->li_tv);
17242 li = li->li_next;
17243 if (li == NULL)
17244 return;
17245 good = get_tv_string(&li->li_tv);
17246 rettv->vval.v_number = test_edit_score(bad, good);
17247 #endif
17251 * "tolower(string)" function
17253 static void
17254 f_tolower(argvars, rettv)
17255 typval_T *argvars;
17256 typval_T *rettv;
17258 char_u *p;
17260 p = vim_strsave(get_tv_string(&argvars[0]));
17261 rettv->v_type = VAR_STRING;
17262 rettv->vval.v_string = p;
17264 if (p != NULL)
17265 while (*p != NUL)
17267 #ifdef FEAT_MBYTE
17268 int l;
17270 if (enc_utf8)
17272 int c, lc;
17274 c = utf_ptr2char(p);
17275 lc = utf_tolower(c);
17276 l = utf_ptr2len(p);
17277 /* TODO: reallocate string when byte count changes. */
17278 if (utf_char2len(lc) == l)
17279 utf_char2bytes(lc, p);
17280 p += l;
17282 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17283 p += l; /* skip multi-byte character */
17284 else
17285 #endif
17287 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17288 ++p;
17294 * "toupper(string)" function
17296 static void
17297 f_toupper(argvars, rettv)
17298 typval_T *argvars;
17299 typval_T *rettv;
17301 rettv->v_type = VAR_STRING;
17302 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17306 * "tr(string, fromstr, tostr)" function
17308 static void
17309 f_tr(argvars, rettv)
17310 typval_T *argvars;
17311 typval_T *rettv;
17313 char_u *instr;
17314 char_u *fromstr;
17315 char_u *tostr;
17316 char_u *p;
17317 #ifdef FEAT_MBYTE
17318 int inlen;
17319 int fromlen;
17320 int tolen;
17321 int idx;
17322 char_u *cpstr;
17323 int cplen;
17324 int first = TRUE;
17325 #endif
17326 char_u buf[NUMBUFLEN];
17327 char_u buf2[NUMBUFLEN];
17328 garray_T ga;
17330 instr = get_tv_string(&argvars[0]);
17331 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17332 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17334 /* Default return value: empty string. */
17335 rettv->v_type = VAR_STRING;
17336 rettv->vval.v_string = NULL;
17337 if (fromstr == NULL || tostr == NULL)
17338 return; /* type error; errmsg already given */
17339 ga_init2(&ga, (int)sizeof(char), 80);
17341 #ifdef FEAT_MBYTE
17342 if (!has_mbyte)
17343 #endif
17344 /* not multi-byte: fromstr and tostr must be the same length */
17345 if (STRLEN(fromstr) != STRLEN(tostr))
17347 #ifdef FEAT_MBYTE
17348 error:
17349 #endif
17350 EMSG2(_(e_invarg2), fromstr);
17351 ga_clear(&ga);
17352 return;
17355 /* fromstr and tostr have to contain the same number of chars */
17356 while (*instr != NUL)
17358 #ifdef FEAT_MBYTE
17359 if (has_mbyte)
17361 inlen = (*mb_ptr2len)(instr);
17362 cpstr = instr;
17363 cplen = inlen;
17364 idx = 0;
17365 for (p = fromstr; *p != NUL; p += fromlen)
17367 fromlen = (*mb_ptr2len)(p);
17368 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17370 for (p = tostr; *p != NUL; p += tolen)
17372 tolen = (*mb_ptr2len)(p);
17373 if (idx-- == 0)
17375 cplen = tolen;
17376 cpstr = p;
17377 break;
17380 if (*p == NUL) /* tostr is shorter than fromstr */
17381 goto error;
17382 break;
17384 ++idx;
17387 if (first && cpstr == instr)
17389 /* Check that fromstr and tostr have the same number of
17390 * (multi-byte) characters. Done only once when a character
17391 * of instr doesn't appear in fromstr. */
17392 first = FALSE;
17393 for (p = tostr; *p != NUL; p += tolen)
17395 tolen = (*mb_ptr2len)(p);
17396 --idx;
17398 if (idx != 0)
17399 goto error;
17402 ga_grow(&ga, cplen);
17403 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17404 ga.ga_len += cplen;
17406 instr += inlen;
17408 else
17409 #endif
17411 /* When not using multi-byte chars we can do it faster. */
17412 p = vim_strchr(fromstr, *instr);
17413 if (p != NULL)
17414 ga_append(&ga, tostr[p - fromstr]);
17415 else
17416 ga_append(&ga, *instr);
17417 ++instr;
17421 /* add a terminating NUL */
17422 ga_grow(&ga, 1);
17423 ga_append(&ga, NUL);
17425 rettv->vval.v_string = ga.ga_data;
17428 #ifdef FEAT_FLOAT
17430 * "trunc({float})" function
17432 static void
17433 f_trunc(argvars, rettv)
17434 typval_T *argvars;
17435 typval_T *rettv;
17437 float_T f;
17439 rettv->v_type = VAR_FLOAT;
17440 if (get_float_arg(argvars, &f) == OK)
17441 /* trunc() is not in C90, use floor() or ceil() instead. */
17442 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17443 else
17444 rettv->vval.v_float = 0.0;
17446 #endif
17449 * "type(expr)" function
17451 static void
17452 f_type(argvars, rettv)
17453 typval_T *argvars;
17454 typval_T *rettv;
17456 int n;
17458 switch (argvars[0].v_type)
17460 case VAR_NUMBER: n = 0; break;
17461 case VAR_STRING: n = 1; break;
17462 case VAR_FUNC: n = 2; break;
17463 case VAR_LIST: n = 3; break;
17464 case VAR_DICT: n = 4; break;
17465 #ifdef FEAT_FLOAT
17466 case VAR_FLOAT: n = 5; break;
17467 #endif
17468 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17470 rettv->vval.v_number = n;
17474 * "values(dict)" function
17476 static void
17477 f_values(argvars, rettv)
17478 typval_T *argvars;
17479 typval_T *rettv;
17481 dict_list(argvars, rettv, 1);
17485 * "virtcol(string)" function
17487 static void
17488 f_virtcol(argvars, rettv)
17489 typval_T *argvars;
17490 typval_T *rettv;
17492 colnr_T vcol = 0;
17493 pos_T *fp;
17494 int fnum = curbuf->b_fnum;
17496 fp = var2fpos(&argvars[0], FALSE, &fnum);
17497 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17498 && fnum == curbuf->b_fnum)
17500 getvvcol(curwin, fp, NULL, NULL, &vcol);
17501 ++vcol;
17504 rettv->vval.v_number = vcol;
17508 * "visualmode()" function
17510 static void
17511 f_visualmode(argvars, rettv)
17512 typval_T *argvars UNUSED;
17513 typval_T *rettv UNUSED;
17515 #ifdef FEAT_VISUAL
17516 char_u str[2];
17518 rettv->v_type = VAR_STRING;
17519 str[0] = curbuf->b_visual_mode_eval;
17520 str[1] = NUL;
17521 rettv->vval.v_string = vim_strsave(str);
17523 /* A non-zero number or non-empty string argument: reset mode. */
17524 if (non_zero_arg(&argvars[0]))
17525 curbuf->b_visual_mode_eval = NUL;
17526 #endif
17530 * "winbufnr(nr)" function
17532 static void
17533 f_winbufnr(argvars, rettv)
17534 typval_T *argvars;
17535 typval_T *rettv;
17537 win_T *wp;
17539 wp = find_win_by_nr(&argvars[0], NULL);
17540 if (wp == NULL)
17541 rettv->vval.v_number = -1;
17542 else
17543 rettv->vval.v_number = wp->w_buffer->b_fnum;
17547 * "wincol()" function
17549 static void
17550 f_wincol(argvars, rettv)
17551 typval_T *argvars UNUSED;
17552 typval_T *rettv;
17554 validate_cursor();
17555 rettv->vval.v_number = curwin->w_wcol + 1;
17559 * "winheight(nr)" function
17561 static void
17562 f_winheight(argvars, rettv)
17563 typval_T *argvars;
17564 typval_T *rettv;
17566 win_T *wp;
17568 wp = find_win_by_nr(&argvars[0], NULL);
17569 if (wp == NULL)
17570 rettv->vval.v_number = -1;
17571 else
17572 rettv->vval.v_number = wp->w_height;
17576 * "winline()" function
17578 static void
17579 f_winline(argvars, rettv)
17580 typval_T *argvars UNUSED;
17581 typval_T *rettv;
17583 validate_cursor();
17584 rettv->vval.v_number = curwin->w_wrow + 1;
17588 * "winnr()" function
17590 static void
17591 f_winnr(argvars, rettv)
17592 typval_T *argvars UNUSED;
17593 typval_T *rettv;
17595 int nr = 1;
17597 #ifdef FEAT_WINDOWS
17598 nr = get_winnr(curtab, &argvars[0]);
17599 #endif
17600 rettv->vval.v_number = nr;
17604 * "winrestcmd()" function
17606 static void
17607 f_winrestcmd(argvars, rettv)
17608 typval_T *argvars UNUSED;
17609 typval_T *rettv;
17611 #ifdef FEAT_WINDOWS
17612 win_T *wp;
17613 int winnr = 1;
17614 garray_T ga;
17615 char_u buf[50];
17617 ga_init2(&ga, (int)sizeof(char), 70);
17618 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17620 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17621 ga_concat(&ga, buf);
17622 # ifdef FEAT_VERTSPLIT
17623 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17624 ga_concat(&ga, buf);
17625 # endif
17626 ++winnr;
17628 ga_append(&ga, NUL);
17630 rettv->vval.v_string = ga.ga_data;
17631 #else
17632 rettv->vval.v_string = NULL;
17633 #endif
17634 rettv->v_type = VAR_STRING;
17638 * "winrestview()" function
17640 static void
17641 f_winrestview(argvars, rettv)
17642 typval_T *argvars;
17643 typval_T *rettv UNUSED;
17645 dict_T *dict;
17647 if (argvars[0].v_type != VAR_DICT
17648 || (dict = argvars[0].vval.v_dict) == NULL)
17649 EMSG(_(e_invarg));
17650 else
17652 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17653 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17654 #ifdef FEAT_VIRTUALEDIT
17655 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17656 #endif
17657 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17658 curwin->w_set_curswant = FALSE;
17660 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17661 #ifdef FEAT_DIFF
17662 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17663 #endif
17664 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17665 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17667 check_cursor();
17668 changed_cline_bef_curs();
17669 invalidate_botline();
17670 redraw_later(VALID);
17672 if (curwin->w_topline == 0)
17673 curwin->w_topline = 1;
17674 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17675 curwin->w_topline = curbuf->b_ml.ml_line_count;
17676 #ifdef FEAT_DIFF
17677 check_topfill(curwin, TRUE);
17678 #endif
17683 * "winsaveview()" function
17685 static void
17686 f_winsaveview(argvars, rettv)
17687 typval_T *argvars UNUSED;
17688 typval_T *rettv;
17690 dict_T *dict;
17692 dict = dict_alloc();
17693 if (dict == NULL)
17694 return;
17695 rettv->v_type = VAR_DICT;
17696 rettv->vval.v_dict = dict;
17697 ++dict->dv_refcount;
17699 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17700 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17701 #ifdef FEAT_VIRTUALEDIT
17702 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17703 #endif
17704 update_curswant();
17705 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17707 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17708 #ifdef FEAT_DIFF
17709 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17710 #endif
17711 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17712 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17716 * "winwidth(nr)" function
17718 static void
17719 f_winwidth(argvars, rettv)
17720 typval_T *argvars;
17721 typval_T *rettv;
17723 win_T *wp;
17725 wp = find_win_by_nr(&argvars[0], NULL);
17726 if (wp == NULL)
17727 rettv->vval.v_number = -1;
17728 else
17729 #ifdef FEAT_VERTSPLIT
17730 rettv->vval.v_number = wp->w_width;
17731 #else
17732 rettv->vval.v_number = Columns;
17733 #endif
17737 * "writefile()" function
17739 static void
17740 f_writefile(argvars, rettv)
17741 typval_T *argvars;
17742 typval_T *rettv;
17744 int binary = FALSE;
17745 char_u *fname;
17746 FILE *fd;
17747 listitem_T *li;
17748 char_u *s;
17749 int ret = 0;
17750 int c;
17752 if (check_restricted() || check_secure())
17753 return;
17755 if (argvars[0].v_type != VAR_LIST)
17757 EMSG2(_(e_listarg), "writefile()");
17758 return;
17760 if (argvars[0].vval.v_list == NULL)
17761 return;
17763 if (argvars[2].v_type != VAR_UNKNOWN
17764 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17765 binary = TRUE;
17767 /* Always open the file in binary mode, library functions have a mind of
17768 * their own about CR-LF conversion. */
17769 fname = get_tv_string(&argvars[1]);
17770 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17772 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17773 ret = -1;
17775 else
17777 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17778 li = li->li_next)
17780 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17782 if (*s == '\n')
17783 c = putc(NUL, fd);
17784 else
17785 c = putc(*s, fd);
17786 if (c == EOF)
17788 ret = -1;
17789 break;
17792 if (!binary || li->li_next != NULL)
17793 if (putc('\n', fd) == EOF)
17795 ret = -1;
17796 break;
17798 if (ret < 0)
17800 EMSG(_(e_write));
17801 break;
17804 fclose(fd);
17807 rettv->vval.v_number = ret;
17811 * Translate a String variable into a position.
17812 * Returns NULL when there is an error.
17814 static pos_T *
17815 var2fpos(varp, dollar_lnum, fnum)
17816 typval_T *varp;
17817 int dollar_lnum; /* TRUE when $ is last line */
17818 int *fnum; /* set to fnum for '0, 'A, etc. */
17820 char_u *name;
17821 static pos_T pos;
17822 pos_T *pp;
17824 /* Argument can be [lnum, col, coladd]. */
17825 if (varp->v_type == VAR_LIST)
17827 list_T *l;
17828 int len;
17829 int error = FALSE;
17830 listitem_T *li;
17832 l = varp->vval.v_list;
17833 if (l == NULL)
17834 return NULL;
17836 /* Get the line number */
17837 pos.lnum = list_find_nr(l, 0L, &error);
17838 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17839 return NULL; /* invalid line number */
17841 /* Get the column number */
17842 pos.col = list_find_nr(l, 1L, &error);
17843 if (error)
17844 return NULL;
17845 len = (long)STRLEN(ml_get(pos.lnum));
17847 /* We accept "$" for the column number: last column. */
17848 li = list_find(l, 1L);
17849 if (li != NULL && li->li_tv.v_type == VAR_STRING
17850 && li->li_tv.vval.v_string != NULL
17851 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17852 pos.col = len + 1;
17854 /* Accept a position up to the NUL after the line. */
17855 if (pos.col == 0 || (int)pos.col > len + 1)
17856 return NULL; /* invalid column number */
17857 --pos.col;
17859 #ifdef FEAT_VIRTUALEDIT
17860 /* Get the virtual offset. Defaults to zero. */
17861 pos.coladd = list_find_nr(l, 2L, &error);
17862 if (error)
17863 pos.coladd = 0;
17864 #endif
17866 return &pos;
17869 name = get_tv_string_chk(varp);
17870 if (name == NULL)
17871 return NULL;
17872 if (name[0] == '.') /* cursor */
17873 return &curwin->w_cursor;
17874 #ifdef FEAT_VISUAL
17875 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17877 if (VIsual_active)
17878 return &VIsual;
17879 return &curwin->w_cursor;
17881 #endif
17882 if (name[0] == '\'') /* mark */
17884 pp = getmark_fnum(name[1], FALSE, fnum);
17885 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17886 return NULL;
17887 return pp;
17890 #ifdef FEAT_VIRTUALEDIT
17891 pos.coladd = 0;
17892 #endif
17894 if (name[0] == 'w' && dollar_lnum)
17896 pos.col = 0;
17897 if (name[1] == '0') /* "w0": first visible line */
17899 update_topline();
17900 pos.lnum = curwin->w_topline;
17901 return &pos;
17903 else if (name[1] == '$') /* "w$": last visible line */
17905 validate_botline();
17906 pos.lnum = curwin->w_botline - 1;
17907 return &pos;
17910 else if (name[0] == '$') /* last column or line */
17912 if (dollar_lnum)
17914 pos.lnum = curbuf->b_ml.ml_line_count;
17915 pos.col = 0;
17917 else
17919 pos.lnum = curwin->w_cursor.lnum;
17920 pos.col = (colnr_T)STRLEN(ml_get_curline());
17922 return &pos;
17924 return NULL;
17928 * Convert list in "arg" into a position and optional file number.
17929 * When "fnump" is NULL there is no file number, only 3 items.
17930 * Note that the column is passed on as-is, the caller may want to decrement
17931 * it to use 1 for the first column.
17932 * Return FAIL when conversion is not possible, doesn't check the position for
17933 * validity.
17935 static int
17936 list2fpos(arg, posp, fnump)
17937 typval_T *arg;
17938 pos_T *posp;
17939 int *fnump;
17941 list_T *l = arg->vval.v_list;
17942 long i = 0;
17943 long n;
17945 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17946 * when "fnump" isn't NULL and "coladd" is optional. */
17947 if (arg->v_type != VAR_LIST
17948 || l == NULL
17949 || l->lv_len < (fnump == NULL ? 2 : 3)
17950 || l->lv_len > (fnump == NULL ? 3 : 4))
17951 return FAIL;
17953 if (fnump != NULL)
17955 n = list_find_nr(l, i++, NULL); /* fnum */
17956 if (n < 0)
17957 return FAIL;
17958 if (n == 0)
17959 n = curbuf->b_fnum; /* current buffer */
17960 *fnump = n;
17963 n = list_find_nr(l, i++, NULL); /* lnum */
17964 if (n < 0)
17965 return FAIL;
17966 posp->lnum = n;
17968 n = list_find_nr(l, i++, NULL); /* col */
17969 if (n < 0)
17970 return FAIL;
17971 posp->col = n;
17973 #ifdef FEAT_VIRTUALEDIT
17974 n = list_find_nr(l, i, NULL);
17975 if (n < 0)
17976 posp->coladd = 0;
17977 else
17978 posp->coladd = n;
17979 #endif
17981 return OK;
17985 * Get the length of an environment variable name.
17986 * Advance "arg" to the first character after the name.
17987 * Return 0 for error.
17989 static int
17990 get_env_len(arg)
17991 char_u **arg;
17993 char_u *p;
17994 int len;
17996 for (p = *arg; vim_isIDc(*p); ++p)
17998 if (p == *arg) /* no name found */
17999 return 0;
18001 len = (int)(p - *arg);
18002 *arg = p;
18003 return len;
18007 * Get the length of the name of a function or internal variable.
18008 * "arg" is advanced to the first non-white character after the name.
18009 * Return 0 if something is wrong.
18011 static int
18012 get_id_len(arg)
18013 char_u **arg;
18015 char_u *p;
18016 int len;
18018 /* Find the end of the name. */
18019 for (p = *arg; eval_isnamec(*p); ++p)
18021 if (p == *arg) /* no name found */
18022 return 0;
18024 len = (int)(p - *arg);
18025 *arg = skipwhite(p);
18027 return len;
18031 * Get the length of the name of a variable or function.
18032 * Only the name is recognized, does not handle ".key" or "[idx]".
18033 * "arg" is advanced to the first non-white character after the name.
18034 * Return -1 if curly braces expansion failed.
18035 * Return 0 if something else is wrong.
18036 * If the name contains 'magic' {}'s, expand them and return the
18037 * expanded name in an allocated string via 'alias' - caller must free.
18039 static int
18040 get_name_len(arg, alias, evaluate, verbose)
18041 char_u **arg;
18042 char_u **alias;
18043 int evaluate;
18044 int verbose;
18046 int len;
18047 char_u *p;
18048 char_u *expr_start;
18049 char_u *expr_end;
18051 *alias = NULL; /* default to no alias */
18053 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
18054 && (*arg)[2] == (int)KE_SNR)
18056 /* hard coded <SNR>, already translated */
18057 *arg += 3;
18058 return get_id_len(arg) + 3;
18060 len = eval_fname_script(*arg);
18061 if (len > 0)
18063 /* literal "<SID>", "s:" or "<SNR>" */
18064 *arg += len;
18068 * Find the end of the name; check for {} construction.
18070 p = find_name_end(*arg, &expr_start, &expr_end,
18071 len > 0 ? 0 : FNE_CHECK_START);
18072 if (expr_start != NULL)
18074 char_u *temp_string;
18076 if (!evaluate)
18078 len += (int)(p - *arg);
18079 *arg = skipwhite(p);
18080 return len;
18084 * Include any <SID> etc in the expanded string:
18085 * Thus the -len here.
18087 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
18088 if (temp_string == NULL)
18089 return -1;
18090 *alias = temp_string;
18091 *arg = skipwhite(p);
18092 return (int)STRLEN(temp_string);
18095 len += get_id_len(arg);
18096 if (len == 0 && verbose)
18097 EMSG2(_(e_invexpr2), *arg);
18099 return len;
18103 * Find the end of a variable or function name, taking care of magic braces.
18104 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
18105 * start and end of the first magic braces item.
18106 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
18107 * Return a pointer to just after the name. Equal to "arg" if there is no
18108 * valid name.
18110 static char_u *
18111 find_name_end(arg, expr_start, expr_end, flags)
18112 char_u *arg;
18113 char_u **expr_start;
18114 char_u **expr_end;
18115 int flags;
18117 int mb_nest = 0;
18118 int br_nest = 0;
18119 char_u *p;
18121 if (expr_start != NULL)
18123 *expr_start = NULL;
18124 *expr_end = NULL;
18127 /* Quick check for valid starting character. */
18128 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
18129 return arg;
18131 for (p = arg; *p != NUL
18132 && (eval_isnamec(*p)
18133 || *p == '{'
18134 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
18135 || mb_nest != 0
18136 || br_nest != 0); mb_ptr_adv(p))
18138 if (*p == '\'')
18140 /* skip over 'string' to avoid counting [ and ] inside it. */
18141 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18143 if (*p == NUL)
18144 break;
18146 else if (*p == '"')
18148 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18149 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18150 if (*p == '\\' && p[1] != NUL)
18151 ++p;
18152 if (*p == NUL)
18153 break;
18156 if (mb_nest == 0)
18158 if (*p == '[')
18159 ++br_nest;
18160 else if (*p == ']')
18161 --br_nest;
18164 if (br_nest == 0)
18166 if (*p == '{')
18168 mb_nest++;
18169 if (expr_start != NULL && *expr_start == NULL)
18170 *expr_start = p;
18172 else if (*p == '}')
18174 mb_nest--;
18175 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18176 *expr_end = p;
18181 return p;
18185 * Expands out the 'magic' {}'s in a variable/function name.
18186 * Note that this can call itself recursively, to deal with
18187 * constructs like foo{bar}{baz}{bam}
18188 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18189 * "in_start" ^
18190 * "expr_start" ^
18191 * "expr_end" ^
18192 * "in_end" ^
18194 * Returns a new allocated string, which the caller must free.
18195 * Returns NULL for failure.
18197 static char_u *
18198 make_expanded_name(in_start, expr_start, expr_end, in_end)
18199 char_u *in_start;
18200 char_u *expr_start;
18201 char_u *expr_end;
18202 char_u *in_end;
18204 char_u c1;
18205 char_u *retval = NULL;
18206 char_u *temp_result;
18207 char_u *nextcmd = NULL;
18209 if (expr_end == NULL || in_end == NULL)
18210 return NULL;
18211 *expr_start = NUL;
18212 *expr_end = NUL;
18213 c1 = *in_end;
18214 *in_end = NUL;
18216 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18217 if (temp_result != NULL && nextcmd == NULL)
18219 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18220 + (in_end - expr_end) + 1));
18221 if (retval != NULL)
18223 STRCPY(retval, in_start);
18224 STRCAT(retval, temp_result);
18225 STRCAT(retval, expr_end + 1);
18228 vim_free(temp_result);
18230 *in_end = c1; /* put char back for error messages */
18231 *expr_start = '{';
18232 *expr_end = '}';
18234 if (retval != NULL)
18236 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18237 if (expr_start != NULL)
18239 /* Further expansion! */
18240 temp_result = make_expanded_name(retval, expr_start,
18241 expr_end, temp_result);
18242 vim_free(retval);
18243 retval = temp_result;
18247 return retval;
18251 * Return TRUE if character "c" can be used in a variable or function name.
18252 * Does not include '{' or '}' for magic braces.
18254 static int
18255 eval_isnamec(c)
18256 int c;
18258 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18262 * Return TRUE if character "c" can be used as the first character in a
18263 * variable or function name (excluding '{' and '}').
18265 static int
18266 eval_isnamec1(c)
18267 int c;
18269 return (ASCII_ISALPHA(c) || c == '_');
18273 * Set number v: variable to "val".
18275 void
18276 set_vim_var_nr(idx, val)
18277 int idx;
18278 long val;
18280 vimvars[idx].vv_nr = val;
18284 * Get number v: variable value.
18286 long
18287 get_vim_var_nr(idx)
18288 int idx;
18290 return vimvars[idx].vv_nr;
18294 * Get string v: variable value. Uses a static buffer, can only be used once.
18296 char_u *
18297 get_vim_var_str(idx)
18298 int idx;
18300 return get_tv_string(&vimvars[idx].vv_tv);
18304 * Get List v: variable value. Caller must take care of reference count when
18305 * needed.
18307 list_T *
18308 get_vim_var_list(idx)
18309 int idx;
18311 return vimvars[idx].vv_list;
18315 * Set v:char to character "c".
18317 void
18318 set_vim_var_char(c)
18319 int c;
18321 #ifdef FEAT_MBYTE
18322 char_u buf[MB_MAXBYTES];
18323 #else
18324 char_u buf[2];
18325 #endif
18327 #ifdef FEAT_MBYTE
18328 if (has_mbyte)
18329 buf[(*mb_char2bytes)(c, buf)] = NUL;
18330 else
18331 #endif
18333 buf[0] = c;
18334 buf[1] = NUL;
18336 set_vim_var_string(VV_CHAR, buf, -1);
18340 * Set v:count to "count" and v:count1 to "count1".
18341 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18343 void
18344 set_vcount(count, count1, set_prevcount)
18345 long count;
18346 long count1;
18347 int set_prevcount;
18349 if (set_prevcount)
18350 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18351 vimvars[VV_COUNT].vv_nr = count;
18352 vimvars[VV_COUNT1].vv_nr = count1;
18356 * Set string v: variable to a copy of "val".
18358 void
18359 set_vim_var_string(idx, val, len)
18360 int idx;
18361 char_u *val;
18362 int len; /* length of "val" to use or -1 (whole string) */
18364 /* Need to do this (at least) once, since we can't initialize a union.
18365 * Will always be invoked when "v:progname" is set. */
18366 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18368 vim_free(vimvars[idx].vv_str);
18369 if (val == NULL)
18370 vimvars[idx].vv_str = NULL;
18371 else if (len == -1)
18372 vimvars[idx].vv_str = vim_strsave(val);
18373 else
18374 vimvars[idx].vv_str = vim_strnsave(val, len);
18378 * Set List v: variable to "val".
18380 void
18381 set_vim_var_list(idx, val)
18382 int idx;
18383 list_T *val;
18385 list_unref(vimvars[idx].vv_list);
18386 vimvars[idx].vv_list = val;
18387 if (val != NULL)
18388 ++val->lv_refcount;
18392 * Set v:register if needed.
18394 void
18395 set_reg_var(c)
18396 int c;
18398 char_u regname;
18400 if (c == 0 || c == ' ')
18401 regname = '"';
18402 else
18403 regname = c;
18404 /* Avoid free/alloc when the value is already right. */
18405 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18406 set_vim_var_string(VV_REG, &regname, 1);
18410 * Get or set v:exception. If "oldval" == NULL, return the current value.
18411 * Otherwise, restore the value to "oldval" and return NULL.
18412 * Must always be called in pairs to save and restore v:exception! Does not
18413 * take care of memory allocations.
18415 char_u *
18416 v_exception(oldval)
18417 char_u *oldval;
18419 if (oldval == NULL)
18420 return vimvars[VV_EXCEPTION].vv_str;
18422 vimvars[VV_EXCEPTION].vv_str = oldval;
18423 return NULL;
18427 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18428 * Otherwise, restore the value to "oldval" and return NULL.
18429 * Must always be called in pairs to save and restore v:throwpoint! Does not
18430 * take care of memory allocations.
18432 char_u *
18433 v_throwpoint(oldval)
18434 char_u *oldval;
18436 if (oldval == NULL)
18437 return vimvars[VV_THROWPOINT].vv_str;
18439 vimvars[VV_THROWPOINT].vv_str = oldval;
18440 return NULL;
18443 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18445 * Set v:cmdarg.
18446 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18447 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18448 * Must always be called in pairs!
18450 char_u *
18451 set_cmdarg(eap, oldarg)
18452 exarg_T *eap;
18453 char_u *oldarg;
18455 char_u *oldval;
18456 char_u *newval;
18457 unsigned len;
18459 oldval = vimvars[VV_CMDARG].vv_str;
18460 if (eap == NULL)
18462 vim_free(oldval);
18463 vimvars[VV_CMDARG].vv_str = oldarg;
18464 return NULL;
18467 if (eap->force_bin == FORCE_BIN)
18468 len = 6;
18469 else if (eap->force_bin == FORCE_NOBIN)
18470 len = 8;
18471 else
18472 len = 0;
18474 if (eap->read_edit)
18475 len += 7;
18477 if (eap->force_ff != 0)
18478 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18479 # ifdef FEAT_MBYTE
18480 if (eap->force_enc != 0)
18481 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18482 if (eap->bad_char != 0)
18483 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18484 # endif
18486 newval = alloc(len + 1);
18487 if (newval == NULL)
18488 return NULL;
18490 if (eap->force_bin == FORCE_BIN)
18491 sprintf((char *)newval, " ++bin");
18492 else if (eap->force_bin == FORCE_NOBIN)
18493 sprintf((char *)newval, " ++nobin");
18494 else
18495 *newval = NUL;
18497 if (eap->read_edit)
18498 STRCAT(newval, " ++edit");
18500 if (eap->force_ff != 0)
18501 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18502 eap->cmd + eap->force_ff);
18503 # ifdef FEAT_MBYTE
18504 if (eap->force_enc != 0)
18505 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18506 eap->cmd + eap->force_enc);
18507 if (eap->bad_char != 0)
18508 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18509 eap->cmd + eap->bad_char);
18510 # endif
18511 vimvars[VV_CMDARG].vv_str = newval;
18512 return oldval;
18514 #endif
18517 * Get the value of internal variable "name".
18518 * Return OK or FAIL.
18520 static int
18521 get_var_tv(name, len, rettv, verbose)
18522 char_u *name;
18523 int len; /* length of "name" */
18524 typval_T *rettv; /* NULL when only checking existence */
18525 int verbose; /* may give error message */
18527 int ret = OK;
18528 typval_T *tv = NULL;
18529 typval_T atv;
18530 dictitem_T *v;
18531 int cc;
18533 /* truncate the name, so that we can use strcmp() */
18534 cc = name[len];
18535 name[len] = NUL;
18538 * Check for "b:changedtick".
18540 if (STRCMP(name, "b:changedtick") == 0)
18542 atv.v_type = VAR_NUMBER;
18543 atv.vval.v_number = curbuf->b_changedtick;
18544 tv = &atv;
18548 * Check for user-defined variables.
18550 else
18552 v = find_var(name, NULL);
18553 if (v != NULL)
18554 tv = &v->di_tv;
18557 if (tv == NULL)
18559 if (rettv != NULL && verbose)
18560 EMSG2(_(e_undefvar), name);
18561 ret = FAIL;
18563 else if (rettv != NULL)
18564 copy_tv(tv, rettv);
18566 name[len] = cc;
18568 return ret;
18572 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18573 * Also handle function call with Funcref variable: func(expr)
18574 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18576 static int
18577 handle_subscript(arg, rettv, evaluate, verbose)
18578 char_u **arg;
18579 typval_T *rettv;
18580 int evaluate; /* do more than finding the end */
18581 int verbose; /* give error messages */
18583 int ret = OK;
18584 dict_T *selfdict = NULL;
18585 char_u *s;
18586 int len;
18587 typval_T functv;
18589 while (ret == OK
18590 && (**arg == '['
18591 || (**arg == '.' && rettv->v_type == VAR_DICT)
18592 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18593 && !vim_iswhite(*(*arg - 1)))
18595 if (**arg == '(')
18597 /* need to copy the funcref so that we can clear rettv */
18598 functv = *rettv;
18599 rettv->v_type = VAR_UNKNOWN;
18601 /* Invoke the function. Recursive! */
18602 s = functv.vval.v_string;
18603 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18604 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18605 &len, evaluate, selfdict);
18607 /* Clear the funcref afterwards, so that deleting it while
18608 * evaluating the arguments is possible (see test55). */
18609 clear_tv(&functv);
18611 /* Stop the expression evaluation when immediately aborting on
18612 * error, or when an interrupt occurred or an exception was thrown
18613 * but not caught. */
18614 if (aborting())
18616 if (ret == OK)
18617 clear_tv(rettv);
18618 ret = FAIL;
18620 dict_unref(selfdict);
18621 selfdict = NULL;
18623 else /* **arg == '[' || **arg == '.' */
18625 dict_unref(selfdict);
18626 if (rettv->v_type == VAR_DICT)
18628 selfdict = rettv->vval.v_dict;
18629 if (selfdict != NULL)
18630 ++selfdict->dv_refcount;
18632 else
18633 selfdict = NULL;
18634 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18636 clear_tv(rettv);
18637 ret = FAIL;
18641 dict_unref(selfdict);
18642 return ret;
18646 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18647 * value).
18649 static typval_T *
18650 alloc_tv()
18652 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18656 * Allocate memory for a variable type-value, and assign a string to it.
18657 * The string "s" must have been allocated, it is consumed.
18658 * Return NULL for out of memory, the variable otherwise.
18660 static typval_T *
18661 alloc_string_tv(s)
18662 char_u *s;
18664 typval_T *rettv;
18666 rettv = alloc_tv();
18667 if (rettv != NULL)
18669 rettv->v_type = VAR_STRING;
18670 rettv->vval.v_string = s;
18672 else
18673 vim_free(s);
18674 return rettv;
18678 * Free the memory for a variable type-value.
18680 void
18681 free_tv(varp)
18682 typval_T *varp;
18684 if (varp != NULL)
18686 switch (varp->v_type)
18688 case VAR_FUNC:
18689 func_unref(varp->vval.v_string);
18690 /*FALLTHROUGH*/
18691 case VAR_STRING:
18692 vim_free(varp->vval.v_string);
18693 break;
18694 case VAR_LIST:
18695 list_unref(varp->vval.v_list);
18696 break;
18697 case VAR_DICT:
18698 dict_unref(varp->vval.v_dict);
18699 break;
18700 case VAR_NUMBER:
18701 #ifdef FEAT_FLOAT
18702 case VAR_FLOAT:
18703 #endif
18704 case VAR_UNKNOWN:
18705 break;
18706 default:
18707 EMSG2(_(e_intern2), "free_tv()");
18708 break;
18710 vim_free(varp);
18715 * Free the memory for a variable value and set the value to NULL or 0.
18717 void
18718 clear_tv(varp)
18719 typval_T *varp;
18721 if (varp != NULL)
18723 switch (varp->v_type)
18725 case VAR_FUNC:
18726 func_unref(varp->vval.v_string);
18727 /*FALLTHROUGH*/
18728 case VAR_STRING:
18729 vim_free(varp->vval.v_string);
18730 varp->vval.v_string = NULL;
18731 break;
18732 case VAR_LIST:
18733 list_unref(varp->vval.v_list);
18734 varp->vval.v_list = NULL;
18735 break;
18736 case VAR_DICT:
18737 dict_unref(varp->vval.v_dict);
18738 varp->vval.v_dict = NULL;
18739 break;
18740 case VAR_NUMBER:
18741 varp->vval.v_number = 0;
18742 break;
18743 #ifdef FEAT_FLOAT
18744 case VAR_FLOAT:
18745 varp->vval.v_float = 0.0;
18746 break;
18747 #endif
18748 case VAR_UNKNOWN:
18749 break;
18750 default:
18751 EMSG2(_(e_intern2), "clear_tv()");
18753 varp->v_lock = 0;
18758 * Set the value of a variable to NULL without freeing items.
18760 static void
18761 init_tv(varp)
18762 typval_T *varp;
18764 if (varp != NULL)
18765 vim_memset(varp, 0, sizeof(typval_T));
18769 * Get the number value of a variable.
18770 * If it is a String variable, uses vim_str2nr().
18771 * For incompatible types, return 0.
18772 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18773 * caller of incompatible types: it sets *denote to TRUE if "denote"
18774 * is not NULL or returns -1 otherwise.
18776 static long
18777 get_tv_number(varp)
18778 typval_T *varp;
18780 int error = FALSE;
18782 return get_tv_number_chk(varp, &error); /* return 0L on error */
18785 long
18786 get_tv_number_chk(varp, denote)
18787 typval_T *varp;
18788 int *denote;
18790 long n = 0L;
18792 switch (varp->v_type)
18794 case VAR_NUMBER:
18795 return (long)(varp->vval.v_number);
18796 #ifdef FEAT_FLOAT
18797 case VAR_FLOAT:
18798 EMSG(_("E805: Using a Float as a Number"));
18799 break;
18800 #endif
18801 case VAR_FUNC:
18802 EMSG(_("E703: Using a Funcref as a Number"));
18803 break;
18804 case VAR_STRING:
18805 if (varp->vval.v_string != NULL)
18806 vim_str2nr(varp->vval.v_string, NULL, NULL,
18807 TRUE, TRUE, &n, NULL);
18808 return n;
18809 case VAR_LIST:
18810 EMSG(_("E745: Using a List as a Number"));
18811 break;
18812 case VAR_DICT:
18813 EMSG(_("E728: Using a Dictionary as a Number"));
18814 break;
18815 default:
18816 EMSG2(_(e_intern2), "get_tv_number()");
18817 break;
18819 if (denote == NULL) /* useful for values that must be unsigned */
18820 n = -1;
18821 else
18822 *denote = TRUE;
18823 return n;
18827 * Get the lnum from the first argument.
18828 * Also accepts ".", "$", etc., but that only works for the current buffer.
18829 * Returns -1 on error.
18831 static linenr_T
18832 get_tv_lnum(argvars)
18833 typval_T *argvars;
18835 typval_T rettv;
18836 linenr_T lnum;
18838 lnum = get_tv_number_chk(&argvars[0], NULL);
18839 if (lnum == 0) /* no valid number, try using line() */
18841 rettv.v_type = VAR_NUMBER;
18842 f_line(argvars, &rettv);
18843 lnum = rettv.vval.v_number;
18844 clear_tv(&rettv);
18846 return lnum;
18850 * Get the lnum from the first argument.
18851 * Also accepts "$", then "buf" is used.
18852 * Returns 0 on error.
18854 static linenr_T
18855 get_tv_lnum_buf(argvars, buf)
18856 typval_T *argvars;
18857 buf_T *buf;
18859 if (argvars[0].v_type == VAR_STRING
18860 && argvars[0].vval.v_string != NULL
18861 && argvars[0].vval.v_string[0] == '$'
18862 && buf != NULL)
18863 return buf->b_ml.ml_line_count;
18864 return get_tv_number_chk(&argvars[0], NULL);
18868 * Get the string value of a variable.
18869 * If it is a Number variable, the number is converted into a string.
18870 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18871 * get_tv_string_buf() uses a given buffer.
18872 * If the String variable has never been set, return an empty string.
18873 * Never returns NULL;
18874 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18875 * NULL on error.
18877 static char_u *
18878 get_tv_string(varp)
18879 typval_T *varp;
18881 static char_u mybuf[NUMBUFLEN];
18883 return get_tv_string_buf(varp, mybuf);
18886 static char_u *
18887 get_tv_string_buf(varp, buf)
18888 typval_T *varp;
18889 char_u *buf;
18891 char_u *res = get_tv_string_buf_chk(varp, buf);
18893 return res != NULL ? res : (char_u *)"";
18896 char_u *
18897 get_tv_string_chk(varp)
18898 typval_T *varp;
18900 static char_u mybuf[NUMBUFLEN];
18902 return get_tv_string_buf_chk(varp, mybuf);
18905 static char_u *
18906 get_tv_string_buf_chk(varp, buf)
18907 typval_T *varp;
18908 char_u *buf;
18910 switch (varp->v_type)
18912 case VAR_NUMBER:
18913 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18914 return buf;
18915 case VAR_FUNC:
18916 EMSG(_("E729: using Funcref as a String"));
18917 break;
18918 case VAR_LIST:
18919 EMSG(_("E730: using List as a String"));
18920 break;
18921 case VAR_DICT:
18922 EMSG(_("E731: using Dictionary as a String"));
18923 break;
18924 #ifdef FEAT_FLOAT
18925 case VAR_FLOAT:
18926 EMSG(_("E806: using Float as a String"));
18927 break;
18928 #endif
18929 case VAR_STRING:
18930 if (varp->vval.v_string != NULL)
18931 return varp->vval.v_string;
18932 return (char_u *)"";
18933 default:
18934 EMSG2(_(e_intern2), "get_tv_string_buf()");
18935 break;
18937 return NULL;
18941 * Find variable "name" in the list of variables.
18942 * Return a pointer to it if found, NULL if not found.
18943 * Careful: "a:0" variables don't have a name.
18944 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18945 * hashtab_T used.
18947 static dictitem_T *
18948 find_var(name, htp)
18949 char_u *name;
18950 hashtab_T **htp;
18952 char_u *varname;
18953 hashtab_T *ht;
18955 ht = find_var_ht(name, &varname);
18956 if (htp != NULL)
18957 *htp = ht;
18958 if (ht == NULL)
18959 return NULL;
18960 return find_var_in_ht(ht, varname, htp != NULL);
18964 * Find variable "varname" in hashtab "ht".
18965 * Returns NULL if not found.
18967 static dictitem_T *
18968 find_var_in_ht(ht, varname, writing)
18969 hashtab_T *ht;
18970 char_u *varname;
18971 int writing;
18973 hashitem_T *hi;
18975 if (*varname == NUL)
18977 /* Must be something like "s:", otherwise "ht" would be NULL. */
18978 switch (varname[-2])
18980 case 's': return &SCRIPT_SV(current_SID).sv_var;
18981 case 'g': return &globvars_var;
18982 case 'v': return &vimvars_var;
18983 case 'b': return &curbuf->b_bufvar;
18984 case 'w': return &curwin->w_winvar;
18985 #ifdef FEAT_WINDOWS
18986 case 't': return &curtab->tp_winvar;
18987 #endif
18988 case 'l': return current_funccal == NULL
18989 ? NULL : &current_funccal->l_vars_var;
18990 case 'a': return current_funccal == NULL
18991 ? NULL : &current_funccal->l_avars_var;
18993 return NULL;
18996 hi = hash_find(ht, varname);
18997 if (HASHITEM_EMPTY(hi))
18999 /* For global variables we may try auto-loading the script. If it
19000 * worked find the variable again. Don't auto-load a script if it was
19001 * loaded already, otherwise it would be loaded every time when
19002 * checking if a function name is a Funcref variable. */
19003 if (ht == &globvarht && !writing
19004 && script_autoload(varname, FALSE) && !aborting())
19005 hi = hash_find(ht, varname);
19006 if (HASHITEM_EMPTY(hi))
19007 return NULL;
19009 return HI2DI(hi);
19013 * Find the hashtab used for a variable name.
19014 * Set "varname" to the start of name without ':'.
19016 static hashtab_T *
19017 find_var_ht(name, varname)
19018 char_u *name;
19019 char_u **varname;
19021 hashitem_T *hi;
19023 if (name[1] != ':')
19025 /* The name must not start with a colon or #. */
19026 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
19027 return NULL;
19028 *varname = name;
19030 /* "version" is "v:version" in all scopes */
19031 hi = hash_find(&compat_hashtab, name);
19032 if (!HASHITEM_EMPTY(hi))
19033 return &compat_hashtab;
19035 if (current_funccal == NULL)
19036 return &globvarht; /* global variable */
19037 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
19039 *varname = name + 2;
19040 if (*name == 'g') /* global variable */
19041 return &globvarht;
19042 /* There must be no ':' or '#' in the rest of the name, unless g: is used
19044 if (vim_strchr(name + 2, ':') != NULL
19045 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
19046 return NULL;
19047 if (*name == 'b') /* buffer variable */
19048 return &curbuf->b_vars.dv_hashtab;
19049 if (*name == 'w') /* window variable */
19050 return &curwin->w_vars.dv_hashtab;
19051 #ifdef FEAT_WINDOWS
19052 if (*name == 't') /* tab page variable */
19053 return &curtab->tp_vars.dv_hashtab;
19054 #endif
19055 if (*name == 'v') /* v: variable */
19056 return &vimvarht;
19057 if (*name == 'a' && current_funccal != NULL) /* function argument */
19058 return &current_funccal->l_avars.dv_hashtab;
19059 if (*name == 'l' && current_funccal != NULL) /* local function variable */
19060 return &current_funccal->l_vars.dv_hashtab;
19061 if (*name == 's' /* script variable */
19062 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
19063 return &SCRIPT_VARS(current_SID);
19064 return NULL;
19068 * Get the string value of a (global/local) variable.
19069 * Returns NULL when it doesn't exist.
19071 char_u *
19072 get_var_value(name)
19073 char_u *name;
19075 dictitem_T *v;
19077 v = find_var(name, NULL);
19078 if (v == NULL)
19079 return NULL;
19080 return get_tv_string(&v->di_tv);
19084 * Allocate a new hashtab for a sourced script. It will be used while
19085 * sourcing this script and when executing functions defined in the script.
19087 void
19088 new_script_vars(id)
19089 scid_T id;
19091 int i;
19092 hashtab_T *ht;
19093 scriptvar_T *sv;
19095 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
19097 /* Re-allocating ga_data means that an ht_array pointing to
19098 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
19099 * at its init value. Also reset "v_dict", it's always the same. */
19100 for (i = 1; i <= ga_scripts.ga_len; ++i)
19102 ht = &SCRIPT_VARS(i);
19103 if (ht->ht_mask == HT_INIT_SIZE - 1)
19104 ht->ht_array = ht->ht_smallarray;
19105 sv = &SCRIPT_SV(i);
19106 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
19109 while (ga_scripts.ga_len < id)
19111 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
19112 init_var_dict(&sv->sv_dict, &sv->sv_var);
19113 ++ga_scripts.ga_len;
19119 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
19120 * point to it.
19122 void
19123 init_var_dict(dict, dict_var)
19124 dict_T *dict;
19125 dictitem_T *dict_var;
19127 hash_init(&dict->dv_hashtab);
19128 dict->dv_refcount = DO_NOT_FREE_CNT;
19129 dict->dv_copyID = 0;
19130 dict_var->di_tv.vval.v_dict = dict;
19131 dict_var->di_tv.v_type = VAR_DICT;
19132 dict_var->di_tv.v_lock = VAR_FIXED;
19133 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
19134 dict_var->di_key[0] = NUL;
19138 * Clean up a list of internal variables.
19139 * Frees all allocated variables and the value they contain.
19140 * Clears hashtab "ht", does not free it.
19142 void
19143 vars_clear(ht)
19144 hashtab_T *ht;
19146 vars_clear_ext(ht, TRUE);
19150 * Like vars_clear(), but only free the value if "free_val" is TRUE.
19152 static void
19153 vars_clear_ext(ht, free_val)
19154 hashtab_T *ht;
19155 int free_val;
19157 int todo;
19158 hashitem_T *hi;
19159 dictitem_T *v;
19161 hash_lock(ht);
19162 todo = (int)ht->ht_used;
19163 for (hi = ht->ht_array; todo > 0; ++hi)
19165 if (!HASHITEM_EMPTY(hi))
19167 --todo;
19169 /* Free the variable. Don't remove it from the hashtab,
19170 * ht_array might change then. hash_clear() takes care of it
19171 * later. */
19172 v = HI2DI(hi);
19173 if (free_val)
19174 clear_tv(&v->di_tv);
19175 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19176 vim_free(v);
19179 hash_clear(ht);
19180 ht->ht_used = 0;
19184 * Delete a variable from hashtab "ht" at item "hi".
19185 * Clear the variable value and free the dictitem.
19187 static void
19188 delete_var(ht, hi)
19189 hashtab_T *ht;
19190 hashitem_T *hi;
19192 dictitem_T *di = HI2DI(hi);
19194 hash_remove(ht, hi);
19195 clear_tv(&di->di_tv);
19196 vim_free(di);
19200 * List the value of one internal variable.
19202 static void
19203 list_one_var(v, prefix, first)
19204 dictitem_T *v;
19205 char_u *prefix;
19206 int *first;
19208 char_u *tofree;
19209 char_u *s;
19210 char_u numbuf[NUMBUFLEN];
19212 current_copyID += COPYID_INC;
19213 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19214 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19215 s == NULL ? (char_u *)"" : s, first);
19216 vim_free(tofree);
19219 static void
19220 list_one_var_a(prefix, name, type, string, first)
19221 char_u *prefix;
19222 char_u *name;
19223 int type;
19224 char_u *string;
19225 int *first; /* when TRUE clear rest of screen and set to FALSE */
19227 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19228 msg_start();
19229 msg_puts(prefix);
19230 if (name != NULL) /* "a:" vars don't have a name stored */
19231 msg_puts(name);
19232 msg_putchar(' ');
19233 msg_advance(22);
19234 if (type == VAR_NUMBER)
19235 msg_putchar('#');
19236 else if (type == VAR_FUNC)
19237 msg_putchar('*');
19238 else if (type == VAR_LIST)
19240 msg_putchar('[');
19241 if (*string == '[')
19242 ++string;
19244 else if (type == VAR_DICT)
19246 msg_putchar('{');
19247 if (*string == '{')
19248 ++string;
19250 else
19251 msg_putchar(' ');
19253 msg_outtrans(string);
19255 if (type == VAR_FUNC)
19256 msg_puts((char_u *)"()");
19257 if (*first)
19259 msg_clr_eos();
19260 *first = FALSE;
19265 * Set variable "name" to value in "tv".
19266 * If the variable already exists, the value is updated.
19267 * Otherwise the variable is created.
19269 static void
19270 set_var(name, tv, copy)
19271 char_u *name;
19272 typval_T *tv;
19273 int copy; /* make copy of value in "tv" */
19275 dictitem_T *v;
19276 char_u *varname;
19277 hashtab_T *ht;
19278 char_u *p;
19280 if (tv->v_type == VAR_FUNC)
19282 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19283 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19284 ? name[2] : name[0]))
19286 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19287 return;
19289 if (function_exists(name))
19291 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19292 name);
19293 return;
19297 ht = find_var_ht(name, &varname);
19298 if (ht == NULL || *varname == NUL)
19300 EMSG2(_(e_illvar), name);
19301 return;
19304 v = find_var_in_ht(ht, varname, TRUE);
19305 if (v != NULL)
19307 /* existing variable, need to clear the value */
19308 if (var_check_ro(v->di_flags, name)
19309 || tv_check_lock(v->di_tv.v_lock, name))
19310 return;
19311 if (v->di_tv.v_type != tv->v_type
19312 && !((v->di_tv.v_type == VAR_STRING
19313 || v->di_tv.v_type == VAR_NUMBER)
19314 && (tv->v_type == VAR_STRING
19315 || tv->v_type == VAR_NUMBER))
19316 #ifdef FEAT_FLOAT
19317 && !((v->di_tv.v_type == VAR_NUMBER
19318 || v->di_tv.v_type == VAR_FLOAT)
19319 && (tv->v_type == VAR_NUMBER
19320 || tv->v_type == VAR_FLOAT))
19321 #endif
19324 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19325 return;
19329 * Handle setting internal v: variables separately: we don't change
19330 * the type.
19332 if (ht == &vimvarht)
19334 if (v->di_tv.v_type == VAR_STRING)
19336 vim_free(v->di_tv.vval.v_string);
19337 if (copy || tv->v_type != VAR_STRING)
19338 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19339 else
19341 /* Take over the string to avoid an extra alloc/free. */
19342 v->di_tv.vval.v_string = tv->vval.v_string;
19343 tv->vval.v_string = NULL;
19346 else if (v->di_tv.v_type != VAR_NUMBER)
19347 EMSG2(_(e_intern2), "set_var()");
19348 else
19350 v->di_tv.vval.v_number = get_tv_number(tv);
19351 if (STRCMP(varname, "searchforward") == 0)
19352 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19354 return;
19357 clear_tv(&v->di_tv);
19359 else /* add a new variable */
19361 /* Can't add "v:" variable. */
19362 if (ht == &vimvarht)
19364 EMSG2(_(e_illvar), name);
19365 return;
19368 /* Make sure the variable name is valid. */
19369 for (p = varname; *p != NUL; ++p)
19370 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19371 && *p != AUTOLOAD_CHAR)
19373 EMSG2(_(e_illvar), varname);
19374 return;
19377 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19378 + STRLEN(varname)));
19379 if (v == NULL)
19380 return;
19381 STRCPY(v->di_key, varname);
19382 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19384 vim_free(v);
19385 return;
19387 v->di_flags = 0;
19390 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19391 copy_tv(tv, &v->di_tv);
19392 else
19394 v->di_tv = *tv;
19395 v->di_tv.v_lock = 0;
19396 init_tv(tv);
19401 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19402 * Also give an error message.
19404 static int
19405 var_check_ro(flags, name)
19406 int flags;
19407 char_u *name;
19409 if (flags & DI_FLAGS_RO)
19411 EMSG2(_(e_readonlyvar), name);
19412 return TRUE;
19414 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19416 EMSG2(_(e_readonlysbx), name);
19417 return TRUE;
19419 return FALSE;
19423 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19424 * Also give an error message.
19426 static int
19427 var_check_fixed(flags, name)
19428 int flags;
19429 char_u *name;
19431 if (flags & DI_FLAGS_FIX)
19433 EMSG2(_("E795: Cannot delete variable %s"), name);
19434 return TRUE;
19436 return FALSE;
19440 * Return TRUE if typeval "tv" is set to be locked (immutable).
19441 * Also give an error message, using "name".
19443 static int
19444 tv_check_lock(lock, name)
19445 int lock;
19446 char_u *name;
19448 if (lock & VAR_LOCKED)
19450 EMSG2(_("E741: Value is locked: %s"),
19451 name == NULL ? (char_u *)_("Unknown") : name);
19452 return TRUE;
19454 if (lock & VAR_FIXED)
19456 EMSG2(_("E742: Cannot change value of %s"),
19457 name == NULL ? (char_u *)_("Unknown") : name);
19458 return TRUE;
19460 return FALSE;
19464 * Copy the values from typval_T "from" to typval_T "to".
19465 * When needed allocates string or increases reference count.
19466 * Does not make a copy of a list or dict but copies the reference!
19467 * It is OK for "from" and "to" to point to the same item. This is used to
19468 * make a copy later.
19470 static void
19471 copy_tv(from, to)
19472 typval_T *from;
19473 typval_T *to;
19475 to->v_type = from->v_type;
19476 to->v_lock = 0;
19477 switch (from->v_type)
19479 case VAR_NUMBER:
19480 to->vval.v_number = from->vval.v_number;
19481 break;
19482 #ifdef FEAT_FLOAT
19483 case VAR_FLOAT:
19484 to->vval.v_float = from->vval.v_float;
19485 break;
19486 #endif
19487 case VAR_STRING:
19488 case VAR_FUNC:
19489 if (from->vval.v_string == NULL)
19490 to->vval.v_string = NULL;
19491 else
19493 to->vval.v_string = vim_strsave(from->vval.v_string);
19494 if (from->v_type == VAR_FUNC)
19495 func_ref(to->vval.v_string);
19497 break;
19498 case VAR_LIST:
19499 if (from->vval.v_list == NULL)
19500 to->vval.v_list = NULL;
19501 else
19503 to->vval.v_list = from->vval.v_list;
19504 ++to->vval.v_list->lv_refcount;
19506 break;
19507 case VAR_DICT:
19508 if (from->vval.v_dict == NULL)
19509 to->vval.v_dict = NULL;
19510 else
19512 to->vval.v_dict = from->vval.v_dict;
19513 ++to->vval.v_dict->dv_refcount;
19515 break;
19516 default:
19517 EMSG2(_(e_intern2), "copy_tv()");
19518 break;
19523 * Make a copy of an item.
19524 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19525 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19526 * reference to an already copied list/dict can be used.
19527 * Returns FAIL or OK.
19529 static int
19530 item_copy(from, to, deep, copyID)
19531 typval_T *from;
19532 typval_T *to;
19533 int deep;
19534 int copyID;
19536 static int recurse = 0;
19537 int ret = OK;
19539 if (recurse >= DICT_MAXNEST)
19541 EMSG(_("E698: variable nested too deep for making a copy"));
19542 return FAIL;
19544 ++recurse;
19546 switch (from->v_type)
19548 case VAR_NUMBER:
19549 #ifdef FEAT_FLOAT
19550 case VAR_FLOAT:
19551 #endif
19552 case VAR_STRING:
19553 case VAR_FUNC:
19554 copy_tv(from, to);
19555 break;
19556 case VAR_LIST:
19557 to->v_type = VAR_LIST;
19558 to->v_lock = 0;
19559 if (from->vval.v_list == NULL)
19560 to->vval.v_list = NULL;
19561 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19563 /* use the copy made earlier */
19564 to->vval.v_list = from->vval.v_list->lv_copylist;
19565 ++to->vval.v_list->lv_refcount;
19567 else
19568 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19569 if (to->vval.v_list == NULL)
19570 ret = FAIL;
19571 break;
19572 case VAR_DICT:
19573 to->v_type = VAR_DICT;
19574 to->v_lock = 0;
19575 if (from->vval.v_dict == NULL)
19576 to->vval.v_dict = NULL;
19577 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19579 /* use the copy made earlier */
19580 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19581 ++to->vval.v_dict->dv_refcount;
19583 else
19584 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19585 if (to->vval.v_dict == NULL)
19586 ret = FAIL;
19587 break;
19588 default:
19589 EMSG2(_(e_intern2), "item_copy()");
19590 ret = FAIL;
19592 --recurse;
19593 return ret;
19597 * ":echo expr1 ..." print each argument separated with a space, add a
19598 * newline at the end.
19599 * ":echon expr1 ..." print each argument plain.
19601 void
19602 ex_echo(eap)
19603 exarg_T *eap;
19605 char_u *arg = eap->arg;
19606 typval_T rettv;
19607 char_u *tofree;
19608 char_u *p;
19609 int needclr = TRUE;
19610 int atstart = TRUE;
19611 char_u numbuf[NUMBUFLEN];
19613 if (eap->skip)
19614 ++emsg_skip;
19615 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19617 /* If eval1() causes an error message the text from the command may
19618 * still need to be cleared. E.g., "echo 22,44". */
19619 need_clr_eos = needclr;
19621 p = arg;
19622 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19625 * Report the invalid expression unless the expression evaluation
19626 * has been cancelled due to an aborting error, an interrupt, or an
19627 * exception.
19629 if (!aborting())
19630 EMSG2(_(e_invexpr2), p);
19631 need_clr_eos = FALSE;
19632 break;
19634 need_clr_eos = FALSE;
19636 if (!eap->skip)
19638 if (atstart)
19640 atstart = FALSE;
19641 /* Call msg_start() after eval1(), evaluating the expression
19642 * may cause a message to appear. */
19643 if (eap->cmdidx == CMD_echo)
19644 msg_start();
19646 else if (eap->cmdidx == CMD_echo)
19647 msg_puts_attr((char_u *)" ", echo_attr);
19648 current_copyID += COPYID_INC;
19649 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19650 if (p != NULL)
19651 for ( ; *p != NUL && !got_int; ++p)
19653 if (*p == '\n' || *p == '\r' || *p == TAB)
19655 if (*p != TAB && needclr)
19657 /* remove any text still there from the command */
19658 msg_clr_eos();
19659 needclr = FALSE;
19661 msg_putchar_attr(*p, echo_attr);
19663 else
19665 #ifdef FEAT_MBYTE
19666 if (has_mbyte)
19668 int i = (*mb_ptr2len)(p);
19670 (void)msg_outtrans_len_attr(p, i, echo_attr);
19671 p += i - 1;
19673 else
19674 #endif
19675 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19678 vim_free(tofree);
19680 clear_tv(&rettv);
19681 arg = skipwhite(arg);
19683 eap->nextcmd = check_nextcmd(arg);
19685 if (eap->skip)
19686 --emsg_skip;
19687 else
19689 /* remove text that may still be there from the command */
19690 if (needclr)
19691 msg_clr_eos();
19692 if (eap->cmdidx == CMD_echo)
19693 msg_end();
19698 * ":echohl {name}".
19700 void
19701 ex_echohl(eap)
19702 exarg_T *eap;
19704 int id;
19706 id = syn_name2id(eap->arg);
19707 if (id == 0)
19708 echo_attr = 0;
19709 else
19710 echo_attr = syn_id2attr(id);
19714 * ":execute expr1 ..." execute the result of an expression.
19715 * ":echomsg expr1 ..." Print a message
19716 * ":echoerr expr1 ..." Print an error
19717 * Each gets spaces around each argument and a newline at the end for
19718 * echo commands
19720 void
19721 ex_execute(eap)
19722 exarg_T *eap;
19724 char_u *arg = eap->arg;
19725 typval_T rettv;
19726 int ret = OK;
19727 char_u *p;
19728 garray_T ga;
19729 int len;
19730 int save_did_emsg;
19732 ga_init2(&ga, 1, 80);
19734 if (eap->skip)
19735 ++emsg_skip;
19736 while (*arg != NUL && *arg != '|' && *arg != '\n')
19738 p = arg;
19739 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19742 * Report the invalid expression unless the expression evaluation
19743 * has been cancelled due to an aborting error, an interrupt, or an
19744 * exception.
19746 if (!aborting())
19747 EMSG2(_(e_invexpr2), p);
19748 ret = FAIL;
19749 break;
19752 if (!eap->skip)
19754 p = get_tv_string(&rettv);
19755 len = (int)STRLEN(p);
19756 if (ga_grow(&ga, len + 2) == FAIL)
19758 clear_tv(&rettv);
19759 ret = FAIL;
19760 break;
19762 if (ga.ga_len)
19763 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19764 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19765 ga.ga_len += len;
19768 clear_tv(&rettv);
19769 arg = skipwhite(arg);
19772 if (ret != FAIL && ga.ga_data != NULL)
19774 if (eap->cmdidx == CMD_echomsg)
19776 MSG_ATTR(ga.ga_data, echo_attr);
19777 out_flush();
19779 else if (eap->cmdidx == CMD_echoerr)
19781 /* We don't want to abort following commands, restore did_emsg. */
19782 save_did_emsg = did_emsg;
19783 EMSG((char_u *)ga.ga_data);
19784 if (!force_abort)
19785 did_emsg = save_did_emsg;
19787 else if (eap->cmdidx == CMD_execute)
19788 do_cmdline((char_u *)ga.ga_data,
19789 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19792 ga_clear(&ga);
19794 if (eap->skip)
19795 --emsg_skip;
19797 eap->nextcmd = check_nextcmd(arg);
19801 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19802 * "arg" points to the "&" or '+' when called, to "option" when returning.
19803 * Returns NULL when no option name found. Otherwise pointer to the char
19804 * after the option name.
19806 static char_u *
19807 find_option_end(arg, opt_flags)
19808 char_u **arg;
19809 int *opt_flags;
19811 char_u *p = *arg;
19813 ++p;
19814 if (*p == 'g' && p[1] == ':')
19816 *opt_flags = OPT_GLOBAL;
19817 p += 2;
19819 else if (*p == 'l' && p[1] == ':')
19821 *opt_flags = OPT_LOCAL;
19822 p += 2;
19824 else
19825 *opt_flags = 0;
19827 if (!ASCII_ISALPHA(*p))
19828 return NULL;
19829 *arg = p;
19831 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19832 p += 4; /* termcap option */
19833 else
19834 while (ASCII_ISALPHA(*p))
19835 ++p;
19836 return p;
19840 * ":function"
19842 void
19843 ex_function(eap)
19844 exarg_T *eap;
19846 char_u *theline;
19847 int j;
19848 int c;
19849 int saved_did_emsg;
19850 char_u *name = NULL;
19851 char_u *p;
19852 char_u *arg;
19853 char_u *line_arg = NULL;
19854 garray_T newargs;
19855 garray_T newlines;
19856 int varargs = FALSE;
19857 int mustend = FALSE;
19858 int flags = 0;
19859 ufunc_T *fp;
19860 int indent;
19861 int nesting;
19862 char_u *skip_until = NULL;
19863 dictitem_T *v;
19864 funcdict_T fudi;
19865 static int func_nr = 0; /* number for nameless function */
19866 int paren;
19867 hashtab_T *ht;
19868 int todo;
19869 hashitem_T *hi;
19870 int sourcing_lnum_off;
19873 * ":function" without argument: list functions.
19875 if (ends_excmd(*eap->arg))
19877 if (!eap->skip)
19879 todo = (int)func_hashtab.ht_used;
19880 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19882 if (!HASHITEM_EMPTY(hi))
19884 --todo;
19885 fp = HI2UF(hi);
19886 if (!isdigit(*fp->uf_name))
19887 list_func_head(fp, FALSE);
19891 eap->nextcmd = check_nextcmd(eap->arg);
19892 return;
19896 * ":function /pat": list functions matching pattern.
19898 if (*eap->arg == '/')
19900 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19901 if (!eap->skip)
19903 regmatch_T regmatch;
19905 c = *p;
19906 *p = NUL;
19907 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19908 *p = c;
19909 if (regmatch.regprog != NULL)
19911 regmatch.rm_ic = p_ic;
19913 todo = (int)func_hashtab.ht_used;
19914 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19916 if (!HASHITEM_EMPTY(hi))
19918 --todo;
19919 fp = HI2UF(hi);
19920 if (!isdigit(*fp->uf_name)
19921 && vim_regexec(&regmatch, fp->uf_name, 0))
19922 list_func_head(fp, FALSE);
19925 vim_free(regmatch.regprog);
19928 if (*p == '/')
19929 ++p;
19930 eap->nextcmd = check_nextcmd(p);
19931 return;
19935 * Get the function name. There are these situations:
19936 * func normal function name
19937 * "name" == func, "fudi.fd_dict" == NULL
19938 * dict.func new dictionary entry
19939 * "name" == NULL, "fudi.fd_dict" set,
19940 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19941 * dict.func existing dict entry with a Funcref
19942 * "name" == func, "fudi.fd_dict" set,
19943 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19944 * dict.func existing dict entry that's not a Funcref
19945 * "name" == NULL, "fudi.fd_dict" set,
19946 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19948 p = eap->arg;
19949 name = trans_function_name(&p, eap->skip, 0, &fudi);
19950 paren = (vim_strchr(p, '(') != NULL);
19951 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19954 * Return on an invalid expression in braces, unless the expression
19955 * evaluation has been cancelled due to an aborting error, an
19956 * interrupt, or an exception.
19958 if (!aborting())
19960 if (!eap->skip && fudi.fd_newkey != NULL)
19961 EMSG2(_(e_dictkey), fudi.fd_newkey);
19962 vim_free(fudi.fd_newkey);
19963 return;
19965 else
19966 eap->skip = TRUE;
19969 /* An error in a function call during evaluation of an expression in magic
19970 * braces should not cause the function not to be defined. */
19971 saved_did_emsg = did_emsg;
19972 did_emsg = FALSE;
19975 * ":function func" with only function name: list function.
19977 if (!paren)
19979 if (!ends_excmd(*skipwhite(p)))
19981 EMSG(_(e_trailing));
19982 goto ret_free;
19984 eap->nextcmd = check_nextcmd(p);
19985 if (eap->nextcmd != NULL)
19986 *p = NUL;
19987 if (!eap->skip && !got_int)
19989 fp = find_func(name);
19990 if (fp != NULL)
19992 list_func_head(fp, TRUE);
19993 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
19995 if (FUNCLINE(fp, j) == NULL)
19996 continue;
19997 msg_putchar('\n');
19998 msg_outnum((long)(j + 1));
19999 if (j < 9)
20000 msg_putchar(' ');
20001 if (j < 99)
20002 msg_putchar(' ');
20003 msg_prt_line(FUNCLINE(fp, j), FALSE);
20004 out_flush(); /* show a line at a time */
20005 ui_breakcheck();
20007 if (!got_int)
20009 msg_putchar('\n');
20010 msg_puts((char_u *)" endfunction");
20013 else
20014 emsg_funcname(N_("E123: Undefined function: %s"), name);
20016 goto ret_free;
20020 * ":function name(arg1, arg2)" Define function.
20022 p = skipwhite(p);
20023 if (*p != '(')
20025 if (!eap->skip)
20027 EMSG2(_("E124: Missing '(': %s"), eap->arg);
20028 goto ret_free;
20030 /* attempt to continue by skipping some text */
20031 if (vim_strchr(p, '(') != NULL)
20032 p = vim_strchr(p, '(');
20034 p = skipwhite(p + 1);
20036 ga_init2(&newargs, (int)sizeof(char_u *), 3);
20037 ga_init2(&newlines, (int)sizeof(char_u *), 3);
20039 if (!eap->skip)
20041 /* Check the name of the function. Unless it's a dictionary function
20042 * (that we are overwriting). */
20043 if (name != NULL)
20044 arg = name;
20045 else
20046 arg = fudi.fd_newkey;
20047 if (arg != NULL && (fudi.fd_di == NULL
20048 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
20050 if (*arg == K_SPECIAL)
20051 j = 3;
20052 else
20053 j = 0;
20054 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
20055 : eval_isnamec(arg[j])))
20056 ++j;
20057 if (arg[j] != NUL)
20058 emsg_funcname((char *)e_invarg2, arg);
20063 * Isolate the arguments: "arg1, arg2, ...)"
20065 while (*p != ')')
20067 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
20069 varargs = TRUE;
20070 p += 3;
20071 mustend = TRUE;
20073 else
20075 arg = p;
20076 while (ASCII_ISALNUM(*p) || *p == '_')
20077 ++p;
20078 if (arg == p || isdigit(*arg)
20079 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
20080 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
20082 if (!eap->skip)
20083 EMSG2(_("E125: Illegal argument: %s"), arg);
20084 break;
20086 if (ga_grow(&newargs, 1) == FAIL)
20087 goto erret;
20088 c = *p;
20089 *p = NUL;
20090 arg = vim_strsave(arg);
20091 if (arg == NULL)
20092 goto erret;
20093 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
20094 *p = c;
20095 newargs.ga_len++;
20096 if (*p == ',')
20097 ++p;
20098 else
20099 mustend = TRUE;
20101 p = skipwhite(p);
20102 if (mustend && *p != ')')
20104 if (!eap->skip)
20105 EMSG2(_(e_invarg2), eap->arg);
20106 break;
20109 ++p; /* skip the ')' */
20111 /* find extra arguments "range", "dict" and "abort" */
20112 for (;;)
20114 p = skipwhite(p);
20115 if (STRNCMP(p, "range", 5) == 0)
20117 flags |= FC_RANGE;
20118 p += 5;
20120 else if (STRNCMP(p, "dict", 4) == 0)
20122 flags |= FC_DICT;
20123 p += 4;
20125 else if (STRNCMP(p, "abort", 5) == 0)
20127 flags |= FC_ABORT;
20128 p += 5;
20130 else
20131 break;
20134 /* When there is a line break use what follows for the function body.
20135 * Makes 'exe "func Test()\n...\nendfunc"' work. */
20136 if (*p == '\n')
20137 line_arg = p + 1;
20138 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
20139 EMSG(_(e_trailing));
20142 * Read the body of the function, until ":endfunction" is found.
20144 if (KeyTyped)
20146 /* Check if the function already exists, don't let the user type the
20147 * whole function before telling him it doesn't work! For a script we
20148 * need to skip the body to be able to find what follows. */
20149 if (!eap->skip && !eap->forceit)
20151 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20152 EMSG(_(e_funcdict));
20153 else if (name != NULL && find_func(name) != NULL)
20154 emsg_funcname(e_funcexts, name);
20157 if (!eap->skip && did_emsg)
20158 goto erret;
20160 msg_putchar('\n'); /* don't overwrite the function name */
20161 cmdline_row = msg_row;
20164 indent = 2;
20165 nesting = 0;
20166 for (;;)
20168 msg_scroll = TRUE;
20169 need_wait_return = FALSE;
20170 sourcing_lnum_off = sourcing_lnum;
20172 if (line_arg != NULL)
20174 /* Use eap->arg, split up in parts by line breaks. */
20175 theline = line_arg;
20176 p = vim_strchr(theline, '\n');
20177 if (p == NULL)
20178 line_arg += STRLEN(line_arg);
20179 else
20181 *p = NUL;
20182 line_arg = p + 1;
20185 else if (eap->getline == NULL)
20186 theline = getcmdline(':', 0L, indent);
20187 else
20188 theline = eap->getline(':', eap->cookie, indent);
20189 if (KeyTyped)
20190 lines_left = Rows - 1;
20191 if (theline == NULL)
20193 EMSG(_("E126: Missing :endfunction"));
20194 goto erret;
20197 /* Detect line continuation: sourcing_lnum increased more than one. */
20198 if (sourcing_lnum > sourcing_lnum_off + 1)
20199 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20200 else
20201 sourcing_lnum_off = 0;
20203 if (skip_until != NULL)
20205 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20206 * don't check for ":endfunc". */
20207 if (STRCMP(theline, skip_until) == 0)
20209 vim_free(skip_until);
20210 skip_until = NULL;
20213 else
20215 /* skip ':' and blanks*/
20216 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20219 /* Check for "endfunction". */
20220 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20222 if (line_arg == NULL)
20223 vim_free(theline);
20224 break;
20227 /* Increase indent inside "if", "while", "for" and "try", decrease
20228 * at "end". */
20229 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20230 indent -= 2;
20231 else if (STRNCMP(p, "if", 2) == 0
20232 || STRNCMP(p, "wh", 2) == 0
20233 || STRNCMP(p, "for", 3) == 0
20234 || STRNCMP(p, "try", 3) == 0)
20235 indent += 2;
20237 /* Check for defining a function inside this function. */
20238 if (checkforcmd(&p, "function", 2))
20240 if (*p == '!')
20241 p = skipwhite(p + 1);
20242 p += eval_fname_script(p);
20243 if (ASCII_ISALPHA(*p))
20245 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20246 if (*skipwhite(p) == '(')
20248 ++nesting;
20249 indent += 2;
20254 /* Check for ":append" or ":insert". */
20255 p = skip_range(p, NULL);
20256 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20257 || (p[0] == 'i'
20258 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20259 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20260 skip_until = vim_strsave((char_u *)".");
20262 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20263 arg = skipwhite(skiptowhite(p));
20264 if (arg[0] == '<' && arg[1] =='<'
20265 && ((p[0] == 'p' && p[1] == 'y'
20266 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20267 || (p[0] == 'p' && p[1] == 'e'
20268 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20269 || (p[0] == 't' && p[1] == 'c'
20270 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20271 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20272 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20273 || (p[0] == 'm' && p[1] == 'z'
20274 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20277 /* ":python <<" continues until a dot, like ":append" */
20278 p = skipwhite(arg + 2);
20279 if (*p == NUL)
20280 skip_until = vim_strsave((char_u *)".");
20281 else
20282 skip_until = vim_strsave(p);
20286 /* Add the line to the function. */
20287 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20289 if (line_arg == NULL)
20290 vim_free(theline);
20291 goto erret;
20294 /* Copy the line to newly allocated memory. get_one_sourceline()
20295 * allocates 250 bytes per line, this saves 80% on average. The cost
20296 * is an extra alloc/free. */
20297 p = vim_strsave(theline);
20298 if (p != NULL)
20300 if (line_arg == NULL)
20301 vim_free(theline);
20302 theline = p;
20305 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20307 /* Add NULL lines for continuation lines, so that the line count is
20308 * equal to the index in the growarray. */
20309 while (sourcing_lnum_off-- > 0)
20310 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20312 /* Check for end of eap->arg. */
20313 if (line_arg != NULL && *line_arg == NUL)
20314 line_arg = NULL;
20317 /* Don't define the function when skipping commands or when an error was
20318 * detected. */
20319 if (eap->skip || did_emsg)
20320 goto erret;
20323 * If there are no errors, add the function
20325 if (fudi.fd_dict == NULL)
20327 v = find_var(name, &ht);
20328 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20330 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20331 name);
20332 goto erret;
20335 fp = find_func(name);
20336 if (fp != NULL)
20338 if (!eap->forceit)
20340 emsg_funcname(e_funcexts, name);
20341 goto erret;
20343 if (fp->uf_calls > 0)
20345 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20346 name);
20347 goto erret;
20349 /* redefine existing function */
20350 ga_clear_strings(&(fp->uf_args));
20351 ga_clear_strings(&(fp->uf_lines));
20352 vim_free(name);
20353 name = NULL;
20356 else
20358 char numbuf[20];
20360 fp = NULL;
20361 if (fudi.fd_newkey == NULL && !eap->forceit)
20363 EMSG(_(e_funcdict));
20364 goto erret;
20366 if (fudi.fd_di == NULL)
20368 /* Can't add a function to a locked dictionary */
20369 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20370 goto erret;
20372 /* Can't change an existing function if it is locked */
20373 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20374 goto erret;
20376 /* Give the function a sequential number. Can only be used with a
20377 * Funcref! */
20378 vim_free(name);
20379 sprintf(numbuf, "%d", ++func_nr);
20380 name = vim_strsave((char_u *)numbuf);
20381 if (name == NULL)
20382 goto erret;
20385 if (fp == NULL)
20387 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20389 int slen, plen;
20390 char_u *scriptname;
20392 /* Check that the autoload name matches the script name. */
20393 j = FAIL;
20394 if (sourcing_name != NULL)
20396 scriptname = autoload_name(name);
20397 if (scriptname != NULL)
20399 p = vim_strchr(scriptname, '/');
20400 plen = (int)STRLEN(p);
20401 slen = (int)STRLEN(sourcing_name);
20402 if (slen > plen && fnamecmp(p,
20403 sourcing_name + slen - plen) == 0)
20404 j = OK;
20405 vim_free(scriptname);
20408 if (j == FAIL)
20410 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20411 goto erret;
20415 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20416 if (fp == NULL)
20417 goto erret;
20419 if (fudi.fd_dict != NULL)
20421 if (fudi.fd_di == NULL)
20423 /* add new dict entry */
20424 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20425 if (fudi.fd_di == NULL)
20427 vim_free(fp);
20428 goto erret;
20430 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20432 vim_free(fudi.fd_di);
20433 vim_free(fp);
20434 goto erret;
20437 else
20438 /* overwrite existing dict entry */
20439 clear_tv(&fudi.fd_di->di_tv);
20440 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20441 fudi.fd_di->di_tv.v_lock = 0;
20442 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20443 fp->uf_refcount = 1;
20445 /* behave like "dict" was used */
20446 flags |= FC_DICT;
20449 /* insert the new function in the function list */
20450 STRCPY(fp->uf_name, name);
20451 hash_add(&func_hashtab, UF2HIKEY(fp));
20453 fp->uf_args = newargs;
20454 fp->uf_lines = newlines;
20455 #ifdef FEAT_PROFILE
20456 fp->uf_tml_count = NULL;
20457 fp->uf_tml_total = NULL;
20458 fp->uf_tml_self = NULL;
20459 fp->uf_profiling = FALSE;
20460 if (prof_def_func())
20461 func_do_profile(fp);
20462 #endif
20463 fp->uf_varargs = varargs;
20464 fp->uf_flags = flags;
20465 fp->uf_calls = 0;
20466 fp->uf_script_ID = current_SID;
20467 goto ret_free;
20469 erret:
20470 ga_clear_strings(&newargs);
20471 ga_clear_strings(&newlines);
20472 ret_free:
20473 vim_free(skip_until);
20474 vim_free(fudi.fd_newkey);
20475 vim_free(name);
20476 did_emsg |= saved_did_emsg;
20480 * Get a function name, translating "<SID>" and "<SNR>".
20481 * Also handles a Funcref in a List or Dictionary.
20482 * Returns the function name in allocated memory, or NULL for failure.
20483 * flags:
20484 * TFN_INT: internal function name OK
20485 * TFN_QUIET: be quiet
20486 * Advances "pp" to just after the function name (if no error).
20488 static char_u *
20489 trans_function_name(pp, skip, flags, fdp)
20490 char_u **pp;
20491 int skip; /* only find the end, don't evaluate */
20492 int flags;
20493 funcdict_T *fdp; /* return: info about dictionary used */
20495 char_u *name = NULL;
20496 char_u *start;
20497 char_u *end;
20498 int lead;
20499 char_u sid_buf[20];
20500 int len;
20501 lval_T lv;
20503 if (fdp != NULL)
20504 vim_memset(fdp, 0, sizeof(funcdict_T));
20505 start = *pp;
20507 /* Check for hard coded <SNR>: already translated function ID (from a user
20508 * command). */
20509 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20510 && (*pp)[2] == (int)KE_SNR)
20512 *pp += 3;
20513 len = get_id_len(pp) + 3;
20514 return vim_strnsave(start, len);
20517 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20518 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20519 lead = eval_fname_script(start);
20520 if (lead > 2)
20521 start += lead;
20523 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20524 lead > 2 ? 0 : FNE_CHECK_START);
20525 if (end == start)
20527 if (!skip)
20528 EMSG(_("E129: Function name required"));
20529 goto theend;
20531 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20534 * Report an invalid expression in braces, unless the expression
20535 * evaluation has been cancelled due to an aborting error, an
20536 * interrupt, or an exception.
20538 if (!aborting())
20540 if (end != NULL)
20541 EMSG2(_(e_invarg2), start);
20543 else
20544 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20545 goto theend;
20548 if (lv.ll_tv != NULL)
20550 if (fdp != NULL)
20552 fdp->fd_dict = lv.ll_dict;
20553 fdp->fd_newkey = lv.ll_newkey;
20554 lv.ll_newkey = NULL;
20555 fdp->fd_di = lv.ll_di;
20557 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20559 name = vim_strsave(lv.ll_tv->vval.v_string);
20560 *pp = end;
20562 else
20564 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20565 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20566 EMSG(_(e_funcref));
20567 else
20568 *pp = end;
20569 name = NULL;
20571 goto theend;
20574 if (lv.ll_name == NULL)
20576 /* Error found, but continue after the function name. */
20577 *pp = end;
20578 goto theend;
20581 /* Check if the name is a Funcref. If so, use the value. */
20582 if (lv.ll_exp_name != NULL)
20584 len = (int)STRLEN(lv.ll_exp_name);
20585 name = deref_func_name(lv.ll_exp_name, &len);
20586 if (name == lv.ll_exp_name)
20587 name = NULL;
20589 else
20591 len = (int)(end - *pp);
20592 name = deref_func_name(*pp, &len);
20593 if (name == *pp)
20594 name = NULL;
20596 if (name != NULL)
20598 name = vim_strsave(name);
20599 *pp = end;
20600 goto theend;
20603 if (lv.ll_exp_name != NULL)
20605 len = (int)STRLEN(lv.ll_exp_name);
20606 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20607 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20609 /* When there was "s:" already or the name expanded to get a
20610 * leading "s:" then remove it. */
20611 lv.ll_name += 2;
20612 len -= 2;
20613 lead = 2;
20616 else
20618 if (lead == 2) /* skip over "s:" */
20619 lv.ll_name += 2;
20620 len = (int)(end - lv.ll_name);
20624 * Copy the function name to allocated memory.
20625 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20626 * Accept <SNR>123_name() outside a script.
20628 if (skip)
20629 lead = 0; /* do nothing */
20630 else if (lead > 0)
20632 lead = 3;
20633 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20634 || eval_fname_sid(*pp))
20636 /* It's "s:" or "<SID>" */
20637 if (current_SID <= 0)
20639 EMSG(_(e_usingsid));
20640 goto theend;
20642 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20643 lead += (int)STRLEN(sid_buf);
20646 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20648 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20649 goto theend;
20651 name = alloc((unsigned)(len + lead + 1));
20652 if (name != NULL)
20654 if (lead > 0)
20656 name[0] = K_SPECIAL;
20657 name[1] = KS_EXTRA;
20658 name[2] = (int)KE_SNR;
20659 if (lead > 3) /* If it's "<SID>" */
20660 STRCPY(name + 3, sid_buf);
20662 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20663 name[len + lead] = NUL;
20665 *pp = end;
20667 theend:
20668 clear_lval(&lv);
20669 return name;
20673 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20674 * Return 2 if "p" starts with "s:".
20675 * Return 0 otherwise.
20677 static int
20678 eval_fname_script(p)
20679 char_u *p;
20681 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20682 || STRNICMP(p + 1, "SNR>", 4) == 0))
20683 return 5;
20684 if (p[0] == 's' && p[1] == ':')
20685 return 2;
20686 return 0;
20690 * Return TRUE if "p" starts with "<SID>" or "s:".
20691 * Only works if eval_fname_script() returned non-zero for "p"!
20693 static int
20694 eval_fname_sid(p)
20695 char_u *p;
20697 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20701 * List the head of the function: "name(arg1, arg2)".
20703 static void
20704 list_func_head(fp, indent)
20705 ufunc_T *fp;
20706 int indent;
20708 int j;
20710 msg_start();
20711 if (indent)
20712 MSG_PUTS(" ");
20713 MSG_PUTS("function ");
20714 if (fp->uf_name[0] == K_SPECIAL)
20716 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20717 msg_puts(fp->uf_name + 3);
20719 else
20720 msg_puts(fp->uf_name);
20721 msg_putchar('(');
20722 for (j = 0; j < fp->uf_args.ga_len; ++j)
20724 if (j)
20725 MSG_PUTS(", ");
20726 msg_puts(FUNCARG(fp, j));
20728 if (fp->uf_varargs)
20730 if (j)
20731 MSG_PUTS(", ");
20732 MSG_PUTS("...");
20734 msg_putchar(')');
20735 msg_clr_eos();
20736 if (p_verbose > 0)
20737 last_set_msg(fp->uf_script_ID);
20741 * Find a function by name, return pointer to it in ufuncs.
20742 * Return NULL for unknown function.
20744 static ufunc_T *
20745 find_func(name)
20746 char_u *name;
20748 hashitem_T *hi;
20750 hi = hash_find(&func_hashtab, name);
20751 if (!HASHITEM_EMPTY(hi))
20752 return HI2UF(hi);
20753 return NULL;
20756 #if defined(EXITFREE) || defined(PROTO)
20757 void
20758 free_all_functions()
20760 hashitem_T *hi;
20762 /* Need to start all over every time, because func_free() may change the
20763 * hash table. */
20764 while (func_hashtab.ht_used > 0)
20765 for (hi = func_hashtab.ht_array; ; ++hi)
20766 if (!HASHITEM_EMPTY(hi))
20768 func_free(HI2UF(hi));
20769 break;
20772 #endif
20775 * Return TRUE if a function "name" exists.
20777 static int
20778 function_exists(name)
20779 char_u *name;
20781 char_u *nm = name;
20782 char_u *p;
20783 int n = FALSE;
20785 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20786 nm = skipwhite(nm);
20788 /* Only accept "funcname", "funcname ", "funcname (..." and
20789 * "funcname(...", not "funcname!...". */
20790 if (p != NULL && (*nm == NUL || *nm == '('))
20792 if (builtin_function(p))
20793 n = (find_internal_func(p) >= 0);
20794 else
20795 n = (find_func(p) != NULL);
20797 vim_free(p);
20798 return n;
20802 * Return TRUE if "name" looks like a builtin function name: starts with a
20803 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20805 static int
20806 builtin_function(name)
20807 char_u *name;
20809 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20810 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20813 #if defined(FEAT_PROFILE) || defined(PROTO)
20815 * Start profiling function "fp".
20817 static void
20818 func_do_profile(fp)
20819 ufunc_T *fp;
20821 fp->uf_tm_count = 0;
20822 profile_zero(&fp->uf_tm_self);
20823 profile_zero(&fp->uf_tm_total);
20824 if (fp->uf_tml_count == NULL)
20825 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20826 (sizeof(int) * fp->uf_lines.ga_len));
20827 if (fp->uf_tml_total == NULL)
20828 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20829 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20830 if (fp->uf_tml_self == NULL)
20831 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20832 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20833 fp->uf_tml_idx = -1;
20834 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20835 || fp->uf_tml_self == NULL)
20836 return; /* out of memory */
20838 fp->uf_profiling = TRUE;
20842 * Dump the profiling results for all functions in file "fd".
20844 void
20845 func_dump_profile(fd)
20846 FILE *fd;
20848 hashitem_T *hi;
20849 int todo;
20850 ufunc_T *fp;
20851 int i;
20852 ufunc_T **sorttab;
20853 int st_len = 0;
20855 todo = (int)func_hashtab.ht_used;
20856 if (todo == 0)
20857 return; /* nothing to dump */
20859 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20861 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20863 if (!HASHITEM_EMPTY(hi))
20865 --todo;
20866 fp = HI2UF(hi);
20867 if (fp->uf_profiling)
20869 if (sorttab != NULL)
20870 sorttab[st_len++] = fp;
20872 if (fp->uf_name[0] == K_SPECIAL)
20873 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20874 else
20875 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20876 if (fp->uf_tm_count == 1)
20877 fprintf(fd, "Called 1 time\n");
20878 else
20879 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20880 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20881 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20882 fprintf(fd, "\n");
20883 fprintf(fd, "count total (s) self (s)\n");
20885 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20887 if (FUNCLINE(fp, i) == NULL)
20888 continue;
20889 prof_func_line(fd, fp->uf_tml_count[i],
20890 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20891 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20893 fprintf(fd, "\n");
20898 if (sorttab != NULL && st_len > 0)
20900 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20901 prof_total_cmp);
20902 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20903 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20904 prof_self_cmp);
20905 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20908 vim_free(sorttab);
20911 static void
20912 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20913 FILE *fd;
20914 ufunc_T **sorttab;
20915 int st_len;
20916 char *title;
20917 int prefer_self; /* when equal print only self time */
20919 int i;
20920 ufunc_T *fp;
20922 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20923 fprintf(fd, "count total (s) self (s) function\n");
20924 for (i = 0; i < 20 && i < st_len; ++i)
20926 fp = sorttab[i];
20927 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20928 prefer_self);
20929 if (fp->uf_name[0] == K_SPECIAL)
20930 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20931 else
20932 fprintf(fd, " %s()\n", fp->uf_name);
20934 fprintf(fd, "\n");
20938 * Print the count and times for one function or function line.
20940 static void
20941 prof_func_line(fd, count, total, self, prefer_self)
20942 FILE *fd;
20943 int count;
20944 proftime_T *total;
20945 proftime_T *self;
20946 int prefer_self; /* when equal print only self time */
20948 if (count > 0)
20950 fprintf(fd, "%5d ", count);
20951 if (prefer_self && profile_equal(total, self))
20952 fprintf(fd, " ");
20953 else
20954 fprintf(fd, "%s ", profile_msg(total));
20955 if (!prefer_self && profile_equal(total, self))
20956 fprintf(fd, " ");
20957 else
20958 fprintf(fd, "%s ", profile_msg(self));
20960 else
20961 fprintf(fd, " ");
20965 * Compare function for total time sorting.
20967 static int
20968 #ifdef __BORLANDC__
20969 _RTLENTRYF
20970 #endif
20971 prof_total_cmp(s1, s2)
20972 const void *s1;
20973 const void *s2;
20975 ufunc_T *p1, *p2;
20977 p1 = *(ufunc_T **)s1;
20978 p2 = *(ufunc_T **)s2;
20979 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20983 * Compare function for self time sorting.
20985 static int
20986 #ifdef __BORLANDC__
20987 _RTLENTRYF
20988 #endif
20989 prof_self_cmp(s1, s2)
20990 const void *s1;
20991 const void *s2;
20993 ufunc_T *p1, *p2;
20995 p1 = *(ufunc_T **)s1;
20996 p2 = *(ufunc_T **)s2;
20997 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
21000 #endif
21003 * If "name" has a package name try autoloading the script for it.
21004 * Return TRUE if a package was loaded.
21006 static int
21007 script_autoload(name, reload)
21008 char_u *name;
21009 int reload; /* load script again when already loaded */
21011 char_u *p;
21012 char_u *scriptname, *tofree;
21013 int ret = FALSE;
21014 int i;
21016 /* If there is no '#' after name[0] there is no package name. */
21017 p = vim_strchr(name, AUTOLOAD_CHAR);
21018 if (p == NULL || p == name)
21019 return FALSE;
21021 tofree = scriptname = autoload_name(name);
21023 /* Find the name in the list of previously loaded package names. Skip
21024 * "autoload/", it's always the same. */
21025 for (i = 0; i < ga_loaded.ga_len; ++i)
21026 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
21027 break;
21028 if (!reload && i < ga_loaded.ga_len)
21029 ret = FALSE; /* was loaded already */
21030 else
21032 /* Remember the name if it wasn't loaded already. */
21033 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
21035 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
21036 tofree = NULL;
21039 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
21040 if (source_runtime(scriptname, FALSE) == OK)
21041 ret = TRUE;
21044 vim_free(tofree);
21045 return ret;
21049 * Return the autoload script name for a function or variable name.
21050 * Returns NULL when out of memory.
21052 static char_u *
21053 autoload_name(name)
21054 char_u *name;
21056 char_u *p;
21057 char_u *scriptname;
21059 /* Get the script file name: replace '#' with '/', append ".vim". */
21060 scriptname = alloc((unsigned)(STRLEN(name) + 14));
21061 if (scriptname == NULL)
21062 return FALSE;
21063 STRCPY(scriptname, "autoload/");
21064 STRCAT(scriptname, name);
21065 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
21066 STRCAT(scriptname, ".vim");
21067 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
21068 *p = '/';
21069 return scriptname;
21072 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
21075 * Function given to ExpandGeneric() to obtain the list of user defined
21076 * function names.
21078 char_u *
21079 get_user_func_name(xp, idx)
21080 expand_T *xp;
21081 int idx;
21083 static long_u done;
21084 static hashitem_T *hi;
21085 ufunc_T *fp;
21087 if (idx == 0)
21089 done = 0;
21090 hi = func_hashtab.ht_array;
21092 if (done < func_hashtab.ht_used)
21094 if (done++ > 0)
21095 ++hi;
21096 while (HASHITEM_EMPTY(hi))
21097 ++hi;
21098 fp = HI2UF(hi);
21100 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
21101 return fp->uf_name; /* prevents overflow */
21103 cat_func_name(IObuff, fp);
21104 if (xp->xp_context != EXPAND_USER_FUNC)
21106 STRCAT(IObuff, "(");
21107 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
21108 STRCAT(IObuff, ")");
21110 return IObuff;
21112 return NULL;
21115 #endif /* FEAT_CMDL_COMPL */
21118 * Copy the function name of "fp" to buffer "buf".
21119 * "buf" must be able to hold the function name plus three bytes.
21120 * Takes care of script-local function names.
21122 static void
21123 cat_func_name(buf, fp)
21124 char_u *buf;
21125 ufunc_T *fp;
21127 if (fp->uf_name[0] == K_SPECIAL)
21129 STRCPY(buf, "<SNR>");
21130 STRCAT(buf, fp->uf_name + 3);
21132 else
21133 STRCPY(buf, fp->uf_name);
21137 * ":delfunction {name}"
21139 void
21140 ex_delfunction(eap)
21141 exarg_T *eap;
21143 ufunc_T *fp = NULL;
21144 char_u *p;
21145 char_u *name;
21146 funcdict_T fudi;
21148 p = eap->arg;
21149 name = trans_function_name(&p, eap->skip, 0, &fudi);
21150 vim_free(fudi.fd_newkey);
21151 if (name == NULL)
21153 if (fudi.fd_dict != NULL && !eap->skip)
21154 EMSG(_(e_funcref));
21155 return;
21157 if (!ends_excmd(*skipwhite(p)))
21159 vim_free(name);
21160 EMSG(_(e_trailing));
21161 return;
21163 eap->nextcmd = check_nextcmd(p);
21164 if (eap->nextcmd != NULL)
21165 *p = NUL;
21167 if (!eap->skip)
21168 fp = find_func(name);
21169 vim_free(name);
21171 if (!eap->skip)
21173 if (fp == NULL)
21175 EMSG2(_(e_nofunc), eap->arg);
21176 return;
21178 if (fp->uf_calls > 0)
21180 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21181 return;
21184 if (fudi.fd_dict != NULL)
21186 /* Delete the dict item that refers to the function, it will
21187 * invoke func_unref() and possibly delete the function. */
21188 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21190 else
21191 func_free(fp);
21196 * Free a function and remove it from the list of functions.
21198 static void
21199 func_free(fp)
21200 ufunc_T *fp;
21202 hashitem_T *hi;
21204 /* clear this function */
21205 ga_clear_strings(&(fp->uf_args));
21206 ga_clear_strings(&(fp->uf_lines));
21207 #ifdef FEAT_PROFILE
21208 vim_free(fp->uf_tml_count);
21209 vim_free(fp->uf_tml_total);
21210 vim_free(fp->uf_tml_self);
21211 #endif
21213 /* remove the function from the function hashtable */
21214 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21215 if (HASHITEM_EMPTY(hi))
21216 EMSG2(_(e_intern2), "func_free()");
21217 else
21218 hash_remove(&func_hashtab, hi);
21220 vim_free(fp);
21224 * Unreference a Function: decrement the reference count and free it when it
21225 * becomes zero. Only for numbered functions.
21227 static void
21228 func_unref(name)
21229 char_u *name;
21231 ufunc_T *fp;
21233 if (name != NULL && isdigit(*name))
21235 fp = find_func(name);
21236 if (fp == NULL)
21237 EMSG2(_(e_intern2), "func_unref()");
21238 else if (--fp->uf_refcount <= 0)
21240 /* Only delete it when it's not being used. Otherwise it's done
21241 * when "uf_calls" becomes zero. */
21242 if (fp->uf_calls == 0)
21243 func_free(fp);
21249 * Count a reference to a Function.
21251 static void
21252 func_ref(name)
21253 char_u *name;
21255 ufunc_T *fp;
21257 if (name != NULL && isdigit(*name))
21259 fp = find_func(name);
21260 if (fp == NULL)
21261 EMSG2(_(e_intern2), "func_ref()");
21262 else
21263 ++fp->uf_refcount;
21268 * Call a user function.
21270 static void
21271 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21272 ufunc_T *fp; /* pointer to function */
21273 int argcount; /* nr of args */
21274 typval_T *argvars; /* arguments */
21275 typval_T *rettv; /* return value */
21276 linenr_T firstline; /* first line of range */
21277 linenr_T lastline; /* last line of range */
21278 dict_T *selfdict; /* Dictionary for "self" */
21280 char_u *save_sourcing_name;
21281 linenr_T save_sourcing_lnum;
21282 scid_T save_current_SID;
21283 funccall_T *fc;
21284 int save_did_emsg;
21285 static int depth = 0;
21286 dictitem_T *v;
21287 int fixvar_idx = 0; /* index in fixvar[] */
21288 int i;
21289 int ai;
21290 char_u numbuf[NUMBUFLEN];
21291 char_u *name;
21292 #ifdef FEAT_PROFILE
21293 proftime_T wait_start;
21294 proftime_T call_start;
21295 #endif
21297 /* If depth of calling is getting too high, don't execute the function */
21298 if (depth >= p_mfd)
21300 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21301 rettv->v_type = VAR_NUMBER;
21302 rettv->vval.v_number = -1;
21303 return;
21305 ++depth;
21307 line_breakcheck(); /* check for CTRL-C hit */
21309 fc = (funccall_T *)alloc(sizeof(funccall_T));
21310 fc->caller = current_funccal;
21311 current_funccal = fc;
21312 fc->func = fp;
21313 fc->rettv = rettv;
21314 rettv->vval.v_number = 0;
21315 fc->linenr = 0;
21316 fc->returned = FALSE;
21317 fc->level = ex_nesting_level;
21318 /* Check if this function has a breakpoint. */
21319 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21320 fc->dbg_tick = debug_tick;
21323 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21324 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21325 * each argument variable and saves a lot of time.
21328 * Init l: variables.
21330 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21331 if (selfdict != NULL)
21333 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21334 * some compiler that checks the destination size. */
21335 v = &fc->fixvar[fixvar_idx++].var;
21336 name = v->di_key;
21337 STRCPY(name, "self");
21338 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21339 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21340 v->di_tv.v_type = VAR_DICT;
21341 v->di_tv.v_lock = 0;
21342 v->di_tv.vval.v_dict = selfdict;
21343 ++selfdict->dv_refcount;
21347 * Init a: variables.
21348 * Set a:0 to "argcount".
21349 * Set a:000 to a list with room for the "..." arguments.
21351 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21352 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21353 (varnumber_T)(argcount - fp->uf_args.ga_len));
21354 /* Use "name" to avoid a warning from some compiler that checks the
21355 * destination size. */
21356 v = &fc->fixvar[fixvar_idx++].var;
21357 name = v->di_key;
21358 STRCPY(name, "000");
21359 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21360 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21361 v->di_tv.v_type = VAR_LIST;
21362 v->di_tv.v_lock = VAR_FIXED;
21363 v->di_tv.vval.v_list = &fc->l_varlist;
21364 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21365 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21366 fc->l_varlist.lv_lock = VAR_FIXED;
21369 * Set a:firstline to "firstline" and a:lastline to "lastline".
21370 * Set a:name to named arguments.
21371 * Set a:N to the "..." arguments.
21373 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21374 (varnumber_T)firstline);
21375 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21376 (varnumber_T)lastline);
21377 for (i = 0; i < argcount; ++i)
21379 ai = i - fp->uf_args.ga_len;
21380 if (ai < 0)
21381 /* named argument a:name */
21382 name = FUNCARG(fp, i);
21383 else
21385 /* "..." argument a:1, a:2, etc. */
21386 sprintf((char *)numbuf, "%d", ai + 1);
21387 name = numbuf;
21389 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21391 v = &fc->fixvar[fixvar_idx++].var;
21392 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21394 else
21396 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21397 + STRLEN(name)));
21398 if (v == NULL)
21399 break;
21400 v->di_flags = DI_FLAGS_RO;
21402 STRCPY(v->di_key, name);
21403 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21405 /* Note: the values are copied directly to avoid alloc/free.
21406 * "argvars" must have VAR_FIXED for v_lock. */
21407 v->di_tv = argvars[i];
21408 v->di_tv.v_lock = VAR_FIXED;
21410 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21412 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21413 fc->l_listitems[ai].li_tv = argvars[i];
21414 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21418 /* Don't redraw while executing the function. */
21419 ++RedrawingDisabled;
21420 save_sourcing_name = sourcing_name;
21421 save_sourcing_lnum = sourcing_lnum;
21422 sourcing_lnum = 1;
21423 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21424 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21425 if (sourcing_name != NULL)
21427 if (save_sourcing_name != NULL
21428 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21429 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21430 else
21431 STRCPY(sourcing_name, "function ");
21432 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21434 if (p_verbose >= 12)
21436 ++no_wait_return;
21437 verbose_enter_scroll();
21439 smsg((char_u *)_("calling %s"), sourcing_name);
21440 if (p_verbose >= 14)
21442 char_u buf[MSG_BUF_LEN];
21443 char_u numbuf2[NUMBUFLEN];
21444 char_u *tofree;
21445 char_u *s;
21447 msg_puts((char_u *)"(");
21448 for (i = 0; i < argcount; ++i)
21450 if (i > 0)
21451 msg_puts((char_u *)", ");
21452 if (argvars[i].v_type == VAR_NUMBER)
21453 msg_outnum((long)argvars[i].vval.v_number);
21454 else
21456 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21457 if (s != NULL)
21459 trunc_string(s, buf, MSG_BUF_CLEN);
21460 msg_puts(buf);
21461 vim_free(tofree);
21465 msg_puts((char_u *)")");
21467 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21469 verbose_leave_scroll();
21470 --no_wait_return;
21473 #ifdef FEAT_PROFILE
21474 if (do_profiling == PROF_YES)
21476 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21477 func_do_profile(fp);
21478 if (fp->uf_profiling
21479 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21481 ++fp->uf_tm_count;
21482 profile_start(&call_start);
21483 profile_zero(&fp->uf_tm_children);
21485 script_prof_save(&wait_start);
21487 #endif
21489 save_current_SID = current_SID;
21490 current_SID = fp->uf_script_ID;
21491 save_did_emsg = did_emsg;
21492 did_emsg = FALSE;
21494 /* call do_cmdline() to execute the lines */
21495 do_cmdline(NULL, get_func_line, (void *)fc,
21496 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21498 --RedrawingDisabled;
21500 /* when the function was aborted because of an error, return -1 */
21501 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21503 clear_tv(rettv);
21504 rettv->v_type = VAR_NUMBER;
21505 rettv->vval.v_number = -1;
21508 #ifdef FEAT_PROFILE
21509 if (do_profiling == PROF_YES && (fp->uf_profiling
21510 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21512 profile_end(&call_start);
21513 profile_sub_wait(&wait_start, &call_start);
21514 profile_add(&fp->uf_tm_total, &call_start);
21515 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21516 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21518 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21519 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21522 #endif
21524 /* when being verbose, mention the return value */
21525 if (p_verbose >= 12)
21527 ++no_wait_return;
21528 verbose_enter_scroll();
21530 if (aborting())
21531 smsg((char_u *)_("%s aborted"), sourcing_name);
21532 else if (fc->rettv->v_type == VAR_NUMBER)
21533 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21534 (long)fc->rettv->vval.v_number);
21535 else
21537 char_u buf[MSG_BUF_LEN];
21538 char_u numbuf2[NUMBUFLEN];
21539 char_u *tofree;
21540 char_u *s;
21542 /* The value may be very long. Skip the middle part, so that we
21543 * have some idea how it starts and ends. smsg() would always
21544 * truncate it at the end. */
21545 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21546 if (s != NULL)
21548 trunc_string(s, buf, MSG_BUF_CLEN);
21549 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21550 vim_free(tofree);
21553 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21555 verbose_leave_scroll();
21556 --no_wait_return;
21559 vim_free(sourcing_name);
21560 sourcing_name = save_sourcing_name;
21561 sourcing_lnum = save_sourcing_lnum;
21562 current_SID = save_current_SID;
21563 #ifdef FEAT_PROFILE
21564 if (do_profiling == PROF_YES)
21565 script_prof_restore(&wait_start);
21566 #endif
21568 if (p_verbose >= 12 && sourcing_name != NULL)
21570 ++no_wait_return;
21571 verbose_enter_scroll();
21573 smsg((char_u *)_("continuing in %s"), sourcing_name);
21574 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21576 verbose_leave_scroll();
21577 --no_wait_return;
21580 did_emsg |= save_did_emsg;
21581 current_funccal = fc->caller;
21582 --depth;
21584 /* If the a:000 list and the l: and a: dicts are not referenced we can
21585 * free the funccall_T and what's in it. */
21586 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21587 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21588 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21590 free_funccal(fc, FALSE);
21592 else
21594 hashitem_T *hi;
21595 listitem_T *li;
21596 int todo;
21598 /* "fc" is still in use. This can happen when returning "a:000" or
21599 * assigning "l:" to a global variable.
21600 * Link "fc" in the list for garbage collection later. */
21601 fc->caller = previous_funccal;
21602 previous_funccal = fc;
21604 /* Make a copy of the a: variables, since we didn't do that above. */
21605 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21606 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21608 if (!HASHITEM_EMPTY(hi))
21610 --todo;
21611 v = HI2DI(hi);
21612 copy_tv(&v->di_tv, &v->di_tv);
21616 /* Make a copy of the a:000 items, since we didn't do that above. */
21617 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21618 copy_tv(&li->li_tv, &li->li_tv);
21623 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21624 * referenced from anywhere that is in use.
21626 static int
21627 can_free_funccal(fc, copyID)
21628 funccall_T *fc;
21629 int copyID;
21631 return (fc->l_varlist.lv_copyID != copyID
21632 && fc->l_vars.dv_copyID != copyID
21633 && fc->l_avars.dv_copyID != copyID);
21637 * Free "fc" and what it contains.
21639 static void
21640 free_funccal(fc, free_val)
21641 funccall_T *fc;
21642 int free_val; /* a: vars were allocated */
21644 listitem_T *li;
21646 /* The a: variables typevals may not have been allocated, only free the
21647 * allocated variables. */
21648 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21650 /* free all l: variables */
21651 vars_clear(&fc->l_vars.dv_hashtab);
21653 /* Free the a:000 variables if they were allocated. */
21654 if (free_val)
21655 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21656 clear_tv(&li->li_tv);
21658 vim_free(fc);
21662 * Add a number variable "name" to dict "dp" with value "nr".
21664 static void
21665 add_nr_var(dp, v, name, nr)
21666 dict_T *dp;
21667 dictitem_T *v;
21668 char *name;
21669 varnumber_T nr;
21671 STRCPY(v->di_key, name);
21672 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21673 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21674 v->di_tv.v_type = VAR_NUMBER;
21675 v->di_tv.v_lock = VAR_FIXED;
21676 v->di_tv.vval.v_number = nr;
21680 * ":return [expr]"
21682 void
21683 ex_return(eap)
21684 exarg_T *eap;
21686 char_u *arg = eap->arg;
21687 typval_T rettv;
21688 int returning = FALSE;
21690 if (current_funccal == NULL)
21692 EMSG(_("E133: :return not inside a function"));
21693 return;
21696 if (eap->skip)
21697 ++emsg_skip;
21699 eap->nextcmd = NULL;
21700 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21701 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21703 if (!eap->skip)
21704 returning = do_return(eap, FALSE, TRUE, &rettv);
21705 else
21706 clear_tv(&rettv);
21708 /* It's safer to return also on error. */
21709 else if (!eap->skip)
21712 * Return unless the expression evaluation has been cancelled due to an
21713 * aborting error, an interrupt, or an exception.
21715 if (!aborting())
21716 returning = do_return(eap, FALSE, TRUE, NULL);
21719 /* When skipping or the return gets pending, advance to the next command
21720 * in this line (!returning). Otherwise, ignore the rest of the line.
21721 * Following lines will be ignored by get_func_line(). */
21722 if (returning)
21723 eap->nextcmd = NULL;
21724 else if (eap->nextcmd == NULL) /* no argument */
21725 eap->nextcmd = check_nextcmd(arg);
21727 if (eap->skip)
21728 --emsg_skip;
21732 * Return from a function. Possibly makes the return pending. Also called
21733 * for a pending return at the ":endtry" or after returning from an extra
21734 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21735 * when called due to a ":return" command. "rettv" may point to a typval_T
21736 * with the return rettv. Returns TRUE when the return can be carried out,
21737 * FALSE when the return gets pending.
21740 do_return(eap, reanimate, is_cmd, rettv)
21741 exarg_T *eap;
21742 int reanimate;
21743 int is_cmd;
21744 void *rettv;
21746 int idx;
21747 struct condstack *cstack = eap->cstack;
21749 if (reanimate)
21750 /* Undo the return. */
21751 current_funccal->returned = FALSE;
21754 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21755 * not in its finally clause (which then is to be executed next) is found.
21756 * In this case, make the ":return" pending for execution at the ":endtry".
21757 * Otherwise, return normally.
21759 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21760 if (idx >= 0)
21762 cstack->cs_pending[idx] = CSTP_RETURN;
21764 if (!is_cmd && !reanimate)
21765 /* A pending return again gets pending. "rettv" points to an
21766 * allocated variable with the rettv of the original ":return"'s
21767 * argument if present or is NULL else. */
21768 cstack->cs_rettv[idx] = rettv;
21769 else
21771 /* When undoing a return in order to make it pending, get the stored
21772 * return rettv. */
21773 if (reanimate)
21774 rettv = current_funccal->rettv;
21776 if (rettv != NULL)
21778 /* Store the value of the pending return. */
21779 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21780 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21781 else
21782 EMSG(_(e_outofmem));
21784 else
21785 cstack->cs_rettv[idx] = NULL;
21787 if (reanimate)
21789 /* The pending return value could be overwritten by a ":return"
21790 * without argument in a finally clause; reset the default
21791 * return value. */
21792 current_funccal->rettv->v_type = VAR_NUMBER;
21793 current_funccal->rettv->vval.v_number = 0;
21796 report_make_pending(CSTP_RETURN, rettv);
21798 else
21800 current_funccal->returned = TRUE;
21802 /* If the return is carried out now, store the return value. For
21803 * a return immediately after reanimation, the value is already
21804 * there. */
21805 if (!reanimate && rettv != NULL)
21807 clear_tv(current_funccal->rettv);
21808 *current_funccal->rettv = *(typval_T *)rettv;
21809 if (!is_cmd)
21810 vim_free(rettv);
21814 return idx < 0;
21818 * Free the variable with a pending return value.
21820 void
21821 discard_pending_return(rettv)
21822 void *rettv;
21824 free_tv((typval_T *)rettv);
21828 * Generate a return command for producing the value of "rettv". The result
21829 * is an allocated string. Used by report_pending() for verbose messages.
21831 char_u *
21832 get_return_cmd(rettv)
21833 void *rettv;
21835 char_u *s = NULL;
21836 char_u *tofree = NULL;
21837 char_u numbuf[NUMBUFLEN];
21839 if (rettv != NULL)
21840 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21841 if (s == NULL)
21842 s = (char_u *)"";
21844 STRCPY(IObuff, ":return ");
21845 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21846 if (STRLEN(s) + 8 >= IOSIZE)
21847 STRCPY(IObuff + IOSIZE - 4, "...");
21848 vim_free(tofree);
21849 return vim_strsave(IObuff);
21853 * Get next function line.
21854 * Called by do_cmdline() to get the next line.
21855 * Returns allocated string, or NULL for end of function.
21857 char_u *
21858 get_func_line(c, cookie, indent)
21859 int c UNUSED;
21860 void *cookie;
21861 int indent UNUSED;
21863 funccall_T *fcp = (funccall_T *)cookie;
21864 ufunc_T *fp = fcp->func;
21865 char_u *retval;
21866 garray_T *gap; /* growarray with function lines */
21868 /* If breakpoints have been added/deleted need to check for it. */
21869 if (fcp->dbg_tick != debug_tick)
21871 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21872 sourcing_lnum);
21873 fcp->dbg_tick = debug_tick;
21875 #ifdef FEAT_PROFILE
21876 if (do_profiling == PROF_YES)
21877 func_line_end(cookie);
21878 #endif
21880 gap = &fp->uf_lines;
21881 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21882 || fcp->returned)
21883 retval = NULL;
21884 else
21886 /* Skip NULL lines (continuation lines). */
21887 while (fcp->linenr < gap->ga_len
21888 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21889 ++fcp->linenr;
21890 if (fcp->linenr >= gap->ga_len)
21891 retval = NULL;
21892 else
21894 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21895 sourcing_lnum = fcp->linenr;
21896 #ifdef FEAT_PROFILE
21897 if (do_profiling == PROF_YES)
21898 func_line_start(cookie);
21899 #endif
21903 /* Did we encounter a breakpoint? */
21904 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21906 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21907 /* Find next breakpoint. */
21908 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21909 sourcing_lnum);
21910 fcp->dbg_tick = debug_tick;
21913 return retval;
21916 #if defined(FEAT_PROFILE) || defined(PROTO)
21918 * Called when starting to read a function line.
21919 * "sourcing_lnum" must be correct!
21920 * When skipping lines it may not actually be executed, but we won't find out
21921 * until later and we need to store the time now.
21923 void
21924 func_line_start(cookie)
21925 void *cookie;
21927 funccall_T *fcp = (funccall_T *)cookie;
21928 ufunc_T *fp = fcp->func;
21930 if (fp->uf_profiling && sourcing_lnum >= 1
21931 && sourcing_lnum <= fp->uf_lines.ga_len)
21933 fp->uf_tml_idx = sourcing_lnum - 1;
21934 /* Skip continuation lines. */
21935 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21936 --fp->uf_tml_idx;
21937 fp->uf_tml_execed = FALSE;
21938 profile_start(&fp->uf_tml_start);
21939 profile_zero(&fp->uf_tml_children);
21940 profile_get_wait(&fp->uf_tml_wait);
21945 * Called when actually executing a function line.
21947 void
21948 func_line_exec(cookie)
21949 void *cookie;
21951 funccall_T *fcp = (funccall_T *)cookie;
21952 ufunc_T *fp = fcp->func;
21954 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21955 fp->uf_tml_execed = TRUE;
21959 * Called when done with a function line.
21961 void
21962 func_line_end(cookie)
21963 void *cookie;
21965 funccall_T *fcp = (funccall_T *)cookie;
21966 ufunc_T *fp = fcp->func;
21968 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21970 if (fp->uf_tml_execed)
21972 ++fp->uf_tml_count[fp->uf_tml_idx];
21973 profile_end(&fp->uf_tml_start);
21974 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21975 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21976 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21977 &fp->uf_tml_children);
21979 fp->uf_tml_idx = -1;
21982 #endif
21985 * Return TRUE if the currently active function should be ended, because a
21986 * return was encountered or an error occurred. Used inside a ":while".
21989 func_has_ended(cookie)
21990 void *cookie;
21992 funccall_T *fcp = (funccall_T *)cookie;
21994 /* Ignore the "abort" flag if the abortion behavior has been changed due to
21995 * an error inside a try conditional. */
21996 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21997 || fcp->returned);
22001 * return TRUE if cookie indicates a function which "abort"s on errors.
22004 func_has_abort(cookie)
22005 void *cookie;
22007 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
22010 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
22011 typedef enum
22013 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
22014 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
22015 VAR_FLAVOUR_VIMINFO /* all uppercase */
22016 } var_flavour_T;
22018 static var_flavour_T var_flavour __ARGS((char_u *varname));
22020 static var_flavour_T
22021 var_flavour(varname)
22022 char_u *varname;
22024 char_u *p = varname;
22026 if (ASCII_ISUPPER(*p))
22028 while (*(++p))
22029 if (ASCII_ISLOWER(*p))
22030 return VAR_FLAVOUR_SESSION;
22031 return VAR_FLAVOUR_VIMINFO;
22033 else
22034 return VAR_FLAVOUR_DEFAULT;
22036 #endif
22038 #if defined(FEAT_VIMINFO) || defined(PROTO)
22040 * Restore global vars that start with a capital from the viminfo file
22043 read_viminfo_varlist(virp, writing)
22044 vir_T *virp;
22045 int writing;
22047 char_u *tab;
22048 int type = VAR_NUMBER;
22049 typval_T tv;
22051 if (!writing && (find_viminfo_parameter('!') != NULL))
22053 tab = vim_strchr(virp->vir_line + 1, '\t');
22054 if (tab != NULL)
22056 *tab++ = '\0'; /* isolate the variable name */
22057 if (*tab == 'S') /* string var */
22058 type = VAR_STRING;
22059 #ifdef FEAT_FLOAT
22060 else if (*tab == 'F')
22061 type = VAR_FLOAT;
22062 #endif
22064 tab = vim_strchr(tab, '\t');
22065 if (tab != NULL)
22067 tv.v_type = type;
22068 if (type == VAR_STRING)
22069 tv.vval.v_string = viminfo_readstring(virp,
22070 (int)(tab - virp->vir_line + 1), TRUE);
22071 #ifdef FEAT_FLOAT
22072 else if (type == VAR_FLOAT)
22073 (void)string2float(tab + 1, &tv.vval.v_float);
22074 #endif
22075 else
22076 tv.vval.v_number = atol((char *)tab + 1);
22077 set_var(virp->vir_line + 1, &tv, FALSE);
22078 if (type == VAR_STRING)
22079 vim_free(tv.vval.v_string);
22084 return viminfo_readline(virp);
22088 * Write global vars that start with a capital to the viminfo file
22090 void
22091 write_viminfo_varlist(fp)
22092 FILE *fp;
22094 hashitem_T *hi;
22095 dictitem_T *this_var;
22096 int todo;
22097 char *s;
22098 char_u *p;
22099 char_u *tofree;
22100 char_u numbuf[NUMBUFLEN];
22102 if (find_viminfo_parameter('!') == NULL)
22103 return;
22105 fprintf(fp, _("\n# global variables:\n"));
22107 todo = (int)globvarht.ht_used;
22108 for (hi = globvarht.ht_array; todo > 0; ++hi)
22110 if (!HASHITEM_EMPTY(hi))
22112 --todo;
22113 this_var = HI2DI(hi);
22114 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
22116 switch (this_var->di_tv.v_type)
22118 case VAR_STRING: s = "STR"; break;
22119 case VAR_NUMBER: s = "NUM"; break;
22120 #ifdef FEAT_FLOAT
22121 case VAR_FLOAT: s = "FLO"; break;
22122 #endif
22123 default: continue;
22125 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
22126 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
22127 if (p != NULL)
22128 viminfo_writestring(fp, p);
22129 vim_free(tofree);
22134 #endif
22136 #if defined(FEAT_SESSION) || defined(PROTO)
22138 store_session_globals(fd)
22139 FILE *fd;
22141 hashitem_T *hi;
22142 dictitem_T *this_var;
22143 int todo;
22144 char_u *p, *t;
22146 todo = (int)globvarht.ht_used;
22147 for (hi = globvarht.ht_array; todo > 0; ++hi)
22149 if (!HASHITEM_EMPTY(hi))
22151 --todo;
22152 this_var = HI2DI(hi);
22153 if ((this_var->di_tv.v_type == VAR_NUMBER
22154 || this_var->di_tv.v_type == VAR_STRING)
22155 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22157 /* Escape special characters with a backslash. Turn a LF and
22158 * CR into \n and \r. */
22159 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22160 (char_u *)"\\\"\n\r");
22161 if (p == NULL) /* out of memory */
22162 break;
22163 for (t = p; *t != NUL; ++t)
22164 if (*t == '\n')
22165 *t = 'n';
22166 else if (*t == '\r')
22167 *t = 'r';
22168 if ((fprintf(fd, "let %s = %c%s%c",
22169 this_var->di_key,
22170 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22171 : ' ',
22173 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22174 : ' ') < 0)
22175 || put_eol(fd) == FAIL)
22177 vim_free(p);
22178 return FAIL;
22180 vim_free(p);
22182 #ifdef FEAT_FLOAT
22183 else if (this_var->di_tv.v_type == VAR_FLOAT
22184 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22186 float_T f = this_var->di_tv.vval.v_float;
22187 int sign = ' ';
22189 if (f < 0)
22191 f = -f;
22192 sign = '-';
22194 if ((fprintf(fd, "let %s = %c&%f",
22195 this_var->di_key, sign, f) < 0)
22196 || put_eol(fd) == FAIL)
22197 return FAIL;
22199 #endif
22202 return OK;
22204 #endif
22207 * Display script name where an item was last set.
22208 * Should only be invoked when 'verbose' is non-zero.
22210 void
22211 last_set_msg(scriptID)
22212 scid_T scriptID;
22214 char_u *p;
22216 if (scriptID != 0)
22218 p = home_replace_save(NULL, get_scriptname(scriptID));
22219 if (p != NULL)
22221 verbose_enter();
22222 MSG_PUTS(_("\n\tLast set from "));
22223 MSG_PUTS(p);
22224 vim_free(p);
22225 verbose_leave();
22231 * List v:oldfiles in a nice way.
22233 void
22234 ex_oldfiles(eap)
22235 exarg_T *eap UNUSED;
22237 list_T *l = vimvars[VV_OLDFILES].vv_list;
22238 listitem_T *li;
22239 int nr = 0;
22241 if (l == NULL)
22242 msg((char_u *)_("No old files"));
22243 else
22245 msg_start();
22246 msg_scroll = TRUE;
22247 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22249 msg_outnum((long)++nr);
22250 MSG_PUTS(": ");
22251 msg_outtrans(get_tv_string(&li->li_tv));
22252 msg_putchar('\n');
22253 out_flush(); /* output one line at a time */
22254 ui_breakcheck();
22256 /* Assume "got_int" was set to truncate the listing. */
22257 got_int = FALSE;
22259 #ifdef FEAT_BROWSE_CMD
22260 if (cmdmod.browse)
22262 quit_more = FALSE;
22263 nr = prompt_for_number(FALSE);
22264 msg_starthere();
22265 if (nr > 0)
22267 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22268 (long)nr);
22270 if (p != NULL)
22272 p = expand_env_save(p);
22273 eap->arg = p;
22274 eap->cmdidx = CMD_edit;
22275 cmdmod.browse = FALSE;
22276 do_exedit(eap, NULL);
22277 vim_free(p);
22281 #endif
22285 #endif /* FEAT_EVAL */
22288 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22290 #ifdef WIN3264
22292 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22294 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22295 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22296 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22299 * Get the short path (8.3) for the filename in "fnamep".
22300 * Only works for a valid file name.
22301 * When the path gets longer "fnamep" is changed and the allocated buffer
22302 * is put in "bufp".
22303 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22304 * Returns OK on success, FAIL on failure.
22306 static int
22307 get_short_pathname(fnamep, bufp, fnamelen)
22308 char_u **fnamep;
22309 char_u **bufp;
22310 int *fnamelen;
22312 int l, len;
22313 char_u *newbuf;
22315 len = *fnamelen;
22316 l = GetShortPathName(*fnamep, *fnamep, len);
22317 if (l > len - 1)
22319 /* If that doesn't work (not enough space), then save the string
22320 * and try again with a new buffer big enough. */
22321 newbuf = vim_strnsave(*fnamep, l);
22322 if (newbuf == NULL)
22323 return FAIL;
22325 vim_free(*bufp);
22326 *fnamep = *bufp = newbuf;
22328 /* Really should always succeed, as the buffer is big enough. */
22329 l = GetShortPathName(*fnamep, *fnamep, l+1);
22332 *fnamelen = l;
22333 return OK;
22337 * Get the short path (8.3) for the filename in "fname". The converted
22338 * path is returned in "bufp".
22340 * Some of the directories specified in "fname" may not exist. This function
22341 * will shorten the existing directories at the beginning of the path and then
22342 * append the remaining non-existing path.
22344 * fname - Pointer to the filename to shorten. On return, contains the
22345 * pointer to the shortened pathname
22346 * bufp - Pointer to an allocated buffer for the filename.
22347 * fnamelen - Length of the filename pointed to by fname
22349 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22351 static int
22352 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22353 char_u **fname;
22354 char_u **bufp;
22355 int *fnamelen;
22357 char_u *short_fname, *save_fname, *pbuf_unused;
22358 char_u *endp, *save_endp;
22359 char_u ch;
22360 int old_len, len;
22361 int new_len, sfx_len;
22362 int retval = OK;
22364 /* Make a copy */
22365 old_len = *fnamelen;
22366 save_fname = vim_strnsave(*fname, old_len);
22367 pbuf_unused = NULL;
22368 short_fname = NULL;
22370 endp = save_fname + old_len - 1; /* Find the end of the copy */
22371 save_endp = endp;
22374 * Try shortening the supplied path till it succeeds by removing one
22375 * directory at a time from the tail of the path.
22377 len = 0;
22378 for (;;)
22380 /* go back one path-separator */
22381 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22382 --endp;
22383 if (endp <= save_fname)
22384 break; /* processed the complete path */
22387 * Replace the path separator with a NUL and try to shorten the
22388 * resulting path.
22390 ch = *endp;
22391 *endp = 0;
22392 short_fname = save_fname;
22393 len = (int)STRLEN(short_fname) + 1;
22394 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22396 retval = FAIL;
22397 goto theend;
22399 *endp = ch; /* preserve the string */
22401 if (len > 0)
22402 break; /* successfully shortened the path */
22404 /* failed to shorten the path. Skip the path separator */
22405 --endp;
22408 if (len > 0)
22411 * Succeeded in shortening the path. Now concatenate the shortened
22412 * path with the remaining path at the tail.
22415 /* Compute the length of the new path. */
22416 sfx_len = (int)(save_endp - endp) + 1;
22417 new_len = len + sfx_len;
22419 *fnamelen = new_len;
22420 vim_free(*bufp);
22421 if (new_len > old_len)
22423 /* There is not enough space in the currently allocated string,
22424 * copy it to a buffer big enough. */
22425 *fname = *bufp = vim_strnsave(short_fname, new_len);
22426 if (*fname == NULL)
22428 retval = FAIL;
22429 goto theend;
22432 else
22434 /* Transfer short_fname to the main buffer (it's big enough),
22435 * unless get_short_pathname() did its work in-place. */
22436 *fname = *bufp = save_fname;
22437 if (short_fname != save_fname)
22438 vim_strncpy(save_fname, short_fname, len);
22439 save_fname = NULL;
22442 /* concat the not-shortened part of the path */
22443 vim_strncpy(*fname + len, endp, sfx_len);
22444 (*fname)[new_len] = NUL;
22447 theend:
22448 vim_free(pbuf_unused);
22449 vim_free(save_fname);
22451 return retval;
22455 * Get a pathname for a partial path.
22456 * Returns OK for success, FAIL for failure.
22458 static int
22459 shortpath_for_partial(fnamep, bufp, fnamelen)
22460 char_u **fnamep;
22461 char_u **bufp;
22462 int *fnamelen;
22464 int sepcount, len, tflen;
22465 char_u *p;
22466 char_u *pbuf, *tfname;
22467 int hasTilde;
22469 /* Count up the path separators from the RHS.. so we know which part
22470 * of the path to return. */
22471 sepcount = 0;
22472 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22473 if (vim_ispathsep(*p))
22474 ++sepcount;
22476 /* Need full path first (use expand_env() to remove a "~/") */
22477 hasTilde = (**fnamep == '~');
22478 if (hasTilde)
22479 pbuf = tfname = expand_env_save(*fnamep);
22480 else
22481 pbuf = tfname = FullName_save(*fnamep, FALSE);
22483 len = tflen = (int)STRLEN(tfname);
22485 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22486 return FAIL;
22488 if (len == 0)
22490 /* Don't have a valid filename, so shorten the rest of the
22491 * path if we can. This CAN give us invalid 8.3 filenames, but
22492 * there's not a lot of point in guessing what it might be.
22494 len = tflen;
22495 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22496 return FAIL;
22499 /* Count the paths backward to find the beginning of the desired string. */
22500 for (p = tfname + len - 1; p >= tfname; --p)
22502 #ifdef FEAT_MBYTE
22503 if (has_mbyte)
22504 p -= mb_head_off(tfname, p);
22505 #endif
22506 if (vim_ispathsep(*p))
22508 if (sepcount == 0 || (hasTilde && sepcount == 1))
22509 break;
22510 else
22511 sepcount --;
22514 if (hasTilde)
22516 --p;
22517 if (p >= tfname)
22518 *p = '~';
22519 else
22520 return FAIL;
22522 else
22523 ++p;
22525 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22526 vim_free(*bufp);
22527 *fnamelen = (int)STRLEN(p);
22528 *bufp = pbuf;
22529 *fnamep = p;
22531 return OK;
22533 #endif /* WIN3264 */
22536 * Adjust a filename, according to a string of modifiers.
22537 * *fnamep must be NUL terminated when called. When returning, the length is
22538 * determined by *fnamelen.
22539 * Returns VALID_ flags or -1 for failure.
22540 * When there is an error, *fnamep is set to NULL.
22543 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22544 char_u *src; /* string with modifiers */
22545 int *usedlen; /* characters after src that are used */
22546 char_u **fnamep; /* file name so far */
22547 char_u **bufp; /* buffer for allocated file name or NULL */
22548 int *fnamelen; /* length of fnamep */
22550 int valid = 0;
22551 char_u *tail;
22552 char_u *s, *p, *pbuf;
22553 char_u dirname[MAXPATHL];
22554 int c;
22555 int has_fullname = 0;
22556 #ifdef WIN3264
22557 int has_shortname = 0;
22558 #endif
22560 repeat:
22561 /* ":p" - full path/file_name */
22562 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22564 has_fullname = 1;
22566 valid |= VALID_PATH;
22567 *usedlen += 2;
22569 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22570 if ((*fnamep)[0] == '~'
22571 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22572 && ((*fnamep)[1] == '/'
22573 # ifdef BACKSLASH_IN_FILENAME
22574 || (*fnamep)[1] == '\\'
22575 # endif
22576 || (*fnamep)[1] == NUL)
22578 #endif
22581 *fnamep = expand_env_save(*fnamep);
22582 vim_free(*bufp); /* free any allocated file name */
22583 *bufp = *fnamep;
22584 if (*fnamep == NULL)
22585 return -1;
22588 /* When "/." or "/.." is used: force expansion to get rid of it. */
22589 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22591 if (vim_ispathsep(*p)
22592 && p[1] == '.'
22593 && (p[2] == NUL
22594 || vim_ispathsep(p[2])
22595 || (p[2] == '.'
22596 && (p[3] == NUL || vim_ispathsep(p[3])))))
22597 break;
22600 /* FullName_save() is slow, don't use it when not needed. */
22601 if (*p != NUL || !vim_isAbsName(*fnamep))
22603 *fnamep = FullName_save(*fnamep, *p != NUL);
22604 vim_free(*bufp); /* free any allocated file name */
22605 *bufp = *fnamep;
22606 if (*fnamep == NULL)
22607 return -1;
22610 /* Append a path separator to a directory. */
22611 if (mch_isdir(*fnamep))
22613 /* Make room for one or two extra characters. */
22614 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22615 vim_free(*bufp); /* free any allocated file name */
22616 *bufp = *fnamep;
22617 if (*fnamep == NULL)
22618 return -1;
22619 add_pathsep(*fnamep);
22623 /* ":." - path relative to the current directory */
22624 /* ":~" - path relative to the home directory */
22625 /* ":8" - shortname path - postponed till after */
22626 while (src[*usedlen] == ':'
22627 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22629 *usedlen += 2;
22630 if (c == '8')
22632 #ifdef WIN3264
22633 has_shortname = 1; /* Postpone this. */
22634 #endif
22635 continue;
22637 pbuf = NULL;
22638 /* Need full path first (use expand_env() to remove a "~/") */
22639 if (!has_fullname)
22641 if (c == '.' && **fnamep == '~')
22642 p = pbuf = expand_env_save(*fnamep);
22643 else
22644 p = pbuf = FullName_save(*fnamep, FALSE);
22646 else
22647 p = *fnamep;
22649 has_fullname = 0;
22651 if (p != NULL)
22653 if (c == '.')
22655 mch_dirname(dirname, MAXPATHL);
22656 s = shorten_fname(p, dirname);
22657 if (s != NULL)
22659 *fnamep = s;
22660 if (pbuf != NULL)
22662 vim_free(*bufp); /* free any allocated file name */
22663 *bufp = pbuf;
22664 pbuf = NULL;
22668 else
22670 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22671 /* Only replace it when it starts with '~' */
22672 if (*dirname == '~')
22674 s = vim_strsave(dirname);
22675 if (s != NULL)
22677 *fnamep = s;
22678 vim_free(*bufp);
22679 *bufp = s;
22683 vim_free(pbuf);
22687 tail = gettail(*fnamep);
22688 *fnamelen = (int)STRLEN(*fnamep);
22690 /* ":h" - head, remove "/file_name", can be repeated */
22691 /* Don't remove the first "/" or "c:\" */
22692 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22694 valid |= VALID_HEAD;
22695 *usedlen += 2;
22696 s = get_past_head(*fnamep);
22697 while (tail > s && after_pathsep(s, tail))
22698 mb_ptr_back(*fnamep, tail);
22699 *fnamelen = (int)(tail - *fnamep);
22700 #ifdef VMS
22701 if (*fnamelen > 0)
22702 *fnamelen += 1; /* the path separator is part of the path */
22703 #endif
22704 if (*fnamelen == 0)
22706 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22707 p = vim_strsave((char_u *)".");
22708 if (p == NULL)
22709 return -1;
22710 vim_free(*bufp);
22711 *bufp = *fnamep = tail = p;
22712 *fnamelen = 1;
22714 else
22716 while (tail > s && !after_pathsep(s, tail))
22717 mb_ptr_back(*fnamep, tail);
22721 /* ":8" - shortname */
22722 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22724 *usedlen += 2;
22725 #ifdef WIN3264
22726 has_shortname = 1;
22727 #endif
22730 #ifdef WIN3264
22731 /* Check shortname after we have done 'heads' and before we do 'tails'
22733 if (has_shortname)
22735 pbuf = NULL;
22736 /* Copy the string if it is shortened by :h */
22737 if (*fnamelen < (int)STRLEN(*fnamep))
22739 p = vim_strnsave(*fnamep, *fnamelen);
22740 if (p == 0)
22741 return -1;
22742 vim_free(*bufp);
22743 *bufp = *fnamep = p;
22746 /* Split into two implementations - makes it easier. First is where
22747 * there isn't a full name already, second is where there is.
22749 if (!has_fullname && !vim_isAbsName(*fnamep))
22751 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22752 return -1;
22754 else
22756 int l;
22758 /* Simple case, already have the full-name
22759 * Nearly always shorter, so try first time. */
22760 l = *fnamelen;
22761 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22762 return -1;
22764 if (l == 0)
22766 /* Couldn't find the filename.. search the paths.
22768 l = *fnamelen;
22769 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22770 return -1;
22772 *fnamelen = l;
22775 #endif /* WIN3264 */
22777 /* ":t" - tail, just the basename */
22778 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22780 *usedlen += 2;
22781 *fnamelen -= (int)(tail - *fnamep);
22782 *fnamep = tail;
22785 /* ":e" - extension, can be repeated */
22786 /* ":r" - root, without extension, can be repeated */
22787 while (src[*usedlen] == ':'
22788 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22790 /* find a '.' in the tail:
22791 * - for second :e: before the current fname
22792 * - otherwise: The last '.'
22794 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22795 s = *fnamep - 2;
22796 else
22797 s = *fnamep + *fnamelen - 1;
22798 for ( ; s > tail; --s)
22799 if (s[0] == '.')
22800 break;
22801 if (src[*usedlen + 1] == 'e') /* :e */
22803 if (s > tail)
22805 *fnamelen += (int)(*fnamep - (s + 1));
22806 *fnamep = s + 1;
22807 #ifdef VMS
22808 /* cut version from the extension */
22809 s = *fnamep + *fnamelen - 1;
22810 for ( ; s > *fnamep; --s)
22811 if (s[0] == ';')
22812 break;
22813 if (s > *fnamep)
22814 *fnamelen = s - *fnamep;
22815 #endif
22817 else if (*fnamep <= tail)
22818 *fnamelen = 0;
22820 else /* :r */
22822 if (s > tail) /* remove one extension */
22823 *fnamelen = (int)(s - *fnamep);
22825 *usedlen += 2;
22828 /* ":s?pat?foo?" - substitute */
22829 /* ":gs?pat?foo?" - global substitute */
22830 if (src[*usedlen] == ':'
22831 && (src[*usedlen + 1] == 's'
22832 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22834 char_u *str;
22835 char_u *pat;
22836 char_u *sub;
22837 int sep;
22838 char_u *flags;
22839 int didit = FALSE;
22841 flags = (char_u *)"";
22842 s = src + *usedlen + 2;
22843 if (src[*usedlen + 1] == 'g')
22845 flags = (char_u *)"g";
22846 ++s;
22849 sep = *s++;
22850 if (sep)
22852 /* find end of pattern */
22853 p = vim_strchr(s, sep);
22854 if (p != NULL)
22856 pat = vim_strnsave(s, (int)(p - s));
22857 if (pat != NULL)
22859 s = p + 1;
22860 /* find end of substitution */
22861 p = vim_strchr(s, sep);
22862 if (p != NULL)
22864 sub = vim_strnsave(s, (int)(p - s));
22865 str = vim_strnsave(*fnamep, *fnamelen);
22866 if (sub != NULL && str != NULL)
22868 *usedlen = (int)(p + 1 - src);
22869 s = do_string_sub(str, pat, sub, flags);
22870 if (s != NULL)
22872 *fnamep = s;
22873 *fnamelen = (int)STRLEN(s);
22874 vim_free(*bufp);
22875 *bufp = s;
22876 didit = TRUE;
22879 vim_free(sub);
22880 vim_free(str);
22882 vim_free(pat);
22885 /* after using ":s", repeat all the modifiers */
22886 if (didit)
22887 goto repeat;
22891 return valid;
22895 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22896 * "flags" can be "g" to do a global substitute.
22897 * Returns an allocated string, NULL for error.
22899 char_u *
22900 do_string_sub(str, pat, sub, flags)
22901 char_u *str;
22902 char_u *pat;
22903 char_u *sub;
22904 char_u *flags;
22906 int sublen;
22907 regmatch_T regmatch;
22908 int i;
22909 int do_all;
22910 char_u *tail;
22911 garray_T ga;
22912 char_u *ret;
22913 char_u *save_cpo;
22915 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22916 save_cpo = p_cpo;
22917 p_cpo = empty_option;
22919 ga_init2(&ga, 1, 200);
22921 do_all = (flags[0] == 'g');
22923 regmatch.rm_ic = p_ic;
22924 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22925 if (regmatch.regprog != NULL)
22927 tail = str;
22928 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22931 * Get some space for a temporary buffer to do the substitution
22932 * into. It will contain:
22933 * - The text up to where the match is.
22934 * - The substituted text.
22935 * - The text after the match.
22937 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22938 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22939 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22941 ga_clear(&ga);
22942 break;
22945 /* copy the text up to where the match is */
22946 i = (int)(regmatch.startp[0] - tail);
22947 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22948 /* add the substituted text */
22949 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22950 + ga.ga_len + i, TRUE, TRUE, FALSE);
22951 ga.ga_len += i + sublen - 1;
22952 /* avoid getting stuck on a match with an empty string */
22953 if (tail == regmatch.endp[0])
22955 if (*tail == NUL)
22956 break;
22957 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22958 ++ga.ga_len;
22960 else
22962 tail = regmatch.endp[0];
22963 if (*tail == NUL)
22964 break;
22966 if (!do_all)
22967 break;
22970 if (ga.ga_data != NULL)
22971 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22973 vim_free(regmatch.regprog);
22976 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22977 ga_clear(&ga);
22978 if (p_cpo == empty_option)
22979 p_cpo = save_cpo;
22980 else
22981 /* Darn, evaluating {sub} expression changed the value. */
22982 free_string_option(save_cpo);
22984 return ret;
22987 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */