blob: 7abde07e354c9f1a1f739811dd6da55de015177b [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
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 */
9
10/*
11 * eval.c: User defined function support
12 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar93343722018-07-10 19:39:18 +020017// flags used in uf_flags
18#define FC_ABORT 0x01 // abort function on error
19#define FC_RANGE 0x02 // function accepts range
20#define FC_DICT 0x04 // Dict function, uses "self"
21#define FC_CLOSURE 0x08 // closure, uses outer scope variables
22#define FC_DELETED 0x10 // :delfunction used while uf_refcount > 0
23#define FC_REMOVED 0x20 // function redefined while uf_refcount > 0
24#define FC_SANDBOX 0x40 // function defined in the sandbox
Bram Moolenaara9b579f2016-07-17 18:29:19 +020025
26/* From user function to hashitem and back. */
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027#define UF2HIKEY(fp) ((fp)->uf_name)
Bram Moolenaar98aefe72018-12-13 22:20:09 +010028#define HIKEY2UF(p) ((ufunc_T *)((p) - offsetof(ufunc_T, uf_name)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +020029#define HI2UF(hi) HIKEY2UF((hi)->hi_key)
30
31#define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j]
32#define FUNCLINE(fp, j) ((char_u **)(fp->uf_lines.ga_data))[j]
33
Bram Moolenaara9b579f2016-07-17 18:29:19 +020034/*
35 * All user-defined functions are found in this hashtable.
36 */
37static hashtab_T func_hashtab;
38
39/* Used by get_func_tv() */
40static garray_T funcargs = GA_EMPTY;
41
Bram Moolenaar209b8e32019-03-14 13:43:24 +010042// pointer to funccal for currently active function
43static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020044
Bram Moolenaar209b8e32019-03-14 13:43:24 +010045// Pointer to list of previously used funccal, still around because some
46// item in it is still being used.
47static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020048
49static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
50static char *e_funcdict = N_("E717: Dictionary entry already exists");
51static char *e_funcref = N_("E718: Funcref required");
52static char *e_nofunc = N_("E130: Unknown function: %s");
53
54#ifdef FEAT_PROFILE
55static void func_do_profile(ufunc_T *fp);
56static void prof_sort_list(FILE *fd, ufunc_T **sorttab, int st_len, char *title, int prefer_self);
57static void prof_func_line(FILE *fd, int count, proftime_T *total, proftime_T *self, int prefer_self);
Bram Moolenaareae1b912019-05-09 15:12:55 +020058static int prof_total_cmp(const void *s1, const void *s2);
59static int prof_self_cmp(const void *s1, const void *s2);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020060#endif
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020061static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020062
63 void
64func_init()
65{
66 hash_init(&func_hashtab);
67}
68
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020069/*
70 * Get function arguments.
71 */
Bram Moolenaara9b579f2016-07-17 18:29:19 +020072 static int
73get_function_args(
74 char_u **argp,
75 char_u endchar,
76 garray_T *newargs,
77 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020078 garray_T *default_args,
Bram Moolenaara9b579f2016-07-17 18:29:19 +020079 int skip)
80{
81 int mustend = FALSE;
82 char_u *arg = *argp;
83 char_u *p = arg;
84 int c;
85 int i;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020086 int any_default = FALSE;
87 char_u *expr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020088
89 if (newargs != NULL)
90 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020091 if (default_args != NULL)
92 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020093
94 if (varargs != NULL)
95 *varargs = FALSE;
96
97 /*
98 * Isolate the arguments: "arg1, arg2, ...)"
99 */
100 while (*p != endchar)
101 {
102 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
103 {
104 if (varargs != NULL)
105 *varargs = TRUE;
106 p += 3;
107 mustend = TRUE;
108 }
109 else
110 {
111 arg = p;
112 while (ASCII_ISALNUM(*p) || *p == '_')
113 ++p;
114 if (arg == p || isdigit(*arg)
115 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
116 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
117 {
118 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100119 semsg(_("E125: Illegal argument: %s"), arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200120 break;
121 }
122 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
Bram Moolenaar19df5cc2016-07-20 22:11:06 +0200123 goto err_ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200124 if (newargs != NULL)
125 {
126 c = *p;
127 *p = NUL;
128 arg = vim_strsave(arg);
129 if (arg == NULL)
Bram Moolenaar19df5cc2016-07-20 22:11:06 +0200130 {
131 *p = c;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200132 goto err_ret;
Bram Moolenaar19df5cc2016-07-20 22:11:06 +0200133 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200134
135 /* Check for duplicate argument name. */
136 for (i = 0; i < newargs->ga_len; ++i)
137 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg) == 0)
138 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100139 semsg(_("E853: Duplicate argument name: %s"), arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200140 vim_free(arg);
141 goto err_ret;
142 }
143 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg;
144 newargs->ga_len++;
145
146 *p = c;
147 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200148 if (*skipwhite(p) == '=' && default_args != NULL)
149 {
150 typval_T rettv;
151
152 any_default = TRUE;
153 p = skipwhite(p) + 1;
154 p = skipwhite(p);
155 expr = p;
156 if (eval1(&p, &rettv, FALSE) != FAIL)
157 {
158 if (ga_grow(default_args, 1) == FAIL)
159 goto err_ret;
160
161 // trim trailing whitespace
162 while (p > expr && VIM_ISWHITE(p[-1]))
163 p--;
164 c = *p;
165 *p = NUL;
166 expr = vim_strsave(expr);
167 if (expr == NULL)
168 {
169 *p = c;
170 goto err_ret;
171 }
172 ((char_u **)(default_args->ga_data))
173 [default_args->ga_len] = expr;
174 default_args->ga_len++;
175 *p = c;
176 }
177 else
178 mustend = TRUE;
179 }
180 else if (any_default)
181 {
182 emsg(_("E989: Non-default argument follows default argument"));
183 mustend = TRUE;
184 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200185 if (*p == ',')
186 ++p;
187 else
188 mustend = TRUE;
189 }
190 p = skipwhite(p);
191 if (mustend && *p != endchar)
192 {
193 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100194 semsg(_(e_invarg2), *argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200195 break;
196 }
197 }
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200198 if (*p != endchar)
199 goto err_ret;
200 ++p; /* skip "endchar" */
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200201
202 *argp = p;
203 return OK;
204
205err_ret:
206 if (newargs != NULL)
207 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200208 if (default_args != NULL)
209 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200210 return FAIL;
211}
212
213/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200214 * Register function "fp" as using "current_funccal" as its scope.
215 */
216 static int
217register_closure(ufunc_T *fp)
218{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200219 if (fp->uf_scoped == current_funccal)
220 /* no change */
221 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200222 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200223 fp->uf_scoped = current_funccal;
224 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200225
Bram Moolenaar58016442016-07-31 18:30:22 +0200226 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
227 return FAIL;
228 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
229 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200230 return OK;
231}
232
233/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200234 * Parse a lambda expression and get a Funcref from "*arg".
235 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
236 */
237 int
238get_lambda_tv(char_u **arg, typval_T *rettv, int evaluate)
239{
240 garray_T newargs;
241 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200242 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200243 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100244 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200245 int varargs;
246 int ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200247 char_u *start = skipwhite(*arg + 1);
248 char_u *s, *e;
249 static int lambda_no = 0;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200250 int *old_eval_lavars = eval_lavars_used;
251 int eval_lavars = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200252
253 ga_init(&newargs);
254 ga_init(&newlines);
255
256 /* First, check if this is a lambda expression. "->" must exist. */
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200257 ret = get_function_args(&start, '-', NULL, NULL, NULL, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200258 if (ret == FAIL || *start != '>')
259 return NOTDONE;
260
261 /* Parse the arguments again. */
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200262 if (evaluate)
263 pnewargs = &newargs;
264 else
265 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 *arg = skipwhite(*arg + 1);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200267 ret = get_function_args(arg, '-', pnewargs, &varargs, NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200268 if (ret == FAIL || **arg != '>')
269 goto errret;
270
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +0200271 /* Set up a flag for checking local variables and arguments. */
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200272 if (evaluate)
273 eval_lavars_used = &eval_lavars;
274
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200275 /* Get the start and the end of the expression. */
276 *arg = skipwhite(*arg + 1);
277 s = *arg;
278 ret = skip_expr(arg);
279 if (ret == FAIL)
280 goto errret;
281 e = *arg;
282 *arg = skipwhite(*arg);
283 if (**arg != '}')
284 goto errret;
285 ++*arg;
286
287 if (evaluate)
288 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200289 int len, flags = 0;
290 char_u *p;
291 char_u name[20];
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200292
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200293 sprintf((char*)name, "<lambda>%d", ++lambda_no);
294
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200295 fp = alloc_clear(sizeof(ufunc_T) + STRLEN(name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200296 if (fp == NULL)
297 goto errret;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200298 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200299 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200300 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200302 ga_init2(&newlines, (int)sizeof(char_u *), 1);
303 if (ga_grow(&newlines, 1) == FAIL)
304 goto errret;
305
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200306 /* Add "return " before the expression. */
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200307 len = 7 + e - s + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200308 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200309 if (p == NULL)
310 goto errret;
311 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
312 STRCPY(p, "return ");
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200313 vim_strncpy(p + 7, s, e - s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314
315 fp->uf_refcount = 1;
316 STRCPY(fp->uf_name, name);
317 hash_add(&func_hashtab, UF2HIKEY(fp));
318 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200319 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200320 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200321 if (current_funccal != NULL && eval_lavars)
322 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200323 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200324 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200325 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200326 }
327 else
328 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200329
330#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200331 if (prof_def_func())
332 func_do_profile(fp);
333#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200334 if (sandbox)
335 flags |= FC_SANDBOX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200337 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200338 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200339 fp->uf_script_ctx = current_sctx;
340 fp->uf_script_ctx.sc_lnum += sourcing_lnum - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200341
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200342 pt->pt_func = fp;
343 pt->pt_refcount = 1;
344 rettv->vval.v_partial = pt;
345 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200346 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200347
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200348 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200349 return OK;
350
351errret:
352 ga_clear_strings(&newargs);
353 ga_clear_strings(&newlines);
354 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100355 vim_free(pt);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200356 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200357 return FAIL;
358}
359
360/*
361 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
362 * name it contains, otherwise return "name".
363 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
364 * "partialp".
365 */
366 char_u *
367deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
368{
369 dictitem_T *v;
370 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200371 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200372
373 if (partialp != NULL)
374 *partialp = NULL;
375
376 cc = name[*lenp];
377 name[*lenp] = NUL;
378 v = find_var(name, NULL, no_autoload);
379 name[*lenp] = cc;
380 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
381 {
382 if (v->di_tv.vval.v_string == NULL)
383 {
384 *lenp = 0;
385 return (char_u *)""; /* just in case */
386 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200387 s = v->di_tv.vval.v_string;
388 *lenp = (int)STRLEN(s);
389 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200390 }
391
392 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
393 {
394 partial_T *pt = v->di_tv.vval.v_partial;
395
396 if (pt == NULL)
397 {
398 *lenp = 0;
399 return (char_u *)""; /* just in case */
400 }
401 if (partialp != NULL)
402 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200403 s = partial_name(pt);
404 *lenp = (int)STRLEN(s);
405 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200406 }
407
408 return name;
409}
410
411/*
412 * Give an error message with a function name. Handle <SNR> things.
413 * "ermsg" is to be passed without translation, use N_() instead of _().
414 */
415 static void
416emsg_funcname(char *ermsg, char_u *name)
417{
418 char_u *p;
419
420 if (*name == K_SPECIAL)
421 p = concat_str((char_u *)"<SNR>", name + 3);
422 else
423 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100424 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200425 if (p != name)
426 vim_free(p);
427}
428
429/*
430 * Allocate a variable for the result of a function.
431 * Return OK or FAIL.
432 */
433 int
434get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200435 char_u *name, // name of the function
436 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200437 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200438 char_u **arg, // argument, pointing to the '('
439 linenr_T firstline, // first line of range
440 linenr_T lastline, // last line of range
441 int *doesrange, // return: function handled range
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200442 int evaluate,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200443 partial_T *partial, // for extra arguments
444 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200445{
446 char_u *argp;
447 int ret = OK;
448 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */
449 int argcount = 0; /* number of arguments found */
450
451 /*
452 * Get the arguments.
453 */
454 argp = *arg;
455 while (argcount < MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
456 {
457 argp = skipwhite(argp + 1); /* skip the '(' or ',' */
458 if (*argp == ')' || *argp == ',' || *argp == NUL)
459 break;
460 if (eval1(&argp, &argvars[argcount], evaluate) == FAIL)
461 {
462 ret = FAIL;
463 break;
464 }
465 ++argcount;
466 if (*argp != ',')
467 break;
468 }
469 if (*argp == ')')
470 ++argp;
471 else
472 ret = FAIL;
473
474 if (ret == OK)
475 {
476 int i = 0;
477
478 if (get_vim_var_nr(VV_TESTING))
479 {
480 /* Prepare for calling test_garbagecollect_now(), need to know
481 * what variables are used on the call stack. */
482 if (funcargs.ga_itemsize == 0)
483 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
484 for (i = 0; i < argcount; ++i)
485 if (ga_grow(&funcargs, 1) == OK)
486 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
487 &argvars[i];
488 }
489
Bram Moolenaardf48fb42016-07-22 21:50:18 +0200490 ret = call_func(name, len, rettv, argcount, argvars, NULL,
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200491 firstline, lastline, doesrange, evaluate, partial, selfdict);
492
493 funcargs.ga_len -= i;
494 }
495 else if (!aborting())
496 {
497 if (argcount == MAX_FUNC_ARGS)
498 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
499 else
500 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
501 }
502
503 while (--argcount >= 0)
504 clear_tv(&argvars[argcount]);
505
506 *arg = skipwhite(argp);
507 return ret;
508}
509
510#define FLEN_FIXED 40
511
512/*
513 * Return TRUE if "p" starts with "<SID>" or "s:".
514 * Only works if eval_fname_script() returned non-zero for "p"!
515 */
516 static int
517eval_fname_sid(char_u *p)
518{
519 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
520}
521
522/*
523 * In a script change <SID>name() and s:name() to K_SNR 123_name().
524 * Change <SNR>123_name() to K_SNR 123_name().
525 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
526 * (slow).
527 */
528 static char_u *
529fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
530{
531 int llen;
532 char_u *fname;
533 int i;
534
535 llen = eval_fname_script(name);
536 if (llen > 0)
537 {
538 fname_buf[0] = K_SPECIAL;
539 fname_buf[1] = KS_EXTRA;
540 fname_buf[2] = (int)KE_SNR;
541 i = 3;
542 if (eval_fname_sid(name)) /* "<SID>" or "s:" */
543 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200544 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200545 *error = ERROR_SCRIPT;
546 else
547 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200548 sprintf((char *)fname_buf + 3, "%ld_",
549 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200550 i = (int)STRLEN(fname_buf);
551 }
552 }
553 if (i + STRLEN(name + llen) < FLEN_FIXED)
554 {
555 STRCPY(fname_buf + i, name + llen);
556 fname = fname_buf;
557 }
558 else
559 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200560 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200561 if (fname == NULL)
562 *error = ERROR_OTHER;
563 else
564 {
565 *tofree = fname;
566 mch_memmove(fname, fname_buf, (size_t)i);
567 STRCPY(fname + i, name + llen);
568 }
569 }
570 }
571 else
572 fname = name;
573 return fname;
574}
575
576/*
577 * Find a function by name, return pointer to it in ufuncs.
578 * Return NULL for unknown function.
579 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200580 ufunc_T *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200581find_func(char_u *name)
582{
583 hashitem_T *hi;
584
585 hi = hash_find(&func_hashtab, name);
586 if (!HASHITEM_EMPTY(hi))
587 return HI2UF(hi);
588 return NULL;
589}
590
591/*
592 * Copy the function name of "fp" to buffer "buf".
593 * "buf" must be able to hold the function name plus three bytes.
594 * Takes care of script-local function names.
595 */
596 static void
597cat_func_name(char_u *buf, ufunc_T *fp)
598{
599 if (fp->uf_name[0] == K_SPECIAL)
600 {
601 STRCPY(buf, "<SNR>");
602 STRCAT(buf, fp->uf_name + 3);
603 }
604 else
605 STRCPY(buf, fp->uf_name);
606}
607
608/*
609 * Add a number variable "name" to dict "dp" with value "nr".
610 */
611 static void
612add_nr_var(
613 dict_T *dp,
614 dictitem_T *v,
615 char *name,
616 varnumber_T nr)
617{
618 STRCPY(v->di_key, name);
619 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
620 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
621 v->di_tv.v_type = VAR_NUMBER;
622 v->di_tv.v_lock = VAR_FIXED;
623 v->di_tv.vval.v_number = nr;
624}
625
626/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100627 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200628 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100629 static void
630free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200631{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100632 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200633
634 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
635 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100636 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200637
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100638 // When garbage collecting a funccall_T may be freed before the
639 // function that references it, clear its uf_scoped field.
640 // The function may have been redefined and point to another
641 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200642 if (fp != NULL && fp->uf_scoped == fc)
643 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200644 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200645 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200646
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200647 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200648 vim_free(fc);
649}
650
651/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100652 * Free "fc" and what it contains.
653 * Can be called only when "fc" is kept beyond the period of it called,
654 * i.e. after cleanup_function_call(fc).
655 */
656 static void
657free_funccal_contents(funccall_T *fc)
658{
659 listitem_T *li;
660
661 // Free all l: variables.
662 vars_clear(&fc->l_vars.dv_hashtab);
663
664 // Free all a: variables.
665 vars_clear(&fc->l_avars.dv_hashtab);
666
667 // Free the a:000 variables.
668 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
669 clear_tv(&li->li_tv);
670
671 free_funccal(fc);
672}
673
674/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200675 * Handle the last part of returning from a function: free the local hashtable.
676 * Unless it is still in use by a closure.
677 */
678 static void
679cleanup_function_call(funccall_T *fc)
680{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100681 int may_free_fc = fc->fc_refcount <= 0;
682 int free_fc = TRUE;
683
Bram Moolenaar6914c642017-04-01 21:21:30 +0200684 current_funccal = fc->caller;
685
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100686 // Free all l: variables if not referred.
687 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
688 vars_clear(&fc->l_vars.dv_hashtab);
689 else
690 free_fc = FALSE;
691
692 // If the a:000 list and the l: and a: dicts are not referenced and
693 // there is no closure using it, we can free the funccall_T and what's
694 // in it.
695 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
696 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200697 else
698 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100699 int todo;
700 hashitem_T *hi;
701 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200702
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100703 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200704
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100705 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200706 todo = (int)fc->l_avars.dv_hashtab.ht_used;
707 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
708 {
709 if (!HASHITEM_EMPTY(hi))
710 {
711 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100712 di = HI2DI(hi);
713 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200714 }
715 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100716 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200717
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100718 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
719 fc->l_varlist.lv_first = NULL;
720 else
721 {
722 listitem_T *li;
723
724 free_fc = FALSE;
725
726 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200727 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
728 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100729 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100730
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100731 if (free_fc)
732 free_funccal(fc);
733 else
734 {
735 static int made_copy = 0;
736
737 // "fc" is still in use. This can happen when returning "a:000",
738 // assigning "l:" to a global variable or defining a closure.
739 // Link "fc" in the list for garbage collection later.
740 fc->caller = previous_funccal;
741 previous_funccal = fc;
742
743 if (want_garbage_collect)
744 // If garbage collector is ready, clear count.
745 made_copy = 0;
746 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100747 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100748 // We have made a lot of copies, worth 4 Mbyte. This can happen
749 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100750 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100751 // too much memory.
752 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100753 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100754 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200755 }
756}
757
758/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200759 * Call a user function.
760 */
761 static void
762call_user_func(
763 ufunc_T *fp, /* pointer to function */
764 int argcount, /* nr of args */
765 typval_T *argvars, /* arguments */
766 typval_T *rettv, /* return value */
767 linenr_T firstline, /* first line of range */
768 linenr_T lastline, /* last line of range */
769 dict_T *selfdict) /* Dictionary for "self" */
770{
771 char_u *save_sourcing_name;
772 linenr_T save_sourcing_lnum;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200773 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +0200774 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200775 funccall_T *fc;
776 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200777 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200778 static int depth = 0;
779 dictitem_T *v;
780 int fixvar_idx = 0; /* index in fixvar[] */
781 int i;
782 int ai;
783 int islambda = FALSE;
784 char_u numbuf[NUMBUFLEN];
785 char_u *name;
786 size_t len;
787#ifdef FEAT_PROFILE
788 proftime_T wait_start;
789 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +0200790 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200791#endif
792
793 /* If depth of calling is getting too high, don't execute the function */
794 if (depth >= p_mfd)
795 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100796 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200797 rettv->v_type = VAR_NUMBER;
798 rettv->vval.v_number = -1;
799 return;
800 }
801 ++depth;
802
803 line_breakcheck(); /* check for CTRL-C hit */
804
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200805 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100806 if (fc == NULL)
807 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200808 fc->caller = current_funccal;
809 current_funccal = fc;
810 fc->func = fp;
811 fc->rettv = rettv;
812 rettv->vval.v_number = 0;
813 fc->linenr = 0;
814 fc->returned = FALSE;
815 fc->level = ex_nesting_level;
816 /* Check if this function has a breakpoint. */
817 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
818 fc->dbg_tick = debug_tick;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200819 /* Set up fields for closure. */
820 fc->fc_refcount = 0;
821 fc->fc_copyID = 0;
822 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200823 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200824
825 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
826 islambda = TRUE;
827
828 /*
829 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
830 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
831 * each argument variable and saves a lot of time.
832 */
833 /*
834 * Init l: variables.
835 */
836 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
837 if (selfdict != NULL)
838 {
839 /* Set l:self to "selfdict". Use "name" to avoid a warning from
840 * some compiler that checks the destination size. */
841 v = &fc->fixvar[fixvar_idx++].var;
842 name = v->di_key;
843 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +0100844 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200845 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
846 v->di_tv.v_type = VAR_DICT;
847 v->di_tv.v_lock = 0;
848 v->di_tv.vval.v_dict = selfdict;
849 ++selfdict->dv_refcount;
850 }
851
852 /*
853 * Init a: variables.
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200854 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200855 * Set a:000 to a list with room for the "..." arguments.
856 */
857 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
858 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200859 (varnumber_T)(argcount >= fp->uf_args.ga_len
860 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +0100861 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200862 /* Use "name" to avoid a warning from some compiler that checks the
863 * destination size. */
864 v = &fc->fixvar[fixvar_idx++].var;
865 name = v->di_key;
866 STRCPY(name, "000");
867 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
868 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
869 v->di_tv.v_type = VAR_LIST;
870 v->di_tv.v_lock = VAR_FIXED;
871 v->di_tv.vval.v_list = &fc->l_varlist;
872 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
873 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
874 fc->l_varlist.lv_lock = VAR_FIXED;
875
876 /*
877 * Set a:firstline to "firstline" and a:lastline to "lastline".
878 * Set a:name to named arguments.
879 * Set a:N to the "..." arguments.
880 */
881 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
882 (varnumber_T)firstline);
883 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
884 (varnumber_T)lastline);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200885 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200886 {
887 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200888 typval_T def_rettv;
889 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200890
891 ai = i - fp->uf_args.ga_len;
892 if (ai < 0)
893 {
894 /* named argument a:name */
895 name = FUNCARG(fp, i);
896 if (islambda)
897 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200898
899 // evaluate named argument default expression
900 isdefault = ai + fp->uf_def_args.ga_len >= 0
901 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
902 && argvars[i].vval.v_number == VVAL_NONE));
903 if (isdefault)
904 {
905 char_u *default_expr = NULL;
906 def_rettv.v_type = VAR_NUMBER;
907 def_rettv.vval.v_number = -1;
908
909 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
910 [ai + fp->uf_def_args.ga_len];
911 if (eval1(&default_expr, &def_rettv, TRUE) == FAIL)
912 {
913 default_arg_err = 1;
914 break;
915 }
916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200917 }
918 else
919 {
920 /* "..." argument a:1, a:2, etc. */
921 sprintf((char *)numbuf, "%d", ai + 1);
922 name = numbuf;
923 }
924 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
925 {
926 v = &fc->fixvar[fixvar_idx++].var;
927 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100928 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200929 }
930 else
931 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100932 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200933 if (v == NULL)
934 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100935 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200936 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200937
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200938 if (isdefault)
939 v->di_tv = def_rettv;
940 else
941 // Note: the values are copied directly to avoid alloc/free.
942 // "argvars" must have VAR_FIXED for v_lock.
943 v->di_tv = argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200944 v->di_tv.v_lock = VAR_FIXED;
945
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200946 if (addlocal)
947 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200948 /* Named arguments should be accessed without the "a:" prefix in
949 * lambda expressions. Add to the l: dict. */
950 copy_tv(&v->di_tv, &v->di_tv);
951 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200952 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200953 else
954 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200955
956 if (ai >= 0 && ai < MAX_FUNC_ARGS)
957 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100958 listitem_T *li = &fc->l_listitems[ai];
959
960 li->li_tv = argvars[i];
961 li->li_tv.v_lock = VAR_FIXED;
962 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200963 }
964 }
965
966 /* Don't redraw while executing the function. */
967 ++RedrawingDisabled;
968 save_sourcing_name = sourcing_name;
969 save_sourcing_lnum = sourcing_lnum;
970 sourcing_lnum = 1;
Bram Moolenaar93343722018-07-10 19:39:18 +0200971
972 if (fp->uf_flags & FC_SANDBOX)
973 {
974 using_sandbox = TRUE;
975 ++sandbox;
976 }
977
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200978 /* need space for function name + ("function " + 3) or "[number]" */
979 len = (save_sourcing_name == NULL ? 0 : STRLEN(save_sourcing_name))
980 + STRLEN(fp->uf_name) + 20;
Bram Moolenaar964b3742019-05-24 18:54:09 +0200981 sourcing_name = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200982 if (sourcing_name != NULL)
983 {
984 if (save_sourcing_name != NULL
985 && STRNCMP(save_sourcing_name, "function ", 9) == 0)
986 sprintf((char *)sourcing_name, "%s[%d]..",
987 save_sourcing_name, (int)save_sourcing_lnum);
988 else
989 STRCPY(sourcing_name, "function ");
990 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp);
991
992 if (p_verbose >= 12)
993 {
994 ++no_wait_return;
995 verbose_enter_scroll();
996
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100997 smsg(_("calling %s"), sourcing_name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200998 if (p_verbose >= 14)
999 {
1000 char_u buf[MSG_BUF_LEN];
1001 char_u numbuf2[NUMBUFLEN];
1002 char_u *tofree;
1003 char_u *s;
1004
Bram Moolenaar32526b32019-01-19 17:43:09 +01001005 msg_puts("(");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001006 for (i = 0; i < argcount; ++i)
1007 {
1008 if (i > 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001009 msg_puts(", ");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001010 if (argvars[i].v_type == VAR_NUMBER)
1011 msg_outnum((long)argvars[i].vval.v_number);
1012 else
1013 {
1014 /* Do not want errors such as E724 here. */
1015 ++emsg_off;
1016 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1017 --emsg_off;
1018 if (s != NULL)
1019 {
1020 if (vim_strsize(s) > MSG_BUF_CLEN)
1021 {
1022 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1023 s = buf;
1024 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001025 msg_puts((char *)s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001026 vim_free(tofree);
1027 }
1028 }
1029 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001030 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001031 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001032 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001033
1034 verbose_leave_scroll();
1035 --no_wait_return;
1036 }
1037 }
1038#ifdef FEAT_PROFILE
1039 if (do_profiling == PROF_YES)
1040 {
1041 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001042 {
1043 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001044 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001045 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001046 if (fp->uf_profiling
1047 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1048 {
1049 ++fp->uf_tm_count;
1050 profile_start(&call_start);
1051 profile_zero(&fp->uf_tm_children);
1052 }
1053 script_prof_save(&wait_start);
1054 }
1055#endif
1056
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001057 save_current_sctx = current_sctx;
1058 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001059 save_did_emsg = did_emsg;
1060 did_emsg = FALSE;
1061
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001062 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1063 did_emsg = TRUE;
1064 else
1065 // call do_cmdline() to execute the lines
1066 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001067 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1068
1069 --RedrawingDisabled;
1070
1071 /* when the function was aborted because of an error, return -1 */
1072 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1073 {
1074 clear_tv(rettv);
1075 rettv->v_type = VAR_NUMBER;
1076 rettv->vval.v_number = -1;
1077 }
1078
1079#ifdef FEAT_PROFILE
1080 if (do_profiling == PROF_YES && (fp->uf_profiling
1081 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1082 {
1083 profile_end(&call_start);
1084 profile_sub_wait(&wait_start, &call_start);
1085 profile_add(&fp->uf_tm_total, &call_start);
1086 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1087 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1088 {
1089 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1090 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1091 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001092 if (started_profiling)
1093 // make a ":profdel func" stop profiling the function
1094 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001095 }
1096#endif
1097
1098 /* when being verbose, mention the return value */
1099 if (p_verbose >= 12)
1100 {
1101 ++no_wait_return;
1102 verbose_enter_scroll();
1103
1104 if (aborting())
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001105 smsg(_("%s aborted"), sourcing_name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001106 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001107 smsg(_("%s returning #%ld"), sourcing_name,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001108 (long)fc->rettv->vval.v_number);
1109 else
1110 {
1111 char_u buf[MSG_BUF_LEN];
1112 char_u numbuf2[NUMBUFLEN];
1113 char_u *tofree;
1114 char_u *s;
1115
1116 /* The value may be very long. Skip the middle part, so that we
1117 * have some idea how it starts and ends. smsg() would always
1118 * truncate it at the end. Don't want errors such as E724 here. */
1119 ++emsg_off;
1120 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1121 --emsg_off;
1122 if (s != NULL)
1123 {
1124 if (vim_strsize(s) > MSG_BUF_CLEN)
1125 {
1126 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1127 s = buf;
1128 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001129 smsg(_("%s returning %s"), sourcing_name, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001130 vim_free(tofree);
1131 }
1132 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01001133 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001134
1135 verbose_leave_scroll();
1136 --no_wait_return;
1137 }
1138
1139 vim_free(sourcing_name);
1140 sourcing_name = save_sourcing_name;
1141 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001142 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001143#ifdef FEAT_PROFILE
1144 if (do_profiling == PROF_YES)
1145 script_prof_restore(&wait_start);
1146#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001147 if (using_sandbox)
1148 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001149
1150 if (p_verbose >= 12 && sourcing_name != NULL)
1151 {
1152 ++no_wait_return;
1153 verbose_enter_scroll();
1154
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001155 smsg(_("continuing in %s"), sourcing_name);
Bram Moolenaar32526b32019-01-19 17:43:09 +01001156 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001157
1158 verbose_leave_scroll();
1159 --no_wait_return;
1160 }
1161
1162 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001163 --depth;
1164
Bram Moolenaar6914c642017-04-01 21:21:30 +02001165 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001166}
1167
1168/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001169 * Unreference "fc": decrement the reference count and free it when it
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001170 * becomes zero. "fp" is detached from "fc".
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001171 * When "force" is TRUE we are exiting.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001172 */
1173 static void
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001174funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001175{
1176 funccall_T **pfc;
1177 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001178
1179 if (fc == NULL)
1180 return;
1181
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001182 if (--fc->fc_refcount <= 0 && (force || (
1183 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001184 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001185 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001186 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001187 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001188 if (fc == *pfc)
1189 {
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001190 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001191 free_funccal_contents(fc);
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001192 return;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001193 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001194 }
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001195 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001196 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001197 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001198}
1199
1200/*
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001201 * Remove the function from the function hashtable. If the function was
1202 * deleted while it still has references this was already done.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001203 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001204 */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001205 static int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001206func_remove(ufunc_T *fp)
1207{
1208 hashitem_T *hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1209
1210 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001211 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001212 hash_remove(&func_hashtab, hi);
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001213 return TRUE;
1214 }
1215 return FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001216}
1217
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02001218 static void
1219func_clear_items(ufunc_T *fp)
1220{
1221 ga_clear_strings(&(fp->uf_args));
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001222 ga_clear_strings(&(fp->uf_def_args));
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02001223 ga_clear_strings(&(fp->uf_lines));
1224#ifdef FEAT_PROFILE
1225 vim_free(fp->uf_tml_count);
1226 fp->uf_tml_count = NULL;
1227 vim_free(fp->uf_tml_total);
1228 fp->uf_tml_total = NULL;
1229 vim_free(fp->uf_tml_self);
1230 fp->uf_tml_self = NULL;
1231#endif
1232}
1233
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001234/*
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001235 * Free all things that a function contains. Does not free the function
1236 * itself, use func_free() for that.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001237 * When "force" is TRUE we are exiting.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001238 */
1239 static void
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001240func_clear(ufunc_T *fp, int force)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001241{
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001242 if (fp->uf_cleared)
1243 return;
1244 fp->uf_cleared = TRUE;
1245
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001246 /* clear this function */
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02001247 func_clear_items(fp);
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001248 funccal_unref(fp->uf_scoped, fp, force);
1249}
1250
1251/*
1252 * Free a function and remove it from the list of functions. Does not free
1253 * what a function contains, call func_clear() first.
1254 */
1255 static void
1256func_free(ufunc_T *fp)
1257{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001258 /* only remove it when not done already, otherwise we would remove a newer
1259 * version of the function */
1260 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1261 func_remove(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001262
1263 vim_free(fp);
1264}
1265
Bram Moolenaarc2574872016-08-11 22:51:05 +02001266/*
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001267 * Free all things that a function contains and free the function itself.
1268 * When "force" is TRUE we are exiting.
1269 */
1270 static void
1271func_clear_free(ufunc_T *fp, int force)
1272{
1273 func_clear(fp, force);
1274 func_free(fp);
1275}
1276
1277/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001278 * There are two kinds of function names:
1279 * 1. ordinary names, function defined with :function
1280 * 2. numbered functions and lambdas
1281 * For the first we only count the name stored in func_hashtab as a reference,
1282 * using function() does not count as a reference, because the function is
1283 * looked up by name.
1284 */
1285 static int
1286func_name_refcount(char_u *name)
1287{
1288 return isdigit(*name) || *name == '<';
1289}
1290
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001291static funccal_entry_T *funccal_stack = NULL;
1292
1293/*
1294 * Save the current function call pointer, and set it to NULL.
1295 * Used when executing autocommands and for ":source".
1296 */
1297 void
1298save_funccal(funccal_entry_T *entry)
1299{
1300 entry->top_funccal = current_funccal;
1301 entry->next = funccal_stack;
1302 funccal_stack = entry;
1303 current_funccal = NULL;
1304}
1305
1306 void
1307restore_funccal(void)
1308{
1309 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001310 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001311 else
1312 {
1313 current_funccal = funccal_stack->top_funccal;
1314 funccal_stack = funccal_stack->next;
1315 }
1316}
1317
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001318#if defined(EXITFREE) || defined(PROTO)
1319 void
1320free_all_functions(void)
1321{
1322 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001323 ufunc_T *fp;
1324 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001325 long_u todo = 1;
1326 long_u used;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001327
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001328 /* Clean up the current_funccal chain and the funccal stack. */
Bram Moolenaar6914c642017-04-01 21:21:30 +02001329 while (current_funccal != NULL)
1330 {
1331 clear_tv(current_funccal->rettv);
1332 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001333 if (current_funccal == NULL && funccal_stack != NULL)
1334 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001335 }
1336
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001337 /* First clear what the functions contain. Since this may lower the
1338 * reference count of a function, it may also free a function and change
1339 * the hash table. Restart if that happens. */
1340 while (todo > 0)
1341 {
1342 todo = func_hashtab.ht_used;
1343 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1344 if (!HASHITEM_EMPTY(hi))
1345 {
1346 /* Only free functions that are not refcounted, those are
1347 * supposed to be freed when no longer referenced. */
1348 fp = HI2UF(hi);
1349 if (func_name_refcount(fp->uf_name))
1350 ++skipped;
1351 else
1352 {
1353 used = func_hashtab.ht_used;
1354 func_clear(fp, TRUE);
1355 if (used != func_hashtab.ht_used)
1356 {
1357 skipped = 0;
1358 break;
1359 }
1360 }
1361 --todo;
1362 }
1363 }
1364
1365 /* Now actually free the functions. Need to start all over every time,
1366 * because func_free() may change the hash table. */
1367 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001368 while (func_hashtab.ht_used > skipped)
1369 {
1370 todo = func_hashtab.ht_used;
1371 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372 if (!HASHITEM_EMPTY(hi))
1373 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001374 --todo;
1375 /* Only free functions that are not refcounted, those are
1376 * supposed to be freed when no longer referenced. */
1377 fp = HI2UF(hi);
1378 if (func_name_refcount(fp->uf_name))
1379 ++skipped;
1380 else
1381 {
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001382 func_free(fp);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001383 skipped = 0;
1384 break;
1385 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001386 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001387 }
1388 if (skipped == 0)
1389 hash_clear(&func_hashtab);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001390}
1391#endif
1392
1393/*
1394 * Return TRUE if "name" looks like a builtin function name: starts with a
1395 * lower case letter and doesn't contain AUTOLOAD_CHAR.
1396 * "len" is the length of "name", or -1 for NUL terminated.
1397 */
1398 static int
1399builtin_function(char_u *name, int len)
1400{
1401 char_u *p;
1402
1403 if (!ASCII_ISLOWER(name[0]))
1404 return FALSE;
1405 p = vim_strchr(name, AUTOLOAD_CHAR);
1406 return p == NULL || (len > 0 && p > name + len);
1407}
1408
1409 int
1410func_call(
1411 char_u *name,
1412 typval_T *args,
1413 partial_T *partial,
1414 dict_T *selfdict,
1415 typval_T *rettv)
1416{
1417 listitem_T *item;
1418 typval_T argv[MAX_FUNC_ARGS + 1];
1419 int argc = 0;
1420 int dummy;
1421 int r = 0;
1422
1423 for (item = args->vval.v_list->lv_first; item != NULL;
1424 item = item->li_next)
1425 {
1426 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1427 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001428 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001429 break;
1430 }
1431 /* Make a copy of each argument. This is needed to be able to set
1432 * v_lock to VAR_FIXED in the copy without changing the original list.
1433 */
1434 copy_tv(&item->li_tv, &argv[argc++]);
1435 }
1436
1437 if (item == NULL)
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001438 r = call_func(name, -1, rettv, argc, argv, NULL,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001439 curwin->w_cursor.lnum, curwin->w_cursor.lnum,
1440 &dummy, TRUE, partial, selfdict);
1441
1442 /* Free the arguments. */
1443 while (argc > 0)
1444 clear_tv(&argv[--argc]);
1445
1446 return r;
1447}
1448
1449/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001450 * Invoke call_func() with a callback.
1451 */
1452 int
1453call_callback(
1454 callback_T *callback,
1455 int len, // length of "name" or -1 to use strlen()
1456 typval_T *rettv, // return value goes here
1457 int argcount, // number of "argvars"
1458 typval_T *argvars, // vars for arguments, must have "argcount"
1459 // PLUS ONE elements!
1460 int (* argv_func)(int, typval_T *, int),
1461 // function to fill in argvars
1462 linenr_T firstline, // first line of range
1463 linenr_T lastline, // last line of range
1464 int *doesrange, // return: function handled range
1465 int evaluate,
1466 dict_T *selfdict) // Dictionary for "self"
1467{
1468 return call_func(callback->cb_name, len, rettv, argcount, argvars,
1469 argv_func, firstline, lastline, doesrange, evaluate,
1470 callback->cb_partial, selfdict);
1471}
1472
1473/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001475 *
1476 * "argv_func", when not NULL, can be used to fill in arguments only when the
1477 * invoked function uses them. It is called like this:
1478 * new_argcount = argv_func(current_argcount, argv, called_func_argcount)
1479 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 * Return FAIL when the function can't be called, OK otherwise.
1481 * Also returns OK when an error was encountered while executing the function.
1482 */
1483 int
1484call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001485 char_u *funcname, // name of the function
1486 int len, // length of "name" or -1 to use strlen()
1487 typval_T *rettv, // return value goes here
1488 int argcount_in, // number of "argvars"
1489 typval_T *argvars_in, // vars for arguments, must have "argcount"
1490 // PLUS ONE elements!
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001491 int (* argv_func)(int, typval_T *, int),
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001492 // function to fill in argvars
1493 linenr_T firstline, // first line of range
1494 linenr_T lastline, // last line of range
1495 int *doesrange, // return: function handled range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496 int evaluate,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001497 partial_T *partial, // optional, can be NULL
1498 dict_T *selfdict_in) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499{
1500 int ret = FAIL;
1501 int error = ERROR_NONE;
1502 int i;
1503 ufunc_T *fp;
1504 char_u fname_buf[FLEN_FIXED + 1];
1505 char_u *tofree = NULL;
1506 char_u *fname;
1507 char_u *name;
1508 int argcount = argcount_in;
1509 typval_T *argvars = argvars_in;
1510 dict_T *selfdict = selfdict_in;
1511 typval_T argv[MAX_FUNC_ARGS + 1]; /* used when "partial" is not NULL */
1512 int argv_clear = 0;
1513
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001514 // Make a copy of the name, if it comes from a funcref variable it could
1515 // be changed or deleted in the called function.
1516 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 if (name == NULL)
1518 return ret;
1519
1520 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1521
1522 *doesrange = FALSE;
1523
1524 if (partial != NULL)
1525 {
1526 /* When the function has a partial with a dict and there is a dict
1527 * argument, use the dict argument. That is backwards compatible.
1528 * When the dict was bound explicitly use the one from the partial. */
1529 if (partial->pt_dict != NULL
1530 && (selfdict_in == NULL || !partial->pt_auto))
1531 selfdict = partial->pt_dict;
1532 if (error == ERROR_NONE && partial->pt_argc > 0)
1533 {
1534 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
1535 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
1536 for (i = 0; i < argcount_in; ++i)
1537 argv[i + argv_clear] = argvars_in[i];
1538 argvars = argv;
1539 argcount = partial->pt_argc + argcount_in;
1540 }
1541 }
1542
1543
Bram Moolenaarb4518562018-05-22 18:31:35 +02001544 /*
1545 * Execute the function if executing and no errors were detected.
1546 */
1547 if (!evaluate)
1548 {
1549 // Not evaluating, which means the return value is unknown. This
1550 // matters for giving error messages.
1551 rettv->v_type = VAR_UNKNOWN;
1552 }
1553 else if (error == ERROR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554 {
1555 char_u *rfname = fname;
1556
1557 /* Ignore "g:" before a function name. */
1558 if (fname[0] == 'g' && fname[1] == ':')
1559 rfname = fname + 2;
1560
1561 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */
1562 rettv->vval.v_number = 0;
1563 error = ERROR_UNKNOWN;
1564
1565 if (!builtin_function(rfname, -1))
1566 {
1567 /*
1568 * User defined function.
1569 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001570 if (partial != NULL && partial->pt_func != NULL)
1571 fp = partial->pt_func;
1572 else
1573 fp = find_func(rfname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575 /* Trigger FuncUndefined event, may load the function. */
1576 if (fp == NULL
1577 && apply_autocmds(EVENT_FUNCUNDEFINED,
1578 rfname, rfname, TRUE, NULL)
1579 && !aborting())
1580 {
1581 /* executed an autocommand, search for the function again */
1582 fp = find_func(rfname);
1583 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 /* Try loading a package. */
1585 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
1586 {
1587 /* loaded a package, search for the function again */
1588 fp = find_func(rfname);
1589 }
1590
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001591 if (fp != NULL && (fp->uf_flags & FC_DELETED))
1592 error = ERROR_DELETED;
1593 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 {
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001595 if (argv_func != NULL)
1596 argcount = argv_func(argcount, argvars, fp->uf_args.ga_len);
1597
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 if (fp->uf_flags & FC_RANGE)
1599 *doesrange = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001600 if (argcount < fp->uf_args.ga_len - fp->uf_def_args.ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 error = ERROR_TOOFEW;
1602 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len)
1603 error = ERROR_TOOMANY;
1604 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1605 error = ERROR_DICT;
1606 else
1607 {
1608 int did_save_redo = FALSE;
Bram Moolenaard4863aa2017-04-07 19:50:12 +02001609 save_redo_T save_redo;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610
1611 /*
1612 * Call the user function.
1613 * Save and restore search patterns, script variables and
1614 * redo buffer.
1615 */
1616 save_search_patterns();
1617#ifdef FEAT_INS_EXPAND
1618 if (!ins_compl_active())
1619#endif
1620 {
Bram Moolenaard4863aa2017-04-07 19:50:12 +02001621 saveRedobuff(&save_redo);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 did_save_redo = TRUE;
1623 }
1624 ++fp->uf_calls;
1625 call_user_func(fp, argcount, argvars, rettv,
1626 firstline, lastline,
1627 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001628 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629 /* Function was unreferenced while being used, free it
1630 * now. */
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001631 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001632 if (did_save_redo)
Bram Moolenaard4863aa2017-04-07 19:50:12 +02001633 restoreRedobuff(&save_redo);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634 restore_search_patterns();
1635 error = ERROR_NONE;
1636 }
1637 }
1638 }
1639 else
1640 {
1641 /*
1642 * Find the function name in the table, call its implementation.
1643 */
1644 error = call_internal_func(fname, argcount, argvars, rettv);
1645 }
1646 /*
1647 * The function call (or "FuncUndefined" autocommand sequence) might
1648 * have been aborted by an error, an interrupt, or an explicitly thrown
1649 * exception that has not been caught so far. This situation can be
1650 * tested for by calling aborting(). For an error in an internal
1651 * function or for the "E132" error in call_user_func(), however, the
1652 * throw point at which the "force_abort" flag (temporarily reset by
1653 * emsg()) is normally updated has not been reached yet. We need to
1654 * update that flag first to make aborting() reliable.
1655 */
1656 update_force_abort();
1657 }
1658 if (error == ERROR_NONE)
1659 ret = OK;
1660
1661 /*
1662 * Report an error unless the argument evaluation or function call has been
1663 * cancelled due to an aborting error, an interrupt, or an exception.
1664 */
1665 if (!aborting())
1666 {
1667 switch (error)
1668 {
1669 case ERROR_UNKNOWN:
1670 emsg_funcname(N_("E117: Unknown function: %s"), name);
1671 break;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001672 case ERROR_DELETED:
1673 emsg_funcname(N_("E933: Function was deleted: %s"), name);
1674 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 case ERROR_TOOMANY:
1676 emsg_funcname((char *)e_toomanyarg, name);
1677 break;
1678 case ERROR_TOOFEW:
1679 emsg_funcname(N_("E119: Not enough arguments for function: %s"),
1680 name);
1681 break;
1682 case ERROR_SCRIPT:
1683 emsg_funcname(N_("E120: Using <SID> not in a script context: %s"),
1684 name);
1685 break;
1686 case ERROR_DICT:
1687 emsg_funcname(N_("E725: Calling dict function without Dictionary: %s"),
1688 name);
1689 break;
1690 }
1691 }
1692
1693 while (argv_clear > 0)
1694 clear_tv(&argv[--argv_clear]);
1695 vim_free(tofree);
1696 vim_free(name);
1697
1698 return ret;
1699}
1700
1701/*
1702 * List the head of the function: "name(arg1, arg2)".
1703 */
1704 static void
1705list_func_head(ufunc_T *fp, int indent)
1706{
1707 int j;
1708
1709 msg_start();
1710 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001711 msg_puts(" ");
1712 msg_puts("function ");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713 if (fp->uf_name[0] == K_SPECIAL)
1714 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001715 msg_puts_attr("<SNR>", HL_ATTR(HLF_8));
1716 msg_puts((char *)fp->uf_name + 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 }
1718 else
Bram Moolenaar32526b32019-01-19 17:43:09 +01001719 msg_puts((char *)fp->uf_name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720 msg_putchar('(');
1721 for (j = 0; j < fp->uf_args.ga_len; ++j)
1722 {
1723 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001724 msg_puts(", ");
1725 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001726 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
1727 {
1728 msg_puts(" = ");
1729 msg_puts(((char **)(fp->uf_def_args.ga_data))
1730 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
1731 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 }
1733 if (fp->uf_varargs)
1734 {
1735 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001736 msg_puts(", ");
1737 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738 }
1739 msg_putchar(')');
1740 if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001741 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001743 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001744 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001745 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001746 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001747 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001748 msg_clr_eos();
1749 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001750 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751}
1752
1753/*
1754 * Get a function name, translating "<SID>" and "<SNR>".
1755 * Also handles a Funcref in a List or Dictionary.
1756 * Returns the function name in allocated memory, or NULL for failure.
1757 * flags:
1758 * TFN_INT: internal function name OK
1759 * TFN_QUIET: be quiet
1760 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02001761 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001762 * Advances "pp" to just after the function name (if no error).
1763 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001764 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765trans_function_name(
1766 char_u **pp,
1767 int skip, /* only find the end, don't evaluate */
1768 int flags,
1769 funcdict_T *fdp, /* return: info about dictionary used */
1770 partial_T **partial) /* return: partial of a FuncRef */
1771{
1772 char_u *name = NULL;
1773 char_u *start;
1774 char_u *end;
1775 int lead;
1776 char_u sid_buf[20];
1777 int len;
1778 lval_T lv;
1779
1780 if (fdp != NULL)
1781 vim_memset(fdp, 0, sizeof(funcdict_T));
1782 start = *pp;
1783
1784 /* Check for hard coded <SNR>: already translated function ID (from a user
1785 * command). */
1786 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
1787 && (*pp)[2] == (int)KE_SNR)
1788 {
1789 *pp += 3;
1790 len = get_id_len(pp) + 3;
1791 return vim_strnsave(start, len);
1792 }
1793
1794 /* A name starting with "<SID>" or "<SNR>" is local to a script. But
1795 * don't skip over "s:", get_lval() needs it for "s:dict.func". */
1796 lead = eval_fname_script(start);
1797 if (lead > 2)
1798 start += lead;
1799
1800 /* Note that TFN_ flags use the same values as GLV_ flags. */
Bram Moolenaar6e65d592017-12-07 22:11:27 +01001801 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802 lead > 2 ? 0 : FNE_CHECK_START);
1803 if (end == start)
1804 {
1805 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001806 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807 goto theend;
1808 }
1809 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
1810 {
1811 /*
1812 * Report an invalid expression in braces, unless the expression
1813 * evaluation has been cancelled due to an aborting error, an
1814 * interrupt, or an exception.
1815 */
1816 if (!aborting())
1817 {
1818 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001819 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 }
1821 else
1822 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
1823 goto theend;
1824 }
1825
1826 if (lv.ll_tv != NULL)
1827 {
1828 if (fdp != NULL)
1829 {
1830 fdp->fd_dict = lv.ll_dict;
1831 fdp->fd_newkey = lv.ll_newkey;
1832 lv.ll_newkey = NULL;
1833 fdp->fd_di = lv.ll_di;
1834 }
1835 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
1836 {
1837 name = vim_strsave(lv.ll_tv->vval.v_string);
1838 *pp = end;
1839 }
1840 else if (lv.ll_tv->v_type == VAR_PARTIAL
1841 && lv.ll_tv->vval.v_partial != NULL)
1842 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001843 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001844 *pp = end;
1845 if (partial != NULL)
1846 *partial = lv.ll_tv->vval.v_partial;
1847 }
1848 else
1849 {
1850 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
1851 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001852 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 else
1854 *pp = end;
1855 name = NULL;
1856 }
1857 goto theend;
1858 }
1859
1860 if (lv.ll_name == NULL)
1861 {
1862 /* Error found, but continue after the function name. */
1863 *pp = end;
1864 goto theend;
1865 }
1866
1867 /* Check if the name is a Funcref. If so, use the value. */
1868 if (lv.ll_exp_name != NULL)
1869 {
1870 len = (int)STRLEN(lv.ll_exp_name);
1871 name = deref_func_name(lv.ll_exp_name, &len, partial,
1872 flags & TFN_NO_AUTOLOAD);
1873 if (name == lv.ll_exp_name)
1874 name = NULL;
1875 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02001876 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877 {
1878 len = (int)(end - *pp);
1879 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
1880 if (name == *pp)
1881 name = NULL;
1882 }
1883 if (name != NULL)
1884 {
1885 name = vim_strsave(name);
1886 *pp = end;
1887 if (STRNCMP(name, "<SNR>", 5) == 0)
1888 {
1889 /* Change "<SNR>" to the byte sequence. */
1890 name[0] = K_SPECIAL;
1891 name[1] = KS_EXTRA;
1892 name[2] = (int)KE_SNR;
1893 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
1894 }
1895 goto theend;
1896 }
1897
1898 if (lv.ll_exp_name != NULL)
1899 {
1900 len = (int)STRLEN(lv.ll_exp_name);
1901 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
1902 && STRNCMP(lv.ll_name, "s:", 2) == 0)
1903 {
1904 /* When there was "s:" already or the name expanded to get a
1905 * leading "s:" then remove it. */
1906 lv.ll_name += 2;
1907 len -= 2;
1908 lead = 2;
1909 }
1910 }
1911 else
1912 {
1913 /* skip over "s:" and "g:" */
1914 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
1915 lv.ll_name += 2;
1916 len = (int)(end - lv.ll_name);
1917 }
1918
1919 /*
1920 * Copy the function name to allocated memory.
1921 * Accept <SID>name() inside a script, translate into <SNR>123_name().
1922 * Accept <SNR>123_name() outside a script.
1923 */
1924 if (skip)
1925 lead = 0; /* do nothing */
1926 else if (lead > 0)
1927 {
1928 lead = 3;
1929 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name))
1930 || eval_fname_sid(*pp))
1931 {
1932 /* It's "s:" or "<SID>" */
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001933 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001935 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001936 goto theend;
1937 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001938 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001939 lead += (int)STRLEN(sid_buf);
1940 }
1941 }
1942 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
1943 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001944 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945 start);
1946 goto theend;
1947 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02001948 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001949 {
1950 char_u *cp = vim_strchr(lv.ll_name, ':');
1951
1952 if (cp != NULL && cp < end)
1953 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001954 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955 goto theend;
1956 }
1957 }
1958
Bram Moolenaar964b3742019-05-24 18:54:09 +02001959 name = alloc(len + lead + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001960 if (name != NULL)
1961 {
1962 if (lead > 0)
1963 {
1964 name[0] = K_SPECIAL;
1965 name[1] = KS_EXTRA;
1966 name[2] = (int)KE_SNR;
1967 if (lead > 3) /* If it's "<SID>" */
1968 STRCPY(name + 3, sid_buf);
1969 }
1970 mch_memmove(name + lead, lv.ll_name, (size_t)len);
1971 name[lead + len] = NUL;
1972 }
1973 *pp = end;
1974
1975theend:
1976 clear_lval(&lv);
1977 return name;
1978}
1979
1980/*
1981 * ":function"
1982 */
1983 void
1984ex_function(exarg_T *eap)
1985{
1986 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02001987 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001988 int j;
1989 int c;
1990 int saved_did_emsg;
1991 int saved_wait_return = need_wait_return;
1992 char_u *name = NULL;
1993 char_u *p;
1994 char_u *arg;
1995 char_u *line_arg = NULL;
1996 garray_T newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001997 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001998 garray_T newlines;
1999 int varargs = FALSE;
2000 int flags = 0;
2001 ufunc_T *fp;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002002 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002003 int indent;
2004 int nesting;
2005 char_u *skip_until = NULL;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002006 char_u *trimmed = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002007 dictitem_T *v;
2008 funcdict_T fudi;
2009 static int func_nr = 0; /* number for nameless function */
2010 int paren;
2011 hashtab_T *ht;
2012 int todo;
2013 hashitem_T *hi;
2014 int sourcing_lnum_off;
2015
2016 /*
2017 * ":function" without argument: list functions.
2018 */
2019 if (ends_excmd(*eap->arg))
2020 {
2021 if (!eap->skip)
2022 {
2023 todo = (int)func_hashtab.ht_used;
2024 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
2025 {
2026 if (!HASHITEM_EMPTY(hi))
2027 {
2028 --todo;
2029 fp = HI2UF(hi);
Bram Moolenaarf86db782018-10-25 13:31:37 +02002030 if (message_filtered(fp->uf_name))
2031 continue;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002032 if (!func_name_refcount(fp->uf_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 list_func_head(fp, FALSE);
2034 }
2035 }
2036 }
2037 eap->nextcmd = check_nextcmd(eap->arg);
2038 return;
2039 }
2040
2041 /*
2042 * ":function /pat": list functions matching pattern.
2043 */
2044 if (*eap->arg == '/')
2045 {
2046 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
2047 if (!eap->skip)
2048 {
2049 regmatch_T regmatch;
2050
2051 c = *p;
2052 *p = NUL;
2053 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2054 *p = c;
2055 if (regmatch.regprog != NULL)
2056 {
2057 regmatch.rm_ic = p_ic;
2058
2059 todo = (int)func_hashtab.ht_used;
2060 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
2061 {
2062 if (!HASHITEM_EMPTY(hi))
2063 {
2064 --todo;
2065 fp = HI2UF(hi);
2066 if (!isdigit(*fp->uf_name)
2067 && vim_regexec(&regmatch, fp->uf_name, 0))
2068 list_func_head(fp, FALSE);
2069 }
2070 }
2071 vim_regfree(regmatch.regprog);
2072 }
2073 }
2074 if (*p == '/')
2075 ++p;
2076 eap->nextcmd = check_nextcmd(p);
2077 return;
2078 }
2079
2080 /*
2081 * Get the function name. There are these situations:
2082 * func normal function name
2083 * "name" == func, "fudi.fd_dict" == NULL
2084 * dict.func new dictionary entry
2085 * "name" == NULL, "fudi.fd_dict" set,
2086 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2087 * dict.func existing dict entry with a Funcref
2088 * "name" == func, "fudi.fd_dict" set,
2089 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2090 * dict.func existing dict entry that's not a Funcref
2091 * "name" == NULL, "fudi.fd_dict" set,
2092 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2093 * s:func script-local function name
2094 * g:func global function name, same as "func"
2095 */
2096 p = eap->arg;
Bram Moolenaar3388d332017-12-07 22:23:04 +01002097 name = trans_function_name(&p, eap->skip, TFN_NO_AUTOLOAD, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002098 paren = (vim_strchr(p, '(') != NULL);
2099 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
2100 {
2101 /*
2102 * Return on an invalid expression in braces, unless the expression
2103 * evaluation has been cancelled due to an aborting error, an
2104 * interrupt, or an exception.
2105 */
2106 if (!aborting())
2107 {
2108 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002109 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 vim_free(fudi.fd_newkey);
2111 return;
2112 }
2113 else
2114 eap->skip = TRUE;
2115 }
2116
2117 /* An error in a function call during evaluation of an expression in magic
2118 * braces should not cause the function not to be defined. */
2119 saved_did_emsg = did_emsg;
2120 did_emsg = FALSE;
2121
2122 /*
2123 * ":function func" with only function name: list function.
2124 */
2125 if (!paren)
2126 {
2127 if (!ends_excmd(*skipwhite(p)))
2128 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002129 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002130 goto ret_free;
2131 }
2132 eap->nextcmd = check_nextcmd(p);
2133 if (eap->nextcmd != NULL)
2134 *p = NUL;
2135 if (!eap->skip && !got_int)
2136 {
2137 fp = find_func(name);
2138 if (fp != NULL)
2139 {
2140 list_func_head(fp, TRUE);
2141 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2142 {
2143 if (FUNCLINE(fp, j) == NULL)
2144 continue;
2145 msg_putchar('\n');
2146 msg_outnum((long)(j + 1));
2147 if (j < 9)
2148 msg_putchar(' ');
2149 if (j < 99)
2150 msg_putchar(' ');
2151 msg_prt_line(FUNCLINE(fp, j), FALSE);
2152 out_flush(); /* show a line at a time */
2153 ui_breakcheck();
2154 }
2155 if (!got_int)
2156 {
2157 msg_putchar('\n');
Bram Moolenaar32526b32019-01-19 17:43:09 +01002158 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159 }
2160 }
2161 else
2162 emsg_funcname(N_("E123: Undefined function: %s"), name);
2163 }
2164 goto ret_free;
2165 }
2166
2167 /*
2168 * ":function name(arg1, arg2)" Define function.
2169 */
2170 p = skipwhite(p);
2171 if (*p != '(')
2172 {
2173 if (!eap->skip)
2174 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002175 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 goto ret_free;
2177 }
2178 /* attempt to continue by skipping some text */
2179 if (vim_strchr(p, '(') != NULL)
2180 p = vim_strchr(p, '(');
2181 }
2182 p = skipwhite(p + 1);
2183
2184 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2185
2186 if (!eap->skip)
2187 {
2188 /* Check the name of the function. Unless it's a dictionary function
2189 * (that we are overwriting). */
2190 if (name != NULL)
2191 arg = name;
2192 else
2193 arg = fudi.fd_newkey;
2194 if (arg != NULL && (fudi.fd_di == NULL
2195 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2196 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2197 {
2198 if (*arg == K_SPECIAL)
2199 j = 3;
2200 else
2201 j = 0;
2202 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2203 : eval_isnamec(arg[j])))
2204 ++j;
2205 if (arg[j] != NUL)
2206 emsg_funcname((char *)e_invarg2, arg);
2207 }
2208 /* Disallow using the g: dict. */
2209 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002210 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211 }
2212
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002213 if (get_function_args(&p, ')', &newargs, &varargs,
2214 &default_args, eap->skip) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002215 goto errret_2;
2216
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002217 /* find extra arguments "range", "dict", "abort" and "closure" */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002218 for (;;)
2219 {
2220 p = skipwhite(p);
2221 if (STRNCMP(p, "range", 5) == 0)
2222 {
2223 flags |= FC_RANGE;
2224 p += 5;
2225 }
2226 else if (STRNCMP(p, "dict", 4) == 0)
2227 {
2228 flags |= FC_DICT;
2229 p += 4;
2230 }
2231 else if (STRNCMP(p, "abort", 5) == 0)
2232 {
2233 flags |= FC_ABORT;
2234 p += 5;
2235 }
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002236 else if (STRNCMP(p, "closure", 7) == 0)
2237 {
2238 flags |= FC_CLOSURE;
2239 p += 7;
Bram Moolenaar58016442016-07-31 18:30:22 +02002240 if (current_funccal == NULL)
2241 {
Bram Moolenaarba209902016-08-24 22:06:38 +02002242 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
Bram Moolenaar58016442016-07-31 18:30:22 +02002243 name == NULL ? (char_u *)"" : name);
2244 goto erret;
2245 }
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002246 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 else
2248 break;
2249 }
2250
2251 /* When there is a line break use what follows for the function body.
2252 * Makes 'exe "func Test()\n...\nendfunc"' work. */
2253 if (*p == '\n')
2254 line_arg = p + 1;
2255 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002256 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002257
2258 /*
2259 * Read the body of the function, until ":endfunction" is found.
2260 */
2261 if (KeyTyped)
2262 {
2263 /* Check if the function already exists, don't let the user type the
2264 * whole function before telling him it doesn't work! For a script we
2265 * need to skip the body to be able to find what follows. */
2266 if (!eap->skip && !eap->forceit)
2267 {
2268 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002269 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002270 else if (name != NULL && find_func(name) != NULL)
2271 emsg_funcname(e_funcexts, name);
2272 }
2273
2274 if (!eap->skip && did_emsg)
2275 goto erret;
2276
2277 msg_putchar('\n'); /* don't overwrite the function name */
2278 cmdline_row = msg_row;
2279 }
2280
2281 indent = 2;
2282 nesting = 0;
2283 for (;;)
2284 {
2285 if (KeyTyped)
2286 {
2287 msg_scroll = TRUE;
2288 saved_wait_return = FALSE;
2289 }
2290 need_wait_return = FALSE;
2291 sourcing_lnum_off = sourcing_lnum;
2292
2293 if (line_arg != NULL)
2294 {
2295 /* Use eap->arg, split up in parts by line breaks. */
2296 theline = line_arg;
2297 p = vim_strchr(theline, '\n');
2298 if (p == NULL)
2299 line_arg += STRLEN(line_arg);
2300 else
2301 {
2302 *p = NUL;
2303 line_arg = p + 1;
2304 }
2305 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002306 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02002307 {
2308 vim_free(line_to_free);
2309 if (eap->getline == NULL)
2310 theline = getcmdline(':', 0L, indent);
2311 else
2312 theline = eap->getline(':', eap->cookie, indent);
2313 line_to_free = theline;
2314 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002315 if (KeyTyped)
2316 lines_left = Rows - 1;
2317 if (theline == NULL)
2318 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002319 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320 goto erret;
2321 }
2322
2323 /* Detect line continuation: sourcing_lnum increased more than one. */
2324 if (sourcing_lnum > sourcing_lnum_off + 1)
2325 sourcing_lnum_off = sourcing_lnum - sourcing_lnum_off - 1;
2326 else
2327 sourcing_lnum_off = 0;
2328
2329 if (skip_until != NULL)
2330 {
Bram Moolenaar8471e572019-05-19 21:37:18 +02002331 // Between ":append" and "." and between ":python <<EOF" and "EOF"
2332 // don't check for ":endfunc".
2333 if (trimmed == NULL
2334 || STRNCMP(theline, trimmed, STRLEN(trimmed)) == 0)
2335 {
2336 p = trimmed == NULL ? theline : theline + STRLEN(trimmed);
2337 if (STRCMP(p, skip_until) == 0)
2338 {
2339 VIM_CLEAR(skip_until);
2340 VIM_CLEAR(trimmed);
2341 }
2342 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 }
2344 else
2345 {
2346 /* skip ':' and blanks*/
Bram Moolenaar1c465442017-03-12 20:10:05 +01002347 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 ;
2349
2350 /* Check for "endfunction". */
2351 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0)
2352 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02002353 char_u *nextcmd = NULL;
2354
Bram Moolenaar663bb232017-06-22 19:12:10 +02002355 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02002356 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002357 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02002358 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002359 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaarf8be4612017-06-23 20:52:40 +02002360 give_warning2(
2361 (char_u *)_("W22: Text found after :endfunction: %s"),
2362 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002363 if (nextcmd != NULL)
2364 {
2365 /* Another command follows. If the line came from "eap" we
2366 * can simply point into it, otherwise we need to change
2367 * "eap->cmdlinep". */
2368 eap->nextcmd = nextcmd;
2369 if (line_to_free != NULL)
2370 {
2371 vim_free(*eap->cmdlinep);
2372 *eap->cmdlinep = line_to_free;
2373 line_to_free = NULL;
2374 }
2375 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 break;
2377 }
2378
2379 /* Increase indent inside "if", "while", "for" and "try", decrease
2380 * at "end". */
2381 if (indent > 2 && STRNCMP(p, "end", 3) == 0)
2382 indent -= 2;
2383 else if (STRNCMP(p, "if", 2) == 0
2384 || STRNCMP(p, "wh", 2) == 0
2385 || STRNCMP(p, "for", 3) == 0
2386 || STRNCMP(p, "try", 3) == 0)
2387 indent += 2;
2388
2389 /* Check for defining a function inside this function. */
2390 if (checkforcmd(&p, "function", 2))
2391 {
2392 if (*p == '!')
2393 p = skipwhite(p + 1);
2394 p += eval_fname_script(p);
2395 vim_free(trans_function_name(&p, TRUE, 0, NULL, NULL));
2396 if (*skipwhite(p) == '(')
2397 {
2398 ++nesting;
2399 indent += 2;
2400 }
2401 }
2402
Bram Moolenaar70bcd732017-01-12 22:20:54 +01002403 /* Check for ":append", ":change", ":insert". */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 p = skip_range(p, NULL);
2405 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01002406 || (p[0] == 'c'
2407 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
2408 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
2409 && (STRNCMP(&p[3], "nge", 3) != 0
2410 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411 || (p[0] == 'i'
2412 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
2413 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's'))))))
2414 skip_until = vim_strsave((char_u *)".");
2415
2416 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */
2417 arg = skipwhite(skiptowhite(p));
2418 if (arg[0] == '<' && arg[1] =='<'
2419 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01002420 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
2421 || ((p[2] == '3' || p[2] == 'x')
2422 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423 || (p[0] == 'p' && p[1] == 'e'
2424 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
2425 || (p[0] == 't' && p[1] == 'c'
2426 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
2427 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
2428 && !ASCII_ISALPHA(p[3]))
2429 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
2430 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
2431 || (p[0] == 'm' && p[1] == 'z'
2432 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
2433 ))
2434 {
2435 /* ":python <<" continues until a dot, like ":append" */
2436 p = skipwhite(arg + 2);
2437 if (*p == NUL)
2438 skip_until = vim_strsave((char_u *)".");
2439 else
2440 skip_until = vim_strsave(p);
2441 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02002442
2443 // Check for ":let v =<< [trim] EOF"
2444 arg = skipwhite(skiptowhite(p));
2445 arg = skipwhite(skiptowhite(arg));
2446 if (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
2447 && ((p[0] == 'l'
2448 && p[1] == 'e'
2449 && (!ASCII_ISALNUM(p[2])
2450 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
2451 {
2452 // ":let v =<<" continues until a dot
2453 p = skipwhite(arg + 3);
2454 if (STRNCMP(p, "trim", 4) == 0)
2455 {
2456 // Ignore leading white space.
2457 p = skipwhite(p + 4);
2458 trimmed = vim_strnsave(theline,
2459 (int)(skipwhite(theline) - theline));
2460 }
2461 if (*p == NUL)
2462 skip_until = vim_strsave((char_u *)".");
2463 else
2464 skip_until = vim_strnsave(p, (int)(skiptowhite(p) - p));
2465 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 }
2467
2468 /* Add the line to the function. */
2469 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002470 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471
2472 /* Copy the line to newly allocated memory. get_one_sourceline()
2473 * allocates 250 bytes per line, this saves 80% on average. The cost
2474 * is an extra alloc/free. */
2475 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002476 if (p == NULL)
2477 goto erret;
2478 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479
2480 /* Add NULL lines for continuation lines, so that the line count is
2481 * equal to the index in the growarray. */
2482 while (sourcing_lnum_off-- > 0)
2483 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2484
2485 /* Check for end of eap->arg. */
2486 if (line_arg != NULL && *line_arg == NUL)
2487 line_arg = NULL;
2488 }
2489
2490 /* Don't define the function when skipping commands or when an error was
2491 * detected. */
2492 if (eap->skip || did_emsg)
2493 goto erret;
2494
2495 /*
2496 * If there are no errors, add the function
2497 */
2498 if (fudi.fd_dict == NULL)
2499 {
2500 v = find_var(name, &ht, FALSE);
2501 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
2502 {
2503 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
2504 name);
2505 goto erret;
2506 }
2507
2508 fp = find_func(name);
2509 if (fp != NULL)
2510 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01002511 // Function can be replaced with "function!" and when sourcing the
2512 // same script again, but only once.
2513 if (!eap->forceit
2514 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
2515 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516 {
2517 emsg_funcname(e_funcexts, name);
2518 goto erret;
2519 }
2520 if (fp->uf_calls > 0)
2521 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01002522 emsg_funcname(
2523 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 name);
2525 goto erret;
2526 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002527 if (fp->uf_refcount > 1)
2528 {
2529 /* This function is referenced somewhere, don't redefine it but
2530 * create a new one. */
2531 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002532 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002533 fp = NULL;
2534 overwrite = TRUE;
2535 }
2536 else
2537 {
2538 /* redefine existing function */
Bram Moolenaard23a8232018-02-10 18:45:26 +01002539 VIM_CLEAR(name);
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02002540 func_clear_items(fp);
2541#ifdef FEAT_PROFILE
2542 fp->uf_profiling = FALSE;
2543 fp->uf_prof_initialized = FALSE;
2544#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002545 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546 }
2547 }
2548 else
2549 {
2550 char numbuf[20];
2551
2552 fp = NULL;
2553 if (fudi.fd_newkey == NULL && !eap->forceit)
2554 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002555 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 goto erret;
2557 }
2558 if (fudi.fd_di == NULL)
2559 {
2560 /* Can't add a function to a locked dictionary */
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002561 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002562 goto erret;
2563 }
2564 /* Can't change an existing function if it is locked */
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002565 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566 goto erret;
2567
2568 /* Give the function a sequential number. Can only be used with a
2569 * Funcref! */
2570 vim_free(name);
2571 sprintf(numbuf, "%d", ++func_nr);
2572 name = vim_strsave((char_u *)numbuf);
2573 if (name == NULL)
2574 goto erret;
2575 }
2576
2577 if (fp == NULL)
2578 {
2579 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
2580 {
2581 int slen, plen;
2582 char_u *scriptname;
2583
2584 /* Check that the autoload name matches the script name. */
2585 j = FAIL;
2586 if (sourcing_name != NULL)
2587 {
2588 scriptname = autoload_name(name);
2589 if (scriptname != NULL)
2590 {
2591 p = vim_strchr(scriptname, '/');
2592 plen = (int)STRLEN(p);
2593 slen = (int)STRLEN(sourcing_name);
2594 if (slen > plen && fnamecmp(p,
2595 sourcing_name + slen - plen) == 0)
2596 j = OK;
2597 vim_free(scriptname);
2598 }
2599 }
2600 if (j == FAIL)
2601 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002602 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 goto erret;
2604 }
2605 }
2606
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002607 fp = alloc_clear(sizeof(ufunc_T) + STRLEN(name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 if (fp == NULL)
2609 goto erret;
2610
2611 if (fudi.fd_dict != NULL)
2612 {
2613 if (fudi.fd_di == NULL)
2614 {
2615 /* add new dict entry */
2616 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
2617 if (fudi.fd_di == NULL)
2618 {
2619 vim_free(fp);
2620 goto erret;
2621 }
2622 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
2623 {
2624 vim_free(fudi.fd_di);
2625 vim_free(fp);
2626 goto erret;
2627 }
2628 }
2629 else
2630 /* overwrite existing dict entry */
2631 clear_tv(&fudi.fd_di->di_tv);
2632 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634
2635 /* behave like "dict" was used */
2636 flags |= FC_DICT;
2637 }
2638
2639 /* insert the new function in the function list */
2640 STRCPY(fp->uf_name, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002641 if (overwrite)
2642 {
2643 hi = hash_find(&func_hashtab, name);
2644 hi->hi_key = UF2HIKEY(fp);
2645 }
2646 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 {
2648 vim_free(fp);
2649 goto erret;
2650 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002651 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 }
2653 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002654 fp->uf_def_args = default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002656 if ((flags & FC_CLOSURE) != 0)
2657 {
Bram Moolenaar58016442016-07-31 18:30:22 +02002658 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002659 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002660 }
2661 else
2662 fp->uf_scoped = NULL;
2663
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 if (prof_def_func())
2666 func_do_profile(fp);
2667#endif
2668 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02002669 if (sandbox)
2670 flags |= FC_SANDBOX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002671 fp->uf_flags = flags;
2672 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002673 fp->uf_script_ctx = current_sctx;
2674 fp->uf_script_ctx.sc_lnum += sourcing_lnum - newlines.ga_len - 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 goto ret_free;
2676
2677erret:
2678 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002679 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002680errret_2:
2681 ga_clear_strings(&newlines);
2682ret_free:
2683 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002684 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 vim_free(fudi.fd_newkey);
2686 vim_free(name);
2687 did_emsg |= saved_did_emsg;
2688 need_wait_return |= saved_wait_return;
2689}
2690
2691/*
2692 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
2693 * Return 2 if "p" starts with "s:".
2694 * Return 0 otherwise.
2695 */
2696 int
2697eval_fname_script(char_u *p)
2698{
2699 /* Use MB_STRICMP() because in Turkish comparing the "I" may not work with
2700 * the standard library function. */
2701 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
2702 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
2703 return 5;
2704 if (p[0] == 's' && p[1] == ':')
2705 return 2;
2706 return 0;
2707}
2708
2709 int
2710translated_function_exists(char_u *name)
2711{
2712 if (builtin_function(name, -1))
2713 return find_internal_func(name) >= 0;
2714 return find_func(name) != NULL;
2715}
2716
2717/*
2718 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002719 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 */
2721 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002722function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723{
2724 char_u *nm = name;
2725 char_u *p;
2726 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002727 int flag;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002729 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
2730 if (no_deref)
2731 flag |= TFN_NO_DEREF;
2732 p = trans_function_name(&nm, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002733 nm = skipwhite(nm);
2734
2735 /* Only accept "funcname", "funcname ", "funcname (..." and
2736 * "funcname(...", not "funcname!...". */
2737 if (p != NULL && (*nm == NUL || *nm == '('))
2738 n = translated_function_exists(p);
2739 vim_free(p);
2740 return n;
2741}
2742
Bram Moolenaar113e1072019-01-20 15:30:40 +01002743#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 char_u *
2745get_expanded_name(char_u *name, int check)
2746{
2747 char_u *nm = name;
2748 char_u *p;
2749
2750 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL, NULL);
2751
2752 if (p != NULL && *nm == NUL)
2753 if (!check || translated_function_exists(p))
2754 return p;
2755
2756 vim_free(p);
2757 return NULL;
2758}
Bram Moolenaar113e1072019-01-20 15:30:40 +01002759#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760
2761#if defined(FEAT_PROFILE) || defined(PROTO)
2762/*
2763 * Start profiling function "fp".
2764 */
2765 static void
2766func_do_profile(ufunc_T *fp)
2767{
2768 int len = fp->uf_lines.ga_len;
2769
Bram Moolenaarad648092018-06-30 18:28:03 +02002770 if (!fp->uf_prof_initialized)
2771 {
2772 if (len == 0)
2773 len = 1; /* avoid getting error for allocating zero bytes */
2774 fp->uf_tm_count = 0;
2775 profile_zero(&fp->uf_tm_self);
2776 profile_zero(&fp->uf_tm_total);
2777 if (fp->uf_tml_count == NULL)
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002778 fp->uf_tml_count = ALLOC_CLEAR_MULT(int, len);
Bram Moolenaarad648092018-06-30 18:28:03 +02002779 if (fp->uf_tml_total == NULL)
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002780 fp->uf_tml_total = ALLOC_CLEAR_MULT(proftime_T, len);
Bram Moolenaarad648092018-06-30 18:28:03 +02002781 if (fp->uf_tml_self == NULL)
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002782 fp->uf_tml_self = ALLOC_CLEAR_MULT(proftime_T, len);
Bram Moolenaarad648092018-06-30 18:28:03 +02002783 fp->uf_tml_idx = -1;
2784 if (fp->uf_tml_count == NULL || fp->uf_tml_total == NULL
2785 || fp->uf_tml_self == NULL)
2786 return; /* out of memory */
2787 fp->uf_prof_initialized = TRUE;
2788 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789
2790 fp->uf_profiling = TRUE;
2791}
2792
2793/*
2794 * Dump the profiling results for all functions in file "fd".
2795 */
2796 void
2797func_dump_profile(FILE *fd)
2798{
2799 hashitem_T *hi;
2800 int todo;
2801 ufunc_T *fp;
2802 int i;
2803 ufunc_T **sorttab;
2804 int st_len = 0;
Bram Moolenaar4c7b08f2018-09-10 22:03:40 +02002805 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806
2807 todo = (int)func_hashtab.ht_used;
2808 if (todo == 0)
2809 return; /* nothing to dump */
2810
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002811 sorttab = ALLOC_MULT(ufunc_T *, todo);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812
2813 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2814 {
2815 if (!HASHITEM_EMPTY(hi))
2816 {
2817 --todo;
2818 fp = HI2UF(hi);
Bram Moolenaarad648092018-06-30 18:28:03 +02002819 if (fp->uf_prof_initialized)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 {
2821 if (sorttab != NULL)
2822 sorttab[st_len++] = fp;
2823
2824 if (fp->uf_name[0] == K_SPECIAL)
2825 fprintf(fd, "FUNCTION <SNR>%s()\n", fp->uf_name + 3);
2826 else
2827 fprintf(fd, "FUNCTION %s()\n", fp->uf_name);
Bram Moolenaar4c7b08f2018-09-10 22:03:40 +02002828 p = home_replace_save(NULL,
2829 get_scriptname(fp->uf_script_ctx.sc_sid));
2830 if (p != NULL)
2831 {
2832 fprintf(fd, " Defined: %s line %ld\n",
2833 p, (long)fp->uf_script_ctx.sc_lnum);
2834 vim_free(p);
2835 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836 if (fp->uf_tm_count == 1)
2837 fprintf(fd, "Called 1 time\n");
2838 else
2839 fprintf(fd, "Called %d times\n", fp->uf_tm_count);
2840 fprintf(fd, "Total time: %s\n", profile_msg(&fp->uf_tm_total));
2841 fprintf(fd, " Self time: %s\n", profile_msg(&fp->uf_tm_self));
2842 fprintf(fd, "\n");
2843 fprintf(fd, "count total (s) self (s)\n");
2844
2845 for (i = 0; i < fp->uf_lines.ga_len; ++i)
2846 {
2847 if (FUNCLINE(fp, i) == NULL)
2848 continue;
2849 prof_func_line(fd, fp->uf_tml_count[i],
2850 &fp->uf_tml_total[i], &fp->uf_tml_self[i], TRUE);
2851 fprintf(fd, "%s\n", FUNCLINE(fp, i));
2852 }
2853 fprintf(fd, "\n");
2854 }
2855 }
2856 }
2857
2858 if (sorttab != NULL && st_len > 0)
2859 {
2860 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
2861 prof_total_cmp);
2862 prof_sort_list(fd, sorttab, st_len, "TOTAL", FALSE);
2863 qsort((void *)sorttab, (size_t)st_len, sizeof(ufunc_T *),
2864 prof_self_cmp);
2865 prof_sort_list(fd, sorttab, st_len, "SELF", TRUE);
2866 }
2867
2868 vim_free(sorttab);
2869}
2870
2871 static void
2872prof_sort_list(
2873 FILE *fd,
2874 ufunc_T **sorttab,
2875 int st_len,
2876 char *title,
2877 int prefer_self) /* when equal print only self time */
2878{
2879 int i;
2880 ufunc_T *fp;
2881
2882 fprintf(fd, "FUNCTIONS SORTED ON %s TIME\n", title);
2883 fprintf(fd, "count total (s) self (s) function\n");
2884 for (i = 0; i < 20 && i < st_len; ++i)
2885 {
2886 fp = sorttab[i];
2887 prof_func_line(fd, fp->uf_tm_count, &fp->uf_tm_total, &fp->uf_tm_self,
2888 prefer_self);
2889 if (fp->uf_name[0] == K_SPECIAL)
2890 fprintf(fd, " <SNR>%s()\n", fp->uf_name + 3);
2891 else
2892 fprintf(fd, " %s()\n", fp->uf_name);
2893 }
2894 fprintf(fd, "\n");
2895}
2896
2897/*
2898 * Print the count and times for one function or function line.
2899 */
2900 static void
2901prof_func_line(
2902 FILE *fd,
2903 int count,
2904 proftime_T *total,
2905 proftime_T *self,
2906 int prefer_self) /* when equal print only self time */
2907{
2908 if (count > 0)
2909 {
2910 fprintf(fd, "%5d ", count);
2911 if (prefer_self && profile_equal(total, self))
2912 fprintf(fd, " ");
2913 else
2914 fprintf(fd, "%s ", profile_msg(total));
2915 if (!prefer_self && profile_equal(total, self))
2916 fprintf(fd, " ");
2917 else
2918 fprintf(fd, "%s ", profile_msg(self));
2919 }
2920 else
2921 fprintf(fd, " ");
2922}
2923
2924/*
2925 * Compare function for total time sorting.
2926 */
2927 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928prof_total_cmp(const void *s1, const void *s2)
2929{
2930 ufunc_T *p1, *p2;
2931
2932 p1 = *(ufunc_T **)s1;
2933 p2 = *(ufunc_T **)s2;
2934 return profile_cmp(&p1->uf_tm_total, &p2->uf_tm_total);
2935}
2936
2937/*
2938 * Compare function for self time sorting.
2939 */
2940 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941prof_self_cmp(const void *s1, const void *s2)
2942{
2943 ufunc_T *p1, *p2;
2944
2945 p1 = *(ufunc_T **)s1;
2946 p2 = *(ufunc_T **)s2;
2947 return profile_cmp(&p1->uf_tm_self, &p2->uf_tm_self);
2948}
2949
2950/*
2951 * Prepare profiling for entering a child or something else that is not
2952 * counted for the script/function itself.
2953 * Should always be called in pair with prof_child_exit().
2954 */
2955 void
2956prof_child_enter(
2957 proftime_T *tm) /* place to store waittime */
2958{
2959 funccall_T *fc = current_funccal;
2960
2961 if (fc != NULL && fc->func->uf_profiling)
2962 profile_start(&fc->prof_child);
2963 script_prof_save(tm);
2964}
2965
2966/*
2967 * Take care of time spent in a child.
2968 * Should always be called after prof_child_enter().
2969 */
2970 void
2971prof_child_exit(
2972 proftime_T *tm) /* where waittime was stored */
2973{
2974 funccall_T *fc = current_funccal;
2975
2976 if (fc != NULL && fc->func->uf_profiling)
2977 {
2978 profile_end(&fc->prof_child);
2979 profile_sub_wait(tm, &fc->prof_child); /* don't count waiting time */
2980 profile_add(&fc->func->uf_tm_children, &fc->prof_child);
2981 profile_add(&fc->func->uf_tml_children, &fc->prof_child);
2982 }
2983 script_prof_restore(tm);
2984}
2985
2986#endif /* FEAT_PROFILE */
2987
2988#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
2989
2990/*
2991 * Function given to ExpandGeneric() to obtain the list of user defined
2992 * function names.
2993 */
2994 char_u *
2995get_user_func_name(expand_T *xp, int idx)
2996{
2997 static long_u done;
2998 static hashitem_T *hi;
2999 ufunc_T *fp;
3000
3001 if (idx == 0)
3002 {
3003 done = 0;
3004 hi = func_hashtab.ht_array;
3005 }
3006 if (done < func_hashtab.ht_used)
3007 {
3008 if (done++ > 0)
3009 ++hi;
3010 while (HASHITEM_EMPTY(hi))
3011 ++hi;
3012 fp = HI2UF(hi);
3013
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003014 if ((fp->uf_flags & FC_DICT)
3015 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
3016 return (char_u *)""; /* don't show dict and lambda functions */
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017
3018 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
3019 return fp->uf_name; /* prevents overflow */
3020
3021 cat_func_name(IObuff, fp);
3022 if (xp->xp_context != EXPAND_USER_FUNC)
3023 {
3024 STRCAT(IObuff, "(");
3025 if (!fp->uf_varargs && fp->uf_args.ga_len == 0)
3026 STRCAT(IObuff, ")");
3027 }
3028 return IObuff;
3029 }
3030 return NULL;
3031}
3032
3033#endif /* FEAT_CMDL_COMPL */
3034
3035/*
3036 * ":delfunction {name}"
3037 */
3038 void
3039ex_delfunction(exarg_T *eap)
3040{
3041 ufunc_T *fp = NULL;
3042 char_u *p;
3043 char_u *name;
3044 funcdict_T fudi;
3045
3046 p = eap->arg;
3047 name = trans_function_name(&p, eap->skip, 0, &fudi, NULL);
3048 vim_free(fudi.fd_newkey);
3049 if (name == NULL)
3050 {
3051 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003052 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 return;
3054 }
3055 if (!ends_excmd(*skipwhite(p)))
3056 {
3057 vim_free(name);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003058 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 return;
3060 }
3061 eap->nextcmd = check_nextcmd(p);
3062 if (eap->nextcmd != NULL)
3063 *p = NUL;
3064
3065 if (!eap->skip)
3066 fp = find_func(name);
3067 vim_free(name);
3068
3069 if (!eap->skip)
3070 {
3071 if (fp == NULL)
3072 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003073 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003074 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003075 return;
3076 }
3077 if (fp->uf_calls > 0)
3078 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003079 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003080 return;
3081 }
3082
3083 if (fudi.fd_dict != NULL)
3084 {
3085 /* Delete the dict item that refers to the function, it will
3086 * invoke func_unref() and possibly delete the function. */
3087 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3088 }
3089 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003090 {
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003091 /* A normal function (not a numbered function or lambda) has a
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003092 * refcount of 1 for the entry in the hashtable. When deleting
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003093 * it and the refcount is more than one, it should be kept.
Bram Moolenaarba209902016-08-24 22:06:38 +02003094 * A numbered function and lambda should be kept if the refcount is
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003095 * one or more. */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003096 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003097 {
3098 /* Function is still referenced somewhere. Don't free it but
3099 * do remove it from the hashtable. */
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003100 if (func_remove(fp))
3101 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003102 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003103 }
3104 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003105 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003106 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003107 }
3108}
3109
3110/*
3111 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003112 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 */
3114 void
3115func_unref(char_u *name)
3116{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003117 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003119 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120 return;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003121 fp = find_func(name);
3122 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003125 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003127 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003129 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003131 /* Only delete it when it's not being used. Otherwise it's done
3132 * when "uf_calls" becomes zero. */
3133 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003134 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003135 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003136}
3137
3138/*
3139 * Unreference a Function: decrement the reference count and free it when it
3140 * becomes zero.
3141 */
3142 void
3143func_ptr_unref(ufunc_T *fp)
3144{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003145 if (fp != NULL && --fp->uf_refcount <= 0)
3146 {
3147 /* Only delete it when it's not being used. Otherwise it's done
3148 * when "uf_calls" becomes zero. */
3149 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003150 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 }
3152}
3153
3154/*
3155 * Count a reference to a Function.
3156 */
3157 void
3158func_ref(char_u *name)
3159{
3160 ufunc_T *fp;
3161
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003162 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163 return;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003164 fp = find_func(name);
3165 if (fp != NULL)
3166 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 else if (isdigit(*name))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003168 /* Only give an error for a numbered function.
3169 * Fail silently, when named or lambda function isn't found. */
Bram Moolenaar95f09602016-11-10 20:01:45 +01003170 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003171}
3172
3173/*
3174 * Count a reference to a Function.
3175 */
3176 void
3177func_ptr_ref(ufunc_T *fp)
3178{
3179 if (fp != NULL)
3180 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003181}
3182
3183/*
3184 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3185 * referenced from anywhere that is in use.
3186 */
3187 static int
3188can_free_funccal(funccall_T *fc, int copyID)
3189{
3190 return (fc->l_varlist.lv_copyID != copyID
3191 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003192 && fc->l_avars.dv_copyID != copyID
3193 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194}
3195
3196/*
3197 * ":return [expr]"
3198 */
3199 void
3200ex_return(exarg_T *eap)
3201{
3202 char_u *arg = eap->arg;
3203 typval_T rettv;
3204 int returning = FALSE;
3205
3206 if (current_funccal == NULL)
3207 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003208 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 return;
3210 }
3211
3212 if (eap->skip)
3213 ++emsg_skip;
3214
3215 eap->nextcmd = NULL;
3216 if ((*arg != NUL && *arg != '|' && *arg != '\n')
3217 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
3218 {
3219 if (!eap->skip)
3220 returning = do_return(eap, FALSE, TRUE, &rettv);
3221 else
3222 clear_tv(&rettv);
3223 }
3224 /* It's safer to return also on error. */
3225 else if (!eap->skip)
3226 {
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003227 /* In return statement, cause_abort should be force_abort. */
3228 update_force_abort();
3229
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 /*
3231 * Return unless the expression evaluation has been cancelled due to an
3232 * aborting error, an interrupt, or an exception.
3233 */
3234 if (!aborting())
3235 returning = do_return(eap, FALSE, TRUE, NULL);
3236 }
3237
3238 /* When skipping or the return gets pending, advance to the next command
3239 * in this line (!returning). Otherwise, ignore the rest of the line.
3240 * Following lines will be ignored by get_func_line(). */
3241 if (returning)
3242 eap->nextcmd = NULL;
3243 else if (eap->nextcmd == NULL) /* no argument */
3244 eap->nextcmd = check_nextcmd(arg);
3245
3246 if (eap->skip)
3247 --emsg_skip;
3248}
3249
3250/*
3251 * ":1,25call func(arg1, arg2)" function call.
3252 */
3253 void
3254ex_call(exarg_T *eap)
3255{
3256 char_u *arg = eap->arg;
3257 char_u *startarg;
3258 char_u *name;
3259 char_u *tofree;
3260 int len;
3261 typval_T rettv;
3262 linenr_T lnum;
3263 int doesrange;
3264 int failed = FALSE;
3265 funcdict_T fudi;
3266 partial_T *partial = NULL;
3267
3268 if (eap->skip)
3269 {
3270 /* trans_function_name() doesn't work well when skipping, use eval0()
3271 * instead to skip to any following command, e.g. for:
3272 * :if 0 | call dict.foo().bar() | endif */
3273 ++emsg_skip;
3274 if (eval0(eap->arg, &rettv, &eap->nextcmd, FALSE) != FAIL)
3275 clear_tv(&rettv);
3276 --emsg_skip;
3277 return;
3278 }
3279
3280 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi, &partial);
3281 if (fudi.fd_newkey != NULL)
3282 {
3283 /* Still need to give an error message for missing key. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003284 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285 vim_free(fudi.fd_newkey);
3286 }
3287 if (tofree == NULL)
3288 return;
3289
3290 /* Increase refcount on dictionary, it could get deleted when evaluating
3291 * the arguments. */
3292 if (fudi.fd_dict != NULL)
3293 ++fudi.fd_dict->dv_refcount;
3294
3295 /* If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
3296 * contents. For VAR_PARTIAL get its partial, unless we already have one
3297 * from trans_function_name(). */
3298 len = (int)STRLEN(tofree);
3299 name = deref_func_name(tofree, &len,
3300 partial != NULL ? NULL : &partial, FALSE);
3301
3302 /* Skip white space to allow ":call func ()". Not good, but required for
3303 * backward compatibility. */
3304 startarg = skipwhite(arg);
3305 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */
3306
3307 if (*startarg != '(')
3308 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003309 semsg(_("E107: Missing parentheses: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310 goto end;
3311 }
3312
3313 /*
3314 * When skipping, evaluate the function once, to find the end of the
3315 * arguments.
3316 * When the function takes a range, this is discovered after the first
3317 * call, and the loop is broken.
3318 */
3319 if (eap->skip)
3320 {
3321 ++emsg_skip;
3322 lnum = eap->line2; /* do it once, also with an invalid range */
3323 }
3324 else
3325 lnum = eap->line1;
3326 for ( ; lnum <= eap->line2; ++lnum)
3327 {
3328 if (!eap->skip && eap->addr_count > 0)
3329 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003330 if (lnum > curbuf->b_ml.ml_line_count)
3331 {
3332 // If the function deleted lines or switched to another buffer
3333 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003334 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003335 break;
3336 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337 curwin->w_cursor.lnum = lnum;
3338 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 }
3341 arg = startarg;
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003342 if (get_func_tv(name, -1, &rettv, &arg,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343 eap->line1, eap->line2, &doesrange,
3344 !eap->skip, partial, fudi.fd_dict) == FAIL)
3345 {
3346 failed = TRUE;
3347 break;
3348 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003349 if (has_watchexpr())
3350 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351
3352 /* Handle a function returning a Funcref, Dictionary or List. */
3353 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE) == FAIL)
3354 {
3355 failed = TRUE;
3356 break;
3357 }
3358
3359 clear_tv(&rettv);
3360 if (doesrange || eap->skip)
3361 break;
3362
3363 /* Stop when immediately aborting on error, or when an interrupt
3364 * occurred or an exception was thrown but not caught.
3365 * get_func_tv() returned OK, so that the check for trailing
3366 * characters below is executed. */
3367 if (aborting())
3368 break;
3369 }
3370 if (eap->skip)
3371 --emsg_skip;
3372
3373 if (!failed)
3374 {
3375 /* Check for trailing illegal characters and a following command. */
3376 if (!ends_excmd(*arg))
3377 {
3378 emsg_severe = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003379 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 }
3381 else
3382 eap->nextcmd = check_nextcmd(arg);
3383 }
3384
3385end:
3386 dict_unref(fudi.fd_dict);
3387 vim_free(tofree);
3388}
3389
3390/*
3391 * Return from a function. Possibly makes the return pending. Also called
3392 * for a pending return at the ":endtry" or after returning from an extra
3393 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
3394 * when called due to a ":return" command. "rettv" may point to a typval_T
3395 * with the return rettv. Returns TRUE when the return can be carried out,
3396 * FALSE when the return gets pending.
3397 */
3398 int
3399do_return(
3400 exarg_T *eap,
3401 int reanimate,
3402 int is_cmd,
3403 void *rettv)
3404{
3405 int idx;
3406 struct condstack *cstack = eap->cstack;
3407
3408 if (reanimate)
3409 /* Undo the return. */
3410 current_funccal->returned = FALSE;
3411
3412 /*
3413 * Cleanup (and inactivate) conditionals, but stop when a try conditional
3414 * not in its finally clause (which then is to be executed next) is found.
3415 * In this case, make the ":return" pending for execution at the ":endtry".
3416 * Otherwise, return normally.
3417 */
3418 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
3419 if (idx >= 0)
3420 {
3421 cstack->cs_pending[idx] = CSTP_RETURN;
3422
3423 if (!is_cmd && !reanimate)
3424 /* A pending return again gets pending. "rettv" points to an
3425 * allocated variable with the rettv of the original ":return"'s
3426 * argument if present or is NULL else. */
3427 cstack->cs_rettv[idx] = rettv;
3428 else
3429 {
3430 /* When undoing a return in order to make it pending, get the stored
3431 * return rettv. */
3432 if (reanimate)
3433 rettv = current_funccal->rettv;
3434
3435 if (rettv != NULL)
3436 {
3437 /* Store the value of the pending return. */
3438 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
3439 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
3440 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003441 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003442 }
3443 else
3444 cstack->cs_rettv[idx] = NULL;
3445
3446 if (reanimate)
3447 {
3448 /* The pending return value could be overwritten by a ":return"
3449 * without argument in a finally clause; reset the default
3450 * return value. */
3451 current_funccal->rettv->v_type = VAR_NUMBER;
3452 current_funccal->rettv->vval.v_number = 0;
3453 }
3454 }
3455 report_make_pending(CSTP_RETURN, rettv);
3456 }
3457 else
3458 {
3459 current_funccal->returned = TRUE;
3460
3461 /* If the return is carried out now, store the return value. For
3462 * a return immediately after reanimation, the value is already
3463 * there. */
3464 if (!reanimate && rettv != NULL)
3465 {
3466 clear_tv(current_funccal->rettv);
3467 *current_funccal->rettv = *(typval_T *)rettv;
3468 if (!is_cmd)
3469 vim_free(rettv);
3470 }
3471 }
3472
3473 return idx < 0;
3474}
3475
3476/*
3477 * Free the variable with a pending return value.
3478 */
3479 void
3480discard_pending_return(void *rettv)
3481{
3482 free_tv((typval_T *)rettv);
3483}
3484
3485/*
3486 * Generate a return command for producing the value of "rettv". The result
3487 * is an allocated string. Used by report_pending() for verbose messages.
3488 */
3489 char_u *
3490get_return_cmd(void *rettv)
3491{
3492 char_u *s = NULL;
3493 char_u *tofree = NULL;
3494 char_u numbuf[NUMBUFLEN];
3495
3496 if (rettv != NULL)
3497 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
3498 if (s == NULL)
3499 s = (char_u *)"";
3500
3501 STRCPY(IObuff, ":return ");
3502 STRNCPY(IObuff + 8, s, IOSIZE - 8);
3503 if (STRLEN(s) + 8 >= IOSIZE)
3504 STRCPY(IObuff + IOSIZE - 4, "...");
3505 vim_free(tofree);
3506 return vim_strsave(IObuff);
3507}
3508
3509/*
3510 * Get next function line.
3511 * Called by do_cmdline() to get the next line.
3512 * Returns allocated string, or NULL for end of function.
3513 */
3514 char_u *
3515get_func_line(
3516 int c UNUSED,
3517 void *cookie,
3518 int indent UNUSED)
3519{
3520 funccall_T *fcp = (funccall_T *)cookie;
3521 ufunc_T *fp = fcp->func;
3522 char_u *retval;
3523 garray_T *gap; /* growarray with function lines */
3524
3525 /* If breakpoints have been added/deleted need to check for it. */
3526 if (fcp->dbg_tick != debug_tick)
3527 {
3528 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
3529 sourcing_lnum);
3530 fcp->dbg_tick = debug_tick;
3531 }
3532#ifdef FEAT_PROFILE
3533 if (do_profiling == PROF_YES)
3534 func_line_end(cookie);
3535#endif
3536
3537 gap = &fp->uf_lines;
3538 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
3539 || fcp->returned)
3540 retval = NULL;
3541 else
3542 {
3543 /* Skip NULL lines (continuation lines). */
3544 while (fcp->linenr < gap->ga_len
3545 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
3546 ++fcp->linenr;
3547 if (fcp->linenr >= gap->ga_len)
3548 retval = NULL;
3549 else
3550 {
3551 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
3552 sourcing_lnum = fcp->linenr;
3553#ifdef FEAT_PROFILE
3554 if (do_profiling == PROF_YES)
3555 func_line_start(cookie);
3556#endif
3557 }
3558 }
3559
3560 /* Did we encounter a breakpoint? */
3561 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum)
3562 {
3563 dbg_breakpoint(fp->uf_name, sourcing_lnum);
3564 /* Find next breakpoint. */
3565 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
3566 sourcing_lnum);
3567 fcp->dbg_tick = debug_tick;
3568 }
3569
3570 return retval;
3571}
3572
3573#if defined(FEAT_PROFILE) || defined(PROTO)
3574/*
3575 * Called when starting to read a function line.
3576 * "sourcing_lnum" must be correct!
3577 * When skipping lines it may not actually be executed, but we won't find out
3578 * until later and we need to store the time now.
3579 */
3580 void
3581func_line_start(void *cookie)
3582{
3583 funccall_T *fcp = (funccall_T *)cookie;
3584 ufunc_T *fp = fcp->func;
3585
3586 if (fp->uf_profiling && sourcing_lnum >= 1
3587 && sourcing_lnum <= fp->uf_lines.ga_len)
3588 {
3589 fp->uf_tml_idx = sourcing_lnum - 1;
3590 /* Skip continuation lines. */
3591 while (fp->uf_tml_idx > 0 && FUNCLINE(fp, fp->uf_tml_idx) == NULL)
3592 --fp->uf_tml_idx;
3593 fp->uf_tml_execed = FALSE;
3594 profile_start(&fp->uf_tml_start);
3595 profile_zero(&fp->uf_tml_children);
3596 profile_get_wait(&fp->uf_tml_wait);
3597 }
3598}
3599
3600/*
3601 * Called when actually executing a function line.
3602 */
3603 void
3604func_line_exec(void *cookie)
3605{
3606 funccall_T *fcp = (funccall_T *)cookie;
3607 ufunc_T *fp = fcp->func;
3608
3609 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
3610 fp->uf_tml_execed = TRUE;
3611}
3612
3613/*
3614 * Called when done with a function line.
3615 */
3616 void
3617func_line_end(void *cookie)
3618{
3619 funccall_T *fcp = (funccall_T *)cookie;
3620 ufunc_T *fp = fcp->func;
3621
3622 if (fp->uf_profiling && fp->uf_tml_idx >= 0)
3623 {
3624 if (fp->uf_tml_execed)
3625 {
3626 ++fp->uf_tml_count[fp->uf_tml_idx];
3627 profile_end(&fp->uf_tml_start);
3628 profile_sub_wait(&fp->uf_tml_wait, &fp->uf_tml_start);
3629 profile_add(&fp->uf_tml_total[fp->uf_tml_idx], &fp->uf_tml_start);
3630 profile_self(&fp->uf_tml_self[fp->uf_tml_idx], &fp->uf_tml_start,
3631 &fp->uf_tml_children);
3632 }
3633 fp->uf_tml_idx = -1;
3634 }
3635}
3636#endif
3637
3638/*
3639 * Return TRUE if the currently active function should be ended, because a
3640 * return was encountered or an error occurred. Used inside a ":while".
3641 */
3642 int
3643func_has_ended(void *cookie)
3644{
3645 funccall_T *fcp = (funccall_T *)cookie;
3646
3647 /* Ignore the "abort" flag if the abortion behavior has been changed due to
3648 * an error inside a try conditional. */
3649 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
3650 || fcp->returned);
3651}
3652
3653/*
3654 * return TRUE if cookie indicates a function which "abort"s on errors.
3655 */
3656 int
3657func_has_abort(
3658 void *cookie)
3659{
3660 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
3661}
3662
3663
3664/*
3665 * Turn "dict.Func" into a partial for "Func" bound to "dict".
3666 * Don't do this when "Func" is already a partial that was bound
3667 * explicitly (pt_auto is FALSE).
3668 * Changes "rettv" in-place.
3669 * Returns the updated "selfdict_in".
3670 */
3671 dict_T *
3672make_partial(dict_T *selfdict_in, typval_T *rettv)
3673{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003674 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 char_u *tofree = NULL;
3676 ufunc_T *fp;
3677 char_u fname_buf[FLEN_FIXED + 1];
3678 int error;
3679 dict_T *selfdict = selfdict_in;
3680
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003681 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
3682 fp = rettv->vval.v_partial->pt_func;
3683 else
3684 {
3685 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
3686 : rettv->vval.v_partial->pt_name;
3687 /* Translate "s:func" to the stored function name. */
3688 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
3689 fp = find_func(fname);
3690 vim_free(tofree);
3691 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692
3693 if (fp != NULL && (fp->uf_flags & FC_DICT))
3694 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003695 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696
3697 if (pt != NULL)
3698 {
3699 pt->pt_refcount = 1;
3700 pt->pt_dict = selfdict;
3701 pt->pt_auto = TRUE;
3702 selfdict = NULL;
3703 if (rettv->v_type == VAR_FUNC)
3704 {
3705 /* Just a function: Take over the function name and use
3706 * selfdict. */
3707 pt->pt_name = rettv->vval.v_string;
3708 }
3709 else
3710 {
3711 partial_T *ret_pt = rettv->vval.v_partial;
3712 int i;
3713
3714 /* Partial: copy the function name, use selfdict and copy
3715 * args. Can't take over name or args, the partial might
3716 * be referenced elsewhere. */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003717 if (ret_pt->pt_name != NULL)
3718 {
3719 pt->pt_name = vim_strsave(ret_pt->pt_name);
3720 func_ref(pt->pt_name);
3721 }
3722 else
3723 {
3724 pt->pt_func = ret_pt->pt_func;
3725 func_ptr_ref(pt->pt_func);
3726 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003727 if (ret_pt->pt_argc > 0)
3728 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003729 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003730 if (pt->pt_argv == NULL)
3731 /* out of memory: drop the arguments */
3732 pt->pt_argc = 0;
3733 else
3734 {
3735 pt->pt_argc = ret_pt->pt_argc;
3736 for (i = 0; i < pt->pt_argc; i++)
3737 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
3738 }
3739 }
3740 partial_unref(ret_pt);
3741 }
3742 rettv->v_type = VAR_PARTIAL;
3743 rettv->vval.v_partial = pt;
3744 }
3745 }
3746 return selfdict;
3747}
3748
3749/*
3750 * Return the name of the executed function.
3751 */
3752 char_u *
3753func_name(void *cookie)
3754{
3755 return ((funccall_T *)cookie)->func->uf_name;
3756}
3757
3758/*
3759 * Return the address holding the next breakpoint line for a funccall cookie.
3760 */
3761 linenr_T *
3762func_breakpoint(void *cookie)
3763{
3764 return &((funccall_T *)cookie)->breakpoint;
3765}
3766
3767/*
3768 * Return the address holding the debug tick for a funccall cookie.
3769 */
3770 int *
3771func_dbg_tick(void *cookie)
3772{
3773 return &((funccall_T *)cookie)->dbg_tick;
3774}
3775
3776/*
3777 * Return the nesting level for a funccall cookie.
3778 */
3779 int
3780func_level(void *cookie)
3781{
3782 return ((funccall_T *)cookie)->level;
3783}
3784
3785/*
3786 * Return TRUE when a function was ended by a ":return" command.
3787 */
3788 int
3789current_func_returned(void)
3790{
3791 return current_funccal->returned;
3792}
3793
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 int
3795free_unref_funccal(int copyID, int testing)
3796{
3797 int did_free = FALSE;
3798 int did_free_funccal = FALSE;
3799 funccall_T *fc, **pfc;
3800
3801 for (pfc = &previous_funccal; *pfc != NULL; )
3802 {
3803 if (can_free_funccal(*pfc, copyID))
3804 {
3805 fc = *pfc;
3806 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01003807 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 did_free = TRUE;
3809 did_free_funccal = TRUE;
3810 }
3811 else
3812 pfc = &(*pfc)->caller;
3813 }
3814 if (did_free_funccal)
3815 /* When a funccal was freed some more items might be garbage
3816 * collected, so run again. */
3817 (void)garbage_collect(testing);
3818
3819 return did_free;
3820}
3821
3822/*
Bram Moolenaarba209902016-08-24 22:06:38 +02003823 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 */
3825 static funccall_T *
3826get_funccal(void)
3827{
3828 int i;
3829 funccall_T *funccal;
3830 funccall_T *temp_funccal;
3831
3832 funccal = current_funccal;
3833 if (debug_backtrace_level > 0)
3834 {
3835 for (i = 0; i < debug_backtrace_level; i++)
3836 {
3837 temp_funccal = funccal->caller;
3838 if (temp_funccal)
3839 funccal = temp_funccal;
3840 else
3841 /* backtrace level overflow. reset to max */
3842 debug_backtrace_level = i;
3843 }
3844 }
3845 return funccal;
3846}
3847
3848/*
3849 * Return the hashtable used for local variables in the current funccal.
3850 * Return NULL if there is no current funccal.
3851 */
3852 hashtab_T *
3853get_funccal_local_ht()
3854{
3855 if (current_funccal == NULL)
3856 return NULL;
3857 return &get_funccal()->l_vars.dv_hashtab;
3858}
3859
3860/*
3861 * Return the l: scope variable.
3862 * Return NULL if there is no current funccal.
3863 */
3864 dictitem_T *
3865get_funccal_local_var()
3866{
3867 if (current_funccal == NULL)
3868 return NULL;
3869 return &get_funccal()->l_vars_var;
3870}
3871
3872/*
3873 * Return the hashtable used for argument in the current funccal.
3874 * Return NULL if there is no current funccal.
3875 */
3876 hashtab_T *
3877get_funccal_args_ht()
3878{
3879 if (current_funccal == NULL)
3880 return NULL;
3881 return &get_funccal()->l_avars.dv_hashtab;
3882}
3883
3884/*
3885 * Return the a: scope variable.
3886 * Return NULL if there is no current funccal.
3887 */
3888 dictitem_T *
3889get_funccal_args_var()
3890{
3891 if (current_funccal == NULL)
3892 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01003893 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894}
3895
3896/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897 * List function variables, if there is a function.
3898 */
3899 void
3900list_func_vars(int *first)
3901{
3902 if (current_funccal != NULL)
3903 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01003904 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905}
3906
3907/*
3908 * If "ht" is the hashtable for local variables in the current funccal, return
3909 * the dict that contains it.
3910 * Otherwise return NULL.
3911 */
3912 dict_T *
3913get_current_funccal_dict(hashtab_T *ht)
3914{
3915 if (current_funccal != NULL
3916 && ht == &current_funccal->l_vars.dv_hashtab)
3917 return &current_funccal->l_vars;
3918 return NULL;
3919}
3920
3921/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003922 * Search hashitem in parent scope.
3923 */
3924 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003925find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003926{
3927 funccall_T *old_current_funccal = current_funccal;
3928 hashtab_T *ht;
3929 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003930 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003931
3932 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
3933 return NULL;
3934
3935 /* Search in parent scope which is possible to reference from lambda */
3936 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02003937 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003938 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003939 ht = find_var_ht(name, &varname);
3940 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02003941 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003942 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02003943 if (!HASHITEM_EMPTY(hi))
3944 {
3945 *pht = ht;
3946 break;
3947 }
3948 }
3949 if (current_funccal == current_funccal->func->uf_scoped)
3950 break;
3951 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003952 }
3953 current_funccal = old_current_funccal;
3954
3955 return hi;
3956}
3957
3958/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003959 * Search variable in parent scope.
3960 */
3961 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003962find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003963{
3964 dictitem_T *v = NULL;
3965 funccall_T *old_current_funccal = current_funccal;
3966 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003967 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003968
3969 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
3970 return NULL;
3971
3972 /* Search in parent scope which is possible to reference from lambda */
3973 current_funccal = current_funccal->func->uf_scoped;
3974 while (current_funccal)
3975 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003976 ht = find_var_ht(name, &varname);
3977 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003978 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02003979 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003980 if (v != NULL)
3981 break;
3982 }
3983 if (current_funccal == current_funccal->func->uf_scoped)
3984 break;
3985 current_funccal = current_funccal->func->uf_scoped;
3986 }
3987 current_funccal = old_current_funccal;
3988
3989 return v;
3990}
3991
3992/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 * Set "copyID + 1" in previous_funccal and callers.
3994 */
3995 int
3996set_ref_in_previous_funccal(int copyID)
3997{
3998 int abort = FALSE;
3999 funccall_T *fc;
4000
4001 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
4002 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004003 fc->fc_copyID = copyID + 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 abort = abort || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1,
4005 NULL);
4006 abort = abort || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1,
4007 NULL);
4008 }
4009 return abort;
4010}
4011
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004012 static int
4013set_ref_in_funccal(funccall_T *fc, int copyID)
4014{
4015 int abort = FALSE;
4016
4017 if (fc->fc_copyID != copyID)
4018 {
4019 fc->fc_copyID = copyID;
4020 abort = abort || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL);
4021 abort = abort || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL);
4022 abort = abort || set_ref_in_func(NULL, fc->func, copyID);
4023 }
4024 return abort;
4025}
4026
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027/*
4028 * Set "copyID" in all local vars and arguments in the call stack.
4029 */
4030 int
4031set_ref_in_call_stack(int copyID)
4032{
4033 int abort = FALSE;
4034 funccall_T *fc;
4035
4036 for (fc = current_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004037 abort = abort || set_ref_in_funccal(fc, copyID);
4038 return abort;
4039}
4040
4041/*
4042 * Set "copyID" in all functions available by name.
4043 */
4044 int
4045set_ref_in_functions(int copyID)
4046{
4047 int todo;
4048 hashitem_T *hi = NULL;
4049 int abort = FALSE;
4050 ufunc_T *fp;
4051
4052 todo = (int)func_hashtab.ht_used;
4053 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004055 if (!HASHITEM_EMPTY(hi))
4056 {
4057 --todo;
4058 fp = HI2UF(hi);
4059 if (!func_name_refcount(fp->uf_name))
4060 abort = abort || set_ref_in_func(NULL, fp, copyID);
4061 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 }
4063 return abort;
4064}
4065
4066/*
4067 * Set "copyID" in all function arguments.
4068 */
4069 int
4070set_ref_in_func_args(int copyID)
4071{
4072 int i;
4073 int abort = FALSE;
4074
4075 for (i = 0; i < funcargs.ga_len; ++i)
4076 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4077 copyID, NULL, NULL);
4078 return abort;
4079}
4080
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004081/*
4082 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004083 * Returns TRUE if setting references failed somehow.
4084 */
4085 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004086set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004087{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004088 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004089 funccall_T *fc;
4090 int error = ERROR_NONE;
4091 char_u fname_buf[FLEN_FIXED + 1];
4092 char_u *tofree = NULL;
4093 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004094 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004095
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004096 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004097 return FALSE;
4098
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004099 if (fp_in == NULL)
4100 {
4101 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
4102 fp = find_func(fname);
4103 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004104 if (fp != NULL)
4105 {
4106 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004107 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004108 }
4109 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004110 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004111}
4112
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004113#endif /* FEAT_EVAL */