blob: 9ab5ffe5258faa516682203a3da89c60da84bea1 [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 Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010057 * Return a pointer to after the type.
58 * When something is wrong return "arg".
59 */
60 static char_u *
61one_function_arg(char_u *arg, garray_T *newargs, garray_T *argtypes, int skip)
62{
Bram Moolenaar6e949782020-04-13 17:21:00 +020063 char_u *p = arg;
64 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010065
66 while (ASCII_ISALNUM(*p) || *p == '_')
67 ++p;
68 if (arg == p || isdigit(*arg)
69 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
70 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))
71 {
72 if (!skip)
73 semsg(_("E125: Illegal argument: %s"), arg);
74 return arg;
75 }
76 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
77 return arg;
78 if (newargs != NULL)
79 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010080 int c;
81 int i;
82
83 c = *p;
84 *p = NUL;
85 arg_copy = vim_strsave(arg);
86 if (arg_copy == NULL)
87 {
88 *p = c;
89 return arg;
90 }
91
92 // Check for duplicate argument name.
93 for (i = 0; i < newargs->ga_len; ++i)
94 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
95 {
96 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
97 vim_free(arg_copy);
98 return arg;
99 }
100 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
101 newargs->ga_len++;
102
103 *p = c;
104 }
105
106 // get any type from "arg: type"
107 if (argtypes != NULL && ga_grow(argtypes, 1) == OK)
108 {
109 char_u *type = NULL;
110
Bram Moolenaar6e949782020-04-13 17:21:00 +0200111 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
112 {
113 semsg(_("E1059: No white space allowed before colon: %s"),
114 arg_copy == NULL ? arg : arg_copy);
115 p = skipwhite(p);
116 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100117 if (*p == ':')
118 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200119 ++p;
120 if (!VIM_ISWHITE(*p))
121 {
122 semsg(_(e_white_after), ":");
123 return arg;
124 }
125 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200126 p = skip_type(type, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100127 type = vim_strnsave(type, p - type);
128 }
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 else if (*skipwhite(p) != '=')
130 {
131 semsg(_("E1077: Missing argument type for %s"),
132 arg_copy == NULL ? arg : arg_copy);
133 return arg;
134 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100135 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
136 }
137
138 return p;
139}
140
141/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200142 * Get function arguments.
143 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100144 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200145get_function_args(
146 char_u **argp,
147 char_u endchar,
148 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149 garray_T *argtypes, // NULL unless using :def
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200150 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200151 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200152 int skip,
153 exarg_T *eap,
154 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200155{
156 int mustend = FALSE;
157 char_u *arg = *argp;
158 char_u *p = arg;
159 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200160 int any_default = FALSE;
161 char_u *expr;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200162 char_u *whitep = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200163
164 if (newargs != NULL)
165 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100166 if (argtypes != NULL)
167 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 if (default_args != NULL)
169 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170
171 if (varargs != NULL)
172 *varargs = FALSE;
173
174 /*
175 * Isolate the arguments: "arg1, arg2, ...)"
176 */
177 while (*p != endchar)
178 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200179 while (eap != NULL && eap->getline != NULL
180 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200181 {
182 char_u *theline;
183
184 // End of the line, get the next one.
185 theline = eap->getline(':', eap->cookie, 0, TRUE);
186 if (theline == NULL)
187 break;
188 vim_free(*line_to_free);
189 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200190 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200191 p = skipwhite(theline);
192 }
193
194 if (mustend && *p != endchar)
195 {
196 if (!skip)
197 semsg(_(e_invarg2), *argp);
198 break;
199 }
200 if (*p == endchar)
201 break;
202
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200203 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
204 {
205 if (varargs != NULL)
206 *varargs = TRUE;
207 p += 3;
208 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100209
210 if (argtypes != NULL)
211 {
212 // ...name: list<type>
213 if (!ASCII_ISALPHA(*p))
214 {
215 emsg(_("E1055: Missing name after ..."));
216 break;
217 }
218
219 arg = p;
220 p = one_function_arg(p, newargs, argtypes, skip);
221 if (p == arg)
222 break;
223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200224 }
225 else
226 {
227 arg = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228 p = one_function_arg(p, newargs, argtypes, skip);
229 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200231
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200232 if (*skipwhite(p) == '=' && default_args != NULL)
233 {
234 typval_T rettv;
235
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100236 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200237 any_default = TRUE;
238 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200239 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200240 p = skipwhite(p);
241 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200242 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200243 {
244 if (ga_grow(default_args, 1) == FAIL)
245 goto err_ret;
246
247 // trim trailing whitespace
248 while (p > expr && VIM_ISWHITE(p[-1]))
249 p--;
250 c = *p;
251 *p = NUL;
252 expr = vim_strsave(expr);
253 if (expr == NULL)
254 {
255 *p = c;
256 goto err_ret;
257 }
258 ((char_u **)(default_args->ga_data))
259 [default_args->ga_len] = expr;
260 default_args->ga_len++;
261 *p = c;
262 }
263 else
264 mustend = TRUE;
265 }
266 else if (any_default)
267 {
268 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200269 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200270 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200272 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200273 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200274 // Don't give this error when skipping, it makes the "->" not
275 // found in "{k,v -> x}" and give a confusing error.
276 if (!skip && in_vim9script()
277 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
278 {
279 semsg(_(e_white_after), ",");
280 goto err_ret;
281 }
282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200283 else
284 mustend = TRUE;
285 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200286 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200287 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200288 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200289
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200290 if (*p != endchar)
291 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100292 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200293
294 *argp = p;
295 return OK;
296
297err_ret:
298 if (newargs != NULL)
299 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200300 if (default_args != NULL)
301 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200302 return FAIL;
303}
304
305/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200306 * Register function "fp" as using "current_funccal" as its scope.
307 */
308 static int
309register_closure(ufunc_T *fp)
310{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200311 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100312 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200313 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200314 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200315 fp->uf_scoped = current_funccal;
316 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200317
Bram Moolenaar58016442016-07-31 18:30:22 +0200318 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
319 return FAIL;
320 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
321 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200322 return OK;
323}
324
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100325 static void
326set_ufunc_name(ufunc_T *fp, char_u *name)
327{
328 STRCPY(fp->uf_name, name);
329
330 if (name[0] == K_SPECIAL)
331 {
332 fp->uf_name_exp = alloc(STRLEN(name) + 3);
333 if (fp->uf_name_exp != NULL)
334 {
335 STRCPY(fp->uf_name_exp, "<SNR>");
336 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
337 }
338 }
339}
340
Bram Moolenaar58016442016-07-31 18:30:22 +0200341/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200342 * Get a name for a lambda. Returned in static memory.
343 */
344 char_u *
345get_lambda_name(void)
346{
347 static char_u name[30];
348 static int lambda_no = 0;
349
350 sprintf((char*)name, "<lambda>%d", ++lambda_no);
351 return name;
352}
353
Bram Moolenaar801ab062020-06-25 19:27:56 +0200354#if defined(FEAT_LUA) || defined(PROTO)
355/*
356 * Registers a native C callback which can be called from Vim script.
357 * Returns the name of the Vim script function.
358 */
359 char_u *
360register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
361{
362 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200363 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200364
365 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
366 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200367 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200368
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200369 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200370 fp->uf_refcount = 1;
371 fp->uf_varargs = TRUE;
372 fp->uf_flags = FC_CFUNC;
373 fp->uf_calls = 0;
374 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200375 fp->uf_cb = cb;
376 fp->uf_cb_free = cb_free;
377 fp->uf_cb_state = state;
378
379 set_ufunc_name(fp, name);
380 hash_add(&func_hashtab, UF2HIKEY(fp));
381
382 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200383}
384#endif
385
Bram Moolenaar04b12692020-05-04 23:24:44 +0200386/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200387 * Parse a lambda expression and get a Funcref from "*arg".
388 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
389 */
390 int
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200391get_lambda_tv(char_u **arg, typval_T *rettv, evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200392{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200393 int evaluate = evalarg != NULL
394 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200395 garray_T newargs;
396 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200397 garray_T *pnewargs;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200398 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100399 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200400 int varargs;
401 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200402 char_u *s;
403 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200404 int *old_eval_lavars = eval_lavars_used;
405 int eval_lavars = FALSE;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200406 char_u *tofree = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200407
408 ga_init(&newargs);
409 ga_init(&newlines);
410
Bram Moolenaare38eab22019-12-05 21:50:01 +0100411 // First, check if this is a lambda expression. "->" must exist.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200412 s = skipwhite(*arg + 1);
413 ret = get_function_args(&s, '-', NULL, NULL, NULL, NULL, TRUE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200414 NULL, NULL);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200415 if (ret == FAIL || *s != '>')
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200416 return NOTDONE;
417
Bram Moolenaare38eab22019-12-05 21:50:01 +0100418 // Parse the arguments again.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200419 if (evaluate)
420 pnewargs = &newargs;
421 else
422 pnewargs = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200423 *arg = skipwhite(*arg + 1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100424 // TODO: argument types
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200425 ret = get_function_args(arg, '-', pnewargs, NULL, &varargs, NULL, FALSE,
426 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200427 if (ret == FAIL || **arg != '>')
428 goto errret;
429
Bram Moolenaare38eab22019-12-05 21:50:01 +0100430 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200431 if (evaluate)
432 eval_lavars_used = &eval_lavars;
433
Bram Moolenaare38eab22019-12-05 21:50:01 +0100434 // Get the start and the end of the expression.
Bram Moolenaar9215f012020-06-27 21:18:00 +0200435 *arg = skipwhite_and_linebreak(*arg + 1, evalarg);
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200436 start = *arg;
437 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200438 if (ret == FAIL)
439 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200440 if (evalarg != NULL)
441 {
442 // avoid that the expression gets freed when another line break follows
443 tofree = evalarg->eval_tofree;
444 evalarg->eval_tofree = NULL;
445 }
446
Bram Moolenaar9215f012020-06-27 21:18:00 +0200447 *arg = skipwhite_and_linebreak(*arg, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200448 if (**arg != '}')
Bram Moolenaaree619e52020-03-28 21:38:06 +0100449 {
450 semsg(_("E451: Expected }: %s"), *arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200451 goto errret;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100452 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200453 ++*arg;
454
455 if (evaluate)
456 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200457 int len;
458 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200459 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200460 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200461
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200462 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200463 if (fp == NULL)
464 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200465 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200466 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200467 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200468 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200469
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200470 ga_init2(&newlines, (int)sizeof(char_u *), 1);
471 if (ga_grow(&newlines, 1) == FAIL)
472 goto errret;
473
Bram Moolenaare38eab22019-12-05 21:50:01 +0100474 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200475 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200476 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200477 if (p == NULL)
478 goto errret;
479 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
480 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200481 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200482 if (strstr((char *)p + 7, "a:") == NULL)
483 // No a: variables are used for sure.
484 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200485
486 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100487 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200488 hash_add(&func_hashtab, UF2HIKEY(fp));
489 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200490 ga_init(&fp->uf_def_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200491 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200492 if (current_funccal != NULL && eval_lavars)
493 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200494 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200495 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200496 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200497 }
498 else
499 fp->uf_scoped = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200500
501#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200502 if (prof_def_func())
503 func_do_profile(fp);
504#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200505 if (sandbox)
506 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100507 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200508 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200509 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200510 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200511 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100512 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200513
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200514 pt->pt_func = fp;
515 pt->pt_refcount = 1;
516 rettv->vval.v_partial = pt;
517 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200519
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200520 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200521 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200522 evalarg->eval_tofree = tofree;
523 else
524 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200525 return OK;
526
527errret:
528 ga_clear_strings(&newargs);
529 ga_clear_strings(&newlines);
530 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100531 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200532 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200533 evalarg->eval_tofree = tofree;
534 else
535 vim_free(tofree);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200536 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 return FAIL;
538}
539
540/*
541 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
542 * name it contains, otherwise return "name".
543 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
544 * "partialp".
545 */
546 char_u *
547deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload)
548{
549 dictitem_T *v;
550 int cc;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200551 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200552
553 if (partialp != NULL)
554 *partialp = NULL;
555
556 cc = name[*lenp];
557 name[*lenp] = NUL;
558 v = find_var(name, NULL, no_autoload);
559 name[*lenp] = cc;
560 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
561 {
562 if (v->di_tv.vval.v_string == NULL)
563 {
564 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100565 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200566 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200567 s = v->di_tv.vval.v_string;
568 *lenp = (int)STRLEN(s);
569 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200570 }
571
572 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL)
573 {
574 partial_T *pt = v->di_tv.vval.v_partial;
575
576 if (pt == NULL)
577 {
578 *lenp = 0;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100579 return (char_u *)""; // just in case
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200580 }
581 if (partialp != NULL)
582 *partialp = pt;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200583 s = partial_name(pt);
584 *lenp = (int)STRLEN(s);
585 return s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200586 }
587
588 return name;
589}
590
591/*
592 * Give an error message with a function name. Handle <SNR> things.
593 * "ermsg" is to be passed without translation, use N_() instead of _().
594 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100595 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200596emsg_funcname(char *ermsg, char_u *name)
597{
598 char_u *p;
599
600 if (*name == K_SPECIAL)
601 p = concat_str((char_u *)"<SNR>", name + 3);
602 else
603 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100604 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200605 if (p != name)
606 vim_free(p);
607}
608
609/*
610 * Allocate a variable for the result of a function.
611 * Return OK or FAIL.
612 */
613 int
614get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200615 char_u *name, // name of the function
616 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200617 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200618 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200619 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200620 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200621{
622 char_u *argp;
623 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100624 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
625 int argcount = 0; // number of arguments found
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200626
627 /*
628 * Get the arguments.
629 */
630 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200631 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
632 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200633 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200634 // skip the '(' or ',' and possibly line breaks
635 argp = skipwhite_and_linebreak(argp + 1, evalarg);
636
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200637 if (*argp == ')' || *argp == ',' || *argp == NUL)
638 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200639 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200640 {
641 ret = FAIL;
642 break;
643 }
644 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200645 // The comma should come right after the argument, but this wasn't
646 // checked previously, thus only enforce it in Vim9 script.
647 if (!in_vim9script())
648 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200649 if (*argp != ',')
650 break;
651 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200652 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653 if (*argp == ')')
654 ++argp;
655 else
656 ret = FAIL;
657
658 if (ret == OK)
659 {
660 int i = 0;
661
662 if (get_vim_var_nr(VV_TESTING))
663 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100664 // Prepare for calling test_garbagecollect_now(), need to know
665 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200666 if (funcargs.ga_itemsize == 0)
667 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
668 for (i = 0; i < argcount; ++i)
669 if (ga_grow(&funcargs, 1) == OK)
670 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
671 &argvars[i];
672 }
673
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200674 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200675
676 funcargs.ga_len -= i;
677 }
678 else if (!aborting())
679 {
680 if (argcount == MAX_FUNC_ARGS)
681 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
682 else
683 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
684 }
685
686 while (--argcount >= 0)
687 clear_tv(&argvars[argcount]);
688
Bram Moolenaar8294d492020-08-10 22:40:56 +0200689 if (in_vim9script())
690 *arg = argp;
691 else
692 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200693 return ret;
694}
695
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200696/*
697 * Return TRUE if "p" starts with "<SID>" or "s:".
698 * Only works if eval_fname_script() returned non-zero for "p"!
699 */
700 static int
701eval_fname_sid(char_u *p)
702{
703 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
704}
705
706/*
707 * In a script change <SID>name() and s:name() to K_SNR 123_name().
708 * Change <SNR>123_name() to K_SNR 123_name().
709 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
710 * (slow).
711 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100712 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200713fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
714{
715 int llen;
716 char_u *fname;
717 int i;
718
719 llen = eval_fname_script(name);
720 if (llen > 0)
721 {
722 fname_buf[0] = K_SPECIAL;
723 fname_buf[1] = KS_EXTRA;
724 fname_buf[2] = (int)KE_SNR;
725 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100726 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200727 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200728 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100729 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730 else
731 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200732 sprintf((char *)fname_buf + 3, "%ld_",
733 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200734 i = (int)STRLEN(fname_buf);
735 }
736 }
737 if (i + STRLEN(name + llen) < FLEN_FIXED)
738 {
739 STRCPY(fname_buf + i, name + llen);
740 fname = fname_buf;
741 }
742 else
743 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200744 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200745 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100746 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200747 else
748 {
749 *tofree = fname;
750 mch_memmove(fname, fname_buf, (size_t)i);
751 STRCPY(fname + i, name + llen);
752 }
753 }
754 }
755 else
756 fname = name;
757 return fname;
758}
759
760/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100761 * Find a function "name" in script "sid".
762 */
763 static ufunc_T *
764find_func_with_sid(char_u *name, int sid)
765{
766 hashitem_T *hi;
767 char_u buffer[200];
768
769 buffer[0] = K_SPECIAL;
770 buffer[1] = KS_EXTRA;
771 buffer[2] = (int)KE_SNR;
772 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
773 (long)sid, name);
774 hi = hash_find(&func_hashtab, buffer);
775 if (!HASHITEM_EMPTY(hi))
776 return HI2UF(hi);
777
778 return NULL;
779}
780
781/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200782 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200783 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200784 * Return NULL for unknown function.
785 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200786 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200787find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200788{
789 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100790 ufunc_T *func;
791 imported_T *imported;
792
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200793 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100794 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200795 int vim9script = in_vim9script();
796 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200797 long sid = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100798
Bram Moolenaar333894b2020-08-01 18:53:07 +0200799 if (vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100800 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200801 // Find script-local function before global one.
802 func = find_func_with_sid(name, current_sctx.sc_sid);
803 if (func != NULL)
804 return func;
805 }
806
Bram Moolenaarefa94442020-08-08 22:16:00 +0200807 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200808 && name[1] == KS_EXTRA
809 && name[2] == KE_SNR)
810 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200811 // Caller changes s: to <SNR>99_name.
812
813 after_script = name + 3;
814 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200815 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200816 ++after_script;
817 else
818 after_script = NULL;
819 }
Bram Moolenaar333894b2020-08-01 18:53:07 +0200820 if (vim9script || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200821 {
822 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200823 if (after_script != NULL && sid != current_sctx.sc_sid)
824 imported = find_imported_in_script(after_script, 0, sid);
825 else
826 imported = find_imported(after_script == NULL
827 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200828 if (imported != NULL && imported->imp_funcname != NULL)
829 {
830 hi = hash_find(&func_hashtab, imported->imp_funcname);
831 if (!HASHITEM_EMPTY(hi))
832 return HI2UF(hi);
833 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100834 }
835 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200836
Bram Moolenaara26b9702020-04-18 19:53:28 +0200837 hi = hash_find(&func_hashtab,
838 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200839 if (!HASHITEM_EMPTY(hi))
840 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100841
842 return NULL;
843}
844
845/*
846 * Find a function by name, return pointer to it in ufuncs.
847 * "cctx" is passed in a :def function to find imported functions.
848 * Return NULL for unknown or dead function.
849 */
850 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200851find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100852{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200853 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100854
855 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
856 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200857 return NULL;
858}
859
860/*
861 * Copy the function name of "fp" to buffer "buf".
862 * "buf" must be able to hold the function name plus three bytes.
863 * Takes care of script-local function names.
864 */
865 static void
866cat_func_name(char_u *buf, ufunc_T *fp)
867{
868 if (fp->uf_name[0] == K_SPECIAL)
869 {
870 STRCPY(buf, "<SNR>");
871 STRCAT(buf, fp->uf_name + 3);
872 }
873 else
874 STRCPY(buf, fp->uf_name);
875}
876
877/*
878 * Add a number variable "name" to dict "dp" with value "nr".
879 */
880 static void
881add_nr_var(
882 dict_T *dp,
883 dictitem_T *v,
884 char *name,
885 varnumber_T nr)
886{
887 STRCPY(v->di_key, name);
888 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
889 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
890 v->di_tv.v_type = VAR_NUMBER;
891 v->di_tv.v_lock = VAR_FIXED;
892 v->di_tv.vval.v_number = nr;
893}
894
895/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100896 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200897 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100898 static void
899free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200900{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100901 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200902
903 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
904 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100905 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200906
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100907 // When garbage collecting a funccall_T may be freed before the
908 // function that references it, clear its uf_scoped field.
909 // The function may have been redefined and point to another
910 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200911 if (fp != NULL && fp->uf_scoped == fc)
912 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200913 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200914 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200915
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200916 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200917 vim_free(fc);
918}
919
920/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100921 * Free "fc" and what it contains.
922 * Can be called only when "fc" is kept beyond the period of it called,
923 * i.e. after cleanup_function_call(fc).
924 */
925 static void
926free_funccal_contents(funccall_T *fc)
927{
928 listitem_T *li;
929
930 // Free all l: variables.
931 vars_clear(&fc->l_vars.dv_hashtab);
932
933 // Free all a: variables.
934 vars_clear(&fc->l_avars.dv_hashtab);
935
936 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200937 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100938 clear_tv(&li->li_tv);
939
940 free_funccal(fc);
941}
942
943/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200944 * Handle the last part of returning from a function: free the local hashtable.
945 * Unless it is still in use by a closure.
946 */
947 static void
948cleanup_function_call(funccall_T *fc)
949{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100950 int may_free_fc = fc->fc_refcount <= 0;
951 int free_fc = TRUE;
952
Bram Moolenaar6914c642017-04-01 21:21:30 +0200953 current_funccal = fc->caller;
954
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100955 // Free all l: variables if not referred.
956 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
957 vars_clear(&fc->l_vars.dv_hashtab);
958 else
959 free_fc = FALSE;
960
961 // If the a:000 list and the l: and a: dicts are not referenced and
962 // there is no closure using it, we can free the funccall_T and what's
963 // in it.
964 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
965 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200966 else
967 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100968 int todo;
969 hashitem_T *hi;
970 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200971
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100972 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200973
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100974 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200975 todo = (int)fc->l_avars.dv_hashtab.ht_used;
976 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
977 {
978 if (!HASHITEM_EMPTY(hi))
979 {
980 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100981 di = HI2DI(hi);
982 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200983 }
984 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100985 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200986
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100987 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
988 fc->l_varlist.lv_first = NULL;
989 else
990 {
991 listitem_T *li;
992
993 free_fc = FALSE;
994
995 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200996 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200997 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100998 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100999
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001000 if (free_fc)
1001 free_funccal(fc);
1002 else
1003 {
1004 static int made_copy = 0;
1005
1006 // "fc" is still in use. This can happen when returning "a:000",
1007 // assigning "l:" to a global variable or defining a closure.
1008 // Link "fc" in the list for garbage collection later.
1009 fc->caller = previous_funccal;
1010 previous_funccal = fc;
1011
1012 if (want_garbage_collect)
1013 // If garbage collector is ready, clear count.
1014 made_copy = 0;
1015 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001016 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001017 // We have made a lot of copies, worth 4 Mbyte. This can happen
1018 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001019 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001020 // too much memory.
1021 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001022 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001023 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001024 }
1025}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001026/*
1027 * Unreference "fc": decrement the reference count and free it when it
1028 * becomes zero. "fp" is detached from "fc".
1029 * When "force" is TRUE we are exiting.
1030 */
1031 static void
1032funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1033{
1034 funccall_T **pfc;
1035 int i;
1036
1037 if (fc == NULL)
1038 return;
1039
1040 if (--fc->fc_refcount <= 0 && (force || (
1041 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1042 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1043 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1044 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1045 {
1046 if (fc == *pfc)
1047 {
1048 *pfc = fc->caller;
1049 free_funccal_contents(fc);
1050 return;
1051 }
1052 }
1053 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1054 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1055 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1056}
1057
1058/*
1059 * Remove the function from the function hashtable. If the function was
1060 * deleted while it still has references this was already done.
1061 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1062 */
1063 static int
1064func_remove(ufunc_T *fp)
1065{
1066 hashitem_T *hi;
1067
1068 // Return if it was already virtually deleted.
1069 if (fp->uf_flags & FC_DEAD)
1070 return FALSE;
1071
1072 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1073 if (!HASHITEM_EMPTY(hi))
1074 {
1075 // When there is a def-function index do not actually remove the
1076 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001077 // Do remove it when it's a copy.
1078 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001079 fp->uf_flags |= FC_DEAD;
1080 else
1081 hash_remove(&func_hashtab, hi);
1082 return TRUE;
1083 }
1084 return FALSE;
1085}
1086
1087 static void
1088func_clear_items(ufunc_T *fp)
1089{
1090 ga_clear_strings(&(fp->uf_args));
1091 ga_clear_strings(&(fp->uf_def_args));
1092 ga_clear_strings(&(fp->uf_lines));
1093 VIM_CLEAR(fp->uf_name_exp);
1094 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001095 VIM_CLEAR(fp->uf_def_arg_idx);
1096 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001097 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001098
1099#ifdef FEAT_LUA
1100 if (fp->uf_cb_free != NULL)
1101 {
1102 fp->uf_cb_free(fp->uf_cb_state);
1103 fp->uf_cb_free = NULL;
1104 }
1105
1106 fp->uf_cb_state = NULL;
1107 fp->uf_cb = NULL;
1108#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001109#ifdef FEAT_PROFILE
1110 VIM_CLEAR(fp->uf_tml_count);
1111 VIM_CLEAR(fp->uf_tml_total);
1112 VIM_CLEAR(fp->uf_tml_self);
1113#endif
1114}
1115
1116/*
1117 * Free all things that a function contains. Does not free the function
1118 * itself, use func_free() for that.
1119 * When "force" is TRUE we are exiting.
1120 */
1121 static void
1122func_clear(ufunc_T *fp, int force)
1123{
1124 if (fp->uf_cleared)
1125 return;
1126 fp->uf_cleared = TRUE;
1127
1128 // clear this function
1129 func_clear_items(fp);
1130 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001131 if ((fp->uf_flags & FC_COPY) == 0)
1132 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001133}
1134
1135/*
1136 * Free a function and remove it from the list of functions. Does not free
1137 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001138 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001139 */
1140 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001141func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001142{
1143 // Only remove it when not done already, otherwise we would remove a newer
1144 // version of the function with the same name.
1145 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1146 func_remove(fp);
1147
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001148 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001149 vim_free(fp);
1150}
1151
1152/*
1153 * Free all things that a function contains and free the function itself.
1154 * When "force" is TRUE we are exiting.
1155 */
1156 static void
1157func_clear_free(ufunc_T *fp, int force)
1158{
1159 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001160 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001161 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001162 else
1163 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001164}
1165
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001166/*
1167 * Copy already defined function "lambda" to a new function with name "global".
1168 * This is for when a compiled function defines a global function.
1169 */
1170 void
1171copy_func(char_u *lambda, char_u *global)
1172{
1173 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1174 ufunc_T *fp;
1175
1176 if (ufunc == NULL)
1177 semsg(_("E1102: lambda function not found: %s"), lambda);
1178 else
1179 {
1180 // TODO: handle ! to overwrite
1181 fp = find_func(global, TRUE, NULL);
1182 if (fp != NULL)
1183 {
1184 semsg(_(e_funcexts), global);
1185 return;
1186 }
1187
1188 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1189 if (fp == NULL)
1190 return;
1191
1192 fp->uf_varargs = ufunc->uf_varargs;
1193 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1194 fp->uf_def_status = ufunc->uf_def_status;
1195 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001196 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1197 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001198 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001199 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001200 goto failed;
1201
1202 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1203 : vim_strsave(ufunc->uf_name_exp);
1204 if (ufunc->uf_arg_types != NULL)
1205 {
1206 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1207 if (fp->uf_arg_types == NULL)
1208 goto failed;
1209 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1210 sizeof(type_T *) * fp->uf_args.ga_len);
1211 }
1212 if (ufunc->uf_def_arg_idx != NULL)
1213 {
1214 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1215 if (fp->uf_def_arg_idx == NULL)
1216 goto failed;
1217 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1218 sizeof(int) * fp->uf_def_args.ga_len + 1);
1219 }
1220 if (ufunc->uf_va_name != NULL)
1221 {
1222 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1223 if (fp->uf_va_name == NULL)
1224 goto failed;
1225 }
1226
1227 fp->uf_refcount = 1;
1228 STRCPY(fp->uf_name, global);
1229 hash_add(&func_hashtab, UF2HIKEY(fp));
1230 }
1231 return;
1232
1233failed:
1234 func_clear_free(fp, TRUE);
1235}
1236
Bram Moolenaar6914c642017-04-01 21:21:30 +02001237
1238/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001239 * Call a user function.
1240 */
1241 static void
1242call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001243 ufunc_T *fp, // pointer to function
1244 int argcount, // nr of args
1245 typval_T *argvars, // arguments
1246 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001247 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001248 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001249{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001250 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001251 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001252 funccall_T *fc;
1253 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001254 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001255 static int depth = 0;
1256 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001257 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001258 int i;
1259 int ai;
1260 int islambda = FALSE;
1261 char_u numbuf[NUMBUFLEN];
1262 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001263#ifdef FEAT_PROFILE
1264 proftime_T wait_start;
1265 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001266 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001268 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001269
Bram Moolenaare38eab22019-12-05 21:50:01 +01001270 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001271 if (depth >= p_mfd)
1272 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001273 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 rettv->v_type = VAR_NUMBER;
1275 rettv->vval.v_number = -1;
1276 return;
1277 }
1278 ++depth;
1279
Bram Moolenaare38eab22019-12-05 21:50:01 +01001280 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001281
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001282 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001283 if (fc == NULL)
1284 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 fc->caller = current_funccal;
1286 current_funccal = fc;
1287 fc->func = fp;
1288 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001289 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001290 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1292 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001293 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001294 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001295 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001296
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001297 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001298 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001299 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001300 save_current_sctx = current_sctx;
1301 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001302
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001303 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001304 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001305 --depth;
1306 current_funccal = fc->caller;
1307
1308 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001309 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001310 free_funccal(fc);
1311 return;
1312 }
1313
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1315 islambda = TRUE;
1316
1317 /*
1318 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1319 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1320 * each argument variable and saves a lot of time.
1321 */
1322 /*
1323 * Init l: variables.
1324 */
1325 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1326 if (selfdict != NULL)
1327 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001328 // Set l:self to "selfdict". Use "name" to avoid a warning from
1329 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330 v = &fc->fixvar[fixvar_idx++].var;
1331 name = v->di_key;
1332 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001333 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001334 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1335 v->di_tv.v_type = VAR_DICT;
1336 v->di_tv.v_lock = 0;
1337 v->di_tv.vval.v_dict = selfdict;
1338 ++selfdict->dv_refcount;
1339 }
1340
1341 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001342 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001343 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001344 * Set a:000 to a list with room for the "..." arguments.
1345 */
1346 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001347 if ((fp->uf_flags & FC_NOARGS) == 0)
1348 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001349 (varnumber_T)(argcount >= fp->uf_args.ga_len
1350 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001351 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001352 if ((fp->uf_flags & FC_NOARGS) == 0)
1353 {
1354 // Use "name" to avoid a warning from some compiler that checks the
1355 // destination size.
1356 v = &fc->fixvar[fixvar_idx++].var;
1357 name = v->di_key;
1358 STRCPY(name, "000");
1359 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1360 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1361 v->di_tv.v_type = VAR_LIST;
1362 v->di_tv.v_lock = VAR_FIXED;
1363 v->di_tv.vval.v_list = &fc->l_varlist;
1364 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001365 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001366 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1367 fc->l_varlist.lv_lock = VAR_FIXED;
1368
1369 /*
1370 * Set a:firstline to "firstline" and a:lastline to "lastline".
1371 * Set a:name to named arguments.
1372 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001373 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001374 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001375 if ((fp->uf_flags & FC_NOARGS) == 0)
1376 {
1377 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001378 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001379 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001380 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001381 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001382 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383 {
1384 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001385 typval_T def_rettv;
1386 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001387
1388 ai = i - fp->uf_args.ga_len;
1389 if (ai < 0)
1390 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001391 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392 name = FUNCARG(fp, i);
1393 if (islambda)
1394 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001395
1396 // evaluate named argument default expression
1397 isdefault = ai + fp->uf_def_args.ga_len >= 0
1398 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1399 && argvars[i].vval.v_number == VVAL_NONE));
1400 if (isdefault)
1401 {
1402 char_u *default_expr = NULL;
1403 def_rettv.v_type = VAR_NUMBER;
1404 def_rettv.vval.v_number = -1;
1405
1406 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1407 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001408 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001409 {
1410 default_arg_err = 1;
1411 break;
1412 }
1413 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001414 }
1415 else
1416 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001417 if ((fp->uf_flags & FC_NOARGS) != 0)
1418 // Bail out if no a: arguments used (in lambda).
1419 break;
1420
Bram Moolenaare38eab22019-12-05 21:50:01 +01001421 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001422 sprintf((char *)numbuf, "%d", ai + 1);
1423 name = numbuf;
1424 }
1425 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1426 {
1427 v = &fc->fixvar[fixvar_idx++].var;
1428 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001429 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001430 }
1431 else
1432 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001433 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434 if (v == NULL)
1435 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001436 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001437 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001439 // Note: the values are copied directly to avoid alloc/free.
1440 // "argvars" must have VAR_FIXED for v_lock.
1441 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001442 v->di_tv.v_lock = VAR_FIXED;
1443
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 if (addlocal)
1445 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001446 // Named arguments should be accessed without the "a:" prefix in
1447 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001448 copy_tv(&v->di_tv, &v->di_tv);
1449 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001451 else
1452 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453
1454 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1455 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001456 listitem_T *li = &fc->l_listitems[ai];
1457
1458 li->li_tv = argvars[i];
1459 li->li_tv.v_lock = VAR_FIXED;
1460 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001461 }
1462 }
1463
Bram Moolenaare38eab22019-12-05 21:50:01 +01001464 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001466
1467 if (fp->uf_flags & FC_SANDBOX)
1468 {
1469 using_sandbox = TRUE;
1470 ++sandbox;
1471 }
1472
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001473 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001474 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001475 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001477 ++no_wait_return;
1478 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001479
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001480 smsg(_("calling %s"), SOURCING_NAME);
1481 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001482 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001483 char_u buf[MSG_BUF_LEN];
1484 char_u numbuf2[NUMBUFLEN];
1485 char_u *tofree;
1486 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001488 msg_puts("(");
1489 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001490 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001491 if (i > 0)
1492 msg_puts(", ");
1493 if (argvars[i].v_type == VAR_NUMBER)
1494 msg_outnum((long)argvars[i].vval.v_number);
1495 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001497 // Do not want errors such as E724 here.
1498 ++emsg_off;
1499 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1500 --emsg_off;
1501 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001502 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001503 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001504 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001505 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1506 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001508 msg_puts((char *)s);
1509 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001510 }
1511 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001512 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001513 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001515 msg_puts("\n"); // don't overwrite this either
1516
1517 verbose_leave_scroll();
1518 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001519 }
1520#ifdef FEAT_PROFILE
1521 if (do_profiling == PROF_YES)
1522 {
1523 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001524 {
1525 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001527 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 if (fp->uf_profiling
1529 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1530 {
1531 ++fp->uf_tm_count;
1532 profile_start(&call_start);
1533 profile_zero(&fp->uf_tm_children);
1534 }
1535 script_prof_save(&wait_start);
1536 }
1537#endif
1538
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001539 save_current_sctx = current_sctx;
1540 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001541 save_did_emsg = did_emsg;
1542 did_emsg = FALSE;
1543
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001544 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1545 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001546 else if (islambda)
1547 {
1548 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1549
1550 // A Lambda always has the command "return {expr}". It is much faster
1551 // to evaluate {expr} directly.
1552 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001553 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001554 --ex_nesting_level;
1555 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001556 else
1557 // call do_cmdline() to execute the lines
1558 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001559 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1560
1561 --RedrawingDisabled;
1562
Bram Moolenaare38eab22019-12-05 21:50:01 +01001563 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1565 {
1566 clear_tv(rettv);
1567 rettv->v_type = VAR_NUMBER;
1568 rettv->vval.v_number = -1;
1569 }
1570
1571#ifdef FEAT_PROFILE
1572 if (do_profiling == PROF_YES && (fp->uf_profiling
1573 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1574 {
1575 profile_end(&call_start);
1576 profile_sub_wait(&wait_start, &call_start);
1577 profile_add(&fp->uf_tm_total, &call_start);
1578 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1579 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1580 {
1581 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1582 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1583 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001584 if (started_profiling)
1585 // make a ":profdel func" stop profiling the function
1586 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587 }
1588#endif
1589
Bram Moolenaare38eab22019-12-05 21:50:01 +01001590 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001591 if (p_verbose >= 12)
1592 {
1593 ++no_wait_return;
1594 verbose_enter_scroll();
1595
1596 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001597 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001599 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 (long)fc->rettv->vval.v_number);
1601 else
1602 {
1603 char_u buf[MSG_BUF_LEN];
1604 char_u numbuf2[NUMBUFLEN];
1605 char_u *tofree;
1606 char_u *s;
1607
Bram Moolenaare38eab22019-12-05 21:50:01 +01001608 // The value may be very long. Skip the middle part, so that we
1609 // have some idea how it starts and ends. smsg() would always
1610 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611 ++emsg_off;
1612 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1613 --emsg_off;
1614 if (s != NULL)
1615 {
1616 if (vim_strsize(s) > MSG_BUF_CLEN)
1617 {
1618 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1619 s = buf;
1620 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001621 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 vim_free(tofree);
1623 }
1624 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001625 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626
1627 verbose_leave_scroll();
1628 --no_wait_return;
1629 }
1630
Bram Moolenaare31ee862020-01-07 20:59:34 +01001631 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001632 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001633 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634#ifdef FEAT_PROFILE
1635 if (do_profiling == PROF_YES)
1636 script_prof_restore(&wait_start);
1637#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001638 if (using_sandbox)
1639 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001641 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642 {
1643 ++no_wait_return;
1644 verbose_enter_scroll();
1645
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001646 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001647 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648
1649 verbose_leave_scroll();
1650 --no_wait_return;
1651 }
1652
1653 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 --depth;
1655
Bram Moolenaar6914c642017-04-01 21:21:30 +02001656 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657}
1658
1659/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001660 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001661 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001662 int
1663call_user_func_check(
1664 ufunc_T *fp,
1665 int argcount,
1666 typval_T *argvars,
1667 typval_T *rettv,
1668 funcexe_T *funcexe,
1669 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001670{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001671 int error;
1672 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001673
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001674 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1675 *funcexe->doesrange = TRUE;
1676 if (argcount < regular_args - fp->uf_def_args.ga_len)
1677 error = FCERR_TOOFEW;
1678 else if (!has_varargs(fp) && argcount > regular_args)
1679 error = FCERR_TOOMANY;
1680 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1681 error = FCERR_DICT;
1682 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001683 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001684 int did_save_redo = FALSE;
1685 save_redo_T save_redo;
1686
1687 /*
1688 * Call the user function.
1689 * Save and restore search patterns, script variables and
1690 * redo buffer.
1691 */
1692 save_search_patterns();
1693 if (!ins_compl_active())
1694 {
1695 saveRedobuff(&save_redo);
1696 did_save_redo = TRUE;
1697 }
1698 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001699 call_user_func(fp, argcount, argvars, rettv, funcexe,
1700 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001701 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1702 // Function was unreferenced while being used, free it now.
1703 func_clear_free(fp, FALSE);
1704 if (did_save_redo)
1705 restoreRedobuff(&save_redo);
1706 restore_search_patterns();
1707 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001708 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001709 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001710}
1711
1712/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001713 * There are two kinds of function names:
1714 * 1. ordinary names, function defined with :function
1715 * 2. numbered functions and lambdas
1716 * For the first we only count the name stored in func_hashtab as a reference,
1717 * using function() does not count as a reference, because the function is
1718 * looked up by name.
1719 */
1720 static int
1721func_name_refcount(char_u *name)
1722{
1723 return isdigit(*name) || *name == '<';
1724}
1725
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001726static funccal_entry_T *funccal_stack = NULL;
1727
1728/*
1729 * Save the current function call pointer, and set it to NULL.
1730 * Used when executing autocommands and for ":source".
1731 */
1732 void
1733save_funccal(funccal_entry_T *entry)
1734{
1735 entry->top_funccal = current_funccal;
1736 entry->next = funccal_stack;
1737 funccal_stack = entry;
1738 current_funccal = NULL;
1739}
1740
1741 void
1742restore_funccal(void)
1743{
1744 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001745 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001746 else
1747 {
1748 current_funccal = funccal_stack->top_funccal;
1749 funccal_stack = funccal_stack->next;
1750 }
1751}
1752
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001753 funccall_T *
1754get_current_funccal(void)
1755{
1756 return current_funccal;
1757}
1758
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001759/*
1760 * Mark all functions of script "sid" as deleted.
1761 */
1762 void
1763delete_script_functions(int sid)
1764{
1765 hashitem_T *hi;
1766 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001767 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001768 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001769 size_t len;
1770
1771 buf[0] = K_SPECIAL;
1772 buf[1] = KS_EXTRA;
1773 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001774 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001775 len = STRLEN(buf);
1776
Bram Moolenaarce658352020-07-31 23:47:12 +02001777 while (todo > 0)
1778 {
1779 todo = func_hashtab.ht_used;
1780 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1781 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001782 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001783 fp = HI2UF(hi);
1784 if (STRNCMP(fp->uf_name, buf, len) == 0)
1785 {
1786 int changed = func_hashtab.ht_changed;
1787
1788 fp->uf_flags |= FC_DEAD;
1789 func_clear(fp, TRUE);
1790 // When clearing a function another function can be cleared
1791 // as a side effect. When that happens start over.
1792 if (changed != func_hashtab.ht_changed)
1793 break;
1794 }
1795 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001796 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001797 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001798}
1799
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800#if defined(EXITFREE) || defined(PROTO)
1801 void
1802free_all_functions(void)
1803{
1804 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001805 ufunc_T *fp;
1806 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001807 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001808 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001809
Bram Moolenaare38eab22019-12-05 21:50:01 +01001810 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001811 while (current_funccal != NULL)
1812 {
1813 clear_tv(current_funccal->rettv);
1814 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001815 if (current_funccal == NULL && funccal_stack != NULL)
1816 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001817 }
1818
Bram Moolenaare38eab22019-12-05 21:50:01 +01001819 // First clear what the functions contain. Since this may lower the
1820 // reference count of a function, it may also free a function and change
1821 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001822 while (todo > 0)
1823 {
1824 todo = func_hashtab.ht_used;
1825 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1826 if (!HASHITEM_EMPTY(hi))
1827 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001828 // clear the def function index now
1829 fp = HI2UF(hi);
1830 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001831 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001832
Bram Moolenaare38eab22019-12-05 21:50:01 +01001833 // Only free functions that are not refcounted, those are
1834 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001835 if (func_name_refcount(fp->uf_name))
1836 ++skipped;
1837 else
1838 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001839 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001840 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001841 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001842 {
1843 skipped = 0;
1844 break;
1845 }
1846 }
1847 --todo;
1848 }
1849 }
1850
Bram Moolenaare38eab22019-12-05 21:50:01 +01001851 // Now actually free the functions. Need to start all over every time,
1852 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001853 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001854 while (func_hashtab.ht_used > skipped)
1855 {
1856 todo = func_hashtab.ht_used;
1857 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 if (!HASHITEM_EMPTY(hi))
1859 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001860 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001861 // Only free functions that are not refcounted, those are
1862 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001863 fp = HI2UF(hi);
1864 if (func_name_refcount(fp->uf_name))
1865 ++skipped;
1866 else
1867 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001868 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001869 skipped = 0;
1870 break;
1871 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001872 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001873 }
1874 if (skipped == 0)
1875 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001876
1877 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001878}
1879#endif
1880
1881/*
1882 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001883 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884 * "len" is the length of "name", or -1 for NUL terminated.
1885 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001886 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887builtin_function(char_u *name, int len)
1888{
1889 char_u *p;
1890
Bram Moolenaara26b9702020-04-18 19:53:28 +02001891 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001892 return FALSE;
1893 p = vim_strchr(name, AUTOLOAD_CHAR);
1894 return p == NULL || (len > 0 && p > name + len);
1895}
1896
1897 int
1898func_call(
1899 char_u *name,
1900 typval_T *args,
1901 partial_T *partial,
1902 dict_T *selfdict,
1903 typval_T *rettv)
1904{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001905 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 listitem_T *item;
1907 typval_T argv[MAX_FUNC_ARGS + 1];
1908 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 int r = 0;
1910
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001911 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001912 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001913 {
1914 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1915 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001916 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 break;
1918 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001919 // Make a copy of each argument. This is needed to be able to set
1920 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001921 copy_tv(&item->li_tv, &argv[argc++]);
1922 }
1923
1924 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001925 {
1926 funcexe_T funcexe;
1927
Bram Moolenaara80faa82020-04-12 19:37:17 +02001928 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001929 funcexe.firstline = curwin->w_cursor.lnum;
1930 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001931 funcexe.evaluate = TRUE;
1932 funcexe.partial = partial;
1933 funcexe.selfdict = selfdict;
1934 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1935 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001936
Bram Moolenaare38eab22019-12-05 21:50:01 +01001937 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001938 while (argc > 0)
1939 clear_tv(&argv[--argc]);
1940
1941 return r;
1942}
1943
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001944static int callback_depth = 0;
1945
1946 int
1947get_callback_depth(void)
1948{
1949 return callback_depth;
1950}
1951
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001952/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001953 * Invoke call_func() with a callback.
1954 */
1955 int
1956call_callback(
1957 callback_T *callback,
1958 int len, // length of "name" or -1 to use strlen()
1959 typval_T *rettv, // return value goes here
1960 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001961 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001962 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001963{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001964 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001965 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001966
Bram Moolenaara80faa82020-04-12 19:37:17 +02001967 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001968 funcexe.evaluate = TRUE;
1969 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001970 ++callback_depth;
1971 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1972 --callback_depth;
1973 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001974}
1975
1976/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001977 * Give an error message for the result of a function.
1978 * Nothing if "error" is FCERR_NONE.
1979 */
1980 void
1981user_func_error(int error, char_u *name)
1982{
1983 switch (error)
1984 {
1985 case FCERR_UNKNOWN:
1986 emsg_funcname(e_unknownfunc, name);
1987 break;
1988 case FCERR_NOTMETHOD:
1989 emsg_funcname(
1990 N_("E276: Cannot use function as a method: %s"), name);
1991 break;
1992 case FCERR_DELETED:
1993 emsg_funcname(N_(e_func_deleted), name);
1994 break;
1995 case FCERR_TOOMANY:
1996 emsg_funcname((char *)e_toomanyarg, name);
1997 break;
1998 case FCERR_TOOFEW:
1999 emsg_funcname((char *)e_toofewarg, name);
2000 break;
2001 case FCERR_SCRIPT:
2002 emsg_funcname(
2003 N_("E120: Using <SID> not in a script context: %s"), name);
2004 break;
2005 case FCERR_DICT:
2006 emsg_funcname(
2007 N_("E725: Calling dict function without Dictionary: %s"),
2008 name);
2009 break;
2010 }
2011}
2012
2013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002015 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 * Return FAIL when the function can't be called, OK otherwise.
2017 * Also returns OK when an error was encountered while executing the function.
2018 */
2019 int
2020call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002021 char_u *funcname, // name of the function
2022 int len, // length of "name" or -1 to use strlen()
2023 typval_T *rettv, // return value goes here
2024 int argcount_in, // number of "argvars"
2025 typval_T *argvars_in, // vars for arguments, must have "argcount"
2026 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002027 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028{
2029 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002030 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002031 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002032 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 char_u fname_buf[FLEN_FIXED + 1];
2034 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002035 char_u *fname = NULL;
2036 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002037 int argcount = argcount_in;
2038 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002039 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002040 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2041 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002042 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002043 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002044 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002045
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002046 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2047 // even when call_func() returns FAIL.
2048 rettv->v_type = VAR_UNKNOWN;
2049
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002050 if (partial != NULL)
2051 fp = partial->pt_func;
2052 if (fp == NULL)
2053 {
2054 // Make a copy of the name, if it comes from a funcref variable it
2055 // could be changed or deleted in the called function.
2056 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2057 if (name == NULL)
2058 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002059
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002060 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2061 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002062
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002063 if (funcexe->doesrange != NULL)
2064 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002065
2066 if (partial != NULL)
2067 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002068 // When the function has a partial with a dict and there is a dict
2069 // argument, use the dict argument. That is backwards compatible.
2070 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002071 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002072 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002073 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002074 {
2075 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002076 {
2077 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2078 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002079 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002080 goto theend;
2081 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002082 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002083 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002084 for (i = 0; i < argcount_in; ++i)
2085 argv[i + argv_clear] = argvars_in[i];
2086 argvars = argv;
2087 argcount = partial->pt_argc + argcount_in;
2088 }
2089 }
2090
Bram Moolenaaref140542019-12-31 21:27:13 +01002091 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002092 {
2093 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002094 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002095
Bram Moolenaar333894b2020-08-01 18:53:07 +02002096 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002097 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002098 {
2099 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002100 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002101 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102
Bram Moolenaare38eab22019-12-05 21:50:01 +01002103 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002105 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002106
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002107 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002108 {
2109 /*
2110 * User defined function.
2111 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002112 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002113 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002114
Bram Moolenaare38eab22019-12-05 21:50:01 +01002115 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116 if (fp == NULL
2117 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002118 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002119 && !aborting())
2120 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002121 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002122 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002123 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002124 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2126 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002127 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002128 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002129 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002130 if (fp == NULL)
2131 {
2132 char_u *p = untrans_function_name(rfname);
2133
2134 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002135 // Don't do this if the name starts with "s:".
2136 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002137 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002138 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002139
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002140 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002141 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002142#ifdef FEAT_LUA
2143 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2144 {
2145 cfunc_T cb = fp->uf_cb;
2146
2147 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2148 }
2149#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002150 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002152 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002153 // postponed filling in the arguments, do it now
2154 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002155 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002156
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002157 if (funcexe->basetv != NULL)
2158 {
2159 // Method call: base->Method()
2160 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2161 argv[0] = *funcexe->basetv;
2162 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002163 argvars = argv;
2164 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002165 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002166
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002167 error = call_user_func_check(fp, argcount, argvars, rettv,
2168 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002169 }
2170 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002171 else if (funcexe->basetv != NULL)
2172 {
2173 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002174 * expr->method(): Find the method name in the table, call its
2175 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002176 */
2177 error = call_internal_method(fname, argcount, argvars, rettv,
2178 funcexe->basetv);
2179 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002180 else
2181 {
2182 /*
2183 * Find the function name in the table, call its implementation.
2184 */
2185 error = call_internal_func(fname, argcount, argvars, rettv);
2186 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002187
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002188 /*
2189 * The function call (or "FuncUndefined" autocommand sequence) might
2190 * have been aborted by an error, an interrupt, or an explicitly thrown
2191 * exception that has not been caught so far. This situation can be
2192 * tested for by calling aborting(). For an error in an internal
2193 * function or for the "E132" error in call_user_func(), however, the
2194 * throw point at which the "force_abort" flag (temporarily reset by
2195 * emsg()) is normally updated has not been reached yet. We need to
2196 * update that flag first to make aborting() reliable.
2197 */
2198 update_force_abort();
2199 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002200 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002201 ret = OK;
2202
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002203theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002204 /*
2205 * Report an error unless the argument evaluation or function call has been
2206 * cancelled due to an aborting error, an interrupt, or an exception.
2207 */
2208 if (!aborting())
2209 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002210 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211 }
2212
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002213 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002215 clear_tv(&argv[--argv_clear + argv_base]);
2216
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217 vim_free(tofree);
2218 vim_free(name);
2219
2220 return ret;
2221}
2222
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002223 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002224printable_func_name(ufunc_T *fp)
2225{
2226 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2227}
2228
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002230 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 */
2232 static void
2233list_func_head(ufunc_T *fp, int indent)
2234{
2235 int j;
2236
2237 msg_start();
2238 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002239 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002240 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002241 msg_puts("def ");
2242 else
2243 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002244 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002245 msg_putchar('(');
2246 for (j = 0; j < fp->uf_args.ga_len; ++j)
2247 {
2248 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002249 msg_puts(", ");
2250 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002251 if (fp->uf_arg_types != NULL)
2252 {
2253 char *tofree;
2254
2255 msg_puts(": ");
2256 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2257 vim_free(tofree);
2258 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002259 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2260 {
2261 msg_puts(" = ");
2262 msg_puts(((char **)(fp->uf_def_args.ga_data))
2263 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2264 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002265 }
2266 if (fp->uf_varargs)
2267 {
2268 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002269 msg_puts(", ");
2270 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002271 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002272 if (fp->uf_va_name != NULL)
2273 {
2274 if (j)
2275 msg_puts(", ");
2276 msg_puts("...");
2277 msg_puts((char *)fp->uf_va_name);
2278 if (fp->uf_va_type)
2279 {
2280 char *tofree;
2281
2282 msg_puts(": ");
2283 msg_puts(type_name(fp->uf_va_type, &tofree));
2284 vim_free(tofree);
2285 }
2286 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002287 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002288
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002289 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002290 {
2291 if (fp->uf_ret_type != &t_void)
2292 {
2293 char *tofree;
2294
2295 msg_puts(": ");
2296 msg_puts(type_name(fp->uf_ret_type, &tofree));
2297 vim_free(tofree);
2298 }
2299 }
2300 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002301 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002302 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002303 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002304 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002305 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002306 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002307 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002308 msg_clr_eos();
2309 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002310 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002311}
2312
2313/*
2314 * Get a function name, translating "<SID>" and "<SNR>".
2315 * Also handles a Funcref in a List or Dictionary.
2316 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002317 * Set "*is_global" to TRUE when the function must be global, unless
2318 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002319 * flags:
2320 * TFN_INT: internal function name OK
2321 * TFN_QUIET: be quiet
2322 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002323 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002324 * Advances "pp" to just after the function name (if no error).
2325 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002326 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327trans_function_name(
2328 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002329 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002330 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002332 funcdict_T *fdp, // return: info about dictionary used
2333 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002334{
2335 char_u *name = NULL;
2336 char_u *start;
2337 char_u *end;
2338 int lead;
2339 char_u sid_buf[20];
2340 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002341 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002342 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002343 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344
2345 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002346 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 start = *pp;
2348
Bram Moolenaare38eab22019-12-05 21:50:01 +01002349 // Check for hard coded <SNR>: already translated function ID (from a user
2350 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2352 && (*pp)[2] == (int)KE_SNR)
2353 {
2354 *pp += 3;
2355 len = get_id_len(pp) + 3;
2356 return vim_strnsave(start, len);
2357 }
2358
Bram Moolenaare38eab22019-12-05 21:50:01 +01002359 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2360 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 lead = eval_fname_script(start);
2362 if (lead > 2)
2363 start += lead;
2364
Bram Moolenaare38eab22019-12-05 21:50:01 +01002365 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002366 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 lead > 2 ? 0 : FNE_CHECK_START);
2368 if (end == start)
2369 {
2370 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002371 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002372 goto theend;
2373 }
2374 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2375 {
2376 /*
2377 * Report an invalid expression in braces, unless the expression
2378 * evaluation has been cancelled due to an aborting error, an
2379 * interrupt, or an exception.
2380 */
2381 if (!aborting())
2382 {
2383 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002384 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 }
2386 else
2387 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2388 goto theend;
2389 }
2390
2391 if (lv.ll_tv != NULL)
2392 {
2393 if (fdp != NULL)
2394 {
2395 fdp->fd_dict = lv.ll_dict;
2396 fdp->fd_newkey = lv.ll_newkey;
2397 lv.ll_newkey = NULL;
2398 fdp->fd_di = lv.ll_di;
2399 }
2400 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2401 {
2402 name = vim_strsave(lv.ll_tv->vval.v_string);
2403 *pp = end;
2404 }
2405 else if (lv.ll_tv->v_type == VAR_PARTIAL
2406 && lv.ll_tv->vval.v_partial != NULL)
2407 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002408 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409 *pp = end;
2410 if (partial != NULL)
2411 *partial = lv.ll_tv->vval.v_partial;
2412 }
2413 else
2414 {
2415 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2416 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002417 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 else
2419 *pp = end;
2420 name = NULL;
2421 }
2422 goto theend;
2423 }
2424
2425 if (lv.ll_name == NULL)
2426 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002427 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002428 *pp = end;
2429 goto theend;
2430 }
2431
Bram Moolenaare38eab22019-12-05 21:50:01 +01002432 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 if (lv.ll_exp_name != NULL)
2434 {
2435 len = (int)STRLEN(lv.ll_exp_name);
2436 name = deref_func_name(lv.ll_exp_name, &len, partial,
2437 flags & TFN_NO_AUTOLOAD);
2438 if (name == lv.ll_exp_name)
2439 name = NULL;
2440 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002441 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 {
2443 len = (int)(end - *pp);
2444 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2445 if (name == *pp)
2446 name = NULL;
2447 }
2448 if (name != NULL)
2449 {
2450 name = vim_strsave(name);
2451 *pp = end;
2452 if (STRNCMP(name, "<SNR>", 5) == 0)
2453 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002454 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455 name[0] = K_SPECIAL;
2456 name[1] = KS_EXTRA;
2457 name[2] = (int)KE_SNR;
2458 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2459 }
2460 goto theend;
2461 }
2462
2463 if (lv.ll_exp_name != NULL)
2464 {
2465 len = (int)STRLEN(lv.ll_exp_name);
2466 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2467 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2468 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002469 // When there was "s:" already or the name expanded to get a
2470 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 lv.ll_name += 2;
2472 len -= 2;
2473 lead = 2;
2474 }
2475 }
2476 else
2477 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002478 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002480 {
2481 if (is_global != NULL && lv.ll_name[0] == 'g')
2482 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002484 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002485 len = (int)(end - lv.ll_name);
2486 }
2487
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002488 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002489 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002490
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002491 /*
2492 * Copy the function name to allocated memory.
2493 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2494 * Accept <SNR>123_name() outside a script.
2495 */
2496 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002497 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002498 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002500 if (!vim9script)
2501 lead = 3;
2502 if (vim9script || (lv.ll_exp_name != NULL
2503 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 || eval_fname_sid(*pp))
2505 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002506 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002507 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002508 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002509 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 goto theend;
2511 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002512 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002513 if (vim9script)
2514 extra = 3 + (int)STRLEN(sid_buf);
2515 else
2516 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002517 }
2518 }
2519 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2520 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002521 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 start);
2523 goto theend;
2524 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002525 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 {
2527 char_u *cp = vim_strchr(lv.ll_name, ':');
2528
2529 if (cp != NULL && cp < end)
2530 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002531 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532 goto theend;
2533 }
2534 }
2535
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002536 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537 if (name != NULL)
2538 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002539 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540 {
2541 name[0] = K_SPECIAL;
2542 name[1] = KS_EXTRA;
2543 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002544 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002545 STRCPY(name + 3, sid_buf);
2546 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002547 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2548 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 }
2550 *pp = end;
2551
2552theend:
2553 clear_lval(&lv);
2554 return name;
2555}
2556
2557/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002558 * Assuming "name" is the result of trans_function_name() and it was prefixed
2559 * to use the script-local name, return the unmodified name (points into
2560 * "name"). Otherwise return NULL.
2561 * This can be used to first search for a script-local function and fall back
2562 * to the global function if not found.
2563 */
2564 char_u *
2565untrans_function_name(char_u *name)
2566{
2567 char_u *p;
2568
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002569 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002570 {
2571 p = vim_strchr(name, '_');
2572 if (p != NULL)
2573 return p + 1;
2574 }
2575 return NULL;
2576}
2577
2578/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002579 * List functions. When "regmatch" is NULL all of then.
2580 * Otherwise functions matching "regmatch".
2581 */
2582 static void
2583list_functions(regmatch_T *regmatch)
2584{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002585 int changed = func_hashtab.ht_changed;
2586 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002587 hashitem_T *hi;
2588
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002589 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002590 {
2591 if (!HASHITEM_EMPTY(hi))
2592 {
2593 ufunc_T *fp = HI2UF(hi);
2594
2595 --todo;
2596 if ((fp->uf_flags & FC_DEAD) == 0
2597 && (regmatch == NULL
2598 ? !message_filtered(fp->uf_name)
2599 && !func_name_refcount(fp->uf_name)
2600 : !isdigit(*fp->uf_name)
2601 && vim_regexec(regmatch, fp->uf_name, 0)))
2602 {
2603 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002604 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002605 {
2606 emsg(_("E454: function list was modified"));
2607 return;
2608 }
2609 }
2610 }
2611 }
2612}
2613
2614/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002615 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002616 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2617 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002618 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002620 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002621def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622{
2623 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002624 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002625 int j;
2626 int c;
2627 int saved_did_emsg;
2628 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002629 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002630 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631 char_u *p;
2632 char_u *arg;
2633 char_u *line_arg = NULL;
2634 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002635 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002636 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 garray_T newlines;
2638 int varargs = FALSE;
2639 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002640 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002641 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002642 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 int indent;
2644 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002645#define MAX_FUNC_NESTING 50
2646 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 dictitem_T *v;
2648 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002649 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002652 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002653 linenr_T sourcing_lnum_off;
2654 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002655 int is_heredoc = FALSE;
2656 char_u *skip_until = NULL;
2657 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002658 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002659 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660
2661 /*
2662 * ":function" without argument: list functions.
2663 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002664 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 {
2666 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002667 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002669 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670 }
2671
2672 /*
2673 * ":function /pat": list functions matching pattern.
2674 */
2675 if (*eap->arg == '/')
2676 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002677 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678 if (!eap->skip)
2679 {
2680 regmatch_T regmatch;
2681
2682 c = *p;
2683 *p = NUL;
2684 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2685 *p = c;
2686 if (regmatch.regprog != NULL)
2687 {
2688 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002689 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690 vim_regfree(regmatch.regprog);
2691 }
2692 }
2693 if (*p == '/')
2694 ++p;
2695 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002696 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002697 }
2698
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002699 ga_init(&newargs);
2700 ga_init(&argtypes);
2701 ga_init(&default_args);
2702
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703 /*
2704 * Get the function name. There are these situations:
2705 * func normal function name
2706 * "name" == func, "fudi.fd_dict" == NULL
2707 * dict.func new dictionary entry
2708 * "name" == NULL, "fudi.fd_dict" set,
2709 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2710 * dict.func existing dict entry with a Funcref
2711 * "name" == func, "fudi.fd_dict" set,
2712 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2713 * dict.func existing dict entry that's not a Funcref
2714 * "name" == NULL, "fudi.fd_dict" set,
2715 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2716 * s:func script-local function name
2717 * g:func global function name, same as "func"
2718 */
2719 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002720 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002722 // nested function, argument is (args).
2723 paren = TRUE;
2724 CLEAR_FIELD(fudi);
2725 }
2726 else
2727 {
2728 name = trans_function_name(&p, &is_global, eap->skip,
2729 TFN_NO_AUTOLOAD, &fudi, NULL);
2730 paren = (vim_strchr(p, '(') != NULL);
2731 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002733 /*
2734 * Return on an invalid expression in braces, unless the expression
2735 * evaluation has been cancelled due to an aborting error, an
2736 * interrupt, or an exception.
2737 */
2738 if (!aborting())
2739 {
2740 if (!eap->skip && fudi.fd_newkey != NULL)
2741 semsg(_(e_dictkey), fudi.fd_newkey);
2742 vim_free(fudi.fd_newkey);
2743 return NULL;
2744 }
2745 else
2746 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002747 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 }
2749
Bram Moolenaare38eab22019-12-05 21:50:01 +01002750 // An error in a function call during evaluation of an expression in magic
2751 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002752 saved_did_emsg = did_emsg;
2753 did_emsg = FALSE;
2754
2755 /*
2756 * ":function func" with only function name: list function.
2757 */
2758 if (!paren)
2759 {
2760 if (!ends_excmd(*skipwhite(p)))
2761 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002762 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 goto ret_free;
2764 }
2765 eap->nextcmd = check_nextcmd(p);
2766 if (eap->nextcmd != NULL)
2767 *p = NUL;
2768 if (!eap->skip && !got_int)
2769 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002770 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002771 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2772 {
2773 char_u *up = untrans_function_name(name);
2774
2775 // With Vim9 script the name was made script-local, if not
2776 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002777 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002778 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002779 }
2780
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 if (fp != NULL)
2782 {
2783 list_func_head(fp, TRUE);
2784 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2785 {
2786 if (FUNCLINE(fp, j) == NULL)
2787 continue;
2788 msg_putchar('\n');
2789 msg_outnum((long)(j + 1));
2790 if (j < 9)
2791 msg_putchar(' ');
2792 if (j < 99)
2793 msg_putchar(' ');
2794 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002795 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 ui_breakcheck();
2797 }
2798 if (!got_int)
2799 {
2800 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002801 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002802 msg_puts(" enddef");
2803 else
2804 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 }
2806 }
2807 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002808 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 }
2810 goto ret_free;
2811 }
2812
2813 /*
2814 * ":function name(arg1, arg2)" Define function.
2815 */
2816 p = skipwhite(p);
2817 if (*p != '(')
2818 {
2819 if (!eap->skip)
2820 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002821 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 goto ret_free;
2823 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002824 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 if (vim_strchr(p, '(') != NULL)
2826 p = vim_strchr(p, '(');
2827 }
2828 p = skipwhite(p + 1);
2829
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002830 // In Vim9 script only global functions can be redefined.
2831 if (vim9script && eap->forceit && !is_global)
2832 {
2833 emsg(_(e_nobang));
2834 goto ret_free;
2835 }
2836
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2838
Bram Moolenaar04b12692020-05-04 23:24:44 +02002839 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002841 // Check the name of the function. Unless it's a dictionary function
2842 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 if (name != NULL)
2844 arg = name;
2845 else
2846 arg = fudi.fd_newkey;
2847 if (arg != NULL && (fudi.fd_di == NULL
2848 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2849 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2850 {
2851 if (*arg == K_SPECIAL)
2852 j = 3;
2853 else
2854 j = 0;
2855 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2856 : eval_isnamec(arg[j])))
2857 ++j;
2858 if (arg[j] != NUL)
2859 emsg_funcname((char *)e_invarg2, arg);
2860 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002861 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002863 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 }
2865
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002866 // This may get more lines and make the pointers into the first line
2867 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002868 if (get_function_args(&p, ')', &newargs,
2869 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002870 &varargs, &default_args, eap->skip,
2871 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872 goto errret_2;
2873
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002874 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002876 // find the return type: :def Func(): type
2877 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002879 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002880 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002882 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002883 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002884 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002885 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002886 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002887 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002888 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002889 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002890 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002892 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002894 else
2895 // find extra arguments "range", "dict", "abort" and "closure"
2896 for (;;)
2897 {
2898 p = skipwhite(p);
2899 if (STRNCMP(p, "range", 5) == 0)
2900 {
2901 flags |= FC_RANGE;
2902 p += 5;
2903 }
2904 else if (STRNCMP(p, "dict", 4) == 0)
2905 {
2906 flags |= FC_DICT;
2907 p += 4;
2908 }
2909 else if (STRNCMP(p, "abort", 5) == 0)
2910 {
2911 flags |= FC_ABORT;
2912 p += 5;
2913 }
2914 else if (STRNCMP(p, "closure", 7) == 0)
2915 {
2916 flags |= FC_CLOSURE;
2917 p += 7;
2918 if (current_funccal == NULL)
2919 {
2920 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2921 name == NULL ? (char_u *)"" : name);
2922 goto erret;
2923 }
2924 }
2925 else
2926 break;
2927 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928
Bram Moolenaare38eab22019-12-05 21:50:01 +01002929 // When there is a line break use what follows for the function body.
2930 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002931 if (*p == '\n')
2932 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002933 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002934 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2935 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002936 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2937 && !eap->skip
2938 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002939 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940
2941 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002942 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2943 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002944 */
2945 if (KeyTyped)
2946 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002947 // Check if the function already exists, don't let the user type the
2948 // whole function before telling him it doesn't work! For a script we
2949 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950 if (!eap->skip && !eap->forceit)
2951 {
2952 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002953 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002954 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955 emsg_funcname(e_funcexts, name);
2956 }
2957
2958 if (!eap->skip && did_emsg)
2959 goto erret;
2960
Bram Moolenaare38eab22019-12-05 21:50:01 +01002961 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002962 cmdline_row = msg_row;
2963 }
2964
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002965 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002966 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002967
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002968 // Detect having skipped over comment lines to find the return
2969 // type. Add NULL lines to keep the line count correct.
2970 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2971 if (SOURCING_LNUM < sourcing_lnum_off)
2972 {
2973 sourcing_lnum_off -= SOURCING_LNUM;
2974 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
2975 goto erret;
2976 while (sourcing_lnum_off-- > 0)
2977 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2978 }
2979
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980 indent = 2;
2981 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002982 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 for (;;)
2984 {
2985 if (KeyTyped)
2986 {
2987 msg_scroll = TRUE;
2988 saved_wait_return = FALSE;
2989 }
2990 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991
2992 if (line_arg != NULL)
2993 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002994 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 theline = line_arg;
2996 p = vim_strchr(theline, '\n');
2997 if (p == NULL)
2998 line_arg += STRLEN(line_arg);
2999 else
3000 {
3001 *p = NUL;
3002 line_arg = p + 1;
3003 }
3004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003006 {
3007 vim_free(line_to_free);
3008 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02003009 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003010 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02003011 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003012 line_to_free = theline;
3013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014 if (KeyTyped)
3015 lines_left = Rows - 1;
3016 if (theline == NULL)
3017 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018 if (eap->cmdidx == CMD_def)
3019 emsg(_("E1057: Missing :enddef"));
3020 else
3021 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 goto erret;
3023 }
3024
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003025 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003026 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003027 if (SOURCING_LNUM < sourcing_lnum_off)
3028 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 else
3030 sourcing_lnum_off = 0;
3031
3032 if (skip_until != NULL)
3033 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003034 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003035 // * ":append" and "."
3036 // * ":python <<EOF" and "EOF"
3037 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3038 if (heredoc_trimmed == NULL
3039 || (is_heredoc && skipwhite(theline) == theline)
3040 || STRNCMP(theline, heredoc_trimmed,
3041 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003042 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003043 if (heredoc_trimmed == NULL)
3044 p = theline;
3045 else if (is_heredoc)
3046 p = skipwhite(theline) == theline
3047 ? theline : theline + STRLEN(heredoc_trimmed);
3048 else
3049 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003050 if (STRCMP(p, skip_until) == 0)
3051 {
3052 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003053 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02003054 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003055 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003056 }
3057 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003058 }
3059 else
3060 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003061 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003062 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003063 ;
3064
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003065 // Check for "endfunction" or "enddef".
3066 if (checkforcmd(&p, nesting_def[nesting]
3067 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003069 char_u *nextcmd = NULL;
3070
Bram Moolenaar663bb232017-06-22 19:12:10 +02003071 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003072 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003073 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003074 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003075 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003076 give_warning2(eap->cmdidx == CMD_def
3077 ? (char_u *)_("W1001: Text found after :enddef: %s")
3078 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003079 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003080 if (nextcmd != NULL)
3081 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003082 // Another command follows. If the line came from "eap" we
3083 // can simply point into it, otherwise we need to change
3084 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003085 eap->nextcmd = nextcmd;
3086 if (line_to_free != NULL)
3087 {
3088 vim_free(*eap->cmdlinep);
3089 *eap->cmdlinep = line_to_free;
3090 line_to_free = NULL;
3091 }
3092 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003093 break;
3094 }
3095
Bram Moolenaare38eab22019-12-05 21:50:01 +01003096 // Increase indent inside "if", "while", "for" and "try", decrease
3097 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003098 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 indent -= 2;
3100 else if (STRNCMP(p, "if", 2) == 0
3101 || STRNCMP(p, "wh", 2) == 0
3102 || STRNCMP(p, "for", 3) == 0
3103 || STRNCMP(p, "try", 3) == 0)
3104 indent += 2;
3105
Bram Moolenaare38eab22019-12-05 21:50:01 +01003106 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003107 // Only recognize "def" inside "def", not inside "function",
3108 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003109 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003110 if (checkforcmd(&p, "function", 2)
3111 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 {
3113 if (*p == '!')
3114 p = skipwhite(p + 1);
3115 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003116 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117 if (*skipwhite(p) == '(')
3118 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003119 if (nesting == MAX_FUNC_NESTING - 1)
3120 emsg(_("E1058: function nesting too deep"));
3121 else
3122 {
3123 ++nesting;
3124 nesting_def[nesting] = (c == 'd');
3125 indent += 2;
3126 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 }
3128 }
3129
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003130 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003132 if (eap->cmdidx != CMD_def
3133 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003134 || (p[0] == 'c'
3135 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3136 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3137 && (STRNCMP(&p[3], "nge", 3) != 0
3138 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 || (p[0] == 'i'
3140 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003141 && (!ASCII_ISALPHA(p[2])
3142 || (p[2] == 's'
3143 && (!ASCII_ISALPHA(p[3])
3144 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 skip_until = vim_strsave((char_u *)".");
3146
Bram Moolenaare38eab22019-12-05 21:50:01 +01003147 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 arg = skipwhite(skiptowhite(p));
3149 if (arg[0] == '<' && arg[1] =='<'
3150 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003151 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3152 || ((p[2] == '3' || p[2] == 'x')
3153 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154 || (p[0] == 'p' && p[1] == 'e'
3155 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3156 || (p[0] == 't' && p[1] == 'c'
3157 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3158 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3159 && !ASCII_ISALPHA(p[3]))
3160 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3161 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3162 || (p[0] == 'm' && p[1] == 'z'
3163 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3164 ))
3165 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003166 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003168 if (STRNCMP(p, "trim", 4) == 0)
3169 {
3170 // Ignore leading white space.
3171 p = skipwhite(p + 4);
3172 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003173 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003174 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 if (*p == NUL)
3176 skip_until = vim_strsave((char_u *)".");
3177 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003178 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003179 do_concat = FALSE;
3180 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003181 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003182
3183 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003184 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003185 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003186 if (*arg == '[')
3187 arg = vim_strchr(arg, ']');
3188 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003189 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003190 arg = skipwhite(skiptowhite(arg));
3191 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3192 && ((p[0] == 'l'
3193 && p[1] == 'e'
3194 && (!ASCII_ISALNUM(p[2])
3195 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003196 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003197 p = skipwhite(arg + 3);
3198 if (STRNCMP(p, "trim", 4) == 0)
3199 {
3200 // Ignore leading white space.
3201 p = skipwhite(p + 4);
3202 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003203 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003204 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003205 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003206 do_concat = FALSE;
3207 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003208 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003209 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 }
3211
Bram Moolenaare38eab22019-12-05 21:50:01 +01003212 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215
Bram Moolenaare38eab22019-12-05 21:50:01 +01003216 // Copy the line to newly allocated memory. get_one_sourceline()
3217 // allocates 250 bytes per line, this saves 80% on average. The cost
3218 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003220 if (p == NULL)
3221 goto erret;
3222 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223
Bram Moolenaare38eab22019-12-05 21:50:01 +01003224 // Add NULL lines for continuation lines, so that the line count is
3225 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 while (sourcing_lnum_off-- > 0)
3227 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3228
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 if (line_arg != NULL && *line_arg == NUL)
3231 line_arg = NULL;
3232 }
3233
Bram Moolenaare38eab22019-12-05 21:50:01 +01003234 // Don't define the function when skipping commands or when an error was
3235 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 if (eap->skip || did_emsg)
3237 goto erret;
3238
3239 /*
3240 * If there are no errors, add the function
3241 */
3242 if (fudi.fd_dict == NULL)
3243 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003244 hashtab_T *ht;
3245
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003246 v = find_var(name, &ht, FALSE);
3247 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3248 {
3249 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3250 name);
3251 goto erret;
3252 }
3253
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003254 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003255 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003257 char_u *uname = untrans_function_name(name);
3258
3259 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3260 }
3261
3262 if (fp != NULL || import != NULL)
3263 {
3264 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003265
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003266 // Function can be replaced with "function!" and when sourcing the
3267 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003268 // A name that is used by an import can not be overruled.
3269 if (import != NULL
3270 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003271 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003272 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003274 if (vim9script)
3275 emsg_funcname(e_already_defined, name);
3276 else
3277 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 goto erret;
3279 }
3280 if (fp->uf_calls > 0)
3281 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003282 emsg_funcname(
3283 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 name);
3285 goto erret;
3286 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003287 if (fp->uf_refcount > 1)
3288 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003289 // This function is referenced somewhere, don't redefine it but
3290 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003291 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003292 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003293 fp = NULL;
3294 overwrite = TRUE;
3295 }
3296 else
3297 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003298 char_u *exp_name = fp->uf_name_exp;
3299
3300 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003301 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003302 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003303 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003304 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003305 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003306#ifdef FEAT_PROFILE
3307 fp->uf_profiling = FALSE;
3308 fp->uf_prof_initialized = FALSE;
3309#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003310 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003311 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003312 }
3313 }
3314 else
3315 {
3316 char numbuf[20];
3317
3318 fp = NULL;
3319 if (fudi.fd_newkey == NULL && !eap->forceit)
3320 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003321 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003322 goto erret;
3323 }
3324 if (fudi.fd_di == NULL)
3325 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003326 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003327 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328 goto erret;
3329 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003330 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003331 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 goto erret;
3333
Bram Moolenaare38eab22019-12-05 21:50:01 +01003334 // Give the function a sequential number. Can only be used with a
3335 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 vim_free(name);
3337 sprintf(numbuf, "%d", ++func_nr);
3338 name = vim_strsave((char_u *)numbuf);
3339 if (name == NULL)
3340 goto erret;
3341 }
3342
3343 if (fp == NULL)
3344 {
3345 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3346 {
3347 int slen, plen;
3348 char_u *scriptname;
3349
Bram Moolenaare38eab22019-12-05 21:50:01 +01003350 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003352 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 {
3354 scriptname = autoload_name(name);
3355 if (scriptname != NULL)
3356 {
3357 p = vim_strchr(scriptname, '/');
3358 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003359 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003361 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 j = OK;
3363 vim_free(scriptname);
3364 }
3365 }
3366 if (j == FAIL)
3367 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003368 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 goto erret;
3370 }
3371 }
3372
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003373 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003374 if (fp == NULL)
3375 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003376 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003377 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378
3379 if (fudi.fd_dict != NULL)
3380 {
3381 if (fudi.fd_di == NULL)
3382 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003383 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3385 if (fudi.fd_di == NULL)
3386 {
3387 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003388 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 goto erret;
3390 }
3391 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3392 {
3393 vim_free(fudi.fd_di);
3394 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003395 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 goto erret;
3397 }
3398 }
3399 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003400 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 clear_tv(&fudi.fd_di->di_tv);
3402 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404
Bram Moolenaare38eab22019-12-05 21:50:01 +01003405 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406 flags |= FC_DICT;
3407 }
3408
Bram Moolenaare38eab22019-12-05 21:50:01 +01003409 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003410 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003411 if (overwrite)
3412 {
3413 hi = hash_find(&func_hashtab, name);
3414 hi->hi_key = UF2HIKEY(fp);
3415 }
3416 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 {
3418 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003419 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 goto erret;
3421 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003422 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003423 }
3424 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003425 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003426 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003427 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003428
3429 if (eap->cmdidx == CMD_def)
3430 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003431 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003432
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003433 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003434
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003435 // error messages are for the first function line
3436 SOURCING_LNUM = sourcing_lnum_top;
3437
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003438 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003439 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003440
3441 if (argtypes.ga_len > 0)
3442 {
3443 // When "varargs" is set the last name/type goes into uf_va_name
3444 // and uf_va_type.
3445 int len = argtypes.ga_len - (varargs ? 1 : 0);
3446
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003447 if (len > 0)
3448 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003449 if (fp->uf_arg_types != NULL)
3450 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003451 int i;
3452 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003453
3454 for (i = 0; i < len; ++ i)
3455 {
3456 p = ((char_u **)argtypes.ga_data)[i];
3457 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003458 // will get the type from the default value
3459 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003460 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003461 type = parse_type(&p, &fp->uf_type_list);
3462 if (type == NULL)
3463 {
3464 SOURCING_LNUM = lnum_save;
3465 goto errret_2;
3466 }
3467 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003468 }
3469 }
3470 if (varargs)
3471 {
3472 // Move the last argument "...name: type" to uf_va_name and
3473 // uf_va_type.
3474 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3475 [fp->uf_args.ga_len - 1];
3476 --fp->uf_args.ga_len;
3477 p = ((char_u **)argtypes.ga_data)[len];
3478 if (p == NULL)
3479 // todo: get type from default value
3480 fp->uf_va_type = &t_any;
3481 else
3482 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003483 if (fp->uf_va_type == NULL)
3484 {
3485 SOURCING_LNUM = lnum_save;
3486 goto errret_2;
3487 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003488 }
3489 varargs = FALSE;
3490 }
3491
3492 // parse the return type, if any
3493 if (ret_type == NULL)
3494 fp->uf_ret_type = &t_void;
3495 else
3496 {
3497 p = ret_type;
3498 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3499 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003500 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003501 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003502 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003503 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003504
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003506 if ((flags & FC_CLOSURE) != 0)
3507 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003508 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003509 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003510 }
3511 else
3512 fp->uf_scoped = NULL;
3513
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 if (prof_def_func())
3516 func_do_profile(fp);
3517#endif
3518 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003519 if (sandbox)
3520 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003521 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003522 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003523 fp->uf_flags = flags;
3524 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003525 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003526 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003527 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003528 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003529 if (is_export)
3530 {
3531 fp->uf_flags |= FC_EXPORT;
3532 // let ex_export() know the export worked.
3533 is_export = FALSE;
3534 }
3535
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003536 if (eap->cmdidx == CMD_def)
3537 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003538 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3539 // :func does not use Vim9 script syntax, even in a Vim9 script file
3540 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003541
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 goto ret_free;
3543
3544erret:
3545 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003546 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547errret_2:
3548 ga_clear_strings(&newlines);
3549ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003550 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003552 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003554 if (name != name_arg)
3555 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003556 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 did_emsg |= saved_did_emsg;
3558 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003559
3560 return fp;
3561}
3562
3563/*
3564 * ":function"
3565 */
3566 void
3567ex_function(exarg_T *eap)
3568{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003569 (void)def_function(eap, NULL);
3570}
3571
3572/*
3573 * :defcompile - compile all :def functions in the current script.
3574 */
3575 void
3576ex_defcompile(exarg_T *eap UNUSED)
3577{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003578 long todo = (long)func_hashtab.ht_used;
3579 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003580 hashitem_T *hi;
3581 ufunc_T *ufunc;
3582
3583 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3584 {
3585 if (!HASHITEM_EMPTY(hi))
3586 {
3587 --todo;
3588 ufunc = HI2UF(hi);
3589 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003590 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003591 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003592 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003593
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003594 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003595 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003596 // a function has been added or removed, need to start over
3597 todo = (long)func_hashtab.ht_used;
3598 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003599 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003600 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003601 }
3602 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003603 }
3604 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605}
3606
3607/*
3608 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3609 * Return 2 if "p" starts with "s:".
3610 * Return 0 otherwise.
3611 */
3612 int
3613eval_fname_script(char_u *p)
3614{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003615 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3616 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3618 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3619 return 5;
3620 if (p[0] == 's' && p[1] == ':')
3621 return 2;
3622 return 0;
3623}
3624
3625 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003626translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627{
3628 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003629 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003630 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003631}
3632
3633/*
3634 * Return TRUE when "ufunc" has old-style "..." varargs
3635 * or named varargs "...name: type".
3636 */
3637 int
3638has_varargs(ufunc_T *ufunc)
3639{
3640 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641}
3642
3643/*
3644 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003645 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 */
3647 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003648function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649{
3650 char_u *nm = name;
3651 char_u *p;
3652 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003653 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003654 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003656 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3657 if (no_deref)
3658 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003659 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660 nm = skipwhite(nm);
3661
Bram Moolenaare38eab22019-12-05 21:50:01 +01003662 // Only accept "funcname", "funcname ", "funcname (..." and
3663 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003665 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666 vim_free(p);
3667 return n;
3668}
3669
Bram Moolenaar113e1072019-01-20 15:30:40 +01003670#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 char_u *
3672get_expanded_name(char_u *name, int check)
3673{
3674 char_u *nm = name;
3675 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003676 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003678 p = trans_function_name(&nm, &is_global, FALSE,
3679 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003681 if (p != NULL && *nm == NUL
3682 && (!check || translated_function_exists(p, is_global)))
3683 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684
3685 vim_free(p);
3686 return NULL;
3687}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003688#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003690/*
3691 * Function given to ExpandGeneric() to obtain the list of user defined
3692 * function names.
3693 */
3694 char_u *
3695get_user_func_name(expand_T *xp, int idx)
3696{
3697 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003698 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 static hashitem_T *hi;
3700 ufunc_T *fp;
3701
3702 if (idx == 0)
3703 {
3704 done = 0;
3705 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003706 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003708 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 {
3710 if (done++ > 0)
3711 ++hi;
3712 while (HASHITEM_EMPTY(hi))
3713 ++hi;
3714 fp = HI2UF(hi);
3715
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003716 // don't show dead, dict and lambda functions
3717 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003718 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003719 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720
3721 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003722 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723
3724 cat_func_name(IObuff, fp);
3725 if (xp->xp_context != EXPAND_USER_FUNC)
3726 {
3727 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003728 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 STRCAT(IObuff, ")");
3730 }
3731 return IObuff;
3732 }
3733 return NULL;
3734}
3735
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003736/*
3737 * ":delfunction {name}"
3738 */
3739 void
3740ex_delfunction(exarg_T *eap)
3741{
3742 ufunc_T *fp = NULL;
3743 char_u *p;
3744 char_u *name;
3745 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003746 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747
3748 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003749 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 vim_free(fudi.fd_newkey);
3751 if (name == NULL)
3752 {
3753 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003754 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 return;
3756 }
3757 if (!ends_excmd(*skipwhite(p)))
3758 {
3759 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003760 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 return;
3762 }
3763 eap->nextcmd = check_nextcmd(p);
3764 if (eap->nextcmd != NULL)
3765 *p = NUL;
3766
3767 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003768 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 vim_free(name);
3770
3771 if (!eap->skip)
3772 {
3773 if (fp == NULL)
3774 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003775 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003776 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 return;
3778 }
3779 if (fp->uf_calls > 0)
3780 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003781 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 return;
3783 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003784 if (fp->uf_flags & FC_VIM9)
3785 {
3786 semsg(_("E1084: Cannot delete Vim9 script function %s"), eap->arg);
3787 return;
3788 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789
3790 if (fudi.fd_dict != NULL)
3791 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003792 // Delete the dict item that refers to the function, it will
3793 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3795 }
3796 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003797 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // A normal function (not a numbered function or lambda) has a
3799 // refcount of 1 for the entry in the hashtable. When deleting
3800 // it and the refcount is more than one, it should be kept.
3801 // A numbered function and lambda should be kept if the refcount is
3802 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003803 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003804 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003805 // Function is still referenced somewhere. Don't free it but
3806 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003807 if (func_remove(fp))
3808 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003809 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003810 }
3811 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003812 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003813 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 }
3815}
3816
3817/*
3818 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003819 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 */
3821 void
3822func_unref(char_u *name)
3823{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003824 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003826 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003828 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003829 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003832 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003834 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003836 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003838 // Only delete it when it's not being used. Otherwise it's done
3839 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003840 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003841 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003842 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003843}
3844
3845/*
3846 * Unreference a Function: decrement the reference count and free it when it
3847 * becomes zero.
3848 */
3849 void
3850func_ptr_unref(ufunc_T *fp)
3851{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003852 if (fp != NULL && --fp->uf_refcount <= 0)
3853 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003854 // Only delete it when it's not being used. Otherwise it's done
3855 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003856 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003857 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 }
3859}
3860
3861/*
3862 * Count a reference to a Function.
3863 */
3864 void
3865func_ref(char_u *name)
3866{
3867 ufunc_T *fp;
3868
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003869 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003871 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003872 if (fp != NULL)
3873 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003875 // Only give an error for a numbered function.
3876 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003877 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003878}
3879
3880/*
3881 * Count a reference to a Function.
3882 */
3883 void
3884func_ptr_ref(ufunc_T *fp)
3885{
3886 if (fp != NULL)
3887 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888}
3889
3890/*
3891 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3892 * referenced from anywhere that is in use.
3893 */
3894 static int
3895can_free_funccal(funccall_T *fc, int copyID)
3896{
3897 return (fc->l_varlist.lv_copyID != copyID
3898 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003899 && fc->l_avars.dv_copyID != copyID
3900 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901}
3902
3903/*
3904 * ":return [expr]"
3905 */
3906 void
3907ex_return(exarg_T *eap)
3908{
3909 char_u *arg = eap->arg;
3910 typval_T rettv;
3911 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003912 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913
3914 if (current_funccal == NULL)
3915 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003916 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003917 return;
3918 }
3919
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003920 CLEAR_FIELD(evalarg);
3921 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3922
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003923 if (eap->skip)
3924 ++emsg_skip;
3925
3926 eap->nextcmd = NULL;
3927 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003928 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929 {
3930 if (!eap->skip)
3931 returning = do_return(eap, FALSE, TRUE, &rettv);
3932 else
3933 clear_tv(&rettv);
3934 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003935 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 else if (!eap->skip)
3937 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003938 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003939 update_force_abort();
3940
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 /*
3942 * Return unless the expression evaluation has been cancelled due to an
3943 * aborting error, an interrupt, or an exception.
3944 */
3945 if (!aborting())
3946 returning = do_return(eap, FALSE, TRUE, NULL);
3947 }
3948
Bram Moolenaare38eab22019-12-05 21:50:01 +01003949 // When skipping or the return gets pending, advance to the next command
3950 // in this line (!returning). Otherwise, ignore the rest of the line.
3951 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 if (returning)
3953 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003954 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 eap->nextcmd = check_nextcmd(arg);
3956
3957 if (eap->skip)
3958 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003959 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960}
3961
3962/*
3963 * ":1,25call func(arg1, arg2)" function call.
3964 */
3965 void
3966ex_call(exarg_T *eap)
3967{
3968 char_u *arg = eap->arg;
3969 char_u *startarg;
3970 char_u *name;
3971 char_u *tofree;
3972 int len;
3973 typval_T rettv;
3974 linenr_T lnum;
3975 int doesrange;
3976 int failed = FALSE;
3977 funcdict_T fudi;
3978 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003979 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980
Bram Moolenaare6b53242020-07-01 17:28:33 +02003981 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 if (eap->skip)
3983 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003984 // trans_function_name() doesn't work well when skipping, use eval0()
3985 // instead to skip to any following command, e.g. for:
3986 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003987 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003988 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 clear_tv(&rettv);
3990 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003991 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003992 return;
3993 }
3994
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003995 tofree = trans_function_name(&arg, NULL, eap->skip,
3996 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003997 if (fudi.fd_newkey != NULL)
3998 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003999 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004000 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004001 vim_free(fudi.fd_newkey);
4002 }
4003 if (tofree == NULL)
4004 return;
4005
Bram Moolenaare38eab22019-12-05 21:50:01 +01004006 // Increase refcount on dictionary, it could get deleted when evaluating
4007 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 if (fudi.fd_dict != NULL)
4009 ++fudi.fd_dict->dv_refcount;
4010
Bram Moolenaare38eab22019-12-05 21:50:01 +01004011 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4012 // contents. For VAR_PARTIAL get its partial, unless we already have one
4013 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 len = (int)STRLEN(tofree);
4015 name = deref_func_name(tofree, &len,
4016 partial != NULL ? NULL : &partial, FALSE);
4017
Bram Moolenaare38eab22019-12-05 21:50:01 +01004018 // Skip white space to allow ":call func ()". Not good, but required for
4019 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004021 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022
4023 if (*startarg != '(')
4024 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004025 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 goto end;
4027 }
4028
4029 /*
4030 * When skipping, evaluate the function once, to find the end of the
4031 * arguments.
4032 * When the function takes a range, this is discovered after the first
4033 * call, and the loop is broken.
4034 */
4035 if (eap->skip)
4036 {
4037 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004038 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 }
4040 else
4041 lnum = eap->line1;
4042 for ( ; lnum <= eap->line2; ++lnum)
4043 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004044 funcexe_T funcexe;
4045
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 if (!eap->skip && eap->addr_count > 0)
4047 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004048 if (lnum > curbuf->b_ml.ml_line_count)
4049 {
4050 // If the function deleted lines or switched to another buffer
4051 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004052 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004053 break;
4054 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 curwin->w_cursor.lnum = lnum;
4056 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 }
4059 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004060
Bram Moolenaara80faa82020-04-12 19:37:17 +02004061 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004062 funcexe.firstline = eap->line1;
4063 funcexe.lastline = eap->line2;
4064 funcexe.doesrange = &doesrange;
4065 funcexe.evaluate = !eap->skip;
4066 funcexe.partial = partial;
4067 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004068 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 {
4070 failed = TRUE;
4071 break;
4072 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004073 if (has_watchexpr())
4074 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004076 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004077 if (handle_subscript(&arg, &rettv,
4078 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 {
4080 failed = TRUE;
4081 break;
4082 }
4083
4084 clear_tv(&rettv);
4085 if (doesrange || eap->skip)
4086 break;
4087
Bram Moolenaare38eab22019-12-05 21:50:01 +01004088 // Stop when immediately aborting on error, or when an interrupt
4089 // occurred or an exception was thrown but not caught.
4090 // get_func_tv() returned OK, so that the check for trailing
4091 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 if (aborting())
4093 break;
4094 }
4095 if (eap->skip)
4096 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004097 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098
Bram Moolenaare51bb172020-02-16 19:42:23 +01004099 // When inside :try we need to check for following "| catch".
4100 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004102 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004103 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004104 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004106 if (!failed)
4107 {
4108 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004109 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004110 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004111 }
4112 else
4113 eap->nextcmd = check_nextcmd(arg);
4114 }
4115
4116end:
4117 dict_unref(fudi.fd_dict);
4118 vim_free(tofree);
4119}
4120
4121/*
4122 * Return from a function. Possibly makes the return pending. Also called
4123 * for a pending return at the ":endtry" or after returning from an extra
4124 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4125 * when called due to a ":return" command. "rettv" may point to a typval_T
4126 * with the return rettv. Returns TRUE when the return can be carried out,
4127 * FALSE when the return gets pending.
4128 */
4129 int
4130do_return(
4131 exarg_T *eap,
4132 int reanimate,
4133 int is_cmd,
4134 void *rettv)
4135{
4136 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004137 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138
4139 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004140 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 current_funccal->returned = FALSE;
4142
4143 /*
4144 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4145 * not in its finally clause (which then is to be executed next) is found.
4146 * In this case, make the ":return" pending for execution at the ":endtry".
4147 * Otherwise, return normally.
4148 */
4149 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4150 if (idx >= 0)
4151 {
4152 cstack->cs_pending[idx] = CSTP_RETURN;
4153
4154 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004155 // A pending return again gets pending. "rettv" points to an
4156 // allocated variable with the rettv of the original ":return"'s
4157 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 cstack->cs_rettv[idx] = rettv;
4159 else
4160 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004161 // When undoing a return in order to make it pending, get the stored
4162 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 if (reanimate)
4164 rettv = current_funccal->rettv;
4165
4166 if (rettv != NULL)
4167 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004168 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4170 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4171 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004172 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 }
4174 else
4175 cstack->cs_rettv[idx] = NULL;
4176
4177 if (reanimate)
4178 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004179 // The pending return value could be overwritten by a ":return"
4180 // without argument in a finally clause; reset the default
4181 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 current_funccal->rettv->v_type = VAR_NUMBER;
4183 current_funccal->rettv->vval.v_number = 0;
4184 }
4185 }
4186 report_make_pending(CSTP_RETURN, rettv);
4187 }
4188 else
4189 {
4190 current_funccal->returned = TRUE;
4191
Bram Moolenaare38eab22019-12-05 21:50:01 +01004192 // If the return is carried out now, store the return value. For
4193 // a return immediately after reanimation, the value is already
4194 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 if (!reanimate && rettv != NULL)
4196 {
4197 clear_tv(current_funccal->rettv);
4198 *current_funccal->rettv = *(typval_T *)rettv;
4199 if (!is_cmd)
4200 vim_free(rettv);
4201 }
4202 }
4203
4204 return idx < 0;
4205}
4206
4207/*
4208 * Free the variable with a pending return value.
4209 */
4210 void
4211discard_pending_return(void *rettv)
4212{
4213 free_tv((typval_T *)rettv);
4214}
4215
4216/*
4217 * Generate a return command for producing the value of "rettv". The result
4218 * is an allocated string. Used by report_pending() for verbose messages.
4219 */
4220 char_u *
4221get_return_cmd(void *rettv)
4222{
4223 char_u *s = NULL;
4224 char_u *tofree = NULL;
4225 char_u numbuf[NUMBUFLEN];
4226
4227 if (rettv != NULL)
4228 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4229 if (s == NULL)
4230 s = (char_u *)"";
4231
4232 STRCPY(IObuff, ":return ");
4233 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4234 if (STRLEN(s) + 8 >= IOSIZE)
4235 STRCPY(IObuff + IOSIZE - 4, "...");
4236 vim_free(tofree);
4237 return vim_strsave(IObuff);
4238}
4239
4240/*
4241 * Get next function line.
4242 * Called by do_cmdline() to get the next line.
4243 * Returns allocated string, or NULL for end of function.
4244 */
4245 char_u *
4246get_func_line(
4247 int c UNUSED,
4248 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004249 int indent UNUSED,
4250 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004251{
4252 funccall_T *fcp = (funccall_T *)cookie;
4253 ufunc_T *fp = fcp->func;
4254 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004255 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256
Bram Moolenaare38eab22019-12-05 21:50:01 +01004257 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 if (fcp->dbg_tick != debug_tick)
4259 {
4260 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004261 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004262 fcp->dbg_tick = debug_tick;
4263 }
4264#ifdef FEAT_PROFILE
4265 if (do_profiling == PROF_YES)
4266 func_line_end(cookie);
4267#endif
4268
4269 gap = &fp->uf_lines;
4270 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4271 || fcp->returned)
4272 retval = NULL;
4273 else
4274 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004275 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 while (fcp->linenr < gap->ga_len
4277 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4278 ++fcp->linenr;
4279 if (fcp->linenr >= gap->ga_len)
4280 retval = NULL;
4281 else
4282 {
4283 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004284 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285#ifdef FEAT_PROFILE
4286 if (do_profiling == PROF_YES)
4287 func_line_start(cookie);
4288#endif
4289 }
4290 }
4291
Bram Moolenaare38eab22019-12-05 21:50:01 +01004292 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004293 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004295 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004296 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004298 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 fcp->dbg_tick = debug_tick;
4300 }
4301
4302 return retval;
4303}
4304
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004305/*
4306 * Return TRUE if the currently active function should be ended, because a
4307 * return was encountered or an error occurred. Used inside a ":while".
4308 */
4309 int
4310func_has_ended(void *cookie)
4311{
4312 funccall_T *fcp = (funccall_T *)cookie;
4313
Bram Moolenaare38eab22019-12-05 21:50:01 +01004314 // Ignore the "abort" flag if the abortion behavior has been changed due to
4315 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4317 || fcp->returned);
4318}
4319
4320/*
4321 * return TRUE if cookie indicates a function which "abort"s on errors.
4322 */
4323 int
4324func_has_abort(
4325 void *cookie)
4326{
4327 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4328}
4329
4330
4331/*
4332 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4333 * Don't do this when "Func" is already a partial that was bound
4334 * explicitly (pt_auto is FALSE).
4335 * Changes "rettv" in-place.
4336 * Returns the updated "selfdict_in".
4337 */
4338 dict_T *
4339make_partial(dict_T *selfdict_in, typval_T *rettv)
4340{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004341 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342 char_u *tofree = NULL;
4343 ufunc_T *fp;
4344 char_u fname_buf[FLEN_FIXED + 1];
4345 int error;
4346 dict_T *selfdict = selfdict_in;
4347
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004348 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4349 fp = rettv->vval.v_partial->pt_func;
4350 else
4351 {
4352 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4353 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004354 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004355 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004356 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004357 vim_free(tofree);
4358 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359
4360 if (fp != NULL && (fp->uf_flags & FC_DICT))
4361 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004362 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363
4364 if (pt != NULL)
4365 {
4366 pt->pt_refcount = 1;
4367 pt->pt_dict = selfdict;
4368 pt->pt_auto = TRUE;
4369 selfdict = NULL;
4370 if (rettv->v_type == VAR_FUNC)
4371 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004372 // Just a function: Take over the function name and use
4373 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374 pt->pt_name = rettv->vval.v_string;
4375 }
4376 else
4377 {
4378 partial_T *ret_pt = rettv->vval.v_partial;
4379 int i;
4380
Bram Moolenaare38eab22019-12-05 21:50:01 +01004381 // Partial: copy the function name, use selfdict and copy
4382 // args. Can't take over name or args, the partial might
4383 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004384 if (ret_pt->pt_name != NULL)
4385 {
4386 pt->pt_name = vim_strsave(ret_pt->pt_name);
4387 func_ref(pt->pt_name);
4388 }
4389 else
4390 {
4391 pt->pt_func = ret_pt->pt_func;
4392 func_ptr_ref(pt->pt_func);
4393 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 if (ret_pt->pt_argc > 0)
4395 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004396 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004398 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 pt->pt_argc = 0;
4400 else
4401 {
4402 pt->pt_argc = ret_pt->pt_argc;
4403 for (i = 0; i < pt->pt_argc; i++)
4404 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4405 }
4406 }
4407 partial_unref(ret_pt);
4408 }
4409 rettv->v_type = VAR_PARTIAL;
4410 rettv->vval.v_partial = pt;
4411 }
4412 }
4413 return selfdict;
4414}
4415
4416/*
4417 * Return the name of the executed function.
4418 */
4419 char_u *
4420func_name(void *cookie)
4421{
4422 return ((funccall_T *)cookie)->func->uf_name;
4423}
4424
4425/*
4426 * Return the address holding the next breakpoint line for a funccall cookie.
4427 */
4428 linenr_T *
4429func_breakpoint(void *cookie)
4430{
4431 return &((funccall_T *)cookie)->breakpoint;
4432}
4433
4434/*
4435 * Return the address holding the debug tick for a funccall cookie.
4436 */
4437 int *
4438func_dbg_tick(void *cookie)
4439{
4440 return &((funccall_T *)cookie)->dbg_tick;
4441}
4442
4443/*
4444 * Return the nesting level for a funccall cookie.
4445 */
4446 int
4447func_level(void *cookie)
4448{
4449 return ((funccall_T *)cookie)->level;
4450}
4451
4452/*
4453 * Return TRUE when a function was ended by a ":return" command.
4454 */
4455 int
4456current_func_returned(void)
4457{
4458 return current_funccal->returned;
4459}
4460
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461 int
4462free_unref_funccal(int copyID, int testing)
4463{
4464 int did_free = FALSE;
4465 int did_free_funccal = FALSE;
4466 funccall_T *fc, **pfc;
4467
4468 for (pfc = &previous_funccal; *pfc != NULL; )
4469 {
4470 if (can_free_funccal(*pfc, copyID))
4471 {
4472 fc = *pfc;
4473 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004474 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004475 did_free = TRUE;
4476 did_free_funccal = TRUE;
4477 }
4478 else
4479 pfc = &(*pfc)->caller;
4480 }
4481 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004482 // When a funccal was freed some more items might be garbage
4483 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484 (void)garbage_collect(testing);
4485
4486 return did_free;
4487}
4488
4489/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004490 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 */
4492 static funccall_T *
4493get_funccal(void)
4494{
4495 int i;
4496 funccall_T *funccal;
4497 funccall_T *temp_funccal;
4498
4499 funccal = current_funccal;
4500 if (debug_backtrace_level > 0)
4501 {
4502 for (i = 0; i < debug_backtrace_level; i++)
4503 {
4504 temp_funccal = funccal->caller;
4505 if (temp_funccal)
4506 funccal = temp_funccal;
4507 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004508 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 debug_backtrace_level = i;
4510 }
4511 }
4512 return funccal;
4513}
4514
4515/*
4516 * Return the hashtable used for local variables in the current funccal.
4517 * Return NULL if there is no current funccal.
4518 */
4519 hashtab_T *
4520get_funccal_local_ht()
4521{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523 return NULL;
4524 return &get_funccal()->l_vars.dv_hashtab;
4525}
4526
4527/*
4528 * Return the l: scope variable.
4529 * Return NULL if there is no current funccal.
4530 */
4531 dictitem_T *
4532get_funccal_local_var()
4533{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 return NULL;
4536 return &get_funccal()->l_vars_var;
4537}
4538
4539/*
4540 * Return the hashtable used for argument in the current funccal.
4541 * Return NULL if there is no current funccal.
4542 */
4543 hashtab_T *
4544get_funccal_args_ht()
4545{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004546 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547 return NULL;
4548 return &get_funccal()->l_avars.dv_hashtab;
4549}
4550
4551/*
4552 * Return the a: scope variable.
4553 * Return NULL if there is no current funccal.
4554 */
4555 dictitem_T *
4556get_funccal_args_var()
4557{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004558 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004560 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004561}
4562
4563/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564 * List function variables, if there is a function.
4565 */
4566 void
4567list_func_vars(int *first)
4568{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004569 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004571 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572}
4573
4574/*
4575 * If "ht" is the hashtable for local variables in the current funccal, return
4576 * the dict that contains it.
4577 * Otherwise return NULL.
4578 */
4579 dict_T *
4580get_current_funccal_dict(hashtab_T *ht)
4581{
4582 if (current_funccal != NULL
4583 && ht == &current_funccal->l_vars.dv_hashtab)
4584 return &current_funccal->l_vars;
4585 return NULL;
4586}
4587
4588/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004589 * Search hashitem in parent scope.
4590 */
4591 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004592find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004593{
4594 funccall_T *old_current_funccal = current_funccal;
4595 hashtab_T *ht;
4596 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004597 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004598
4599 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4600 return NULL;
4601
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004602 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004603 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004604 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004605 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004606 ht = find_var_ht(name, &varname);
4607 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004608 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004609 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004610 if (!HASHITEM_EMPTY(hi))
4611 {
4612 *pht = ht;
4613 break;
4614 }
4615 }
4616 if (current_funccal == current_funccal->func->uf_scoped)
4617 break;
4618 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004619 }
4620 current_funccal = old_current_funccal;
4621
4622 return hi;
4623}
4624
4625/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004626 * Search variable in parent scope.
4627 */
4628 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004629find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004630{
4631 dictitem_T *v = NULL;
4632 funccall_T *old_current_funccal = current_funccal;
4633 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004634 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004635
4636 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4637 return NULL;
4638
Bram Moolenaare38eab22019-12-05 21:50:01 +01004639 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004640 current_funccal = current_funccal->func->uf_scoped;
4641 while (current_funccal)
4642 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004643 ht = find_var_ht(name, &varname);
4644 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004645 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004646 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004647 if (v != NULL)
4648 break;
4649 }
4650 if (current_funccal == current_funccal->func->uf_scoped)
4651 break;
4652 current_funccal = current_funccal->func->uf_scoped;
4653 }
4654 current_funccal = old_current_funccal;
4655
4656 return v;
4657}
4658
4659/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004660 * Set "copyID + 1" in previous_funccal and callers.
4661 */
4662 int
4663set_ref_in_previous_funccal(int copyID)
4664{
4665 int abort = FALSE;
4666 funccall_T *fc;
4667
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004668 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004670 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004671 abort = abort
4672 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4673 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004674 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675 }
4676 return abort;
4677}
4678
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004679 static int
4680set_ref_in_funccal(funccall_T *fc, int copyID)
4681{
4682 int abort = FALSE;
4683
4684 if (fc->fc_copyID != copyID)
4685 {
4686 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004687 abort = abort
4688 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4689 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004690 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004691 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004692 }
4693 return abort;
4694}
4695
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696/*
4697 * Set "copyID" in all local vars and arguments in the call stack.
4698 */
4699 int
4700set_ref_in_call_stack(int copyID)
4701{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004702 int abort = FALSE;
4703 funccall_T *fc;
4704 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004706 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004707 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004708
4709 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004710 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4711 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004712 abort = abort || set_ref_in_funccal(fc, copyID);
4713
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004714 return abort;
4715}
4716
4717/*
4718 * Set "copyID" in all functions available by name.
4719 */
4720 int
4721set_ref_in_functions(int copyID)
4722{
4723 int todo;
4724 hashitem_T *hi = NULL;
4725 int abort = FALSE;
4726 ufunc_T *fp;
4727
4728 todo = (int)func_hashtab.ht_used;
4729 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004731 if (!HASHITEM_EMPTY(hi))
4732 {
4733 --todo;
4734 fp = HI2UF(hi);
4735 if (!func_name_refcount(fp->uf_name))
4736 abort = abort || set_ref_in_func(NULL, fp, copyID);
4737 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 }
4739 return abort;
4740}
4741
4742/*
4743 * Set "copyID" in all function arguments.
4744 */
4745 int
4746set_ref_in_func_args(int copyID)
4747{
4748 int i;
4749 int abort = FALSE;
4750
4751 for (i = 0; i < funcargs.ga_len; ++i)
4752 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4753 copyID, NULL, NULL);
4754 return abort;
4755}
4756
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004757/*
4758 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004759 * Returns TRUE if setting references failed somehow.
4760 */
4761 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004762set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004763{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004764 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004765 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004766 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004767 char_u fname_buf[FLEN_FIXED + 1];
4768 char_u *tofree = NULL;
4769 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004770 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004771
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004772 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004773 return FALSE;
4774
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004775 if (fp_in == NULL)
4776 {
4777 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004778 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004779 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004780 if (fp != NULL)
4781 {
4782 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004783 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004784 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004785
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004786 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004787 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004788}
4789
Bram Moolenaare38eab22019-12-05 21:50:01 +01004790#endif // FEAT_EVAL