blob: bdd838730470efc781107aad9f85bc5114937257 [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/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
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 Moolenaar8a7d6542020-01-26 15:56:19 +010025#define FC_DEAD 0x80 // function kept only for reference to dfunc
26#define FC_EXPORT 0x100 // "export def Func()"
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaara9b579f2016-07-17 18:29:19 +020028/*
29 * All user-defined functions are found in this hashtable.
30 */
31static hashtab_T func_hashtab;
32
Bram Moolenaare38eab22019-12-05 21:50:01 +010033// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020034static garray_T funcargs = GA_EMPTY;
35
Bram Moolenaar209b8e32019-03-14 13:43:24 +010036// pointer to funccal for currently active function
37static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
Bram Moolenaar209b8e32019-03-14 13:43:24 +010039// Pointer to list of previously used funccal, still around because some
40// item in it is still being used.
41static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020042
43static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
44static char *e_funcdict = N_("E717: Dictionary entry already exists");
45static char *e_funcref = N_("E718: Funcref required");
46static char *e_nofunc = N_("E130: Unknown function: %s");
47
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020048static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020049
50 void
51func_init()
52{
53 hash_init(&func_hashtab);
54}
55
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020056/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020057 * Return the function hash table
58 */
59 hashtab_T *
60func_tbl_get(void)
61{
62 return &func_hashtab;
63}
64
65/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010066 * Get one function argument and an optional type: "arg: type".
67 * Return a pointer to after the type.
68 * When something is wrong return "arg".
69 */
70 static char_u *
71one_function_arg(char_u *arg, garray_T *newargs, garray_T *argtypes, int skip)
72{
73 char_u *p = arg;
74
75 while (ASCII_ISALNUM(*p) || *p == '_')
76 ++p;
77 if (arg == p || isdigit(*arg)
78 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
79 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
80 {
81 if (!skip)
82 semsg(_("E125: Illegal argument: %s"), arg);
83 return arg;
84 }
85 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
86 return arg;
87 if (newargs != NULL)
88 {
89 char_u *arg_copy;
90 int c;
91 int i;
92
93 c = *p;
94 *p = NUL;
95 arg_copy = vim_strsave(arg);
96 if (arg_copy == NULL)
97 {
98 *p = c;
99 return arg;
100 }
101
102 // Check for duplicate argument name.
103 for (i = 0; i < newargs->ga_len; ++i)
104 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
105 {
106 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
107 vim_free(arg_copy);
108 return arg;
109 }
110 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
111 newargs->ga_len++;
112
113 *p = c;
114 }
115
116 // get any type from "arg: type"
117 if (argtypes != NULL && ga_grow(argtypes, 1) == OK)
118 {
119 char_u *type = NULL;
120
121 if (*p == ':')
122 {
123 type = skipwhite(p + 1);
124 p = skip_type(type);
125 type = vim_strnsave(type, p - type);
126 }
127 else if (*skipwhite(p) == ':')
128 emsg(_("E1059: No white space allowed before :"));
129 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
130 }
131
132 return p;
133}
134
135/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200136 * Get function arguments.
137 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200139get_function_args(
140 char_u **argp,
141 char_u endchar,
142 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100143 garray_T *argtypes, // NULL unless using :def
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200144 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200145 garray_T *default_args,
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200146 int skip)
147{
148 int mustend = FALSE;
149 char_u *arg = *argp;
150 char_u *p = arg;
151 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200152 int any_default = FALSE;
153 char_u *expr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200154
155 if (newargs != NULL)
156 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100157 if (argtypes != NULL)
158 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200159 if (default_args != NULL)
160 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200161
162 if (varargs != NULL)
163 *varargs = FALSE;
164
165 /*
166 * Isolate the arguments: "arg1, arg2, ...)"
167 */
168 while (*p != endchar)
169 {
170 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
171 {
172 if (varargs != NULL)
173 *varargs = TRUE;
174 p += 3;
175 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100176
177 if (argtypes != NULL)
178 {
179 // ...name: list<type>
180 if (!ASCII_ISALPHA(*p))
181 {
182 emsg(_("E1055: Missing name after ..."));
183 break;
184 }
185
186 arg = p;
187 p = one_function_arg(p, newargs, argtypes, skip);
188 if (p == arg)
189 break;
190 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200191 }
192 else
193 {
194 arg = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100195 p = one_function_arg(p, newargs, argtypes, skip);
196 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200197 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200198
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200199 if (*skipwhite(p) == '=' && default_args != NULL)
200 {
201 typval_T rettv;
202
203 any_default = TRUE;
204 p = skipwhite(p) + 1;
205 p = skipwhite(p);
206 expr = p;
207 if (eval1(&p, &rettv, FALSE) != FAIL)
208 {
209 if (ga_grow(default_args, 1) == FAIL)
210 goto err_ret;
211
212 // trim trailing whitespace
213 while (p > expr && VIM_ISWHITE(p[-1]))
214 p--;
215 c = *p;
216 *p = NUL;
217 expr = vim_strsave(expr);
218 if (expr == NULL)
219 {
220 *p = c;
221 goto err_ret;
222 }
223 ((char_u **)(default_args->ga_data))
224 [default_args->ga_len] = expr;
225 default_args->ga_len++;
226 *p = c;
227 }
228 else
229 mustend = TRUE;
230 }
231 else if (any_default)
232 {
233 emsg(_("E989: Non-default argument follows default argument"));
234 mustend = TRUE;
235 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200236 if (*p == ',')
237 ++p;
238 else
239 mustend = TRUE;
240 }
241 p = skipwhite(p);
242 if (mustend && *p != endchar)
243 {
244 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100245 semsg(_(e_invarg2), *argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200246 break;
247 }
248 }
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200249 if (*p != endchar)
250 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100251 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200252
253 *argp = p;
254 return OK;
255
256err_ret:
257 if (newargs != NULL)
258 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200259 if (default_args != NULL)
260 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200261 return FAIL;
262}
263
264/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200265 * Register function "fp" as using "current_funccal" as its scope.
266 */
267 static int
268register_closure(ufunc_T *fp)
269{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200270 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100271 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200272 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200273 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200274 fp->uf_scoped = current_funccal;
275 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200276
Bram Moolenaar58016442016-07-31 18:30:22 +0200277 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
278 return FAIL;
279 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
280 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200281 return OK;
282}
283
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100284 static void
285set_ufunc_name(ufunc_T *fp, char_u *name)
286{
287 STRCPY(fp->uf_name, name);
288
289 if (name[0] == K_SPECIAL)
290 {
291 fp->uf_name_exp = alloc(STRLEN(name) + 3);
292 if (fp->uf_name_exp != NULL)
293 {
294 STRCPY(fp->uf_name_exp, "<SNR>");
295 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
296 }
297 }
298}
299
Bram Moolenaar58016442016-07-31 18:30:22 +0200300/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200301 * Parse a lambda expression and get a Funcref from "*arg".
302 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
303 */
304 int
305get_lambda_tv(char_u **arg, typval_T *rettv, int evaluate)
306{
307 garray_T newargs;
308 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200309 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200310 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100311 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200312 int varargs;
313 int ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314 char_u *start = skipwhite(*arg + 1);
315 char_u *s, *e;
316 static int lambda_no = 0;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200317 int *old_eval_lavars = eval_lavars_used;
318 int eval_lavars = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200319
320 ga_init(&newargs);
321 ga_init(&newlines);
322
Bram Moolenaare38eab22019-12-05 21:50:01 +0100323 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100324 ret = get_function_args(&start, '-', NULL, NULL, NULL, NULL, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 if (ret == FAIL || *start != '>')
326 return NOTDONE;
327
Bram Moolenaare38eab22019-12-05 21:50:01 +0100328 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200329 if (evaluate)
330 pnewargs = &newargs;
331 else
332 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200333 *arg = skipwhite(*arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100334 // TODO: argument types
335 ret = get_function_args(arg, '-', pnewargs, NULL, &varargs, NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 if (ret == FAIL || **arg != '>')
337 goto errret;
338
Bram Moolenaare38eab22019-12-05 21:50:01 +0100339 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200340 if (evaluate)
341 eval_lavars_used = &eval_lavars;
342
Bram Moolenaare38eab22019-12-05 21:50:01 +0100343 // Get the start and the end of the expression.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200344 *arg = skipwhite(*arg + 1);
345 s = *arg;
346 ret = skip_expr(arg);
347 if (ret == FAIL)
348 goto errret;
349 e = *arg;
350 *arg = skipwhite(*arg);
351 if (**arg != '}')
352 goto errret;
353 ++*arg;
354
355 if (evaluate)
356 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200357 int len, flags = 0;
358 char_u *p;
359 char_u name[20];
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200360
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200361 sprintf((char*)name, "<lambda>%d", ++lambda_no);
362
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200363 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200364 if (fp == NULL)
365 goto errret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100366 fp->uf_dfunc_idx = -1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200367 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200368 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200369 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200370
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200371 ga_init2(&newlines, (int)sizeof(char_u *), 1);
372 if (ga_grow(&newlines, 1) == FAIL)
373 goto errret;
374
Bram Moolenaare38eab22019-12-05 21:50:01 +0100375 // Add "return " before the expression.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200376 len = 7 + e - s + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200377 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200378 if (p == NULL)
379 goto errret;
380 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
381 STRCPY(p, "return ");
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200382 vim_strncpy(p + 7, s, e - s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200383
384 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100385 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200386 hash_add(&func_hashtab, UF2HIKEY(fp));
387 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200388 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200389 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200390 if (current_funccal != NULL && eval_lavars)
391 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200392 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200393 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200394 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200395 }
396 else
397 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200398
399#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200400 if (prof_def_func())
401 func_do_profile(fp);
402#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200403 if (sandbox)
404 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100405 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200406 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200407 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200408 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200409 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100410 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200411
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200412 pt->pt_func = fp;
413 pt->pt_refcount = 1;
414 rettv->vval.v_partial = pt;
415 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200416 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200417
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200418 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200419 return OK;
420
421errret:
422 ga_clear_strings(&newargs);
423 ga_clear_strings(&newlines);
424 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100425 vim_free(pt);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200426 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200427 return FAIL;
428}
429
430/*
431 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
432 * name it contains, otherwise return "name".
433 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
434 * "partialp".
435 */
436 char_u *
437deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
438{
439 dictitem_T *v;
440 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200441 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200442
443 if (partialp != NULL)
444 *partialp = NULL;
445
446 cc = name[*lenp];
447 name[*lenp] = NUL;
448 v = find_var(name, NULL, no_autoload);
449 name[*lenp] = cc;
450 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
451 {
452 if (v->di_tv.vval.v_string == NULL)
453 {
454 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100455 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200456 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200457 s = v->di_tv.vval.v_string;
458 *lenp = (int)STRLEN(s);
459 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200460 }
461
462 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
463 {
464 partial_T *pt = v->di_tv.vval.v_partial;
465
466 if (pt == NULL)
467 {
468 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100469 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200470 }
471 if (partialp != NULL)
472 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200473 s = partial_name(pt);
474 *lenp = (int)STRLEN(s);
475 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200476 }
477
478 return name;
479}
480
481/*
482 * Give an error message with a function name. Handle <SNR> things.
483 * "ermsg" is to be passed without translation, use N_() instead of _().
484 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100485 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200486emsg_funcname(char *ermsg, char_u *name)
487{
488 char_u *p;
489
490 if (*name == K_SPECIAL)
491 p = concat_str((char_u *)"<SNR>", name + 3);
492 else
493 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100494 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200495 if (p != name)
496 vim_free(p);
497}
498
499/*
500 * Allocate a variable for the result of a function.
501 * Return OK or FAIL.
502 */
503 int
504get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200505 char_u *name, // name of the function
506 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200507 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200508 char_u **arg, // argument, pointing to the '('
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200509 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200510{
511 char_u *argp;
512 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100513 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
514 int argcount = 0; // number of arguments found
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200515
516 /*
517 * Get the arguments.
518 */
519 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200520 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
521 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200522 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100523 argp = skipwhite(argp + 1); // skip the '(' or ','
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200524 if (*argp == ')' || *argp == ',' || *argp == NUL)
525 break;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200526 if (eval1(&argp, &argvars[argcount], funcexe->evaluate) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200527 {
528 ret = FAIL;
529 break;
530 }
531 ++argcount;
532 if (*argp != ',')
533 break;
534 }
535 if (*argp == ')')
536 ++argp;
537 else
538 ret = FAIL;
539
540 if (ret == OK)
541 {
542 int i = 0;
543
544 if (get_vim_var_nr(VV_TESTING))
545 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100546 // Prepare for calling test_garbagecollect_now(), need to know
547 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200548 if (funcargs.ga_itemsize == 0)
549 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
550 for (i = 0; i < argcount; ++i)
551 if (ga_grow(&funcargs, 1) == OK)
552 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
553 &argvars[i];
554 }
555
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200556 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200557
558 funcargs.ga_len -= i;
559 }
560 else if (!aborting())
561 {
562 if (argcount == MAX_FUNC_ARGS)
563 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
564 else
565 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
566 }
567
568 while (--argcount >= 0)
569 clear_tv(&argvars[argcount]);
570
571 *arg = skipwhite(argp);
572 return ret;
573}
574
575#define FLEN_FIXED 40
576
577/*
578 * Return TRUE if "p" starts with "<SID>" or "s:".
579 * Only works if eval_fname_script() returned non-zero for "p"!
580 */
581 static int
582eval_fname_sid(char_u *p)
583{
584 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
585}
586
587/*
588 * In a script change <SID>name() and s:name() to K_SNR 123_name().
589 * Change <SNR>123_name() to K_SNR 123_name().
590 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
591 * (slow).
592 */
593 static char_u *
594fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
595{
596 int llen;
597 char_u *fname;
598 int i;
599
600 llen = eval_fname_script(name);
601 if (llen > 0)
602 {
603 fname_buf[0] = K_SPECIAL;
604 fname_buf[1] = KS_EXTRA;
605 fname_buf[2] = (int)KE_SNR;
606 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100607 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200608 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200609 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100610 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200611 else
612 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200613 sprintf((char *)fname_buf + 3, "%ld_",
614 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200615 i = (int)STRLEN(fname_buf);
616 }
617 }
618 if (i + STRLEN(name + llen) < FLEN_FIXED)
619 {
620 STRCPY(fname_buf + i, name + llen);
621 fname = fname_buf;
622 }
623 else
624 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200625 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200626 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100627 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200628 else
629 {
630 *tofree = fname;
631 mch_memmove(fname, fname_buf, (size_t)i);
632 STRCPY(fname + i, name + llen);
633 }
634 }
635 }
636 else
637 fname = name;
638 return fname;
639}
640
641/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100642 * Find a function "name" in script "sid".
643 */
644 static ufunc_T *
645find_func_with_sid(char_u *name, int sid)
646{
647 hashitem_T *hi;
648 char_u buffer[200];
649
650 buffer[0] = K_SPECIAL;
651 buffer[1] = KS_EXTRA;
652 buffer[2] = (int)KE_SNR;
653 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
654 (long)sid, name);
655 hi = hash_find(&func_hashtab, buffer);
656 if (!HASHITEM_EMPTY(hi))
657 return HI2UF(hi);
658
659 return NULL;
660}
661
662/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200663 * Find a function by name, return pointer to it in ufuncs.
664 * Return NULL for unknown function.
665 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100666 static ufunc_T *
667find_func_even_dead(char_u *name, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200668{
669 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100670 ufunc_T *func;
671 imported_T *imported;
672
673 if (in_vim9script())
674 {
675 // Find script-local function before global one.
676 func = find_func_with_sid(name, current_sctx.sc_sid);
677 if (func != NULL)
678 return func;
679
680 // Find imported funcion before global one.
681 imported = find_imported(name, cctx);
682 if (imported != NULL && imported->imp_funcname != NULL)
683 {
684 hi = hash_find(&func_hashtab, imported->imp_funcname);
685 if (!HASHITEM_EMPTY(hi))
686 return HI2UF(hi);
687 }
688 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200689
690 hi = hash_find(&func_hashtab, name);
691 if (!HASHITEM_EMPTY(hi))
692 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100693
694 return NULL;
695}
696
697/*
698 * Find a function by name, return pointer to it in ufuncs.
699 * "cctx" is passed in a :def function to find imported functions.
700 * Return NULL for unknown or dead function.
701 */
702 ufunc_T *
703find_func(char_u *name, cctx_T *cctx)
704{
705 ufunc_T *fp = find_func_even_dead(name, cctx);
706
707 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
708 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200709 return NULL;
710}
711
712/*
713 * Copy the function name of "fp" to buffer "buf".
714 * "buf" must be able to hold the function name plus three bytes.
715 * Takes care of script-local function names.
716 */
717 static void
718cat_func_name(char_u *buf, ufunc_T *fp)
719{
720 if (fp->uf_name[0] == K_SPECIAL)
721 {
722 STRCPY(buf, "<SNR>");
723 STRCAT(buf, fp->uf_name + 3);
724 }
725 else
726 STRCPY(buf, fp->uf_name);
727}
728
729/*
730 * Add a number variable "name" to dict "dp" with value "nr".
731 */
732 static void
733add_nr_var(
734 dict_T *dp,
735 dictitem_T *v,
736 char *name,
737 varnumber_T nr)
738{
739 STRCPY(v->di_key, name);
740 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
741 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
742 v->di_tv.v_type = VAR_NUMBER;
743 v->di_tv.v_lock = VAR_FIXED;
744 v->di_tv.vval.v_number = nr;
745}
746
747/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100748 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200749 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100750 static void
751free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200752{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100753 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200754
755 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
756 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100757 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200758
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100759 // When garbage collecting a funccall_T may be freed before the
760 // function that references it, clear its uf_scoped field.
761 // The function may have been redefined and point to another
762 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200763 if (fp != NULL && fp->uf_scoped == fc)
764 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200765 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200766 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200767
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200768 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200769 vim_free(fc);
770}
771
772/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100773 * Free "fc" and what it contains.
774 * Can be called only when "fc" is kept beyond the period of it called,
775 * i.e. after cleanup_function_call(fc).
776 */
777 static void
778free_funccal_contents(funccall_T *fc)
779{
780 listitem_T *li;
781
782 // Free all l: variables.
783 vars_clear(&fc->l_vars.dv_hashtab);
784
785 // Free all a: variables.
786 vars_clear(&fc->l_avars.dv_hashtab);
787
788 // Free the a:000 variables.
789 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
790 clear_tv(&li->li_tv);
791
792 free_funccal(fc);
793}
794
795/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200796 * Handle the last part of returning from a function: free the local hashtable.
797 * Unless it is still in use by a closure.
798 */
799 static void
800cleanup_function_call(funccall_T *fc)
801{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100802 int may_free_fc = fc->fc_refcount <= 0;
803 int free_fc = TRUE;
804
Bram Moolenaar6914c642017-04-01 21:21:30 +0200805 current_funccal = fc->caller;
806
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100807 // Free all l: variables if not referred.
808 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
809 vars_clear(&fc->l_vars.dv_hashtab);
810 else
811 free_fc = FALSE;
812
813 // If the a:000 list and the l: and a: dicts are not referenced and
814 // there is no closure using it, we can free the funccall_T and what's
815 // in it.
816 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
817 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200818 else
819 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100820 int todo;
821 hashitem_T *hi;
822 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200823
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100824 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200825
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100826 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200827 todo = (int)fc->l_avars.dv_hashtab.ht_used;
828 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
829 {
830 if (!HASHITEM_EMPTY(hi))
831 {
832 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100833 di = HI2DI(hi);
834 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200835 }
836 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100837 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200838
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100839 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
840 fc->l_varlist.lv_first = NULL;
841 else
842 {
843 listitem_T *li;
844
845 free_fc = FALSE;
846
847 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200848 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next)
849 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100850 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100851
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100852 if (free_fc)
853 free_funccal(fc);
854 else
855 {
856 static int made_copy = 0;
857
858 // "fc" is still in use. This can happen when returning "a:000",
859 // assigning "l:" to a global variable or defining a closure.
860 // Link "fc" in the list for garbage collection later.
861 fc->caller = previous_funccal;
862 previous_funccal = fc;
863
864 if (want_garbage_collect)
865 // If garbage collector is ready, clear count.
866 made_copy = 0;
867 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100868 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100869 // We have made a lot of copies, worth 4 Mbyte. This can happen
870 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100871 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100872 // too much memory.
873 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +0100874 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100875 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200876 }
877}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100878/*
879 * Unreference "fc": decrement the reference count and free it when it
880 * becomes zero. "fp" is detached from "fc".
881 * When "force" is TRUE we are exiting.
882 */
883 static void
884funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
885{
886 funccall_T **pfc;
887 int i;
888
889 if (fc == NULL)
890 return;
891
892 if (--fc->fc_refcount <= 0 && (force || (
893 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
894 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
895 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
896 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
897 {
898 if (fc == *pfc)
899 {
900 *pfc = fc->caller;
901 free_funccal_contents(fc);
902 return;
903 }
904 }
905 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
906 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
907 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
908}
909
910/*
911 * Remove the function from the function hashtable. If the function was
912 * deleted while it still has references this was already done.
913 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
914 */
915 static int
916func_remove(ufunc_T *fp)
917{
918 hashitem_T *hi;
919
920 // Return if it was already virtually deleted.
921 if (fp->uf_flags & FC_DEAD)
922 return FALSE;
923
924 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
925 if (!HASHITEM_EMPTY(hi))
926 {
927 // When there is a def-function index do not actually remove the
928 // function, so we can find the index when defining the function again.
929 if (fp->uf_dfunc_idx >= 0)
930 fp->uf_flags |= FC_DEAD;
931 else
932 hash_remove(&func_hashtab, hi);
933 return TRUE;
934 }
935 return FALSE;
936}
937
938 static void
939func_clear_items(ufunc_T *fp)
940{
941 ga_clear_strings(&(fp->uf_args));
942 ga_clear_strings(&(fp->uf_def_args));
943 ga_clear_strings(&(fp->uf_lines));
944 VIM_CLEAR(fp->uf_name_exp);
945 VIM_CLEAR(fp->uf_arg_types);
946 ga_clear(&fp->uf_type_list);
947#ifdef FEAT_PROFILE
948 VIM_CLEAR(fp->uf_tml_count);
949 VIM_CLEAR(fp->uf_tml_total);
950 VIM_CLEAR(fp->uf_tml_self);
951#endif
952}
953
954/*
955 * Free all things that a function contains. Does not free the function
956 * itself, use func_free() for that.
957 * When "force" is TRUE we are exiting.
958 */
959 static void
960func_clear(ufunc_T *fp, int force)
961{
962 if (fp->uf_cleared)
963 return;
964 fp->uf_cleared = TRUE;
965
966 // clear this function
967 func_clear_items(fp);
968 funccal_unref(fp->uf_scoped, fp, force);
969 delete_def_function(fp);
970}
971
972/*
973 * Free a function and remove it from the list of functions. Does not free
974 * what a function contains, call func_clear() first.
975 */
976 static void
977func_free(ufunc_T *fp)
978{
979 // Only remove it when not done already, otherwise we would remove a newer
980 // version of the function with the same name.
981 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
982 func_remove(fp);
983
984 if ((fp->uf_flags & FC_DEAD) == 0)
985 vim_free(fp);
986}
987
988/*
989 * Free all things that a function contains and free the function itself.
990 * When "force" is TRUE we are exiting.
991 */
992 static void
993func_clear_free(ufunc_T *fp, int force)
994{
995 func_clear(fp, force);
996 func_free(fp);
997}
998
Bram Moolenaar6914c642017-04-01 21:21:30 +0200999
1000/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001001 * Call a user function.
1002 */
1003 static void
1004call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001005 ufunc_T *fp, // pointer to function
1006 int argcount, // nr of args
1007 typval_T *argvars, // arguments
1008 typval_T *rettv, // return value
1009 linenr_T firstline, // first line of range
1010 linenr_T lastline, // last line of range
1011 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001012{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001013 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001014 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001015 funccall_T *fc;
1016 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001017 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001018 static int depth = 0;
1019 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001020 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001021 int i;
1022 int ai;
1023 int islambda = FALSE;
1024 char_u numbuf[NUMBUFLEN];
1025 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001026#ifdef FEAT_PROFILE
1027 proftime_T wait_start;
1028 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001029 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001030#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001031 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001032
Bram Moolenaare38eab22019-12-05 21:50:01 +01001033 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001034 if (depth >= p_mfd)
1035 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001036 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001037 rettv->v_type = VAR_NUMBER;
1038 rettv->vval.v_number = -1;
1039 return;
1040 }
1041 ++depth;
1042
Bram Moolenaare38eab22019-12-05 21:50:01 +01001043 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001044
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001045 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001046 if (fc == NULL)
1047 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001048 fc->caller = current_funccal;
1049 current_funccal = fc;
1050 fc->func = fp;
1051 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001052 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001053 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001054 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1055 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001056 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001057 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001058 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001059
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001060 if (fp->uf_dfunc_idx >= 0)
1061 {
1062 estack_push_ufunc(ETYPE_UFUNC, fp, 1);
1063
1064 // Execute the compiled function.
1065 call_def_function(fp, argcount, argvars, rettv);
1066 --depth;
1067 current_funccal = fc->caller;
1068
1069 estack_pop();
1070 free_funccal(fc);
1071 return;
1072 }
1073
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001074 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1075 islambda = TRUE;
1076
1077 /*
1078 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1079 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1080 * each argument variable and saves a lot of time.
1081 */
1082 /*
1083 * Init l: variables.
1084 */
1085 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1086 if (selfdict != NULL)
1087 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001088 // Set l:self to "selfdict". Use "name" to avoid a warning from
1089 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001090 v = &fc->fixvar[fixvar_idx++].var;
1091 name = v->di_key;
1092 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001093 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001094 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1095 v->di_tv.v_type = VAR_DICT;
1096 v->di_tv.v_lock = 0;
1097 v->di_tv.vval.v_dict = selfdict;
1098 ++selfdict->dv_refcount;
1099 }
1100
1101 /*
1102 * Init a: variables.
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001103 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001104 * Set a:000 to a list with room for the "..." arguments.
1105 */
1106 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
1107 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001108 (varnumber_T)(argcount >= fp->uf_args.ga_len
1109 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001110 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001111 // Use "name" to avoid a warning from some compiler that checks the
1112 // destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001113 v = &fc->fixvar[fixvar_idx++].var;
1114 name = v->di_key;
1115 STRCPY(name, "000");
1116 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1117 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1118 v->di_tv.v_type = VAR_LIST;
1119 v->di_tv.v_lock = VAR_FIXED;
1120 v->di_tv.vval.v_list = &fc->l_varlist;
1121 vim_memset(&fc->l_varlist, 0, sizeof(list_T));
1122 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1123 fc->l_varlist.lv_lock = VAR_FIXED;
1124
1125 /*
1126 * Set a:firstline to "firstline" and a:lastline to "lastline".
1127 * Set a:name to named arguments.
1128 * Set a:N to the "..." arguments.
1129 */
1130 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
1131 (varnumber_T)firstline);
1132 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
1133 (varnumber_T)lastline);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001134 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001135 {
1136 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001137 typval_T def_rettv;
1138 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001139
1140 ai = i - fp->uf_args.ga_len;
1141 if (ai < 0)
1142 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001143 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001144 name = FUNCARG(fp, i);
1145 if (islambda)
1146 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001147
1148 // evaluate named argument default expression
1149 isdefault = ai + fp->uf_def_args.ga_len >= 0
1150 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1151 && argvars[i].vval.v_number == VVAL_NONE));
1152 if (isdefault)
1153 {
1154 char_u *default_expr = NULL;
1155 def_rettv.v_type = VAR_NUMBER;
1156 def_rettv.vval.v_number = -1;
1157
1158 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1159 [ai + fp->uf_def_args.ga_len];
1160 if (eval1(&default_expr, &def_rettv, TRUE) == FAIL)
1161 {
1162 default_arg_err = 1;
1163 break;
1164 }
1165 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001166 }
1167 else
1168 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001169 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001170 sprintf((char *)numbuf, "%d", ai + 1);
1171 name = numbuf;
1172 }
1173 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1174 {
1175 v = &fc->fixvar[fixvar_idx++].var;
1176 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001177 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001178 }
1179 else
1180 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001181 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001182 if (v == NULL)
1183 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001184 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001185 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001186
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001187 // Note: the values are copied directly to avoid alloc/free.
1188 // "argvars" must have VAR_FIXED for v_lock.
1189 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001190 v->di_tv.v_lock = VAR_FIXED;
1191
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001192 if (addlocal)
1193 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001194 // Named arguments should be accessed without the "a:" prefix in
1195 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001196 copy_tv(&v->di_tv, &v->di_tv);
1197 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001198 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001199 else
1200 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001201
1202 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1203 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001204 listitem_T *li = &fc->l_listitems[ai];
1205
1206 li->li_tv = argvars[i];
1207 li->li_tv.v_lock = VAR_FIXED;
1208 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001209 }
1210 }
1211
Bram Moolenaare38eab22019-12-05 21:50:01 +01001212 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001213 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001214
1215 if (fp->uf_flags & FC_SANDBOX)
1216 {
1217 using_sandbox = TRUE;
1218 ++sandbox;
1219 }
1220
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001221 estack_push_ufunc(ETYPE_UFUNC, fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001222 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001223 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001224 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001225 ++no_wait_return;
1226 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001227
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001228 smsg(_("calling %s"), SOURCING_NAME);
1229 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001230 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001231 char_u buf[MSG_BUF_LEN];
1232 char_u numbuf2[NUMBUFLEN];
1233 char_u *tofree;
1234 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001235
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001236 msg_puts("(");
1237 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001238 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001239 if (i > 0)
1240 msg_puts(", ");
1241 if (argvars[i].v_type == VAR_NUMBER)
1242 msg_outnum((long)argvars[i].vval.v_number);
1243 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001244 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001245 // Do not want errors such as E724 here.
1246 ++emsg_off;
1247 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1248 --emsg_off;
1249 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001250 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001251 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001252 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001253 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1254 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001255 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001256 msg_puts((char *)s);
1257 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001258 }
1259 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001260 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001261 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001262 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001263 msg_puts("\n"); // don't overwrite this either
1264
1265 verbose_leave_scroll();
1266 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267 }
1268#ifdef FEAT_PROFILE
1269 if (do_profiling == PROF_YES)
1270 {
1271 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001272 {
1273 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001275 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001276 if (fp->uf_profiling
1277 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1278 {
1279 ++fp->uf_tm_count;
1280 profile_start(&call_start);
1281 profile_zero(&fp->uf_tm_children);
1282 }
1283 script_prof_save(&wait_start);
1284 }
1285#endif
1286
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001287 save_current_sctx = current_sctx;
1288 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001289 save_did_emsg = did_emsg;
1290 did_emsg = FALSE;
1291
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001292 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1293 did_emsg = TRUE;
1294 else
1295 // call do_cmdline() to execute the lines
1296 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001297 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1298
1299 --RedrawingDisabled;
1300
Bram Moolenaare38eab22019-12-05 21:50:01 +01001301 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001302 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1303 {
1304 clear_tv(rettv);
1305 rettv->v_type = VAR_NUMBER;
1306 rettv->vval.v_number = -1;
1307 }
1308
1309#ifdef FEAT_PROFILE
1310 if (do_profiling == PROF_YES && (fp->uf_profiling
1311 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1312 {
1313 profile_end(&call_start);
1314 profile_sub_wait(&wait_start, &call_start);
1315 profile_add(&fp->uf_tm_total, &call_start);
1316 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1317 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1318 {
1319 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1320 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1321 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001322 if (started_profiling)
1323 // make a ":profdel func" stop profiling the function
1324 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001325 }
1326#endif
1327
Bram Moolenaare38eab22019-12-05 21:50:01 +01001328 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001329 if (p_verbose >= 12)
1330 {
1331 ++no_wait_return;
1332 verbose_enter_scroll();
1333
1334 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001335 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001336 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001337 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001338 (long)fc->rettv->vval.v_number);
1339 else
1340 {
1341 char_u buf[MSG_BUF_LEN];
1342 char_u numbuf2[NUMBUFLEN];
1343 char_u *tofree;
1344 char_u *s;
1345
Bram Moolenaare38eab22019-12-05 21:50:01 +01001346 // The value may be very long. Skip the middle part, so that we
1347 // have some idea how it starts and ends. smsg() would always
1348 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001349 ++emsg_off;
1350 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1351 --emsg_off;
1352 if (s != NULL)
1353 {
1354 if (vim_strsize(s) > MSG_BUF_CLEN)
1355 {
1356 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1357 s = buf;
1358 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001359 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 vim_free(tofree);
1361 }
1362 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001363 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001364
1365 verbose_leave_scroll();
1366 --no_wait_return;
1367 }
1368
Bram Moolenaare31ee862020-01-07 20:59:34 +01001369 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001370 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001371 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372#ifdef FEAT_PROFILE
1373 if (do_profiling == PROF_YES)
1374 script_prof_restore(&wait_start);
1375#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001376 if (using_sandbox)
1377 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001378
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001379 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380 {
1381 ++no_wait_return;
1382 verbose_enter_scroll();
1383
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001384 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001385 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001386
1387 verbose_leave_scroll();
1388 --no_wait_return;
1389 }
1390
1391 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392 --depth;
1393
Bram Moolenaar6914c642017-04-01 21:21:30 +02001394 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001395}
1396
1397/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001398 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001399 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001400 int
1401call_user_func_check(
1402 ufunc_T *fp,
1403 int argcount,
1404 typval_T *argvars,
1405 typval_T *rettv,
1406 funcexe_T *funcexe,
1407 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001408{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001409 int error;
1410 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001411
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001412 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1413 *funcexe->doesrange = TRUE;
1414 if (argcount < regular_args - fp->uf_def_args.ga_len)
1415 error = FCERR_TOOFEW;
1416 else if (!has_varargs(fp) && argcount > regular_args)
1417 error = FCERR_TOOMANY;
1418 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1419 error = FCERR_DICT;
1420 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001421 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001422 int did_save_redo = FALSE;
1423 save_redo_T save_redo;
1424
1425 /*
1426 * Call the user function.
1427 * Save and restore search patterns, script variables and
1428 * redo buffer.
1429 */
1430 save_search_patterns();
1431 if (!ins_compl_active())
1432 {
1433 saveRedobuff(&save_redo);
1434 did_save_redo = TRUE;
1435 }
1436 ++fp->uf_calls;
1437 call_user_func(fp, argcount, argvars, rettv,
1438 funcexe->firstline, funcexe->lastline,
1439 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
1440 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1441 // Function was unreferenced while being used, free it now.
1442 func_clear_free(fp, FALSE);
1443 if (did_save_redo)
1444 restoreRedobuff(&save_redo);
1445 restore_search_patterns();
1446 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001447 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001448 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001449}
1450
1451/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001452 * There are two kinds of function names:
1453 * 1. ordinary names, function defined with :function
1454 * 2. numbered functions and lambdas
1455 * For the first we only count the name stored in func_hashtab as a reference,
1456 * using function() does not count as a reference, because the function is
1457 * looked up by name.
1458 */
1459 static int
1460func_name_refcount(char_u *name)
1461{
1462 return isdigit(*name) || *name == '<';
1463}
1464
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001465static funccal_entry_T *funccal_stack = NULL;
1466
1467/*
1468 * Save the current function call pointer, and set it to NULL.
1469 * Used when executing autocommands and for ":source".
1470 */
1471 void
1472save_funccal(funccal_entry_T *entry)
1473{
1474 entry->top_funccal = current_funccal;
1475 entry->next = funccal_stack;
1476 funccal_stack = entry;
1477 current_funccal = NULL;
1478}
1479
1480 void
1481restore_funccal(void)
1482{
1483 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001484 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001485 else
1486 {
1487 current_funccal = funccal_stack->top_funccal;
1488 funccal_stack = funccal_stack->next;
1489 }
1490}
1491
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001492 funccall_T *
1493get_current_funccal(void)
1494{
1495 return current_funccal;
1496}
1497
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498#if defined(EXITFREE) || defined(PROTO)
1499 void
1500free_all_functions(void)
1501{
1502 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001503 ufunc_T *fp;
1504 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001505 long_u todo = 1;
1506 long_u used;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507
Bram Moolenaare38eab22019-12-05 21:50:01 +01001508 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001509 while (current_funccal != NULL)
1510 {
1511 clear_tv(current_funccal->rettv);
1512 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001513 if (current_funccal == NULL && funccal_stack != NULL)
1514 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001515 }
1516
Bram Moolenaare38eab22019-12-05 21:50:01 +01001517 // First clear what the functions contain. Since this may lower the
1518 // reference count of a function, it may also free a function and change
1519 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001520 while (todo > 0)
1521 {
1522 todo = func_hashtab.ht_used;
1523 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1524 if (!HASHITEM_EMPTY(hi))
1525 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001526 // clear the def function index now
1527 fp = HI2UF(hi);
1528 fp->uf_flags &= ~FC_DEAD;
1529 fp->uf_dfunc_idx = -1;
1530
Bram Moolenaare38eab22019-12-05 21:50:01 +01001531 // Only free functions that are not refcounted, those are
1532 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001533 if (func_name_refcount(fp->uf_name))
1534 ++skipped;
1535 else
1536 {
1537 used = func_hashtab.ht_used;
1538 func_clear(fp, TRUE);
1539 if (used != func_hashtab.ht_used)
1540 {
1541 skipped = 0;
1542 break;
1543 }
1544 }
1545 --todo;
1546 }
1547 }
1548
Bram Moolenaare38eab22019-12-05 21:50:01 +01001549 // Now actually free the functions. Need to start all over every time,
1550 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001551 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001552 while (func_hashtab.ht_used > skipped)
1553 {
1554 todo = func_hashtab.ht_used;
1555 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 if (!HASHITEM_EMPTY(hi))
1557 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001558 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001559 // Only free functions that are not refcounted, those are
1560 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001561 fp = HI2UF(hi);
1562 if (func_name_refcount(fp->uf_name))
1563 ++skipped;
1564 else
1565 {
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001566 func_free(fp);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001567 skipped = 0;
1568 break;
1569 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001571 }
1572 if (skipped == 0)
1573 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001574
1575 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576}
1577#endif
1578
1579/*
1580 * Return TRUE if "name" looks like a builtin function name: starts with a
1581 * lower case letter and doesn't contain AUTOLOAD_CHAR.
1582 * "len" is the length of "name", or -1 for NUL terminated.
1583 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001584 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001585builtin_function(char_u *name, int len)
1586{
1587 char_u *p;
1588
1589 if (!ASCII_ISLOWER(name[0]))
1590 return FALSE;
1591 p = vim_strchr(name, AUTOLOAD_CHAR);
1592 return p == NULL || (len > 0 && p > name + len);
1593}
1594
1595 int
1596func_call(
1597 char_u *name,
1598 typval_T *args,
1599 partial_T *partial,
1600 dict_T *selfdict,
1601 typval_T *rettv)
1602{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001603 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001604 listitem_T *item;
1605 typval_T argv[MAX_FUNC_ARGS + 1];
1606 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607 int r = 0;
1608
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001609 range_list_materialize(l);
1610 for (item = l->lv_first; item != NULL; item = item->li_next)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611 {
1612 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1613 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001614 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 break;
1616 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001617 // Make a copy of each argument. This is needed to be able to set
1618 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619 copy_tv(&item->li_tv, &argv[argc++]);
1620 }
1621
1622 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001623 {
1624 funcexe_T funcexe;
1625
Bram Moolenaarac92e252019-08-03 21:58:38 +02001626 vim_memset(&funcexe, 0, sizeof(funcexe));
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001627 funcexe.firstline = curwin->w_cursor.lnum;
1628 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001629 funcexe.evaluate = TRUE;
1630 funcexe.partial = partial;
1631 funcexe.selfdict = selfdict;
1632 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1633 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634
Bram Moolenaare38eab22019-12-05 21:50:01 +01001635 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 while (argc > 0)
1637 clear_tv(&argv[--argc]);
1638
1639 return r;
1640}
1641
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001642static int callback_depth = 0;
1643
1644 int
1645get_callback_depth(void)
1646{
1647 return callback_depth;
1648}
1649
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001651 * Invoke call_func() with a callback.
1652 */
1653 int
1654call_callback(
1655 callback_T *callback,
1656 int len, // length of "name" or -1 to use strlen()
1657 typval_T *rettv, // return value goes here
1658 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001659 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001660 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001661{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001662 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001663 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001664
1665 vim_memset(&funcexe, 0, sizeof(funcexe));
1666 funcexe.evaluate = TRUE;
1667 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001668 ++callback_depth;
1669 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1670 --callback_depth;
1671 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001672}
1673
1674/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001675 * Give an error message for the result of a function.
1676 * Nothing if "error" is FCERR_NONE.
1677 */
1678 void
1679user_func_error(int error, char_u *name)
1680{
1681 switch (error)
1682 {
1683 case FCERR_UNKNOWN:
1684 emsg_funcname(e_unknownfunc, name);
1685 break;
1686 case FCERR_NOTMETHOD:
1687 emsg_funcname(
1688 N_("E276: Cannot use function as a method: %s"), name);
1689 break;
1690 case FCERR_DELETED:
1691 emsg_funcname(N_(e_func_deleted), name);
1692 break;
1693 case FCERR_TOOMANY:
1694 emsg_funcname((char *)e_toomanyarg, name);
1695 break;
1696 case FCERR_TOOFEW:
1697 emsg_funcname((char *)e_toofewarg, name);
1698 break;
1699 case FCERR_SCRIPT:
1700 emsg_funcname(
1701 N_("E120: Using <SID> not in a script context: %s"), name);
1702 break;
1703 case FCERR_DICT:
1704 emsg_funcname(
1705 N_("E725: Calling dict function without Dictionary: %s"),
1706 name);
1707 break;
1708 }
1709}
1710
1711/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001712 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001713 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 * Return FAIL when the function can't be called, OK otherwise.
1715 * Also returns OK when an error was encountered while executing the function.
1716 */
1717 int
1718call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001719 char_u *funcname, // name of the function
1720 int len, // length of "name" or -1 to use strlen()
1721 typval_T *rettv, // return value goes here
1722 int argcount_in, // number of "argvars"
1723 typval_T *argvars_in, // vars for arguments, must have "argcount"
1724 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001725 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001726{
1727 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01001728 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001729 int i;
1730 ufunc_T *fp;
1731 char_u fname_buf[FLEN_FIXED + 1];
1732 char_u *tofree = NULL;
1733 char_u *fname;
1734 char_u *name;
1735 int argcount = argcount_in;
1736 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001737 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001738 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
1739 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001741 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001742 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02001744 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
1745 // even when call_func() returns FAIL.
1746 rettv->v_type = VAR_UNKNOWN;
1747
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001748 // Make a copy of the name, if it comes from a funcref variable it could
1749 // be changed or deleted in the called function.
1750 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 if (name == NULL)
1752 return ret;
1753
1754 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1755
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001756 if (funcexe->doesrange != NULL)
1757 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758
1759 if (partial != NULL)
1760 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001761 // When the function has a partial with a dict and there is a dict
1762 // argument, use the dict argument. That is backwards compatible.
1763 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001764 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01001766 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001767 {
1768 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001769 {
1770 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
1771 {
Bram Moolenaaref140542019-12-31 21:27:13 +01001772 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001773 goto theend;
1774 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001776 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 for (i = 0; i < argcount_in; ++i)
1778 argv[i + argv_clear] = argvars_in[i];
1779 argvars = argv;
1780 argcount = partial->pt_argc + argcount_in;
1781 }
1782 }
1783
Bram Moolenaaref140542019-12-31 21:27:13 +01001784 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 {
1786 char_u *rfname = fname;
1787
Bram Moolenaare38eab22019-12-05 21:50:01 +01001788 // Ignore "g:" before a function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789 if (fname[0] == 'g' && fname[1] == ':')
1790 rfname = fname + 2;
1791
Bram Moolenaare38eab22019-12-05 21:50:01 +01001792 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01001794 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001795
1796 if (!builtin_function(rfname, -1))
1797 {
1798 /*
1799 * User defined function.
1800 */
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001801 if (partial != NULL && partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001802 fp = partial->pt_func;
1803 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001804 fp = find_func(rfname, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805
Bram Moolenaare38eab22019-12-05 21:50:01 +01001806 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807 if (fp == NULL
1808 && apply_autocmds(EVENT_FUNCUNDEFINED,
1809 rfname, rfname, TRUE, NULL)
1810 && !aborting())
1811 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001812 // executed an autocommand, search for the function again
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001813 fp = find_func(rfname, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001815 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
1817 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001818 // loaded a package, search for the function again
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001819 fp = find_func(rfname, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820 }
1821
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001822 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01001823 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001824 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001826 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01001827 // postponed filling in the arguments, do it now
1828 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001829 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001830
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001831 if (funcexe->basetv != NULL)
1832 {
1833 // Method call: base->Method()
1834 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
1835 argv[0] = *funcexe->basetv;
1836 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001837 argvars = argv;
1838 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001839 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001840
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001841 error = call_user_func_check(fp, argcount, argvars, rettv,
1842 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 }
1844 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02001845 else if (funcexe->basetv != NULL)
1846 {
1847 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001848 * expr->method(): Find the method name in the table, call its
1849 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02001850 */
1851 error = call_internal_method(fname, argcount, argvars, rettv,
1852 funcexe->basetv);
1853 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 else
1855 {
1856 /*
1857 * Find the function name in the table, call its implementation.
1858 */
1859 error = call_internal_func(fname, argcount, argvars, rettv);
1860 }
1861 /*
1862 * The function call (or "FuncUndefined" autocommand sequence) might
1863 * have been aborted by an error, an interrupt, or an explicitly thrown
1864 * exception that has not been caught so far. This situation can be
1865 * tested for by calling aborting(). For an error in an internal
1866 * function or for the "E132" error in call_user_func(), however, the
1867 * throw point at which the "force_abort" flag (temporarily reset by
1868 * emsg()) is normally updated has not been reached yet. We need to
1869 * update that flag first to make aborting() reliable.
1870 */
1871 update_force_abort();
1872 }
Bram Moolenaaref140542019-12-31 21:27:13 +01001873 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001874 ret = OK;
1875
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001876theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001877 /*
1878 * Report an error unless the argument evaluation or function call has been
1879 * cancelled due to an aborting error, an interrupt, or an exception.
1880 */
1881 if (!aborting())
1882 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001883 user_func_error(error, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884 }
1885
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001886 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001888 clear_tv(&argv[--argv_clear + argv_base]);
1889
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890 vim_free(tofree);
1891 vim_free(name);
1892
1893 return ret;
1894}
1895
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001896 static char_u *
1897printable_func_name(ufunc_T *fp)
1898{
1899 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
1900}
1901
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902/*
1903 * List the head of the function: "name(arg1, arg2)".
1904 */
1905 static void
1906list_func_head(ufunc_T *fp, int indent)
1907{
1908 int j;
1909
1910 msg_start();
1911 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001912 msg_puts(" ");
1913 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001914 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001915 msg_putchar('(');
1916 for (j = 0; j < fp->uf_args.ga_len; ++j)
1917 {
1918 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001919 msg_puts(", ");
1920 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001921 if (fp->uf_arg_types != NULL)
1922 {
1923 char *tofree;
1924
1925 msg_puts(": ");
1926 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
1927 vim_free(tofree);
1928 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001929 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
1930 {
1931 msg_puts(" = ");
1932 msg_puts(((char **)(fp->uf_def_args.ga_data))
1933 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
1934 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 }
1936 if (fp->uf_varargs)
1937 {
1938 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001939 msg_puts(", ");
1940 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001941 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942 if (fp->uf_va_name != NULL)
1943 {
1944 if (j)
1945 msg_puts(", ");
1946 msg_puts("...");
1947 msg_puts((char *)fp->uf_va_name);
1948 if (fp->uf_va_type)
1949 {
1950 char *tofree;
1951
1952 msg_puts(": ");
1953 msg_puts(type_name(fp->uf_va_type, &tofree));
1954 vim_free(tofree);
1955 }
1956 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001957 msg_putchar(')');
1958 if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001959 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001960 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001961 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001962 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001963 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001964 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01001965 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001966 msg_clr_eos();
1967 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001968 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001969}
1970
1971/*
1972 * Get a function name, translating "<SID>" and "<SNR>".
1973 * Also handles a Funcref in a List or Dictionary.
1974 * Returns the function name in allocated memory, or NULL for failure.
1975 * flags:
1976 * TFN_INT: internal function name OK
1977 * TFN_QUIET: be quiet
1978 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02001979 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001980 * Advances "pp" to just after the function name (if no error).
1981 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001982 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001983trans_function_name(
1984 char_u **pp,
Bram Moolenaare38eab22019-12-05 21:50:01 +01001985 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001986 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01001987 funcdict_T *fdp, // return: info about dictionary used
1988 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001989{
1990 char_u *name = NULL;
1991 char_u *start;
1992 char_u *end;
1993 int lead;
1994 char_u sid_buf[20];
1995 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001996 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001999
2000 if (fdp != NULL)
2001 vim_memset(fdp, 0, sizeof(funcdict_T));
2002 start = *pp;
2003
Bram Moolenaare38eab22019-12-05 21:50:01 +01002004 // Check for hard coded <SNR>: already translated function ID (from a user
2005 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002006 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2007 && (*pp)[2] == (int)KE_SNR)
2008 {
2009 *pp += 3;
2010 len = get_id_len(pp) + 3;
2011 return vim_strnsave(start, len);
2012 }
2013
Bram Moolenaare38eab22019-12-05 21:50:01 +01002014 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2015 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 lead = eval_fname_script(start);
2017 if (lead > 2)
2018 start += lead;
2019
Bram Moolenaare38eab22019-12-05 21:50:01 +01002020 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002021 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022 lead > 2 ? 0 : FNE_CHECK_START);
2023 if (end == start)
2024 {
2025 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002026 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002027 goto theend;
2028 }
2029 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2030 {
2031 /*
2032 * Report an invalid expression in braces, unless the expression
2033 * evaluation has been cancelled due to an aborting error, an
2034 * interrupt, or an exception.
2035 */
2036 if (!aborting())
2037 {
2038 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002039 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002040 }
2041 else
2042 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2043 goto theend;
2044 }
2045
2046 if (lv.ll_tv != NULL)
2047 {
2048 if (fdp != NULL)
2049 {
2050 fdp->fd_dict = lv.ll_dict;
2051 fdp->fd_newkey = lv.ll_newkey;
2052 lv.ll_newkey = NULL;
2053 fdp->fd_di = lv.ll_di;
2054 }
2055 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2056 {
2057 name = vim_strsave(lv.ll_tv->vval.v_string);
2058 *pp = end;
2059 }
2060 else if (lv.ll_tv->v_type == VAR_PARTIAL
2061 && lv.ll_tv->vval.v_partial != NULL)
2062 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002063 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002064 *pp = end;
2065 if (partial != NULL)
2066 *partial = lv.ll_tv->vval.v_partial;
2067 }
2068 else
2069 {
2070 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2071 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002072 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002073 else
2074 *pp = end;
2075 name = NULL;
2076 }
2077 goto theend;
2078 }
2079
2080 if (lv.ll_name == NULL)
2081 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002082 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002083 *pp = end;
2084 goto theend;
2085 }
2086
Bram Moolenaare38eab22019-12-05 21:50:01 +01002087 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002088 if (lv.ll_exp_name != NULL)
2089 {
2090 len = (int)STRLEN(lv.ll_exp_name);
2091 name = deref_func_name(lv.ll_exp_name, &len, partial,
2092 flags & TFN_NO_AUTOLOAD);
2093 if (name == lv.ll_exp_name)
2094 name = NULL;
2095 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002096 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002097 {
2098 len = (int)(end - *pp);
2099 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2100 if (name == *pp)
2101 name = NULL;
2102 }
2103 if (name != NULL)
2104 {
2105 name = vim_strsave(name);
2106 *pp = end;
2107 if (STRNCMP(name, "<SNR>", 5) == 0)
2108 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002109 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 name[0] = K_SPECIAL;
2111 name[1] = KS_EXTRA;
2112 name[2] = (int)KE_SNR;
2113 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2114 }
2115 goto theend;
2116 }
2117
2118 if (lv.ll_exp_name != NULL)
2119 {
2120 len = (int)STRLEN(lv.ll_exp_name);
2121 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2122 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2123 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002124 // When there was "s:" already or the name expanded to get a
2125 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002126 lv.ll_name += 2;
2127 len -= 2;
2128 lead = 2;
2129 }
2130 }
2131 else
2132 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002133 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002134 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
2135 lv.ll_name += 2;
2136 len = (int)(end - lv.ll_name);
2137 }
2138
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002139 // In Vim9 script a user function is script-local by default.
2140 vim9script = ASCII_ISUPPER(*start)
2141 && current_sctx.sc_version == SCRIPT_VERSION_VIM9;
2142
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002143 /*
2144 * Copy the function name to allocated memory.
2145 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2146 * Accept <SNR>123_name() outside a script.
2147 */
2148 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002149 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002150 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002152 if (!vim9script)
2153 lead = 3;
2154 if (vim9script || (lv.ll_exp_name != NULL
2155 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156 || eval_fname_sid(*pp))
2157 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002158 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002159 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002160 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002161 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002162 goto theend;
2163 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002164 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002165 if (vim9script)
2166 extra = 3 + (int)STRLEN(sid_buf);
2167 else
2168 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002169 }
2170 }
2171 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2172 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002173 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002174 start);
2175 goto theend;
2176 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002177 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002178 {
2179 char_u *cp = vim_strchr(lv.ll_name, ':');
2180
2181 if (cp != NULL && cp < end)
2182 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002183 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184 goto theend;
2185 }
2186 }
2187
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002188 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002189 if (name != NULL)
2190 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002191 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002192 {
2193 name[0] = K_SPECIAL;
2194 name[1] = KS_EXTRA;
2195 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002196 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002197 STRCPY(name + 3, sid_buf);
2198 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002199 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2200 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002201 }
2202 *pp = end;
2203
2204theend:
2205 clear_lval(&lv);
2206 return name;
2207}
2208
2209/*
2210 * ":function"
2211 */
2212 void
2213ex_function(exarg_T *eap)
2214{
2215 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002216 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217 int j;
2218 int c;
2219 int saved_did_emsg;
2220 int saved_wait_return = need_wait_return;
2221 char_u *name = NULL;
2222 char_u *p;
2223 char_u *arg;
2224 char_u *line_arg = NULL;
2225 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002226 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002227 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228 garray_T newlines;
2229 int varargs = FALSE;
2230 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002231 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232 ufunc_T *fp;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002233 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002234 int indent;
2235 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002236#define MAX_FUNC_NESTING 50
2237 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002238 dictitem_T *v;
2239 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002240 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002242 int todo;
2243 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002244 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002245 linenr_T sourcing_lnum_off;
2246 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002247 int is_heredoc = FALSE;
2248 char_u *skip_until = NULL;
2249 char_u *heredoc_trimmed = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002250
2251 /*
2252 * ":function" without argument: list functions.
2253 */
2254 if (ends_excmd(*eap->arg))
2255 {
2256 if (!eap->skip)
2257 {
2258 todo = (int)func_hashtab.ht_used;
2259 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
2260 {
2261 if (!HASHITEM_EMPTY(hi))
2262 {
2263 --todo;
2264 fp = HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002265 if ((fp->uf_flags & FC_DEAD)
2266 || message_filtered(fp->uf_name))
Bram Moolenaarf86db782018-10-25 13:31:37 +02002267 continue;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002268 if (!func_name_refcount(fp->uf_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 list_func_head(fp, FALSE);
2270 }
2271 }
2272 }
2273 eap->nextcmd = check_nextcmd(eap->arg);
2274 return;
2275 }
2276
2277 /*
2278 * ":function /pat": list functions matching pattern.
2279 */
2280 if (*eap->arg == '/')
2281 {
2282 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL);
2283 if (!eap->skip)
2284 {
2285 regmatch_T regmatch;
2286
2287 c = *p;
2288 *p = NUL;
2289 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2290 *p = c;
2291 if (regmatch.regprog != NULL)
2292 {
2293 regmatch.rm_ic = p_ic;
2294
2295 todo = (int)func_hashtab.ht_used;
2296 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
2297 {
2298 if (!HASHITEM_EMPTY(hi))
2299 {
2300 --todo;
2301 fp = HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002302 if ((fp->uf_flags & FC_DEAD) == 0
2303 && !isdigit(*fp->uf_name)
2304 && vim_regexec(&regmatch, fp->uf_name, 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305 list_func_head(fp, FALSE);
2306 }
2307 }
2308 vim_regfree(regmatch.regprog);
2309 }
2310 }
2311 if (*p == '/')
2312 ++p;
2313 eap->nextcmd = check_nextcmd(p);
2314 return;
2315 }
2316
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002317 ga_init(&newargs);
2318 ga_init(&argtypes);
2319 ga_init(&default_args);
2320
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002321 /*
2322 * Get the function name. There are these situations:
2323 * func normal function name
2324 * "name" == func, "fudi.fd_dict" == NULL
2325 * dict.func new dictionary entry
2326 * "name" == NULL, "fudi.fd_dict" set,
2327 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2328 * dict.func existing dict entry with a Funcref
2329 * "name" == func, "fudi.fd_dict" set,
2330 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2331 * dict.func existing dict entry that's not a Funcref
2332 * "name" == NULL, "fudi.fd_dict" set,
2333 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2334 * s:func script-local function name
2335 * g:func global function name, same as "func"
2336 */
2337 p = eap->arg;
Bram Moolenaar3388d332017-12-07 22:23:04 +01002338 name = trans_function_name(&p, eap->skip, TFN_NO_AUTOLOAD, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002339 paren = (vim_strchr(p, '(') != NULL);
2340 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
2341 {
2342 /*
2343 * Return on an invalid expression in braces, unless the expression
2344 * evaluation has been cancelled due to an aborting error, an
2345 * interrupt, or an exception.
2346 */
2347 if (!aborting())
2348 {
2349 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002350 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351 vim_free(fudi.fd_newkey);
2352 return;
2353 }
2354 else
2355 eap->skip = TRUE;
2356 }
2357
Bram Moolenaare38eab22019-12-05 21:50:01 +01002358 // An error in a function call during evaluation of an expression in magic
2359 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002360 saved_did_emsg = did_emsg;
2361 did_emsg = FALSE;
2362
2363 /*
2364 * ":function func" with only function name: list function.
2365 */
2366 if (!paren)
2367 {
2368 if (!ends_excmd(*skipwhite(p)))
2369 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002370 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 goto ret_free;
2372 }
2373 eap->nextcmd = check_nextcmd(p);
2374 if (eap->nextcmd != NULL)
2375 *p = NUL;
2376 if (!eap->skip && !got_int)
2377 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002378 fp = find_func(name, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 if (fp != NULL)
2380 {
2381 list_func_head(fp, TRUE);
2382 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2383 {
2384 if (FUNCLINE(fp, j) == NULL)
2385 continue;
2386 msg_putchar('\n');
2387 msg_outnum((long)(j + 1));
2388 if (j < 9)
2389 msg_putchar(' ');
2390 if (j < 99)
2391 msg_putchar(' ');
2392 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002393 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394 ui_breakcheck();
2395 }
2396 if (!got_int)
2397 {
2398 msg_putchar('\n');
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002399 if (fp->uf_dfunc_idx >= 0)
2400 msg_puts(" enddef");
2401 else
2402 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002403 }
2404 }
2405 else
2406 emsg_funcname(N_("E123: Undefined function: %s"), name);
2407 }
2408 goto ret_free;
2409 }
2410
2411 /*
2412 * ":function name(arg1, arg2)" Define function.
2413 */
2414 p = skipwhite(p);
2415 if (*p != '(')
2416 {
2417 if (!eap->skip)
2418 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002419 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420 goto ret_free;
2421 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002422 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002423 if (vim_strchr(p, '(') != NULL)
2424 p = vim_strchr(p, '(');
2425 }
2426 p = skipwhite(p + 1);
2427
2428 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2429
2430 if (!eap->skip)
2431 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002432 // Check the name of the function. Unless it's a dictionary function
2433 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 if (name != NULL)
2435 arg = name;
2436 else
2437 arg = fudi.fd_newkey;
2438 if (arg != NULL && (fudi.fd_di == NULL
2439 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2440 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2441 {
2442 if (*arg == K_SPECIAL)
2443 j = 3;
2444 else
2445 j = 0;
2446 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2447 : eval_isnamec(arg[j])))
2448 ++j;
2449 if (arg[j] != NUL)
2450 emsg_funcname((char *)e_invarg2, arg);
2451 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002452 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002454 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455 }
2456
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002457 if (get_function_args(&p, ')', &newargs,
2458 eap->cmdidx == CMD_def ? &argtypes : NULL,
2459 &varargs, &default_args, eap->skip) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002460 goto errret_2;
2461
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002462 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002464 // find the return type: :def Func(): type
2465 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002467 ret_type = skipwhite(p + 1);
2468 p = skip_type(ret_type);
2469 if (p > ret_type)
2470 p = skipwhite(p);
2471 else
2472 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002475 else
2476 // find extra arguments "range", "dict", "abort" and "closure"
2477 for (;;)
2478 {
2479 p = skipwhite(p);
2480 if (STRNCMP(p, "range", 5) == 0)
2481 {
2482 flags |= FC_RANGE;
2483 p += 5;
2484 }
2485 else if (STRNCMP(p, "dict", 4) == 0)
2486 {
2487 flags |= FC_DICT;
2488 p += 4;
2489 }
2490 else if (STRNCMP(p, "abort", 5) == 0)
2491 {
2492 flags |= FC_ABORT;
2493 p += 5;
2494 }
2495 else if (STRNCMP(p, "closure", 7) == 0)
2496 {
2497 flags |= FC_CLOSURE;
2498 p += 7;
2499 if (current_funccal == NULL)
2500 {
2501 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2502 name == NULL ? (char_u *)"" : name);
2503 goto erret;
2504 }
2505 }
2506 else
2507 break;
2508 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509
Bram Moolenaare38eab22019-12-05 21:50:01 +01002510 // When there is a line break use what follows for the function body.
2511 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 if (*p == '\n')
2513 line_arg = p + 1;
2514 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002515 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516
2517 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002518 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2519 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 */
2521 if (KeyTyped)
2522 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002523 // Check if the function already exists, don't let the user type the
2524 // whole function before telling him it doesn't work! For a script we
2525 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 if (!eap->skip && !eap->forceit)
2527 {
2528 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002529 emsg(_(e_funcdict));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002530 else if (name != NULL && find_func(name, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 emsg_funcname(e_funcexts, name);
2532 }
2533
2534 if (!eap->skip && did_emsg)
2535 goto erret;
2536
Bram Moolenaare38eab22019-12-05 21:50:01 +01002537 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 cmdline_row = msg_row;
2539 }
2540
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002541 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002542 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002543
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 indent = 2;
2545 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002546 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 for (;;)
2548 {
2549 if (KeyTyped)
2550 {
2551 msg_scroll = TRUE;
2552 saved_wait_return = FALSE;
2553 }
2554 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555
2556 if (line_arg != NULL)
2557 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002558 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 theline = line_arg;
2560 p = vim_strchr(theline, '\n');
2561 if (p == NULL)
2562 line_arg += STRLEN(line_arg);
2563 else
2564 {
2565 *p = NUL;
2566 line_arg = p + 1;
2567 }
2568 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02002570 {
2571 vim_free(line_to_free);
2572 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02002573 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002574 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02002575 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002576 line_to_free = theline;
2577 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 if (KeyTyped)
2579 lines_left = Rows - 1;
2580 if (theline == NULL)
2581 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002582 if (eap->cmdidx == CMD_def)
2583 emsg(_("E1057: Missing :enddef"));
2584 else
2585 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586 goto erret;
2587 }
2588
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002589 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002590 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002591 if (SOURCING_LNUM < sourcing_lnum_off)
2592 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002593 else
2594 sourcing_lnum_off = 0;
2595
2596 if (skip_until != NULL)
2597 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002598 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002599 // * ":append" and "."
2600 // * ":python <<EOF" and "EOF"
2601 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
2602 if (heredoc_trimmed == NULL
2603 || (is_heredoc && skipwhite(theline) == theline)
2604 || STRNCMP(theline, heredoc_trimmed,
2605 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002606 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002607 if (heredoc_trimmed == NULL)
2608 p = theline;
2609 else if (is_heredoc)
2610 p = skipwhite(theline) == theline
2611 ? theline : theline + STRLEN(heredoc_trimmed);
2612 else
2613 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02002614 if (STRCMP(p, skip_until) == 0)
2615 {
2616 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002617 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02002618 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002619 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002620 }
2621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 }
2623 else
2624 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002625 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01002626 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002627 ;
2628
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002629 // Check for "endfunction" or "enddef".
2630 if (checkforcmd(&p, nesting_def[nesting]
2631 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02002633 char_u *nextcmd = NULL;
2634
Bram Moolenaar663bb232017-06-22 19:12:10 +02002635 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02002636 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002637 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02002638 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002639 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002640 give_warning2(eap->cmdidx == CMD_def
2641 ? (char_u *)_("W1001: Text found after :enddef: %s")
2642 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02002643 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002644 if (nextcmd != NULL)
2645 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 // Another command follows. If the line came from "eap" we
2647 // can simply point into it, otherwise we need to change
2648 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02002649 eap->nextcmd = nextcmd;
2650 if (line_to_free != NULL)
2651 {
2652 vim_free(*eap->cmdlinep);
2653 *eap->cmdlinep = line_to_free;
2654 line_to_free = NULL;
2655 }
2656 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 break;
2658 }
2659
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 // Increase indent inside "if", "while", "for" and "try", decrease
2661 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002662 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 indent -= 2;
2664 else if (STRNCMP(p, "if", 2) == 0
2665 || STRNCMP(p, "wh", 2) == 0
2666 || STRNCMP(p, "for", 3) == 0
2667 || STRNCMP(p, "try", 3) == 0)
2668 indent += 2;
2669
Bram Moolenaare38eab22019-12-05 21:50:01 +01002670 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01002671 // Only recognize "def" inside "def", not inside "function",
2672 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002673 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01002674 if (checkforcmd(&p, "function", 2)
2675 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676 {
2677 if (*p == '!')
2678 p = skipwhite(p + 1);
2679 p += eval_fname_script(p);
2680 vim_free(trans_function_name(&p, TRUE, 0, NULL, NULL));
2681 if (*skipwhite(p) == '(')
2682 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002683 if (nesting == MAX_FUNC_NESTING - 1)
2684 emsg(_("E1058: function nesting too deep"));
2685 else
2686 {
2687 ++nesting;
2688 nesting_def[nesting] = (c == 'd');
2689 indent += 2;
2690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 }
2692 }
2693
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002694 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002696 if (eap->cmdidx != CMD_def
2697 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01002698 || (p[0] == 'c'
2699 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
2700 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
2701 && (STRNCMP(&p[3], "nge", 3) != 0
2702 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703 || (p[0] == 'i'
2704 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01002705 && (!ASCII_ISALPHA(p[2])
2706 || (p[2] == 's'
2707 && (!ASCII_ISALPHA(p[3])
2708 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 skip_until = vim_strsave((char_u *)".");
2710
Bram Moolenaare38eab22019-12-05 21:50:01 +01002711 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 arg = skipwhite(skiptowhite(p));
2713 if (arg[0] == '<' && arg[1] =='<'
2714 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01002715 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
2716 || ((p[2] == '3' || p[2] == 'x')
2717 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 || (p[0] == 'p' && p[1] == 'e'
2719 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
2720 || (p[0] == 't' && p[1] == 'c'
2721 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
2722 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
2723 && !ASCII_ISALPHA(p[3]))
2724 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
2725 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
2726 || (p[0] == 'm' && p[1] == 'z'
2727 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
2728 ))
2729 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002730 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731 p = skipwhite(arg + 2);
2732 if (*p == NUL)
2733 skip_until = vim_strsave((char_u *)".");
2734 else
2735 skip_until = vim_strsave(p);
2736 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02002737
2738 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002739 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02002740 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002741 if (*arg == '[')
2742 arg = vim_strchr(arg, ']');
2743 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002744 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002745 arg = skipwhite(skiptowhite(arg));
2746 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
2747 && ((p[0] == 'l'
2748 && p[1] == 'e'
2749 && (!ASCII_ISALNUM(p[2])
2750 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02002751 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002752 p = skipwhite(arg + 3);
2753 if (STRNCMP(p, "trim", 4) == 0)
2754 {
2755 // Ignore leading white space.
2756 p = skipwhite(p + 4);
2757 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar8471e572019-05-19 21:37:18 +02002758 (int)(skipwhite(theline) - theline));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01002759 }
2760 skip_until = vim_strnsave(p, (int)(skiptowhite(p) - p));
2761 do_concat = FALSE;
2762 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002763 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02002764 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 }
2766
Bram Moolenaare38eab22019-12-05 21:50:01 +01002767 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770
Bram Moolenaare38eab22019-12-05 21:50:01 +01002771 // Copy the line to newly allocated memory. get_one_sourceline()
2772 // allocates 250 bytes per line, this saves 80% on average. The cost
2773 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002775 if (p == NULL)
2776 goto erret;
2777 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778
Bram Moolenaare38eab22019-12-05 21:50:01 +01002779 // Add NULL lines for continuation lines, so that the line count is
2780 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 while (sourcing_lnum_off-- > 0)
2782 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2783
Bram Moolenaare38eab22019-12-05 21:50:01 +01002784 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 if (line_arg != NULL && *line_arg == NUL)
2786 line_arg = NULL;
2787 }
2788
Bram Moolenaare38eab22019-12-05 21:50:01 +01002789 // Don't define the function when skipping commands or when an error was
2790 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791 if (eap->skip || did_emsg)
2792 goto erret;
2793
2794 /*
2795 * If there are no errors, add the function
2796 */
2797 if (fudi.fd_dict == NULL)
2798 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002799 hashtab_T *ht;
2800
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002801 v = find_var(name, &ht, FALSE);
2802 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
2803 {
2804 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
2805 name);
2806 goto erret;
2807 }
2808
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002809 fp = find_func_even_dead(name, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 if (fp != NULL)
2811 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002812 int dead = fp->uf_flags & FC_DEAD;
2813
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01002814 // Function can be replaced with "function!" and when sourcing the
2815 // same script again, but only once.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002816 if (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01002817 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
2818 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 {
2820 emsg_funcname(e_funcexts, name);
2821 goto erret;
2822 }
2823 if (fp->uf_calls > 0)
2824 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01002825 emsg_funcname(
2826 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827 name);
2828 goto erret;
2829 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002830 if (fp->uf_refcount > 1)
2831 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002832 // This function is referenced somewhere, don't redefine it but
2833 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002834 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002835 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002836 fp = NULL;
2837 overwrite = TRUE;
2838 }
2839 else
2840 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01002841 char_u *exp_name = fp->uf_name_exp;
2842
2843 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01002844 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01002845 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02002846 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01002847 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002848 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02002849#ifdef FEAT_PROFILE
2850 fp->uf_profiling = FALSE;
2851 fp->uf_prof_initialized = FALSE;
2852#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002853 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002854 }
2855 }
2856 else
2857 {
2858 char numbuf[20];
2859
2860 fp = NULL;
2861 if (fudi.fd_newkey == NULL && !eap->forceit)
2862 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002863 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 goto erret;
2865 }
2866 if (fudi.fd_di == NULL)
2867 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002868 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002869 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870 goto erret;
2871 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002872 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01002873 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 goto erret;
2875
Bram Moolenaare38eab22019-12-05 21:50:01 +01002876 // Give the function a sequential number. Can only be used with a
2877 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878 vim_free(name);
2879 sprintf(numbuf, "%d", ++func_nr);
2880 name = vim_strsave((char_u *)numbuf);
2881 if (name == NULL)
2882 goto erret;
2883 }
2884
2885 if (fp == NULL)
2886 {
2887 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
2888 {
2889 int slen, plen;
2890 char_u *scriptname;
2891
Bram Moolenaare38eab22019-12-05 21:50:01 +01002892 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002894 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 {
2896 scriptname = autoload_name(name);
2897 if (scriptname != NULL)
2898 {
2899 p = vim_strchr(scriptname, '/');
2900 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002901 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002903 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002904 j = OK;
2905 vim_free(scriptname);
2906 }
2907 }
2908 if (j == FAIL)
2909 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002910 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 goto erret;
2912 }
2913 }
2914
Bram Moolenaar47ed5532019-08-08 20:49:14 +02002915 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002916 if (fp == NULL)
2917 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002918 fp->uf_dfunc_idx = -1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919
2920 if (fudi.fd_dict != NULL)
2921 {
2922 if (fudi.fd_di == NULL)
2923 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002924 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002925 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
2926 if (fudi.fd_di == NULL)
2927 {
2928 vim_free(fp);
2929 goto erret;
2930 }
2931 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
2932 {
2933 vim_free(fudi.fd_di);
2934 vim_free(fp);
2935 goto erret;
2936 }
2937 }
2938 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01002939 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 clear_tv(&fudi.fd_di->di_tv);
2941 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002943
Bram Moolenaare38eab22019-12-05 21:50:01 +01002944 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002945 flags |= FC_DICT;
2946 }
2947
Bram Moolenaare38eab22019-12-05 21:50:01 +01002948 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002949 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002950 if (overwrite)
2951 {
2952 hi = hash_find(&func_hashtab, name);
2953 hi->hi_key = UF2HIKEY(fp);
2954 }
2955 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 {
2957 vim_free(fp);
2958 goto erret;
2959 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002960 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961 }
2962 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002963 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002964 fp->uf_ret_type = &t_any;
2965
2966 if (eap->cmdidx == CMD_def)
2967 {
2968 // parse the argument types
2969 ga_init2(&fp->uf_type_list, sizeof(type_T), 5);
2970
2971 if (argtypes.ga_len > 0)
2972 {
2973 // When "varargs" is set the last name/type goes into uf_va_name
2974 // and uf_va_type.
2975 int len = argtypes.ga_len - (varargs ? 1 : 0);
2976
2977 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
2978 if (fp->uf_arg_types != NULL)
2979 {
2980 int i;
2981
2982 for (i = 0; i < len; ++ i)
2983 {
2984 p = ((char_u **)argtypes.ga_data)[i];
2985 if (p == NULL)
2986 // todo: get type from default value
2987 fp->uf_arg_types[i] = &t_any;
2988 else
2989 fp->uf_arg_types[i] = parse_type(&p, &fp->uf_type_list);
2990 }
2991 }
2992 if (varargs)
2993 {
2994 // Move the last argument "...name: type" to uf_va_name and
2995 // uf_va_type.
2996 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
2997 [fp->uf_args.ga_len - 1];
2998 --fp->uf_args.ga_len;
2999 p = ((char_u **)argtypes.ga_data)[len];
3000 if (p == NULL)
3001 // todo: get type from default value
3002 fp->uf_va_type = &t_any;
3003 else
3004 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
3005 }
3006 varargs = FALSE;
3007 }
3008
3009 // parse the return type, if any
3010 if (ret_type == NULL)
3011 fp->uf_ret_type = &t_void;
3012 else
3013 {
3014 p = ret_type;
3015 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3016 }
3017 }
3018
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003020 if ((flags & FC_CLOSURE) != 0)
3021 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003022 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003023 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003024 }
3025 else
3026 fp->uf_scoped = NULL;
3027
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 if (prof_def_func())
3030 func_do_profile(fp);
3031#endif
3032 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003033 if (sandbox)
3034 flags |= FC_SANDBOX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 fp->uf_flags = flags;
3036 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003037 fp->uf_script_ctx = current_sctx;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003038 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003039 if (is_export)
3040 {
3041 fp->uf_flags |= FC_EXPORT;
3042 // let ex_export() know the export worked.
3043 is_export = FALSE;
3044 }
3045
3046 // ":def Func()" needs to be compiled
3047 if (eap->cmdidx == CMD_def)
3048 compile_def_function(fp, FALSE);
3049
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 goto ret_free;
3051
3052erret:
3053 ga_clear_strings(&newargs);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003054 ga_clear_strings(&argtypes);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003055 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056errret_2:
3057 ga_clear_strings(&newlines);
3058ret_free:
3059 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003060 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 vim_free(fudi.fd_newkey);
3062 vim_free(name);
3063 did_emsg |= saved_did_emsg;
3064 need_wait_return |= saved_wait_return;
3065}
3066
3067/*
3068 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3069 * Return 2 if "p" starts with "s:".
3070 * Return 0 otherwise.
3071 */
3072 int
3073eval_fname_script(char_u *p)
3074{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003075 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3076 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3078 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3079 return 5;
3080 if (p[0] == 's' && p[1] == ':')
3081 return 2;
3082 return 0;
3083}
3084
3085 int
3086translated_function_exists(char_u *name)
3087{
3088 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003089 return has_internal_func(name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003090 return find_func(name, NULL) != NULL;
3091}
3092
3093/*
3094 * Return TRUE when "ufunc" has old-style "..." varargs
3095 * or named varargs "...name: type".
3096 */
3097 int
3098has_varargs(ufunc_T *ufunc)
3099{
3100 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101}
3102
3103/*
3104 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003105 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106 */
3107 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003108function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109{
3110 char_u *nm = name;
3111 char_u *p;
3112 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003113 int flag;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003114
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003115 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3116 if (no_deref)
3117 flag |= TFN_NO_DEREF;
3118 p = trans_function_name(&nm, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 nm = skipwhite(nm);
3120
Bram Moolenaare38eab22019-12-05 21:50:01 +01003121 // Only accept "funcname", "funcname ", "funcname (..." and
3122 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 if (p != NULL && (*nm == NUL || *nm == '('))
3124 n = translated_function_exists(p);
3125 vim_free(p);
3126 return n;
3127}
3128
Bram Moolenaar113e1072019-01-20 15:30:40 +01003129#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 char_u *
3131get_expanded_name(char_u *name, int check)
3132{
3133 char_u *nm = name;
3134 char_u *p;
3135
3136 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL, NULL);
3137
3138 if (p != NULL && *nm == NUL)
3139 if (!check || translated_function_exists(p))
3140 return p;
3141
3142 vim_free(p);
3143 return NULL;
3144}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003145#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147/*
3148 * Function given to ExpandGeneric() to obtain the list of user defined
3149 * function names.
3150 */
3151 char_u *
3152get_user_func_name(expand_T *xp, int idx)
3153{
3154 static long_u done;
3155 static hashitem_T *hi;
3156 ufunc_T *fp;
3157
3158 if (idx == 0)
3159 {
3160 done = 0;
3161 hi = func_hashtab.ht_array;
3162 }
3163 if (done < func_hashtab.ht_used)
3164 {
3165 if (done++ > 0)
3166 ++hi;
3167 while (HASHITEM_EMPTY(hi))
3168 ++hi;
3169 fp = HI2UF(hi);
3170
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003171 // don't show dead, dict and lambda functions
3172 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003173 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003174 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175
3176 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003177 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178
3179 cat_func_name(IObuff, fp);
3180 if (xp->xp_context != EXPAND_USER_FUNC)
3181 {
3182 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003183 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 STRCAT(IObuff, ")");
3185 }
3186 return IObuff;
3187 }
3188 return NULL;
3189}
3190
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191/*
3192 * ":delfunction {name}"
3193 */
3194 void
3195ex_delfunction(exarg_T *eap)
3196{
3197 ufunc_T *fp = NULL;
3198 char_u *p;
3199 char_u *name;
3200 funcdict_T fudi;
3201
3202 p = eap->arg;
3203 name = trans_function_name(&p, eap->skip, 0, &fudi, NULL);
3204 vim_free(fudi.fd_newkey);
3205 if (name == NULL)
3206 {
3207 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003208 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 return;
3210 }
3211 if (!ends_excmd(*skipwhite(p)))
3212 {
3213 vim_free(name);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003214 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215 return;
3216 }
3217 eap->nextcmd = check_nextcmd(p);
3218 if (eap->nextcmd != NULL)
3219 *p = NUL;
3220
3221 if (!eap->skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003222 fp = find_func(name, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 vim_free(name);
3224
3225 if (!eap->skip)
3226 {
3227 if (fp == NULL)
3228 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003229 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003230 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 return;
3232 }
3233 if (fp->uf_calls > 0)
3234 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003235 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 return;
3237 }
3238
3239 if (fudi.fd_dict != NULL)
3240 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003241 // Delete the dict item that refers to the function, it will
3242 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3244 }
3245 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003246 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003247 // A normal function (not a numbered function or lambda) has a
3248 // refcount of 1 for the entry in the hashtable. When deleting
3249 // it and the refcount is more than one, it should be kept.
3250 // A numbered function and lambda should be kept if the refcount is
3251 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003252 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003253 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003254 // Function is still referenced somewhere. Don't free it but
3255 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003256 if (func_remove(fp))
3257 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003258 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003259 }
3260 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003261 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003262 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 }
3264}
3265
3266/*
3267 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003268 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003269 */
3270 void
3271func_unref(char_u *name)
3272{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003273 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003274
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003275 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003277 fp = find_func(name, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003278 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003279 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003281 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003283 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003285 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003287 // Only delete it when it's not being used. Otherwise it's done
3288 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003289 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003290 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003291 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003292}
3293
3294/*
3295 * Unreference a Function: decrement the reference count and free it when it
3296 * becomes zero.
3297 */
3298 void
3299func_ptr_unref(ufunc_T *fp)
3300{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003301 if (fp != NULL && --fp->uf_refcount <= 0)
3302 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003303 // Only delete it when it's not being used. Otherwise it's done
3304 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003305 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003306 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 }
3308}
3309
3310/*
3311 * Count a reference to a Function.
3312 */
3313 void
3314func_ref(char_u *name)
3315{
3316 ufunc_T *fp;
3317
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003318 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 fp = find_func(name, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003321 if (fp != NULL)
3322 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003323 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003324 // Only give an error for a numbered function.
3325 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003326 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003327}
3328
3329/*
3330 * Count a reference to a Function.
3331 */
3332 void
3333func_ptr_ref(ufunc_T *fp)
3334{
3335 if (fp != NULL)
3336 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337}
3338
3339/*
3340 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3341 * referenced from anywhere that is in use.
3342 */
3343 static int
3344can_free_funccal(funccall_T *fc, int copyID)
3345{
3346 return (fc->l_varlist.lv_copyID != copyID
3347 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003348 && fc->l_avars.dv_copyID != copyID
3349 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350}
3351
3352/*
3353 * ":return [expr]"
3354 */
3355 void
3356ex_return(exarg_T *eap)
3357{
3358 char_u *arg = eap->arg;
3359 typval_T rettv;
3360 int returning = FALSE;
3361
3362 if (current_funccal == NULL)
3363 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003364 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365 return;
3366 }
3367
3368 if (eap->skip)
3369 ++emsg_skip;
3370
3371 eap->nextcmd = NULL;
3372 if ((*arg != NUL && *arg != '|' && *arg != '\n')
3373 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL)
3374 {
3375 if (!eap->skip)
3376 returning = do_return(eap, FALSE, TRUE, &rettv);
3377 else
3378 clear_tv(&rettv);
3379 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003380 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 else if (!eap->skip)
3382 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003383 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003384 update_force_abort();
3385
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 /*
3387 * Return unless the expression evaluation has been cancelled due to an
3388 * aborting error, an interrupt, or an exception.
3389 */
3390 if (!aborting())
3391 returning = do_return(eap, FALSE, TRUE, NULL);
3392 }
3393
Bram Moolenaare38eab22019-12-05 21:50:01 +01003394 // When skipping or the return gets pending, advance to the next command
3395 // in this line (!returning). Otherwise, ignore the rest of the line.
3396 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003397 if (returning)
3398 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003399 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 eap->nextcmd = check_nextcmd(arg);
3401
3402 if (eap->skip)
3403 --emsg_skip;
3404}
3405
3406/*
3407 * ":1,25call func(arg1, arg2)" function call.
3408 */
3409 void
3410ex_call(exarg_T *eap)
3411{
3412 char_u *arg = eap->arg;
3413 char_u *startarg;
3414 char_u *name;
3415 char_u *tofree;
3416 int len;
3417 typval_T rettv;
3418 linenr_T lnum;
3419 int doesrange;
3420 int failed = FALSE;
3421 funcdict_T fudi;
3422 partial_T *partial = NULL;
3423
3424 if (eap->skip)
3425 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003426 // trans_function_name() doesn't work well when skipping, use eval0()
3427 // instead to skip to any following command, e.g. for:
3428 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003429 ++emsg_skip;
3430 if (eval0(eap->arg, &rettv, &eap->nextcmd, FALSE) != FAIL)
3431 clear_tv(&rettv);
3432 --emsg_skip;
3433 return;
3434 }
3435
3436 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi, &partial);
3437 if (fudi.fd_newkey != NULL)
3438 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003439 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003440 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003441 vim_free(fudi.fd_newkey);
3442 }
3443 if (tofree == NULL)
3444 return;
3445
Bram Moolenaare38eab22019-12-05 21:50:01 +01003446 // Increase refcount on dictionary, it could get deleted when evaluating
3447 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 if (fudi.fd_dict != NULL)
3449 ++fudi.fd_dict->dv_refcount;
3450
Bram Moolenaare38eab22019-12-05 21:50:01 +01003451 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
3452 // contents. For VAR_PARTIAL get its partial, unless we already have one
3453 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 len = (int)STRLEN(tofree);
3455 name = deref_func_name(tofree, &len,
3456 partial != NULL ? NULL : &partial, FALSE);
3457
Bram Moolenaare38eab22019-12-05 21:50:01 +01003458 // Skip white space to allow ":call func ()". Not good, but required for
3459 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003461 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462
3463 if (*startarg != '(')
3464 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003465 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 goto end;
3467 }
3468
3469 /*
3470 * When skipping, evaluate the function once, to find the end of the
3471 * arguments.
3472 * When the function takes a range, this is discovered after the first
3473 * call, and the loop is broken.
3474 */
3475 if (eap->skip)
3476 {
3477 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003478 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 }
3480 else
3481 lnum = eap->line1;
3482 for ( ; lnum <= eap->line2; ++lnum)
3483 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003484 funcexe_T funcexe;
3485
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 if (!eap->skip && eap->addr_count > 0)
3487 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003488 if (lnum > curbuf->b_ml.ml_line_count)
3489 {
3490 // If the function deleted lines or switched to another buffer
3491 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003492 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003493 break;
3494 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003495 curwin->w_cursor.lnum = lnum;
3496 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003497 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 }
3499 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003500
Bram Moolenaarac92e252019-08-03 21:58:38 +02003501 vim_memset(&funcexe, 0, sizeof(funcexe));
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003502 funcexe.firstline = eap->line1;
3503 funcexe.lastline = eap->line2;
3504 funcexe.doesrange = &doesrange;
3505 funcexe.evaluate = !eap->skip;
3506 funcexe.partial = partial;
3507 funcexe.selfdict = fudi.fd_dict;
3508 if (get_func_tv(name, -1, &rettv, &arg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003509 {
3510 failed = TRUE;
3511 break;
3512 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003513 if (has_watchexpr())
3514 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02003516 // Handle a function returning a Funcref, Dictionary or List.
3517 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE,
3518 name, &name) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003519 {
3520 failed = TRUE;
3521 break;
3522 }
3523
3524 clear_tv(&rettv);
3525 if (doesrange || eap->skip)
3526 break;
3527
Bram Moolenaare38eab22019-12-05 21:50:01 +01003528 // Stop when immediately aborting on error, or when an interrupt
3529 // occurred or an exception was thrown but not caught.
3530 // get_func_tv() returned OK, so that the check for trailing
3531 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532 if (aborting())
3533 break;
3534 }
3535 if (eap->skip)
3536 --emsg_skip;
3537
3538 if (!failed)
3539 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003540 // Check for trailing illegal characters and a following command.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 if (!ends_excmd(*arg))
3542 {
3543 emsg_severe = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003544 emsg(_(e_trailing));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 }
3546 else
3547 eap->nextcmd = check_nextcmd(arg);
3548 }
3549
3550end:
3551 dict_unref(fudi.fd_dict);
3552 vim_free(tofree);
3553}
3554
3555/*
3556 * Return from a function. Possibly makes the return pending. Also called
3557 * for a pending return at the ":endtry" or after returning from an extra
3558 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
3559 * when called due to a ":return" command. "rettv" may point to a typval_T
3560 * with the return rettv. Returns TRUE when the return can be carried out,
3561 * FALSE when the return gets pending.
3562 */
3563 int
3564do_return(
3565 exarg_T *eap,
3566 int reanimate,
3567 int is_cmd,
3568 void *rettv)
3569{
3570 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01003571 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572
3573 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003574 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 current_funccal->returned = FALSE;
3576
3577 /*
3578 * Cleanup (and inactivate) conditionals, but stop when a try conditional
3579 * not in its finally clause (which then is to be executed next) is found.
3580 * In this case, make the ":return" pending for execution at the ":endtry".
3581 * Otherwise, return normally.
3582 */
3583 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
3584 if (idx >= 0)
3585 {
3586 cstack->cs_pending[idx] = CSTP_RETURN;
3587
3588 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003589 // A pending return again gets pending. "rettv" points to an
3590 // allocated variable with the rettv of the original ":return"'s
3591 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592 cstack->cs_rettv[idx] = rettv;
3593 else
3594 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003595 // When undoing a return in order to make it pending, get the stored
3596 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 if (reanimate)
3598 rettv = current_funccal->rettv;
3599
3600 if (rettv != NULL)
3601 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003602 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
3604 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
3605 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003606 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 }
3608 else
3609 cstack->cs_rettv[idx] = NULL;
3610
3611 if (reanimate)
3612 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003613 // The pending return value could be overwritten by a ":return"
3614 // without argument in a finally clause; reset the default
3615 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 current_funccal->rettv->v_type = VAR_NUMBER;
3617 current_funccal->rettv->vval.v_number = 0;
3618 }
3619 }
3620 report_make_pending(CSTP_RETURN, rettv);
3621 }
3622 else
3623 {
3624 current_funccal->returned = TRUE;
3625
Bram Moolenaare38eab22019-12-05 21:50:01 +01003626 // If the return is carried out now, store the return value. For
3627 // a return immediately after reanimation, the value is already
3628 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 if (!reanimate && rettv != NULL)
3630 {
3631 clear_tv(current_funccal->rettv);
3632 *current_funccal->rettv = *(typval_T *)rettv;
3633 if (!is_cmd)
3634 vim_free(rettv);
3635 }
3636 }
3637
3638 return idx < 0;
3639}
3640
3641/*
3642 * Free the variable with a pending return value.
3643 */
3644 void
3645discard_pending_return(void *rettv)
3646{
3647 free_tv((typval_T *)rettv);
3648}
3649
3650/*
3651 * Generate a return command for producing the value of "rettv". The result
3652 * is an allocated string. Used by report_pending() for verbose messages.
3653 */
3654 char_u *
3655get_return_cmd(void *rettv)
3656{
3657 char_u *s = NULL;
3658 char_u *tofree = NULL;
3659 char_u numbuf[NUMBUFLEN];
3660
3661 if (rettv != NULL)
3662 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
3663 if (s == NULL)
3664 s = (char_u *)"";
3665
3666 STRCPY(IObuff, ":return ");
3667 STRNCPY(IObuff + 8, s, IOSIZE - 8);
3668 if (STRLEN(s) + 8 >= IOSIZE)
3669 STRCPY(IObuff + IOSIZE - 4, "...");
3670 vim_free(tofree);
3671 return vim_strsave(IObuff);
3672}
3673
3674/*
3675 * Get next function line.
3676 * Called by do_cmdline() to get the next line.
3677 * Returns allocated string, or NULL for end of function.
3678 */
3679 char_u *
3680get_func_line(
3681 int c UNUSED,
3682 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02003683 int indent UNUSED,
3684 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685{
3686 funccall_T *fcp = (funccall_T *)cookie;
3687 ufunc_T *fp = fcp->func;
3688 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003689 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690
Bram Moolenaare38eab22019-12-05 21:50:01 +01003691 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003692 if (fcp->dbg_tick != debug_tick)
3693 {
3694 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003695 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 fcp->dbg_tick = debug_tick;
3697 }
3698#ifdef FEAT_PROFILE
3699 if (do_profiling == PROF_YES)
3700 func_line_end(cookie);
3701#endif
3702
3703 gap = &fp->uf_lines;
3704 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
3705 || fcp->returned)
3706 retval = NULL;
3707 else
3708 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003709 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 while (fcp->linenr < gap->ga_len
3711 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
3712 ++fcp->linenr;
3713 if (fcp->linenr >= gap->ga_len)
3714 retval = NULL;
3715 else
3716 {
3717 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003718 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719#ifdef FEAT_PROFILE
3720 if (do_profiling == PROF_YES)
3721 func_line_start(cookie);
3722#endif
3723 }
3724 }
3725
Bram Moolenaare38eab22019-12-05 21:50:01 +01003726 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003727 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003728 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003729 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003730 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003731 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003732 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 fcp->dbg_tick = debug_tick;
3734 }
3735
3736 return retval;
3737}
3738
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739/*
3740 * Return TRUE if the currently active function should be ended, because a
3741 * return was encountered or an error occurred. Used inside a ":while".
3742 */
3743 int
3744func_has_ended(void *cookie)
3745{
3746 funccall_T *fcp = (funccall_T *)cookie;
3747
Bram Moolenaare38eab22019-12-05 21:50:01 +01003748 // Ignore the "abort" flag if the abortion behavior has been changed due to
3749 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
3751 || fcp->returned);
3752}
3753
3754/*
3755 * return TRUE if cookie indicates a function which "abort"s on errors.
3756 */
3757 int
3758func_has_abort(
3759 void *cookie)
3760{
3761 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
3762}
3763
3764
3765/*
3766 * Turn "dict.Func" into a partial for "Func" bound to "dict".
3767 * Don't do this when "Func" is already a partial that was bound
3768 * explicitly (pt_auto is FALSE).
3769 * Changes "rettv" in-place.
3770 * Returns the updated "selfdict_in".
3771 */
3772 dict_T *
3773make_partial(dict_T *selfdict_in, typval_T *rettv)
3774{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003775 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 char_u *tofree = NULL;
3777 ufunc_T *fp;
3778 char_u fname_buf[FLEN_FIXED + 1];
3779 int error;
3780 dict_T *selfdict = selfdict_in;
3781
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003782 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
3783 fp = rettv->vval.v_partial->pt_func;
3784 else
3785 {
3786 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
3787 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003788 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003789 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003790 fp = find_func(fname, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003791 vim_free(tofree);
3792 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793
3794 if (fp != NULL && (fp->uf_flags & FC_DICT))
3795 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003796 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797
3798 if (pt != NULL)
3799 {
3800 pt->pt_refcount = 1;
3801 pt->pt_dict = selfdict;
3802 pt->pt_auto = TRUE;
3803 selfdict = NULL;
3804 if (rettv->v_type == VAR_FUNC)
3805 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003806 // Just a function: Take over the function name and use
3807 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 pt->pt_name = rettv->vval.v_string;
3809 }
3810 else
3811 {
3812 partial_T *ret_pt = rettv->vval.v_partial;
3813 int i;
3814
Bram Moolenaare38eab22019-12-05 21:50:01 +01003815 // Partial: copy the function name, use selfdict and copy
3816 // args. Can't take over name or args, the partial might
3817 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003818 if (ret_pt->pt_name != NULL)
3819 {
3820 pt->pt_name = vim_strsave(ret_pt->pt_name);
3821 func_ref(pt->pt_name);
3822 }
3823 else
3824 {
3825 pt->pt_func = ret_pt->pt_func;
3826 func_ptr_ref(pt->pt_func);
3827 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 if (ret_pt->pt_argc > 0)
3829 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02003830 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003832 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 pt->pt_argc = 0;
3834 else
3835 {
3836 pt->pt_argc = ret_pt->pt_argc;
3837 for (i = 0; i < pt->pt_argc; i++)
3838 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
3839 }
3840 }
3841 partial_unref(ret_pt);
3842 }
3843 rettv->v_type = VAR_PARTIAL;
3844 rettv->vval.v_partial = pt;
3845 }
3846 }
3847 return selfdict;
3848}
3849
3850/*
3851 * Return the name of the executed function.
3852 */
3853 char_u *
3854func_name(void *cookie)
3855{
3856 return ((funccall_T *)cookie)->func->uf_name;
3857}
3858
3859/*
3860 * Return the address holding the next breakpoint line for a funccall cookie.
3861 */
3862 linenr_T *
3863func_breakpoint(void *cookie)
3864{
3865 return &((funccall_T *)cookie)->breakpoint;
3866}
3867
3868/*
3869 * Return the address holding the debug tick for a funccall cookie.
3870 */
3871 int *
3872func_dbg_tick(void *cookie)
3873{
3874 return &((funccall_T *)cookie)->dbg_tick;
3875}
3876
3877/*
3878 * Return the nesting level for a funccall cookie.
3879 */
3880 int
3881func_level(void *cookie)
3882{
3883 return ((funccall_T *)cookie)->level;
3884}
3885
3886/*
3887 * Return TRUE when a function was ended by a ":return" command.
3888 */
3889 int
3890current_func_returned(void)
3891{
3892 return current_funccal->returned;
3893}
3894
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 int
3896free_unref_funccal(int copyID, int testing)
3897{
3898 int did_free = FALSE;
3899 int did_free_funccal = FALSE;
3900 funccall_T *fc, **pfc;
3901
3902 for (pfc = &previous_funccal; *pfc != NULL; )
3903 {
3904 if (can_free_funccal(*pfc, copyID))
3905 {
3906 fc = *pfc;
3907 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01003908 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 did_free = TRUE;
3910 did_free_funccal = TRUE;
3911 }
3912 else
3913 pfc = &(*pfc)->caller;
3914 }
3915 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003916 // When a funccal was freed some more items might be garbage
3917 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918 (void)garbage_collect(testing);
3919
3920 return did_free;
3921}
3922
3923/*
Bram Moolenaarba209902016-08-24 22:06:38 +02003924 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 */
3926 static funccall_T *
3927get_funccal(void)
3928{
3929 int i;
3930 funccall_T *funccal;
3931 funccall_T *temp_funccal;
3932
3933 funccal = current_funccal;
3934 if (debug_backtrace_level > 0)
3935 {
3936 for (i = 0; i < debug_backtrace_level; i++)
3937 {
3938 temp_funccal = funccal->caller;
3939 if (temp_funccal)
3940 funccal = temp_funccal;
3941 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003942 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 debug_backtrace_level = i;
3944 }
3945 }
3946 return funccal;
3947}
3948
3949/*
3950 * Return the hashtable used for local variables in the current funccal.
3951 * Return NULL if there is no current funccal.
3952 */
3953 hashtab_T *
3954get_funccal_local_ht()
3955{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003956 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 return NULL;
3958 return &get_funccal()->l_vars.dv_hashtab;
3959}
3960
3961/*
3962 * Return the l: scope variable.
3963 * Return NULL if there is no current funccal.
3964 */
3965 dictitem_T *
3966get_funccal_local_var()
3967{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003968 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 return NULL;
3970 return &get_funccal()->l_vars_var;
3971}
3972
3973/*
3974 * Return the hashtable used for argument in the current funccal.
3975 * Return NULL if there is no current funccal.
3976 */
3977 hashtab_T *
3978get_funccal_args_ht()
3979{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003980 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 return NULL;
3982 return &get_funccal()->l_avars.dv_hashtab;
3983}
3984
3985/*
3986 * Return the a: scope variable.
3987 * Return NULL if there is no current funccal.
3988 */
3989 dictitem_T *
3990get_funccal_args_var()
3991{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003992 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01003994 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995}
3996
3997/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 * List function variables, if there is a function.
3999 */
4000 void
4001list_func_vars(int *first)
4002{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004003 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004005 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006}
4007
4008/*
4009 * If "ht" is the hashtable for local variables in the current funccal, return
4010 * the dict that contains it.
4011 * Otherwise return NULL.
4012 */
4013 dict_T *
4014get_current_funccal_dict(hashtab_T *ht)
4015{
4016 if (current_funccal != NULL
4017 && ht == &current_funccal->l_vars.dv_hashtab)
4018 return &current_funccal->l_vars;
4019 return NULL;
4020}
4021
4022/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004023 * Search hashitem in parent scope.
4024 */
4025 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004026find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004027{
4028 funccall_T *old_current_funccal = current_funccal;
4029 hashtab_T *ht;
4030 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004031 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004032
4033 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4034 return NULL;
4035
Bram Moolenaare38eab22019-12-05 21:50:01 +01004036 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004037 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004038 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004039 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004040 ht = find_var_ht(name, &varname);
4041 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004042 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004043 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004044 if (!HASHITEM_EMPTY(hi))
4045 {
4046 *pht = ht;
4047 break;
4048 }
4049 }
4050 if (current_funccal == current_funccal->func->uf_scoped)
4051 break;
4052 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004053 }
4054 current_funccal = old_current_funccal;
4055
4056 return hi;
4057}
4058
4059/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004060 * Search variable in parent scope.
4061 */
4062 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004063find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004064{
4065 dictitem_T *v = NULL;
4066 funccall_T *old_current_funccal = current_funccal;
4067 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004068 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004069
4070 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4071 return NULL;
4072
Bram Moolenaare38eab22019-12-05 21:50:01 +01004073 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004074 current_funccal = current_funccal->func->uf_scoped;
4075 while (current_funccal)
4076 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004077 ht = find_var_ht(name, &varname);
4078 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004079 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004080 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004081 if (v != NULL)
4082 break;
4083 }
4084 if (current_funccal == current_funccal->func->uf_scoped)
4085 break;
4086 current_funccal = current_funccal->func->uf_scoped;
4087 }
4088 current_funccal = old_current_funccal;
4089
4090 return v;
4091}
4092
4093/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094 * Set "copyID + 1" in previous_funccal and callers.
4095 */
4096 int
4097set_ref_in_previous_funccal(int copyID)
4098{
4099 int abort = FALSE;
4100 funccall_T *fc;
4101
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004102 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004104 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004105 abort = abort
4106 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4107 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004108 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004109 }
4110 return abort;
4111}
4112
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004113 static int
4114set_ref_in_funccal(funccall_T *fc, int copyID)
4115{
4116 int abort = FALSE;
4117
4118 if (fc->fc_copyID != copyID)
4119 {
4120 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004121 abort = abort
4122 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4123 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004124 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004125 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004126 }
4127 return abort;
4128}
4129
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130/*
4131 * Set "copyID" in all local vars and arguments in the call stack.
4132 */
4133 int
4134set_ref_in_call_stack(int copyID)
4135{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004136 int abort = FALSE;
4137 funccall_T *fc;
4138 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004140 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004141 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004142
4143 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004144 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4145 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004146 abort = abort || set_ref_in_funccal(fc, copyID);
4147
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004148 return abort;
4149}
4150
4151/*
4152 * Set "copyID" in all functions available by name.
4153 */
4154 int
4155set_ref_in_functions(int copyID)
4156{
4157 int todo;
4158 hashitem_T *hi = NULL;
4159 int abort = FALSE;
4160 ufunc_T *fp;
4161
4162 todo = (int)func_hashtab.ht_used;
4163 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004164 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004165 if (!HASHITEM_EMPTY(hi))
4166 {
4167 --todo;
4168 fp = HI2UF(hi);
4169 if (!func_name_refcount(fp->uf_name))
4170 abort = abort || set_ref_in_func(NULL, fp, copyID);
4171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 }
4173 return abort;
4174}
4175
4176/*
4177 * Set "copyID" in all function arguments.
4178 */
4179 int
4180set_ref_in_func_args(int copyID)
4181{
4182 int i;
4183 int abort = FALSE;
4184
4185 for (i = 0; i < funcargs.ga_len; ++i)
4186 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4187 copyID, NULL, NULL);
4188 return abort;
4189}
4190
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004191/*
4192 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004193 * Returns TRUE if setting references failed somehow.
4194 */
4195 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004196set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004197{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004198 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004199 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004200 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004201 char_u fname_buf[FLEN_FIXED + 1];
4202 char_u *tofree = NULL;
4203 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004204 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004205
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004206 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004207 return FALSE;
4208
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004209 if (fp_in == NULL)
4210 {
4211 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004212 fp = find_func(fname, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004213 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004214 if (fp != NULL)
4215 {
4216 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004217 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004218 }
4219 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004220 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004221}
4222
Bram Moolenaare38eab22019-12-05 21:50:01 +01004223#endif // FEAT_EVAL