Merge branch 'vim' into feat/float-point-ext
[vim_extended.git] / src / eval.c
blob08fef87a5a7a291c996a8877739b40c95c6ec19a
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;
10134 int index = 0;
10136 if (argvars[0].v_type == VAR_LIST)
10138 if ((l = argvars[0].vval.v_list) == NULL
10139 || (map && tv_check_lock(l->lv_lock, ermsg)))
10140 return;
10142 else if (argvars[0].v_type == VAR_DICT)
10144 if ((d = argvars[0].vval.v_dict) == NULL
10145 || (map && tv_check_lock(d->dv_lock, ermsg)))
10146 return;
10148 else
10150 EMSG2(_(e_listdictarg), ermsg);
10151 return;
10154 expr = get_tv_string_buf_chk(&argvars[1], buf);
10155 /* On type errors, the preceding call has already displayed an error
10156 * message. Avoid a misleading error message for an empty string that
10157 * was not passed as argument. */
10158 if (expr != NULL)
10160 prepare_vimvar(VV_VAL, &save_val);
10161 expr = skipwhite(expr);
10163 /* We reset "did_emsg" to be able to detect whether an error
10164 * occurred during evaluation of the expression. */
10165 save_did_emsg = did_emsg;
10166 did_emsg = FALSE;
10168 prepare_vimvar(VV_KEY, &save_key);
10169 if (argvars[0].v_type == VAR_DICT)
10171 vimvars[VV_KEY].vv_type = VAR_STRING;
10173 ht = &d->dv_hashtab;
10174 hash_lock(ht);
10175 todo = (int)ht->ht_used;
10176 for (hi = ht->ht_array; todo > 0; ++hi)
10178 if (!HASHITEM_EMPTY(hi))
10180 --todo;
10181 di = HI2DI(hi);
10182 if (tv_check_lock(di->di_tv.v_lock, ermsg))
10183 break;
10184 vimvars[VV_KEY].vv_str = vim_strsave(di->di_key);
10185 if (filter_map_one(&di->di_tv, expr, map, &rem) == FAIL
10186 || did_emsg)
10187 break;
10188 if (!map && rem)
10189 dictitem_remove(d, di);
10190 clear_tv(&vimvars[VV_KEY].vv_tv);
10193 hash_unlock(ht);
10195 else
10197 vimvars[VV_KEY].vv_type = VAR_NUMBER;
10199 for (li = l->lv_first; li != NULL; li = nli)
10201 if (tv_check_lock(li->li_tv.v_lock, ermsg))
10202 break;
10203 nli = li->li_next;
10204 vimvars[VV_KEY].vv_nr = index;
10205 if (filter_map_one(&li->li_tv, expr, map, &rem) == FAIL
10206 || did_emsg)
10207 break;
10208 if (!map && rem)
10209 listitem_remove(l, li);
10210 ++index;
10214 restore_vimvar(VV_KEY, &save_key);
10215 restore_vimvar(VV_VAL, &save_val);
10217 did_emsg |= save_did_emsg;
10220 copy_tv(&argvars[0], rettv);
10223 static int
10224 filter_map_one(tv, expr, map, remp)
10225 typval_T *tv;
10226 char_u *expr;
10227 int map;
10228 int *remp;
10230 typval_T rettv;
10231 char_u *s;
10232 int retval = FAIL;
10234 copy_tv(tv, &vimvars[VV_VAL].vv_tv);
10235 s = expr;
10236 if (eval1(&s, &rettv, TRUE) == FAIL)
10237 goto theend;
10238 if (*s != NUL) /* check for trailing chars after expr */
10240 EMSG2(_(e_invexpr2), s);
10241 goto theend;
10243 if (map)
10245 /* map(): replace the list item value */
10246 clear_tv(tv);
10247 rettv.v_lock = 0;
10248 *tv = rettv;
10250 else
10252 int error = FALSE;
10254 /* filter(): when expr is zero remove the item */
10255 *remp = (get_tv_number_chk(&rettv, &error) == 0);
10256 clear_tv(&rettv);
10257 /* On type error, nothing has been removed; return FAIL to stop the
10258 * loop. The error message was given by get_tv_number_chk(). */
10259 if (error)
10260 goto theend;
10262 retval = OK;
10263 theend:
10264 clear_tv(&vimvars[VV_VAL].vv_tv);
10265 return retval;
10269 * "filter()" function
10271 static void
10272 f_filter(argvars, rettv)
10273 typval_T *argvars;
10274 typval_T *rettv;
10276 filter_map(argvars, rettv, FALSE);
10280 * "finddir({fname}[, {path}[, {count}]])" function
10282 static void
10283 f_finddir(argvars, rettv)
10284 typval_T *argvars;
10285 typval_T *rettv;
10287 findfilendir(argvars, rettv, FINDFILE_DIR);
10291 * "findfile({fname}[, {path}[, {count}]])" function
10293 static void
10294 f_findfile(argvars, rettv)
10295 typval_T *argvars;
10296 typval_T *rettv;
10298 findfilendir(argvars, rettv, FINDFILE_FILE);
10301 #ifdef FEAT_FLOAT
10303 * "float2nr({float})" function
10305 static void
10306 f_float2nr(argvars, rettv)
10307 typval_T *argvars;
10308 typval_T *rettv;
10310 float_T f;
10312 if (get_float_arg(argvars, &f) == OK)
10314 if (f < -0x7fffffff)
10315 rettv->vval.v_number = -0x7fffffff;
10316 else if (f > 0x7fffffff)
10317 rettv->vval.v_number = 0x7fffffff;
10318 else
10319 rettv->vval.v_number = (varnumber_T)f;
10324 * "floor({float})" function
10326 static void
10327 f_floor(argvars, rettv)
10328 typval_T *argvars;
10329 typval_T *rettv;
10331 float_T f;
10333 rettv->v_type = VAR_FLOAT;
10334 if (get_float_arg(argvars, &f) == OK)
10335 rettv->vval.v_float = floor(f);
10336 else
10337 rettv->vval.v_float = 0.0;
10339 #endif
10342 * "fnameescape({string})" function
10344 static void
10345 f_fnameescape(argvars, rettv)
10346 typval_T *argvars;
10347 typval_T *rettv;
10349 rettv->vval.v_string = vim_strsave_fnameescape(
10350 get_tv_string(&argvars[0]), FALSE);
10351 rettv->v_type = VAR_STRING;
10355 * "fnamemodify({fname}, {mods})" function
10357 static void
10358 f_fnamemodify(argvars, rettv)
10359 typval_T *argvars;
10360 typval_T *rettv;
10362 char_u *fname;
10363 char_u *mods;
10364 int usedlen = 0;
10365 int len;
10366 char_u *fbuf = NULL;
10367 char_u buf[NUMBUFLEN];
10369 fname = get_tv_string_chk(&argvars[0]);
10370 mods = get_tv_string_buf_chk(&argvars[1], buf);
10371 if (fname == NULL || mods == NULL)
10372 fname = NULL;
10373 else
10375 len = (int)STRLEN(fname);
10376 (void)modify_fname(mods, &usedlen, &fname, &fbuf, &len);
10379 rettv->v_type = VAR_STRING;
10380 if (fname == NULL)
10381 rettv->vval.v_string = NULL;
10382 else
10383 rettv->vval.v_string = vim_strnsave(fname, len);
10384 vim_free(fbuf);
10387 static void foldclosed_both __ARGS((typval_T *argvars, typval_T *rettv, int end));
10390 * "foldclosed()" function
10392 static void
10393 foldclosed_both(argvars, rettv, end)
10394 typval_T *argvars;
10395 typval_T *rettv;
10396 int end;
10398 #ifdef FEAT_FOLDING
10399 linenr_T lnum;
10400 linenr_T first, last;
10402 lnum = get_tv_lnum(argvars);
10403 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10405 if (hasFoldingWin(curwin, lnum, &first, &last, FALSE, NULL))
10407 if (end)
10408 rettv->vval.v_number = (varnumber_T)last;
10409 else
10410 rettv->vval.v_number = (varnumber_T)first;
10411 return;
10414 #endif
10415 rettv->vval.v_number = -1;
10419 * "foldclosed()" function
10421 static void
10422 f_foldclosed(argvars, rettv)
10423 typval_T *argvars;
10424 typval_T *rettv;
10426 foldclosed_both(argvars, rettv, FALSE);
10430 * "foldclosedend()" function
10432 static void
10433 f_foldclosedend(argvars, rettv)
10434 typval_T *argvars;
10435 typval_T *rettv;
10437 foldclosed_both(argvars, rettv, TRUE);
10441 * "foldlevel()" function
10443 static void
10444 f_foldlevel(argvars, rettv)
10445 typval_T *argvars;
10446 typval_T *rettv;
10448 #ifdef FEAT_FOLDING
10449 linenr_T lnum;
10451 lnum = get_tv_lnum(argvars);
10452 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
10453 rettv->vval.v_number = foldLevel(lnum);
10454 #endif
10458 * "foldtext()" function
10460 static void
10461 f_foldtext(argvars, rettv)
10462 typval_T *argvars UNUSED;
10463 typval_T *rettv;
10465 #ifdef FEAT_FOLDING
10466 linenr_T lnum;
10467 char_u *s;
10468 char_u *r;
10469 int len;
10470 char *txt;
10471 #endif
10473 rettv->v_type = VAR_STRING;
10474 rettv->vval.v_string = NULL;
10475 #ifdef FEAT_FOLDING
10476 if ((linenr_T)vimvars[VV_FOLDSTART].vv_nr > 0
10477 && (linenr_T)vimvars[VV_FOLDEND].vv_nr
10478 <= curbuf->b_ml.ml_line_count
10479 && vimvars[VV_FOLDDASHES].vv_str != NULL)
10481 /* Find first non-empty line in the fold. */
10482 lnum = (linenr_T)vimvars[VV_FOLDSTART].vv_nr;
10483 while (lnum < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10485 if (!linewhite(lnum))
10486 break;
10487 ++lnum;
10490 /* Find interesting text in this line. */
10491 s = skipwhite(ml_get(lnum));
10492 /* skip C comment-start */
10493 if (s[0] == '/' && (s[1] == '*' || s[1] == '/'))
10495 s = skipwhite(s + 2);
10496 if (*skipwhite(s) == NUL
10497 && lnum + 1 < (linenr_T)vimvars[VV_FOLDEND].vv_nr)
10499 s = skipwhite(ml_get(lnum + 1));
10500 if (*s == '*')
10501 s = skipwhite(s + 1);
10504 txt = _("+-%s%3ld lines: ");
10505 r = alloc((unsigned)(STRLEN(txt)
10506 + STRLEN(vimvars[VV_FOLDDASHES].vv_str) /* for %s */
10507 + 20 /* for %3ld */
10508 + STRLEN(s))); /* concatenated */
10509 if (r != NULL)
10511 sprintf((char *)r, txt, vimvars[VV_FOLDDASHES].vv_str,
10512 (long)((linenr_T)vimvars[VV_FOLDEND].vv_nr
10513 - (linenr_T)vimvars[VV_FOLDSTART].vv_nr + 1));
10514 len = (int)STRLEN(r);
10515 STRCAT(r, s);
10516 /* remove 'foldmarker' and 'commentstring' */
10517 foldtext_cleanup(r + len);
10518 rettv->vval.v_string = r;
10521 #endif
10525 * "foldtextresult(lnum)" function
10527 static void
10528 f_foldtextresult(argvars, rettv)
10529 typval_T *argvars UNUSED;
10530 typval_T *rettv;
10532 #ifdef FEAT_FOLDING
10533 linenr_T lnum;
10534 char_u *text;
10535 char_u buf[51];
10536 foldinfo_T foldinfo;
10537 int fold_count;
10538 #endif
10540 rettv->v_type = VAR_STRING;
10541 rettv->vval.v_string = NULL;
10542 #ifdef FEAT_FOLDING
10543 lnum = get_tv_lnum(argvars);
10544 /* treat illegal types and illegal string values for {lnum} the same */
10545 if (lnum < 0)
10546 lnum = 0;
10547 fold_count = foldedCount(curwin, lnum, &foldinfo);
10548 if (fold_count > 0)
10550 text = get_foldtext(curwin, lnum, lnum + fold_count - 1,
10551 &foldinfo, buf);
10552 if (text == buf)
10553 text = vim_strsave(text);
10554 rettv->vval.v_string = text;
10556 #endif
10560 * "foreground()" function
10562 static void
10563 f_foreground(argvars, rettv)
10564 typval_T *argvars UNUSED;
10565 typval_T *rettv UNUSED;
10567 #ifdef FEAT_GUI
10568 if (gui.in_use)
10569 gui_mch_set_foreground();
10570 #else
10571 # ifdef WIN32
10572 win32_set_foreground();
10573 # endif
10574 #endif
10578 * "function()" function
10580 static void
10581 f_function(argvars, rettv)
10582 typval_T *argvars;
10583 typval_T *rettv;
10585 char_u *s;
10587 s = get_tv_string(&argvars[0]);
10588 if (s == NULL || *s == NUL || VIM_ISDIGIT(*s))
10589 EMSG2(_(e_invarg2), s);
10590 /* Don't check an autoload name for existence here. */
10591 else if (vim_strchr(s, AUTOLOAD_CHAR) == NULL && !function_exists(s))
10592 EMSG2(_("E700: Unknown function: %s"), s);
10593 else
10595 rettv->vval.v_string = vim_strsave(s);
10596 rettv->v_type = VAR_FUNC;
10601 * "garbagecollect()" function
10603 static void
10604 f_garbagecollect(argvars, rettv)
10605 typval_T *argvars;
10606 typval_T *rettv UNUSED;
10608 /* This is postponed until we are back at the toplevel, because we may be
10609 * using Lists and Dicts internally. E.g.: ":echo [garbagecollect()]". */
10610 want_garbage_collect = TRUE;
10612 if (argvars[0].v_type != VAR_UNKNOWN && get_tv_number(&argvars[0]) == 1)
10613 garbage_collect_at_exit = TRUE;
10617 * "get()" function
10619 static void
10620 f_get(argvars, rettv)
10621 typval_T *argvars;
10622 typval_T *rettv;
10624 listitem_T *li;
10625 list_T *l;
10626 dictitem_T *di;
10627 dict_T *d;
10628 typval_T *tv = NULL;
10630 if (argvars[0].v_type == VAR_LIST)
10632 if ((l = argvars[0].vval.v_list) != NULL)
10634 int error = FALSE;
10636 li = list_find(l, get_tv_number_chk(&argvars[1], &error));
10637 if (!error && li != NULL)
10638 tv = &li->li_tv;
10641 else if (argvars[0].v_type == VAR_DICT)
10643 if ((d = argvars[0].vval.v_dict) != NULL)
10645 di = dict_find(d, get_tv_string(&argvars[1]), -1);
10646 if (di != NULL)
10647 tv = &di->di_tv;
10650 else
10651 EMSG2(_(e_listdictarg), "get()");
10653 if (tv == NULL)
10655 if (argvars[2].v_type != VAR_UNKNOWN)
10656 copy_tv(&argvars[2], rettv);
10658 else
10659 copy_tv(tv, rettv);
10662 static void get_buffer_lines __ARGS((buf_T *buf, linenr_T start, linenr_T end, int retlist, typval_T *rettv));
10665 * Get line or list of lines from buffer "buf" into "rettv".
10666 * Return a range (from start to end) of lines in rettv from the specified
10667 * buffer.
10668 * If 'retlist' is TRUE, then the lines are returned as a Vim List.
10670 static void
10671 get_buffer_lines(buf, start, end, retlist, rettv)
10672 buf_T *buf;
10673 linenr_T start;
10674 linenr_T end;
10675 int retlist;
10676 typval_T *rettv;
10678 char_u *p;
10680 if (retlist && rettv_list_alloc(rettv) == FAIL)
10681 return;
10683 if (buf == NULL || buf->b_ml.ml_mfp == NULL || start < 0)
10684 return;
10686 if (!retlist)
10688 if (start >= 1 && start <= buf->b_ml.ml_line_count)
10689 p = ml_get_buf(buf, start, FALSE);
10690 else
10691 p = (char_u *)"";
10693 rettv->v_type = VAR_STRING;
10694 rettv->vval.v_string = vim_strsave(p);
10696 else
10698 if (end < start)
10699 return;
10701 if (start < 1)
10702 start = 1;
10703 if (end > buf->b_ml.ml_line_count)
10704 end = buf->b_ml.ml_line_count;
10705 while (start <= end)
10706 if (list_append_string(rettv->vval.v_list,
10707 ml_get_buf(buf, start++, FALSE), -1) == FAIL)
10708 break;
10713 * "getbufline()" function
10715 static void
10716 f_getbufline(argvars, rettv)
10717 typval_T *argvars;
10718 typval_T *rettv;
10720 linenr_T lnum;
10721 linenr_T end;
10722 buf_T *buf;
10724 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10725 ++emsg_off;
10726 buf = get_buf_tv(&argvars[0]);
10727 --emsg_off;
10729 lnum = get_tv_lnum_buf(&argvars[1], buf);
10730 if (argvars[2].v_type == VAR_UNKNOWN)
10731 end = lnum;
10732 else
10733 end = get_tv_lnum_buf(&argvars[2], buf);
10735 get_buffer_lines(buf, lnum, end, TRUE, rettv);
10739 * "getbufvar()" function
10741 static void
10742 f_getbufvar(argvars, rettv)
10743 typval_T *argvars;
10744 typval_T *rettv;
10746 buf_T *buf;
10747 buf_T *save_curbuf;
10748 char_u *varname;
10749 dictitem_T *v;
10751 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
10752 varname = get_tv_string_chk(&argvars[1]);
10753 ++emsg_off;
10754 buf = get_buf_tv(&argvars[0]);
10756 rettv->v_type = VAR_STRING;
10757 rettv->vval.v_string = NULL;
10759 if (buf != NULL && varname != NULL)
10761 /* set curbuf to be our buf, temporarily */
10762 save_curbuf = curbuf;
10763 curbuf = buf;
10765 if (*varname == '&') /* buffer-local-option */
10766 get_option_tv(&varname, rettv, TRUE);
10767 else
10769 if (*varname == NUL)
10770 /* let getbufvar({nr}, "") return the "b:" dictionary. The
10771 * scope prefix before the NUL byte is required by
10772 * find_var_in_ht(). */
10773 varname = (char_u *)"b:" + 2;
10774 /* look up the variable */
10775 v = find_var_in_ht(&curbuf->b_vars.dv_hashtab, varname, FALSE);
10776 if (v != NULL)
10777 copy_tv(&v->di_tv, rettv);
10780 /* restore previous notion of curbuf */
10781 curbuf = save_curbuf;
10784 --emsg_off;
10788 * "getchar()" function
10790 static void
10791 f_getchar(argvars, rettv)
10792 typval_T *argvars;
10793 typval_T *rettv;
10795 varnumber_T n;
10796 int error = FALSE;
10798 /* Position the cursor. Needed after a message that ends in a space. */
10799 windgoto(msg_row, msg_col);
10801 ++no_mapping;
10802 ++allow_keys;
10803 for (;;)
10805 if (argvars[0].v_type == VAR_UNKNOWN)
10806 /* getchar(): blocking wait. */
10807 n = safe_vgetc();
10808 else if (get_tv_number_chk(&argvars[0], &error) == 1)
10809 /* getchar(1): only check if char avail */
10810 n = vpeekc();
10811 else if (error || vpeekc() == NUL)
10812 /* illegal argument or getchar(0) and no char avail: return zero */
10813 n = 0;
10814 else
10815 /* getchar(0) and char avail: return char */
10816 n = safe_vgetc();
10817 if (n == K_IGNORE)
10818 continue;
10819 break;
10821 --no_mapping;
10822 --allow_keys;
10824 vimvars[VV_MOUSE_WIN].vv_nr = 0;
10825 vimvars[VV_MOUSE_LNUM].vv_nr = 0;
10826 vimvars[VV_MOUSE_COL].vv_nr = 0;
10828 rettv->vval.v_number = n;
10829 if (IS_SPECIAL(n) || mod_mask != 0)
10831 char_u temp[10]; /* modifier: 3, mbyte-char: 6, NUL: 1 */
10832 int i = 0;
10834 /* Turn a special key into three bytes, plus modifier. */
10835 if (mod_mask != 0)
10837 temp[i++] = K_SPECIAL;
10838 temp[i++] = KS_MODIFIER;
10839 temp[i++] = mod_mask;
10841 if (IS_SPECIAL(n))
10843 temp[i++] = K_SPECIAL;
10844 temp[i++] = K_SECOND(n);
10845 temp[i++] = K_THIRD(n);
10847 #ifdef FEAT_MBYTE
10848 else if (has_mbyte)
10849 i += (*mb_char2bytes)(n, temp + i);
10850 #endif
10851 else
10852 temp[i++] = n;
10853 temp[i++] = NUL;
10854 rettv->v_type = VAR_STRING;
10855 rettv->vval.v_string = vim_strsave(temp);
10857 #ifdef FEAT_MOUSE
10858 if (n == K_LEFTMOUSE
10859 || n == K_LEFTMOUSE_NM
10860 || n == K_LEFTDRAG
10861 || n == K_LEFTRELEASE
10862 || n == K_LEFTRELEASE_NM
10863 || n == K_MIDDLEMOUSE
10864 || n == K_MIDDLEDRAG
10865 || n == K_MIDDLERELEASE
10866 || n == K_RIGHTMOUSE
10867 || n == K_RIGHTDRAG
10868 || n == K_RIGHTRELEASE
10869 || n == K_X1MOUSE
10870 || n == K_X1DRAG
10871 || n == K_X1RELEASE
10872 || n == K_X2MOUSE
10873 || n == K_X2DRAG
10874 || n == K_X2RELEASE
10875 || n == K_MOUSEDOWN
10876 || n == K_MOUSEUP)
10878 int row = mouse_row;
10879 int col = mouse_col;
10880 win_T *win;
10881 linenr_T lnum;
10882 # ifdef FEAT_WINDOWS
10883 win_T *wp;
10884 # endif
10885 int winnr = 1;
10887 if (row >= 0 && col >= 0)
10889 /* Find the window at the mouse coordinates and compute the
10890 * text position. */
10891 win = mouse_find_win(&row, &col);
10892 (void)mouse_comp_pos(win, &row, &col, &lnum);
10893 # ifdef FEAT_WINDOWS
10894 for (wp = firstwin; wp != win; wp = wp->w_next)
10895 ++winnr;
10896 # endif
10897 vimvars[VV_MOUSE_WIN].vv_nr = winnr;
10898 vimvars[VV_MOUSE_LNUM].vv_nr = lnum;
10899 vimvars[VV_MOUSE_COL].vv_nr = col + 1;
10902 #endif
10907 * "getcharmod()" function
10909 static void
10910 f_getcharmod(argvars, rettv)
10911 typval_T *argvars UNUSED;
10912 typval_T *rettv;
10914 rettv->vval.v_number = mod_mask;
10918 * "getcmdline()" function
10920 static void
10921 f_getcmdline(argvars, rettv)
10922 typval_T *argvars UNUSED;
10923 typval_T *rettv;
10925 rettv->v_type = VAR_STRING;
10926 rettv->vval.v_string = get_cmdline_str();
10930 * "getcmdpos()" function
10932 static void
10933 f_getcmdpos(argvars, rettv)
10934 typval_T *argvars UNUSED;
10935 typval_T *rettv;
10937 rettv->vval.v_number = get_cmdline_pos() + 1;
10941 * "getcmdtype()" function
10943 static void
10944 f_getcmdtype(argvars, rettv)
10945 typval_T *argvars UNUSED;
10946 typval_T *rettv;
10948 rettv->v_type = VAR_STRING;
10949 rettv->vval.v_string = alloc(2);
10950 if (rettv->vval.v_string != NULL)
10952 rettv->vval.v_string[0] = get_cmdline_type();
10953 rettv->vval.v_string[1] = NUL;
10958 * "getcwd()" function
10960 static void
10961 f_getcwd(argvars, rettv)
10962 typval_T *argvars UNUSED;
10963 typval_T *rettv;
10965 char_u cwd[MAXPATHL];
10967 rettv->v_type = VAR_STRING;
10968 if (mch_dirname(cwd, MAXPATHL) == FAIL)
10969 rettv->vval.v_string = NULL;
10970 else
10972 rettv->vval.v_string = vim_strsave(cwd);
10973 #ifdef BACKSLASH_IN_FILENAME
10974 if (rettv->vval.v_string != NULL)
10975 slash_adjust(rettv->vval.v_string);
10976 #endif
10981 * "getfontname()" function
10983 static void
10984 f_getfontname(argvars, rettv)
10985 typval_T *argvars UNUSED;
10986 typval_T *rettv;
10988 rettv->v_type = VAR_STRING;
10989 rettv->vval.v_string = NULL;
10990 #ifdef FEAT_GUI
10991 if (gui.in_use)
10993 GuiFont font;
10994 char_u *name = NULL;
10996 if (argvars[0].v_type == VAR_UNKNOWN)
10998 /* Get the "Normal" font. Either the name saved by
10999 * hl_set_font_name() or from the font ID. */
11000 font = gui.norm_font;
11001 name = hl_get_font_name();
11003 else
11005 name = get_tv_string(&argvars[0]);
11006 if (STRCMP(name, "*") == 0) /* don't use font dialog */
11007 return;
11008 font = gui_mch_get_font(name, FALSE);
11009 if (font == NOFONT)
11010 return; /* Invalid font name, return empty string. */
11012 rettv->vval.v_string = gui_mch_get_fontname(font, name);
11013 if (argvars[0].v_type != VAR_UNKNOWN)
11014 gui_mch_free_font(font);
11016 #endif
11020 * "getfperm({fname})" function
11022 static void
11023 f_getfperm(argvars, rettv)
11024 typval_T *argvars;
11025 typval_T *rettv;
11027 char_u *fname;
11028 struct stat st;
11029 char_u *perm = NULL;
11030 char_u flags[] = "rwx";
11031 int i;
11033 fname = get_tv_string(&argvars[0]);
11035 rettv->v_type = VAR_STRING;
11036 if (mch_stat((char *)fname, &st) >= 0)
11038 perm = vim_strsave((char_u *)"---------");
11039 if (perm != NULL)
11041 for (i = 0; i < 9; i++)
11043 if (st.st_mode & (1 << (8 - i)))
11044 perm[i] = flags[i % 3];
11048 rettv->vval.v_string = perm;
11052 * "getfsize({fname})" function
11054 static void
11055 f_getfsize(argvars, rettv)
11056 typval_T *argvars;
11057 typval_T *rettv;
11059 char_u *fname;
11060 struct stat st;
11062 fname = get_tv_string(&argvars[0]);
11064 rettv->v_type = VAR_NUMBER;
11066 if (mch_stat((char *)fname, &st) >= 0)
11068 if (mch_isdir(fname))
11069 rettv->vval.v_number = 0;
11070 else
11072 rettv->vval.v_number = (varnumber_T)st.st_size;
11074 /* non-perfect check for overflow */
11075 if ((off_t)rettv->vval.v_number != (off_t)st.st_size)
11076 rettv->vval.v_number = -2;
11079 else
11080 rettv->vval.v_number = -1;
11084 * "getftime({fname})" function
11086 static void
11087 f_getftime(argvars, rettv)
11088 typval_T *argvars;
11089 typval_T *rettv;
11091 char_u *fname;
11092 struct stat st;
11094 fname = get_tv_string(&argvars[0]);
11096 if (mch_stat((char *)fname, &st) >= 0)
11097 rettv->vval.v_number = (varnumber_T)st.st_mtime;
11098 else
11099 rettv->vval.v_number = -1;
11103 * "getftype({fname})" function
11105 static void
11106 f_getftype(argvars, rettv)
11107 typval_T *argvars;
11108 typval_T *rettv;
11110 char_u *fname;
11111 struct stat st;
11112 char_u *type = NULL;
11113 char *t;
11115 fname = get_tv_string(&argvars[0]);
11117 rettv->v_type = VAR_STRING;
11118 if (mch_lstat((char *)fname, &st) >= 0)
11120 #ifdef S_ISREG
11121 if (S_ISREG(st.st_mode))
11122 t = "file";
11123 else if (S_ISDIR(st.st_mode))
11124 t = "dir";
11125 # ifdef S_ISLNK
11126 else if (S_ISLNK(st.st_mode))
11127 t = "link";
11128 # endif
11129 # ifdef S_ISBLK
11130 else if (S_ISBLK(st.st_mode))
11131 t = "bdev";
11132 # endif
11133 # ifdef S_ISCHR
11134 else if (S_ISCHR(st.st_mode))
11135 t = "cdev";
11136 # endif
11137 # ifdef S_ISFIFO
11138 else if (S_ISFIFO(st.st_mode))
11139 t = "fifo";
11140 # endif
11141 # ifdef S_ISSOCK
11142 else if (S_ISSOCK(st.st_mode))
11143 t = "fifo";
11144 # endif
11145 else
11146 t = "other";
11147 #else
11148 # ifdef S_IFMT
11149 switch (st.st_mode & S_IFMT)
11151 case S_IFREG: t = "file"; break;
11152 case S_IFDIR: t = "dir"; break;
11153 # ifdef S_IFLNK
11154 case S_IFLNK: t = "link"; break;
11155 # endif
11156 # ifdef S_IFBLK
11157 case S_IFBLK: t = "bdev"; break;
11158 # endif
11159 # ifdef S_IFCHR
11160 case S_IFCHR: t = "cdev"; break;
11161 # endif
11162 # ifdef S_IFIFO
11163 case S_IFIFO: t = "fifo"; break;
11164 # endif
11165 # ifdef S_IFSOCK
11166 case S_IFSOCK: t = "socket"; break;
11167 # endif
11168 default: t = "other";
11170 # else
11171 if (mch_isdir(fname))
11172 t = "dir";
11173 else
11174 t = "file";
11175 # endif
11176 #endif
11177 type = vim_strsave((char_u *)t);
11179 rettv->vval.v_string = type;
11183 * "getline(lnum, [end])" function
11185 static void
11186 f_getline(argvars, rettv)
11187 typval_T *argvars;
11188 typval_T *rettv;
11190 linenr_T lnum;
11191 linenr_T end;
11192 int retlist;
11194 lnum = get_tv_lnum(argvars);
11195 if (argvars[1].v_type == VAR_UNKNOWN)
11197 end = 0;
11198 retlist = FALSE;
11200 else
11202 end = get_tv_lnum(&argvars[1]);
11203 retlist = TRUE;
11206 get_buffer_lines(curbuf, lnum, end, retlist, rettv);
11210 * "getmatches()" function
11212 static void
11213 f_getmatches(argvars, rettv)
11214 typval_T *argvars UNUSED;
11215 typval_T *rettv;
11217 #ifdef FEAT_SEARCH_EXTRA
11218 dict_T *dict;
11219 matchitem_T *cur = curwin->w_match_head;
11221 if (rettv_list_alloc(rettv) == OK)
11223 while (cur != NULL)
11225 dict = dict_alloc();
11226 if (dict == NULL)
11227 return;
11228 dict_add_nr_str(dict, "group", 0L, syn_id2name(cur->hlg_id));
11229 dict_add_nr_str(dict, "pattern", 0L, cur->pattern);
11230 dict_add_nr_str(dict, "priority", (long)cur->priority, NULL);
11231 dict_add_nr_str(dict, "id", (long)cur->id, NULL);
11232 list_append_dict(rettv->vval.v_list, dict);
11233 cur = cur->next;
11236 #endif
11240 * "getpid()" function
11242 static void
11243 f_getpid(argvars, rettv)
11244 typval_T *argvars UNUSED;
11245 typval_T *rettv;
11247 rettv->vval.v_number = mch_get_pid();
11251 * "getpos(string)" function
11253 static void
11254 f_getpos(argvars, rettv)
11255 typval_T *argvars;
11256 typval_T *rettv;
11258 pos_T *fp;
11259 list_T *l;
11260 int fnum = -1;
11262 if (rettv_list_alloc(rettv) == OK)
11264 l = rettv->vval.v_list;
11265 fp = var2fpos(&argvars[0], TRUE, &fnum);
11266 if (fnum != -1)
11267 list_append_number(l, (varnumber_T)fnum);
11268 else
11269 list_append_number(l, (varnumber_T)0);
11270 list_append_number(l, (fp != NULL) ? (varnumber_T)fp->lnum
11271 : (varnumber_T)0);
11272 list_append_number(l, (fp != NULL)
11273 ? (varnumber_T)(fp->col == MAXCOL ? MAXCOL : fp->col + 1)
11274 : (varnumber_T)0);
11275 list_append_number(l,
11276 #ifdef FEAT_VIRTUALEDIT
11277 (fp != NULL) ? (varnumber_T)fp->coladd :
11278 #endif
11279 (varnumber_T)0);
11281 else
11282 rettv->vval.v_number = FALSE;
11286 * "getqflist()" and "getloclist()" functions
11288 static void
11289 f_getqflist(argvars, rettv)
11290 typval_T *argvars UNUSED;
11291 typval_T *rettv UNUSED;
11293 #ifdef FEAT_QUICKFIX
11294 win_T *wp;
11295 #endif
11297 #ifdef FEAT_QUICKFIX
11298 if (rettv_list_alloc(rettv) == OK)
11300 wp = NULL;
11301 if (argvars[0].v_type != VAR_UNKNOWN) /* getloclist() */
11303 wp = find_win_by_nr(&argvars[0], NULL);
11304 if (wp == NULL)
11305 return;
11308 (void)get_errorlist(wp, rettv->vval.v_list);
11310 #endif
11314 * "getreg()" function
11316 static void
11317 f_getreg(argvars, rettv)
11318 typval_T *argvars;
11319 typval_T *rettv;
11321 char_u *strregname;
11322 int regname;
11323 int arg2 = FALSE;
11324 int error = FALSE;
11326 if (argvars[0].v_type != VAR_UNKNOWN)
11328 strregname = get_tv_string_chk(&argvars[0]);
11329 error = strregname == NULL;
11330 if (argvars[1].v_type != VAR_UNKNOWN)
11331 arg2 = get_tv_number_chk(&argvars[1], &error);
11333 else
11334 strregname = vimvars[VV_REG].vv_str;
11335 regname = (strregname == NULL ? '"' : *strregname);
11336 if (regname == 0)
11337 regname = '"';
11339 rettv->v_type = VAR_STRING;
11340 rettv->vval.v_string = error ? NULL :
11341 get_reg_contents(regname, TRUE, arg2);
11345 * "getregtype()" function
11347 static void
11348 f_getregtype(argvars, rettv)
11349 typval_T *argvars;
11350 typval_T *rettv;
11352 char_u *strregname;
11353 int regname;
11354 char_u buf[NUMBUFLEN + 2];
11355 long reglen = 0;
11357 if (argvars[0].v_type != VAR_UNKNOWN)
11359 strregname = get_tv_string_chk(&argvars[0]);
11360 if (strregname == NULL) /* type error; errmsg already given */
11362 rettv->v_type = VAR_STRING;
11363 rettv->vval.v_string = NULL;
11364 return;
11367 else
11368 /* Default to v:register */
11369 strregname = vimvars[VV_REG].vv_str;
11371 regname = (strregname == NULL ? '"' : *strregname);
11372 if (regname == 0)
11373 regname = '"';
11375 buf[0] = NUL;
11376 buf[1] = NUL;
11377 switch (get_reg_type(regname, &reglen))
11379 case MLINE: buf[0] = 'V'; break;
11380 case MCHAR: buf[0] = 'v'; break;
11381 #ifdef FEAT_VISUAL
11382 case MBLOCK:
11383 buf[0] = Ctrl_V;
11384 sprintf((char *)buf + 1, "%ld", reglen + 1);
11385 break;
11386 #endif
11388 rettv->v_type = VAR_STRING;
11389 rettv->vval.v_string = vim_strsave(buf);
11393 * "gettabwinvar()" function
11395 static void
11396 f_gettabwinvar(argvars, rettv)
11397 typval_T *argvars;
11398 typval_T *rettv;
11400 getwinvar(argvars, rettv, 1);
11404 * "getwinposx()" function
11406 static void
11407 f_getwinposx(argvars, rettv)
11408 typval_T *argvars UNUSED;
11409 typval_T *rettv;
11411 rettv->vval.v_number = -1;
11412 #ifdef FEAT_GUI
11413 if (gui.in_use)
11415 int x, y;
11417 if (gui_mch_get_winpos(&x, &y) == OK)
11418 rettv->vval.v_number = x;
11420 #endif
11424 * "getwinposy()" function
11426 static void
11427 f_getwinposy(argvars, rettv)
11428 typval_T *argvars UNUSED;
11429 typval_T *rettv;
11431 rettv->vval.v_number = -1;
11432 #ifdef FEAT_GUI
11433 if (gui.in_use)
11435 int x, y;
11437 if (gui_mch_get_winpos(&x, &y) == OK)
11438 rettv->vval.v_number = y;
11440 #endif
11444 * Find window specified by "vp" in tabpage "tp".
11446 static win_T *
11447 find_win_by_nr(vp, tp)
11448 typval_T *vp;
11449 tabpage_T *tp; /* NULL for current tab page */
11451 #ifdef FEAT_WINDOWS
11452 win_T *wp;
11453 #endif
11454 int nr;
11456 nr = get_tv_number_chk(vp, NULL);
11458 #ifdef FEAT_WINDOWS
11459 if (nr < 0)
11460 return NULL;
11461 if (nr == 0)
11462 return curwin;
11464 for (wp = (tp == NULL || tp == curtab) ? firstwin : tp->tp_firstwin;
11465 wp != NULL; wp = wp->w_next)
11466 if (--nr <= 0)
11467 break;
11468 return wp;
11469 #else
11470 if (nr == 0 || nr == 1)
11471 return curwin;
11472 return NULL;
11473 #endif
11477 * "getwinvar()" function
11479 static void
11480 f_getwinvar(argvars, rettv)
11481 typval_T *argvars;
11482 typval_T *rettv;
11484 getwinvar(argvars, rettv, 0);
11488 * getwinvar() and gettabwinvar()
11490 static void
11491 getwinvar(argvars, rettv, off)
11492 typval_T *argvars;
11493 typval_T *rettv;
11494 int off; /* 1 for gettabwinvar() */
11496 win_T *win, *oldcurwin;
11497 char_u *varname;
11498 dictitem_T *v;
11499 tabpage_T *tp;
11501 #ifdef FEAT_WINDOWS
11502 if (off == 1)
11503 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
11504 else
11505 tp = curtab;
11506 #endif
11507 win = find_win_by_nr(&argvars[off], tp);
11508 varname = get_tv_string_chk(&argvars[off + 1]);
11509 ++emsg_off;
11511 rettv->v_type = VAR_STRING;
11512 rettv->vval.v_string = NULL;
11514 if (win != NULL && varname != NULL)
11516 /* Set curwin to be our win, temporarily. Also set curbuf, so
11517 * that we can get buffer-local options. */
11518 oldcurwin = curwin;
11519 curwin = win;
11520 curbuf = win->w_buffer;
11522 if (*varname == '&') /* window-local-option */
11523 get_option_tv(&varname, rettv, 1);
11524 else
11526 if (*varname == NUL)
11527 /* let getwinvar({nr}, "") return the "w:" dictionary. The
11528 * scope prefix before the NUL byte is required by
11529 * find_var_in_ht(). */
11530 varname = (char_u *)"w:" + 2;
11531 /* look up the variable */
11532 v = find_var_in_ht(&win->w_vars.dv_hashtab, varname, FALSE);
11533 if (v != NULL)
11534 copy_tv(&v->di_tv, rettv);
11537 /* restore previous notion of curwin */
11538 curwin = oldcurwin;
11539 curbuf = curwin->w_buffer;
11542 --emsg_off;
11546 * "glob()" function
11548 static void
11549 f_glob(argvars, rettv)
11550 typval_T *argvars;
11551 typval_T *rettv;
11553 int flags = WILD_SILENT|WILD_USE_NL;
11554 expand_T xpc;
11555 int error = FALSE;
11557 /* When the optional second argument is non-zero, don't remove matches
11558 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11559 if (argvars[1].v_type != VAR_UNKNOWN
11560 && get_tv_number_chk(&argvars[1], &error))
11561 flags |= WILD_KEEP_ALL;
11562 rettv->v_type = VAR_STRING;
11563 if (!error)
11565 ExpandInit(&xpc);
11566 xpc.xp_context = EXPAND_FILES;
11567 rettv->vval.v_string = ExpandOne(&xpc, get_tv_string(&argvars[0]),
11568 NULL, flags, WILD_ALL);
11570 else
11571 rettv->vval.v_string = NULL;
11575 * "globpath()" function
11577 static void
11578 f_globpath(argvars, rettv)
11579 typval_T *argvars;
11580 typval_T *rettv;
11582 int flags = 0;
11583 char_u buf1[NUMBUFLEN];
11584 char_u *file = get_tv_string_buf_chk(&argvars[1], buf1);
11585 int error = FALSE;
11587 /* When the optional second argument is non-zero, don't remove matches
11588 * for 'wildignore' and don't put matches for 'suffixes' at the end. */
11589 if (argvars[2].v_type != VAR_UNKNOWN
11590 && get_tv_number_chk(&argvars[2], &error))
11591 flags |= WILD_KEEP_ALL;
11592 rettv->v_type = VAR_STRING;
11593 if (file == NULL || error)
11594 rettv->vval.v_string = NULL;
11595 else
11596 rettv->vval.v_string = globpath(get_tv_string(&argvars[0]), file,
11597 flags);
11601 * "has()" function
11603 static void
11604 f_has(argvars, rettv)
11605 typval_T *argvars;
11606 typval_T *rettv;
11608 int i;
11609 char_u *name;
11610 int n = FALSE;
11611 static char *(has_list[]) =
11613 #ifdef AMIGA
11614 "amiga",
11615 # ifdef FEAT_ARP
11616 "arp",
11617 # endif
11618 #endif
11619 #ifdef __BEOS__
11620 "beos",
11621 #endif
11622 #ifdef MSDOS
11623 # ifdef DJGPP
11624 "dos32",
11625 # else
11626 "dos16",
11627 # endif
11628 #endif
11629 #ifdef MACOS
11630 "mac",
11631 #endif
11632 #if defined(MACOS_X_UNIX)
11633 "macunix",
11634 #endif
11635 #ifdef OS2
11636 "os2",
11637 #endif
11638 #ifdef __QNX__
11639 "qnx",
11640 #endif
11641 #ifdef RISCOS
11642 "riscos",
11643 #endif
11644 #ifdef UNIX
11645 "unix",
11646 #endif
11647 #ifdef VMS
11648 "vms",
11649 #endif
11650 #ifdef WIN16
11651 "win16",
11652 #endif
11653 #ifdef WIN32
11654 "win32",
11655 #endif
11656 #if defined(UNIX) && (defined(__CYGWIN32__) || defined(__CYGWIN__))
11657 "win32unix",
11658 #endif
11659 #if defined(WIN64) || defined(_WIN64)
11660 "win64",
11661 #endif
11662 #ifdef EBCDIC
11663 "ebcdic",
11664 #endif
11665 #ifndef CASE_INSENSITIVE_FILENAME
11666 "fname_case",
11667 #endif
11668 #ifdef FEAT_ARABIC
11669 "arabic",
11670 #endif
11671 #ifdef FEAT_AUTOCMD
11672 "autocmd",
11673 #endif
11674 #ifdef FEAT_BEVAL
11675 "balloon_eval",
11676 # ifndef FEAT_GUI_W32 /* other GUIs always have multiline balloons */
11677 "balloon_multiline",
11678 # endif
11679 #endif
11680 #if defined(SOME_BUILTIN_TCAPS) || defined(ALL_BUILTIN_TCAPS)
11681 "builtin_terms",
11682 # ifdef ALL_BUILTIN_TCAPS
11683 "all_builtin_terms",
11684 # endif
11685 #endif
11686 #ifdef FEAT_BYTEOFF
11687 "byte_offset",
11688 #endif
11689 #ifdef FEAT_CINDENT
11690 "cindent",
11691 #endif
11692 #ifdef FEAT_CLIENTSERVER
11693 "clientserver",
11694 #endif
11695 #ifdef FEAT_CLIPBOARD
11696 "clipboard",
11697 #endif
11698 #ifdef FEAT_CMDL_COMPL
11699 "cmdline_compl",
11700 #endif
11701 #ifdef FEAT_CMDHIST
11702 "cmdline_hist",
11703 #endif
11704 #ifdef FEAT_COMMENTS
11705 "comments",
11706 #endif
11707 #ifdef FEAT_CRYPT
11708 "cryptv",
11709 #endif
11710 #ifdef FEAT_CSCOPE
11711 "cscope",
11712 #endif
11713 #ifdef CURSOR_SHAPE
11714 "cursorshape",
11715 #endif
11716 #ifdef DEBUG
11717 "debug",
11718 #endif
11719 #ifdef FEAT_CON_DIALOG
11720 "dialog_con",
11721 #endif
11722 #ifdef FEAT_GUI_DIALOG
11723 "dialog_gui",
11724 #endif
11725 #ifdef FEAT_DIFF
11726 "diff",
11727 #endif
11728 #ifdef FEAT_DIGRAPHS
11729 "digraphs",
11730 #endif
11731 #ifdef FEAT_DND
11732 "dnd",
11733 #endif
11734 #ifdef FEAT_EMACS_TAGS
11735 "emacs_tags",
11736 #endif
11737 "eval", /* always present, of course! */
11738 #ifdef FEAT_EX_EXTRA
11739 "ex_extra",
11740 #endif
11741 #ifdef FEAT_SEARCH_EXTRA
11742 "extra_search",
11743 #endif
11744 #ifdef FEAT_FKMAP
11745 "farsi",
11746 #endif
11747 #ifdef FEAT_SEARCHPATH
11748 "file_in_path",
11749 #endif
11750 #if defined(UNIX) && !defined(USE_SYSTEM)
11751 "filterpipe",
11752 #endif
11753 #ifdef FEAT_FIND_ID
11754 "find_in_path",
11755 #endif
11756 #ifdef FEAT_FLOAT
11757 "float",
11758 #endif
11759 #ifdef FEAT_FOLDING
11760 "folding",
11761 #endif
11762 #ifdef FEAT_FOOTER
11763 "footer",
11764 #endif
11765 #if !defined(USE_SYSTEM) && defined(UNIX)
11766 "fork",
11767 #endif
11768 #ifdef FEAT_GETTEXT
11769 "gettext",
11770 #endif
11771 #ifdef FEAT_GUI
11772 "gui",
11773 #endif
11774 #ifdef FEAT_GUI_ATHENA
11775 # ifdef FEAT_GUI_NEXTAW
11776 "gui_neXtaw",
11777 # else
11778 "gui_athena",
11779 # endif
11780 #endif
11781 #ifdef FEAT_GUI_GTK
11782 "gui_gtk",
11783 # ifdef HAVE_GTK2
11784 "gui_gtk2",
11785 # endif
11786 #endif
11787 #ifdef FEAT_GUI_GNOME
11788 "gui_gnome",
11789 #endif
11790 #ifdef FEAT_GUI_MAC
11791 "gui_mac",
11792 #endif
11793 #ifdef FEAT_GUI_MOTIF
11794 "gui_motif",
11795 #endif
11796 #ifdef FEAT_GUI_PHOTON
11797 "gui_photon",
11798 #endif
11799 #ifdef FEAT_GUI_W16
11800 "gui_win16",
11801 #endif
11802 #ifdef FEAT_GUI_W32
11803 "gui_win32",
11804 #endif
11805 #ifdef FEAT_HANGULIN
11806 "hangul_input",
11807 #endif
11808 #if defined(HAVE_ICONV_H) && defined(USE_ICONV)
11809 "iconv",
11810 #endif
11811 #ifdef FEAT_INS_EXPAND
11812 "insert_expand",
11813 #endif
11814 #ifdef FEAT_JUMPLIST
11815 "jumplist",
11816 #endif
11817 #ifdef FEAT_KEYMAP
11818 "keymap",
11819 #endif
11820 #ifdef FEAT_LANGMAP
11821 "langmap",
11822 #endif
11823 #ifdef FEAT_LIBCALL
11824 "libcall",
11825 #endif
11826 #ifdef FEAT_LINEBREAK
11827 "linebreak",
11828 #endif
11829 #ifdef FEAT_LISP
11830 "lispindent",
11831 #endif
11832 #ifdef FEAT_LISTCMDS
11833 "listcmds",
11834 #endif
11835 #ifdef FEAT_LOCALMAP
11836 "localmap",
11837 #endif
11838 #ifdef FEAT_MENU
11839 "menu",
11840 #endif
11841 #ifdef FEAT_SESSION
11842 "mksession",
11843 #endif
11844 #ifdef FEAT_MODIFY_FNAME
11845 "modify_fname",
11846 #endif
11847 #ifdef FEAT_MOUSE
11848 "mouse",
11849 #endif
11850 #ifdef FEAT_MOUSESHAPE
11851 "mouseshape",
11852 #endif
11853 #if defined(UNIX) || defined(VMS)
11854 # ifdef FEAT_MOUSE_DEC
11855 "mouse_dec",
11856 # endif
11857 # ifdef FEAT_MOUSE_GPM
11858 "mouse_gpm",
11859 # endif
11860 # ifdef FEAT_MOUSE_JSB
11861 "mouse_jsbterm",
11862 # endif
11863 # ifdef FEAT_MOUSE_NET
11864 "mouse_netterm",
11865 # endif
11866 # ifdef FEAT_MOUSE_PTERM
11867 "mouse_pterm",
11868 # endif
11869 # ifdef FEAT_SYSMOUSE
11870 "mouse_sysmouse",
11871 # endif
11872 # ifdef FEAT_MOUSE_XTERM
11873 "mouse_xterm",
11874 # endif
11875 #endif
11876 #ifdef FEAT_MBYTE
11877 "multi_byte",
11878 #endif
11879 #ifdef FEAT_MBYTE_IME
11880 "multi_byte_ime",
11881 #endif
11882 #ifdef FEAT_MULTI_LANG
11883 "multi_lang",
11884 #endif
11885 #ifdef FEAT_MZSCHEME
11886 #ifndef DYNAMIC_MZSCHEME
11887 "mzscheme",
11888 #endif
11889 #endif
11890 #ifdef FEAT_OLE
11891 "ole",
11892 #endif
11893 #ifdef FEAT_OSFILETYPE
11894 "osfiletype",
11895 #endif
11896 #ifdef FEAT_PATH_EXTRA
11897 "path_extra",
11898 #endif
11899 #ifdef FEAT_PERL
11900 #ifndef DYNAMIC_PERL
11901 "perl",
11902 #endif
11903 #endif
11904 #ifdef FEAT_PYTHON
11905 #ifndef DYNAMIC_PYTHON
11906 "python",
11907 #endif
11908 #endif
11909 #ifdef FEAT_POSTSCRIPT
11910 "postscript",
11911 #endif
11912 #ifdef FEAT_PRINTER
11913 "printer",
11914 #endif
11915 #ifdef FEAT_PROFILE
11916 "profile",
11917 #endif
11918 #ifdef FEAT_RELTIME
11919 "reltime",
11920 #endif
11921 #ifdef FEAT_QUICKFIX
11922 "quickfix",
11923 #endif
11924 #ifdef FEAT_RIGHTLEFT
11925 "rightleft",
11926 #endif
11927 #if defined(FEAT_RUBY) && !defined(DYNAMIC_RUBY)
11928 "ruby",
11929 #endif
11930 #ifdef FEAT_SCROLLBIND
11931 "scrollbind",
11932 #endif
11933 #ifdef FEAT_CMDL_INFO
11934 "showcmd",
11935 "cmdline_info",
11936 #endif
11937 #ifdef FEAT_SIGNS
11938 "signs",
11939 #endif
11940 #ifdef FEAT_SMARTINDENT
11941 "smartindent",
11942 #endif
11943 #ifdef FEAT_SNIFF
11944 "sniff",
11945 #endif
11946 #ifdef STARTUPTIME
11947 "startuptime",
11948 #endif
11949 #ifdef FEAT_STL_OPT
11950 "statusline",
11951 #endif
11952 #ifdef FEAT_SUN_WORKSHOP
11953 "sun_workshop",
11954 #endif
11955 #ifdef FEAT_NETBEANS_INTG
11956 "netbeans_intg",
11957 #endif
11958 #ifdef FEAT_SPELL
11959 "spell",
11960 #endif
11961 #ifdef FEAT_SYN_HL
11962 "syntax",
11963 #endif
11964 #if defined(USE_SYSTEM) || !defined(UNIX)
11965 "system",
11966 #endif
11967 #ifdef FEAT_TAG_BINS
11968 "tag_binary",
11969 #endif
11970 #ifdef FEAT_TAG_OLDSTATIC
11971 "tag_old_static",
11972 #endif
11973 #ifdef FEAT_TAG_ANYWHITE
11974 "tag_any_white",
11975 #endif
11976 #ifdef FEAT_TCL
11977 # ifndef DYNAMIC_TCL
11978 "tcl",
11979 # endif
11980 #endif
11981 #ifdef TERMINFO
11982 "terminfo",
11983 #endif
11984 #ifdef FEAT_TERMRESPONSE
11985 "termresponse",
11986 #endif
11987 #ifdef FEAT_TEXTOBJ
11988 "textobjects",
11989 #endif
11990 #ifdef HAVE_TGETENT
11991 "tgetent",
11992 #endif
11993 #ifdef FEAT_TITLE
11994 "title",
11995 #endif
11996 #ifdef FEAT_TOOLBAR
11997 "toolbar",
11998 #endif
11999 #ifdef FEAT_USR_CMDS
12000 "user-commands", /* was accidentally included in 5.4 */
12001 "user_commands",
12002 #endif
12003 #ifdef FEAT_VIMINFO
12004 "viminfo",
12005 #endif
12006 #ifdef FEAT_VERTSPLIT
12007 "vertsplit",
12008 #endif
12009 #ifdef FEAT_VIRTUALEDIT
12010 "virtualedit",
12011 #endif
12012 #ifdef FEAT_VISUAL
12013 "visual",
12014 #endif
12015 #ifdef FEAT_VISUALEXTRA
12016 "visualextra",
12017 #endif
12018 #ifdef FEAT_VREPLACE
12019 "vreplace",
12020 #endif
12021 #ifdef FEAT_WILDIGN
12022 "wildignore",
12023 #endif
12024 #ifdef FEAT_WILDMENU
12025 "wildmenu",
12026 #endif
12027 #ifdef FEAT_WINDOWS
12028 "windows",
12029 #endif
12030 #ifdef FEAT_WAK
12031 "winaltkeys",
12032 #endif
12033 #ifdef FEAT_WRITEBACKUP
12034 "writebackup",
12035 #endif
12036 #ifdef FEAT_XIM
12037 "xim",
12038 #endif
12039 #ifdef FEAT_XFONTSET
12040 "xfontset",
12041 #endif
12042 #ifdef USE_XSMP
12043 "xsmp",
12044 #endif
12045 #ifdef USE_XSMP_INTERACT
12046 "xsmp_interact",
12047 #endif
12048 #ifdef FEAT_XCLIPBOARD
12049 "xterm_clipboard",
12050 #endif
12051 #ifdef FEAT_XTERM_SAVE
12052 "xterm_save",
12053 #endif
12054 #if defined(UNIX) && defined(FEAT_X11)
12055 "X11",
12056 #endif
12057 NULL
12060 name = get_tv_string(&argvars[0]);
12061 for (i = 0; has_list[i] != NULL; ++i)
12062 if (STRICMP(name, has_list[i]) == 0)
12064 n = TRUE;
12065 break;
12068 if (n == FALSE)
12070 if (STRNICMP(name, "patch", 5) == 0)
12071 n = has_patch(atoi((char *)name + 5));
12072 else if (STRICMP(name, "vim_starting") == 0)
12073 n = (starting != 0);
12074 #ifdef FEAT_MBYTE
12075 else if (STRICMP(name, "multi_byte_encoding") == 0)
12076 n = has_mbyte;
12077 #endif
12078 #if defined(FEAT_BEVAL) && defined(FEAT_GUI_W32)
12079 else if (STRICMP(name, "balloon_multiline") == 0)
12080 n = multiline_balloon_available();
12081 #endif
12082 #ifdef DYNAMIC_TCL
12083 else if (STRICMP(name, "tcl") == 0)
12084 n = tcl_enabled(FALSE);
12085 #endif
12086 #if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
12087 else if (STRICMP(name, "iconv") == 0)
12088 n = iconv_enabled(FALSE);
12089 #endif
12090 #ifdef DYNAMIC_MZSCHEME
12091 else if (STRICMP(name, "mzscheme") == 0)
12092 n = mzscheme_enabled(FALSE);
12093 #endif
12094 #ifdef DYNAMIC_RUBY
12095 else if (STRICMP(name, "ruby") == 0)
12096 n = ruby_enabled(FALSE);
12097 #endif
12098 #ifdef DYNAMIC_PYTHON
12099 else if (STRICMP(name, "python") == 0)
12100 n = python_enabled(FALSE);
12101 #endif
12102 #ifdef DYNAMIC_PERL
12103 else if (STRICMP(name, "perl") == 0)
12104 n = perl_enabled(FALSE);
12105 #endif
12106 #ifdef FEAT_GUI
12107 else if (STRICMP(name, "gui_running") == 0)
12108 n = (gui.in_use || gui.starting);
12109 # ifdef FEAT_GUI_W32
12110 else if (STRICMP(name, "gui_win32s") == 0)
12111 n = gui_is_win32s();
12112 # endif
12113 # ifdef FEAT_BROWSE
12114 else if (STRICMP(name, "browse") == 0)
12115 n = gui.in_use; /* gui_mch_browse() works when GUI is running */
12116 # endif
12117 #endif
12118 #ifdef FEAT_SYN_HL
12119 else if (STRICMP(name, "syntax_items") == 0)
12120 n = syntax_present(curbuf);
12121 #endif
12122 #if defined(WIN3264)
12123 else if (STRICMP(name, "win95") == 0)
12124 n = mch_windows95();
12125 #endif
12126 #ifdef FEAT_NETBEANS_INTG
12127 else if (STRICMP(name, "netbeans_enabled") == 0)
12128 n = usingNetbeans;
12129 #endif
12132 rettv->vval.v_number = n;
12136 * "has_key()" function
12138 static void
12139 f_has_key(argvars, rettv)
12140 typval_T *argvars;
12141 typval_T *rettv;
12143 if (argvars[0].v_type != VAR_DICT)
12145 EMSG(_(e_dictreq));
12146 return;
12148 if (argvars[0].vval.v_dict == NULL)
12149 return;
12151 rettv->vval.v_number = dict_find(argvars[0].vval.v_dict,
12152 get_tv_string(&argvars[1]), -1) != NULL;
12156 * "haslocaldir()" function
12158 static void
12159 f_haslocaldir(argvars, rettv)
12160 typval_T *argvars UNUSED;
12161 typval_T *rettv;
12163 rettv->vval.v_number = (curwin->w_localdir != NULL);
12167 * "hasmapto()" function
12169 static void
12170 f_hasmapto(argvars, rettv)
12171 typval_T *argvars;
12172 typval_T *rettv;
12174 char_u *name;
12175 char_u *mode;
12176 char_u buf[NUMBUFLEN];
12177 int abbr = FALSE;
12179 name = get_tv_string(&argvars[0]);
12180 if (argvars[1].v_type == VAR_UNKNOWN)
12181 mode = (char_u *)"nvo";
12182 else
12184 mode = get_tv_string_buf(&argvars[1], buf);
12185 if (argvars[2].v_type != VAR_UNKNOWN)
12186 abbr = get_tv_number(&argvars[2]);
12189 if (map_to_exists(name, mode, abbr))
12190 rettv->vval.v_number = TRUE;
12191 else
12192 rettv->vval.v_number = FALSE;
12196 * "histadd()" function
12198 static void
12199 f_histadd(argvars, rettv)
12200 typval_T *argvars UNUSED;
12201 typval_T *rettv;
12203 #ifdef FEAT_CMDHIST
12204 int histype;
12205 char_u *str;
12206 char_u buf[NUMBUFLEN];
12207 #endif
12209 rettv->vval.v_number = FALSE;
12210 if (check_restricted() || check_secure())
12211 return;
12212 #ifdef FEAT_CMDHIST
12213 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12214 histype = str != NULL ? get_histtype(str) : -1;
12215 if (histype >= 0)
12217 str = get_tv_string_buf(&argvars[1], buf);
12218 if (*str != NUL)
12220 init_history();
12221 add_to_history(histype, str, FALSE, NUL);
12222 rettv->vval.v_number = TRUE;
12223 return;
12226 #endif
12230 * "histdel()" function
12232 static void
12233 f_histdel(argvars, rettv)
12234 typval_T *argvars UNUSED;
12235 typval_T *rettv UNUSED;
12237 #ifdef FEAT_CMDHIST
12238 int n;
12239 char_u buf[NUMBUFLEN];
12240 char_u *str;
12242 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12243 if (str == NULL)
12244 n = 0;
12245 else if (argvars[1].v_type == VAR_UNKNOWN)
12246 /* only one argument: clear entire history */
12247 n = clr_history(get_histtype(str));
12248 else if (argvars[1].v_type == VAR_NUMBER)
12249 /* index given: remove that entry */
12250 n = del_history_idx(get_histtype(str),
12251 (int)get_tv_number(&argvars[1]));
12252 else
12253 /* string given: remove all matching entries */
12254 n = del_history_entry(get_histtype(str),
12255 get_tv_string_buf(&argvars[1], buf));
12256 rettv->vval.v_number = n;
12257 #endif
12261 * "histget()" function
12263 static void
12264 f_histget(argvars, rettv)
12265 typval_T *argvars UNUSED;
12266 typval_T *rettv;
12268 #ifdef FEAT_CMDHIST
12269 int type;
12270 int idx;
12271 char_u *str;
12273 str = get_tv_string_chk(&argvars[0]); /* NULL on type error */
12274 if (str == NULL)
12275 rettv->vval.v_string = NULL;
12276 else
12278 type = get_histtype(str);
12279 if (argvars[1].v_type == VAR_UNKNOWN)
12280 idx = get_history_idx(type);
12281 else
12282 idx = (int)get_tv_number_chk(&argvars[1], NULL);
12283 /* -1 on type error */
12284 rettv->vval.v_string = vim_strsave(get_history_entry(type, idx));
12286 #else
12287 rettv->vval.v_string = NULL;
12288 #endif
12289 rettv->v_type = VAR_STRING;
12293 * "histnr()" function
12295 static void
12296 f_histnr(argvars, rettv)
12297 typval_T *argvars UNUSED;
12298 typval_T *rettv;
12300 int i;
12302 #ifdef FEAT_CMDHIST
12303 char_u *history = get_tv_string_chk(&argvars[0]);
12305 i = history == NULL ? HIST_CMD - 1 : get_histtype(history);
12306 if (i >= HIST_CMD && i < HIST_COUNT)
12307 i = get_history_idx(i);
12308 else
12309 #endif
12310 i = -1;
12311 rettv->vval.v_number = i;
12315 * "highlightID(name)" function
12317 static void
12318 f_hlID(argvars, rettv)
12319 typval_T *argvars;
12320 typval_T *rettv;
12322 rettv->vval.v_number = syn_name2id(get_tv_string(&argvars[0]));
12326 * "highlight_exists()" function
12328 static void
12329 f_hlexists(argvars, rettv)
12330 typval_T *argvars;
12331 typval_T *rettv;
12333 rettv->vval.v_number = highlight_exists(get_tv_string(&argvars[0]));
12337 * "hostname()" function
12339 static void
12340 f_hostname(argvars, rettv)
12341 typval_T *argvars UNUSED;
12342 typval_T *rettv;
12344 char_u hostname[256];
12346 mch_get_host_name(hostname, 256);
12347 rettv->v_type = VAR_STRING;
12348 rettv->vval.v_string = vim_strsave(hostname);
12352 * iconv() function
12354 static void
12355 f_iconv(argvars, rettv)
12356 typval_T *argvars UNUSED;
12357 typval_T *rettv;
12359 #ifdef FEAT_MBYTE
12360 char_u buf1[NUMBUFLEN];
12361 char_u buf2[NUMBUFLEN];
12362 char_u *from, *to, *str;
12363 vimconv_T vimconv;
12364 #endif
12366 rettv->v_type = VAR_STRING;
12367 rettv->vval.v_string = NULL;
12369 #ifdef FEAT_MBYTE
12370 str = get_tv_string(&argvars[0]);
12371 from = enc_canonize(enc_skip(get_tv_string_buf(&argvars[1], buf1)));
12372 to = enc_canonize(enc_skip(get_tv_string_buf(&argvars[2], buf2)));
12373 vimconv.vc_type = CONV_NONE;
12374 convert_setup(&vimconv, from, to);
12376 /* If the encodings are equal, no conversion needed. */
12377 if (vimconv.vc_type == CONV_NONE)
12378 rettv->vval.v_string = vim_strsave(str);
12379 else
12380 rettv->vval.v_string = string_convert(&vimconv, str, NULL);
12382 convert_setup(&vimconv, NULL, NULL);
12383 vim_free(from);
12384 vim_free(to);
12385 #endif
12389 * "indent()" function
12391 static void
12392 f_indent(argvars, rettv)
12393 typval_T *argvars;
12394 typval_T *rettv;
12396 linenr_T lnum;
12398 lnum = get_tv_lnum(argvars);
12399 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
12400 rettv->vval.v_number = get_indent_lnum(lnum);
12401 else
12402 rettv->vval.v_number = -1;
12406 * "index()" function
12408 static void
12409 f_index(argvars, rettv)
12410 typval_T *argvars;
12411 typval_T *rettv;
12413 list_T *l;
12414 listitem_T *item;
12415 long idx = 0;
12416 int ic = FALSE;
12418 rettv->vval.v_number = -1;
12419 if (argvars[0].v_type != VAR_LIST)
12421 EMSG(_(e_listreq));
12422 return;
12424 l = argvars[0].vval.v_list;
12425 if (l != NULL)
12427 item = l->lv_first;
12428 if (argvars[2].v_type != VAR_UNKNOWN)
12430 int error = FALSE;
12432 /* Start at specified item. Use the cached index that list_find()
12433 * sets, so that a negative number also works. */
12434 item = list_find(l, get_tv_number_chk(&argvars[2], &error));
12435 idx = l->lv_idx;
12436 if (argvars[3].v_type != VAR_UNKNOWN)
12437 ic = get_tv_number_chk(&argvars[3], &error);
12438 if (error)
12439 item = NULL;
12442 for ( ; item != NULL; item = item->li_next, ++idx)
12443 if (tv_equal(&item->li_tv, &argvars[1], ic))
12445 rettv->vval.v_number = idx;
12446 break;
12451 static int inputsecret_flag = 0;
12453 static void get_user_input __ARGS((typval_T *argvars, typval_T *rettv, int inputdialog));
12456 * This function is used by f_input() and f_inputdialog() functions. The third
12457 * argument to f_input() specifies the type of completion to use at the
12458 * prompt. The third argument to f_inputdialog() specifies the value to return
12459 * when the user cancels the prompt.
12461 static void
12462 get_user_input(argvars, rettv, inputdialog)
12463 typval_T *argvars;
12464 typval_T *rettv;
12465 int inputdialog;
12467 char_u *prompt = get_tv_string_chk(&argvars[0]);
12468 char_u *p = NULL;
12469 int c;
12470 char_u buf[NUMBUFLEN];
12471 int cmd_silent_save = cmd_silent;
12472 char_u *defstr = (char_u *)"";
12473 int xp_type = EXPAND_NOTHING;
12474 char_u *xp_arg = NULL;
12476 rettv->v_type = VAR_STRING;
12477 rettv->vval.v_string = NULL;
12479 #ifdef NO_CONSOLE_INPUT
12480 /* While starting up, there is no place to enter text. */
12481 if (no_console_input())
12482 return;
12483 #endif
12485 cmd_silent = FALSE; /* Want to see the prompt. */
12486 if (prompt != NULL)
12488 /* Only the part of the message after the last NL is considered as
12489 * prompt for the command line */
12490 p = vim_strrchr(prompt, '\n');
12491 if (p == NULL)
12492 p = prompt;
12493 else
12495 ++p;
12496 c = *p;
12497 *p = NUL;
12498 msg_start();
12499 msg_clr_eos();
12500 msg_puts_attr(prompt, echo_attr);
12501 msg_didout = FALSE;
12502 msg_starthere();
12503 *p = c;
12505 cmdline_row = msg_row;
12507 if (argvars[1].v_type != VAR_UNKNOWN)
12509 defstr = get_tv_string_buf_chk(&argvars[1], buf);
12510 if (defstr != NULL)
12511 stuffReadbuffSpec(defstr);
12513 if (!inputdialog && argvars[2].v_type != VAR_UNKNOWN)
12515 char_u *xp_name;
12516 int xp_namelen;
12517 long argt;
12519 rettv->vval.v_string = NULL;
12521 xp_name = get_tv_string_buf_chk(&argvars[2], buf);
12522 if (xp_name == NULL)
12523 return;
12525 xp_namelen = (int)STRLEN(xp_name);
12527 if (parse_compl_arg(xp_name, xp_namelen, &xp_type, &argt,
12528 &xp_arg) == FAIL)
12529 return;
12533 if (defstr != NULL)
12534 rettv->vval.v_string =
12535 getcmdline_prompt(inputsecret_flag ? NUL : '@', p, echo_attr,
12536 xp_type, xp_arg);
12538 vim_free(xp_arg);
12540 /* since the user typed this, no need to wait for return */
12541 need_wait_return = FALSE;
12542 msg_didout = FALSE;
12544 cmd_silent = cmd_silent_save;
12548 * "input()" function
12549 * Also handles inputsecret() when inputsecret is set.
12551 static void
12552 f_input(argvars, rettv)
12553 typval_T *argvars;
12554 typval_T *rettv;
12556 get_user_input(argvars, rettv, FALSE);
12560 * "inputdialog()" function
12562 static void
12563 f_inputdialog(argvars, rettv)
12564 typval_T *argvars;
12565 typval_T *rettv;
12567 #if defined(FEAT_GUI_TEXTDIALOG)
12568 /* Use a GUI dialog if the GUI is running and 'c' is not in 'guioptions' */
12569 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL)
12571 char_u *message;
12572 char_u buf[NUMBUFLEN];
12573 char_u *defstr = (char_u *)"";
12575 message = get_tv_string_chk(&argvars[0]);
12576 if (argvars[1].v_type != VAR_UNKNOWN
12577 && (defstr = get_tv_string_buf_chk(&argvars[1], buf)) != NULL)
12578 vim_strncpy(IObuff, defstr, IOSIZE - 1);
12579 else
12580 IObuff[0] = NUL;
12581 if (message != NULL && defstr != NULL
12582 && do_dialog(VIM_QUESTION, NULL, message,
12583 (char_u *)_("&OK\n&Cancel"), 1, IObuff) == 1)
12584 rettv->vval.v_string = vim_strsave(IObuff);
12585 else
12587 if (message != NULL && defstr != NULL
12588 && argvars[1].v_type != VAR_UNKNOWN
12589 && argvars[2].v_type != VAR_UNKNOWN)
12590 rettv->vval.v_string = vim_strsave(
12591 get_tv_string_buf(&argvars[2], buf));
12592 else
12593 rettv->vval.v_string = NULL;
12595 rettv->v_type = VAR_STRING;
12597 else
12598 #endif
12599 get_user_input(argvars, rettv, TRUE);
12603 * "inputlist()" function
12605 static void
12606 f_inputlist(argvars, rettv)
12607 typval_T *argvars;
12608 typval_T *rettv;
12610 listitem_T *li;
12611 int selected;
12612 int mouse_used;
12614 #ifdef NO_CONSOLE_INPUT
12615 /* While starting up, there is no place to enter text. */
12616 if (no_console_input())
12617 return;
12618 #endif
12619 if (argvars[0].v_type != VAR_LIST || argvars[0].vval.v_list == NULL)
12621 EMSG2(_(e_listarg), "inputlist()");
12622 return;
12625 msg_start();
12626 msg_row = Rows - 1; /* for when 'cmdheight' > 1 */
12627 lines_left = Rows; /* avoid more prompt */
12628 msg_scroll = TRUE;
12629 msg_clr_eos();
12631 for (li = argvars[0].vval.v_list->lv_first; li != NULL; li = li->li_next)
12633 msg_puts(get_tv_string(&li->li_tv));
12634 msg_putchar('\n');
12637 /* Ask for choice. */
12638 selected = prompt_for_number(&mouse_used);
12639 if (mouse_used)
12640 selected -= lines_left;
12642 rettv->vval.v_number = selected;
12646 static garray_T ga_userinput = {0, 0, sizeof(tasave_T), 4, NULL};
12649 * "inputrestore()" function
12651 static void
12652 f_inputrestore(argvars, rettv)
12653 typval_T *argvars UNUSED;
12654 typval_T *rettv;
12656 if (ga_userinput.ga_len > 0)
12658 --ga_userinput.ga_len;
12659 restore_typeahead((tasave_T *)(ga_userinput.ga_data)
12660 + ga_userinput.ga_len);
12661 /* default return is zero == OK */
12663 else if (p_verbose > 1)
12665 verb_msg((char_u *)_("called inputrestore() more often than inputsave()"));
12666 rettv->vval.v_number = 1; /* Failed */
12671 * "inputsave()" function
12673 static void
12674 f_inputsave(argvars, rettv)
12675 typval_T *argvars UNUSED;
12676 typval_T *rettv;
12678 /* Add an entry to the stack of typeahead storage. */
12679 if (ga_grow(&ga_userinput, 1) == OK)
12681 save_typeahead((tasave_T *)(ga_userinput.ga_data)
12682 + ga_userinput.ga_len);
12683 ++ga_userinput.ga_len;
12684 /* default return is zero == OK */
12686 else
12687 rettv->vval.v_number = 1; /* Failed */
12691 * "inputsecret()" function
12693 static void
12694 f_inputsecret(argvars, rettv)
12695 typval_T *argvars;
12696 typval_T *rettv;
12698 ++cmdline_star;
12699 ++inputsecret_flag;
12700 f_input(argvars, rettv);
12701 --cmdline_star;
12702 --inputsecret_flag;
12706 * "insert()" function
12708 static void
12709 f_insert(argvars, rettv)
12710 typval_T *argvars;
12711 typval_T *rettv;
12713 long before = 0;
12714 listitem_T *item;
12715 list_T *l;
12716 int error = FALSE;
12718 if (argvars[0].v_type != VAR_LIST)
12719 EMSG2(_(e_listarg), "insert()");
12720 else if ((l = argvars[0].vval.v_list) != NULL
12721 && !tv_check_lock(l->lv_lock, (char_u *)"insert()"))
12723 if (argvars[2].v_type != VAR_UNKNOWN)
12724 before = get_tv_number_chk(&argvars[2], &error);
12725 if (error)
12726 return; /* type error; errmsg already given */
12728 if (before == l->lv_len)
12729 item = NULL;
12730 else
12732 item = list_find(l, before);
12733 if (item == NULL)
12735 EMSGN(_(e_listidx), before);
12736 l = NULL;
12739 if (l != NULL)
12741 list_insert_tv(l, &argvars[1], item);
12742 copy_tv(&argvars[0], rettv);
12748 * "isdirectory()" function
12750 static void
12751 f_isdirectory(argvars, rettv)
12752 typval_T *argvars;
12753 typval_T *rettv;
12755 rettv->vval.v_number = mch_isdir(get_tv_string(&argvars[0]));
12759 * "islocked()" function
12761 static void
12762 f_islocked(argvars, rettv)
12763 typval_T *argvars;
12764 typval_T *rettv;
12766 lval_T lv;
12767 char_u *end;
12768 dictitem_T *di;
12770 rettv->vval.v_number = -1;
12771 end = get_lval(get_tv_string(&argvars[0]), NULL, &lv, FALSE, FALSE, FALSE,
12772 FNE_CHECK_START);
12773 if (end != NULL && lv.ll_name != NULL)
12775 if (*end != NUL)
12776 EMSG(_(e_trailing));
12777 else
12779 if (lv.ll_tv == NULL)
12781 if (check_changedtick(lv.ll_name))
12782 rettv->vval.v_number = 1; /* always locked */
12783 else
12785 di = find_var(lv.ll_name, NULL);
12786 if (di != NULL)
12788 /* Consider a variable locked when:
12789 * 1. the variable itself is locked
12790 * 2. the value of the variable is locked.
12791 * 3. the List or Dict value is locked.
12793 rettv->vval.v_number = ((di->di_flags & DI_FLAGS_LOCK)
12794 || tv_islocked(&di->di_tv));
12798 else if (lv.ll_range)
12799 EMSG(_("E786: Range not allowed"));
12800 else if (lv.ll_newkey != NULL)
12801 EMSG2(_(e_dictkey), lv.ll_newkey);
12802 else if (lv.ll_list != NULL)
12803 /* List item. */
12804 rettv->vval.v_number = tv_islocked(&lv.ll_li->li_tv);
12805 else
12806 /* Dictionary item. */
12807 rettv->vval.v_number = tv_islocked(&lv.ll_di->di_tv);
12811 clear_lval(&lv);
12814 static void dict_list __ARGS((typval_T *argvars, typval_T *rettv, int what));
12817 * Turn a dict into a list:
12818 * "what" == 0: list of keys
12819 * "what" == 1: list of values
12820 * "what" == 2: list of items
12822 static void
12823 dict_list(argvars, rettv, what)
12824 typval_T *argvars;
12825 typval_T *rettv;
12826 int what;
12828 list_T *l2;
12829 dictitem_T *di;
12830 hashitem_T *hi;
12831 listitem_T *li;
12832 listitem_T *li2;
12833 dict_T *d;
12834 int todo;
12836 if (argvars[0].v_type != VAR_DICT)
12838 EMSG(_(e_dictreq));
12839 return;
12841 if ((d = argvars[0].vval.v_dict) == NULL)
12842 return;
12844 if (rettv_list_alloc(rettv) == FAIL)
12845 return;
12847 todo = (int)d->dv_hashtab.ht_used;
12848 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
12850 if (!HASHITEM_EMPTY(hi))
12852 --todo;
12853 di = HI2DI(hi);
12855 li = listitem_alloc();
12856 if (li == NULL)
12857 break;
12858 list_append(rettv->vval.v_list, li);
12860 if (what == 0)
12862 /* keys() */
12863 li->li_tv.v_type = VAR_STRING;
12864 li->li_tv.v_lock = 0;
12865 li->li_tv.vval.v_string = vim_strsave(di->di_key);
12867 else if (what == 1)
12869 /* values() */
12870 copy_tv(&di->di_tv, &li->li_tv);
12872 else
12874 /* items() */
12875 l2 = list_alloc();
12876 li->li_tv.v_type = VAR_LIST;
12877 li->li_tv.v_lock = 0;
12878 li->li_tv.vval.v_list = l2;
12879 if (l2 == NULL)
12880 break;
12881 ++l2->lv_refcount;
12883 li2 = listitem_alloc();
12884 if (li2 == NULL)
12885 break;
12886 list_append(l2, li2);
12887 li2->li_tv.v_type = VAR_STRING;
12888 li2->li_tv.v_lock = 0;
12889 li2->li_tv.vval.v_string = vim_strsave(di->di_key);
12891 li2 = listitem_alloc();
12892 if (li2 == NULL)
12893 break;
12894 list_append(l2, li2);
12895 copy_tv(&di->di_tv, &li2->li_tv);
12902 * "items(dict)" function
12904 static void
12905 f_items(argvars, rettv)
12906 typval_T *argvars;
12907 typval_T *rettv;
12909 dict_list(argvars, rettv, 2);
12913 * "join()" function
12915 static void
12916 f_join(argvars, rettv)
12917 typval_T *argvars;
12918 typval_T *rettv;
12920 garray_T ga;
12921 char_u *sep;
12923 if (argvars[0].v_type != VAR_LIST)
12925 EMSG(_(e_listreq));
12926 return;
12928 if (argvars[0].vval.v_list == NULL)
12929 return;
12930 if (argvars[1].v_type == VAR_UNKNOWN)
12931 sep = (char_u *)" ";
12932 else
12933 sep = get_tv_string_chk(&argvars[1]);
12935 rettv->v_type = VAR_STRING;
12937 if (sep != NULL)
12939 ga_init2(&ga, (int)sizeof(char), 80);
12940 list_join(&ga, argvars[0].vval.v_list, sep, TRUE, 0);
12941 ga_append(&ga, NUL);
12942 rettv->vval.v_string = (char_u *)ga.ga_data;
12944 else
12945 rettv->vval.v_string = NULL;
12949 * "keys()" function
12951 static void
12952 f_keys(argvars, rettv)
12953 typval_T *argvars;
12954 typval_T *rettv;
12956 dict_list(argvars, rettv, 0);
12960 * "last_buffer_nr()" function.
12962 static void
12963 f_last_buffer_nr(argvars, rettv)
12964 typval_T *argvars UNUSED;
12965 typval_T *rettv;
12967 int n = 0;
12968 buf_T *buf;
12970 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
12971 if (n < buf->b_fnum)
12972 n = buf->b_fnum;
12974 rettv->vval.v_number = n;
12978 * "len()" function
12980 static void
12981 f_len(argvars, rettv)
12982 typval_T *argvars;
12983 typval_T *rettv;
12985 switch (argvars[0].v_type)
12987 case VAR_STRING:
12988 case VAR_NUMBER:
12989 rettv->vval.v_number = (varnumber_T)STRLEN(
12990 get_tv_string(&argvars[0]));
12991 break;
12992 case VAR_LIST:
12993 rettv->vval.v_number = list_len(argvars[0].vval.v_list);
12994 break;
12995 case VAR_DICT:
12996 rettv->vval.v_number = dict_len(argvars[0].vval.v_dict);
12997 break;
12998 default:
12999 EMSG(_("E701: Invalid type for len()"));
13000 break;
13004 static void libcall_common __ARGS((typval_T *argvars, typval_T *rettv, int type));
13006 static void
13007 libcall_common(argvars, rettv, type)
13008 typval_T *argvars;
13009 typval_T *rettv;
13010 int type;
13012 #ifdef FEAT_LIBCALL
13013 char_u *string_in;
13014 char_u **string_result;
13015 int nr_result;
13016 #endif
13018 rettv->v_type = type;
13019 if (type != VAR_NUMBER)
13020 rettv->vval.v_string = NULL;
13022 if (check_restricted() || check_secure())
13023 return;
13025 #ifdef FEAT_LIBCALL
13026 /* The first two args must be strings, otherwise its meaningless */
13027 if (argvars[0].v_type == VAR_STRING && argvars[1].v_type == VAR_STRING)
13029 string_in = NULL;
13030 if (argvars[2].v_type == VAR_STRING)
13031 string_in = argvars[2].vval.v_string;
13032 if (type == VAR_NUMBER)
13033 string_result = NULL;
13034 else
13035 string_result = &rettv->vval.v_string;
13036 if (mch_libcall(argvars[0].vval.v_string,
13037 argvars[1].vval.v_string,
13038 string_in,
13039 argvars[2].vval.v_number,
13040 string_result,
13041 &nr_result) == OK
13042 && type == VAR_NUMBER)
13043 rettv->vval.v_number = nr_result;
13045 #endif
13049 * "libcall()" function
13051 static void
13052 f_libcall(argvars, rettv)
13053 typval_T *argvars;
13054 typval_T *rettv;
13056 libcall_common(argvars, rettv, VAR_STRING);
13060 * "libcallnr()" function
13062 static void
13063 f_libcallnr(argvars, rettv)
13064 typval_T *argvars;
13065 typval_T *rettv;
13067 libcall_common(argvars, rettv, VAR_NUMBER);
13071 * "line(string)" function
13073 static void
13074 f_line(argvars, rettv)
13075 typval_T *argvars;
13076 typval_T *rettv;
13078 linenr_T lnum = 0;
13079 pos_T *fp;
13080 int fnum;
13082 fp = var2fpos(&argvars[0], TRUE, &fnum);
13083 if (fp != NULL)
13084 lnum = fp->lnum;
13085 rettv->vval.v_number = lnum;
13089 * "line2byte(lnum)" function
13091 static void
13092 f_line2byte(argvars, rettv)
13093 typval_T *argvars UNUSED;
13094 typval_T *rettv;
13096 #ifndef FEAT_BYTEOFF
13097 rettv->vval.v_number = -1;
13098 #else
13099 linenr_T lnum;
13101 lnum = get_tv_lnum(argvars);
13102 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
13103 rettv->vval.v_number = -1;
13104 else
13105 rettv->vval.v_number = ml_find_line_or_offset(curbuf, lnum, NULL);
13106 if (rettv->vval.v_number >= 0)
13107 ++rettv->vval.v_number;
13108 #endif
13112 * "lispindent(lnum)" function
13114 static void
13115 f_lispindent(argvars, rettv)
13116 typval_T *argvars;
13117 typval_T *rettv;
13119 #ifdef FEAT_LISP
13120 pos_T pos;
13121 linenr_T lnum;
13123 pos = curwin->w_cursor;
13124 lnum = get_tv_lnum(argvars);
13125 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count)
13127 curwin->w_cursor.lnum = lnum;
13128 rettv->vval.v_number = get_lisp_indent();
13129 curwin->w_cursor = pos;
13131 else
13132 #endif
13133 rettv->vval.v_number = -1;
13137 * "localtime()" function
13139 static void
13140 f_localtime(argvars, rettv)
13141 typval_T *argvars UNUSED;
13142 typval_T *rettv;
13144 rettv->vval.v_number = (varnumber_T)time(NULL);
13147 static void get_maparg __ARGS((typval_T *argvars, typval_T *rettv, int exact));
13149 static void
13150 get_maparg(argvars, rettv, exact)
13151 typval_T *argvars;
13152 typval_T *rettv;
13153 int exact;
13155 char_u *keys;
13156 char_u *which;
13157 char_u buf[NUMBUFLEN];
13158 char_u *keys_buf = NULL;
13159 char_u *rhs;
13160 int mode;
13161 garray_T ga;
13162 int abbr = FALSE;
13164 /* return empty string for failure */
13165 rettv->v_type = VAR_STRING;
13166 rettv->vval.v_string = NULL;
13168 keys = get_tv_string(&argvars[0]);
13169 if (*keys == NUL)
13170 return;
13172 if (argvars[1].v_type != VAR_UNKNOWN)
13174 which = get_tv_string_buf_chk(&argvars[1], buf);
13175 if (argvars[2].v_type != VAR_UNKNOWN)
13176 abbr = get_tv_number(&argvars[2]);
13178 else
13179 which = (char_u *)"";
13180 if (which == NULL)
13181 return;
13183 mode = get_map_mode(&which, 0);
13185 keys = replace_termcodes(keys, &keys_buf, TRUE, TRUE, FALSE);
13186 rhs = check_map(keys, mode, exact, FALSE, abbr);
13187 vim_free(keys_buf);
13188 if (rhs != NULL)
13190 ga_init(&ga);
13191 ga.ga_itemsize = 1;
13192 ga.ga_growsize = 40;
13194 while (*rhs != NUL)
13195 ga_concat(&ga, str2special(&rhs, FALSE));
13197 ga_append(&ga, NUL);
13198 rettv->vval.v_string = (char_u *)ga.ga_data;
13202 #ifdef FEAT_FLOAT
13204 * "log10()" function
13206 static void
13207 f_log10(argvars, rettv)
13208 typval_T *argvars;
13209 typval_T *rettv;
13211 float_T f;
13213 rettv->v_type = VAR_FLOAT;
13214 if (get_float_arg(argvars, &f) == OK)
13215 rettv->vval.v_float = log10(f);
13216 else
13217 rettv->vval.v_float = 0.0;
13219 #endif
13222 * "map()" function
13224 static void
13225 f_map(argvars, rettv)
13226 typval_T *argvars;
13227 typval_T *rettv;
13229 filter_map(argvars, rettv, TRUE);
13233 * "maparg()" function
13235 static void
13236 f_maparg(argvars, rettv)
13237 typval_T *argvars;
13238 typval_T *rettv;
13240 get_maparg(argvars, rettv, TRUE);
13244 * "mapcheck()" function
13246 static void
13247 f_mapcheck(argvars, rettv)
13248 typval_T *argvars;
13249 typval_T *rettv;
13251 get_maparg(argvars, rettv, FALSE);
13254 static void find_some_match __ARGS((typval_T *argvars, typval_T *rettv, int start));
13256 static void
13257 find_some_match(argvars, rettv, type)
13258 typval_T *argvars;
13259 typval_T *rettv;
13260 int type;
13262 char_u *str = NULL;
13263 char_u *expr = NULL;
13264 char_u *pat;
13265 regmatch_T regmatch;
13266 char_u patbuf[NUMBUFLEN];
13267 char_u strbuf[NUMBUFLEN];
13268 char_u *save_cpo;
13269 long start = 0;
13270 long nth = 1;
13271 colnr_T startcol = 0;
13272 int match = 0;
13273 list_T *l = NULL;
13274 listitem_T *li = NULL;
13275 long idx = 0;
13276 char_u *tofree = NULL;
13278 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
13279 save_cpo = p_cpo;
13280 p_cpo = (char_u *)"";
13282 rettv->vval.v_number = -1;
13283 if (type == 3)
13285 /* return empty list when there are no matches */
13286 if (rettv_list_alloc(rettv) == FAIL)
13287 goto theend;
13289 else if (type == 2)
13291 rettv->v_type = VAR_STRING;
13292 rettv->vval.v_string = NULL;
13295 if (argvars[0].v_type == VAR_LIST)
13297 if ((l = argvars[0].vval.v_list) == NULL)
13298 goto theend;
13299 li = l->lv_first;
13301 else
13302 expr = str = get_tv_string(&argvars[0]);
13304 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
13305 if (pat == NULL)
13306 goto theend;
13308 if (argvars[2].v_type != VAR_UNKNOWN)
13310 int error = FALSE;
13312 start = get_tv_number_chk(&argvars[2], &error);
13313 if (error)
13314 goto theend;
13315 if (l != NULL)
13317 li = list_find(l, start);
13318 if (li == NULL)
13319 goto theend;
13320 idx = l->lv_idx; /* use the cached index */
13322 else
13324 if (start < 0)
13325 start = 0;
13326 if (start > (long)STRLEN(str))
13327 goto theend;
13328 /* When "count" argument is there ignore matches before "start",
13329 * otherwise skip part of the string. Differs when pattern is "^"
13330 * or "\<". */
13331 if (argvars[3].v_type != VAR_UNKNOWN)
13332 startcol = start;
13333 else
13334 str += start;
13337 if (argvars[3].v_type != VAR_UNKNOWN)
13338 nth = get_tv_number_chk(&argvars[3], &error);
13339 if (error)
13340 goto theend;
13343 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
13344 if (regmatch.regprog != NULL)
13346 regmatch.rm_ic = p_ic;
13348 for (;;)
13350 if (l != NULL)
13352 if (li == NULL)
13354 match = FALSE;
13355 break;
13357 vim_free(tofree);
13358 str = echo_string(&li->li_tv, &tofree, strbuf, 0);
13359 if (str == NULL)
13360 break;
13363 match = vim_regexec_nl(&regmatch, str, (colnr_T)startcol);
13365 if (match && --nth <= 0)
13366 break;
13367 if (l == NULL && !match)
13368 break;
13370 /* Advance to just after the match. */
13371 if (l != NULL)
13373 li = li->li_next;
13374 ++idx;
13376 else
13378 #ifdef FEAT_MBYTE
13379 startcol = (colnr_T)(regmatch.startp[0]
13380 + (*mb_ptr2len)(regmatch.startp[0]) - str);
13381 #else
13382 startcol = regmatch.startp[0] + 1 - str;
13383 #endif
13387 if (match)
13389 if (type == 3)
13391 int i;
13393 /* return list with matched string and submatches */
13394 for (i = 0; i < NSUBEXP; ++i)
13396 if (regmatch.endp[i] == NULL)
13398 if (list_append_string(rettv->vval.v_list,
13399 (char_u *)"", 0) == FAIL)
13400 break;
13402 else if (list_append_string(rettv->vval.v_list,
13403 regmatch.startp[i],
13404 (int)(regmatch.endp[i] - regmatch.startp[i]))
13405 == FAIL)
13406 break;
13409 else if (type == 2)
13411 /* return matched string */
13412 if (l != NULL)
13413 copy_tv(&li->li_tv, rettv);
13414 else
13415 rettv->vval.v_string = vim_strnsave(regmatch.startp[0],
13416 (int)(regmatch.endp[0] - regmatch.startp[0]));
13418 else if (l != NULL)
13419 rettv->vval.v_number = idx;
13420 else
13422 if (type != 0)
13423 rettv->vval.v_number =
13424 (varnumber_T)(regmatch.startp[0] - str);
13425 else
13426 rettv->vval.v_number =
13427 (varnumber_T)(regmatch.endp[0] - str);
13428 rettv->vval.v_number += (varnumber_T)(str - expr);
13431 vim_free(regmatch.regprog);
13434 theend:
13435 vim_free(tofree);
13436 p_cpo = save_cpo;
13440 * "match()" function
13442 static void
13443 f_match(argvars, rettv)
13444 typval_T *argvars;
13445 typval_T *rettv;
13447 find_some_match(argvars, rettv, 1);
13451 * "matchadd()" function
13453 static void
13454 f_matchadd(argvars, rettv)
13455 typval_T *argvars;
13456 typval_T *rettv;
13458 #ifdef FEAT_SEARCH_EXTRA
13459 char_u buf[NUMBUFLEN];
13460 char_u *grp = get_tv_string_buf_chk(&argvars[0], buf); /* group */
13461 char_u *pat = get_tv_string_buf_chk(&argvars[1], buf); /* pattern */
13462 int prio = 10; /* default priority */
13463 int id = -1;
13464 int error = FALSE;
13466 rettv->vval.v_number = -1;
13468 if (grp == NULL || pat == NULL)
13469 return;
13470 if (argvars[2].v_type != VAR_UNKNOWN)
13472 prio = get_tv_number_chk(&argvars[2], &error);
13473 if (argvars[3].v_type != VAR_UNKNOWN)
13474 id = get_tv_number_chk(&argvars[3], &error);
13476 if (error == TRUE)
13477 return;
13478 if (id >= 1 && id <= 3)
13480 EMSGN("E798: ID is reserved for \":match\": %ld", id);
13481 return;
13484 rettv->vval.v_number = match_add(curwin, grp, pat, prio, id);
13485 #endif
13489 * "matcharg()" function
13491 static void
13492 f_matcharg(argvars, rettv)
13493 typval_T *argvars;
13494 typval_T *rettv;
13496 if (rettv_list_alloc(rettv) == OK)
13498 #ifdef FEAT_SEARCH_EXTRA
13499 int id = get_tv_number(&argvars[0]);
13500 matchitem_T *m;
13502 if (id >= 1 && id <= 3)
13504 if ((m = (matchitem_T *)get_match(curwin, id)) != NULL)
13506 list_append_string(rettv->vval.v_list,
13507 syn_id2name(m->hlg_id), -1);
13508 list_append_string(rettv->vval.v_list, m->pattern, -1);
13510 else
13512 list_append_string(rettv->vval.v_list, NUL, -1);
13513 list_append_string(rettv->vval.v_list, NUL, -1);
13516 #endif
13521 * "matchdelete()" function
13523 static void
13524 f_matchdelete(argvars, rettv)
13525 typval_T *argvars;
13526 typval_T *rettv;
13528 #ifdef FEAT_SEARCH_EXTRA
13529 rettv->vval.v_number = match_delete(curwin,
13530 (int)get_tv_number(&argvars[0]), TRUE);
13531 #endif
13535 * "matchend()" function
13537 static void
13538 f_matchend(argvars, rettv)
13539 typval_T *argvars;
13540 typval_T *rettv;
13542 find_some_match(argvars, rettv, 0);
13546 * "matchlist()" function
13548 static void
13549 f_matchlist(argvars, rettv)
13550 typval_T *argvars;
13551 typval_T *rettv;
13553 find_some_match(argvars, rettv, 3);
13557 * "matchstr()" function
13559 static void
13560 f_matchstr(argvars, rettv)
13561 typval_T *argvars;
13562 typval_T *rettv;
13564 find_some_match(argvars, rettv, 2);
13567 static void max_min __ARGS((typval_T *argvars, typval_T *rettv, int domax));
13569 static void
13570 max_min(argvars, rettv, domax)
13571 typval_T *argvars;
13572 typval_T *rettv;
13573 int domax;
13575 long n = 0;
13576 long i;
13577 int error = FALSE;
13579 if (argvars[0].v_type == VAR_LIST)
13581 list_T *l;
13582 listitem_T *li;
13584 l = argvars[0].vval.v_list;
13585 if (l != NULL)
13587 li = l->lv_first;
13588 if (li != NULL)
13590 n = get_tv_number_chk(&li->li_tv, &error);
13591 for (;;)
13593 li = li->li_next;
13594 if (li == NULL)
13595 break;
13596 i = get_tv_number_chk(&li->li_tv, &error);
13597 if (domax ? i > n : i < n)
13598 n = i;
13603 else if (argvars[0].v_type == VAR_DICT)
13605 dict_T *d;
13606 int first = TRUE;
13607 hashitem_T *hi;
13608 int todo;
13610 d = argvars[0].vval.v_dict;
13611 if (d != NULL)
13613 todo = (int)d->dv_hashtab.ht_used;
13614 for (hi = d->dv_hashtab.ht_array; todo > 0; ++hi)
13616 if (!HASHITEM_EMPTY(hi))
13618 --todo;
13619 i = get_tv_number_chk(&HI2DI(hi)->di_tv, &error);
13620 if (first)
13622 n = i;
13623 first = FALSE;
13625 else if (domax ? i > n : i < n)
13626 n = i;
13631 else
13632 EMSG(_(e_listdictarg));
13633 rettv->vval.v_number = error ? 0 : n;
13637 * "max()" function
13639 static void
13640 f_max(argvars, rettv)
13641 typval_T *argvars;
13642 typval_T *rettv;
13644 max_min(argvars, rettv, TRUE);
13648 * "min()" function
13650 static void
13651 f_min(argvars, rettv)
13652 typval_T *argvars;
13653 typval_T *rettv;
13655 max_min(argvars, rettv, FALSE);
13658 static int mkdir_recurse __ARGS((char_u *dir, int prot));
13661 * Create the directory in which "dir" is located, and higher levels when
13662 * needed.
13664 static int
13665 mkdir_recurse(dir, prot)
13666 char_u *dir;
13667 int prot;
13669 char_u *p;
13670 char_u *updir;
13671 int r = FAIL;
13673 /* Get end of directory name in "dir".
13674 * We're done when it's "/" or "c:/". */
13675 p = gettail_sep(dir);
13676 if (p <= get_past_head(dir))
13677 return OK;
13679 /* If the directory exists we're done. Otherwise: create it.*/
13680 updir = vim_strnsave(dir, (int)(p - dir));
13681 if (updir == NULL)
13682 return FAIL;
13683 if (mch_isdir(updir))
13684 r = OK;
13685 else if (mkdir_recurse(updir, prot) == OK)
13686 r = vim_mkdir_emsg(updir, prot);
13687 vim_free(updir);
13688 return r;
13691 #ifdef vim_mkdir
13693 * "mkdir()" function
13695 static void
13696 f_mkdir(argvars, rettv)
13697 typval_T *argvars;
13698 typval_T *rettv;
13700 char_u *dir;
13701 char_u buf[NUMBUFLEN];
13702 int prot = 0755;
13704 rettv->vval.v_number = FAIL;
13705 if (check_restricted() || check_secure())
13706 return;
13708 dir = get_tv_string_buf(&argvars[0], buf);
13709 if (argvars[1].v_type != VAR_UNKNOWN)
13711 if (argvars[2].v_type != VAR_UNKNOWN)
13712 prot = get_tv_number_chk(&argvars[2], NULL);
13713 if (prot != -1 && STRCMP(get_tv_string(&argvars[1]), "p") == 0)
13714 mkdir_recurse(dir, prot);
13716 rettv->vval.v_number = prot != -1 ? vim_mkdir_emsg(dir, prot) : 0;
13718 #endif
13721 * "mode()" function
13723 static void
13724 f_mode(argvars, rettv)
13725 typval_T *argvars;
13726 typval_T *rettv;
13728 char_u buf[3];
13730 buf[1] = NUL;
13731 buf[2] = NUL;
13733 #ifdef FEAT_VISUAL
13734 if (VIsual_active)
13736 if (VIsual_select)
13737 buf[0] = VIsual_mode + 's' - 'v';
13738 else
13739 buf[0] = VIsual_mode;
13741 else
13742 #endif
13743 if (State == HITRETURN || State == ASKMORE || State == SETWSIZE
13744 || State == CONFIRM)
13746 buf[0] = 'r';
13747 if (State == ASKMORE)
13748 buf[1] = 'm';
13749 else if (State == CONFIRM)
13750 buf[1] = '?';
13752 else if (State == EXTERNCMD)
13753 buf[0] = '!';
13754 else if (State & INSERT)
13756 #ifdef FEAT_VREPLACE
13757 if (State & VREPLACE_FLAG)
13759 buf[0] = 'R';
13760 buf[1] = 'v';
13762 else
13763 #endif
13764 if (State & REPLACE_FLAG)
13765 buf[0] = 'R';
13766 else
13767 buf[0] = 'i';
13769 else if (State & CMDLINE)
13771 buf[0] = 'c';
13772 if (exmode_active)
13773 buf[1] = 'v';
13775 else if (exmode_active)
13777 buf[0] = 'c';
13778 buf[1] = 'e';
13780 else
13782 buf[0] = 'n';
13783 if (finish_op)
13784 buf[1] = 'o';
13787 /* Clear out the minor mode when the argument is not a non-zero number or
13788 * non-empty string. */
13789 if (!non_zero_arg(&argvars[0]))
13790 buf[1] = NUL;
13792 rettv->vval.v_string = vim_strsave(buf);
13793 rettv->v_type = VAR_STRING;
13797 * "nextnonblank()" function
13799 static void
13800 f_nextnonblank(argvars, rettv)
13801 typval_T *argvars;
13802 typval_T *rettv;
13804 linenr_T lnum;
13806 for (lnum = get_tv_lnum(argvars); ; ++lnum)
13808 if (lnum < 0 || lnum > curbuf->b_ml.ml_line_count)
13810 lnum = 0;
13811 break;
13813 if (*skipwhite(ml_get(lnum)) != NUL)
13814 break;
13816 rettv->vval.v_number = lnum;
13820 * "nr2char()" function
13822 static void
13823 f_nr2char(argvars, rettv)
13824 typval_T *argvars;
13825 typval_T *rettv;
13827 char_u buf[NUMBUFLEN];
13829 #ifdef FEAT_MBYTE
13830 if (has_mbyte)
13831 buf[(*mb_char2bytes)((int)get_tv_number(&argvars[0]), buf)] = NUL;
13832 else
13833 #endif
13835 buf[0] = (char_u)get_tv_number(&argvars[0]);
13836 buf[1] = NUL;
13838 rettv->v_type = VAR_STRING;
13839 rettv->vval.v_string = vim_strsave(buf);
13843 * "pathshorten()" function
13845 static void
13846 f_pathshorten(argvars, rettv)
13847 typval_T *argvars;
13848 typval_T *rettv;
13850 char_u *p;
13852 rettv->v_type = VAR_STRING;
13853 p = get_tv_string_chk(&argvars[0]);
13854 if (p == NULL)
13855 rettv->vval.v_string = NULL;
13856 else
13858 p = vim_strsave(p);
13859 rettv->vval.v_string = p;
13860 if (p != NULL)
13861 shorten_dir(p);
13865 #ifdef FEAT_FLOAT
13867 * "pow()" function
13869 static void
13870 f_pow(argvars, rettv)
13871 typval_T *argvars;
13872 typval_T *rettv;
13874 float_T fx, fy;
13876 rettv->v_type = VAR_FLOAT;
13877 if (get_float_arg(argvars, &fx) == OK
13878 && get_float_arg(&argvars[1], &fy) == OK)
13879 rettv->vval.v_float = pow(fx, fy);
13880 else
13881 rettv->vval.v_float = 0.0;
13883 #endif
13886 * "prevnonblank()" function
13888 static void
13889 f_prevnonblank(argvars, rettv)
13890 typval_T *argvars;
13891 typval_T *rettv;
13893 linenr_T lnum;
13895 lnum = get_tv_lnum(argvars);
13896 if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
13897 lnum = 0;
13898 else
13899 while (lnum >= 1 && *skipwhite(ml_get(lnum)) == NUL)
13900 --lnum;
13901 rettv->vval.v_number = lnum;
13904 #ifdef HAVE_STDARG_H
13905 /* This dummy va_list is here because:
13906 * - passing a NULL pointer doesn't work when va_list isn't a pointer
13907 * - locally in the function results in a "used before set" warning
13908 * - using va_start() to initialize it gives "function with fixed args" error */
13909 static va_list ap;
13910 #endif
13913 * "printf()" function
13915 static void
13916 f_printf(argvars, rettv)
13917 typval_T *argvars;
13918 typval_T *rettv;
13920 rettv->v_type = VAR_STRING;
13921 rettv->vval.v_string = NULL;
13922 #ifdef HAVE_STDARG_H /* only very old compilers can't do this */
13924 char_u buf[NUMBUFLEN];
13925 int len;
13926 char_u *s;
13927 int saved_did_emsg = did_emsg;
13928 char *fmt;
13930 /* Get the required length, allocate the buffer and do it for real. */
13931 did_emsg = FALSE;
13932 fmt = (char *)get_tv_string_buf(&argvars[0], buf);
13933 len = vim_vsnprintf(NULL, 0, fmt, ap, argvars + 1);
13934 if (!did_emsg)
13936 s = alloc(len + 1);
13937 if (s != NULL)
13939 rettv->vval.v_string = s;
13940 (void)vim_vsnprintf((char *)s, len + 1, fmt, ap, argvars + 1);
13943 did_emsg |= saved_did_emsg;
13945 #endif
13949 * "pumvisible()" function
13951 static void
13952 f_pumvisible(argvars, rettv)
13953 typval_T *argvars UNUSED;
13954 typval_T *rettv UNUSED;
13956 #ifdef FEAT_INS_EXPAND
13957 if (pum_visible())
13958 rettv->vval.v_number = 1;
13959 #endif
13963 * "range()" function
13965 static void
13966 f_range(argvars, rettv)
13967 typval_T *argvars;
13968 typval_T *rettv;
13970 long start;
13971 long end;
13972 long stride = 1;
13973 long i;
13974 int error = FALSE;
13976 start = get_tv_number_chk(&argvars[0], &error);
13977 if (argvars[1].v_type == VAR_UNKNOWN)
13979 end = start - 1;
13980 start = 0;
13982 else
13984 end = get_tv_number_chk(&argvars[1], &error);
13985 if (argvars[2].v_type != VAR_UNKNOWN)
13986 stride = get_tv_number_chk(&argvars[2], &error);
13989 if (error)
13990 return; /* type error; errmsg already given */
13991 if (stride == 0)
13992 EMSG(_("E726: Stride is zero"));
13993 else if (stride > 0 ? end + 1 < start : end - 1 > start)
13994 EMSG(_("E727: Start past end"));
13995 else
13997 if (rettv_list_alloc(rettv) == OK)
13998 for (i = start; stride > 0 ? i <= end : i >= end; i += stride)
13999 if (list_append_number(rettv->vval.v_list,
14000 (varnumber_T)i) == FAIL)
14001 break;
14006 * "readfile()" function
14008 static void
14009 f_readfile(argvars, rettv)
14010 typval_T *argvars;
14011 typval_T *rettv;
14013 int binary = FALSE;
14014 char_u *fname;
14015 FILE *fd;
14016 listitem_T *li;
14017 #define FREAD_SIZE 200 /* optimized for text lines */
14018 char_u buf[FREAD_SIZE];
14019 int readlen; /* size of last fread() */
14020 int buflen; /* nr of valid chars in buf[] */
14021 int filtd; /* how much in buf[] was NUL -> '\n' filtered */
14022 int tolist; /* first byte in buf[] still to be put in list */
14023 int chop; /* how many CR to chop off */
14024 char_u *prev = NULL; /* previously read bytes, if any */
14025 int prevlen = 0; /* length of "prev" if not NULL */
14026 char_u *s;
14027 int len;
14028 long maxline = MAXLNUM;
14029 long cnt = 0;
14031 if (argvars[1].v_type != VAR_UNKNOWN)
14033 if (STRCMP(get_tv_string(&argvars[1]), "b") == 0)
14034 binary = TRUE;
14035 if (argvars[2].v_type != VAR_UNKNOWN)
14036 maxline = get_tv_number(&argvars[2]);
14039 if (rettv_list_alloc(rettv) == FAIL)
14040 return;
14042 /* Always open the file in binary mode, library functions have a mind of
14043 * their own about CR-LF conversion. */
14044 fname = get_tv_string(&argvars[0]);
14045 if (*fname == NUL || (fd = mch_fopen((char *)fname, READBIN)) == NULL)
14047 EMSG2(_(e_notopen), *fname == NUL ? (char_u *)_("<empty>") : fname);
14048 return;
14051 filtd = 0;
14052 while (cnt < maxline || maxline < 0)
14054 readlen = (int)fread(buf + filtd, 1, FREAD_SIZE - filtd, fd);
14055 buflen = filtd + readlen;
14056 tolist = 0;
14057 for ( ; filtd < buflen || readlen <= 0; ++filtd)
14059 if (buf[filtd] == '\n' || readlen <= 0)
14061 /* Only when in binary mode add an empty list item when the
14062 * last line ends in a '\n'. */
14063 if (!binary && readlen == 0 && filtd == 0)
14064 break;
14066 /* Found end-of-line or end-of-file: add a text line to the
14067 * list. */
14068 chop = 0;
14069 if (!binary)
14070 while (filtd - chop - 1 >= tolist
14071 && buf[filtd - chop - 1] == '\r')
14072 ++chop;
14073 len = filtd - tolist - chop;
14074 if (prev == NULL)
14075 s = vim_strnsave(buf + tolist, len);
14076 else
14078 s = alloc((unsigned)(prevlen + len + 1));
14079 if (s != NULL)
14081 mch_memmove(s, prev, prevlen);
14082 vim_free(prev);
14083 prev = NULL;
14084 mch_memmove(s + prevlen, buf + tolist, len);
14085 s[prevlen + len] = NUL;
14088 tolist = filtd + 1;
14090 li = listitem_alloc();
14091 if (li == NULL)
14093 vim_free(s);
14094 break;
14096 li->li_tv.v_type = VAR_STRING;
14097 li->li_tv.v_lock = 0;
14098 li->li_tv.vval.v_string = s;
14099 list_append(rettv->vval.v_list, li);
14101 if (++cnt >= maxline && maxline >= 0)
14102 break;
14103 if (readlen <= 0)
14104 break;
14106 else if (buf[filtd] == NUL)
14107 buf[filtd] = '\n';
14109 if (readlen <= 0)
14110 break;
14112 if (tolist == 0)
14114 /* "buf" is full, need to move text to an allocated buffer */
14115 if (prev == NULL)
14117 prev = vim_strnsave(buf, buflen);
14118 prevlen = buflen;
14120 else
14122 s = alloc((unsigned)(prevlen + buflen));
14123 if (s != NULL)
14125 mch_memmove(s, prev, prevlen);
14126 mch_memmove(s + prevlen, buf, buflen);
14127 vim_free(prev);
14128 prev = s;
14129 prevlen += buflen;
14132 filtd = 0;
14134 else
14136 mch_memmove(buf, buf + tolist, buflen - tolist);
14137 filtd -= tolist;
14142 * For a negative line count use only the lines at the end of the file,
14143 * free the rest.
14145 if (maxline < 0)
14146 while (cnt > -maxline)
14148 listitem_remove(rettv->vval.v_list, rettv->vval.v_list->lv_first);
14149 --cnt;
14152 vim_free(prev);
14153 fclose(fd);
14156 #if defined(FEAT_RELTIME)
14157 static int list2proftime __ARGS((typval_T *arg, proftime_T *tm));
14160 * Convert a List to proftime_T.
14161 * Return FAIL when there is something wrong.
14163 static int
14164 list2proftime(arg, tm)
14165 typval_T *arg;
14166 proftime_T *tm;
14168 long n1, n2;
14169 int error = FALSE;
14171 if (arg->v_type != VAR_LIST || arg->vval.v_list == NULL
14172 || arg->vval.v_list->lv_len != 2)
14173 return FAIL;
14174 n1 = list_find_nr(arg->vval.v_list, 0L, &error);
14175 n2 = list_find_nr(arg->vval.v_list, 1L, &error);
14176 # ifdef WIN3264
14177 tm->HighPart = n1;
14178 tm->LowPart = n2;
14179 # else
14180 tm->tv_sec = n1;
14181 tm->tv_usec = n2;
14182 # endif
14183 return error ? FAIL : OK;
14185 #endif /* FEAT_RELTIME */
14188 * "reltime()" function
14190 static void
14191 f_reltime(argvars, rettv)
14192 typval_T *argvars;
14193 typval_T *rettv;
14195 #ifdef FEAT_RELTIME
14196 proftime_T res;
14197 proftime_T start;
14199 if (argvars[0].v_type == VAR_UNKNOWN)
14201 /* No arguments: get current time. */
14202 profile_start(&res);
14204 else if (argvars[1].v_type == VAR_UNKNOWN)
14206 if (list2proftime(&argvars[0], &res) == FAIL)
14207 return;
14208 profile_end(&res);
14210 else
14212 /* Two arguments: compute the difference. */
14213 if (list2proftime(&argvars[0], &start) == FAIL
14214 || list2proftime(&argvars[1], &res) == FAIL)
14215 return;
14216 profile_sub(&res, &start);
14219 if (rettv_list_alloc(rettv) == OK)
14221 long n1, n2;
14223 # ifdef WIN3264
14224 n1 = res.HighPart;
14225 n2 = res.LowPart;
14226 # else
14227 n1 = res.tv_sec;
14228 n2 = res.tv_usec;
14229 # endif
14230 list_append_number(rettv->vval.v_list, (varnumber_T)n1);
14231 list_append_number(rettv->vval.v_list, (varnumber_T)n2);
14233 #endif
14237 * "reltimestr()" function
14239 static void
14240 f_reltimestr(argvars, rettv)
14241 typval_T *argvars;
14242 typval_T *rettv;
14244 #ifdef FEAT_RELTIME
14245 proftime_T tm;
14246 #endif
14248 rettv->v_type = VAR_STRING;
14249 rettv->vval.v_string = NULL;
14250 #ifdef FEAT_RELTIME
14251 if (list2proftime(&argvars[0], &tm) == OK)
14252 rettv->vval.v_string = vim_strsave((char_u *)profile_msg(&tm));
14253 #endif
14256 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
14257 static void make_connection __ARGS((void));
14258 static int check_connection __ARGS((void));
14260 static void
14261 make_connection()
14263 if (X_DISPLAY == NULL
14264 # ifdef FEAT_GUI
14265 && !gui.in_use
14266 # endif
14269 x_force_connect = TRUE;
14270 setup_term_clip();
14271 x_force_connect = FALSE;
14275 static int
14276 check_connection()
14278 make_connection();
14279 if (X_DISPLAY == NULL)
14281 EMSG(_("E240: No connection to Vim server"));
14282 return FAIL;
14284 return OK;
14286 #endif
14288 #ifdef FEAT_CLIENTSERVER
14289 static void remote_common __ARGS((typval_T *argvars, typval_T *rettv, int expr));
14291 static void
14292 remote_common(argvars, rettv, expr)
14293 typval_T *argvars;
14294 typval_T *rettv;
14295 int expr;
14297 char_u *server_name;
14298 char_u *keys;
14299 char_u *r = NULL;
14300 char_u buf[NUMBUFLEN];
14301 # ifdef WIN32
14302 HWND w;
14303 # else
14304 Window w;
14305 # endif
14307 if (check_restricted() || check_secure())
14308 return;
14310 # ifdef FEAT_X11
14311 if (check_connection() == FAIL)
14312 return;
14313 # endif
14315 server_name = get_tv_string_chk(&argvars[0]);
14316 if (server_name == NULL)
14317 return; /* type error; errmsg already given */
14318 keys = get_tv_string_buf(&argvars[1], buf);
14319 # ifdef WIN32
14320 if (serverSendToVim(server_name, keys, &r, &w, expr, TRUE) < 0)
14321 # else
14322 if (serverSendToVim(X_DISPLAY, server_name, keys, &r, &w, expr, 0, TRUE)
14323 < 0)
14324 # endif
14326 if (r != NULL)
14327 EMSG(r); /* sending worked but evaluation failed */
14328 else
14329 EMSG2(_("E241: Unable to send to %s"), server_name);
14330 return;
14333 rettv->vval.v_string = r;
14335 if (argvars[2].v_type != VAR_UNKNOWN)
14337 dictitem_T v;
14338 char_u str[30];
14339 char_u *idvar;
14341 sprintf((char *)str, PRINTF_HEX_LONG_U, (long_u)w);
14342 v.di_tv.v_type = VAR_STRING;
14343 v.di_tv.vval.v_string = vim_strsave(str);
14344 idvar = get_tv_string_chk(&argvars[2]);
14345 if (idvar != NULL)
14346 set_var(idvar, &v.di_tv, FALSE);
14347 vim_free(v.di_tv.vval.v_string);
14350 #endif
14353 * "remote_expr()" function
14355 static void
14356 f_remote_expr(argvars, rettv)
14357 typval_T *argvars UNUSED;
14358 typval_T *rettv;
14360 rettv->v_type = VAR_STRING;
14361 rettv->vval.v_string = NULL;
14362 #ifdef FEAT_CLIENTSERVER
14363 remote_common(argvars, rettv, TRUE);
14364 #endif
14368 * "remote_foreground()" function
14370 static void
14371 f_remote_foreground(argvars, rettv)
14372 typval_T *argvars UNUSED;
14373 typval_T *rettv UNUSED;
14375 #ifdef FEAT_CLIENTSERVER
14376 # ifdef WIN32
14377 /* On Win32 it's done in this application. */
14379 char_u *server_name = get_tv_string_chk(&argvars[0]);
14381 if (server_name != NULL)
14382 serverForeground(server_name);
14384 # else
14385 /* Send a foreground() expression to the server. */
14386 argvars[1].v_type = VAR_STRING;
14387 argvars[1].vval.v_string = vim_strsave((char_u *)"foreground()");
14388 argvars[2].v_type = VAR_UNKNOWN;
14389 remote_common(argvars, rettv, TRUE);
14390 vim_free(argvars[1].vval.v_string);
14391 # endif
14392 #endif
14395 static void
14396 f_remote_peek(argvars, rettv)
14397 typval_T *argvars UNUSED;
14398 typval_T *rettv;
14400 #ifdef FEAT_CLIENTSERVER
14401 dictitem_T v;
14402 char_u *s = NULL;
14403 # ifdef WIN32
14404 long_u n = 0;
14405 # endif
14406 char_u *serverid;
14408 if (check_restricted() || check_secure())
14410 rettv->vval.v_number = -1;
14411 return;
14413 serverid = get_tv_string_chk(&argvars[0]);
14414 if (serverid == NULL)
14416 rettv->vval.v_number = -1;
14417 return; /* type error; errmsg already given */
14419 # ifdef WIN32
14420 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14421 if (n == 0)
14422 rettv->vval.v_number = -1;
14423 else
14425 s = serverGetReply((HWND)n, FALSE, FALSE, FALSE);
14426 rettv->vval.v_number = (s != NULL);
14428 # else
14429 if (check_connection() == FAIL)
14430 return;
14432 rettv->vval.v_number = serverPeekReply(X_DISPLAY,
14433 serverStrToWin(serverid), &s);
14434 # endif
14436 if (argvars[1].v_type != VAR_UNKNOWN && rettv->vval.v_number > 0)
14438 char_u *retvar;
14440 v.di_tv.v_type = VAR_STRING;
14441 v.di_tv.vval.v_string = vim_strsave(s);
14442 retvar = get_tv_string_chk(&argvars[1]);
14443 if (retvar != NULL)
14444 set_var(retvar, &v.di_tv, FALSE);
14445 vim_free(v.di_tv.vval.v_string);
14447 #else
14448 rettv->vval.v_number = -1;
14449 #endif
14452 static void
14453 f_remote_read(argvars, rettv)
14454 typval_T *argvars UNUSED;
14455 typval_T *rettv;
14457 char_u *r = NULL;
14459 #ifdef FEAT_CLIENTSERVER
14460 char_u *serverid = get_tv_string_chk(&argvars[0]);
14462 if (serverid != NULL && !check_restricted() && !check_secure())
14464 # ifdef WIN32
14465 /* The server's HWND is encoded in the 'id' parameter */
14466 long_u n = 0;
14468 sscanf(serverid, SCANF_HEX_LONG_U, &n);
14469 if (n != 0)
14470 r = serverGetReply((HWND)n, FALSE, TRUE, TRUE);
14471 if (r == NULL)
14472 # else
14473 if (check_connection() == FAIL || serverReadReply(X_DISPLAY,
14474 serverStrToWin(serverid), &r, FALSE) < 0)
14475 # endif
14476 EMSG(_("E277: Unable to read a server reply"));
14478 #endif
14479 rettv->v_type = VAR_STRING;
14480 rettv->vval.v_string = r;
14484 * "remote_send()" function
14486 static void
14487 f_remote_send(argvars, rettv)
14488 typval_T *argvars UNUSED;
14489 typval_T *rettv;
14491 rettv->v_type = VAR_STRING;
14492 rettv->vval.v_string = NULL;
14493 #ifdef FEAT_CLIENTSERVER
14494 remote_common(argvars, rettv, FALSE);
14495 #endif
14499 * "remove()" function
14501 static void
14502 f_remove(argvars, rettv)
14503 typval_T *argvars;
14504 typval_T *rettv;
14506 list_T *l;
14507 listitem_T *item, *item2;
14508 listitem_T *li;
14509 long idx;
14510 long end;
14511 char_u *key;
14512 dict_T *d;
14513 dictitem_T *di;
14515 if (argvars[0].v_type == VAR_DICT)
14517 if (argvars[2].v_type != VAR_UNKNOWN)
14518 EMSG2(_(e_toomanyarg), "remove()");
14519 else if ((d = argvars[0].vval.v_dict) != NULL
14520 && !tv_check_lock(d->dv_lock, (char_u *)"remove() argument"))
14522 key = get_tv_string_chk(&argvars[1]);
14523 if (key != NULL)
14525 di = dict_find(d, key, -1);
14526 if (di == NULL)
14527 EMSG2(_(e_dictkey), key);
14528 else
14530 *rettv = di->di_tv;
14531 init_tv(&di->di_tv);
14532 dictitem_remove(d, di);
14537 else if (argvars[0].v_type != VAR_LIST)
14538 EMSG2(_(e_listdictarg), "remove()");
14539 else if ((l = argvars[0].vval.v_list) != NULL
14540 && !tv_check_lock(l->lv_lock, (char_u *)"remove() argument"))
14542 int error = FALSE;
14544 idx = get_tv_number_chk(&argvars[1], &error);
14545 if (error)
14546 ; /* type error: do nothing, errmsg already given */
14547 else if ((item = list_find(l, idx)) == NULL)
14548 EMSGN(_(e_listidx), idx);
14549 else
14551 if (argvars[2].v_type == VAR_UNKNOWN)
14553 /* Remove one item, return its value. */
14554 list_remove(l, item, item);
14555 *rettv = item->li_tv;
14556 vim_free(item);
14558 else
14560 /* Remove range of items, return list with values. */
14561 end = get_tv_number_chk(&argvars[2], &error);
14562 if (error)
14563 ; /* type error: do nothing */
14564 else if ((item2 = list_find(l, end)) == NULL)
14565 EMSGN(_(e_listidx), end);
14566 else
14568 int cnt = 0;
14570 for (li = item; li != NULL; li = li->li_next)
14572 ++cnt;
14573 if (li == item2)
14574 break;
14576 if (li == NULL) /* didn't find "item2" after "item" */
14577 EMSG(_(e_invrange));
14578 else
14580 list_remove(l, item, item2);
14581 if (rettv_list_alloc(rettv) == OK)
14583 l = rettv->vval.v_list;
14584 l->lv_first = item;
14585 l->lv_last = item2;
14586 item->li_prev = NULL;
14587 item2->li_next = NULL;
14588 l->lv_len = cnt;
14598 * "rename({from}, {to})" function
14600 static void
14601 f_rename(argvars, rettv)
14602 typval_T *argvars;
14603 typval_T *rettv;
14605 char_u buf[NUMBUFLEN];
14607 if (check_restricted() || check_secure())
14608 rettv->vval.v_number = -1;
14609 else
14610 rettv->vval.v_number = vim_rename(get_tv_string(&argvars[0]),
14611 get_tv_string_buf(&argvars[1], buf));
14615 * "repeat()" function
14617 static void
14618 f_repeat(argvars, rettv)
14619 typval_T *argvars;
14620 typval_T *rettv;
14622 char_u *p;
14623 int n;
14624 int slen;
14625 int len;
14626 char_u *r;
14627 int i;
14629 n = get_tv_number(&argvars[1]);
14630 if (argvars[0].v_type == VAR_LIST)
14632 if (rettv_list_alloc(rettv) == OK && argvars[0].vval.v_list != NULL)
14633 while (n-- > 0)
14634 if (list_extend(rettv->vval.v_list,
14635 argvars[0].vval.v_list, NULL) == FAIL)
14636 break;
14638 else
14640 p = get_tv_string(&argvars[0]);
14641 rettv->v_type = VAR_STRING;
14642 rettv->vval.v_string = NULL;
14644 slen = (int)STRLEN(p);
14645 len = slen * n;
14646 if (len <= 0)
14647 return;
14649 r = alloc(len + 1);
14650 if (r != NULL)
14652 for (i = 0; i < n; i++)
14653 mch_memmove(r + i * slen, p, (size_t)slen);
14654 r[len] = NUL;
14657 rettv->vval.v_string = r;
14662 * "resolve()" function
14664 static void
14665 f_resolve(argvars, rettv)
14666 typval_T *argvars;
14667 typval_T *rettv;
14669 char_u *p;
14671 p = get_tv_string(&argvars[0]);
14672 #ifdef FEAT_SHORTCUT
14674 char_u *v = NULL;
14676 v = mch_resolve_shortcut(p);
14677 if (v != NULL)
14678 rettv->vval.v_string = v;
14679 else
14680 rettv->vval.v_string = vim_strsave(p);
14682 #else
14683 # ifdef HAVE_READLINK
14685 char_u buf[MAXPATHL + 1];
14686 char_u *cpy;
14687 int len;
14688 char_u *remain = NULL;
14689 char_u *q;
14690 int is_relative_to_current = FALSE;
14691 int has_trailing_pathsep = FALSE;
14692 int limit = 100;
14694 p = vim_strsave(p);
14696 if (p[0] == '.' && (vim_ispathsep(p[1])
14697 || (p[1] == '.' && (vim_ispathsep(p[2])))))
14698 is_relative_to_current = TRUE;
14700 len = STRLEN(p);
14701 if (len > 0 && after_pathsep(p, p + len))
14702 has_trailing_pathsep = TRUE;
14704 q = getnextcomp(p);
14705 if (*q != NUL)
14707 /* Separate the first path component in "p", and keep the
14708 * remainder (beginning with the path separator). */
14709 remain = vim_strsave(q - 1);
14710 q[-1] = NUL;
14713 for (;;)
14715 for (;;)
14717 len = readlink((char *)p, (char *)buf, MAXPATHL);
14718 if (len <= 0)
14719 break;
14720 buf[len] = NUL;
14722 if (limit-- == 0)
14724 vim_free(p);
14725 vim_free(remain);
14726 EMSG(_("E655: Too many symbolic links (cycle?)"));
14727 rettv->vval.v_string = NULL;
14728 goto fail;
14731 /* Ensure that the result will have a trailing path separator
14732 * if the argument has one. */
14733 if (remain == NULL && has_trailing_pathsep)
14734 add_pathsep(buf);
14736 /* Separate the first path component in the link value and
14737 * concatenate the remainders. */
14738 q = getnextcomp(vim_ispathsep(*buf) ? buf + 1 : buf);
14739 if (*q != NUL)
14741 if (remain == NULL)
14742 remain = vim_strsave(q - 1);
14743 else
14745 cpy = concat_str(q - 1, remain);
14746 if (cpy != NULL)
14748 vim_free(remain);
14749 remain = cpy;
14752 q[-1] = NUL;
14755 q = gettail(p);
14756 if (q > p && *q == NUL)
14758 /* Ignore trailing path separator. */
14759 q[-1] = NUL;
14760 q = gettail(p);
14762 if (q > p && !mch_isFullName(buf))
14764 /* symlink is relative to directory of argument */
14765 cpy = alloc((unsigned)(STRLEN(p) + STRLEN(buf) + 1));
14766 if (cpy != NULL)
14768 STRCPY(cpy, p);
14769 STRCPY(gettail(cpy), buf);
14770 vim_free(p);
14771 p = cpy;
14774 else
14776 vim_free(p);
14777 p = vim_strsave(buf);
14781 if (remain == NULL)
14782 break;
14784 /* Append the first path component of "remain" to "p". */
14785 q = getnextcomp(remain + 1);
14786 len = q - remain - (*q != NUL);
14787 cpy = vim_strnsave(p, STRLEN(p) + len);
14788 if (cpy != NULL)
14790 STRNCAT(cpy, remain, len);
14791 vim_free(p);
14792 p = cpy;
14794 /* Shorten "remain". */
14795 if (*q != NUL)
14796 STRMOVE(remain, q - 1);
14797 else
14799 vim_free(remain);
14800 remain = NULL;
14804 /* If the result is a relative path name, make it explicitly relative to
14805 * the current directory if and only if the argument had this form. */
14806 if (!vim_ispathsep(*p))
14808 if (is_relative_to_current
14809 && *p != NUL
14810 && !(p[0] == '.'
14811 && (p[1] == NUL
14812 || vim_ispathsep(p[1])
14813 || (p[1] == '.'
14814 && (p[2] == NUL
14815 || vim_ispathsep(p[2]))))))
14817 /* Prepend "./". */
14818 cpy = concat_str((char_u *)"./", p);
14819 if (cpy != NULL)
14821 vim_free(p);
14822 p = cpy;
14825 else if (!is_relative_to_current)
14827 /* Strip leading "./". */
14828 q = p;
14829 while (q[0] == '.' && vim_ispathsep(q[1]))
14830 q += 2;
14831 if (q > p)
14832 STRMOVE(p, p + 2);
14836 /* Ensure that the result will have no trailing path separator
14837 * if the argument had none. But keep "/" or "//". */
14838 if (!has_trailing_pathsep)
14840 q = p + STRLEN(p);
14841 if (after_pathsep(p, q))
14842 *gettail_sep(p) = NUL;
14845 rettv->vval.v_string = p;
14847 # else
14848 rettv->vval.v_string = vim_strsave(p);
14849 # endif
14850 #endif
14852 simplify_filename(rettv->vval.v_string);
14854 #ifdef HAVE_READLINK
14855 fail:
14856 #endif
14857 rettv->v_type = VAR_STRING;
14861 * "reverse({list})" function
14863 static void
14864 f_reverse(argvars, rettv)
14865 typval_T *argvars;
14866 typval_T *rettv;
14868 list_T *l;
14869 listitem_T *li, *ni;
14871 if (argvars[0].v_type != VAR_LIST)
14872 EMSG2(_(e_listarg), "reverse()");
14873 else if ((l = argvars[0].vval.v_list) != NULL
14874 && !tv_check_lock(l->lv_lock, (char_u *)"reverse()"))
14876 li = l->lv_last;
14877 l->lv_first = l->lv_last = NULL;
14878 l->lv_len = 0;
14879 while (li != NULL)
14881 ni = li->li_prev;
14882 list_append(l, li);
14883 li = ni;
14885 rettv->vval.v_list = l;
14886 rettv->v_type = VAR_LIST;
14887 ++l->lv_refcount;
14888 l->lv_idx = l->lv_len - l->lv_idx - 1;
14892 #define SP_NOMOVE 0x01 /* don't move cursor */
14893 #define SP_REPEAT 0x02 /* repeat to find outer pair */
14894 #define SP_RETCOUNT 0x04 /* return matchcount */
14895 #define SP_SETPCMARK 0x08 /* set previous context mark */
14896 #define SP_START 0x10 /* accept match at start position */
14897 #define SP_SUBPAT 0x20 /* return nr of matching sub-pattern */
14898 #define SP_END 0x40 /* leave cursor at end of match */
14900 static int get_search_arg __ARGS((typval_T *varp, int *flagsp));
14903 * Get flags for a search function.
14904 * Possibly sets "p_ws".
14905 * Returns BACKWARD, FORWARD or zero (for an error).
14907 static int
14908 get_search_arg(varp, flagsp)
14909 typval_T *varp;
14910 int *flagsp;
14912 int dir = FORWARD;
14913 char_u *flags;
14914 char_u nbuf[NUMBUFLEN];
14915 int mask;
14917 if (varp->v_type != VAR_UNKNOWN)
14919 flags = get_tv_string_buf_chk(varp, nbuf);
14920 if (flags == NULL)
14921 return 0; /* type error; errmsg already given */
14922 while (*flags != NUL)
14924 switch (*flags)
14926 case 'b': dir = BACKWARD; break;
14927 case 'w': p_ws = TRUE; break;
14928 case 'W': p_ws = FALSE; break;
14929 default: mask = 0;
14930 if (flagsp != NULL)
14931 switch (*flags)
14933 case 'c': mask = SP_START; break;
14934 case 'e': mask = SP_END; break;
14935 case 'm': mask = SP_RETCOUNT; break;
14936 case 'n': mask = SP_NOMOVE; break;
14937 case 'p': mask = SP_SUBPAT; break;
14938 case 'r': mask = SP_REPEAT; break;
14939 case 's': mask = SP_SETPCMARK; break;
14941 if (mask == 0)
14943 EMSG2(_(e_invarg2), flags);
14944 dir = 0;
14946 else
14947 *flagsp |= mask;
14949 if (dir == 0)
14950 break;
14951 ++flags;
14954 return dir;
14958 * Shared by search() and searchpos() functions
14960 static int
14961 search_cmn(argvars, match_pos, flagsp)
14962 typval_T *argvars;
14963 pos_T *match_pos;
14964 int *flagsp;
14966 int flags;
14967 char_u *pat;
14968 pos_T pos;
14969 pos_T save_cursor;
14970 int save_p_ws = p_ws;
14971 int dir;
14972 int retval = 0; /* default: FAIL */
14973 long lnum_stop = 0;
14974 proftime_T tm;
14975 #ifdef FEAT_RELTIME
14976 long time_limit = 0;
14977 #endif
14978 int options = SEARCH_KEEP;
14979 int subpatnum;
14981 pat = get_tv_string(&argvars[0]);
14982 dir = get_search_arg(&argvars[1], flagsp); /* may set p_ws */
14983 if (dir == 0)
14984 goto theend;
14985 flags = *flagsp;
14986 if (flags & SP_START)
14987 options |= SEARCH_START;
14988 if (flags & SP_END)
14989 options |= SEARCH_END;
14991 /* Optional arguments: line number to stop searching and timeout. */
14992 if (argvars[1].v_type != VAR_UNKNOWN && argvars[2].v_type != VAR_UNKNOWN)
14994 lnum_stop = get_tv_number_chk(&argvars[2], NULL);
14995 if (lnum_stop < 0)
14996 goto theend;
14997 #ifdef FEAT_RELTIME
14998 if (argvars[3].v_type != VAR_UNKNOWN)
15000 time_limit = get_tv_number_chk(&argvars[3], NULL);
15001 if (time_limit < 0)
15002 goto theend;
15004 #endif
15007 #ifdef FEAT_RELTIME
15008 /* Set the time limit, if there is one. */
15009 profile_setlimit(time_limit, &tm);
15010 #endif
15013 * This function does not accept SP_REPEAT and SP_RETCOUNT flags.
15014 * Check to make sure only those flags are set.
15015 * Also, Only the SP_NOMOVE or the SP_SETPCMARK flag can be set. Both
15016 * flags cannot be set. Check for that condition also.
15018 if (((flags & (SP_REPEAT | SP_RETCOUNT)) != 0)
15019 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15021 EMSG2(_(e_invarg2), get_tv_string(&argvars[1]));
15022 goto theend;
15025 pos = save_cursor = curwin->w_cursor;
15026 subpatnum = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15027 options, RE_SEARCH, (linenr_T)lnum_stop, &tm);
15028 if (subpatnum != FAIL)
15030 if (flags & SP_SUBPAT)
15031 retval = subpatnum;
15032 else
15033 retval = pos.lnum;
15034 if (flags & SP_SETPCMARK)
15035 setpcmark();
15036 curwin->w_cursor = pos;
15037 if (match_pos != NULL)
15039 /* Store the match cursor position */
15040 match_pos->lnum = pos.lnum;
15041 match_pos->col = pos.col + 1;
15043 /* "/$" will put the cursor after the end of the line, may need to
15044 * correct that here */
15045 check_cursor();
15048 /* If 'n' flag is used: restore cursor position. */
15049 if (flags & SP_NOMOVE)
15050 curwin->w_cursor = save_cursor;
15051 else
15052 curwin->w_set_curswant = TRUE;
15053 theend:
15054 p_ws = save_p_ws;
15056 return retval;
15059 #ifdef FEAT_FLOAT
15061 * "round({float})" function
15063 static void
15064 f_round(argvars, rettv)
15065 typval_T *argvars;
15066 typval_T *rettv;
15068 float_T f;
15070 rettv->v_type = VAR_FLOAT;
15071 if (get_float_arg(argvars, &f) == OK)
15072 /* round() is not in C90, use ceil() or floor() instead. */
15073 rettv->vval.v_float = f > 0 ? floor(f + 0.5) : ceil(f - 0.5);
15074 else
15075 rettv->vval.v_float = 0.0;
15077 #endif
15080 * "search()" function
15082 static void
15083 f_search(argvars, rettv)
15084 typval_T *argvars;
15085 typval_T *rettv;
15087 int flags = 0;
15089 rettv->vval.v_number = search_cmn(argvars, NULL, &flags);
15093 * "searchdecl()" function
15095 static void
15096 f_searchdecl(argvars, rettv)
15097 typval_T *argvars;
15098 typval_T *rettv;
15100 int locally = 1;
15101 int thisblock = 0;
15102 int error = FALSE;
15103 char_u *name;
15105 rettv->vval.v_number = 1; /* default: FAIL */
15107 name = get_tv_string_chk(&argvars[0]);
15108 if (argvars[1].v_type != VAR_UNKNOWN)
15110 locally = get_tv_number_chk(&argvars[1], &error) == 0;
15111 if (!error && argvars[2].v_type != VAR_UNKNOWN)
15112 thisblock = get_tv_number_chk(&argvars[2], &error) != 0;
15114 if (!error && name != NULL)
15115 rettv->vval.v_number = find_decl(name, (int)STRLEN(name),
15116 locally, thisblock, SEARCH_KEEP) == FAIL;
15120 * Used by searchpair() and searchpairpos()
15122 static int
15123 searchpair_cmn(argvars, match_pos)
15124 typval_T *argvars;
15125 pos_T *match_pos;
15127 char_u *spat, *mpat, *epat;
15128 char_u *skip;
15129 int save_p_ws = p_ws;
15130 int dir;
15131 int flags = 0;
15132 char_u nbuf1[NUMBUFLEN];
15133 char_u nbuf2[NUMBUFLEN];
15134 char_u nbuf3[NUMBUFLEN];
15135 int retval = 0; /* default: FAIL */
15136 long lnum_stop = 0;
15137 long time_limit = 0;
15139 /* Get the three pattern arguments: start, middle, end. */
15140 spat = get_tv_string_chk(&argvars[0]);
15141 mpat = get_tv_string_buf_chk(&argvars[1], nbuf1);
15142 epat = get_tv_string_buf_chk(&argvars[2], nbuf2);
15143 if (spat == NULL || mpat == NULL || epat == NULL)
15144 goto theend; /* type error */
15146 /* Handle the optional fourth argument: flags */
15147 dir = get_search_arg(&argvars[3], &flags); /* may set p_ws */
15148 if (dir == 0)
15149 goto theend;
15151 /* Don't accept SP_END or SP_SUBPAT.
15152 * Only one of the SP_NOMOVE or SP_SETPCMARK flags can be set.
15154 if ((flags & (SP_END | SP_SUBPAT)) != 0
15155 || ((flags & SP_NOMOVE) && (flags & SP_SETPCMARK)))
15157 EMSG2(_(e_invarg2), get_tv_string(&argvars[3]));
15158 goto theend;
15161 /* Using 'r' implies 'W', otherwise it doesn't work. */
15162 if (flags & SP_REPEAT)
15163 p_ws = FALSE;
15165 /* Optional fifth argument: skip expression */
15166 if (argvars[3].v_type == VAR_UNKNOWN
15167 || argvars[4].v_type == VAR_UNKNOWN)
15168 skip = (char_u *)"";
15169 else
15171 skip = get_tv_string_buf_chk(&argvars[4], nbuf3);
15172 if (argvars[5].v_type != VAR_UNKNOWN)
15174 lnum_stop = get_tv_number_chk(&argvars[5], NULL);
15175 if (lnum_stop < 0)
15176 goto theend;
15177 #ifdef FEAT_RELTIME
15178 if (argvars[6].v_type != VAR_UNKNOWN)
15180 time_limit = get_tv_number_chk(&argvars[6], NULL);
15181 if (time_limit < 0)
15182 goto theend;
15184 #endif
15187 if (skip == NULL)
15188 goto theend; /* type error */
15190 retval = do_searchpair(spat, mpat, epat, dir, skip, flags,
15191 match_pos, lnum_stop, time_limit);
15193 theend:
15194 p_ws = save_p_ws;
15196 return retval;
15200 * "searchpair()" function
15202 static void
15203 f_searchpair(argvars, rettv)
15204 typval_T *argvars;
15205 typval_T *rettv;
15207 rettv->vval.v_number = searchpair_cmn(argvars, NULL);
15211 * "searchpairpos()" function
15213 static void
15214 f_searchpairpos(argvars, rettv)
15215 typval_T *argvars;
15216 typval_T *rettv;
15218 pos_T match_pos;
15219 int lnum = 0;
15220 int col = 0;
15222 if (rettv_list_alloc(rettv) == FAIL)
15223 return;
15225 if (searchpair_cmn(argvars, &match_pos) > 0)
15227 lnum = match_pos.lnum;
15228 col = match_pos.col;
15231 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15232 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15236 * Search for a start/middle/end thing.
15237 * Used by searchpair(), see its documentation for the details.
15238 * Returns 0 or -1 for no match,
15240 long
15241 do_searchpair(spat, mpat, epat, dir, skip, flags, match_pos,
15242 lnum_stop, time_limit)
15243 char_u *spat; /* start pattern */
15244 char_u *mpat; /* middle pattern */
15245 char_u *epat; /* end pattern */
15246 int dir; /* BACKWARD or FORWARD */
15247 char_u *skip; /* skip expression */
15248 int flags; /* SP_SETPCMARK and other SP_ values */
15249 pos_T *match_pos;
15250 linenr_T lnum_stop; /* stop at this line if not zero */
15251 long time_limit; /* stop after this many msec */
15253 char_u *save_cpo;
15254 char_u *pat, *pat2 = NULL, *pat3 = NULL;
15255 long retval = 0;
15256 pos_T pos;
15257 pos_T firstpos;
15258 pos_T foundpos;
15259 pos_T save_cursor;
15260 pos_T save_pos;
15261 int n;
15262 int r;
15263 int nest = 1;
15264 int err;
15265 int options = SEARCH_KEEP;
15266 proftime_T tm;
15268 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
15269 save_cpo = p_cpo;
15270 p_cpo = empty_option;
15272 #ifdef FEAT_RELTIME
15273 /* Set the time limit, if there is one. */
15274 profile_setlimit(time_limit, &tm);
15275 #endif
15277 /* Make two search patterns: start/end (pat2, for in nested pairs) and
15278 * start/middle/end (pat3, for the top pair). */
15279 pat2 = alloc((unsigned)(STRLEN(spat) + STRLEN(epat) + 15));
15280 pat3 = alloc((unsigned)(STRLEN(spat) + STRLEN(mpat) + STRLEN(epat) + 23));
15281 if (pat2 == NULL || pat3 == NULL)
15282 goto theend;
15283 sprintf((char *)pat2, "\\(%s\\m\\)\\|\\(%s\\m\\)", spat, epat);
15284 if (*mpat == NUL)
15285 STRCPY(pat3, pat2);
15286 else
15287 sprintf((char *)pat3, "\\(%s\\m\\)\\|\\(%s\\m\\)\\|\\(%s\\m\\)",
15288 spat, epat, mpat);
15289 if (flags & SP_START)
15290 options |= SEARCH_START;
15292 save_cursor = curwin->w_cursor;
15293 pos = curwin->w_cursor;
15294 clearpos(&firstpos);
15295 clearpos(&foundpos);
15296 pat = pat3;
15297 for (;;)
15299 n = searchit(curwin, curbuf, &pos, dir, pat, 1L,
15300 options, RE_SEARCH, lnum_stop, &tm);
15301 if (n == FAIL || (firstpos.lnum != 0 && equalpos(pos, firstpos)))
15302 /* didn't find it or found the first match again: FAIL */
15303 break;
15305 if (firstpos.lnum == 0)
15306 firstpos = pos;
15307 if (equalpos(pos, foundpos))
15309 /* Found the same position again. Can happen with a pattern that
15310 * has "\zs" at the end and searching backwards. Advance one
15311 * character and try again. */
15312 if (dir == BACKWARD)
15313 decl(&pos);
15314 else
15315 incl(&pos);
15317 foundpos = pos;
15319 /* clear the start flag to avoid getting stuck here */
15320 options &= ~SEARCH_START;
15322 /* If the skip pattern matches, ignore this match. */
15323 if (*skip != NUL)
15325 save_pos = curwin->w_cursor;
15326 curwin->w_cursor = pos;
15327 r = eval_to_bool(skip, &err, NULL, FALSE);
15328 curwin->w_cursor = save_pos;
15329 if (err)
15331 /* Evaluating {skip} caused an error, break here. */
15332 curwin->w_cursor = save_cursor;
15333 retval = -1;
15334 break;
15336 if (r)
15337 continue;
15340 if ((dir == BACKWARD && n == 3) || (dir == FORWARD && n == 2))
15342 /* Found end when searching backwards or start when searching
15343 * forward: nested pair. */
15344 ++nest;
15345 pat = pat2; /* nested, don't search for middle */
15347 else
15349 /* Found end when searching forward or start when searching
15350 * backward: end of (nested) pair; or found middle in outer pair. */
15351 if (--nest == 1)
15352 pat = pat3; /* outer level, search for middle */
15355 if (nest == 0)
15357 /* Found the match: return matchcount or line number. */
15358 if (flags & SP_RETCOUNT)
15359 ++retval;
15360 else
15361 retval = pos.lnum;
15362 if (flags & SP_SETPCMARK)
15363 setpcmark();
15364 curwin->w_cursor = pos;
15365 if (!(flags & SP_REPEAT))
15366 break;
15367 nest = 1; /* search for next unmatched */
15371 if (match_pos != NULL)
15373 /* Store the match cursor position */
15374 match_pos->lnum = curwin->w_cursor.lnum;
15375 match_pos->col = curwin->w_cursor.col + 1;
15378 /* If 'n' flag is used or search failed: restore cursor position. */
15379 if ((flags & SP_NOMOVE) || retval == 0)
15380 curwin->w_cursor = save_cursor;
15382 theend:
15383 vim_free(pat2);
15384 vim_free(pat3);
15385 if (p_cpo == empty_option)
15386 p_cpo = save_cpo;
15387 else
15388 /* Darn, evaluating the {skip} expression changed the value. */
15389 free_string_option(save_cpo);
15391 return retval;
15395 * "searchpos()" function
15397 static void
15398 f_searchpos(argvars, rettv)
15399 typval_T *argvars;
15400 typval_T *rettv;
15402 pos_T match_pos;
15403 int lnum = 0;
15404 int col = 0;
15405 int n;
15406 int flags = 0;
15408 if (rettv_list_alloc(rettv) == FAIL)
15409 return;
15411 n = search_cmn(argvars, &match_pos, &flags);
15412 if (n > 0)
15414 lnum = match_pos.lnum;
15415 col = match_pos.col;
15418 list_append_number(rettv->vval.v_list, (varnumber_T)lnum);
15419 list_append_number(rettv->vval.v_list, (varnumber_T)col);
15420 if (flags & SP_SUBPAT)
15421 list_append_number(rettv->vval.v_list, (varnumber_T)n);
15425 static void
15426 f_server2client(argvars, rettv)
15427 typval_T *argvars UNUSED;
15428 typval_T *rettv;
15430 #ifdef FEAT_CLIENTSERVER
15431 char_u buf[NUMBUFLEN];
15432 char_u *server = get_tv_string_chk(&argvars[0]);
15433 char_u *reply = get_tv_string_buf_chk(&argvars[1], buf);
15435 rettv->vval.v_number = -1;
15436 if (server == NULL || reply == NULL)
15437 return;
15438 if (check_restricted() || check_secure())
15439 return;
15440 # ifdef FEAT_X11
15441 if (check_connection() == FAIL)
15442 return;
15443 # endif
15445 if (serverSendReply(server, reply) < 0)
15447 EMSG(_("E258: Unable to send to client"));
15448 return;
15450 rettv->vval.v_number = 0;
15451 #else
15452 rettv->vval.v_number = -1;
15453 #endif
15456 static void
15457 f_serverlist(argvars, rettv)
15458 typval_T *argvars UNUSED;
15459 typval_T *rettv;
15461 char_u *r = NULL;
15463 #ifdef FEAT_CLIENTSERVER
15464 # ifdef WIN32
15465 r = serverGetVimNames();
15466 # else
15467 make_connection();
15468 if (X_DISPLAY != NULL)
15469 r = serverGetVimNames(X_DISPLAY);
15470 # endif
15471 #endif
15472 rettv->v_type = VAR_STRING;
15473 rettv->vval.v_string = r;
15477 * "setbufvar()" function
15479 static void
15480 f_setbufvar(argvars, rettv)
15481 typval_T *argvars;
15482 typval_T *rettv UNUSED;
15484 buf_T *buf;
15485 aco_save_T aco;
15486 char_u *varname, *bufvarname;
15487 typval_T *varp;
15488 char_u nbuf[NUMBUFLEN];
15490 if (check_restricted() || check_secure())
15491 return;
15492 (void)get_tv_number(&argvars[0]); /* issue errmsg if type error */
15493 varname = get_tv_string_chk(&argvars[1]);
15494 buf = get_buf_tv(&argvars[0]);
15495 varp = &argvars[2];
15497 if (buf != NULL && varname != NULL && varp != NULL)
15499 /* set curbuf to be our buf, temporarily */
15500 aucmd_prepbuf(&aco, buf);
15502 if (*varname == '&')
15504 long numval;
15505 char_u *strval;
15506 int error = FALSE;
15508 ++varname;
15509 numval = get_tv_number_chk(varp, &error);
15510 strval = get_tv_string_buf_chk(varp, nbuf);
15511 if (!error && strval != NULL)
15512 set_option_value(varname, numval, strval, OPT_LOCAL);
15514 else
15516 bufvarname = alloc((unsigned)STRLEN(varname) + 3);
15517 if (bufvarname != NULL)
15519 STRCPY(bufvarname, "b:");
15520 STRCPY(bufvarname + 2, varname);
15521 set_var(bufvarname, varp, TRUE);
15522 vim_free(bufvarname);
15526 /* reset notion of buffer */
15527 aucmd_restbuf(&aco);
15532 * "setcmdpos()" function
15534 static void
15535 f_setcmdpos(argvars, rettv)
15536 typval_T *argvars;
15537 typval_T *rettv;
15539 int pos = (int)get_tv_number(&argvars[0]) - 1;
15541 if (pos >= 0)
15542 rettv->vval.v_number = set_cmdline_pos(pos);
15546 * "setline()" function
15548 static void
15549 f_setline(argvars, rettv)
15550 typval_T *argvars;
15551 typval_T *rettv;
15553 linenr_T lnum;
15554 char_u *line = NULL;
15555 list_T *l = NULL;
15556 listitem_T *li = NULL;
15557 long added = 0;
15558 linenr_T lcount = curbuf->b_ml.ml_line_count;
15560 lnum = get_tv_lnum(&argvars[0]);
15561 if (argvars[1].v_type == VAR_LIST)
15563 l = argvars[1].vval.v_list;
15564 li = l->lv_first;
15566 else
15567 line = get_tv_string_chk(&argvars[1]);
15569 /* default result is zero == OK */
15570 for (;;)
15572 if (l != NULL)
15574 /* list argument, get next string */
15575 if (li == NULL)
15576 break;
15577 line = get_tv_string_chk(&li->li_tv);
15578 li = li->li_next;
15581 rettv->vval.v_number = 1; /* FAIL */
15582 if (line == NULL || lnum < 1 || lnum > curbuf->b_ml.ml_line_count + 1)
15583 break;
15584 if (lnum <= curbuf->b_ml.ml_line_count)
15586 /* existing line, replace it */
15587 if (u_savesub(lnum) == OK && ml_replace(lnum, line, TRUE) == OK)
15589 changed_bytes(lnum, 0);
15590 if (lnum == curwin->w_cursor.lnum)
15591 check_cursor_col();
15592 rettv->vval.v_number = 0; /* OK */
15595 else if (added > 0 || u_save(lnum - 1, lnum) == OK)
15597 /* lnum is one past the last line, append the line */
15598 ++added;
15599 if (ml_append(lnum - 1, line, (colnr_T)0, FALSE) == OK)
15600 rettv->vval.v_number = 0; /* OK */
15603 if (l == NULL) /* only one string argument */
15604 break;
15605 ++lnum;
15608 if (added > 0)
15609 appended_lines_mark(lcount, added);
15612 static void set_qf_ll_list __ARGS((win_T *wp, typval_T *list_arg, typval_T *action_arg, typval_T *rettv));
15615 * Used by "setqflist()" and "setloclist()" functions
15617 static void
15618 set_qf_ll_list(wp, list_arg, action_arg, rettv)
15619 win_T *wp UNUSED;
15620 typval_T *list_arg UNUSED;
15621 typval_T *action_arg UNUSED;
15622 typval_T *rettv;
15624 #ifdef FEAT_QUICKFIX
15625 char_u *act;
15626 int action = ' ';
15627 #endif
15629 rettv->vval.v_number = -1;
15631 #ifdef FEAT_QUICKFIX
15632 if (list_arg->v_type != VAR_LIST)
15633 EMSG(_(e_listreq));
15634 else
15636 list_T *l = list_arg->vval.v_list;
15638 if (action_arg->v_type == VAR_STRING)
15640 act = get_tv_string_chk(action_arg);
15641 if (act == NULL)
15642 return; /* type error; errmsg already given */
15643 if (*act == 'a' || *act == 'r')
15644 action = *act;
15647 if (l != NULL && set_errorlist(wp, l, action) == OK)
15648 rettv->vval.v_number = 0;
15650 #endif
15654 * "setloclist()" function
15656 static void
15657 f_setloclist(argvars, rettv)
15658 typval_T *argvars;
15659 typval_T *rettv;
15661 win_T *win;
15663 rettv->vval.v_number = -1;
15665 win = find_win_by_nr(&argvars[0], NULL);
15666 if (win != NULL)
15667 set_qf_ll_list(win, &argvars[1], &argvars[2], rettv);
15671 * "setmatches()" function
15673 static void
15674 f_setmatches(argvars, rettv)
15675 typval_T *argvars;
15676 typval_T *rettv;
15678 #ifdef FEAT_SEARCH_EXTRA
15679 list_T *l;
15680 listitem_T *li;
15681 dict_T *d;
15683 rettv->vval.v_number = -1;
15684 if (argvars[0].v_type != VAR_LIST)
15686 EMSG(_(e_listreq));
15687 return;
15689 if ((l = argvars[0].vval.v_list) != NULL)
15692 /* To some extent make sure that we are dealing with a list from
15693 * "getmatches()". */
15694 li = l->lv_first;
15695 while (li != NULL)
15697 if (li->li_tv.v_type != VAR_DICT
15698 || (d = li->li_tv.vval.v_dict) == NULL)
15700 EMSG(_(e_invarg));
15701 return;
15703 if (!(dict_find(d, (char_u *)"group", -1) != NULL
15704 && dict_find(d, (char_u *)"pattern", -1) != NULL
15705 && dict_find(d, (char_u *)"priority", -1) != NULL
15706 && dict_find(d, (char_u *)"id", -1) != NULL))
15708 EMSG(_(e_invarg));
15709 return;
15711 li = li->li_next;
15714 clear_matches(curwin);
15715 li = l->lv_first;
15716 while (li != NULL)
15718 d = li->li_tv.vval.v_dict;
15719 match_add(curwin, get_dict_string(d, (char_u *)"group", FALSE),
15720 get_dict_string(d, (char_u *)"pattern", FALSE),
15721 (int)get_dict_number(d, (char_u *)"priority"),
15722 (int)get_dict_number(d, (char_u *)"id"));
15723 li = li->li_next;
15725 rettv->vval.v_number = 0;
15727 #endif
15731 * "setpos()" function
15733 static void
15734 f_setpos(argvars, rettv)
15735 typval_T *argvars;
15736 typval_T *rettv;
15738 pos_T pos;
15739 int fnum;
15740 char_u *name;
15742 rettv->vval.v_number = -1;
15743 name = get_tv_string_chk(argvars);
15744 if (name != NULL)
15746 if (list2fpos(&argvars[1], &pos, &fnum) == OK)
15748 if (--pos.col < 0)
15749 pos.col = 0;
15750 if (name[0] == '.' && name[1] == NUL)
15752 /* set cursor */
15753 if (fnum == curbuf->b_fnum)
15755 curwin->w_cursor = pos;
15756 check_cursor();
15757 rettv->vval.v_number = 0;
15759 else
15760 EMSG(_(e_invarg));
15762 else if (name[0] == '\'' && name[1] != NUL && name[2] == NUL)
15764 /* set mark */
15765 if (setmark_pos(name[1], &pos, fnum) == OK)
15766 rettv->vval.v_number = 0;
15768 else
15769 EMSG(_(e_invarg));
15775 * "setqflist()" function
15777 static void
15778 f_setqflist(argvars, rettv)
15779 typval_T *argvars;
15780 typval_T *rettv;
15782 set_qf_ll_list(NULL, &argvars[0], &argvars[1], rettv);
15786 * "setreg()" function
15788 static void
15789 f_setreg(argvars, rettv)
15790 typval_T *argvars;
15791 typval_T *rettv;
15793 int regname;
15794 char_u *strregname;
15795 char_u *stropt;
15796 char_u *strval;
15797 int append;
15798 char_u yank_type;
15799 long block_len;
15801 block_len = -1;
15802 yank_type = MAUTO;
15803 append = FALSE;
15805 strregname = get_tv_string_chk(argvars);
15806 rettv->vval.v_number = 1; /* FAIL is default */
15808 if (strregname == NULL)
15809 return; /* type error; errmsg already given */
15810 regname = *strregname;
15811 if (regname == 0 || regname == '@')
15812 regname = '"';
15813 else if (regname == '=')
15814 return;
15816 if (argvars[2].v_type != VAR_UNKNOWN)
15818 stropt = get_tv_string_chk(&argvars[2]);
15819 if (stropt == NULL)
15820 return; /* type error */
15821 for (; *stropt != NUL; ++stropt)
15822 switch (*stropt)
15824 case 'a': case 'A': /* append */
15825 append = TRUE;
15826 break;
15827 case 'v': case 'c': /* character-wise selection */
15828 yank_type = MCHAR;
15829 break;
15830 case 'V': case 'l': /* line-wise selection */
15831 yank_type = MLINE;
15832 break;
15833 #ifdef FEAT_VISUAL
15834 case 'b': case Ctrl_V: /* block-wise selection */
15835 yank_type = MBLOCK;
15836 if (VIM_ISDIGIT(stropt[1]))
15838 ++stropt;
15839 block_len = getdigits(&stropt) - 1;
15840 --stropt;
15842 break;
15843 #endif
15847 strval = get_tv_string_chk(&argvars[1]);
15848 if (strval != NULL)
15849 write_reg_contents_ex(regname, strval, -1,
15850 append, yank_type, block_len);
15851 rettv->vval.v_number = 0;
15855 * "settabwinvar()" function
15857 static void
15858 f_settabwinvar(argvars, rettv)
15859 typval_T *argvars;
15860 typval_T *rettv;
15862 setwinvar(argvars, rettv, 1);
15866 * "setwinvar()" function
15868 static void
15869 f_setwinvar(argvars, rettv)
15870 typval_T *argvars;
15871 typval_T *rettv;
15873 setwinvar(argvars, rettv, 0);
15877 * "setwinvar()" and "settabwinvar()" functions
15879 static void
15880 setwinvar(argvars, rettv, off)
15881 typval_T *argvars;
15882 typval_T *rettv UNUSED;
15883 int off;
15885 win_T *win;
15886 #ifdef FEAT_WINDOWS
15887 win_T *save_curwin;
15888 tabpage_T *save_curtab;
15889 #endif
15890 char_u *varname, *winvarname;
15891 typval_T *varp;
15892 char_u nbuf[NUMBUFLEN];
15893 tabpage_T *tp;
15895 if (check_restricted() || check_secure())
15896 return;
15898 #ifdef FEAT_WINDOWS
15899 if (off == 1)
15900 tp = find_tabpage((int)get_tv_number_chk(&argvars[0], NULL));
15901 else
15902 tp = curtab;
15903 #endif
15904 win = find_win_by_nr(&argvars[off], tp);
15905 varname = get_tv_string_chk(&argvars[off + 1]);
15906 varp = &argvars[off + 2];
15908 if (win != NULL && varname != NULL && varp != NULL)
15910 #ifdef FEAT_WINDOWS
15911 /* set curwin to be our win, temporarily */
15912 save_curwin = curwin;
15913 save_curtab = curtab;
15914 goto_tabpage_tp(tp);
15915 if (!win_valid(win))
15916 return;
15917 curwin = win;
15918 curbuf = curwin->w_buffer;
15919 #endif
15921 if (*varname == '&')
15923 long numval;
15924 char_u *strval;
15925 int error = FALSE;
15927 ++varname;
15928 numval = get_tv_number_chk(varp, &error);
15929 strval = get_tv_string_buf_chk(varp, nbuf);
15930 if (!error && strval != NULL)
15931 set_option_value(varname, numval, strval, OPT_LOCAL);
15933 else
15935 winvarname = alloc((unsigned)STRLEN(varname) + 3);
15936 if (winvarname != NULL)
15938 STRCPY(winvarname, "w:");
15939 STRCPY(winvarname + 2, varname);
15940 set_var(winvarname, varp, TRUE);
15941 vim_free(winvarname);
15945 #ifdef FEAT_WINDOWS
15946 /* Restore current tabpage and window, if still valid (autocomands can
15947 * make them invalid). */
15948 if (valid_tabpage(save_curtab))
15949 goto_tabpage_tp(save_curtab);
15950 if (win_valid(save_curwin))
15952 curwin = save_curwin;
15953 curbuf = curwin->w_buffer;
15955 #endif
15960 * "shellescape({string})" function
15962 static void
15963 f_shellescape(argvars, rettv)
15964 typval_T *argvars;
15965 typval_T *rettv;
15967 rettv->vval.v_string = vim_strsave_shellescape(
15968 get_tv_string(&argvars[0]), non_zero_arg(&argvars[1]));
15969 rettv->v_type = VAR_STRING;
15973 * "simplify()" function
15975 static void
15976 f_simplify(argvars, rettv)
15977 typval_T *argvars;
15978 typval_T *rettv;
15980 char_u *p;
15982 p = get_tv_string(&argvars[0]);
15983 rettv->vval.v_string = vim_strsave(p);
15984 simplify_filename(rettv->vval.v_string); /* simplify in place */
15985 rettv->v_type = VAR_STRING;
15988 #ifdef FEAT_FLOAT
15990 * "sin()" function
15992 static void
15993 f_sin(argvars, rettv)
15994 typval_T *argvars;
15995 typval_T *rettv;
15997 float_T f;
15999 rettv->v_type = VAR_FLOAT;
16000 if (get_float_arg(argvars, &f) == OK)
16001 rettv->vval.v_float = sin(f);
16002 else
16003 rettv->vval.v_float = 0.0;
16005 #endif
16007 static int
16008 #ifdef __BORLANDC__
16009 _RTLENTRYF
16010 #endif
16011 item_compare __ARGS((const void *s1, const void *s2));
16012 static int
16013 #ifdef __BORLANDC__
16014 _RTLENTRYF
16015 #endif
16016 item_compare2 __ARGS((const void *s1, const void *s2));
16018 static int item_compare_ic;
16019 static char_u *item_compare_func;
16020 static int item_compare_func_err;
16021 #define ITEM_COMPARE_FAIL 999
16024 * Compare functions for f_sort() below.
16026 static int
16027 #ifdef __BORLANDC__
16028 _RTLENTRYF
16029 #endif
16030 item_compare(s1, s2)
16031 const void *s1;
16032 const void *s2;
16034 char_u *p1, *p2;
16035 char_u *tofree1, *tofree2;
16036 int res;
16037 char_u numbuf1[NUMBUFLEN];
16038 char_u numbuf2[NUMBUFLEN];
16040 p1 = tv2string(&(*(listitem_T **)s1)->li_tv, &tofree1, numbuf1, 0);
16041 p2 = tv2string(&(*(listitem_T **)s2)->li_tv, &tofree2, numbuf2, 0);
16042 if (p1 == NULL)
16043 p1 = (char_u *)"";
16044 if (p2 == NULL)
16045 p2 = (char_u *)"";
16046 if (item_compare_ic)
16047 res = STRICMP(p1, p2);
16048 else
16049 res = STRCMP(p1, p2);
16050 vim_free(tofree1);
16051 vim_free(tofree2);
16052 return res;
16055 static int
16056 #ifdef __BORLANDC__
16057 _RTLENTRYF
16058 #endif
16059 item_compare2(s1, s2)
16060 const void *s1;
16061 const void *s2;
16063 int res;
16064 typval_T rettv;
16065 typval_T argv[3];
16066 int dummy;
16068 /* shortcut after failure in previous call; compare all items equal */
16069 if (item_compare_func_err)
16070 return 0;
16072 /* copy the values. This is needed to be able to set v_lock to VAR_FIXED
16073 * in the copy without changing the original list items. */
16074 copy_tv(&(*(listitem_T **)s1)->li_tv, &argv[0]);
16075 copy_tv(&(*(listitem_T **)s2)->li_tv, &argv[1]);
16077 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
16078 res = call_func(item_compare_func, (int)STRLEN(item_compare_func),
16079 &rettv, 2, argv, 0L, 0L, &dummy, TRUE, NULL);
16080 clear_tv(&argv[0]);
16081 clear_tv(&argv[1]);
16083 if (res == FAIL)
16084 res = ITEM_COMPARE_FAIL;
16085 else
16086 res = get_tv_number_chk(&rettv, &item_compare_func_err);
16087 if (item_compare_func_err)
16088 res = ITEM_COMPARE_FAIL; /* return value has wrong type */
16089 clear_tv(&rettv);
16090 return res;
16094 * "sort({list})" function
16096 static void
16097 f_sort(argvars, rettv)
16098 typval_T *argvars;
16099 typval_T *rettv;
16101 list_T *l;
16102 listitem_T *li;
16103 listitem_T **ptrs;
16104 long len;
16105 long i;
16107 if (argvars[0].v_type != VAR_LIST)
16108 EMSG2(_(e_listarg), "sort()");
16109 else
16111 l = argvars[0].vval.v_list;
16112 if (l == NULL || tv_check_lock(l->lv_lock, (char_u *)"sort()"))
16113 return;
16114 rettv->vval.v_list = l;
16115 rettv->v_type = VAR_LIST;
16116 ++l->lv_refcount;
16118 len = list_len(l);
16119 if (len <= 1)
16120 return; /* short list sorts pretty quickly */
16122 item_compare_ic = FALSE;
16123 item_compare_func = NULL;
16124 if (argvars[1].v_type != VAR_UNKNOWN)
16126 if (argvars[1].v_type == VAR_FUNC)
16127 item_compare_func = argvars[1].vval.v_string;
16128 else
16130 int error = FALSE;
16132 i = get_tv_number_chk(&argvars[1], &error);
16133 if (error)
16134 return; /* type error; errmsg already given */
16135 if (i == 1)
16136 item_compare_ic = TRUE;
16137 else
16138 item_compare_func = get_tv_string(&argvars[1]);
16142 /* Make an array with each entry pointing to an item in the List. */
16143 ptrs = (listitem_T **)alloc((int)(len * sizeof(listitem_T *)));
16144 if (ptrs == NULL)
16145 return;
16146 i = 0;
16147 for (li = l->lv_first; li != NULL; li = li->li_next)
16148 ptrs[i++] = li;
16150 item_compare_func_err = FALSE;
16151 /* test the compare function */
16152 if (item_compare_func != NULL
16153 && item_compare2((void *)&ptrs[0], (void *)&ptrs[1])
16154 == ITEM_COMPARE_FAIL)
16155 EMSG(_("E702: Sort compare function failed"));
16156 else
16158 /* Sort the array with item pointers. */
16159 qsort((void *)ptrs, (size_t)len, sizeof(listitem_T *),
16160 item_compare_func == NULL ? item_compare : item_compare2);
16162 if (!item_compare_func_err)
16164 /* Clear the List and append the items in the sorted order. */
16165 l->lv_first = l->lv_last = l->lv_idx_item = NULL;
16166 l->lv_len = 0;
16167 for (i = 0; i < len; ++i)
16168 list_append(l, ptrs[i]);
16172 vim_free(ptrs);
16177 * "soundfold({word})" function
16179 static void
16180 f_soundfold(argvars, rettv)
16181 typval_T *argvars;
16182 typval_T *rettv;
16184 char_u *s;
16186 rettv->v_type = VAR_STRING;
16187 s = get_tv_string(&argvars[0]);
16188 #ifdef FEAT_SPELL
16189 rettv->vval.v_string = eval_soundfold(s);
16190 #else
16191 rettv->vval.v_string = vim_strsave(s);
16192 #endif
16196 * "spellbadword()" function
16198 static void
16199 f_spellbadword(argvars, rettv)
16200 typval_T *argvars UNUSED;
16201 typval_T *rettv;
16203 char_u *word = (char_u *)"";
16204 hlf_T attr = HLF_COUNT;
16205 int len = 0;
16207 if (rettv_list_alloc(rettv) == FAIL)
16208 return;
16210 #ifdef FEAT_SPELL
16211 if (argvars[0].v_type == VAR_UNKNOWN)
16213 /* Find the start and length of the badly spelled word. */
16214 len = spell_move_to(curwin, FORWARD, TRUE, TRUE, &attr);
16215 if (len != 0)
16216 word = ml_get_cursor();
16218 else if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16220 char_u *str = get_tv_string_chk(&argvars[0]);
16221 int capcol = -1;
16223 if (str != NULL)
16225 /* Check the argument for spelling. */
16226 while (*str != NUL)
16228 len = spell_check(curwin, str, &attr, &capcol, FALSE);
16229 if (attr != HLF_COUNT)
16231 word = str;
16232 break;
16234 str += len;
16238 #endif
16240 list_append_string(rettv->vval.v_list, word, len);
16241 list_append_string(rettv->vval.v_list, (char_u *)(
16242 attr == HLF_SPB ? "bad" :
16243 attr == HLF_SPR ? "rare" :
16244 attr == HLF_SPL ? "local" :
16245 attr == HLF_SPC ? "caps" :
16246 ""), -1);
16250 * "spellsuggest()" function
16252 static void
16253 f_spellsuggest(argvars, rettv)
16254 typval_T *argvars UNUSED;
16255 typval_T *rettv;
16257 #ifdef FEAT_SPELL
16258 char_u *str;
16259 int typeerr = FALSE;
16260 int maxcount;
16261 garray_T ga;
16262 int i;
16263 listitem_T *li;
16264 int need_capital = FALSE;
16265 #endif
16267 if (rettv_list_alloc(rettv) == FAIL)
16268 return;
16270 #ifdef FEAT_SPELL
16271 if (curwin->w_p_spell && *curbuf->b_p_spl != NUL)
16273 str = get_tv_string(&argvars[0]);
16274 if (argvars[1].v_type != VAR_UNKNOWN)
16276 maxcount = get_tv_number_chk(&argvars[1], &typeerr);
16277 if (maxcount <= 0)
16278 return;
16279 if (argvars[2].v_type != VAR_UNKNOWN)
16281 need_capital = get_tv_number_chk(&argvars[2], &typeerr);
16282 if (typeerr)
16283 return;
16286 else
16287 maxcount = 25;
16289 spell_suggest_list(&ga, str, maxcount, need_capital, FALSE);
16291 for (i = 0; i < ga.ga_len; ++i)
16293 str = ((char_u **)ga.ga_data)[i];
16295 li = listitem_alloc();
16296 if (li == NULL)
16297 vim_free(str);
16298 else
16300 li->li_tv.v_type = VAR_STRING;
16301 li->li_tv.v_lock = 0;
16302 li->li_tv.vval.v_string = str;
16303 list_append(rettv->vval.v_list, li);
16306 ga_clear(&ga);
16308 #endif
16311 static void
16312 f_split(argvars, rettv)
16313 typval_T *argvars;
16314 typval_T *rettv;
16316 char_u *str;
16317 char_u *end;
16318 char_u *pat = NULL;
16319 regmatch_T regmatch;
16320 char_u patbuf[NUMBUFLEN];
16321 char_u *save_cpo;
16322 int match;
16323 colnr_T col = 0;
16324 int keepempty = FALSE;
16325 int typeerr = FALSE;
16327 /* Make 'cpoptions' empty, the 'l' flag should not be used here. */
16328 save_cpo = p_cpo;
16329 p_cpo = (char_u *)"";
16331 str = get_tv_string(&argvars[0]);
16332 if (argvars[1].v_type != VAR_UNKNOWN)
16334 pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16335 if (pat == NULL)
16336 typeerr = TRUE;
16337 if (argvars[2].v_type != VAR_UNKNOWN)
16338 keepempty = get_tv_number_chk(&argvars[2], &typeerr);
16340 if (pat == NULL || *pat == NUL)
16341 pat = (char_u *)"[\\x01- ]\\+";
16343 if (rettv_list_alloc(rettv) == FAIL)
16344 return;
16345 if (typeerr)
16346 return;
16348 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
16349 if (regmatch.regprog != NULL)
16351 regmatch.rm_ic = FALSE;
16352 while (*str != NUL || keepempty)
16354 if (*str == NUL)
16355 match = FALSE; /* empty item at the end */
16356 else
16357 match = vim_regexec_nl(&regmatch, str, col);
16358 if (match)
16359 end = regmatch.startp[0];
16360 else
16361 end = str + STRLEN(str);
16362 if (keepempty || end > str || (rettv->vval.v_list->lv_len > 0
16363 && *str != NUL && match && end < regmatch.endp[0]))
16365 if (list_append_string(rettv->vval.v_list, str,
16366 (int)(end - str)) == FAIL)
16367 break;
16369 if (!match)
16370 break;
16371 /* Advance to just after the match. */
16372 if (regmatch.endp[0] > str)
16373 col = 0;
16374 else
16376 /* Don't get stuck at the same match. */
16377 #ifdef FEAT_MBYTE
16378 col = (*mb_ptr2len)(regmatch.endp[0]);
16379 #else
16380 col = 1;
16381 #endif
16383 str = regmatch.endp[0];
16386 vim_free(regmatch.regprog);
16389 p_cpo = save_cpo;
16392 #ifdef FEAT_FLOAT
16394 * "sqrt()" function
16396 static void
16397 f_sqrt(argvars, rettv)
16398 typval_T *argvars;
16399 typval_T *rettv;
16401 float_T f;
16403 rettv->v_type = VAR_FLOAT;
16404 if (get_float_arg(argvars, &f) == OK)
16405 rettv->vval.v_float = sqrt(f);
16406 else
16407 rettv->vval.v_float = 0.0;
16411 * "str2float()" function
16413 static void
16414 f_str2float(argvars, rettv)
16415 typval_T *argvars;
16416 typval_T *rettv;
16418 char_u *p = skipwhite(get_tv_string(&argvars[0]));
16420 if (*p == '+')
16421 p = skipwhite(p + 1);
16422 (void)string2float(p, &rettv->vval.v_float);
16423 rettv->v_type = VAR_FLOAT;
16425 #endif
16428 * "str2nr()" function
16430 static void
16431 f_str2nr(argvars, rettv)
16432 typval_T *argvars;
16433 typval_T *rettv;
16435 int base = 10;
16436 char_u *p;
16437 long n;
16439 if (argvars[1].v_type != VAR_UNKNOWN)
16441 base = get_tv_number(&argvars[1]);
16442 if (base != 8 && base != 10 && base != 16)
16444 EMSG(_(e_invarg));
16445 return;
16449 p = skipwhite(get_tv_string(&argvars[0]));
16450 if (*p == '+')
16451 p = skipwhite(p + 1);
16452 vim_str2nr(p, NULL, NULL, base == 8 ? 2 : 0, base == 16 ? 2 : 0, &n, NULL);
16453 rettv->vval.v_number = n;
16456 #ifdef HAVE_STRFTIME
16458 * "strftime({format}[, {time}])" function
16460 static void
16461 f_strftime(argvars, rettv)
16462 typval_T *argvars;
16463 typval_T *rettv;
16465 char_u result_buf[256];
16466 struct tm *curtime;
16467 time_t seconds;
16468 char_u *p;
16470 rettv->v_type = VAR_STRING;
16472 p = get_tv_string(&argvars[0]);
16473 if (argvars[1].v_type == VAR_UNKNOWN)
16474 seconds = time(NULL);
16475 else
16476 seconds = (time_t)get_tv_number(&argvars[1]);
16477 curtime = localtime(&seconds);
16478 /* MSVC returns NULL for an invalid value of seconds. */
16479 if (curtime == NULL)
16480 rettv->vval.v_string = vim_strsave((char_u *)_("(Invalid)"));
16481 else
16483 # ifdef FEAT_MBYTE
16484 vimconv_T conv;
16485 char_u *enc;
16487 conv.vc_type = CONV_NONE;
16488 enc = enc_locale();
16489 convert_setup(&conv, p_enc, enc);
16490 if (conv.vc_type != CONV_NONE)
16491 p = string_convert(&conv, p, NULL);
16492 # endif
16493 if (p != NULL)
16494 (void)strftime((char *)result_buf, sizeof(result_buf),
16495 (char *)p, curtime);
16496 else
16497 result_buf[0] = NUL;
16499 # ifdef FEAT_MBYTE
16500 if (conv.vc_type != CONV_NONE)
16501 vim_free(p);
16502 convert_setup(&conv, enc, p_enc);
16503 if (conv.vc_type != CONV_NONE)
16504 rettv->vval.v_string = string_convert(&conv, result_buf, NULL);
16505 else
16506 # endif
16507 rettv->vval.v_string = vim_strsave(result_buf);
16509 # ifdef FEAT_MBYTE
16510 /* Release conversion descriptors */
16511 convert_setup(&conv, NULL, NULL);
16512 vim_free(enc);
16513 # endif
16516 #endif
16519 * "stridx()" function
16521 static void
16522 f_stridx(argvars, rettv)
16523 typval_T *argvars;
16524 typval_T *rettv;
16526 char_u buf[NUMBUFLEN];
16527 char_u *needle;
16528 char_u *haystack;
16529 char_u *save_haystack;
16530 char_u *pos;
16531 int start_idx;
16533 needle = get_tv_string_chk(&argvars[1]);
16534 save_haystack = haystack = get_tv_string_buf_chk(&argvars[0], buf);
16535 rettv->vval.v_number = -1;
16536 if (needle == NULL || haystack == NULL)
16537 return; /* type error; errmsg already given */
16539 if (argvars[2].v_type != VAR_UNKNOWN)
16541 int error = FALSE;
16543 start_idx = get_tv_number_chk(&argvars[2], &error);
16544 if (error || start_idx >= (int)STRLEN(haystack))
16545 return;
16546 if (start_idx >= 0)
16547 haystack += start_idx;
16550 pos = (char_u *)strstr((char *)haystack, (char *)needle);
16551 if (pos != NULL)
16552 rettv->vval.v_number = (varnumber_T)(pos - save_haystack);
16556 * "string()" function
16558 static void
16559 f_string(argvars, rettv)
16560 typval_T *argvars;
16561 typval_T *rettv;
16563 char_u *tofree;
16564 char_u numbuf[NUMBUFLEN];
16566 rettv->v_type = VAR_STRING;
16567 rettv->vval.v_string = tv2string(&argvars[0], &tofree, numbuf, 0);
16568 /* Make a copy if we have a value but it's not in allocated memory. */
16569 if (rettv->vval.v_string != NULL && tofree == NULL)
16570 rettv->vval.v_string = vim_strsave(rettv->vval.v_string);
16574 * "strlen()" function
16576 static void
16577 f_strlen(argvars, rettv)
16578 typval_T *argvars;
16579 typval_T *rettv;
16581 rettv->vval.v_number = (varnumber_T)(STRLEN(
16582 get_tv_string(&argvars[0])));
16586 * "strpart()" function
16588 static void
16589 f_strpart(argvars, rettv)
16590 typval_T *argvars;
16591 typval_T *rettv;
16593 char_u *p;
16594 int n;
16595 int len;
16596 int slen;
16597 int error = FALSE;
16599 p = get_tv_string(&argvars[0]);
16600 slen = (int)STRLEN(p);
16602 n = get_tv_number_chk(&argvars[1], &error);
16603 if (error)
16604 len = 0;
16605 else if (argvars[2].v_type != VAR_UNKNOWN)
16606 len = get_tv_number(&argvars[2]);
16607 else
16608 len = slen - n; /* default len: all bytes that are available. */
16611 * Only return the overlap between the specified part and the actual
16612 * string.
16614 if (n < 0)
16616 len += n;
16617 n = 0;
16619 else if (n > slen)
16620 n = slen;
16621 if (len < 0)
16622 len = 0;
16623 else if (n + len > slen)
16624 len = slen - n;
16626 rettv->v_type = VAR_STRING;
16627 rettv->vval.v_string = vim_strnsave(p + n, len);
16631 * "strridx()" function
16633 static void
16634 f_strridx(argvars, rettv)
16635 typval_T *argvars;
16636 typval_T *rettv;
16638 char_u buf[NUMBUFLEN];
16639 char_u *needle;
16640 char_u *haystack;
16641 char_u *rest;
16642 char_u *lastmatch = NULL;
16643 int haystack_len, end_idx;
16645 needle = get_tv_string_chk(&argvars[1]);
16646 haystack = get_tv_string_buf_chk(&argvars[0], buf);
16648 rettv->vval.v_number = -1;
16649 if (needle == NULL || haystack == NULL)
16650 return; /* type error; errmsg already given */
16652 haystack_len = (int)STRLEN(haystack);
16653 if (argvars[2].v_type != VAR_UNKNOWN)
16655 /* Third argument: upper limit for index */
16656 end_idx = get_tv_number_chk(&argvars[2], NULL);
16657 if (end_idx < 0)
16658 return; /* can never find a match */
16660 else
16661 end_idx = haystack_len;
16663 if (*needle == NUL)
16665 /* Empty string matches past the end. */
16666 lastmatch = haystack + end_idx;
16668 else
16670 for (rest = haystack; *rest != '\0'; ++rest)
16672 rest = (char_u *)strstr((char *)rest, (char *)needle);
16673 if (rest == NULL || rest > haystack + end_idx)
16674 break;
16675 lastmatch = rest;
16679 if (lastmatch == NULL)
16680 rettv->vval.v_number = -1;
16681 else
16682 rettv->vval.v_number = (varnumber_T)(lastmatch - haystack);
16686 * "strtrans()" function
16688 static void
16689 f_strtrans(argvars, rettv)
16690 typval_T *argvars;
16691 typval_T *rettv;
16693 rettv->v_type = VAR_STRING;
16694 rettv->vval.v_string = transstr(get_tv_string(&argvars[0]));
16698 * "submatch()" function
16700 static void
16701 f_submatch(argvars, rettv)
16702 typval_T *argvars;
16703 typval_T *rettv;
16705 rettv->v_type = VAR_STRING;
16706 rettv->vval.v_string =
16707 reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
16711 * "substitute()" function
16713 static void
16714 f_substitute(argvars, rettv)
16715 typval_T *argvars;
16716 typval_T *rettv;
16718 char_u patbuf[NUMBUFLEN];
16719 char_u subbuf[NUMBUFLEN];
16720 char_u flagsbuf[NUMBUFLEN];
16722 char_u *str = get_tv_string_chk(&argvars[0]);
16723 char_u *pat = get_tv_string_buf_chk(&argvars[1], patbuf);
16724 char_u *sub = get_tv_string_buf_chk(&argvars[2], subbuf);
16725 char_u *flg = get_tv_string_buf_chk(&argvars[3], flagsbuf);
16727 rettv->v_type = VAR_STRING;
16728 if (str == NULL || pat == NULL || sub == NULL || flg == NULL)
16729 rettv->vval.v_string = NULL;
16730 else
16731 rettv->vval.v_string = do_string_sub(str, pat, sub, flg);
16735 * "synID(lnum, col, trans)" function
16737 static void
16738 f_synID(argvars, rettv)
16739 typval_T *argvars UNUSED;
16740 typval_T *rettv;
16742 int id = 0;
16743 #ifdef FEAT_SYN_HL
16744 long lnum;
16745 long col;
16746 int trans;
16747 int transerr = FALSE;
16749 lnum = get_tv_lnum(argvars); /* -1 on type error */
16750 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16751 trans = get_tv_number_chk(&argvars[2], &transerr);
16753 if (!transerr && lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16754 && col >= 0 && col < (long)STRLEN(ml_get(lnum)))
16755 id = syn_get_id(curwin, lnum, (colnr_T)col, trans, NULL, FALSE);
16756 #endif
16758 rettv->vval.v_number = id;
16762 * "synIDattr(id, what [, mode])" function
16764 static void
16765 f_synIDattr(argvars, rettv)
16766 typval_T *argvars UNUSED;
16767 typval_T *rettv;
16769 char_u *p = NULL;
16770 #ifdef FEAT_SYN_HL
16771 int id;
16772 char_u *what;
16773 char_u *mode;
16774 char_u modebuf[NUMBUFLEN];
16775 int modec;
16777 id = get_tv_number(&argvars[0]);
16778 what = get_tv_string(&argvars[1]);
16779 if (argvars[2].v_type != VAR_UNKNOWN)
16781 mode = get_tv_string_buf(&argvars[2], modebuf);
16782 modec = TOLOWER_ASC(mode[0]);
16783 if (modec != 't' && modec != 'c'
16784 #ifdef FEAT_GUI
16785 && modec != 'g'
16786 #endif
16788 modec = 0; /* replace invalid with current */
16790 else
16792 #ifdef FEAT_GUI
16793 if (gui.in_use)
16794 modec = 'g';
16795 else
16796 #endif
16797 if (t_colors > 1)
16798 modec = 'c';
16799 else
16800 modec = 't';
16804 switch (TOLOWER_ASC(what[0]))
16806 case 'b':
16807 if (TOLOWER_ASC(what[1]) == 'g') /* bg[#] */
16808 p = highlight_color(id, what, modec);
16809 else /* bold */
16810 p = highlight_has_attr(id, HL_BOLD, modec);
16811 break;
16813 case 'f': /* fg[#] */
16814 p = highlight_color(id, what, modec);
16815 break;
16817 case 'i':
16818 if (TOLOWER_ASC(what[1]) == 'n') /* inverse */
16819 p = highlight_has_attr(id, HL_INVERSE, modec);
16820 else /* italic */
16821 p = highlight_has_attr(id, HL_ITALIC, modec);
16822 break;
16824 case 'n': /* name */
16825 p = get_highlight_name(NULL, id - 1);
16826 break;
16828 case 'r': /* reverse */
16829 p = highlight_has_attr(id, HL_INVERSE, modec);
16830 break;
16832 case 's':
16833 if (TOLOWER_ASC(what[1]) == 'p') /* sp[#] */
16834 p = highlight_color(id, what, modec);
16835 else /* standout */
16836 p = highlight_has_attr(id, HL_STANDOUT, modec);
16837 break;
16839 case 'u':
16840 if (STRLEN(what) <= 5 || TOLOWER_ASC(what[5]) != 'c')
16841 /* underline */
16842 p = highlight_has_attr(id, HL_UNDERLINE, modec);
16843 else
16844 /* undercurl */
16845 p = highlight_has_attr(id, HL_UNDERCURL, modec);
16846 break;
16849 if (p != NULL)
16850 p = vim_strsave(p);
16851 #endif
16852 rettv->v_type = VAR_STRING;
16853 rettv->vval.v_string = p;
16857 * "synIDtrans(id)" function
16859 static void
16860 f_synIDtrans(argvars, rettv)
16861 typval_T *argvars UNUSED;
16862 typval_T *rettv;
16864 int id;
16866 #ifdef FEAT_SYN_HL
16867 id = get_tv_number(&argvars[0]);
16869 if (id > 0)
16870 id = syn_get_final_id(id);
16871 else
16872 #endif
16873 id = 0;
16875 rettv->vval.v_number = id;
16879 * "synstack(lnum, col)" function
16881 static void
16882 f_synstack(argvars, rettv)
16883 typval_T *argvars UNUSED;
16884 typval_T *rettv;
16886 #ifdef FEAT_SYN_HL
16887 long lnum;
16888 long col;
16889 int i;
16890 int id;
16891 #endif
16893 rettv->v_type = VAR_LIST;
16894 rettv->vval.v_list = NULL;
16896 #ifdef FEAT_SYN_HL
16897 lnum = get_tv_lnum(argvars); /* -1 on type error */
16898 col = get_tv_number(&argvars[1]) - 1; /* -1 on type error */
16900 if (lnum >= 1 && lnum <= curbuf->b_ml.ml_line_count
16901 && col >= 0 && (col == 0 || col < (long)STRLEN(ml_get(lnum)))
16902 && rettv_list_alloc(rettv) != FAIL)
16904 (void)syn_get_id(curwin, lnum, (colnr_T)col, FALSE, NULL, TRUE);
16905 for (i = 0; ; ++i)
16907 id = syn_get_stack_item(i);
16908 if (id < 0)
16909 break;
16910 if (list_append_number(rettv->vval.v_list, id) == FAIL)
16911 break;
16914 #endif
16918 * "system()" function
16920 static void
16921 f_system(argvars, rettv)
16922 typval_T *argvars;
16923 typval_T *rettv;
16925 char_u *res = NULL;
16926 char_u *p;
16927 char_u *infile = NULL;
16928 char_u buf[NUMBUFLEN];
16929 int err = FALSE;
16930 FILE *fd;
16932 if (check_restricted() || check_secure())
16933 goto done;
16935 if (argvars[1].v_type != VAR_UNKNOWN)
16938 * Write the string to a temp file, to be used for input of the shell
16939 * command.
16941 if ((infile = vim_tempname('i')) == NULL)
16943 EMSG(_(e_notmp));
16944 goto done;
16947 fd = mch_fopen((char *)infile, WRITEBIN);
16948 if (fd == NULL)
16950 EMSG2(_(e_notopen), infile);
16951 goto done;
16953 p = get_tv_string_buf_chk(&argvars[1], buf);
16954 if (p == NULL)
16956 fclose(fd);
16957 goto done; /* type error; errmsg already given */
16959 if (fwrite(p, STRLEN(p), 1, fd) != 1)
16960 err = TRUE;
16961 if (fclose(fd) != 0)
16962 err = TRUE;
16963 if (err)
16965 EMSG(_("E677: Error writing temp file"));
16966 goto done;
16970 res = get_cmd_output(get_tv_string(&argvars[0]), infile,
16971 SHELL_SILENT | SHELL_COOKED);
16973 #ifdef USE_CR
16974 /* translate <CR> into <NL> */
16975 if (res != NULL)
16977 char_u *s;
16979 for (s = res; *s; ++s)
16981 if (*s == CAR)
16982 *s = NL;
16985 #else
16986 # ifdef USE_CRNL
16987 /* translate <CR><NL> into <NL> */
16988 if (res != NULL)
16990 char_u *s, *d;
16992 d = res;
16993 for (s = res; *s; ++s)
16995 if (s[0] == CAR && s[1] == NL)
16996 ++s;
16997 *d++ = *s;
16999 *d = NUL;
17001 # endif
17002 #endif
17004 done:
17005 if (infile != NULL)
17007 mch_remove(infile);
17008 vim_free(infile);
17010 rettv->v_type = VAR_STRING;
17011 rettv->vval.v_string = res;
17015 * "tabpagebuflist()" function
17017 static void
17018 f_tabpagebuflist(argvars, rettv)
17019 typval_T *argvars UNUSED;
17020 typval_T *rettv UNUSED;
17022 #ifdef FEAT_WINDOWS
17023 tabpage_T *tp;
17024 win_T *wp = NULL;
17026 if (argvars[0].v_type == VAR_UNKNOWN)
17027 wp = firstwin;
17028 else
17030 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17031 if (tp != NULL)
17032 wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
17034 if (wp != NULL && rettv_list_alloc(rettv) != FAIL)
17036 for (; wp != NULL; wp = wp->w_next)
17037 if (list_append_number(rettv->vval.v_list,
17038 wp->w_buffer->b_fnum) == FAIL)
17039 break;
17041 #endif
17046 * "tabpagenr()" function
17048 static void
17049 f_tabpagenr(argvars, rettv)
17050 typval_T *argvars UNUSED;
17051 typval_T *rettv;
17053 int nr = 1;
17054 #ifdef FEAT_WINDOWS
17055 char_u *arg;
17057 if (argvars[0].v_type != VAR_UNKNOWN)
17059 arg = get_tv_string_chk(&argvars[0]);
17060 nr = 0;
17061 if (arg != NULL)
17063 if (STRCMP(arg, "$") == 0)
17064 nr = tabpage_index(NULL) - 1;
17065 else
17066 EMSG2(_(e_invexpr2), arg);
17069 else
17070 nr = tabpage_index(curtab);
17071 #endif
17072 rettv->vval.v_number = nr;
17076 #ifdef FEAT_WINDOWS
17077 static int get_winnr __ARGS((tabpage_T *tp, typval_T *argvar));
17080 * Common code for tabpagewinnr() and winnr().
17082 static int
17083 get_winnr(tp, argvar)
17084 tabpage_T *tp;
17085 typval_T *argvar;
17087 win_T *twin;
17088 int nr = 1;
17089 win_T *wp;
17090 char_u *arg;
17092 twin = (tp == curtab) ? curwin : tp->tp_curwin;
17093 if (argvar->v_type != VAR_UNKNOWN)
17095 arg = get_tv_string_chk(argvar);
17096 if (arg == NULL)
17097 nr = 0; /* type error; errmsg already given */
17098 else if (STRCMP(arg, "$") == 0)
17099 twin = (tp == curtab) ? lastwin : tp->tp_lastwin;
17100 else if (STRCMP(arg, "#") == 0)
17102 twin = (tp == curtab) ? prevwin : tp->tp_prevwin;
17103 if (twin == NULL)
17104 nr = 0;
17106 else
17108 EMSG2(_(e_invexpr2), arg);
17109 nr = 0;
17113 if (nr > 0)
17114 for (wp = (tp == curtab) ? firstwin : tp->tp_firstwin;
17115 wp != twin; wp = wp->w_next)
17117 if (wp == NULL)
17119 /* didn't find it in this tabpage */
17120 nr = 0;
17121 break;
17123 ++nr;
17125 return nr;
17127 #endif
17130 * "tabpagewinnr()" function
17132 static void
17133 f_tabpagewinnr(argvars, rettv)
17134 typval_T *argvars UNUSED;
17135 typval_T *rettv;
17137 int nr = 1;
17138 #ifdef FEAT_WINDOWS
17139 tabpage_T *tp;
17141 tp = find_tabpage((int)get_tv_number(&argvars[0]));
17142 if (tp == NULL)
17143 nr = 0;
17144 else
17145 nr = get_winnr(tp, &argvars[1]);
17146 #endif
17147 rettv->vval.v_number = nr;
17152 * "tagfiles()" function
17154 static void
17155 f_tagfiles(argvars, rettv)
17156 typval_T *argvars UNUSED;
17157 typval_T *rettv;
17159 char_u fname[MAXPATHL + 1];
17160 tagname_T tn;
17161 int first;
17163 if (rettv_list_alloc(rettv) == FAIL)
17164 return;
17166 for (first = TRUE; ; first = FALSE)
17167 if (get_tagfname(&tn, first, fname) == FAIL
17168 || list_append_string(rettv->vval.v_list, fname, -1) == FAIL)
17169 break;
17170 tagname_free(&tn);
17174 * "taglist()" function
17176 static void
17177 f_taglist(argvars, rettv)
17178 typval_T *argvars;
17179 typval_T *rettv;
17181 char_u *tag_pattern;
17183 tag_pattern = get_tv_string(&argvars[0]);
17185 rettv->vval.v_number = FALSE;
17186 if (*tag_pattern == NUL)
17187 return;
17189 if (rettv_list_alloc(rettv) == OK)
17190 (void)get_tags(rettv->vval.v_list, tag_pattern);
17194 * "tempname()" function
17196 static void
17197 f_tempname(argvars, rettv)
17198 typval_T *argvars UNUSED;
17199 typval_T *rettv;
17201 static int x = 'A';
17203 rettv->v_type = VAR_STRING;
17204 rettv->vval.v_string = vim_tempname(x);
17206 /* Advance 'x' to use A-Z and 0-9, so that there are at least 34 different
17207 * names. Skip 'I' and 'O', they are used for shell redirection. */
17210 if (x == 'Z')
17211 x = '0';
17212 else if (x == '9')
17213 x = 'A';
17214 else
17216 #ifdef EBCDIC
17217 if (x == 'I')
17218 x = 'J';
17219 else if (x == 'R')
17220 x = 'S';
17221 else
17222 #endif
17223 ++x;
17225 } while (x == 'I' || x == 'O');
17229 * "test(list)" function: Just checking the walls...
17231 static void
17232 f_test(argvars, rettv)
17233 typval_T *argvars UNUSED;
17234 typval_T *rettv UNUSED;
17236 /* Used for unit testing. Change the code below to your liking. */
17237 #if 0
17238 listitem_T *li;
17239 list_T *l;
17240 char_u *bad, *good;
17242 if (argvars[0].v_type != VAR_LIST)
17243 return;
17244 l = argvars[0].vval.v_list;
17245 if (l == NULL)
17246 return;
17247 li = l->lv_first;
17248 if (li == NULL)
17249 return;
17250 bad = get_tv_string(&li->li_tv);
17251 li = li->li_next;
17252 if (li == NULL)
17253 return;
17254 good = get_tv_string(&li->li_tv);
17255 rettv->vval.v_number = test_edit_score(bad, good);
17256 #endif
17260 * "tolower(string)" function
17262 static void
17263 f_tolower(argvars, rettv)
17264 typval_T *argvars;
17265 typval_T *rettv;
17267 char_u *p;
17269 p = vim_strsave(get_tv_string(&argvars[0]));
17270 rettv->v_type = VAR_STRING;
17271 rettv->vval.v_string = p;
17273 if (p != NULL)
17274 while (*p != NUL)
17276 #ifdef FEAT_MBYTE
17277 int l;
17279 if (enc_utf8)
17281 int c, lc;
17283 c = utf_ptr2char(p);
17284 lc = utf_tolower(c);
17285 l = utf_ptr2len(p);
17286 /* TODO: reallocate string when byte count changes. */
17287 if (utf_char2len(lc) == l)
17288 utf_char2bytes(lc, p);
17289 p += l;
17291 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1)
17292 p += l; /* skip multi-byte character */
17293 else
17294 #endif
17296 *p = TOLOWER_LOC(*p); /* note that tolower() can be a macro */
17297 ++p;
17303 * "toupper(string)" function
17305 static void
17306 f_toupper(argvars, rettv)
17307 typval_T *argvars;
17308 typval_T *rettv;
17310 rettv->v_type = VAR_STRING;
17311 rettv->vval.v_string = strup_save(get_tv_string(&argvars[0]));
17315 * "tr(string, fromstr, tostr)" function
17317 static void
17318 f_tr(argvars, rettv)
17319 typval_T *argvars;
17320 typval_T *rettv;
17322 char_u *instr;
17323 char_u *fromstr;
17324 char_u *tostr;
17325 char_u *p;
17326 #ifdef FEAT_MBYTE
17327 int inlen;
17328 int fromlen;
17329 int tolen;
17330 int idx;
17331 char_u *cpstr;
17332 int cplen;
17333 int first = TRUE;
17334 #endif
17335 char_u buf[NUMBUFLEN];
17336 char_u buf2[NUMBUFLEN];
17337 garray_T ga;
17339 instr = get_tv_string(&argvars[0]);
17340 fromstr = get_tv_string_buf_chk(&argvars[1], buf);
17341 tostr = get_tv_string_buf_chk(&argvars[2], buf2);
17343 /* Default return value: empty string. */
17344 rettv->v_type = VAR_STRING;
17345 rettv->vval.v_string = NULL;
17346 if (fromstr == NULL || tostr == NULL)
17347 return; /* type error; errmsg already given */
17348 ga_init2(&ga, (int)sizeof(char), 80);
17350 #ifdef FEAT_MBYTE
17351 if (!has_mbyte)
17352 #endif
17353 /* not multi-byte: fromstr and tostr must be the same length */
17354 if (STRLEN(fromstr) != STRLEN(tostr))
17356 #ifdef FEAT_MBYTE
17357 error:
17358 #endif
17359 EMSG2(_(e_invarg2), fromstr);
17360 ga_clear(&ga);
17361 return;
17364 /* fromstr and tostr have to contain the same number of chars */
17365 while (*instr != NUL)
17367 #ifdef FEAT_MBYTE
17368 if (has_mbyte)
17370 inlen = (*mb_ptr2len)(instr);
17371 cpstr = instr;
17372 cplen = inlen;
17373 idx = 0;
17374 for (p = fromstr; *p != NUL; p += fromlen)
17376 fromlen = (*mb_ptr2len)(p);
17377 if (fromlen == inlen && STRNCMP(instr, p, inlen) == 0)
17379 for (p = tostr; *p != NUL; p += tolen)
17381 tolen = (*mb_ptr2len)(p);
17382 if (idx-- == 0)
17384 cplen = tolen;
17385 cpstr = p;
17386 break;
17389 if (*p == NUL) /* tostr is shorter than fromstr */
17390 goto error;
17391 break;
17393 ++idx;
17396 if (first && cpstr == instr)
17398 /* Check that fromstr and tostr have the same number of
17399 * (multi-byte) characters. Done only once when a character
17400 * of instr doesn't appear in fromstr. */
17401 first = FALSE;
17402 for (p = tostr; *p != NUL; p += tolen)
17404 tolen = (*mb_ptr2len)(p);
17405 --idx;
17407 if (idx != 0)
17408 goto error;
17411 ga_grow(&ga, cplen);
17412 mch_memmove((char *)ga.ga_data + ga.ga_len, cpstr, (size_t)cplen);
17413 ga.ga_len += cplen;
17415 instr += inlen;
17417 else
17418 #endif
17420 /* When not using multi-byte chars we can do it faster. */
17421 p = vim_strchr(fromstr, *instr);
17422 if (p != NULL)
17423 ga_append(&ga, tostr[p - fromstr]);
17424 else
17425 ga_append(&ga, *instr);
17426 ++instr;
17430 /* add a terminating NUL */
17431 ga_grow(&ga, 1);
17432 ga_append(&ga, NUL);
17434 rettv->vval.v_string = ga.ga_data;
17437 #ifdef FEAT_FLOAT
17439 * "trunc({float})" function
17441 static void
17442 f_trunc(argvars, rettv)
17443 typval_T *argvars;
17444 typval_T *rettv;
17446 float_T f;
17448 rettv->v_type = VAR_FLOAT;
17449 if (get_float_arg(argvars, &f) == OK)
17450 /* trunc() is not in C90, use floor() or ceil() instead. */
17451 rettv->vval.v_float = f > 0 ? floor(f) : ceil(f);
17452 else
17453 rettv->vval.v_float = 0.0;
17455 #endif
17458 * "type(expr)" function
17460 static void
17461 f_type(argvars, rettv)
17462 typval_T *argvars;
17463 typval_T *rettv;
17465 int n;
17467 switch (argvars[0].v_type)
17469 case VAR_NUMBER: n = 0; break;
17470 case VAR_STRING: n = 1; break;
17471 case VAR_FUNC: n = 2; break;
17472 case VAR_LIST: n = 3; break;
17473 case VAR_DICT: n = 4; break;
17474 #ifdef FEAT_FLOAT
17475 case VAR_FLOAT: n = 5; break;
17476 #endif
17477 default: EMSG2(_(e_intern2), "f_type()"); n = 0; break;
17479 rettv->vval.v_number = n;
17483 * "values(dict)" function
17485 static void
17486 f_values(argvars, rettv)
17487 typval_T *argvars;
17488 typval_T *rettv;
17490 dict_list(argvars, rettv, 1);
17494 * "virtcol(string)" function
17496 static void
17497 f_virtcol(argvars, rettv)
17498 typval_T *argvars;
17499 typval_T *rettv;
17501 colnr_T vcol = 0;
17502 pos_T *fp;
17503 int fnum = curbuf->b_fnum;
17505 fp = var2fpos(&argvars[0], FALSE, &fnum);
17506 if (fp != NULL && fp->lnum <= curbuf->b_ml.ml_line_count
17507 && fnum == curbuf->b_fnum)
17509 getvvcol(curwin, fp, NULL, NULL, &vcol);
17510 ++vcol;
17513 rettv->vval.v_number = vcol;
17517 * "visualmode()" function
17519 static void
17520 f_visualmode(argvars, rettv)
17521 typval_T *argvars UNUSED;
17522 typval_T *rettv UNUSED;
17524 #ifdef FEAT_VISUAL
17525 char_u str[2];
17527 rettv->v_type = VAR_STRING;
17528 str[0] = curbuf->b_visual_mode_eval;
17529 str[1] = NUL;
17530 rettv->vval.v_string = vim_strsave(str);
17532 /* A non-zero number or non-empty string argument: reset mode. */
17533 if (non_zero_arg(&argvars[0]))
17534 curbuf->b_visual_mode_eval = NUL;
17535 #endif
17539 * "winbufnr(nr)" function
17541 static void
17542 f_winbufnr(argvars, rettv)
17543 typval_T *argvars;
17544 typval_T *rettv;
17546 win_T *wp;
17548 wp = find_win_by_nr(&argvars[0], NULL);
17549 if (wp == NULL)
17550 rettv->vval.v_number = -1;
17551 else
17552 rettv->vval.v_number = wp->w_buffer->b_fnum;
17556 * "wincol()" function
17558 static void
17559 f_wincol(argvars, rettv)
17560 typval_T *argvars UNUSED;
17561 typval_T *rettv;
17563 validate_cursor();
17564 rettv->vval.v_number = curwin->w_wcol + 1;
17568 * "winheight(nr)" function
17570 static void
17571 f_winheight(argvars, rettv)
17572 typval_T *argvars;
17573 typval_T *rettv;
17575 win_T *wp;
17577 wp = find_win_by_nr(&argvars[0], NULL);
17578 if (wp == NULL)
17579 rettv->vval.v_number = -1;
17580 else
17581 rettv->vval.v_number = wp->w_height;
17585 * "winline()" function
17587 static void
17588 f_winline(argvars, rettv)
17589 typval_T *argvars UNUSED;
17590 typval_T *rettv;
17592 validate_cursor();
17593 rettv->vval.v_number = curwin->w_wrow + 1;
17597 * "winnr()" function
17599 static void
17600 f_winnr(argvars, rettv)
17601 typval_T *argvars UNUSED;
17602 typval_T *rettv;
17604 int nr = 1;
17606 #ifdef FEAT_WINDOWS
17607 nr = get_winnr(curtab, &argvars[0]);
17608 #endif
17609 rettv->vval.v_number = nr;
17613 * "winrestcmd()" function
17615 static void
17616 f_winrestcmd(argvars, rettv)
17617 typval_T *argvars UNUSED;
17618 typval_T *rettv;
17620 #ifdef FEAT_WINDOWS
17621 win_T *wp;
17622 int winnr = 1;
17623 garray_T ga;
17624 char_u buf[50];
17626 ga_init2(&ga, (int)sizeof(char), 70);
17627 for (wp = firstwin; wp != NULL; wp = wp->w_next)
17629 sprintf((char *)buf, "%dresize %d|", winnr, wp->w_height);
17630 ga_concat(&ga, buf);
17631 # ifdef FEAT_VERTSPLIT
17632 sprintf((char *)buf, "vert %dresize %d|", winnr, wp->w_width);
17633 ga_concat(&ga, buf);
17634 # endif
17635 ++winnr;
17637 ga_append(&ga, NUL);
17639 rettv->vval.v_string = ga.ga_data;
17640 #else
17641 rettv->vval.v_string = NULL;
17642 #endif
17643 rettv->v_type = VAR_STRING;
17647 * "winrestview()" function
17649 static void
17650 f_winrestview(argvars, rettv)
17651 typval_T *argvars;
17652 typval_T *rettv UNUSED;
17654 dict_T *dict;
17656 if (argvars[0].v_type != VAR_DICT
17657 || (dict = argvars[0].vval.v_dict) == NULL)
17658 EMSG(_(e_invarg));
17659 else
17661 curwin->w_cursor.lnum = get_dict_number(dict, (char_u *)"lnum");
17662 curwin->w_cursor.col = get_dict_number(dict, (char_u *)"col");
17663 #ifdef FEAT_VIRTUALEDIT
17664 curwin->w_cursor.coladd = get_dict_number(dict, (char_u *)"coladd");
17665 #endif
17666 curwin->w_curswant = get_dict_number(dict, (char_u *)"curswant");
17667 curwin->w_set_curswant = FALSE;
17669 set_topline(curwin, get_dict_number(dict, (char_u *)"topline"));
17670 #ifdef FEAT_DIFF
17671 curwin->w_topfill = get_dict_number(dict, (char_u *)"topfill");
17672 #endif
17673 curwin->w_leftcol = get_dict_number(dict, (char_u *)"leftcol");
17674 curwin->w_skipcol = get_dict_number(dict, (char_u *)"skipcol");
17676 check_cursor();
17677 changed_cline_bef_curs();
17678 invalidate_botline();
17679 redraw_later(VALID);
17681 if (curwin->w_topline == 0)
17682 curwin->w_topline = 1;
17683 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
17684 curwin->w_topline = curbuf->b_ml.ml_line_count;
17685 #ifdef FEAT_DIFF
17686 check_topfill(curwin, TRUE);
17687 #endif
17692 * "winsaveview()" function
17694 static void
17695 f_winsaveview(argvars, rettv)
17696 typval_T *argvars UNUSED;
17697 typval_T *rettv;
17699 dict_T *dict;
17701 dict = dict_alloc();
17702 if (dict == NULL)
17703 return;
17704 rettv->v_type = VAR_DICT;
17705 rettv->vval.v_dict = dict;
17706 ++dict->dv_refcount;
17708 dict_add_nr_str(dict, "lnum", (long)curwin->w_cursor.lnum, NULL);
17709 dict_add_nr_str(dict, "col", (long)curwin->w_cursor.col, NULL);
17710 #ifdef FEAT_VIRTUALEDIT
17711 dict_add_nr_str(dict, "coladd", (long)curwin->w_cursor.coladd, NULL);
17712 #endif
17713 update_curswant();
17714 dict_add_nr_str(dict, "curswant", (long)curwin->w_curswant, NULL);
17716 dict_add_nr_str(dict, "topline", (long)curwin->w_topline, NULL);
17717 #ifdef FEAT_DIFF
17718 dict_add_nr_str(dict, "topfill", (long)curwin->w_topfill, NULL);
17719 #endif
17720 dict_add_nr_str(dict, "leftcol", (long)curwin->w_leftcol, NULL);
17721 dict_add_nr_str(dict, "skipcol", (long)curwin->w_skipcol, NULL);
17725 * "winwidth(nr)" function
17727 static void
17728 f_winwidth(argvars, rettv)
17729 typval_T *argvars;
17730 typval_T *rettv;
17732 win_T *wp;
17734 wp = find_win_by_nr(&argvars[0], NULL);
17735 if (wp == NULL)
17736 rettv->vval.v_number = -1;
17737 else
17738 #ifdef FEAT_VERTSPLIT
17739 rettv->vval.v_number = wp->w_width;
17740 #else
17741 rettv->vval.v_number = Columns;
17742 #endif
17746 * "writefile()" function
17748 static void
17749 f_writefile(argvars, rettv)
17750 typval_T *argvars;
17751 typval_T *rettv;
17753 int binary = FALSE;
17754 char_u *fname;
17755 FILE *fd;
17756 listitem_T *li;
17757 char_u *s;
17758 int ret = 0;
17759 int c;
17761 if (check_restricted() || check_secure())
17762 return;
17764 if (argvars[0].v_type != VAR_LIST)
17766 EMSG2(_(e_listarg), "writefile()");
17767 return;
17769 if (argvars[0].vval.v_list == NULL)
17770 return;
17772 if (argvars[2].v_type != VAR_UNKNOWN
17773 && STRCMP(get_tv_string(&argvars[2]), "b") == 0)
17774 binary = TRUE;
17776 /* Always open the file in binary mode, library functions have a mind of
17777 * their own about CR-LF conversion. */
17778 fname = get_tv_string(&argvars[1]);
17779 if (*fname == NUL || (fd = mch_fopen((char *)fname, WRITEBIN)) == NULL)
17781 EMSG2(_(e_notcreate), *fname == NUL ? (char_u *)_("<empty>") : fname);
17782 ret = -1;
17784 else
17786 for (li = argvars[0].vval.v_list->lv_first; li != NULL;
17787 li = li->li_next)
17789 for (s = get_tv_string(&li->li_tv); *s != NUL; ++s)
17791 if (*s == '\n')
17792 c = putc(NUL, fd);
17793 else
17794 c = putc(*s, fd);
17795 if (c == EOF)
17797 ret = -1;
17798 break;
17801 if (!binary || li->li_next != NULL)
17802 if (putc('\n', fd) == EOF)
17804 ret = -1;
17805 break;
17807 if (ret < 0)
17809 EMSG(_(e_write));
17810 break;
17813 fclose(fd);
17816 rettv->vval.v_number = ret;
17820 * Translate a String variable into a position.
17821 * Returns NULL when there is an error.
17823 static pos_T *
17824 var2fpos(varp, dollar_lnum, fnum)
17825 typval_T *varp;
17826 int dollar_lnum; /* TRUE when $ is last line */
17827 int *fnum; /* set to fnum for '0, 'A, etc. */
17829 char_u *name;
17830 static pos_T pos;
17831 pos_T *pp;
17833 /* Argument can be [lnum, col, coladd]. */
17834 if (varp->v_type == VAR_LIST)
17836 list_T *l;
17837 int len;
17838 int error = FALSE;
17839 listitem_T *li;
17841 l = varp->vval.v_list;
17842 if (l == NULL)
17843 return NULL;
17845 /* Get the line number */
17846 pos.lnum = list_find_nr(l, 0L, &error);
17847 if (error || pos.lnum <= 0 || pos.lnum > curbuf->b_ml.ml_line_count)
17848 return NULL; /* invalid line number */
17850 /* Get the column number */
17851 pos.col = list_find_nr(l, 1L, &error);
17852 if (error)
17853 return NULL;
17854 len = (long)STRLEN(ml_get(pos.lnum));
17856 /* We accept "$" for the column number: last column. */
17857 li = list_find(l, 1L);
17858 if (li != NULL && li->li_tv.v_type == VAR_STRING
17859 && li->li_tv.vval.v_string != NULL
17860 && STRCMP(li->li_tv.vval.v_string, "$") == 0)
17861 pos.col = len + 1;
17863 /* Accept a position up to the NUL after the line. */
17864 if (pos.col == 0 || (int)pos.col > len + 1)
17865 return NULL; /* invalid column number */
17866 --pos.col;
17868 #ifdef FEAT_VIRTUALEDIT
17869 /* Get the virtual offset. Defaults to zero. */
17870 pos.coladd = list_find_nr(l, 2L, &error);
17871 if (error)
17872 pos.coladd = 0;
17873 #endif
17875 return &pos;
17878 name = get_tv_string_chk(varp);
17879 if (name == NULL)
17880 return NULL;
17881 if (name[0] == '.') /* cursor */
17882 return &curwin->w_cursor;
17883 #ifdef FEAT_VISUAL
17884 if (name[0] == 'v' && name[1] == NUL) /* Visual start */
17886 if (VIsual_active)
17887 return &VIsual;
17888 return &curwin->w_cursor;
17890 #endif
17891 if (name[0] == '\'') /* mark */
17893 pp = getmark_fnum(name[1], FALSE, fnum);
17894 if (pp == NULL || pp == (pos_T *)-1 || pp->lnum <= 0)
17895 return NULL;
17896 return pp;
17899 #ifdef FEAT_VIRTUALEDIT
17900 pos.coladd = 0;
17901 #endif
17903 if (name[0] == 'w' && dollar_lnum)
17905 pos.col = 0;
17906 if (name[1] == '0') /* "w0": first visible line */
17908 update_topline();
17909 pos.lnum = curwin->w_topline;
17910 return &pos;
17912 else if (name[1] == '$') /* "w$": last visible line */
17914 validate_botline();
17915 pos.lnum = curwin->w_botline - 1;
17916 return &pos;
17919 else if (name[0] == '$') /* last column or line */
17921 if (dollar_lnum)
17923 pos.lnum = curbuf->b_ml.ml_line_count;
17924 pos.col = 0;
17926 else
17928 pos.lnum = curwin->w_cursor.lnum;
17929 pos.col = (colnr_T)STRLEN(ml_get_curline());
17931 return &pos;
17933 return NULL;
17937 * Convert list in "arg" into a position and optional file number.
17938 * When "fnump" is NULL there is no file number, only 3 items.
17939 * Note that the column is passed on as-is, the caller may want to decrement
17940 * it to use 1 for the first column.
17941 * Return FAIL when conversion is not possible, doesn't check the position for
17942 * validity.
17944 static int
17945 list2fpos(arg, posp, fnump)
17946 typval_T *arg;
17947 pos_T *posp;
17948 int *fnump;
17950 list_T *l = arg->vval.v_list;
17951 long i = 0;
17952 long n;
17954 /* List must be: [fnum, lnum, col, coladd], where "fnum" is only there
17955 * when "fnump" isn't NULL and "coladd" is optional. */
17956 if (arg->v_type != VAR_LIST
17957 || l == NULL
17958 || l->lv_len < (fnump == NULL ? 2 : 3)
17959 || l->lv_len > (fnump == NULL ? 3 : 4))
17960 return FAIL;
17962 if (fnump != NULL)
17964 n = list_find_nr(l, i++, NULL); /* fnum */
17965 if (n < 0)
17966 return FAIL;
17967 if (n == 0)
17968 n = curbuf->b_fnum; /* current buffer */
17969 *fnump = n;
17972 n = list_find_nr(l, i++, NULL); /* lnum */
17973 if (n < 0)
17974 return FAIL;
17975 posp->lnum = n;
17977 n = list_find_nr(l, i++, NULL); /* col */
17978 if (n < 0)
17979 return FAIL;
17980 posp->col = n;
17982 #ifdef FEAT_VIRTUALEDIT
17983 n = list_find_nr(l, i, NULL);
17984 if (n < 0)
17985 posp->coladd = 0;
17986 else
17987 posp->coladd = n;
17988 #endif
17990 return OK;
17994 * Get the length of an environment variable name.
17995 * Advance "arg" to the first character after the name.
17996 * Return 0 for error.
17998 static int
17999 get_env_len(arg)
18000 char_u **arg;
18002 char_u *p;
18003 int len;
18005 for (p = *arg; vim_isIDc(*p); ++p)
18007 if (p == *arg) /* no name found */
18008 return 0;
18010 len = (int)(p - *arg);
18011 *arg = p;
18012 return len;
18016 * Get the length of the name of a function or internal variable.
18017 * "arg" is advanced to the first non-white character after the name.
18018 * Return 0 if something is wrong.
18020 static int
18021 get_id_len(arg)
18022 char_u **arg;
18024 char_u *p;
18025 int len;
18027 /* Find the end of the name. */
18028 for (p = *arg; eval_isnamec(*p); ++p)
18030 if (p == *arg) /* no name found */
18031 return 0;
18033 len = (int)(p - *arg);
18034 *arg = skipwhite(p);
18036 return len;
18040 * Get the length of the name of a variable or function.
18041 * Only the name is recognized, does not handle ".key" or "[idx]".
18042 * "arg" is advanced to the first non-white character after the name.
18043 * Return -1 if curly braces expansion failed.
18044 * Return 0 if something else is wrong.
18045 * If the name contains 'magic' {}'s, expand them and return the
18046 * expanded name in an allocated string via 'alias' - caller must free.
18048 static int
18049 get_name_len(arg, alias, evaluate, verbose)
18050 char_u **arg;
18051 char_u **alias;
18052 int evaluate;
18053 int verbose;
18055 int len;
18056 char_u *p;
18057 char_u *expr_start;
18058 char_u *expr_end;
18060 *alias = NULL; /* default to no alias */
18062 if ((*arg)[0] == K_SPECIAL && (*arg)[1] == KS_EXTRA
18063 && (*arg)[2] == (int)KE_SNR)
18065 /* hard coded <SNR>, already translated */
18066 *arg += 3;
18067 return get_id_len(arg) + 3;
18069 len = eval_fname_script(*arg);
18070 if (len > 0)
18072 /* literal "<SID>", "s:" or "<SNR>" */
18073 *arg += len;
18077 * Find the end of the name; check for {} construction.
18079 p = find_name_end(*arg, &expr_start, &expr_end,
18080 len > 0 ? 0 : FNE_CHECK_START);
18081 if (expr_start != NULL)
18083 char_u *temp_string;
18085 if (!evaluate)
18087 len += (int)(p - *arg);
18088 *arg = skipwhite(p);
18089 return len;
18093 * Include any <SID> etc in the expanded string:
18094 * Thus the -len here.
18096 temp_string = make_expanded_name(*arg - len, expr_start, expr_end, p);
18097 if (temp_string == NULL)
18098 return -1;
18099 *alias = temp_string;
18100 *arg = skipwhite(p);
18101 return (int)STRLEN(temp_string);
18104 len += get_id_len(arg);
18105 if (len == 0 && verbose)
18106 EMSG2(_(e_invexpr2), *arg);
18108 return len;
18112 * Find the end of a variable or function name, taking care of magic braces.
18113 * If "expr_start" is not NULL then "expr_start" and "expr_end" are set to the
18114 * start and end of the first magic braces item.
18115 * "flags" can have FNE_INCL_BR and FNE_CHECK_START.
18116 * Return a pointer to just after the name. Equal to "arg" if there is no
18117 * valid name.
18119 static char_u *
18120 find_name_end(arg, expr_start, expr_end, flags)
18121 char_u *arg;
18122 char_u **expr_start;
18123 char_u **expr_end;
18124 int flags;
18126 int mb_nest = 0;
18127 int br_nest = 0;
18128 char_u *p;
18130 if (expr_start != NULL)
18132 *expr_start = NULL;
18133 *expr_end = NULL;
18136 /* Quick check for valid starting character. */
18137 if ((flags & FNE_CHECK_START) && !eval_isnamec1(*arg) && *arg != '{')
18138 return arg;
18140 for (p = arg; *p != NUL
18141 && (eval_isnamec(*p)
18142 || *p == '{'
18143 || ((flags & FNE_INCL_BR) && (*p == '[' || *p == '.'))
18144 || mb_nest != 0
18145 || br_nest != 0); mb_ptr_adv(p))
18147 if (*p == '\'')
18149 /* skip over 'string' to avoid counting [ and ] inside it. */
18150 for (p = p + 1; *p != NUL && *p != '\''; mb_ptr_adv(p))
18152 if (*p == NUL)
18153 break;
18155 else if (*p == '"')
18157 /* skip over "str\"ing" to avoid counting [ and ] inside it. */
18158 for (p = p + 1; *p != NUL && *p != '"'; mb_ptr_adv(p))
18159 if (*p == '\\' && p[1] != NUL)
18160 ++p;
18161 if (*p == NUL)
18162 break;
18165 if (mb_nest == 0)
18167 if (*p == '[')
18168 ++br_nest;
18169 else if (*p == ']')
18170 --br_nest;
18173 if (br_nest == 0)
18175 if (*p == '{')
18177 mb_nest++;
18178 if (expr_start != NULL && *expr_start == NULL)
18179 *expr_start = p;
18181 else if (*p == '}')
18183 mb_nest--;
18184 if (expr_start != NULL && mb_nest == 0 && *expr_end == NULL)
18185 *expr_end = p;
18190 return p;
18194 * Expands out the 'magic' {}'s in a variable/function name.
18195 * Note that this can call itself recursively, to deal with
18196 * constructs like foo{bar}{baz}{bam}
18197 * The four pointer arguments point to "foo{expre}ss{ion}bar"
18198 * "in_start" ^
18199 * "expr_start" ^
18200 * "expr_end" ^
18201 * "in_end" ^
18203 * Returns a new allocated string, which the caller must free.
18204 * Returns NULL for failure.
18206 static char_u *
18207 make_expanded_name(in_start, expr_start, expr_end, in_end)
18208 char_u *in_start;
18209 char_u *expr_start;
18210 char_u *expr_end;
18211 char_u *in_end;
18213 char_u c1;
18214 char_u *retval = NULL;
18215 char_u *temp_result;
18216 char_u *nextcmd = NULL;
18218 if (expr_end == NULL || in_end == NULL)
18219 return NULL;
18220 *expr_start = NUL;
18221 *expr_end = NUL;
18222 c1 = *in_end;
18223 *in_end = NUL;
18225 temp_result = eval_to_string(expr_start + 1, &nextcmd, FALSE);
18226 if (temp_result != NULL && nextcmd == NULL)
18228 retval = alloc((unsigned)(STRLEN(temp_result) + (expr_start - in_start)
18229 + (in_end - expr_end) + 1));
18230 if (retval != NULL)
18232 STRCPY(retval, in_start);
18233 STRCAT(retval, temp_result);
18234 STRCAT(retval, expr_end + 1);
18237 vim_free(temp_result);
18239 *in_end = c1; /* put char back for error messages */
18240 *expr_start = '{';
18241 *expr_end = '}';
18243 if (retval != NULL)
18245 temp_result = find_name_end(retval, &expr_start, &expr_end, 0);
18246 if (expr_start != NULL)
18248 /* Further expansion! */
18249 temp_result = make_expanded_name(retval, expr_start,
18250 expr_end, temp_result);
18251 vim_free(retval);
18252 retval = temp_result;
18256 return retval;
18260 * Return TRUE if character "c" can be used in a variable or function name.
18261 * Does not include '{' or '}' for magic braces.
18263 static int
18264 eval_isnamec(c)
18265 int c;
18267 return (ASCII_ISALNUM(c) || c == '_' || c == ':' || c == AUTOLOAD_CHAR);
18271 * Return TRUE if character "c" can be used as the first character in a
18272 * variable or function name (excluding '{' and '}').
18274 static int
18275 eval_isnamec1(c)
18276 int c;
18278 return (ASCII_ISALPHA(c) || c == '_');
18282 * Set number v: variable to "val".
18284 void
18285 set_vim_var_nr(idx, val)
18286 int idx;
18287 long val;
18289 vimvars[idx].vv_nr = val;
18293 * Get number v: variable value.
18295 long
18296 get_vim_var_nr(idx)
18297 int idx;
18299 return vimvars[idx].vv_nr;
18303 * Get string v: variable value. Uses a static buffer, can only be used once.
18305 char_u *
18306 get_vim_var_str(idx)
18307 int idx;
18309 return get_tv_string(&vimvars[idx].vv_tv);
18313 * Get List v: variable value. Caller must take care of reference count when
18314 * needed.
18316 list_T *
18317 get_vim_var_list(idx)
18318 int idx;
18320 return vimvars[idx].vv_list;
18324 * Set v:char to character "c".
18326 void
18327 set_vim_var_char(c)
18328 int c;
18330 #ifdef FEAT_MBYTE
18331 char_u buf[MB_MAXBYTES];
18332 #else
18333 char_u buf[2];
18334 #endif
18336 #ifdef FEAT_MBYTE
18337 if (has_mbyte)
18338 buf[(*mb_char2bytes)(c, buf)] = NUL;
18339 else
18340 #endif
18342 buf[0] = c;
18343 buf[1] = NUL;
18345 set_vim_var_string(VV_CHAR, buf, -1);
18349 * Set v:count to "count" and v:count1 to "count1".
18350 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
18352 void
18353 set_vcount(count, count1, set_prevcount)
18354 long count;
18355 long count1;
18356 int set_prevcount;
18358 if (set_prevcount)
18359 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
18360 vimvars[VV_COUNT].vv_nr = count;
18361 vimvars[VV_COUNT1].vv_nr = count1;
18365 * Set string v: variable to a copy of "val".
18367 void
18368 set_vim_var_string(idx, val, len)
18369 int idx;
18370 char_u *val;
18371 int len; /* length of "val" to use or -1 (whole string) */
18373 /* Need to do this (at least) once, since we can't initialize a union.
18374 * Will always be invoked when "v:progname" is set. */
18375 vimvars[VV_VERSION].vv_nr = VIM_VERSION_100;
18377 vim_free(vimvars[idx].vv_str);
18378 if (val == NULL)
18379 vimvars[idx].vv_str = NULL;
18380 else if (len == -1)
18381 vimvars[idx].vv_str = vim_strsave(val);
18382 else
18383 vimvars[idx].vv_str = vim_strnsave(val, len);
18387 * Set List v: variable to "val".
18389 void
18390 set_vim_var_list(idx, val)
18391 int idx;
18392 list_T *val;
18394 list_unref(vimvars[idx].vv_list);
18395 vimvars[idx].vv_list = val;
18396 if (val != NULL)
18397 ++val->lv_refcount;
18401 * Set v:register if needed.
18403 void
18404 set_reg_var(c)
18405 int c;
18407 char_u regname;
18409 if (c == 0 || c == ' ')
18410 regname = '"';
18411 else
18412 regname = c;
18413 /* Avoid free/alloc when the value is already right. */
18414 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
18415 set_vim_var_string(VV_REG, &regname, 1);
18419 * Get or set v:exception. If "oldval" == NULL, return the current value.
18420 * Otherwise, restore the value to "oldval" and return NULL.
18421 * Must always be called in pairs to save and restore v:exception! Does not
18422 * take care of memory allocations.
18424 char_u *
18425 v_exception(oldval)
18426 char_u *oldval;
18428 if (oldval == NULL)
18429 return vimvars[VV_EXCEPTION].vv_str;
18431 vimvars[VV_EXCEPTION].vv_str = oldval;
18432 return NULL;
18436 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
18437 * Otherwise, restore the value to "oldval" and return NULL.
18438 * Must always be called in pairs to save and restore v:throwpoint! Does not
18439 * take care of memory allocations.
18441 char_u *
18442 v_throwpoint(oldval)
18443 char_u *oldval;
18445 if (oldval == NULL)
18446 return vimvars[VV_THROWPOINT].vv_str;
18448 vimvars[VV_THROWPOINT].vv_str = oldval;
18449 return NULL;
18452 #if defined(FEAT_AUTOCMD) || defined(PROTO)
18454 * Set v:cmdarg.
18455 * If "eap" != NULL, use "eap" to generate the value and return the old value.
18456 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
18457 * Must always be called in pairs!
18459 char_u *
18460 set_cmdarg(eap, oldarg)
18461 exarg_T *eap;
18462 char_u *oldarg;
18464 char_u *oldval;
18465 char_u *newval;
18466 unsigned len;
18468 oldval = vimvars[VV_CMDARG].vv_str;
18469 if (eap == NULL)
18471 vim_free(oldval);
18472 vimvars[VV_CMDARG].vv_str = oldarg;
18473 return NULL;
18476 if (eap->force_bin == FORCE_BIN)
18477 len = 6;
18478 else if (eap->force_bin == FORCE_NOBIN)
18479 len = 8;
18480 else
18481 len = 0;
18483 if (eap->read_edit)
18484 len += 7;
18486 if (eap->force_ff != 0)
18487 len += (unsigned)STRLEN(eap->cmd + eap->force_ff) + 6;
18488 # ifdef FEAT_MBYTE
18489 if (eap->force_enc != 0)
18490 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
18491 if (eap->bad_char != 0)
18492 len += (unsigned)STRLEN(eap->cmd + eap->bad_char) + 7;
18493 # endif
18495 newval = alloc(len + 1);
18496 if (newval == NULL)
18497 return NULL;
18499 if (eap->force_bin == FORCE_BIN)
18500 sprintf((char *)newval, " ++bin");
18501 else if (eap->force_bin == FORCE_NOBIN)
18502 sprintf((char *)newval, " ++nobin");
18503 else
18504 *newval = NUL;
18506 if (eap->read_edit)
18507 STRCAT(newval, " ++edit");
18509 if (eap->force_ff != 0)
18510 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
18511 eap->cmd + eap->force_ff);
18512 # ifdef FEAT_MBYTE
18513 if (eap->force_enc != 0)
18514 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
18515 eap->cmd + eap->force_enc);
18516 if (eap->bad_char != 0)
18517 sprintf((char *)newval + STRLEN(newval), " ++bad=%s",
18518 eap->cmd + eap->bad_char);
18519 # endif
18520 vimvars[VV_CMDARG].vv_str = newval;
18521 return oldval;
18523 #endif
18526 * Get the value of internal variable "name".
18527 * Return OK or FAIL.
18529 static int
18530 get_var_tv(name, len, rettv, verbose)
18531 char_u *name;
18532 int len; /* length of "name" */
18533 typval_T *rettv; /* NULL when only checking existence */
18534 int verbose; /* may give error message */
18536 int ret = OK;
18537 typval_T *tv = NULL;
18538 typval_T atv;
18539 dictitem_T *v;
18540 int cc;
18542 /* truncate the name, so that we can use strcmp() */
18543 cc = name[len];
18544 name[len] = NUL;
18547 * Check for "b:changedtick".
18549 if (STRCMP(name, "b:changedtick") == 0)
18551 atv.v_type = VAR_NUMBER;
18552 atv.vval.v_number = curbuf->b_changedtick;
18553 tv = &atv;
18557 * Check for user-defined variables.
18559 else
18561 v = find_var(name, NULL);
18562 if (v != NULL)
18563 tv = &v->di_tv;
18566 if (tv == NULL)
18568 if (rettv != NULL && verbose)
18569 EMSG2(_(e_undefvar), name);
18570 ret = FAIL;
18572 else if (rettv != NULL)
18573 copy_tv(tv, rettv);
18575 name[len] = cc;
18577 return ret;
18581 * Handle expr[expr], expr[expr:expr] subscript and .name lookup.
18582 * Also handle function call with Funcref variable: func(expr)
18583 * Can all be combined: dict.func(expr)[idx]['func'](expr)
18585 static int
18586 handle_subscript(arg, rettv, evaluate, verbose)
18587 char_u **arg;
18588 typval_T *rettv;
18589 int evaluate; /* do more than finding the end */
18590 int verbose; /* give error messages */
18592 int ret = OK;
18593 dict_T *selfdict = NULL;
18594 char_u *s;
18595 int len;
18596 typval_T functv;
18598 while (ret == OK
18599 && (**arg == '['
18600 || (**arg == '.' && rettv->v_type == VAR_DICT)
18601 || (**arg == '(' && rettv->v_type == VAR_FUNC))
18602 && !vim_iswhite(*(*arg - 1)))
18604 if (**arg == '(')
18606 /* need to copy the funcref so that we can clear rettv */
18607 functv = *rettv;
18608 rettv->v_type = VAR_UNKNOWN;
18610 /* Invoke the function. Recursive! */
18611 s = functv.vval.v_string;
18612 ret = get_func_tv(s, (int)STRLEN(s), rettv, arg,
18613 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
18614 &len, evaluate, selfdict);
18616 /* Clear the funcref afterwards, so that deleting it while
18617 * evaluating the arguments is possible (see test55). */
18618 clear_tv(&functv);
18620 /* Stop the expression evaluation when immediately aborting on
18621 * error, or when an interrupt occurred or an exception was thrown
18622 * but not caught. */
18623 if (aborting())
18625 if (ret == OK)
18626 clear_tv(rettv);
18627 ret = FAIL;
18629 dict_unref(selfdict);
18630 selfdict = NULL;
18632 else /* **arg == '[' || **arg == '.' */
18634 dict_unref(selfdict);
18635 if (rettv->v_type == VAR_DICT)
18637 selfdict = rettv->vval.v_dict;
18638 if (selfdict != NULL)
18639 ++selfdict->dv_refcount;
18641 else
18642 selfdict = NULL;
18643 if (eval_index(arg, rettv, evaluate, verbose) == FAIL)
18645 clear_tv(rettv);
18646 ret = FAIL;
18650 dict_unref(selfdict);
18651 return ret;
18655 * Allocate memory for a variable type-value, and make it empty (0 or NULL
18656 * value).
18658 static typval_T *
18659 alloc_tv()
18661 return (typval_T *)alloc_clear((unsigned)sizeof(typval_T));
18665 * Allocate memory for a variable type-value, and assign a string to it.
18666 * The string "s" must have been allocated, it is consumed.
18667 * Return NULL for out of memory, the variable otherwise.
18669 static typval_T *
18670 alloc_string_tv(s)
18671 char_u *s;
18673 typval_T *rettv;
18675 rettv = alloc_tv();
18676 if (rettv != NULL)
18678 rettv->v_type = VAR_STRING;
18679 rettv->vval.v_string = s;
18681 else
18682 vim_free(s);
18683 return rettv;
18687 * Free the memory for a variable type-value.
18689 void
18690 free_tv(varp)
18691 typval_T *varp;
18693 if (varp != NULL)
18695 switch (varp->v_type)
18697 case VAR_FUNC:
18698 func_unref(varp->vval.v_string);
18699 /*FALLTHROUGH*/
18700 case VAR_STRING:
18701 vim_free(varp->vval.v_string);
18702 break;
18703 case VAR_LIST:
18704 list_unref(varp->vval.v_list);
18705 break;
18706 case VAR_DICT:
18707 dict_unref(varp->vval.v_dict);
18708 break;
18709 case VAR_NUMBER:
18710 #ifdef FEAT_FLOAT
18711 case VAR_FLOAT:
18712 #endif
18713 case VAR_UNKNOWN:
18714 break;
18715 default:
18716 EMSG2(_(e_intern2), "free_tv()");
18717 break;
18719 vim_free(varp);
18724 * Free the memory for a variable value and set the value to NULL or 0.
18726 void
18727 clear_tv(varp)
18728 typval_T *varp;
18730 if (varp != NULL)
18732 switch (varp->v_type)
18734 case VAR_FUNC:
18735 func_unref(varp->vval.v_string);
18736 /*FALLTHROUGH*/
18737 case VAR_STRING:
18738 vim_free(varp->vval.v_string);
18739 varp->vval.v_string = NULL;
18740 break;
18741 case VAR_LIST:
18742 list_unref(varp->vval.v_list);
18743 varp->vval.v_list = NULL;
18744 break;
18745 case VAR_DICT:
18746 dict_unref(varp->vval.v_dict);
18747 varp->vval.v_dict = NULL;
18748 break;
18749 case VAR_NUMBER:
18750 varp->vval.v_number = 0;
18751 break;
18752 #ifdef FEAT_FLOAT
18753 case VAR_FLOAT:
18754 varp->vval.v_float = 0.0;
18755 break;
18756 #endif
18757 case VAR_UNKNOWN:
18758 break;
18759 default:
18760 EMSG2(_(e_intern2), "clear_tv()");
18762 varp->v_lock = 0;
18767 * Set the value of a variable to NULL without freeing items.
18769 static void
18770 init_tv(varp)
18771 typval_T *varp;
18773 if (varp != NULL)
18774 vim_memset(varp, 0, sizeof(typval_T));
18778 * Get the number value of a variable.
18779 * If it is a String variable, uses vim_str2nr().
18780 * For incompatible types, return 0.
18781 * get_tv_number_chk() is similar to get_tv_number(), but informs the
18782 * caller of incompatible types: it sets *denote to TRUE if "denote"
18783 * is not NULL or returns -1 otherwise.
18785 static long
18786 get_tv_number(varp)
18787 typval_T *varp;
18789 int error = FALSE;
18791 return get_tv_number_chk(varp, &error); /* return 0L on error */
18794 long
18795 get_tv_number_chk(varp, denote)
18796 typval_T *varp;
18797 int *denote;
18799 long n = 0L;
18801 switch (varp->v_type)
18803 case VAR_NUMBER:
18804 return (long)(varp->vval.v_number);
18805 #ifdef FEAT_FLOAT
18806 case VAR_FLOAT:
18807 EMSG(_("E805: Using a Float as a Number"));
18808 break;
18809 #endif
18810 case VAR_FUNC:
18811 EMSG(_("E703: Using a Funcref as a Number"));
18812 break;
18813 case VAR_STRING:
18814 if (varp->vval.v_string != NULL)
18815 vim_str2nr(varp->vval.v_string, NULL, NULL,
18816 TRUE, TRUE, &n, NULL);
18817 return n;
18818 case VAR_LIST:
18819 EMSG(_("E745: Using a List as a Number"));
18820 break;
18821 case VAR_DICT:
18822 EMSG(_("E728: Using a Dictionary as a Number"));
18823 break;
18824 default:
18825 EMSG2(_(e_intern2), "get_tv_number()");
18826 break;
18828 if (denote == NULL) /* useful for values that must be unsigned */
18829 n = -1;
18830 else
18831 *denote = TRUE;
18832 return n;
18836 * Get the lnum from the first argument.
18837 * Also accepts ".", "$", etc., but that only works for the current buffer.
18838 * Returns -1 on error.
18840 static linenr_T
18841 get_tv_lnum(argvars)
18842 typval_T *argvars;
18844 typval_T rettv;
18845 linenr_T lnum;
18847 lnum = get_tv_number_chk(&argvars[0], NULL);
18848 if (lnum == 0) /* no valid number, try using line() */
18850 rettv.v_type = VAR_NUMBER;
18851 f_line(argvars, &rettv);
18852 lnum = rettv.vval.v_number;
18853 clear_tv(&rettv);
18855 return lnum;
18859 * Get the lnum from the first argument.
18860 * Also accepts "$", then "buf" is used.
18861 * Returns 0 on error.
18863 static linenr_T
18864 get_tv_lnum_buf(argvars, buf)
18865 typval_T *argvars;
18866 buf_T *buf;
18868 if (argvars[0].v_type == VAR_STRING
18869 && argvars[0].vval.v_string != NULL
18870 && argvars[0].vval.v_string[0] == '$'
18871 && buf != NULL)
18872 return buf->b_ml.ml_line_count;
18873 return get_tv_number_chk(&argvars[0], NULL);
18877 * Get the string value of a variable.
18878 * If it is a Number variable, the number is converted into a string.
18879 * get_tv_string() uses a single, static buffer. YOU CAN ONLY USE IT ONCE!
18880 * get_tv_string_buf() uses a given buffer.
18881 * If the String variable has never been set, return an empty string.
18882 * Never returns NULL;
18883 * get_tv_string_chk() and get_tv_string_buf_chk() are similar, but return
18884 * NULL on error.
18886 static char_u *
18887 get_tv_string(varp)
18888 typval_T *varp;
18890 static char_u mybuf[NUMBUFLEN];
18892 return get_tv_string_buf(varp, mybuf);
18895 static char_u *
18896 get_tv_string_buf(varp, buf)
18897 typval_T *varp;
18898 char_u *buf;
18900 char_u *res = get_tv_string_buf_chk(varp, buf);
18902 return res != NULL ? res : (char_u *)"";
18905 char_u *
18906 get_tv_string_chk(varp)
18907 typval_T *varp;
18909 static char_u mybuf[NUMBUFLEN];
18911 return get_tv_string_buf_chk(varp, mybuf);
18914 static char_u *
18915 get_tv_string_buf_chk(varp, buf)
18916 typval_T *varp;
18917 char_u *buf;
18919 switch (varp->v_type)
18921 case VAR_NUMBER:
18922 sprintf((char *)buf, "%ld", (long)varp->vval.v_number);
18923 return buf;
18924 case VAR_FUNC:
18925 EMSG(_("E729: using Funcref as a String"));
18926 break;
18927 case VAR_LIST:
18928 EMSG(_("E730: using List as a String"));
18929 break;
18930 case VAR_DICT:
18931 EMSG(_("E731: using Dictionary as a String"));
18932 break;
18933 #ifdef FEAT_FLOAT
18934 case VAR_FLOAT:
18935 EMSG(_("E806: using Float as a String"));
18936 break;
18937 #endif
18938 case VAR_STRING:
18939 if (varp->vval.v_string != NULL)
18940 return varp->vval.v_string;
18941 return (char_u *)"";
18942 default:
18943 EMSG2(_(e_intern2), "get_tv_string_buf()");
18944 break;
18946 return NULL;
18950 * Find variable "name" in the list of variables.
18951 * Return a pointer to it if found, NULL if not found.
18952 * Careful: "a:0" variables don't have a name.
18953 * When "htp" is not NULL we are writing to the variable, set "htp" to the
18954 * hashtab_T used.
18956 static dictitem_T *
18957 find_var(name, htp)
18958 char_u *name;
18959 hashtab_T **htp;
18961 char_u *varname;
18962 hashtab_T *ht;
18964 ht = find_var_ht(name, &varname);
18965 if (htp != NULL)
18966 *htp = ht;
18967 if (ht == NULL)
18968 return NULL;
18969 return find_var_in_ht(ht, varname, htp != NULL);
18973 * Find variable "varname" in hashtab "ht".
18974 * Returns NULL if not found.
18976 static dictitem_T *
18977 find_var_in_ht(ht, varname, writing)
18978 hashtab_T *ht;
18979 char_u *varname;
18980 int writing;
18982 hashitem_T *hi;
18984 if (*varname == NUL)
18986 /* Must be something like "s:", otherwise "ht" would be NULL. */
18987 switch (varname[-2])
18989 case 's': return &SCRIPT_SV(current_SID).sv_var;
18990 case 'g': return &globvars_var;
18991 case 'v': return &vimvars_var;
18992 case 'b': return &curbuf->b_bufvar;
18993 case 'w': return &curwin->w_winvar;
18994 #ifdef FEAT_WINDOWS
18995 case 't': return &curtab->tp_winvar;
18996 #endif
18997 case 'l': return current_funccal == NULL
18998 ? NULL : &current_funccal->l_vars_var;
18999 case 'a': return current_funccal == NULL
19000 ? NULL : &current_funccal->l_avars_var;
19002 return NULL;
19005 hi = hash_find(ht, varname);
19006 if (HASHITEM_EMPTY(hi))
19008 /* For global variables we may try auto-loading the script. If it
19009 * worked find the variable again. Don't auto-load a script if it was
19010 * loaded already, otherwise it would be loaded every time when
19011 * checking if a function name is a Funcref variable. */
19012 if (ht == &globvarht && !writing
19013 && script_autoload(varname, FALSE) && !aborting())
19014 hi = hash_find(ht, varname);
19015 if (HASHITEM_EMPTY(hi))
19016 return NULL;
19018 return HI2DI(hi);
19022 * Find the hashtab used for a variable name.
19023 * Set "varname" to the start of name without ':'.
19025 static hashtab_T *
19026 find_var_ht(name, varname)
19027 char_u *name;
19028 char_u **varname;
19030 hashitem_T *hi;
19032 if (name[1] != ':')
19034 /* The name must not start with a colon or #. */
19035 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
19036 return NULL;
19037 *varname = name;
19039 /* "version" is "v:version" in all scopes */
19040 hi = hash_find(&compat_hashtab, name);
19041 if (!HASHITEM_EMPTY(hi))
19042 return &compat_hashtab;
19044 if (current_funccal == NULL)
19045 return &globvarht; /* global variable */
19046 return &current_funccal->l_vars.dv_hashtab; /* l: variable */
19048 *varname = name + 2;
19049 if (*name == 'g') /* global variable */
19050 return &globvarht;
19051 /* There must be no ':' or '#' in the rest of the name, unless g: is used
19053 if (vim_strchr(name + 2, ':') != NULL
19054 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
19055 return NULL;
19056 if (*name == 'b') /* buffer variable */
19057 return &curbuf->b_vars.dv_hashtab;
19058 if (*name == 'w') /* window variable */
19059 return &curwin->w_vars.dv_hashtab;
19060 #ifdef FEAT_WINDOWS
19061 if (*name == 't') /* tab page variable */
19062 return &curtab->tp_vars.dv_hashtab;
19063 #endif
19064 if (*name == 'v') /* v: variable */
19065 return &vimvarht;
19066 if (*name == 'a' && current_funccal != NULL) /* function argument */
19067 return &current_funccal->l_avars.dv_hashtab;
19068 if (*name == 'l' && current_funccal != NULL) /* local function variable */
19069 return &current_funccal->l_vars.dv_hashtab;
19070 if (*name == 's' /* script variable */
19071 && current_SID > 0 && current_SID <= ga_scripts.ga_len)
19072 return &SCRIPT_VARS(current_SID);
19073 return NULL;
19077 * Get the string value of a (global/local) variable.
19078 * Returns NULL when it doesn't exist.
19080 char_u *
19081 get_var_value(name)
19082 char_u *name;
19084 dictitem_T *v;
19086 v = find_var(name, NULL);
19087 if (v == NULL)
19088 return NULL;
19089 return get_tv_string(&v->di_tv);
19093 * Allocate a new hashtab for a sourced script. It will be used while
19094 * sourcing this script and when executing functions defined in the script.
19096 void
19097 new_script_vars(id)
19098 scid_T id;
19100 int i;
19101 hashtab_T *ht;
19102 scriptvar_T *sv;
19104 if (ga_grow(&ga_scripts, (int)(id - ga_scripts.ga_len)) == OK)
19106 /* Re-allocating ga_data means that an ht_array pointing to
19107 * ht_smallarray becomes invalid. We can recognize this: ht_mask is
19108 * at its init value. Also reset "v_dict", it's always the same. */
19109 for (i = 1; i <= ga_scripts.ga_len; ++i)
19111 ht = &SCRIPT_VARS(i);
19112 if (ht->ht_mask == HT_INIT_SIZE - 1)
19113 ht->ht_array = ht->ht_smallarray;
19114 sv = &SCRIPT_SV(i);
19115 sv->sv_var.di_tv.vval.v_dict = &sv->sv_dict;
19118 while (ga_scripts.ga_len < id)
19120 sv = &SCRIPT_SV(ga_scripts.ga_len + 1);
19121 init_var_dict(&sv->sv_dict, &sv->sv_var);
19122 ++ga_scripts.ga_len;
19128 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
19129 * point to it.
19131 void
19132 init_var_dict(dict, dict_var)
19133 dict_T *dict;
19134 dictitem_T *dict_var;
19136 hash_init(&dict->dv_hashtab);
19137 dict->dv_refcount = DO_NOT_FREE_CNT;
19138 dict->dv_copyID = 0;
19139 dict_var->di_tv.vval.v_dict = dict;
19140 dict_var->di_tv.v_type = VAR_DICT;
19141 dict_var->di_tv.v_lock = VAR_FIXED;
19142 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
19143 dict_var->di_key[0] = NUL;
19147 * Clean up a list of internal variables.
19148 * Frees all allocated variables and the value they contain.
19149 * Clears hashtab "ht", does not free it.
19151 void
19152 vars_clear(ht)
19153 hashtab_T *ht;
19155 vars_clear_ext(ht, TRUE);
19159 * Like vars_clear(), but only free the value if "free_val" is TRUE.
19161 static void
19162 vars_clear_ext(ht, free_val)
19163 hashtab_T *ht;
19164 int free_val;
19166 int todo;
19167 hashitem_T *hi;
19168 dictitem_T *v;
19170 hash_lock(ht);
19171 todo = (int)ht->ht_used;
19172 for (hi = ht->ht_array; todo > 0; ++hi)
19174 if (!HASHITEM_EMPTY(hi))
19176 --todo;
19178 /* Free the variable. Don't remove it from the hashtab,
19179 * ht_array might change then. hash_clear() takes care of it
19180 * later. */
19181 v = HI2DI(hi);
19182 if (free_val)
19183 clear_tv(&v->di_tv);
19184 if ((v->di_flags & DI_FLAGS_FIX) == 0)
19185 vim_free(v);
19188 hash_clear(ht);
19189 ht->ht_used = 0;
19193 * Delete a variable from hashtab "ht" at item "hi".
19194 * Clear the variable value and free the dictitem.
19196 static void
19197 delete_var(ht, hi)
19198 hashtab_T *ht;
19199 hashitem_T *hi;
19201 dictitem_T *di = HI2DI(hi);
19203 hash_remove(ht, hi);
19204 clear_tv(&di->di_tv);
19205 vim_free(di);
19209 * List the value of one internal variable.
19211 static void
19212 list_one_var(v, prefix, first)
19213 dictitem_T *v;
19214 char_u *prefix;
19215 int *first;
19217 char_u *tofree;
19218 char_u *s;
19219 char_u numbuf[NUMBUFLEN];
19221 current_copyID += COPYID_INC;
19222 s = echo_string(&v->di_tv, &tofree, numbuf, current_copyID);
19223 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
19224 s == NULL ? (char_u *)"" : s, first);
19225 vim_free(tofree);
19228 static void
19229 list_one_var_a(prefix, name, type, string, first)
19230 char_u *prefix;
19231 char_u *name;
19232 int type;
19233 char_u *string;
19234 int *first; /* when TRUE clear rest of screen and set to FALSE */
19236 /* don't use msg() or msg_attr() to avoid overwriting "v:statusmsg" */
19237 msg_start();
19238 msg_puts(prefix);
19239 if (name != NULL) /* "a:" vars don't have a name stored */
19240 msg_puts(name);
19241 msg_putchar(' ');
19242 msg_advance(22);
19243 if (type == VAR_NUMBER)
19244 msg_putchar('#');
19245 else if (type == VAR_FUNC)
19246 msg_putchar('*');
19247 else if (type == VAR_LIST)
19249 msg_putchar('[');
19250 if (*string == '[')
19251 ++string;
19253 else if (type == VAR_DICT)
19255 msg_putchar('{');
19256 if (*string == '{')
19257 ++string;
19259 else
19260 msg_putchar(' ');
19262 msg_outtrans(string);
19264 if (type == VAR_FUNC)
19265 msg_puts((char_u *)"()");
19266 if (*first)
19268 msg_clr_eos();
19269 *first = FALSE;
19274 * Set variable "name" to value in "tv".
19275 * If the variable already exists, the value is updated.
19276 * Otherwise the variable is created.
19278 static void
19279 set_var(name, tv, copy)
19280 char_u *name;
19281 typval_T *tv;
19282 int copy; /* make copy of value in "tv" */
19284 dictitem_T *v;
19285 char_u *varname;
19286 hashtab_T *ht;
19287 char_u *p;
19289 if (tv->v_type == VAR_FUNC)
19291 if (!(vim_strchr((char_u *)"wbs", name[0]) != NULL && name[1] == ':')
19292 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
19293 ? name[2] : name[0]))
19295 EMSG2(_("E704: Funcref variable name must start with a capital: %s"), name);
19296 return;
19298 if (function_exists(name))
19300 EMSG2(_("E705: Variable name conflicts with existing function: %s"),
19301 name);
19302 return;
19306 ht = find_var_ht(name, &varname);
19307 if (ht == NULL || *varname == NUL)
19309 EMSG2(_(e_illvar), name);
19310 return;
19313 v = find_var_in_ht(ht, varname, TRUE);
19314 if (v != NULL)
19316 /* existing variable, need to clear the value */
19317 if (var_check_ro(v->di_flags, name)
19318 || tv_check_lock(v->di_tv.v_lock, name))
19319 return;
19320 if (v->di_tv.v_type != tv->v_type
19321 && !((v->di_tv.v_type == VAR_STRING
19322 || v->di_tv.v_type == VAR_NUMBER)
19323 && (tv->v_type == VAR_STRING
19324 || tv->v_type == VAR_NUMBER))
19325 #ifdef FEAT_FLOAT
19326 && !((v->di_tv.v_type == VAR_NUMBER
19327 || v->di_tv.v_type == VAR_FLOAT)
19328 && (tv->v_type == VAR_NUMBER
19329 || tv->v_type == VAR_FLOAT))
19330 #endif
19333 EMSG2(_("E706: Variable type mismatch for: %s"), name);
19334 return;
19338 * Handle setting internal v: variables separately: we don't change
19339 * the type.
19341 if (ht == &vimvarht)
19343 if (v->di_tv.v_type == VAR_STRING)
19345 vim_free(v->di_tv.vval.v_string);
19346 if (copy || tv->v_type != VAR_STRING)
19347 v->di_tv.vval.v_string = vim_strsave(get_tv_string(tv));
19348 else
19350 /* Take over the string to avoid an extra alloc/free. */
19351 v->di_tv.vval.v_string = tv->vval.v_string;
19352 tv->vval.v_string = NULL;
19355 else if (v->di_tv.v_type != VAR_NUMBER)
19356 EMSG2(_(e_intern2), "set_var()");
19357 else
19359 v->di_tv.vval.v_number = get_tv_number(tv);
19360 if (STRCMP(varname, "searchforward") == 0)
19361 set_search_direction(v->di_tv.vval.v_number ? '/' : '?');
19363 return;
19366 clear_tv(&v->di_tv);
19368 else /* add a new variable */
19370 /* Can't add "v:" variable. */
19371 if (ht == &vimvarht)
19373 EMSG2(_(e_illvar), name);
19374 return;
19377 /* Make sure the variable name is valid. */
19378 for (p = varname; *p != NUL; ++p)
19379 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
19380 && *p != AUTOLOAD_CHAR)
19382 EMSG2(_(e_illvar), varname);
19383 return;
19386 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
19387 + STRLEN(varname)));
19388 if (v == NULL)
19389 return;
19390 STRCPY(v->di_key, varname);
19391 if (hash_add(ht, DI2HIKEY(v)) == FAIL)
19393 vim_free(v);
19394 return;
19396 v->di_flags = 0;
19399 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
19400 copy_tv(tv, &v->di_tv);
19401 else
19403 v->di_tv = *tv;
19404 v->di_tv.v_lock = 0;
19405 init_tv(tv);
19410 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
19411 * Also give an error message.
19413 static int
19414 var_check_ro(flags, name)
19415 int flags;
19416 char_u *name;
19418 if (flags & DI_FLAGS_RO)
19420 EMSG2(_(e_readonlyvar), name);
19421 return TRUE;
19423 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
19425 EMSG2(_(e_readonlysbx), name);
19426 return TRUE;
19428 return FALSE;
19432 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
19433 * Also give an error message.
19435 static int
19436 var_check_fixed(flags, name)
19437 int flags;
19438 char_u *name;
19440 if (flags & DI_FLAGS_FIX)
19442 EMSG2(_("E795: Cannot delete variable %s"), name);
19443 return TRUE;
19445 return FALSE;
19449 * Return TRUE if typeval "tv" is set to be locked (immutable).
19450 * Also give an error message, using "name".
19452 static int
19453 tv_check_lock(lock, name)
19454 int lock;
19455 char_u *name;
19457 if (lock & VAR_LOCKED)
19459 EMSG2(_("E741: Value is locked: %s"),
19460 name == NULL ? (char_u *)_("Unknown") : name);
19461 return TRUE;
19463 if (lock & VAR_FIXED)
19465 EMSG2(_("E742: Cannot change value of %s"),
19466 name == NULL ? (char_u *)_("Unknown") : name);
19467 return TRUE;
19469 return FALSE;
19473 * Copy the values from typval_T "from" to typval_T "to".
19474 * When needed allocates string or increases reference count.
19475 * Does not make a copy of a list or dict but copies the reference!
19476 * It is OK for "from" and "to" to point to the same item. This is used to
19477 * make a copy later.
19479 static void
19480 copy_tv(from, to)
19481 typval_T *from;
19482 typval_T *to;
19484 to->v_type = from->v_type;
19485 to->v_lock = 0;
19486 switch (from->v_type)
19488 case VAR_NUMBER:
19489 to->vval.v_number = from->vval.v_number;
19490 break;
19491 #ifdef FEAT_FLOAT
19492 case VAR_FLOAT:
19493 to->vval.v_float = from->vval.v_float;
19494 break;
19495 #endif
19496 case VAR_STRING:
19497 case VAR_FUNC:
19498 if (from->vval.v_string == NULL)
19499 to->vval.v_string = NULL;
19500 else
19502 to->vval.v_string = vim_strsave(from->vval.v_string);
19503 if (from->v_type == VAR_FUNC)
19504 func_ref(to->vval.v_string);
19506 break;
19507 case VAR_LIST:
19508 if (from->vval.v_list == NULL)
19509 to->vval.v_list = NULL;
19510 else
19512 to->vval.v_list = from->vval.v_list;
19513 ++to->vval.v_list->lv_refcount;
19515 break;
19516 case VAR_DICT:
19517 if (from->vval.v_dict == NULL)
19518 to->vval.v_dict = NULL;
19519 else
19521 to->vval.v_dict = from->vval.v_dict;
19522 ++to->vval.v_dict->dv_refcount;
19524 break;
19525 default:
19526 EMSG2(_(e_intern2), "copy_tv()");
19527 break;
19532 * Make a copy of an item.
19533 * Lists and Dictionaries are also copied. A deep copy if "deep" is set.
19534 * For deepcopy() "copyID" is zero for a full copy or the ID for when a
19535 * reference to an already copied list/dict can be used.
19536 * Returns FAIL or OK.
19538 static int
19539 item_copy(from, to, deep, copyID)
19540 typval_T *from;
19541 typval_T *to;
19542 int deep;
19543 int copyID;
19545 static int recurse = 0;
19546 int ret = OK;
19548 if (recurse >= DICT_MAXNEST)
19550 EMSG(_("E698: variable nested too deep for making a copy"));
19551 return FAIL;
19553 ++recurse;
19555 switch (from->v_type)
19557 case VAR_NUMBER:
19558 #ifdef FEAT_FLOAT
19559 case VAR_FLOAT:
19560 #endif
19561 case VAR_STRING:
19562 case VAR_FUNC:
19563 copy_tv(from, to);
19564 break;
19565 case VAR_LIST:
19566 to->v_type = VAR_LIST;
19567 to->v_lock = 0;
19568 if (from->vval.v_list == NULL)
19569 to->vval.v_list = NULL;
19570 else if (copyID != 0 && from->vval.v_list->lv_copyID == copyID)
19572 /* use the copy made earlier */
19573 to->vval.v_list = from->vval.v_list->lv_copylist;
19574 ++to->vval.v_list->lv_refcount;
19576 else
19577 to->vval.v_list = list_copy(from->vval.v_list, deep, copyID);
19578 if (to->vval.v_list == NULL)
19579 ret = FAIL;
19580 break;
19581 case VAR_DICT:
19582 to->v_type = VAR_DICT;
19583 to->v_lock = 0;
19584 if (from->vval.v_dict == NULL)
19585 to->vval.v_dict = NULL;
19586 else if (copyID != 0 && from->vval.v_dict->dv_copyID == copyID)
19588 /* use the copy made earlier */
19589 to->vval.v_dict = from->vval.v_dict->dv_copydict;
19590 ++to->vval.v_dict->dv_refcount;
19592 else
19593 to->vval.v_dict = dict_copy(from->vval.v_dict, deep, copyID);
19594 if (to->vval.v_dict == NULL)
19595 ret = FAIL;
19596 break;
19597 default:
19598 EMSG2(_(e_intern2), "item_copy()");
19599 ret = FAIL;
19601 --recurse;
19602 return ret;
19606 * ":echo expr1 ..." print each argument separated with a space, add a
19607 * newline at the end.
19608 * ":echon expr1 ..." print each argument plain.
19610 void
19611 ex_echo(eap)
19612 exarg_T *eap;
19614 char_u *arg = eap->arg;
19615 typval_T rettv;
19616 char_u *tofree;
19617 char_u *p;
19618 int needclr = TRUE;
19619 int atstart = TRUE;
19620 char_u numbuf[NUMBUFLEN];
19622 if (eap->skip)
19623 ++emsg_skip;
19624 while (*arg != NUL && *arg != '|' && *arg != '\n' && !got_int)
19626 /* If eval1() causes an error message the text from the command may
19627 * still need to be cleared. E.g., "echo 22,44". */
19628 need_clr_eos = needclr;
19630 p = arg;
19631 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19634 * Report the invalid expression unless the expression evaluation
19635 * has been cancelled due to an aborting error, an interrupt, or an
19636 * exception.
19638 if (!aborting())
19639 EMSG2(_(e_invexpr2), p);
19640 need_clr_eos = FALSE;
19641 break;
19643 need_clr_eos = FALSE;
19645 if (!eap->skip)
19647 if (atstart)
19649 atstart = FALSE;
19650 /* Call msg_start() after eval1(), evaluating the expression
19651 * may cause a message to appear. */
19652 if (eap->cmdidx == CMD_echo)
19653 msg_start();
19655 else if (eap->cmdidx == CMD_echo)
19656 msg_puts_attr((char_u *)" ", echo_attr);
19657 current_copyID += COPYID_INC;
19658 p = echo_string(&rettv, &tofree, numbuf, current_copyID);
19659 if (p != NULL)
19660 for ( ; *p != NUL && !got_int; ++p)
19662 if (*p == '\n' || *p == '\r' || *p == TAB)
19664 if (*p != TAB && needclr)
19666 /* remove any text still there from the command */
19667 msg_clr_eos();
19668 needclr = FALSE;
19670 msg_putchar_attr(*p, echo_attr);
19672 else
19674 #ifdef FEAT_MBYTE
19675 if (has_mbyte)
19677 int i = (*mb_ptr2len)(p);
19679 (void)msg_outtrans_len_attr(p, i, echo_attr);
19680 p += i - 1;
19682 else
19683 #endif
19684 (void)msg_outtrans_len_attr(p, 1, echo_attr);
19687 vim_free(tofree);
19689 clear_tv(&rettv);
19690 arg = skipwhite(arg);
19692 eap->nextcmd = check_nextcmd(arg);
19694 if (eap->skip)
19695 --emsg_skip;
19696 else
19698 /* remove text that may still be there from the command */
19699 if (needclr)
19700 msg_clr_eos();
19701 if (eap->cmdidx == CMD_echo)
19702 msg_end();
19707 * ":echohl {name}".
19709 void
19710 ex_echohl(eap)
19711 exarg_T *eap;
19713 int id;
19715 id = syn_name2id(eap->arg);
19716 if (id == 0)
19717 echo_attr = 0;
19718 else
19719 echo_attr = syn_id2attr(id);
19723 * ":execute expr1 ..." execute the result of an expression.
19724 * ":echomsg expr1 ..." Print a message
19725 * ":echoerr expr1 ..." Print an error
19726 * Each gets spaces around each argument and a newline at the end for
19727 * echo commands
19729 void
19730 ex_execute(eap)
19731 exarg_T *eap;
19733 char_u *arg = eap->arg;
19734 typval_T rettv;
19735 int ret = OK;
19736 char_u *p;
19737 garray_T ga;
19738 int len;
19739 int save_did_emsg;
19741 ga_init2(&ga, 1, 80);
19743 if (eap->skip)
19744 ++emsg_skip;
19745 while (*arg != NUL && *arg != '|' && *arg != '\n')
19747 p = arg;
19748 if (eval1(&arg, &rettv, !eap->skip) == FAIL)
19751 * Report the invalid expression unless the expression evaluation
19752 * has been cancelled due to an aborting error, an interrupt, or an
19753 * exception.
19755 if (!aborting())
19756 EMSG2(_(e_invexpr2), p);
19757 ret = FAIL;
19758 break;
19761 if (!eap->skip)
19763 p = get_tv_string(&rettv);
19764 len = (int)STRLEN(p);
19765 if (ga_grow(&ga, len + 2) == FAIL)
19767 clear_tv(&rettv);
19768 ret = FAIL;
19769 break;
19771 if (ga.ga_len)
19772 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
19773 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
19774 ga.ga_len += len;
19777 clear_tv(&rettv);
19778 arg = skipwhite(arg);
19781 if (ret != FAIL && ga.ga_data != NULL)
19783 if (eap->cmdidx == CMD_echomsg)
19785 MSG_ATTR(ga.ga_data, echo_attr);
19786 out_flush();
19788 else if (eap->cmdidx == CMD_echoerr)
19790 /* We don't want to abort following commands, restore did_emsg. */
19791 save_did_emsg = did_emsg;
19792 EMSG((char_u *)ga.ga_data);
19793 if (!force_abort)
19794 did_emsg = save_did_emsg;
19796 else if (eap->cmdidx == CMD_execute)
19797 do_cmdline((char_u *)ga.ga_data,
19798 eap->getline, eap->cookie, DOCMD_NOWAIT|DOCMD_VERBOSE);
19801 ga_clear(&ga);
19803 if (eap->skip)
19804 --emsg_skip;
19806 eap->nextcmd = check_nextcmd(arg);
19810 * Skip over the name of an option: "&option", "&g:option" or "&l:option".
19811 * "arg" points to the "&" or '+' when called, to "option" when returning.
19812 * Returns NULL when no option name found. Otherwise pointer to the char
19813 * after the option name.
19815 static char_u *
19816 find_option_end(arg, opt_flags)
19817 char_u **arg;
19818 int *opt_flags;
19820 char_u *p = *arg;
19822 ++p;
19823 if (*p == 'g' && p[1] == ':')
19825 *opt_flags = OPT_GLOBAL;
19826 p += 2;
19828 else if (*p == 'l' && p[1] == ':')
19830 *opt_flags = OPT_LOCAL;
19831 p += 2;
19833 else
19834 *opt_flags = 0;
19836 if (!ASCII_ISALPHA(*p))
19837 return NULL;
19838 *arg = p;
19840 if (p[0] == 't' && p[1] == '_' && p[2] != NUL && p[3] != NUL)
19841 p += 4; /* termcap option */
19842 else
19843 while (ASCII_ISALPHA(*p))
19844 ++p;
19845 return p;
19849 * ":function"
19851 void
19852 ex_function(eap)
19853 exarg_T *eap;
19855 char_u *theline;
19856 int j;
19857 int c;
19858 int saved_did_emsg;
19859 char_u *name = NULL;
19860 char_u *p;
19861 char_u *arg;
19862 char_u *line_arg = NULL;
19863 garray_T newargs;
19864 garray_T newlines;
19865 int varargs = FALSE;
19866 int mustend = FALSE;
19867 int flags = 0;
19868 ufunc_T *fp;
19869 int indent;
19870 int nesting;
19871 char_u *skip_until = NULL;
19872 dictitem_T *v;
19873 funcdict_T fudi;
19874 static int func_nr = 0; /* number for nameless function */
19875 int paren;
19876 hashtab_T *ht;
19877 int todo;
19878 hashitem_T *hi;
19879 int sourcing_lnum_off;
19882 * ":function" without argument: list functions.
19884 if (ends_excmd(*eap->arg))
19886 if (!eap->skip)
19888 todo = (int)func_hashtab.ht_used;
19889 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19891 if (!HASHITEM_EMPTY(hi))
19893 --todo;
19894 fp = HI2UF(hi);
19895 if (!isdigit(*fp->uf_name))
19896 list_func_head(fp, FALSE);
19900 eap->nextcmd = check_nextcmd(eap->arg);
19901 return;
19905 * ":function /pat": list functions matching pattern.
19907 if (*eap->arg == '/')
19909 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
19910 if (!eap->skip)
19912 regmatch_T regmatch;
19914 c = *p;
19915 *p = NUL;
19916 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
19917 *p = c;
19918 if (regmatch.regprog != NULL)
19920 regmatch.rm_ic = p_ic;
19922 todo = (int)func_hashtab.ht_used;
19923 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
19925 if (!HASHITEM_EMPTY(hi))
19927 --todo;
19928 fp = HI2UF(hi);
19929 if (!isdigit(*fp->uf_name)
19930 && vim_regexec(&regmatch, fp->uf_name, 0))
19931 list_func_head(fp, FALSE);
19934 vim_free(regmatch.regprog);
19937 if (*p == '/')
19938 ++p;
19939 eap->nextcmd = check_nextcmd(p);
19940 return;
19944 * Get the function name. There are these situations:
19945 * func normal function name
19946 * "name" == func, "fudi.fd_dict" == NULL
19947 * dict.func new dictionary entry
19948 * "name" == NULL, "fudi.fd_dict" set,
19949 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
19950 * dict.func existing dict entry with a Funcref
19951 * "name" == func, "fudi.fd_dict" set,
19952 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19953 * dict.func existing dict entry that's not a Funcref
19954 * "name" == NULL, "fudi.fd_dict" set,
19955 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
19957 p = eap->arg;
19958 name = trans_function_name(&p, eap->skip, 0, &fudi);
19959 paren = (vim_strchr(p, '(') != NULL);
19960 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
19963 * Return on an invalid expression in braces, unless the expression
19964 * evaluation has been cancelled due to an aborting error, an
19965 * interrupt, or an exception.
19967 if (!aborting())
19969 if (!eap->skip && fudi.fd_newkey != NULL)
19970 EMSG2(_(e_dictkey), fudi.fd_newkey);
19971 vim_free(fudi.fd_newkey);
19972 return;
19974 else
19975 eap->skip = TRUE;
19978 /* An error in a function call during evaluation of an expression in magic
19979 * braces should not cause the function not to be defined. */
19980 saved_did_emsg = did_emsg;
19981 did_emsg = FALSE;
19984 * ":function func" with only function name: list function.
19986 if (!paren)
19988 if (!ends_excmd(*skipwhite(p)))
19990 EMSG(_(e_trailing));
19991 goto ret_free;
19993 eap->nextcmd = check_nextcmd(p);
19994 if (eap->nextcmd != NULL)
19995 *p = NUL;
19996 if (!eap->skip && !got_int)
19998 fp = find_func(name);
19999 if (fp != NULL)
20001 list_func_head(fp, TRUE);
20002 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
20004 if (FUNCLINE(fp, j) == NULL)
20005 continue;
20006 msg_putchar('\n');
20007 msg_outnum((long)(j + 1));
20008 if (j < 9)
20009 msg_putchar(' ');
20010 if (j < 99)
20011 msg_putchar(' ');
20012 msg_prt_line(FUNCLINE(fp, j), FALSE);
20013 out_flush(); /* show a line at a time */
20014 ui_breakcheck();
20016 if (!got_int)
20018 msg_putchar('\n');
20019 msg_puts((char_u *)" endfunction");
20022 else
20023 emsg_funcname(N_("E123: Undefined function: %s"), name);
20025 goto ret_free;
20029 * ":function name(arg1, arg2)" Define function.
20031 p = skipwhite(p);
20032 if (*p != '(')
20034 if (!eap->skip)
20036 EMSG2(_("E124: Missing '(': %s"), eap->arg);
20037 goto ret_free;
20039 /* attempt to continue by skipping some text */
20040 if (vim_strchr(p, '(') != NULL)
20041 p = vim_strchr(p, '(');
20043 p = skipwhite(p + 1);
20045 ga_init2(&newargs, (int)sizeof(char_u *), 3);
20046 ga_init2(&newlines, (int)sizeof(char_u *), 3);
20048 if (!eap->skip)
20050 /* Check the name of the function. Unless it's a dictionary function
20051 * (that we are overwriting). */
20052 if (name != NULL)
20053 arg = name;
20054 else
20055 arg = fudi.fd_newkey;
20056 if (arg != NULL && (fudi.fd_di == NULL
20057 || fudi.fd_di->di_tv.v_type != VAR_FUNC))
20059 if (*arg == K_SPECIAL)
20060 j = 3;
20061 else
20062 j = 0;
20063 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
20064 : eval_isnamec(arg[j])))
20065 ++j;
20066 if (arg[j] != NUL)
20067 emsg_funcname((char *)e_invarg2, arg);
20072 * Isolate the arguments: "arg1, arg2, ...)"
20074 while (*p != ')')
20076 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
20078 varargs = TRUE;
20079 p += 3;
20080 mustend = TRUE;
20082 else
20084 arg = p;
20085 while (ASCII_ISALNUM(*p) || *p == '_')
20086 ++p;
20087 if (arg == p || isdigit(*arg)
20088 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
20089 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
20091 if (!eap->skip)
20092 EMSG2(_("E125: Illegal argument: %s"), arg);
20093 break;
20095 if (ga_grow(&newargs, 1) == FAIL)
20096 goto erret;
20097 c = *p;
20098 *p = NUL;
20099 arg = vim_strsave(arg);
20100 if (arg == NULL)
20101 goto erret;
20102 ((char_u **)(newargs.ga_data))[newargs.ga_len] = arg;
20103 *p = c;
20104 newargs.ga_len++;
20105 if (*p == ',')
20106 ++p;
20107 else
20108 mustend = TRUE;
20110 p = skipwhite(p);
20111 if (mustend && *p != ')')
20113 if (!eap->skip)
20114 EMSG2(_(e_invarg2), eap->arg);
20115 break;
20118 ++p; /* skip the ')' */
20120 /* find extra arguments "range", "dict" and "abort" */
20121 for (;;)
20123 p = skipwhite(p);
20124 if (STRNCMP(p, "range", 5) == 0)
20126 flags |= FC_RANGE;
20127 p += 5;
20129 else if (STRNCMP(p, "dict", 4) == 0)
20131 flags |= FC_DICT;
20132 p += 4;
20134 else if (STRNCMP(p, "abort", 5) == 0)
20136 flags |= FC_ABORT;
20137 p += 5;
20139 else
20140 break;
20143 /* When there is a line break use what follows for the function body.
20144 * Makes 'exe "func Test()\n...\nendfunc"' work. */
20145 if (*p == '\n')
20146 line_arg = p + 1;
20147 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
20148 EMSG(_(e_trailing));
20151 * Read the body of the function, until ":endfunction" is found.
20153 if (KeyTyped)
20155 /* Check if the function already exists, don't let the user type the
20156 * whole function before telling him it doesn't work! For a script we
20157 * need to skip the body to be able to find what follows. */
20158 if (!eap->skip && !eap->forceit)
20160 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
20161 EMSG(_(e_funcdict));
20162 else if (name != NULL && find_func(name) != NULL)
20163 emsg_funcname(e_funcexts, name);
20166 if (!eap->skip && did_emsg)
20167 goto erret;
20169 msg_putchar('\n'); /* don't overwrite the function name */
20170 cmdline_row = msg_row;
20173 indent = 2;
20174 nesting = 0;
20175 for (;;)
20177 msg_scroll = TRUE;
20178 need_wait_return = FALSE;
20179 sourcing_lnum_off = sourcing_lnum;
20181 if (line_arg != NULL)
20183 /* Use eap->arg, split up in parts by line breaks. */
20184 theline = line_arg;
20185 p = vim_strchr(theline, '\n');
20186 if (p == NULL)
20187 line_arg += STRLEN(line_arg);
20188 else
20190 *p = NUL;
20191 line_arg = p + 1;
20194 else if (eap->getline == NULL)
20195 theline = getcmdline(':', 0L, indent);
20196 else
20197 theline = eap->getline(':', eap->cookie, indent);
20198 if (KeyTyped)
20199 lines_left = Rows - 1;
20200 if (theline == NULL)
20202 EMSG(_("E126: Missing :endfunction"));
20203 goto erret;
20206 /* Detect line continuation: sourcing_lnum increased more than one. */
20207 if (sourcing_lnum > sourcing_lnum_off + 1)
20208 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
20209 else
20210 sourcing_lnum_off = 0;
20212 if (skip_until != NULL)
20214 /* between ":append" and "." and between ":python <<EOF" and "EOF"
20215 * don't check for ":endfunc". */
20216 if (STRCMP(theline, skip_until) == 0)
20218 vim_free(skip_until);
20219 skip_until = NULL;
20222 else
20224 /* skip ':' and blanks*/
20225 for (p = theline; vim_iswhite(*p) || *p == ':'; ++p)
20228 /* Check for "endfunction". */
20229 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
20231 if (line_arg == NULL)
20232 vim_free(theline);
20233 break;
20236 /* Increase indent inside "if", "while", "for" and "try", decrease
20237 * at "end". */
20238 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
20239 indent -= 2;
20240 else if (STRNCMP(p, "if", 2) == 0
20241 || STRNCMP(p, "wh", 2) == 0
20242 || STRNCMP(p, "for", 3) == 0
20243 || STRNCMP(p, "try", 3) == 0)
20244 indent += 2;
20246 /* Check for defining a function inside this function. */
20247 if (checkforcmd(&p, "function", 2))
20249 if (*p == '!')
20250 p = skipwhite(p + 1);
20251 p += eval_fname_script(p);
20252 if (ASCII_ISALPHA(*p))
20254 vim_free(trans_function_name(&p, TRUE, 0, NULL));
20255 if (*skipwhite(p) == '(')
20257 ++nesting;
20258 indent += 2;
20263 /* Check for ":append" or ":insert". */
20264 p = skip_range(p, NULL);
20265 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
20266 || (p[0] == 'i'
20267 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
20268 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
20269 skip_until = vim_strsave((char_u *)".");
20271 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
20272 arg = skipwhite(skiptowhite(p));
20273 if (arg[0] == '<' && arg[1] =='<'
20274 && ((p[0] == 'p' && p[1] == 'y'
20275 && (!ASCII_ISALPHA(p[2]) || p[2] == 't'))
20276 || (p[0] == 'p' && p[1] == 'e'
20277 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
20278 || (p[0] == 't' && p[1] == 'c'
20279 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
20280 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
20281 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
20282 || (p[0] == 'm' && p[1] == 'z'
20283 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
20286 /* ":python <<" continues until a dot, like ":append" */
20287 p = skipwhite(arg + 2);
20288 if (*p == NUL)
20289 skip_until = vim_strsave((char_u *)".");
20290 else
20291 skip_until = vim_strsave(p);
20295 /* Add the line to the function. */
20296 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
20298 if (line_arg == NULL)
20299 vim_free(theline);
20300 goto erret;
20303 /* Copy the line to newly allocated memory. get_one_sourceline()
20304 * allocates 250 bytes per line, this saves 80% on average. The cost
20305 * is an extra alloc/free. */
20306 p = vim_strsave(theline);
20307 if (p != NULL)
20309 if (line_arg == NULL)
20310 vim_free(theline);
20311 theline = p;
20314 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = theline;
20316 /* Add NULL lines for continuation lines, so that the line count is
20317 * equal to the index in the growarray. */
20318 while (sourcing_lnum_off-- > 0)
20319 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
20321 /* Check for end of eap->arg. */
20322 if (line_arg != NULL && *line_arg == NUL)
20323 line_arg = NULL;
20326 /* Don't define the function when skipping commands or when an error was
20327 * detected. */
20328 if (eap->skip || did_emsg)
20329 goto erret;
20332 * If there are no errors, add the function
20334 if (fudi.fd_dict == NULL)
20336 v = find_var(name, &ht);
20337 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
20339 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
20340 name);
20341 goto erret;
20344 fp = find_func(name);
20345 if (fp != NULL)
20347 if (!eap->forceit)
20349 emsg_funcname(e_funcexts, name);
20350 goto erret;
20352 if (fp->uf_calls > 0)
20354 emsg_funcname(N_("E127: Cannot redefine function %s: It is in use"),
20355 name);
20356 goto erret;
20358 /* redefine existing function */
20359 ga_clear_strings(&(fp->uf_args));
20360 ga_clear_strings(&(fp->uf_lines));
20361 vim_free(name);
20362 name = NULL;
20365 else
20367 char numbuf[20];
20369 fp = NULL;
20370 if (fudi.fd_newkey == NULL && !eap->forceit)
20372 EMSG(_(e_funcdict));
20373 goto erret;
20375 if (fudi.fd_di == NULL)
20377 /* Can't add a function to a locked dictionary */
20378 if (tv_check_lock(fudi.fd_dict->dv_lock, eap->arg))
20379 goto erret;
20381 /* Can't change an existing function if it is locked */
20382 else if (tv_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg))
20383 goto erret;
20385 /* Give the function a sequential number. Can only be used with a
20386 * Funcref! */
20387 vim_free(name);
20388 sprintf(numbuf, "%d", ++func_nr);
20389 name = vim_strsave((char_u *)numbuf);
20390 if (name == NULL)
20391 goto erret;
20394 if (fp == NULL)
20396 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
20398 int slen, plen;
20399 char_u *scriptname;
20401 /* Check that the autoload name matches the script name. */
20402 j = FAIL;
20403 if (sourcing_name != NULL)
20405 scriptname = autoload_name(name);
20406 if (scriptname != NULL)
20408 p = vim_strchr(scriptname, '/');
20409 plen = (int)STRLEN(p);
20410 slen = (int)STRLEN(sourcing_name);
20411 if (slen > plen && fnamecmp(p,
20412 sourcing_name + slen - plen) == 0)
20413 j = OK;
20414 vim_free(scriptname);
20417 if (j == FAIL)
20419 EMSG2(_("E746: Function name does not match script file name: %s"), name);
20420 goto erret;
20424 fp = (ufunc_T *)alloc((unsigned)(sizeof(ufunc_T) + STRLEN(name)));
20425 if (fp == NULL)
20426 goto erret;
20428 if (fudi.fd_dict != NULL)
20430 if (fudi.fd_di == NULL)
20432 /* add new dict entry */
20433 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
20434 if (fudi.fd_di == NULL)
20436 vim_free(fp);
20437 goto erret;
20439 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
20441 vim_free(fudi.fd_di);
20442 vim_free(fp);
20443 goto erret;
20446 else
20447 /* overwrite existing dict entry */
20448 clear_tv(&fudi.fd_di->di_tv);
20449 fudi.fd_di->di_tv.v_type = VAR_FUNC;
20450 fudi.fd_di->di_tv.v_lock = 0;
20451 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
20452 fp->uf_refcount = 1;
20454 /* behave like "dict" was used */
20455 flags |= FC_DICT;
20458 /* insert the new function in the function list */
20459 STRCPY(fp->uf_name, name);
20460 hash_add(&func_hashtab, UF2HIKEY(fp));
20462 fp->uf_args = newargs;
20463 fp->uf_lines = newlines;
20464 #ifdef FEAT_PROFILE
20465 fp->uf_tml_count = NULL;
20466 fp->uf_tml_total = NULL;
20467 fp->uf_tml_self = NULL;
20468 fp->uf_profiling = FALSE;
20469 if (prof_def_func())
20470 func_do_profile(fp);
20471 #endif
20472 fp->uf_varargs = varargs;
20473 fp->uf_flags = flags;
20474 fp->uf_calls = 0;
20475 fp->uf_script_ID = current_SID;
20476 goto ret_free;
20478 erret:
20479 ga_clear_strings(&newargs);
20480 ga_clear_strings(&newlines);
20481 ret_free:
20482 vim_free(skip_until);
20483 vim_free(fudi.fd_newkey);
20484 vim_free(name);
20485 did_emsg |= saved_did_emsg;
20489 * Get a function name, translating "<SID>" and "<SNR>".
20490 * Also handles a Funcref in a List or Dictionary.
20491 * Returns the function name in allocated memory, or NULL for failure.
20492 * flags:
20493 * TFN_INT: internal function name OK
20494 * TFN_QUIET: be quiet
20495 * Advances "pp" to just after the function name (if no error).
20497 static char_u *
20498 trans_function_name(pp, skip, flags, fdp)
20499 char_u **pp;
20500 int skip; /* only find the end, don't evaluate */
20501 int flags;
20502 funcdict_T *fdp; /* return: info about dictionary used */
20504 char_u *name = NULL;
20505 char_u *start;
20506 char_u *end;
20507 int lead;
20508 char_u sid_buf[20];
20509 int len;
20510 lval_T lv;
20512 if (fdp != NULL)
20513 vim_memset(fdp, 0, sizeof(funcdict_T));
20514 start = *pp;
20516 /* Check for hard coded <SNR>: already translated function ID (from a user
20517 * command). */
20518 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
20519 && (*pp)[2] == (int)KE_SNR)
20521 *pp += 3;
20522 len = get_id_len(pp) + 3;
20523 return vim_strnsave(start, len);
20526 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
20527 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
20528 lead = eval_fname_script(start);
20529 if (lead > 2)
20530 start += lead;
20532 end = get_lval(start, NULL, &lv, FALSE, skip, flags & TFN_QUIET,
20533 lead > 2 ? 0 : FNE_CHECK_START);
20534 if (end == start)
20536 if (!skip)
20537 EMSG(_("E129: Function name required"));
20538 goto theend;
20540 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
20543 * Report an invalid expression in braces, unless the expression
20544 * evaluation has been cancelled due to an aborting error, an
20545 * interrupt, or an exception.
20547 if (!aborting())
20549 if (end != NULL)
20550 EMSG2(_(e_invarg2), start);
20552 else
20553 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
20554 goto theend;
20557 if (lv.ll_tv != NULL)
20559 if (fdp != NULL)
20561 fdp->fd_dict = lv.ll_dict;
20562 fdp->fd_newkey = lv.ll_newkey;
20563 lv.ll_newkey = NULL;
20564 fdp->fd_di = lv.ll_di;
20566 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
20568 name = vim_strsave(lv.ll_tv->vval.v_string);
20569 *pp = end;
20571 else
20573 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
20574 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
20575 EMSG(_(e_funcref));
20576 else
20577 *pp = end;
20578 name = NULL;
20580 goto theend;
20583 if (lv.ll_name == NULL)
20585 /* Error found, but continue after the function name. */
20586 *pp = end;
20587 goto theend;
20590 /* Check if the name is a Funcref. If so, use the value. */
20591 if (lv.ll_exp_name != NULL)
20593 len = (int)STRLEN(lv.ll_exp_name);
20594 name = deref_func_name(lv.ll_exp_name, &len);
20595 if (name == lv.ll_exp_name)
20596 name = NULL;
20598 else
20600 len = (int)(end - *pp);
20601 name = deref_func_name(*pp, &len);
20602 if (name == *pp)
20603 name = NULL;
20605 if (name != NULL)
20607 name = vim_strsave(name);
20608 *pp = end;
20609 goto theend;
20612 if (lv.ll_exp_name != NULL)
20614 len = (int)STRLEN(lv.ll_exp_name);
20615 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
20616 && STRNCMP(lv.ll_name, "s:", 2) == 0)
20618 /* When there was "s:" already or the name expanded to get a
20619 * leading "s:" then remove it. */
20620 lv.ll_name += 2;
20621 len -= 2;
20622 lead = 2;
20625 else
20627 if (lead == 2) /* skip over "s:" */
20628 lv.ll_name += 2;
20629 len = (int)(end - lv.ll_name);
20633 * Copy the function name to allocated memory.
20634 * Accept <SID>name() inside a script, translate into <SNR>123_name().
20635 * Accept <SNR>123_name() outside a script.
20637 if (skip)
20638 lead = 0; /* do nothing */
20639 else if (lead > 0)
20641 lead = 3;
20642 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
20643 || eval_fname_sid(*pp))
20645 /* It's "s:" or "<SID>" */
20646 if (current_SID <= 0)
20648 EMSG(_(e_usingsid));
20649 goto theend;
20651 sprintf((char *)sid_buf, "%ld_", (long)current_SID);
20652 lead += (int)STRLEN(sid_buf);
20655 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name))
20657 EMSG2(_("E128: Function name must start with a capital or contain a colon: %s"), lv.ll_name);
20658 goto theend;
20660 name = alloc((unsigned)(len + lead + 1));
20661 if (name != NULL)
20663 if (lead > 0)
20665 name[0] = K_SPECIAL;
20666 name[1] = KS_EXTRA;
20667 name[2] = (int)KE_SNR;
20668 if (lead > 3) /* If it's "<SID>" */
20669 STRCPY(name + 3, sid_buf);
20671 mch_memmove(name + lead, lv.ll_name, (size_t)len);
20672 name[len + lead] = NUL;
20674 *pp = end;
20676 theend:
20677 clear_lval(&lv);
20678 return name;
20682 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
20683 * Return 2 if "p" starts with "s:".
20684 * Return 0 otherwise.
20686 static int
20687 eval_fname_script(p)
20688 char_u *p;
20690 if (p[0] == '<' && (STRNICMP(p + 1, "SID>", 4) == 0
20691 || STRNICMP(p + 1, "SNR>", 4) == 0))
20692 return 5;
20693 if (p[0] == 's' && p[1] == ':')
20694 return 2;
20695 return 0;
20699 * Return TRUE if "p" starts with "<SID>" or "s:".
20700 * Only works if eval_fname_script() returned non-zero for "p"!
20702 static int
20703 eval_fname_sid(p)
20704 char_u *p;
20706 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
20710 * List the head of the function: "name(arg1, arg2)".
20712 static void
20713 list_func_head(fp, indent)
20714 ufunc_T *fp;
20715 int indent;
20717 int j;
20719 msg_start();
20720 if (indent)
20721 MSG_PUTS(" ");
20722 MSG_PUTS("function ");
20723 if (fp->uf_name[0] == K_SPECIAL)
20725 MSG_PUTS_ATTR("<SNR>", hl_attr(HLF_8));
20726 msg_puts(fp->uf_name + 3);
20728 else
20729 msg_puts(fp->uf_name);
20730 msg_putchar('(');
20731 for (j = 0; j < fp->uf_args.ga_len; ++j)
20733 if (j)
20734 MSG_PUTS(", ");
20735 msg_puts(FUNCARG(fp, j));
20737 if (fp->uf_varargs)
20739 if (j)
20740 MSG_PUTS(", ");
20741 MSG_PUTS("...");
20743 msg_putchar(')');
20744 msg_clr_eos();
20745 if (p_verbose > 0)
20746 last_set_msg(fp->uf_script_ID);
20750 * Find a function by name, return pointer to it in ufuncs.
20751 * Return NULL for unknown function.
20753 static ufunc_T *
20754 find_func(name)
20755 char_u *name;
20757 hashitem_T *hi;
20759 hi = hash_find(&func_hashtab, name);
20760 if (!HASHITEM_EMPTY(hi))
20761 return HI2UF(hi);
20762 return NULL;
20765 #if defined(EXITFREE) || defined(PROTO)
20766 void
20767 free_all_functions()
20769 hashitem_T *hi;
20771 /* Need to start all over every time, because func_free() may change the
20772 * hash table. */
20773 while (func_hashtab.ht_used > 0)
20774 for (hi = func_hashtab.ht_array; ; ++hi)
20775 if (!HASHITEM_EMPTY(hi))
20777 func_free(HI2UF(hi));
20778 break;
20781 #endif
20784 * Return TRUE if a function "name" exists.
20786 static int
20787 function_exists(name)
20788 char_u *name;
20790 char_u *nm = name;
20791 char_u *p;
20792 int n = FALSE;
20794 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL);
20795 nm = skipwhite(nm);
20797 /* Only accept "funcname", "funcname ", "funcname (..." and
20798 * "funcname(...", not "funcname!...". */
20799 if (p != NULL && (*nm == NUL || *nm == '('))
20801 if (builtin_function(p))
20802 n = (find_internal_func(p) >= 0);
20803 else
20804 n = (find_func(p) != NULL);
20806 vim_free(p);
20807 return n;
20811 * Return TRUE if "name" looks like a builtin function name: starts with a
20812 * lower case letter and doesn't contain a ':' or AUTOLOAD_CHAR.
20814 static int
20815 builtin_function(name)
20816 char_u *name;
20818 return ASCII_ISLOWER(name[0]) && vim_strchr(name, ':') == NULL
20819 && vim_strchr(name, AUTOLOAD_CHAR) == NULL;
20822 #if defined(FEAT_PROFILE) || defined(PROTO)
20824 * Start profiling function "fp".
20826 static void
20827 func_do_profile(fp)
20828 ufunc_T *fp;
20830 fp->uf_tm_count = 0;
20831 profile_zero(&fp->uf_tm_self);
20832 profile_zero(&fp->uf_tm_total);
20833 if (fp->uf_tml_count == NULL)
20834 fp->uf_tml_count = (int *)alloc_clear((unsigned)
20835 (sizeof(int) * fp->uf_lines.ga_len));
20836 if (fp->uf_tml_total == NULL)
20837 fp->uf_tml_total = (proftime_T *)alloc_clear((unsigned)
20838 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20839 if (fp->uf_tml_self == NULL)
20840 fp->uf_tml_self = (proftime_T *)alloc_clear((unsigned)
20841 (sizeof(proftime_T) * fp->uf_lines.ga_len));
20842 fp->uf_tml_idx = -1;
20843 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
20844 || fp->uf_tml_self == NULL)
20845 return; /* out of memory */
20847 fp->uf_profiling = TRUE;
20851 * Dump the profiling results for all functions in file "fd".
20853 void
20854 func_dump_profile(fd)
20855 FILE *fd;
20857 hashitem_T *hi;
20858 int todo;
20859 ufunc_T *fp;
20860 int i;
20861 ufunc_T **sorttab;
20862 int st_len = 0;
20864 todo = (int)func_hashtab.ht_used;
20865 if (todo == 0)
20866 return; /* nothing to dump */
20868 sorttab = (ufunc_T **)alloc((unsigned)(sizeof(ufunc_T) * todo));
20870 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
20872 if (!HASHITEM_EMPTY(hi))
20874 --todo;
20875 fp = HI2UF(hi);
20876 if (fp->uf_profiling)
20878 if (sorttab != NULL)
20879 sorttab[st_len++] = fp;
20881 if (fp->uf_name[0] == K_SPECIAL)
20882 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
20883 else
20884 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
20885 if (fp->uf_tm_count == 1)
20886 fprintf(fd, "Called 1 time\n");
20887 else
20888 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
20889 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
20890 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
20891 fprintf(fd, "\n");
20892 fprintf(fd, "count total (s) self (s)\n");
20894 for (i = 0; i < fp->uf_lines.ga_len; ++i)
20896 if (FUNCLINE(fp, i) == NULL)
20897 continue;
20898 prof_func_line(fd, fp->uf_tml_count[i],
20899 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
20900 fprintf(fd, "%s\n", FUNCLINE(fp, i));
20902 fprintf(fd, "\n");
20907 if (sorttab != NULL && st_len > 0)
20909 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20910 prof_total_cmp);
20911 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
20912 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
20913 prof_self_cmp);
20914 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
20917 vim_free(sorttab);
20920 static void
20921 prof_sort_list(fd, sorttab, st_len, title, prefer_self)
20922 FILE *fd;
20923 ufunc_T **sorttab;
20924 int st_len;
20925 char *title;
20926 int prefer_self; /* when equal print only self time */
20928 int i;
20929 ufunc_T *fp;
20931 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
20932 fprintf(fd, "count total (s) self (s) function\n");
20933 for (i = 0; i < 20 && i < st_len; ++i)
20935 fp = sorttab[i];
20936 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
20937 prefer_self);
20938 if (fp->uf_name[0] == K_SPECIAL)
20939 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
20940 else
20941 fprintf(fd, " %s()\n", fp->uf_name);
20943 fprintf(fd, "\n");
20947 * Print the count and times for one function or function line.
20949 static void
20950 prof_func_line(fd, count, total, self, prefer_self)
20951 FILE *fd;
20952 int count;
20953 proftime_T *total;
20954 proftime_T *self;
20955 int prefer_self; /* when equal print only self time */
20957 if (count > 0)
20959 fprintf(fd, "%5d ", count);
20960 if (prefer_self && profile_equal(total, self))
20961 fprintf(fd, " ");
20962 else
20963 fprintf(fd, "%s ", profile_msg(total));
20964 if (!prefer_self && profile_equal(total, self))
20965 fprintf(fd, " ");
20966 else
20967 fprintf(fd, "%s ", profile_msg(self));
20969 else
20970 fprintf(fd, " ");
20974 * Compare function for total time sorting.
20976 static int
20977 #ifdef __BORLANDC__
20978 _RTLENTRYF
20979 #endif
20980 prof_total_cmp(s1, s2)
20981 const void *s1;
20982 const void *s2;
20984 ufunc_T *p1, *p2;
20986 p1 = *(ufunc_T **)s1;
20987 p2 = *(ufunc_T **)s2;
20988 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
20992 * Compare function for self time sorting.
20994 static int
20995 #ifdef __BORLANDC__
20996 _RTLENTRYF
20997 #endif
20998 prof_self_cmp(s1, s2)
20999 const void *s1;
21000 const void *s2;
21002 ufunc_T *p1, *p2;
21004 p1 = *(ufunc_T **)s1;
21005 p2 = *(ufunc_T **)s2;
21006 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
21009 #endif
21012 * If "name" has a package name try autoloading the script for it.
21013 * Return TRUE if a package was loaded.
21015 static int
21016 script_autoload(name, reload)
21017 char_u *name;
21018 int reload; /* load script again when already loaded */
21020 char_u *p;
21021 char_u *scriptname, *tofree;
21022 int ret = FALSE;
21023 int i;
21025 /* If there is no '#' after name[0] there is no package name. */
21026 p = vim_strchr(name, AUTOLOAD_CHAR);
21027 if (p == NULL || p == name)
21028 return FALSE;
21030 tofree = scriptname = autoload_name(name);
21032 /* Find the name in the list of previously loaded package names. Skip
21033 * "autoload/", it's always the same. */
21034 for (i = 0; i < ga_loaded.ga_len; ++i)
21035 if (STRCMP(((char_u **)ga_loaded.ga_data)[i] + 9, scriptname + 9) == 0)
21036 break;
21037 if (!reload && i < ga_loaded.ga_len)
21038 ret = FALSE; /* was loaded already */
21039 else
21041 /* Remember the name if it wasn't loaded already. */
21042 if (i == ga_loaded.ga_len && ga_grow(&ga_loaded, 1) == OK)
21044 ((char_u **)ga_loaded.ga_data)[ga_loaded.ga_len++] = scriptname;
21045 tofree = NULL;
21048 /* Try loading the package from $VIMRUNTIME/autoload/<name>.vim */
21049 if (source_runtime(scriptname, FALSE) == OK)
21050 ret = TRUE;
21053 vim_free(tofree);
21054 return ret;
21058 * Return the autoload script name for a function or variable name.
21059 * Returns NULL when out of memory.
21061 static char_u *
21062 autoload_name(name)
21063 char_u *name;
21065 char_u *p;
21066 char_u *scriptname;
21068 /* Get the script file name: replace '#' with '/', append ".vim". */
21069 scriptname = alloc((unsigned)(STRLEN(name) + 14));
21070 if (scriptname == NULL)
21071 return FALSE;
21072 STRCPY(scriptname, "autoload/");
21073 STRCAT(scriptname, name);
21074 *vim_strrchr(scriptname, AUTOLOAD_CHAR) = NUL;
21075 STRCAT(scriptname, ".vim");
21076 while ((p = vim_strchr(scriptname, AUTOLOAD_CHAR)) != NULL)
21077 *p = '/';
21078 return scriptname;
21081 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
21084 * Function given to ExpandGeneric() to obtain the list of user defined
21085 * function names.
21087 char_u *
21088 get_user_func_name(xp, idx)
21089 expand_T *xp;
21090 int idx;
21092 static long_u done;
21093 static hashitem_T *hi;
21094 ufunc_T *fp;
21096 if (idx == 0)
21098 done = 0;
21099 hi = func_hashtab.ht_array;
21101 if (done < func_hashtab.ht_used)
21103 if (done++ > 0)
21104 ++hi;
21105 while (HASHITEM_EMPTY(hi))
21106 ++hi;
21107 fp = HI2UF(hi);
21109 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
21110 return fp->uf_name; /* prevents overflow */
21112 cat_func_name(IObuff, fp);
21113 if (xp->xp_context != EXPAND_USER_FUNC)
21115 STRCAT(IObuff, "(");
21116 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
21117 STRCAT(IObuff, ")");
21119 return IObuff;
21121 return NULL;
21124 #endif /* FEAT_CMDL_COMPL */
21127 * Copy the function name of "fp" to buffer "buf".
21128 * "buf" must be able to hold the function name plus three bytes.
21129 * Takes care of script-local function names.
21131 static void
21132 cat_func_name(buf, fp)
21133 char_u *buf;
21134 ufunc_T *fp;
21136 if (fp->uf_name[0] == K_SPECIAL)
21138 STRCPY(buf, "<SNR>");
21139 STRCAT(buf, fp->uf_name + 3);
21141 else
21142 STRCPY(buf, fp->uf_name);
21146 * ":delfunction {name}"
21148 void
21149 ex_delfunction(eap)
21150 exarg_T *eap;
21152 ufunc_T *fp = NULL;
21153 char_u *p;
21154 char_u *name;
21155 funcdict_T fudi;
21157 p = eap->arg;
21158 name = trans_function_name(&p, eap->skip, 0, &fudi);
21159 vim_free(fudi.fd_newkey);
21160 if (name == NULL)
21162 if (fudi.fd_dict != NULL && !eap->skip)
21163 EMSG(_(e_funcref));
21164 return;
21166 if (!ends_excmd(*skipwhite(p)))
21168 vim_free(name);
21169 EMSG(_(e_trailing));
21170 return;
21172 eap->nextcmd = check_nextcmd(p);
21173 if (eap->nextcmd != NULL)
21174 *p = NUL;
21176 if (!eap->skip)
21177 fp = find_func(name);
21178 vim_free(name);
21180 if (!eap->skip)
21182 if (fp == NULL)
21184 EMSG2(_(e_nofunc), eap->arg);
21185 return;
21187 if (fp->uf_calls > 0)
21189 EMSG2(_("E131: Cannot delete function %s: It is in use"), eap->arg);
21190 return;
21193 if (fudi.fd_dict != NULL)
21195 /* Delete the dict item that refers to the function, it will
21196 * invoke func_unref() and possibly delete the function. */
21197 dictitem_remove(fudi.fd_dict, fudi.fd_di);
21199 else
21200 func_free(fp);
21205 * Free a function and remove it from the list of functions.
21207 static void
21208 func_free(fp)
21209 ufunc_T *fp;
21211 hashitem_T *hi;
21213 /* clear this function */
21214 ga_clear_strings(&(fp->uf_args));
21215 ga_clear_strings(&(fp->uf_lines));
21216 #ifdef FEAT_PROFILE
21217 vim_free(fp->uf_tml_count);
21218 vim_free(fp->uf_tml_total);
21219 vim_free(fp->uf_tml_self);
21220 #endif
21222 /* remove the function from the function hashtable */
21223 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
21224 if (HASHITEM_EMPTY(hi))
21225 EMSG2(_(e_intern2), "func_free()");
21226 else
21227 hash_remove(&func_hashtab, hi);
21229 vim_free(fp);
21233 * Unreference a Function: decrement the reference count and free it when it
21234 * becomes zero. Only for numbered functions.
21236 static void
21237 func_unref(name)
21238 char_u *name;
21240 ufunc_T *fp;
21242 if (name != NULL && isdigit(*name))
21244 fp = find_func(name);
21245 if (fp == NULL)
21246 EMSG2(_(e_intern2), "func_unref()");
21247 else if (--fp->uf_refcount <= 0)
21249 /* Only delete it when it's not being used. Otherwise it's done
21250 * when "uf_calls" becomes zero. */
21251 if (fp->uf_calls == 0)
21252 func_free(fp);
21258 * Count a reference to a Function.
21260 static void
21261 func_ref(name)
21262 char_u *name;
21264 ufunc_T *fp;
21266 if (name != NULL && isdigit(*name))
21268 fp = find_func(name);
21269 if (fp == NULL)
21270 EMSG2(_(e_intern2), "func_ref()");
21271 else
21272 ++fp->uf_refcount;
21277 * Call a user function.
21279 static void
21280 call_user_func(fp, argcount, argvars, rettv, firstline, lastline, selfdict)
21281 ufunc_T *fp; /* pointer to function */
21282 int argcount; /* nr of args */
21283 typval_T *argvars; /* arguments */
21284 typval_T *rettv; /* return value */
21285 linenr_T firstline; /* first line of range */
21286 linenr_T lastline; /* last line of range */
21287 dict_T *selfdict; /* Dictionary for "self" */
21289 char_u *save_sourcing_name;
21290 linenr_T save_sourcing_lnum;
21291 scid_T save_current_SID;
21292 funccall_T *fc;
21293 int save_did_emsg;
21294 static int depth = 0;
21295 dictitem_T *v;
21296 int fixvar_idx = 0; /* index in fixvar[] */
21297 int i;
21298 int ai;
21299 char_u numbuf[NUMBUFLEN];
21300 char_u *name;
21301 #ifdef FEAT_PROFILE
21302 proftime_T wait_start;
21303 proftime_T call_start;
21304 #endif
21306 /* If depth of calling is getting too high, don't execute the function */
21307 if (depth >= p_mfd)
21309 EMSG(_("E132: Function call depth is higher than 'maxfuncdepth'"));
21310 rettv->v_type = VAR_NUMBER;
21311 rettv->vval.v_number = -1;
21312 return;
21314 ++depth;
21316 line_breakcheck(); /* check for CTRL-C hit */
21318 fc = (funccall_T *)alloc(sizeof(funccall_T));
21319 fc->caller = current_funccal;
21320 current_funccal = fc;
21321 fc->func = fp;
21322 fc->rettv = rettv;
21323 rettv->vval.v_number = 0;
21324 fc->linenr = 0;
21325 fc->returned = FALSE;
21326 fc->level = ex_nesting_level;
21327 /* Check if this function has a breakpoint. */
21328 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
21329 fc->dbg_tick = debug_tick;
21332 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
21333 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
21334 * each argument variable and saves a lot of time.
21337 * Init l: variables.
21339 init_var_dict(&fc->l_vars, &fc->l_vars_var);
21340 if (selfdict != NULL)
21342 /* Set l:self to "selfdict". Use "name" to avoid a warning from
21343 * some compiler that checks the destination size. */
21344 v = &fc->fixvar[fixvar_idx++].var;
21345 name = v->di_key;
21346 STRCPY(name, "self");
21347 v->di_flags = DI_FLAGS_RO + DI_FLAGS_FIX;
21348 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
21349 v->di_tv.v_type = VAR_DICT;
21350 v->di_tv.v_lock = 0;
21351 v->di_tv.vval.v_dict = selfdict;
21352 ++selfdict->dv_refcount;
21356 * Init a: variables.
21357 * Set a:0 to "argcount".
21358 * Set a:000 to a list with room for the "..." arguments.
21360 init_var_dict(&fc->l_avars, &fc->l_avars_var);
21361 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
21362 (varnumber_T)(argcount - fp->uf_args.ga_len));
21363 /* Use "name" to avoid a warning from some compiler that checks the
21364 * destination size. */
21365 v = &fc->fixvar[fixvar_idx++].var;
21366 name = v->di_key;
21367 STRCPY(name, "000");
21368 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21369 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21370 v->di_tv.v_type = VAR_LIST;
21371 v->di_tv.v_lock = VAR_FIXED;
21372 v->di_tv.vval.v_list = &fc->l_varlist;
21373 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
21374 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
21375 fc->l_varlist.lv_lock = VAR_FIXED;
21378 * Set a:firstline to "firstline" and a:lastline to "lastline".
21379 * Set a:name to named arguments.
21380 * Set a:N to the "..." arguments.
21382 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
21383 (varnumber_T)firstline);
21384 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
21385 (varnumber_T)lastline);
21386 for (i = 0; i < argcount; ++i)
21388 ai = i - fp->uf_args.ga_len;
21389 if (ai < 0)
21390 /* named argument a:name */
21391 name = FUNCARG(fp, i);
21392 else
21394 /* "..." argument a:1, a:2, etc. */
21395 sprintf((char *)numbuf, "%d", ai + 1);
21396 name = numbuf;
21398 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
21400 v = &fc->fixvar[fixvar_idx++].var;
21401 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21403 else
21405 v = (dictitem_T *)alloc((unsigned)(sizeof(dictitem_T)
21406 + STRLEN(name)));
21407 if (v == NULL)
21408 break;
21409 v->di_flags = DI_FLAGS_RO;
21411 STRCPY(v->di_key, name);
21412 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
21414 /* Note: the values are copied directly to avoid alloc/free.
21415 * "argvars" must have VAR_FIXED for v_lock. */
21416 v->di_tv = argvars[i];
21417 v->di_tv.v_lock = VAR_FIXED;
21419 if (ai >= 0 && ai < MAX_FUNC_ARGS)
21421 list_append(&fc->l_varlist, &fc->l_listitems[ai]);
21422 fc->l_listitems[ai].li_tv = argvars[i];
21423 fc->l_listitems[ai].li_tv.v_lock = VAR_FIXED;
21427 /* Don't redraw while executing the function. */
21428 ++RedrawingDisabled;
21429 save_sourcing_name = sourcing_name;
21430 save_sourcing_lnum = sourcing_lnum;
21431 sourcing_lnum = 1;
21432 sourcing_name = alloc((unsigned)((save_sourcing_name == NULL ? 0
21433 : STRLEN(save_sourcing_name)) + STRLEN(fp->uf_name) + 13));
21434 if (sourcing_name != NULL)
21436 if (save_sourcing_name != NULL
21437 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
21438 sprintf((char *)sourcing_name, "%s..", save_sourcing_name);
21439 else
21440 STRCPY(sourcing_name, "function ");
21441 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
21443 if (p_verbose >= 12)
21445 ++no_wait_return;
21446 verbose_enter_scroll();
21448 smsg((char_u *)_("calling %s"), sourcing_name);
21449 if (p_verbose >= 14)
21451 char_u buf[MSG_BUF_LEN];
21452 char_u numbuf2[NUMBUFLEN];
21453 char_u *tofree;
21454 char_u *s;
21456 msg_puts((char_u *)"(");
21457 for (i = 0; i < argcount; ++i)
21459 if (i > 0)
21460 msg_puts((char_u *)", ");
21461 if (argvars[i].v_type == VAR_NUMBER)
21462 msg_outnum((long)argvars[i].vval.v_number);
21463 else
21465 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
21466 if (s != NULL)
21468 trunc_string(s, buf, MSG_BUF_CLEN);
21469 msg_puts(buf);
21470 vim_free(tofree);
21474 msg_puts((char_u *)")");
21476 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21478 verbose_leave_scroll();
21479 --no_wait_return;
21482 #ifdef FEAT_PROFILE
21483 if (do_profiling == PROF_YES)
21485 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
21486 func_do_profile(fp);
21487 if (fp->uf_profiling
21488 || (fc->caller != NULL && fc->caller->func->uf_profiling))
21490 ++fp->uf_tm_count;
21491 profile_start(&call_start);
21492 profile_zero(&fp->uf_tm_children);
21494 script_prof_save(&wait_start);
21496 #endif
21498 save_current_SID = current_SID;
21499 current_SID = fp->uf_script_ID;
21500 save_did_emsg = did_emsg;
21501 did_emsg = FALSE;
21503 /* call do_cmdline() to execute the lines */
21504 do_cmdline(NULL, get_func_line, (void *)fc,
21505 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
21507 --RedrawingDisabled;
21509 /* when the function was aborted because of an error, return -1 */
21510 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
21512 clear_tv(rettv);
21513 rettv->v_type = VAR_NUMBER;
21514 rettv->vval.v_number = -1;
21517 #ifdef FEAT_PROFILE
21518 if (do_profiling == PROF_YES && (fp->uf_profiling
21519 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
21521 profile_end(&call_start);
21522 profile_sub_wait(&wait_start, &call_start);
21523 profile_add(&fp->uf_tm_total, &call_start);
21524 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
21525 if (fc->caller != NULL && fc->caller->func->uf_profiling)
21527 profile_add(&fc->caller->func->uf_tm_children, &call_start);
21528 profile_add(&fc->caller->func->uf_tml_children, &call_start);
21531 #endif
21533 /* when being verbose, mention the return value */
21534 if (p_verbose >= 12)
21536 ++no_wait_return;
21537 verbose_enter_scroll();
21539 if (aborting())
21540 smsg((char_u *)_("%s aborted"), sourcing_name);
21541 else if (fc->rettv->v_type == VAR_NUMBER)
21542 smsg((char_u *)_("%s returning #%ld"), sourcing_name,
21543 (long)fc->rettv->vval.v_number);
21544 else
21546 char_u buf[MSG_BUF_LEN];
21547 char_u numbuf2[NUMBUFLEN];
21548 char_u *tofree;
21549 char_u *s;
21551 /* The value may be very long. Skip the middle part, so that we
21552 * have some idea how it starts and ends. smsg() would always
21553 * truncate it at the end. */
21554 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
21555 if (s != NULL)
21557 trunc_string(s, buf, MSG_BUF_CLEN);
21558 smsg((char_u *)_("%s returning %s"), sourcing_name, buf);
21559 vim_free(tofree);
21562 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21564 verbose_leave_scroll();
21565 --no_wait_return;
21568 vim_free(sourcing_name);
21569 sourcing_name = save_sourcing_name;
21570 sourcing_lnum = save_sourcing_lnum;
21571 current_SID = save_current_SID;
21572 #ifdef FEAT_PROFILE
21573 if (do_profiling == PROF_YES)
21574 script_prof_restore(&wait_start);
21575 #endif
21577 if (p_verbose >= 12 && sourcing_name != NULL)
21579 ++no_wait_return;
21580 verbose_enter_scroll();
21582 smsg((char_u *)_("continuing in %s"), sourcing_name);
21583 msg_puts((char_u *)"\n"); /* don't overwrite this either */
21585 verbose_leave_scroll();
21586 --no_wait_return;
21589 did_emsg |= save_did_emsg;
21590 current_funccal = fc->caller;
21591 --depth;
21593 /* If the a:000 list and the l: and a: dicts are not referenced we can
21594 * free the funccall_T and what's in it. */
21595 if (fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
21596 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
21597 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
21599 free_funccal(fc, FALSE);
21601 else
21603 hashitem_T *hi;
21604 listitem_T *li;
21605 int todo;
21607 /* "fc" is still in use. This can happen when returning "a:000" or
21608 * assigning "l:" to a global variable.
21609 * Link "fc" in the list for garbage collection later. */
21610 fc->caller = previous_funccal;
21611 previous_funccal = fc;
21613 /* Make a copy of the a: variables, since we didn't do that above. */
21614 todo = (int)fc->l_avars.dv_hashtab.ht_used;
21615 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
21617 if (!HASHITEM_EMPTY(hi))
21619 --todo;
21620 v = HI2DI(hi);
21621 copy_tv(&v->di_tv, &v->di_tv);
21625 /* Make a copy of the a:000 items, since we didn't do that above. */
21626 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21627 copy_tv(&li->li_tv, &li->li_tv);
21632 * Return TRUE if items in "fc" do not have "copyID". That means they are not
21633 * referenced from anywhere that is in use.
21635 static int
21636 can_free_funccal(fc, copyID)
21637 funccall_T *fc;
21638 int copyID;
21640 return (fc->l_varlist.lv_copyID != copyID
21641 && fc->l_vars.dv_copyID != copyID
21642 && fc->l_avars.dv_copyID != copyID);
21646 * Free "fc" and what it contains.
21648 static void
21649 free_funccal(fc, free_val)
21650 funccall_T *fc;
21651 int free_val; /* a: vars were allocated */
21653 listitem_T *li;
21655 /* The a: variables typevals may not have been allocated, only free the
21656 * allocated variables. */
21657 vars_clear_ext(&fc->l_avars.dv_hashtab, free_val);
21659 /* free all l: variables */
21660 vars_clear(&fc->l_vars.dv_hashtab);
21662 /* Free the a:000 variables if they were allocated. */
21663 if (free_val)
21664 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
21665 clear_tv(&li->li_tv);
21667 vim_free(fc);
21671 * Add a number variable "name" to dict "dp" with value "nr".
21673 static void
21674 add_nr_var(dp, v, name, nr)
21675 dict_T *dp;
21676 dictitem_T *v;
21677 char *name;
21678 varnumber_T nr;
21680 STRCPY(v->di_key, name);
21681 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
21682 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
21683 v->di_tv.v_type = VAR_NUMBER;
21684 v->di_tv.v_lock = VAR_FIXED;
21685 v->di_tv.vval.v_number = nr;
21689 * ":return [expr]"
21691 void
21692 ex_return(eap)
21693 exarg_T *eap;
21695 char_u *arg = eap->arg;
21696 typval_T rettv;
21697 int returning = FALSE;
21699 if (current_funccal == NULL)
21701 EMSG(_("E133: :return not inside a function"));
21702 return;
21705 if (eap->skip)
21706 ++emsg_skip;
21708 eap->nextcmd = NULL;
21709 if ((*arg != NUL && *arg != '|' && *arg != '\n')
21710 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
21712 if (!eap->skip)
21713 returning = do_return(eap, FALSE, TRUE, &rettv);
21714 else
21715 clear_tv(&rettv);
21717 /* It's safer to return also on error. */
21718 else if (!eap->skip)
21721 * Return unless the expression evaluation has been cancelled due to an
21722 * aborting error, an interrupt, or an exception.
21724 if (!aborting())
21725 returning = do_return(eap, FALSE, TRUE, NULL);
21728 /* When skipping or the return gets pending, advance to the next command
21729 * in this line (!returning). Otherwise, ignore the rest of the line.
21730 * Following lines will be ignored by get_func_line(). */
21731 if (returning)
21732 eap->nextcmd = NULL;
21733 else if (eap->nextcmd == NULL) /* no argument */
21734 eap->nextcmd = check_nextcmd(arg);
21736 if (eap->skip)
21737 --emsg_skip;
21741 * Return from a function. Possibly makes the return pending. Also called
21742 * for a pending return at the ":endtry" or after returning from an extra
21743 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
21744 * when called due to a ":return" command. "rettv" may point to a typval_T
21745 * with the return rettv. Returns TRUE when the return can be carried out,
21746 * FALSE when the return gets pending.
21749 do_return(eap, reanimate, is_cmd, rettv)
21750 exarg_T *eap;
21751 int reanimate;
21752 int is_cmd;
21753 void *rettv;
21755 int idx;
21756 struct condstack *cstack = eap->cstack;
21758 if (reanimate)
21759 /* Undo the return. */
21760 current_funccal->returned = FALSE;
21763 * Cleanup (and inactivate) conditionals, but stop when a try conditional
21764 * not in its finally clause (which then is to be executed next) is found.
21765 * In this case, make the ":return" pending for execution at the ":endtry".
21766 * Otherwise, return normally.
21768 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
21769 if (idx >= 0)
21771 cstack->cs_pending[idx] = CSTP_RETURN;
21773 if (!is_cmd && !reanimate)
21774 /* A pending return again gets pending. "rettv" points to an
21775 * allocated variable with the rettv of the original ":return"'s
21776 * argument if present or is NULL else. */
21777 cstack->cs_rettv[idx] = rettv;
21778 else
21780 /* When undoing a return in order to make it pending, get the stored
21781 * return rettv. */
21782 if (reanimate)
21783 rettv = current_funccal->rettv;
21785 if (rettv != NULL)
21787 /* Store the value of the pending return. */
21788 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
21789 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
21790 else
21791 EMSG(_(e_outofmem));
21793 else
21794 cstack->cs_rettv[idx] = NULL;
21796 if (reanimate)
21798 /* The pending return value could be overwritten by a ":return"
21799 * without argument in a finally clause; reset the default
21800 * return value. */
21801 current_funccal->rettv->v_type = VAR_NUMBER;
21802 current_funccal->rettv->vval.v_number = 0;
21805 report_make_pending(CSTP_RETURN, rettv);
21807 else
21809 current_funccal->returned = TRUE;
21811 /* If the return is carried out now, store the return value. For
21812 * a return immediately after reanimation, the value is already
21813 * there. */
21814 if (!reanimate && rettv != NULL)
21816 clear_tv(current_funccal->rettv);
21817 *current_funccal->rettv = *(typval_T *)rettv;
21818 if (!is_cmd)
21819 vim_free(rettv);
21823 return idx < 0;
21827 * Free the variable with a pending return value.
21829 void
21830 discard_pending_return(rettv)
21831 void *rettv;
21833 free_tv((typval_T *)rettv);
21837 * Generate a return command for producing the value of "rettv". The result
21838 * is an allocated string. Used by report_pending() for verbose messages.
21840 char_u *
21841 get_return_cmd(rettv)
21842 void *rettv;
21844 char_u *s = NULL;
21845 char_u *tofree = NULL;
21846 char_u numbuf[NUMBUFLEN];
21848 if (rettv != NULL)
21849 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
21850 if (s == NULL)
21851 s = (char_u *)"";
21853 STRCPY(IObuff, ":return ");
21854 STRNCPY(IObuff + 8, s, IOSIZE - 8);
21855 if (STRLEN(s) + 8 >= IOSIZE)
21856 STRCPY(IObuff + IOSIZE - 4, "...");
21857 vim_free(tofree);
21858 return vim_strsave(IObuff);
21862 * Get next function line.
21863 * Called by do_cmdline() to get the next line.
21864 * Returns allocated string, or NULL for end of function.
21866 char_u *
21867 get_func_line(c, cookie, indent)
21868 int c UNUSED;
21869 void *cookie;
21870 int indent UNUSED;
21872 funccall_T *fcp = (funccall_T *)cookie;
21873 ufunc_T *fp = fcp->func;
21874 char_u *retval;
21875 garray_T *gap; /* growarray with function lines */
21877 /* If breakpoints have been added/deleted need to check for it. */
21878 if (fcp->dbg_tick != debug_tick)
21880 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21881 sourcing_lnum);
21882 fcp->dbg_tick = debug_tick;
21884 #ifdef FEAT_PROFILE
21885 if (do_profiling == PROF_YES)
21886 func_line_end(cookie);
21887 #endif
21889 gap = &fp->uf_lines;
21890 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
21891 || fcp->returned)
21892 retval = NULL;
21893 else
21895 /* Skip NULL lines (continuation lines). */
21896 while (fcp->linenr < gap->ga_len
21897 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
21898 ++fcp->linenr;
21899 if (fcp->linenr >= gap->ga_len)
21900 retval = NULL;
21901 else
21903 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
21904 sourcing_lnum = fcp->linenr;
21905 #ifdef FEAT_PROFILE
21906 if (do_profiling == PROF_YES)
21907 func_line_start(cookie);
21908 #endif
21912 /* Did we encounter a breakpoint? */
21913 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
21915 dbg_breakpoint(fp->uf_name, sourcing_lnum);
21916 /* Find next breakpoint. */
21917 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
21918 sourcing_lnum);
21919 fcp->dbg_tick = debug_tick;
21922 return retval;
21925 #if defined(FEAT_PROFILE) || defined(PROTO)
21927 * Called when starting to read a function line.
21928 * "sourcing_lnum" must be correct!
21929 * When skipping lines it may not actually be executed, but we won't find out
21930 * until later and we need to store the time now.
21932 void
21933 func_line_start(cookie)
21934 void *cookie;
21936 funccall_T *fcp = (funccall_T *)cookie;
21937 ufunc_T *fp = fcp->func;
21939 if (fp->uf_profiling && sourcing_lnum >= 1
21940 && sourcing_lnum <= fp->uf_lines.ga_len)
21942 fp->uf_tml_idx = sourcing_lnum - 1;
21943 /* Skip continuation lines. */
21944 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
21945 --fp->uf_tml_idx;
21946 fp->uf_tml_execed = FALSE;
21947 profile_start(&fp->uf_tml_start);
21948 profile_zero(&fp->uf_tml_children);
21949 profile_get_wait(&fp->uf_tml_wait);
21954 * Called when actually executing a function line.
21956 void
21957 func_line_exec(cookie)
21958 void *cookie;
21960 funccall_T *fcp = (funccall_T *)cookie;
21961 ufunc_T *fp = fcp->func;
21963 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21964 fp->uf_tml_execed = TRUE;
21968 * Called when done with a function line.
21970 void
21971 func_line_end(cookie)
21972 void *cookie;
21974 funccall_T *fcp = (funccall_T *)cookie;
21975 ufunc_T *fp = fcp->func;
21977 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
21979 if (fp->uf_tml_execed)
21981 ++fp->uf_tml_count[fp->uf_tml_idx];
21982 profile_end(&fp->uf_tml_start);
21983 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
21984 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
21985 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
21986 &fp->uf_tml_children);
21988 fp->uf_tml_idx = -1;
21991 #endif
21994 * Return TRUE if the currently active function should be ended, because a
21995 * return was encountered or an error occurred. Used inside a ":while".
21998 func_has_ended(cookie)
21999 void *cookie;
22001 funccall_T *fcp = (funccall_T *)cookie;
22003 /* Ignore the "abort" flag if the abortion behavior has been changed due to
22004 * an error inside a try conditional. */
22005 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
22006 || fcp->returned);
22010 * return TRUE if cookie indicates a function which "abort"s on errors.
22013 func_has_abort(cookie)
22014 void *cookie;
22016 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
22019 #if defined(FEAT_VIMINFO) || defined(FEAT_SESSION)
22020 typedef enum
22022 VAR_FLAVOUR_DEFAULT, /* doesn't start with uppercase */
22023 VAR_FLAVOUR_SESSION, /* starts with uppercase, some lower */
22024 VAR_FLAVOUR_VIMINFO /* all uppercase */
22025 } var_flavour_T;
22027 static var_flavour_T var_flavour __ARGS((char_u *varname));
22029 static var_flavour_T
22030 var_flavour(varname)
22031 char_u *varname;
22033 char_u *p = varname;
22035 if (ASCII_ISUPPER(*p))
22037 while (*(++p))
22038 if (ASCII_ISLOWER(*p))
22039 return VAR_FLAVOUR_SESSION;
22040 return VAR_FLAVOUR_VIMINFO;
22042 else
22043 return VAR_FLAVOUR_DEFAULT;
22045 #endif
22047 #if defined(FEAT_VIMINFO) || defined(PROTO)
22049 * Restore global vars that start with a capital from the viminfo file
22052 read_viminfo_varlist(virp, writing)
22053 vir_T *virp;
22054 int writing;
22056 char_u *tab;
22057 int type = VAR_NUMBER;
22058 typval_T tv;
22060 if (!writing && (find_viminfo_parameter('!') != NULL))
22062 tab = vim_strchr(virp->vir_line + 1, '\t');
22063 if (tab != NULL)
22065 *tab++ = '\0'; /* isolate the variable name */
22066 if (*tab == 'S') /* string var */
22067 type = VAR_STRING;
22068 #ifdef FEAT_FLOAT
22069 else if (*tab == 'F')
22070 type = VAR_FLOAT;
22071 #endif
22073 tab = vim_strchr(tab, '\t');
22074 if (tab != NULL)
22076 tv.v_type = type;
22077 if (type == VAR_STRING)
22078 tv.vval.v_string = viminfo_readstring(virp,
22079 (int)(tab - virp->vir_line + 1), TRUE);
22080 #ifdef FEAT_FLOAT
22081 else if (type == VAR_FLOAT)
22082 (void)string2float(tab + 1, &tv.vval.v_float);
22083 #endif
22084 else
22085 tv.vval.v_number = atol((char *)tab + 1);
22086 set_var(virp->vir_line + 1, &tv, FALSE);
22087 if (type == VAR_STRING)
22088 vim_free(tv.vval.v_string);
22093 return viminfo_readline(virp);
22097 * Write global vars that start with a capital to the viminfo file
22099 void
22100 write_viminfo_varlist(fp)
22101 FILE *fp;
22103 hashitem_T *hi;
22104 dictitem_T *this_var;
22105 int todo;
22106 char *s;
22107 char_u *p;
22108 char_u *tofree;
22109 char_u numbuf[NUMBUFLEN];
22111 if (find_viminfo_parameter('!') == NULL)
22112 return;
22114 fprintf(fp, _("\n# global variables:\n"));
22116 todo = (int)globvarht.ht_used;
22117 for (hi = globvarht.ht_array; todo > 0; ++hi)
22119 if (!HASHITEM_EMPTY(hi))
22121 --todo;
22122 this_var = HI2DI(hi);
22123 if (var_flavour(this_var->di_key) == VAR_FLAVOUR_VIMINFO)
22125 switch (this_var->di_tv.v_type)
22127 case VAR_STRING: s = "STR"; break;
22128 case VAR_NUMBER: s = "NUM"; break;
22129 #ifdef FEAT_FLOAT
22130 case VAR_FLOAT: s = "FLO"; break;
22131 #endif
22132 default: continue;
22134 fprintf(fp, "!%s\t%s\t", this_var->di_key, s);
22135 p = echo_string(&this_var->di_tv, &tofree, numbuf, 0);
22136 if (p != NULL)
22137 viminfo_writestring(fp, p);
22138 vim_free(tofree);
22143 #endif
22145 #if defined(FEAT_SESSION) || defined(PROTO)
22147 store_session_globals(fd)
22148 FILE *fd;
22150 hashitem_T *hi;
22151 dictitem_T *this_var;
22152 int todo;
22153 char_u *p, *t;
22155 todo = (int)globvarht.ht_used;
22156 for (hi = globvarht.ht_array; todo > 0; ++hi)
22158 if (!HASHITEM_EMPTY(hi))
22160 --todo;
22161 this_var = HI2DI(hi);
22162 if ((this_var->di_tv.v_type == VAR_NUMBER
22163 || this_var->di_tv.v_type == VAR_STRING)
22164 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22166 /* Escape special characters with a backslash. Turn a LF and
22167 * CR into \n and \r. */
22168 p = vim_strsave_escaped(get_tv_string(&this_var->di_tv),
22169 (char_u *)"\\\"\n\r");
22170 if (p == NULL) /* out of memory */
22171 break;
22172 for (t = p; *t != NUL; ++t)
22173 if (*t == '\n')
22174 *t = 'n';
22175 else if (*t == '\r')
22176 *t = 'r';
22177 if ((fprintf(fd, "let %s = %c%s%c",
22178 this_var->di_key,
22179 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22180 : ' ',
22182 (this_var->di_tv.v_type == VAR_STRING) ? '"'
22183 : ' ') < 0)
22184 || put_eol(fd) == FAIL)
22186 vim_free(p);
22187 return FAIL;
22189 vim_free(p);
22191 #ifdef FEAT_FLOAT
22192 else if (this_var->di_tv.v_type == VAR_FLOAT
22193 && var_flavour(this_var->di_key) == VAR_FLAVOUR_SESSION)
22195 float_T f = this_var->di_tv.vval.v_float;
22196 int sign = ' ';
22198 if (f < 0)
22200 f = -f;
22201 sign = '-';
22203 if ((fprintf(fd, "let %s = %c&%f",
22204 this_var->di_key, sign, f) < 0)
22205 || put_eol(fd) == FAIL)
22206 return FAIL;
22208 #endif
22211 return OK;
22213 #endif
22216 * Display script name where an item was last set.
22217 * Should only be invoked when 'verbose' is non-zero.
22219 void
22220 last_set_msg(scriptID)
22221 scid_T scriptID;
22223 char_u *p;
22225 if (scriptID != 0)
22227 p = home_replace_save(NULL, get_scriptname(scriptID));
22228 if (p != NULL)
22230 verbose_enter();
22231 MSG_PUTS(_("\n\tLast set from "));
22232 MSG_PUTS(p);
22233 vim_free(p);
22234 verbose_leave();
22240 * List v:oldfiles in a nice way.
22242 void
22243 ex_oldfiles(eap)
22244 exarg_T *eap UNUSED;
22246 list_T *l = vimvars[VV_OLDFILES].vv_list;
22247 listitem_T *li;
22248 int nr = 0;
22250 if (l == NULL)
22251 msg((char_u *)_("No old files"));
22252 else
22254 msg_start();
22255 msg_scroll = TRUE;
22256 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
22258 msg_outnum((long)++nr);
22259 MSG_PUTS(": ");
22260 msg_outtrans(get_tv_string(&li->li_tv));
22261 msg_putchar('\n');
22262 out_flush(); /* output one line at a time */
22263 ui_breakcheck();
22265 /* Assume "got_int" was set to truncate the listing. */
22266 got_int = FALSE;
22268 #ifdef FEAT_BROWSE_CMD
22269 if (cmdmod.browse)
22271 quit_more = FALSE;
22272 nr = prompt_for_number(FALSE);
22273 msg_starthere();
22274 if (nr > 0)
22276 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
22277 (long)nr);
22279 if (p != NULL)
22281 p = expand_env_save(p);
22282 eap->arg = p;
22283 eap->cmdidx = CMD_edit;
22284 cmdmod.browse = FALSE;
22285 do_exedit(eap, NULL);
22286 vim_free(p);
22290 #endif
22294 #endif /* FEAT_EVAL */
22297 #if defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) || defined(PROTO)
22299 #ifdef WIN3264
22301 * Functions for ":8" filename modifier: get 8.3 version of a filename.
22303 static int get_short_pathname __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22304 static int shortpath_for_invalid_fname __ARGS((char_u **fname, char_u **bufp, int *fnamelen));
22305 static int shortpath_for_partial __ARGS((char_u **fnamep, char_u **bufp, int *fnamelen));
22308 * Get the short path (8.3) for the filename in "fnamep".
22309 * Only works for a valid file name.
22310 * When the path gets longer "fnamep" is changed and the allocated buffer
22311 * is put in "bufp".
22312 * *fnamelen is the length of "fnamep" and set to 0 for a nonexistent path.
22313 * Returns OK on success, FAIL on failure.
22315 static int
22316 get_short_pathname(fnamep, bufp, fnamelen)
22317 char_u **fnamep;
22318 char_u **bufp;
22319 int *fnamelen;
22321 int l, len;
22322 char_u *newbuf;
22324 len = *fnamelen;
22325 l = GetShortPathName(*fnamep, *fnamep, len);
22326 if (l > len - 1)
22328 /* If that doesn't work (not enough space), then save the string
22329 * and try again with a new buffer big enough. */
22330 newbuf = vim_strnsave(*fnamep, l);
22331 if (newbuf == NULL)
22332 return FAIL;
22334 vim_free(*bufp);
22335 *fnamep = *bufp = newbuf;
22337 /* Really should always succeed, as the buffer is big enough. */
22338 l = GetShortPathName(*fnamep, *fnamep, l+1);
22341 *fnamelen = l;
22342 return OK;
22346 * Get the short path (8.3) for the filename in "fname". The converted
22347 * path is returned in "bufp".
22349 * Some of the directories specified in "fname" may not exist. This function
22350 * will shorten the existing directories at the beginning of the path and then
22351 * append the remaining non-existing path.
22353 * fname - Pointer to the filename to shorten. On return, contains the
22354 * pointer to the shortened pathname
22355 * bufp - Pointer to an allocated buffer for the filename.
22356 * fnamelen - Length of the filename pointed to by fname
22358 * Returns OK on success (or nothing done) and FAIL on failure (out of memory).
22360 static int
22361 shortpath_for_invalid_fname(fname, bufp, fnamelen)
22362 char_u **fname;
22363 char_u **bufp;
22364 int *fnamelen;
22366 char_u *short_fname, *save_fname, *pbuf_unused;
22367 char_u *endp, *save_endp;
22368 char_u ch;
22369 int old_len, len;
22370 int new_len, sfx_len;
22371 int retval = OK;
22373 /* Make a copy */
22374 old_len = *fnamelen;
22375 save_fname = vim_strnsave(*fname, old_len);
22376 pbuf_unused = NULL;
22377 short_fname = NULL;
22379 endp = save_fname + old_len - 1; /* Find the end of the copy */
22380 save_endp = endp;
22383 * Try shortening the supplied path till it succeeds by removing one
22384 * directory at a time from the tail of the path.
22386 len = 0;
22387 for (;;)
22389 /* go back one path-separator */
22390 while (endp > save_fname && !after_pathsep(save_fname, endp + 1))
22391 --endp;
22392 if (endp <= save_fname)
22393 break; /* processed the complete path */
22396 * Replace the path separator with a NUL and try to shorten the
22397 * resulting path.
22399 ch = *endp;
22400 *endp = 0;
22401 short_fname = save_fname;
22402 len = (int)STRLEN(short_fname) + 1;
22403 if (get_short_pathname(&short_fname, &pbuf_unused, &len) == FAIL)
22405 retval = FAIL;
22406 goto theend;
22408 *endp = ch; /* preserve the string */
22410 if (len > 0)
22411 break; /* successfully shortened the path */
22413 /* failed to shorten the path. Skip the path separator */
22414 --endp;
22417 if (len > 0)
22420 * Succeeded in shortening the path. Now concatenate the shortened
22421 * path with the remaining path at the tail.
22424 /* Compute the length of the new path. */
22425 sfx_len = (int)(save_endp - endp) + 1;
22426 new_len = len + sfx_len;
22428 *fnamelen = new_len;
22429 vim_free(*bufp);
22430 if (new_len > old_len)
22432 /* There is not enough space in the currently allocated string,
22433 * copy it to a buffer big enough. */
22434 *fname = *bufp = vim_strnsave(short_fname, new_len);
22435 if (*fname == NULL)
22437 retval = FAIL;
22438 goto theend;
22441 else
22443 /* Transfer short_fname to the main buffer (it's big enough),
22444 * unless get_short_pathname() did its work in-place. */
22445 *fname = *bufp = save_fname;
22446 if (short_fname != save_fname)
22447 vim_strncpy(save_fname, short_fname, len);
22448 save_fname = NULL;
22451 /* concat the not-shortened part of the path */
22452 vim_strncpy(*fname + len, endp, sfx_len);
22453 (*fname)[new_len] = NUL;
22456 theend:
22457 vim_free(pbuf_unused);
22458 vim_free(save_fname);
22460 return retval;
22464 * Get a pathname for a partial path.
22465 * Returns OK for success, FAIL for failure.
22467 static int
22468 shortpath_for_partial(fnamep, bufp, fnamelen)
22469 char_u **fnamep;
22470 char_u **bufp;
22471 int *fnamelen;
22473 int sepcount, len, tflen;
22474 char_u *p;
22475 char_u *pbuf, *tfname;
22476 int hasTilde;
22478 /* Count up the path separators from the RHS.. so we know which part
22479 * of the path to return. */
22480 sepcount = 0;
22481 for (p = *fnamep; p < *fnamep + *fnamelen; mb_ptr_adv(p))
22482 if (vim_ispathsep(*p))
22483 ++sepcount;
22485 /* Need full path first (use expand_env() to remove a "~/") */
22486 hasTilde = (**fnamep == '~');
22487 if (hasTilde)
22488 pbuf = tfname = expand_env_save(*fnamep);
22489 else
22490 pbuf = tfname = FullName_save(*fnamep, FALSE);
22492 len = tflen = (int)STRLEN(tfname);
22494 if (get_short_pathname(&tfname, &pbuf, &len) == FAIL)
22495 return FAIL;
22497 if (len == 0)
22499 /* Don't have a valid filename, so shorten the rest of the
22500 * path if we can. This CAN give us invalid 8.3 filenames, but
22501 * there's not a lot of point in guessing what it might be.
22503 len = tflen;
22504 if (shortpath_for_invalid_fname(&tfname, &pbuf, &len) == FAIL)
22505 return FAIL;
22508 /* Count the paths backward to find the beginning of the desired string. */
22509 for (p = tfname + len - 1; p >= tfname; --p)
22511 #ifdef FEAT_MBYTE
22512 if (has_mbyte)
22513 p -= mb_head_off(tfname, p);
22514 #endif
22515 if (vim_ispathsep(*p))
22517 if (sepcount == 0 || (hasTilde && sepcount == 1))
22518 break;
22519 else
22520 sepcount --;
22523 if (hasTilde)
22525 --p;
22526 if (p >= tfname)
22527 *p = '~';
22528 else
22529 return FAIL;
22531 else
22532 ++p;
22534 /* Copy in the string - p indexes into tfname - allocated at pbuf */
22535 vim_free(*bufp);
22536 *fnamelen = (int)STRLEN(p);
22537 *bufp = pbuf;
22538 *fnamep = p;
22540 return OK;
22542 #endif /* WIN3264 */
22545 * Adjust a filename, according to a string of modifiers.
22546 * *fnamep must be NUL terminated when called. When returning, the length is
22547 * determined by *fnamelen.
22548 * Returns VALID_ flags or -1 for failure.
22549 * When there is an error, *fnamep is set to NULL.
22552 modify_fname(src, usedlen, fnamep, bufp, fnamelen)
22553 char_u *src; /* string with modifiers */
22554 int *usedlen; /* characters after src that are used */
22555 char_u **fnamep; /* file name so far */
22556 char_u **bufp; /* buffer for allocated file name or NULL */
22557 int *fnamelen; /* length of fnamep */
22559 int valid = 0;
22560 char_u *tail;
22561 char_u *s, *p, *pbuf;
22562 char_u dirname[MAXPATHL];
22563 int c;
22564 int has_fullname = 0;
22565 #ifdef WIN3264
22566 int has_shortname = 0;
22567 #endif
22569 repeat:
22570 /* ":p" - full path/file_name */
22571 if (src[*usedlen] == ':' && src[*usedlen + 1] == 'p')
22573 has_fullname = 1;
22575 valid |= VALID_PATH;
22576 *usedlen += 2;
22578 /* Expand "~/path" for all systems and "~user/path" for Unix and VMS */
22579 if ((*fnamep)[0] == '~'
22580 #if !defined(UNIX) && !(defined(VMS) && defined(USER_HOME))
22581 && ((*fnamep)[1] == '/'
22582 # ifdef BACKSLASH_IN_FILENAME
22583 || (*fnamep)[1] == '\\'
22584 # endif
22585 || (*fnamep)[1] == NUL)
22587 #endif
22590 *fnamep = expand_env_save(*fnamep);
22591 vim_free(*bufp); /* free any allocated file name */
22592 *bufp = *fnamep;
22593 if (*fnamep == NULL)
22594 return -1;
22597 /* When "/." or "/.." is used: force expansion to get rid of it. */
22598 for (p = *fnamep; *p != NUL; mb_ptr_adv(p))
22600 if (vim_ispathsep(*p)
22601 && p[1] == '.'
22602 && (p[2] == NUL
22603 || vim_ispathsep(p[2])
22604 || (p[2] == '.'
22605 && (p[3] == NUL || vim_ispathsep(p[3])))))
22606 break;
22609 /* FullName_save() is slow, don't use it when not needed. */
22610 if (*p != NUL || !vim_isAbsName(*fnamep))
22612 *fnamep = FullName_save(*fnamep, *p != NUL);
22613 vim_free(*bufp); /* free any allocated file name */
22614 *bufp = *fnamep;
22615 if (*fnamep == NULL)
22616 return -1;
22619 /* Append a path separator to a directory. */
22620 if (mch_isdir(*fnamep))
22622 /* Make room for one or two extra characters. */
22623 *fnamep = vim_strnsave(*fnamep, (int)STRLEN(*fnamep) + 2);
22624 vim_free(*bufp); /* free any allocated file name */
22625 *bufp = *fnamep;
22626 if (*fnamep == NULL)
22627 return -1;
22628 add_pathsep(*fnamep);
22632 /* ":." - path relative to the current directory */
22633 /* ":~" - path relative to the home directory */
22634 /* ":8" - shortname path - postponed till after */
22635 while (src[*usedlen] == ':'
22636 && ((c = src[*usedlen + 1]) == '.' || c == '~' || c == '8'))
22638 *usedlen += 2;
22639 if (c == '8')
22641 #ifdef WIN3264
22642 has_shortname = 1; /* Postpone this. */
22643 #endif
22644 continue;
22646 pbuf = NULL;
22647 /* Need full path first (use expand_env() to remove a "~/") */
22648 if (!has_fullname)
22650 if (c == '.' && **fnamep == '~')
22651 p = pbuf = expand_env_save(*fnamep);
22652 else
22653 p = pbuf = FullName_save(*fnamep, FALSE);
22655 else
22656 p = *fnamep;
22658 has_fullname = 0;
22660 if (p != NULL)
22662 if (c == '.')
22664 mch_dirname(dirname, MAXPATHL);
22665 s = shorten_fname(p, dirname);
22666 if (s != NULL)
22668 *fnamep = s;
22669 if (pbuf != NULL)
22671 vim_free(*bufp); /* free any allocated file name */
22672 *bufp = pbuf;
22673 pbuf = NULL;
22677 else
22679 home_replace(NULL, p, dirname, MAXPATHL, TRUE);
22680 /* Only replace it when it starts with '~' */
22681 if (*dirname == '~')
22683 s = vim_strsave(dirname);
22684 if (s != NULL)
22686 *fnamep = s;
22687 vim_free(*bufp);
22688 *bufp = s;
22692 vim_free(pbuf);
22696 tail = gettail(*fnamep);
22697 *fnamelen = (int)STRLEN(*fnamep);
22699 /* ":h" - head, remove "/file_name", can be repeated */
22700 /* Don't remove the first "/" or "c:\" */
22701 while (src[*usedlen] == ':' && src[*usedlen + 1] == 'h')
22703 valid |= VALID_HEAD;
22704 *usedlen += 2;
22705 s = get_past_head(*fnamep);
22706 while (tail > s && after_pathsep(s, tail))
22707 mb_ptr_back(*fnamep, tail);
22708 *fnamelen = (int)(tail - *fnamep);
22709 #ifdef VMS
22710 if (*fnamelen > 0)
22711 *fnamelen += 1; /* the path separator is part of the path */
22712 #endif
22713 if (*fnamelen == 0)
22715 /* Result is empty. Turn it into "." to make ":cd %:h" work. */
22716 p = vim_strsave((char_u *)".");
22717 if (p == NULL)
22718 return -1;
22719 vim_free(*bufp);
22720 *bufp = *fnamep = tail = p;
22721 *fnamelen = 1;
22723 else
22725 while (tail > s && !after_pathsep(s, tail))
22726 mb_ptr_back(*fnamep, tail);
22730 /* ":8" - shortname */
22731 if (src[*usedlen] == ':' && src[*usedlen + 1] == '8')
22733 *usedlen += 2;
22734 #ifdef WIN3264
22735 has_shortname = 1;
22736 #endif
22739 #ifdef WIN3264
22740 /* Check shortname after we have done 'heads' and before we do 'tails'
22742 if (has_shortname)
22744 pbuf = NULL;
22745 /* Copy the string if it is shortened by :h */
22746 if (*fnamelen < (int)STRLEN(*fnamep))
22748 p = vim_strnsave(*fnamep, *fnamelen);
22749 if (p == 0)
22750 return -1;
22751 vim_free(*bufp);
22752 *bufp = *fnamep = p;
22755 /* Split into two implementations - makes it easier. First is where
22756 * there isn't a full name already, second is where there is.
22758 if (!has_fullname && !vim_isAbsName(*fnamep))
22760 if (shortpath_for_partial(fnamep, bufp, fnamelen) == FAIL)
22761 return -1;
22763 else
22765 int l;
22767 /* Simple case, already have the full-name
22768 * Nearly always shorter, so try first time. */
22769 l = *fnamelen;
22770 if (get_short_pathname(fnamep, bufp, &l) == FAIL)
22771 return -1;
22773 if (l == 0)
22775 /* Couldn't find the filename.. search the paths.
22777 l = *fnamelen;
22778 if (shortpath_for_invalid_fname(fnamep, bufp, &l) == FAIL)
22779 return -1;
22781 *fnamelen = l;
22784 #endif /* WIN3264 */
22786 /* ":t" - tail, just the basename */
22787 if (src[*usedlen] == ':' && src[*usedlen + 1] == 't')
22789 *usedlen += 2;
22790 *fnamelen -= (int)(tail - *fnamep);
22791 *fnamep = tail;
22794 /* ":e" - extension, can be repeated */
22795 /* ":r" - root, without extension, can be repeated */
22796 while (src[*usedlen] == ':'
22797 && (src[*usedlen + 1] == 'e' || src[*usedlen + 1] == 'r'))
22799 /* find a '.' in the tail:
22800 * - for second :e: before the current fname
22801 * - otherwise: The last '.'
22803 if (src[*usedlen + 1] == 'e' && *fnamep > tail)
22804 s = *fnamep - 2;
22805 else
22806 s = *fnamep + *fnamelen - 1;
22807 for ( ; s > tail; --s)
22808 if (s[0] == '.')
22809 break;
22810 if (src[*usedlen + 1] == 'e') /* :e */
22812 if (s > tail)
22814 *fnamelen += (int)(*fnamep - (s + 1));
22815 *fnamep = s + 1;
22816 #ifdef VMS
22817 /* cut version from the extension */
22818 s = *fnamep + *fnamelen - 1;
22819 for ( ; s > *fnamep; --s)
22820 if (s[0] == ';')
22821 break;
22822 if (s > *fnamep)
22823 *fnamelen = s - *fnamep;
22824 #endif
22826 else if (*fnamep <= tail)
22827 *fnamelen = 0;
22829 else /* :r */
22831 if (s > tail) /* remove one extension */
22832 *fnamelen = (int)(s - *fnamep);
22834 *usedlen += 2;
22837 /* ":s?pat?foo?" - substitute */
22838 /* ":gs?pat?foo?" - global substitute */
22839 if (src[*usedlen] == ':'
22840 && (src[*usedlen + 1] == 's'
22841 || (src[*usedlen + 1] == 'g' && src[*usedlen + 2] == 's')))
22843 char_u *str;
22844 char_u *pat;
22845 char_u *sub;
22846 int sep;
22847 char_u *flags;
22848 int didit = FALSE;
22850 flags = (char_u *)"";
22851 s = src + *usedlen + 2;
22852 if (src[*usedlen + 1] == 'g')
22854 flags = (char_u *)"g";
22855 ++s;
22858 sep = *s++;
22859 if (sep)
22861 /* find end of pattern */
22862 p = vim_strchr(s, sep);
22863 if (p != NULL)
22865 pat = vim_strnsave(s, (int)(p - s));
22866 if (pat != NULL)
22868 s = p + 1;
22869 /* find end of substitution */
22870 p = vim_strchr(s, sep);
22871 if (p != NULL)
22873 sub = vim_strnsave(s, (int)(p - s));
22874 str = vim_strnsave(*fnamep, *fnamelen);
22875 if (sub != NULL && str != NULL)
22877 *usedlen = (int)(p + 1 - src);
22878 s = do_string_sub(str, pat, sub, flags);
22879 if (s != NULL)
22881 *fnamep = s;
22882 *fnamelen = (int)STRLEN(s);
22883 vim_free(*bufp);
22884 *bufp = s;
22885 didit = TRUE;
22888 vim_free(sub);
22889 vim_free(str);
22891 vim_free(pat);
22894 /* after using ":s", repeat all the modifiers */
22895 if (didit)
22896 goto repeat;
22900 return valid;
22904 * Perform a substitution on "str" with pattern "pat" and substitute "sub".
22905 * "flags" can be "g" to do a global substitute.
22906 * Returns an allocated string, NULL for error.
22908 char_u *
22909 do_string_sub(str, pat, sub, flags)
22910 char_u *str;
22911 char_u *pat;
22912 char_u *sub;
22913 char_u *flags;
22915 int sublen;
22916 regmatch_T regmatch;
22917 int i;
22918 int do_all;
22919 char_u *tail;
22920 garray_T ga;
22921 char_u *ret;
22922 char_u *save_cpo;
22924 /* Make 'cpoptions' empty, so that the 'l' flag doesn't work here */
22925 save_cpo = p_cpo;
22926 p_cpo = empty_option;
22928 ga_init2(&ga, 1, 200);
22930 do_all = (flags[0] == 'g');
22932 regmatch.rm_ic = p_ic;
22933 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
22934 if (regmatch.regprog != NULL)
22936 tail = str;
22937 while (vim_regexec_nl(&regmatch, str, (colnr_T)(tail - str)))
22940 * Get some space for a temporary buffer to do the substitution
22941 * into. It will contain:
22942 * - The text up to where the match is.
22943 * - The substituted text.
22944 * - The text after the match.
22946 sublen = vim_regsub(&regmatch, sub, tail, FALSE, TRUE, FALSE);
22947 if (ga_grow(&ga, (int)(STRLEN(tail) + sublen -
22948 (regmatch.endp[0] - regmatch.startp[0]))) == FAIL)
22950 ga_clear(&ga);
22951 break;
22954 /* copy the text up to where the match is */
22955 i = (int)(regmatch.startp[0] - tail);
22956 mch_memmove((char_u *)ga.ga_data + ga.ga_len, tail, (size_t)i);
22957 /* add the substituted text */
22958 (void)vim_regsub(&regmatch, sub, (char_u *)ga.ga_data
22959 + ga.ga_len + i, TRUE, TRUE, FALSE);
22960 ga.ga_len += i + sublen - 1;
22961 /* avoid getting stuck on a match with an empty string */
22962 if (tail == regmatch.endp[0])
22964 if (*tail == NUL)
22965 break;
22966 *((char_u *)ga.ga_data + ga.ga_len) = *tail++;
22967 ++ga.ga_len;
22969 else
22971 tail = regmatch.endp[0];
22972 if (*tail == NUL)
22973 break;
22975 if (!do_all)
22976 break;
22979 if (ga.ga_data != NULL)
22980 STRCPY((char *)ga.ga_data + ga.ga_len, tail);
22982 vim_free(regmatch.regprog);
22985 ret = vim_strsave(ga.ga_data == NULL ? str : (char_u *)ga.ga_data);
22986 ga_clear(&ga);
22987 if (p_cpo == empty_option)
22988 p_cpo = save_cpo;
22989 else
22990 /* Darn, evaluating {sub} expression changed the value. */
22991 free_string_option(save_cpo);
22993 return ret;
22996 #endif /* defined(FEAT_MODIFY_FNAME) || defined(FEAT_EVAL) */