blob: 684a805d8abaf0197451719e285f6bbc3b64de4f [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
689 *arg = skipwhite(argp);
690 return ret;
691}
692
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200693/*
694 * Return TRUE if "p" starts with "<SID>" or "s:".
695 * Only works if eval_fname_script() returned non-zero for "p"!
696 */
697 static int
698eval_fname_sid(char_u *p)
699{
700 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
701}
702
703/*
704 * In a script change <SID>name() and s:name() to K_SNR 123_name().
705 * Change <SNR>123_name() to K_SNR 123_name().
706 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
707 * (slow).
708 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100709 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200710fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
711{
712 int llen;
713 char_u *fname;
714 int i;
715
716 llen = eval_fname_script(name);
717 if (llen > 0)
718 {
719 fname_buf[0] = K_SPECIAL;
720 fname_buf[1] = KS_EXTRA;
721 fname_buf[2] = (int)KE_SNR;
722 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100723 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200724 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200725 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100726 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200727 else
728 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200729 sprintf((char *)fname_buf + 3, "%ld_",
730 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200731 i = (int)STRLEN(fname_buf);
732 }
733 }
734 if (i + STRLEN(name + llen) < FLEN_FIXED)
735 {
736 STRCPY(fname_buf + i, name + llen);
737 fname = fname_buf;
738 }
739 else
740 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200741 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200742 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100743 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200744 else
745 {
746 *tofree = fname;
747 mch_memmove(fname, fname_buf, (size_t)i);
748 STRCPY(fname + i, name + llen);
749 }
750 }
751 }
752 else
753 fname = name;
754 return fname;
755}
756
757/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100758 * Find a function "name" in script "sid".
759 */
760 static ufunc_T *
761find_func_with_sid(char_u *name, int sid)
762{
763 hashitem_T *hi;
764 char_u buffer[200];
765
766 buffer[0] = K_SPECIAL;
767 buffer[1] = KS_EXTRA;
768 buffer[2] = (int)KE_SNR;
769 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
770 (long)sid, name);
771 hi = hash_find(&func_hashtab, buffer);
772 if (!HASHITEM_EMPTY(hi))
773 return HI2UF(hi);
774
775 return NULL;
776}
777
778/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200779 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200780 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200781 * Return NULL for unknown function.
782 */
Bram Moolenaarce658352020-07-31 23:47:12 +0200783 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200784find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200785{
786 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100787 ufunc_T *func;
788 imported_T *imported;
789
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200790 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100791 {
Bram Moolenaar333894b2020-08-01 18:53:07 +0200792 int vim9script = in_vim9script();
793 char_u *after_script = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100794
Bram Moolenaar333894b2020-08-01 18:53:07 +0200795 if (vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100796 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200797 // Find script-local function before global one.
798 func = find_func_with_sid(name, current_sctx.sc_sid);
799 if (func != NULL)
800 return func;
801 }
802
Bram Moolenaar333894b2020-08-01 18:53:07 +0200803 if (!vim9script
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200804 && name[0] == K_SPECIAL
805 && name[1] == KS_EXTRA
806 && name[2] == KE_SNR)
807 {
808 long sid;
809
810 // Caller changes s: to <SNR>99_name.
811
812 after_script = name + 3;
813 sid = getdigits(&after_script);
814 if (sid == current_sctx.sc_sid && *after_script == '_')
815 ++after_script;
816 else
817 after_script = NULL;
818 }
Bram Moolenaar333894b2020-08-01 18:53:07 +0200819 if (vim9script || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200820 {
821 // Find imported function before global one.
822 imported = find_imported(
823 after_script == NULL ? name : after_script, 0, cctx);
824 if (imported != NULL && imported->imp_funcname != NULL)
825 {
826 hi = hash_find(&func_hashtab, imported->imp_funcname);
827 if (!HASHITEM_EMPTY(hi))
828 return HI2UF(hi);
829 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100830 }
831 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200832
Bram Moolenaara26b9702020-04-18 19:53:28 +0200833 hi = hash_find(&func_hashtab,
834 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200835 if (!HASHITEM_EMPTY(hi))
836 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100837
838 return NULL;
839}
840
841/*
842 * Find a function by name, return pointer to it in ufuncs.
843 * "cctx" is passed in a :def function to find imported functions.
844 * Return NULL for unknown or dead function.
845 */
846 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200847find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100848{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200849 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100850
851 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
852 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200853 return NULL;
854}
855
856/*
857 * Copy the function name of "fp" to buffer "buf".
858 * "buf" must be able to hold the function name plus three bytes.
859 * Takes care of script-local function names.
860 */
861 static void
862cat_func_name(char_u *buf, ufunc_T *fp)
863{
864 if (fp->uf_name[0] == K_SPECIAL)
865 {
866 STRCPY(buf, "<SNR>");
867 STRCAT(buf, fp->uf_name + 3);
868 }
869 else
870 STRCPY(buf, fp->uf_name);
871}
872
873/*
874 * Add a number variable "name" to dict "dp" with value "nr".
875 */
876 static void
877add_nr_var(
878 dict_T *dp,
879 dictitem_T *v,
880 char *name,
881 varnumber_T nr)
882{
883 STRCPY(v->di_key, name);
884 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
885 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
886 v->di_tv.v_type = VAR_NUMBER;
887 v->di_tv.v_lock = VAR_FIXED;
888 v->di_tv.vval.v_number = nr;
889}
890
891/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100892 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200893 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100894 static void
895free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200896{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100897 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200898
899 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
900 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100901 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200902
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100903 // When garbage collecting a funccall_T may be freed before the
904 // function that references it, clear its uf_scoped field.
905 // The function may have been redefined and point to another
906 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200907 if (fp != NULL && fp->uf_scoped == fc)
908 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200909 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200910 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200911
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200912 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200913 vim_free(fc);
914}
915
916/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100917 * Free "fc" and what it contains.
918 * Can be called only when "fc" is kept beyond the period of it called,
919 * i.e. after cleanup_function_call(fc).
920 */
921 static void
922free_funccal_contents(funccall_T *fc)
923{
924 listitem_T *li;
925
926 // Free all l: variables.
927 vars_clear(&fc->l_vars.dv_hashtab);
928
929 // Free all a: variables.
930 vars_clear(&fc->l_avars.dv_hashtab);
931
932 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200933 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100934 clear_tv(&li->li_tv);
935
936 free_funccal(fc);
937}
938
939/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200940 * Handle the last part of returning from a function: free the local hashtable.
941 * Unless it is still in use by a closure.
942 */
943 static void
944cleanup_function_call(funccall_T *fc)
945{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100946 int may_free_fc = fc->fc_refcount <= 0;
947 int free_fc = TRUE;
948
Bram Moolenaar6914c642017-04-01 21:21:30 +0200949 current_funccal = fc->caller;
950
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100951 // Free all l: variables if not referred.
952 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
953 vars_clear(&fc->l_vars.dv_hashtab);
954 else
955 free_fc = FALSE;
956
957 // If the a:000 list and the l: and a: dicts are not referenced and
958 // there is no closure using it, we can free the funccall_T and what's
959 // in it.
960 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
961 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200962 else
963 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100964 int todo;
965 hashitem_T *hi;
966 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200967
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100968 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200969
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100970 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200971 todo = (int)fc->l_avars.dv_hashtab.ht_used;
972 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
973 {
974 if (!HASHITEM_EMPTY(hi))
975 {
976 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100977 di = HI2DI(hi);
978 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200979 }
980 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100981 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200982
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100983 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
984 fc->l_varlist.lv_first = NULL;
985 else
986 {
987 listitem_T *li;
988
989 free_fc = FALSE;
990
991 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200992 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200993 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100994 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100995
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100996 if (free_fc)
997 free_funccal(fc);
998 else
999 {
1000 static int made_copy = 0;
1001
1002 // "fc" is still in use. This can happen when returning "a:000",
1003 // assigning "l:" to a global variable or defining a closure.
1004 // Link "fc" in the list for garbage collection later.
1005 fc->caller = previous_funccal;
1006 previous_funccal = fc;
1007
1008 if (want_garbage_collect)
1009 // If garbage collector is ready, clear count.
1010 made_copy = 0;
1011 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001012 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001013 // We have made a lot of copies, worth 4 Mbyte. This can happen
1014 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001015 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001016 // too much memory.
1017 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001018 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001019 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001020 }
1021}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001022/*
1023 * Unreference "fc": decrement the reference count and free it when it
1024 * becomes zero. "fp" is detached from "fc".
1025 * When "force" is TRUE we are exiting.
1026 */
1027 static void
1028funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1029{
1030 funccall_T **pfc;
1031 int i;
1032
1033 if (fc == NULL)
1034 return;
1035
1036 if (--fc->fc_refcount <= 0 && (force || (
1037 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1038 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1039 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1040 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1041 {
1042 if (fc == *pfc)
1043 {
1044 *pfc = fc->caller;
1045 free_funccal_contents(fc);
1046 return;
1047 }
1048 }
1049 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1050 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1051 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1052}
1053
1054/*
1055 * Remove the function from the function hashtable. If the function was
1056 * deleted while it still has references this was already done.
1057 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1058 */
1059 static int
1060func_remove(ufunc_T *fp)
1061{
1062 hashitem_T *hi;
1063
1064 // Return if it was already virtually deleted.
1065 if (fp->uf_flags & FC_DEAD)
1066 return FALSE;
1067
1068 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1069 if (!HASHITEM_EMPTY(hi))
1070 {
1071 // When there is a def-function index do not actually remove the
1072 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001073 // Do remove it when it's a copy.
1074 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001075 fp->uf_flags |= FC_DEAD;
1076 else
1077 hash_remove(&func_hashtab, hi);
1078 return TRUE;
1079 }
1080 return FALSE;
1081}
1082
1083 static void
1084func_clear_items(ufunc_T *fp)
1085{
1086 ga_clear_strings(&(fp->uf_args));
1087 ga_clear_strings(&(fp->uf_def_args));
1088 ga_clear_strings(&(fp->uf_lines));
1089 VIM_CLEAR(fp->uf_name_exp);
1090 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001091 VIM_CLEAR(fp->uf_def_arg_idx);
1092 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001093 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001094
1095#ifdef FEAT_LUA
1096 if (fp->uf_cb_free != NULL)
1097 {
1098 fp->uf_cb_free(fp->uf_cb_state);
1099 fp->uf_cb_free = NULL;
1100 }
1101
1102 fp->uf_cb_state = NULL;
1103 fp->uf_cb = NULL;
1104#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001105#ifdef FEAT_PROFILE
1106 VIM_CLEAR(fp->uf_tml_count);
1107 VIM_CLEAR(fp->uf_tml_total);
1108 VIM_CLEAR(fp->uf_tml_self);
1109#endif
1110}
1111
1112/*
1113 * Free all things that a function contains. Does not free the function
1114 * itself, use func_free() for that.
1115 * When "force" is TRUE we are exiting.
1116 */
1117 static void
1118func_clear(ufunc_T *fp, int force)
1119{
1120 if (fp->uf_cleared)
1121 return;
1122 fp->uf_cleared = TRUE;
1123
1124 // clear this function
1125 func_clear_items(fp);
1126 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001127 if ((fp->uf_flags & FC_COPY) == 0)
1128 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001129}
1130
1131/*
1132 * Free a function and remove it from the list of functions. Does not free
1133 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001134 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001135 */
1136 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001137func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001138{
1139 // Only remove it when not done already, otherwise we would remove a newer
1140 // version of the function with the same name.
1141 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1142 func_remove(fp);
1143
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001144 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001145 vim_free(fp);
1146}
1147
1148/*
1149 * Free all things that a function contains and free the function itself.
1150 * When "force" is TRUE we are exiting.
1151 */
1152 static void
1153func_clear_free(ufunc_T *fp, int force)
1154{
1155 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001156 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001157 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001158 else
1159 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001160}
1161
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001162/*
1163 * Copy already defined function "lambda" to a new function with name "global".
1164 * This is for when a compiled function defines a global function.
1165 */
1166 void
1167copy_func(char_u *lambda, char_u *global)
1168{
1169 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1170 ufunc_T *fp;
1171
1172 if (ufunc == NULL)
1173 semsg(_("E1102: lambda function not found: %s"), lambda);
1174 else
1175 {
1176 // TODO: handle ! to overwrite
1177 fp = find_func(global, TRUE, NULL);
1178 if (fp != NULL)
1179 {
1180 semsg(_(e_funcexts), global);
1181 return;
1182 }
1183
1184 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1185 if (fp == NULL)
1186 return;
1187
1188 fp->uf_varargs = ufunc->uf_varargs;
1189 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1190 fp->uf_def_status = ufunc->uf_def_status;
1191 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001192 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1193 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001194 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001195 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001196 goto failed;
1197
1198 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1199 : vim_strsave(ufunc->uf_name_exp);
1200 if (ufunc->uf_arg_types != NULL)
1201 {
1202 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1203 if (fp->uf_arg_types == NULL)
1204 goto failed;
1205 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1206 sizeof(type_T *) * fp->uf_args.ga_len);
1207 }
1208 if (ufunc->uf_def_arg_idx != NULL)
1209 {
1210 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1211 if (fp->uf_def_arg_idx == NULL)
1212 goto failed;
1213 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1214 sizeof(int) * fp->uf_def_args.ga_len + 1);
1215 }
1216 if (ufunc->uf_va_name != NULL)
1217 {
1218 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1219 if (fp->uf_va_name == NULL)
1220 goto failed;
1221 }
1222
1223 fp->uf_refcount = 1;
1224 STRCPY(fp->uf_name, global);
1225 hash_add(&func_hashtab, UF2HIKEY(fp));
1226 }
1227 return;
1228
1229failed:
1230 func_clear_free(fp, TRUE);
1231}
1232
Bram Moolenaar6914c642017-04-01 21:21:30 +02001233
1234/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001235 * Call a user function.
1236 */
1237 static void
1238call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001239 ufunc_T *fp, // pointer to function
1240 int argcount, // nr of args
1241 typval_T *argvars, // arguments
1242 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001243 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001244 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001245{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001246 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001247 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001248 funccall_T *fc;
1249 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001250 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001251 static int depth = 0;
1252 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001253 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001254 int i;
1255 int ai;
1256 int islambda = FALSE;
1257 char_u numbuf[NUMBUFLEN];
1258 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001259#ifdef FEAT_PROFILE
1260 proftime_T wait_start;
1261 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001262 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001263#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001264 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001265
Bram Moolenaare38eab22019-12-05 21:50:01 +01001266 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267 if (depth >= p_mfd)
1268 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001269 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001270 rettv->v_type = VAR_NUMBER;
1271 rettv->vval.v_number = -1;
1272 return;
1273 }
1274 ++depth;
1275
Bram Moolenaare38eab22019-12-05 21:50:01 +01001276 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001277
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001278 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001279 if (fc == NULL)
1280 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001281 fc->caller = current_funccal;
1282 current_funccal = fc;
1283 fc->func = fp;
1284 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001286 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1288 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001289 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001290 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001291 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001293 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001294 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001295 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001296 save_current_sctx = current_sctx;
1297 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001298
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001299 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001300 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001301 --depth;
1302 current_funccal = fc->caller;
1303
1304 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001305 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001306 free_funccal(fc);
1307 return;
1308 }
1309
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001310 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1311 islambda = TRUE;
1312
1313 /*
1314 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1315 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1316 * each argument variable and saves a lot of time.
1317 */
1318 /*
1319 * Init l: variables.
1320 */
1321 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1322 if (selfdict != NULL)
1323 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001324 // Set l:self to "selfdict". Use "name" to avoid a warning from
1325 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 v = &fc->fixvar[fixvar_idx++].var;
1327 name = v->di_key;
1328 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001329 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1331 v->di_tv.v_type = VAR_DICT;
1332 v->di_tv.v_lock = 0;
1333 v->di_tv.vval.v_dict = selfdict;
1334 ++selfdict->dv_refcount;
1335 }
1336
1337 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001338 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001339 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001340 * Set a:000 to a list with room for the "..." arguments.
1341 */
1342 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001343 if ((fp->uf_flags & FC_NOARGS) == 0)
1344 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001345 (varnumber_T)(argcount >= fp->uf_args.ga_len
1346 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001347 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001348 if ((fp->uf_flags & FC_NOARGS) == 0)
1349 {
1350 // Use "name" to avoid a warning from some compiler that checks the
1351 // destination size.
1352 v = &fc->fixvar[fixvar_idx++].var;
1353 name = v->di_key;
1354 STRCPY(name, "000");
1355 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1356 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1357 v->di_tv.v_type = VAR_LIST;
1358 v->di_tv.v_lock = VAR_FIXED;
1359 v->di_tv.vval.v_list = &fc->l_varlist;
1360 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001361 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001362 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1363 fc->l_varlist.lv_lock = VAR_FIXED;
1364
1365 /*
1366 * Set a:firstline to "firstline" and a:lastline to "lastline".
1367 * Set a:name to named arguments.
1368 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001369 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001370 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001371 if ((fp->uf_flags & FC_NOARGS) == 0)
1372 {
1373 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001374 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001375 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001376 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001377 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001378 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379 {
1380 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001381 typval_T def_rettv;
1382 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383
1384 ai = i - fp->uf_args.ga_len;
1385 if (ai < 0)
1386 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001387 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001388 name = FUNCARG(fp, i);
1389 if (islambda)
1390 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001391
1392 // evaluate named argument default expression
1393 isdefault = ai + fp->uf_def_args.ga_len >= 0
1394 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1395 && argvars[i].vval.v_number == VVAL_NONE));
1396 if (isdefault)
1397 {
1398 char_u *default_expr = NULL;
1399 def_rettv.v_type = VAR_NUMBER;
1400 def_rettv.vval.v_number = -1;
1401
1402 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1403 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001404 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001405 {
1406 default_arg_err = 1;
1407 break;
1408 }
1409 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001410 }
1411 else
1412 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001413 if ((fp->uf_flags & FC_NOARGS) != 0)
1414 // Bail out if no a: arguments used (in lambda).
1415 break;
1416
Bram Moolenaare38eab22019-12-05 21:50:01 +01001417 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418 sprintf((char *)numbuf, "%d", ai + 1);
1419 name = numbuf;
1420 }
1421 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1422 {
1423 v = &fc->fixvar[fixvar_idx++].var;
1424 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001425 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001426 }
1427 else
1428 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001429 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001430 if (v == NULL)
1431 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001432 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001435 // Note: the values are copied directly to avoid alloc/free.
1436 // "argvars" must have VAR_FIXED for v_lock.
1437 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438 v->di_tv.v_lock = VAR_FIXED;
1439
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 if (addlocal)
1441 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001442 // Named arguments should be accessed without the "a:" prefix in
1443 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001444 copy_tv(&v->di_tv, &v->di_tv);
1445 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001446 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001447 else
1448 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001449
1450 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1451 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001452 listitem_T *li = &fc->l_listitems[ai];
1453
1454 li->li_tv = argvars[i];
1455 li->li_tv.v_lock = VAR_FIXED;
1456 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457 }
1458 }
1459
Bram Moolenaare38eab22019-12-05 21:50:01 +01001460 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001461 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001462
1463 if (fp->uf_flags & FC_SANDBOX)
1464 {
1465 using_sandbox = TRUE;
1466 ++sandbox;
1467 }
1468
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001469 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001470 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001471 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001472 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001473 ++no_wait_return;
1474 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001476 smsg(_("calling %s"), SOURCING_NAME);
1477 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001479 char_u buf[MSG_BUF_LEN];
1480 char_u numbuf2[NUMBUFLEN];
1481 char_u *tofree;
1482 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001484 msg_puts("(");
1485 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001487 if (i > 0)
1488 msg_puts(", ");
1489 if (argvars[i].v_type == VAR_NUMBER)
1490 msg_outnum((long)argvars[i].vval.v_number);
1491 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001493 // Do not want errors such as E724 here.
1494 ++emsg_off;
1495 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1496 --emsg_off;
1497 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001499 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001501 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1502 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001503 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001504 msg_puts((char *)s);
1505 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001506 }
1507 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001509 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001510 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001511 msg_puts("\n"); // don't overwrite this either
1512
1513 verbose_leave_scroll();
1514 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 }
1516#ifdef FEAT_PROFILE
1517 if (do_profiling == PROF_YES)
1518 {
1519 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001520 {
1521 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001523 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524 if (fp->uf_profiling
1525 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1526 {
1527 ++fp->uf_tm_count;
1528 profile_start(&call_start);
1529 profile_zero(&fp->uf_tm_children);
1530 }
1531 script_prof_save(&wait_start);
1532 }
1533#endif
1534
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001535 save_current_sctx = current_sctx;
1536 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 save_did_emsg = did_emsg;
1538 did_emsg = FALSE;
1539
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001540 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1541 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001542 else if (islambda)
1543 {
1544 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1545
1546 // A Lambda always has the command "return {expr}". It is much faster
1547 // to evaluate {expr} directly.
1548 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001549 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001550 --ex_nesting_level;
1551 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001552 else
1553 // call do_cmdline() to execute the lines
1554 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001555 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1556
1557 --RedrawingDisabled;
1558
Bram Moolenaare38eab22019-12-05 21:50:01 +01001559 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001560 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1561 {
1562 clear_tv(rettv);
1563 rettv->v_type = VAR_NUMBER;
1564 rettv->vval.v_number = -1;
1565 }
1566
1567#ifdef FEAT_PROFILE
1568 if (do_profiling == PROF_YES && (fp->uf_profiling
1569 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1570 {
1571 profile_end(&call_start);
1572 profile_sub_wait(&wait_start, &call_start);
1573 profile_add(&fp->uf_tm_total, &call_start);
1574 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1575 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1576 {
1577 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1578 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1579 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001580 if (started_profiling)
1581 // make a ":profdel func" stop profiling the function
1582 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583 }
1584#endif
1585
Bram Moolenaare38eab22019-12-05 21:50:01 +01001586 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001587 if (p_verbose >= 12)
1588 {
1589 ++no_wait_return;
1590 verbose_enter_scroll();
1591
1592 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001593 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001595 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596 (long)fc->rettv->vval.v_number);
1597 else
1598 {
1599 char_u buf[MSG_BUF_LEN];
1600 char_u numbuf2[NUMBUFLEN];
1601 char_u *tofree;
1602 char_u *s;
1603
Bram Moolenaare38eab22019-12-05 21:50:01 +01001604 // The value may be very long. Skip the middle part, so that we
1605 // have some idea how it starts and ends. smsg() would always
1606 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607 ++emsg_off;
1608 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1609 --emsg_off;
1610 if (s != NULL)
1611 {
1612 if (vim_strsize(s) > MSG_BUF_CLEN)
1613 {
1614 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1615 s = buf;
1616 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001617 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618 vim_free(tofree);
1619 }
1620 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001621 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622
1623 verbose_leave_scroll();
1624 --no_wait_return;
1625 }
1626
Bram Moolenaare31ee862020-01-07 20:59:34 +01001627 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001628 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001629 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630#ifdef FEAT_PROFILE
1631 if (do_profiling == PROF_YES)
1632 script_prof_restore(&wait_start);
1633#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001634 if (using_sandbox)
1635 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001637 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001638 {
1639 ++no_wait_return;
1640 verbose_enter_scroll();
1641
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001642 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001643 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644
1645 verbose_leave_scroll();
1646 --no_wait_return;
1647 }
1648
1649 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 --depth;
1651
Bram Moolenaar6914c642017-04-01 21:21:30 +02001652 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653}
1654
1655/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001656 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001657 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001658 int
1659call_user_func_check(
1660 ufunc_T *fp,
1661 int argcount,
1662 typval_T *argvars,
1663 typval_T *rettv,
1664 funcexe_T *funcexe,
1665 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001666{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001667 int error;
1668 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001669
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001670 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1671 *funcexe->doesrange = TRUE;
1672 if (argcount < regular_args - fp->uf_def_args.ga_len)
1673 error = FCERR_TOOFEW;
1674 else if (!has_varargs(fp) && argcount > regular_args)
1675 error = FCERR_TOOMANY;
1676 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1677 error = FCERR_DICT;
1678 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001679 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001680 int did_save_redo = FALSE;
1681 save_redo_T save_redo;
1682
1683 /*
1684 * Call the user function.
1685 * Save and restore search patterns, script variables and
1686 * redo buffer.
1687 */
1688 save_search_patterns();
1689 if (!ins_compl_active())
1690 {
1691 saveRedobuff(&save_redo);
1692 did_save_redo = TRUE;
1693 }
1694 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001695 call_user_func(fp, argcount, argvars, rettv, funcexe,
1696 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001697 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1698 // Function was unreferenced while being used, free it now.
1699 func_clear_free(fp, FALSE);
1700 if (did_save_redo)
1701 restoreRedobuff(&save_redo);
1702 restore_search_patterns();
1703 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001704 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001705 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001706}
1707
1708/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001709 * There are two kinds of function names:
1710 * 1. ordinary names, function defined with :function
1711 * 2. numbered functions and lambdas
1712 * For the first we only count the name stored in func_hashtab as a reference,
1713 * using function() does not count as a reference, because the function is
1714 * looked up by name.
1715 */
1716 static int
1717func_name_refcount(char_u *name)
1718{
1719 return isdigit(*name) || *name == '<';
1720}
1721
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001722static funccal_entry_T *funccal_stack = NULL;
1723
1724/*
1725 * Save the current function call pointer, and set it to NULL.
1726 * Used when executing autocommands and for ":source".
1727 */
1728 void
1729save_funccal(funccal_entry_T *entry)
1730{
1731 entry->top_funccal = current_funccal;
1732 entry->next = funccal_stack;
1733 funccal_stack = entry;
1734 current_funccal = NULL;
1735}
1736
1737 void
1738restore_funccal(void)
1739{
1740 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001741 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001742 else
1743 {
1744 current_funccal = funccal_stack->top_funccal;
1745 funccal_stack = funccal_stack->next;
1746 }
1747}
1748
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001749 funccall_T *
1750get_current_funccal(void)
1751{
1752 return current_funccal;
1753}
1754
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001755/*
1756 * Mark all functions of script "sid" as deleted.
1757 */
1758 void
1759delete_script_functions(int sid)
1760{
1761 hashitem_T *hi;
1762 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001763 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001764 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001765 size_t len;
1766
1767 buf[0] = K_SPECIAL;
1768 buf[1] = KS_EXTRA;
1769 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001770 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001771 len = STRLEN(buf);
1772
Bram Moolenaarce658352020-07-31 23:47:12 +02001773 while (todo > 0)
1774 {
1775 todo = func_hashtab.ht_used;
1776 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1777 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001778 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001779 fp = HI2UF(hi);
1780 if (STRNCMP(fp->uf_name, buf, len) == 0)
1781 {
1782 int changed = func_hashtab.ht_changed;
1783
1784 fp->uf_flags |= FC_DEAD;
1785 func_clear(fp, TRUE);
1786 // When clearing a function another function can be cleared
1787 // as a side effect. When that happens start over.
1788 if (changed != func_hashtab.ht_changed)
1789 break;
1790 }
1791 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001792 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001793 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001794}
1795
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796#if defined(EXITFREE) || defined(PROTO)
1797 void
1798free_all_functions(void)
1799{
1800 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001801 ufunc_T *fp;
1802 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001803 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001804 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805
Bram Moolenaare38eab22019-12-05 21:50:01 +01001806 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001807 while (current_funccal != NULL)
1808 {
1809 clear_tv(current_funccal->rettv);
1810 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001811 if (current_funccal == NULL && funccal_stack != NULL)
1812 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001813 }
1814
Bram Moolenaare38eab22019-12-05 21:50:01 +01001815 // First clear what the functions contain. Since this may lower the
1816 // reference count of a function, it may also free a function and change
1817 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001818 while (todo > 0)
1819 {
1820 todo = func_hashtab.ht_used;
1821 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1822 if (!HASHITEM_EMPTY(hi))
1823 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001824 // clear the def function index now
1825 fp = HI2UF(hi);
1826 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001827 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001828
Bram Moolenaare38eab22019-12-05 21:50:01 +01001829 // Only free functions that are not refcounted, those are
1830 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001831 if (func_name_refcount(fp->uf_name))
1832 ++skipped;
1833 else
1834 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001835 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001836 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001837 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001838 {
1839 skipped = 0;
1840 break;
1841 }
1842 }
1843 --todo;
1844 }
1845 }
1846
Bram Moolenaare38eab22019-12-05 21:50:01 +01001847 // Now actually free the functions. Need to start all over every time,
1848 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001849 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001850 while (func_hashtab.ht_used > skipped)
1851 {
1852 todo = func_hashtab.ht_used;
1853 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 if (!HASHITEM_EMPTY(hi))
1855 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001856 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001857 // Only free functions that are not refcounted, those are
1858 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001859 fp = HI2UF(hi);
1860 if (func_name_refcount(fp->uf_name))
1861 ++skipped;
1862 else
1863 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001864 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001865 skipped = 0;
1866 break;
1867 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001869 }
1870 if (skipped == 0)
1871 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001872
1873 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001874}
1875#endif
1876
1877/*
1878 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001879 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001880 * "len" is the length of "name", or -1 for NUL terminated.
1881 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001882 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001883builtin_function(char_u *name, int len)
1884{
1885 char_u *p;
1886
Bram Moolenaara26b9702020-04-18 19:53:28 +02001887 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001888 return FALSE;
1889 p = vim_strchr(name, AUTOLOAD_CHAR);
1890 return p == NULL || (len > 0 && p > name + len);
1891}
1892
1893 int
1894func_call(
1895 char_u *name,
1896 typval_T *args,
1897 partial_T *partial,
1898 dict_T *selfdict,
1899 typval_T *rettv)
1900{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001901 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 listitem_T *item;
1903 typval_T argv[MAX_FUNC_ARGS + 1];
1904 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001905 int r = 0;
1906
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001907 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001908 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909 {
1910 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1911 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001912 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001913 break;
1914 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001915 // Make a copy of each argument. This is needed to be able to set
1916 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 copy_tv(&item->li_tv, &argv[argc++]);
1918 }
1919
1920 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001921 {
1922 funcexe_T funcexe;
1923
Bram Moolenaara80faa82020-04-12 19:37:17 +02001924 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001925 funcexe.firstline = curwin->w_cursor.lnum;
1926 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001927 funcexe.evaluate = TRUE;
1928 funcexe.partial = partial;
1929 funcexe.selfdict = selfdict;
1930 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1931 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001932
Bram Moolenaare38eab22019-12-05 21:50:01 +01001933 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001934 while (argc > 0)
1935 clear_tv(&argv[--argc]);
1936
1937 return r;
1938}
1939
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001940static int callback_depth = 0;
1941
1942 int
1943get_callback_depth(void)
1944{
1945 return callback_depth;
1946}
1947
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001948/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001949 * Invoke call_func() with a callback.
1950 */
1951 int
1952call_callback(
1953 callback_T *callback,
1954 int len, // length of "name" or -1 to use strlen()
1955 typval_T *rettv, // return value goes here
1956 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001957 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001958 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001959{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001960 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001961 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001962
Bram Moolenaara80faa82020-04-12 19:37:17 +02001963 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001964 funcexe.evaluate = TRUE;
1965 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001966 ++callback_depth;
1967 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1968 --callback_depth;
1969 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001970}
1971
1972/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001973 * Give an error message for the result of a function.
1974 * Nothing if "error" is FCERR_NONE.
1975 */
1976 void
1977user_func_error(int error, char_u *name)
1978{
1979 switch (error)
1980 {
1981 case FCERR_UNKNOWN:
1982 emsg_funcname(e_unknownfunc, name);
1983 break;
1984 case FCERR_NOTMETHOD:
1985 emsg_funcname(
1986 N_("E276: Cannot use function as a method: %s"), name);
1987 break;
1988 case FCERR_DELETED:
1989 emsg_funcname(N_(e_func_deleted), name);
1990 break;
1991 case FCERR_TOOMANY:
1992 emsg_funcname((char *)e_toomanyarg, name);
1993 break;
1994 case FCERR_TOOFEW:
1995 emsg_funcname((char *)e_toofewarg, name);
1996 break;
1997 case FCERR_SCRIPT:
1998 emsg_funcname(
1999 N_("E120: Using <SID> not in a script context: %s"), name);
2000 break;
2001 case FCERR_DICT:
2002 emsg_funcname(
2003 N_("E725: Calling dict function without Dictionary: %s"),
2004 name);
2005 break;
2006 }
2007}
2008
2009/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002010 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002011 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002012 * Return FAIL when the function can't be called, OK otherwise.
2013 * Also returns OK when an error was encountered while executing the function.
2014 */
2015 int
2016call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002017 char_u *funcname, // name of the function
2018 int len, // length of "name" or -1 to use strlen()
2019 typval_T *rettv, // return value goes here
2020 int argcount_in, // number of "argvars"
2021 typval_T *argvars_in, // vars for arguments, must have "argcount"
2022 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002023 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002024{
2025 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002026 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002027 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002028 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002029 char_u fname_buf[FLEN_FIXED + 1];
2030 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002031 char_u *fname = NULL;
2032 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002033 int argcount = argcount_in;
2034 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002035 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002036 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2037 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002038 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002039 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002040 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002041
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002042 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2043 // even when call_func() returns FAIL.
2044 rettv->v_type = VAR_UNKNOWN;
2045
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002046 if (partial != NULL)
2047 fp = partial->pt_func;
2048 if (fp == NULL)
2049 {
2050 // Make a copy of the name, if it comes from a funcref variable it
2051 // could be changed or deleted in the called function.
2052 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2053 if (name == NULL)
2054 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002055
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002056 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2057 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002058
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002059 if (funcexe->doesrange != NULL)
2060 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002061
2062 if (partial != NULL)
2063 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002064 // When the function has a partial with a dict and there is a dict
2065 // argument, use the dict argument. That is backwards compatible.
2066 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002067 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002068 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002069 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002070 {
2071 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002072 {
2073 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2074 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002075 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002076 goto theend;
2077 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002079 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002080 for (i = 0; i < argcount_in; ++i)
2081 argv[i + argv_clear] = argvars_in[i];
2082 argvars = argv;
2083 argcount = partial->pt_argc + argcount_in;
2084 }
2085 }
2086
Bram Moolenaaref140542019-12-31 21:27:13 +01002087 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002088 {
2089 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002090 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002091
Bram Moolenaar333894b2020-08-01 18:53:07 +02002092 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002093 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002094 {
2095 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002096 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002097 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002098
Bram Moolenaare38eab22019-12-05 21:50:01 +01002099 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002100 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002101 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002103 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104 {
2105 /*
2106 * User defined function.
2107 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002108 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002109 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110
Bram Moolenaare38eab22019-12-05 21:50:01 +01002111 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112 if (fp == NULL
2113 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002114 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002115 && !aborting())
2116 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002117 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002118 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002119 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002120 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002121 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2122 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002123 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002124 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002126 if (fp == NULL)
2127 {
2128 char_u *p = untrans_function_name(rfname);
2129
2130 // If using Vim9 script try not local to the script.
2131 // TODO: should not do this if the name started with "s:".
2132 if (p != NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002133 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002134 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002135
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002136 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002137 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002138#ifdef FEAT_LUA
2139 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2140 {
2141 cfunc_T cb = fp->uf_cb;
2142
2143 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2144 }
2145#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002146 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002147 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002148 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002149 // postponed filling in the arguments, do it now
2150 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002151 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002152
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002153 if (funcexe->basetv != NULL)
2154 {
2155 // Method call: base->Method()
2156 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2157 argv[0] = *funcexe->basetv;
2158 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002159 argvars = argv;
2160 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002161 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002162
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002163 error = call_user_func_check(fp, argcount, argvars, rettv,
2164 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002165 }
2166 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002167 else if (funcexe->basetv != NULL)
2168 {
2169 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002170 * expr->method(): Find the method name in the table, call its
2171 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002172 */
2173 error = call_internal_method(fname, argcount, argvars, rettv,
2174 funcexe->basetv);
2175 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 else
2177 {
2178 /*
2179 * Find the function name in the table, call its implementation.
2180 */
2181 error = call_internal_func(fname, argcount, argvars, rettv);
2182 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002183
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184 /*
2185 * The function call (or "FuncUndefined" autocommand sequence) might
2186 * have been aborted by an error, an interrupt, or an explicitly thrown
2187 * exception that has not been caught so far. This situation can be
2188 * tested for by calling aborting(). For an error in an internal
2189 * function or for the "E132" error in call_user_func(), however, the
2190 * throw point at which the "force_abort" flag (temporarily reset by
2191 * emsg()) is normally updated has not been reached yet. We need to
2192 * update that flag first to make aborting() reliable.
2193 */
2194 update_force_abort();
2195 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002196 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002197 ret = OK;
2198
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002199theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002200 /*
2201 * Report an error unless the argument evaluation or function call has been
2202 * cancelled due to an aborting error, an interrupt, or an exception.
2203 */
2204 if (!aborting())
2205 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002206 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002207 }
2208
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002209 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002210 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002211 clear_tv(&argv[--argv_clear + argv_base]);
2212
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002213 vim_free(tofree);
2214 vim_free(name);
2215
2216 return ret;
2217}
2218
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002219 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002220printable_func_name(ufunc_T *fp)
2221{
2222 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2223}
2224
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002225/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002226 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002227 */
2228 static void
2229list_func_head(ufunc_T *fp, int indent)
2230{
2231 int j;
2232
2233 msg_start();
2234 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002235 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002236 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002237 msg_puts("def ");
2238 else
2239 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002240 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 msg_putchar('(');
2242 for (j = 0; j < fp->uf_args.ga_len; ++j)
2243 {
2244 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002245 msg_puts(", ");
2246 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002247 if (fp->uf_arg_types != NULL)
2248 {
2249 char *tofree;
2250
2251 msg_puts(": ");
2252 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2253 vim_free(tofree);
2254 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002255 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2256 {
2257 msg_puts(" = ");
2258 msg_puts(((char **)(fp->uf_def_args.ga_data))
2259 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2260 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002261 }
2262 if (fp->uf_varargs)
2263 {
2264 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002265 msg_puts(", ");
2266 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002267 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002268 if (fp->uf_va_name != NULL)
2269 {
2270 if (j)
2271 msg_puts(", ");
2272 msg_puts("...");
2273 msg_puts((char *)fp->uf_va_name);
2274 if (fp->uf_va_type)
2275 {
2276 char *tofree;
2277
2278 msg_puts(": ");
2279 msg_puts(type_name(fp->uf_va_type, &tofree));
2280 vim_free(tofree);
2281 }
2282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002284
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002285 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002286 {
2287 if (fp->uf_ret_type != &t_void)
2288 {
2289 char *tofree;
2290
2291 msg_puts(": ");
2292 msg_puts(type_name(fp->uf_ret_type, &tofree));
2293 vim_free(tofree);
2294 }
2295 }
2296 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002297 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002299 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002300 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002301 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002302 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002303 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002304 msg_clr_eos();
2305 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002306 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002307}
2308
2309/*
2310 * Get a function name, translating "<SID>" and "<SNR>".
2311 * Also handles a Funcref in a List or Dictionary.
2312 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002313 * Set "*is_global" to TRUE when the function must be global, unless
2314 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002315 * flags:
2316 * TFN_INT: internal function name OK
2317 * TFN_QUIET: be quiet
2318 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002319 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320 * Advances "pp" to just after the function name (if no error).
2321 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002322 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002323trans_function_name(
2324 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002325 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002326 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002328 funcdict_T *fdp, // return: info about dictionary used
2329 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002330{
2331 char_u *name = NULL;
2332 char_u *start;
2333 char_u *end;
2334 int lead;
2335 char_u sid_buf[20];
2336 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002337 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002338 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002339 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340
2341 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002342 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 start = *pp;
2344
Bram Moolenaare38eab22019-12-05 21:50:01 +01002345 // Check for hard coded <SNR>: already translated function ID (from a user
2346 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2348 && (*pp)[2] == (int)KE_SNR)
2349 {
2350 *pp += 3;
2351 len = get_id_len(pp) + 3;
2352 return vim_strnsave(start, len);
2353 }
2354
Bram Moolenaare38eab22019-12-05 21:50:01 +01002355 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2356 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002357 lead = eval_fname_script(start);
2358 if (lead > 2)
2359 start += lead;
2360
Bram Moolenaare38eab22019-12-05 21:50:01 +01002361 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002362 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 lead > 2 ? 0 : FNE_CHECK_START);
2364 if (end == start)
2365 {
2366 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002367 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002368 goto theend;
2369 }
2370 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2371 {
2372 /*
2373 * Report an invalid expression in braces, unless the expression
2374 * evaluation has been cancelled due to an aborting error, an
2375 * interrupt, or an exception.
2376 */
2377 if (!aborting())
2378 {
2379 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002380 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381 }
2382 else
2383 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2384 goto theend;
2385 }
2386
2387 if (lv.ll_tv != NULL)
2388 {
2389 if (fdp != NULL)
2390 {
2391 fdp->fd_dict = lv.ll_dict;
2392 fdp->fd_newkey = lv.ll_newkey;
2393 lv.ll_newkey = NULL;
2394 fdp->fd_di = lv.ll_di;
2395 }
2396 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2397 {
2398 name = vim_strsave(lv.ll_tv->vval.v_string);
2399 *pp = end;
2400 }
2401 else if (lv.ll_tv->v_type == VAR_PARTIAL
2402 && lv.ll_tv->vval.v_partial != NULL)
2403 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002404 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405 *pp = end;
2406 if (partial != NULL)
2407 *partial = lv.ll_tv->vval.v_partial;
2408 }
2409 else
2410 {
2411 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2412 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002413 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002414 else
2415 *pp = end;
2416 name = NULL;
2417 }
2418 goto theend;
2419 }
2420
2421 if (lv.ll_name == NULL)
2422 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002423 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 *pp = end;
2425 goto theend;
2426 }
2427
Bram Moolenaare38eab22019-12-05 21:50:01 +01002428 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 if (lv.ll_exp_name != NULL)
2430 {
2431 len = (int)STRLEN(lv.ll_exp_name);
2432 name = deref_func_name(lv.ll_exp_name, &len, partial,
2433 flags & TFN_NO_AUTOLOAD);
2434 if (name == lv.ll_exp_name)
2435 name = NULL;
2436 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002437 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438 {
2439 len = (int)(end - *pp);
2440 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2441 if (name == *pp)
2442 name = NULL;
2443 }
2444 if (name != NULL)
2445 {
2446 name = vim_strsave(name);
2447 *pp = end;
2448 if (STRNCMP(name, "<SNR>", 5) == 0)
2449 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002450 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451 name[0] = K_SPECIAL;
2452 name[1] = KS_EXTRA;
2453 name[2] = (int)KE_SNR;
2454 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2455 }
2456 goto theend;
2457 }
2458
2459 if (lv.ll_exp_name != NULL)
2460 {
2461 len = (int)STRLEN(lv.ll_exp_name);
2462 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2463 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2464 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002465 // When there was "s:" already or the name expanded to get a
2466 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 lv.ll_name += 2;
2468 len -= 2;
2469 lead = 2;
2470 }
2471 }
2472 else
2473 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002474 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002476 {
2477 if (is_global != NULL && lv.ll_name[0] == 'g')
2478 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002480 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 len = (int)(end - lv.ll_name);
2482 }
2483
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002484 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002485 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002486
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 /*
2488 * Copy the function name to allocated memory.
2489 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2490 * Accept <SNR>123_name() outside a script.
2491 */
2492 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002493 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002494 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002496 if (!vim9script)
2497 lead = 3;
2498 if (vim9script || (lv.ll_exp_name != NULL
2499 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002500 || eval_fname_sid(*pp))
2501 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002502 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002503 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002505 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 goto theend;
2507 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002508 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002509 if (vim9script)
2510 extra = 3 + (int)STRLEN(sid_buf);
2511 else
2512 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513 }
2514 }
2515 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2516 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002517 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 start);
2519 goto theend;
2520 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002521 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 {
2523 char_u *cp = vim_strchr(lv.ll_name, ':');
2524
2525 if (cp != NULL && cp < end)
2526 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002527 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 goto theend;
2529 }
2530 }
2531
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002532 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 if (name != NULL)
2534 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002535 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 {
2537 name[0] = K_SPECIAL;
2538 name[1] = KS_EXTRA;
2539 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002540 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 STRCPY(name + 3, sid_buf);
2542 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002543 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2544 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002545 }
2546 *pp = end;
2547
2548theend:
2549 clear_lval(&lv);
2550 return name;
2551}
2552
2553/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002554 * Assuming "name" is the result of trans_function_name() and it was prefixed
2555 * to use the script-local name, return the unmodified name (points into
2556 * "name"). Otherwise return NULL.
2557 * This can be used to first search for a script-local function and fall back
2558 * to the global function if not found.
2559 */
2560 char_u *
2561untrans_function_name(char_u *name)
2562{
2563 char_u *p;
2564
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002565 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002566 {
2567 p = vim_strchr(name, '_');
2568 if (p != NULL)
2569 return p + 1;
2570 }
2571 return NULL;
2572}
2573
2574/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002575 * List functions. When "regmatch" is NULL all of then.
2576 * Otherwise functions matching "regmatch".
2577 */
2578 static void
2579list_functions(regmatch_T *regmatch)
2580{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002581 int changed = func_hashtab.ht_changed;
2582 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002583 hashitem_T *hi;
2584
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002585 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002586 {
2587 if (!HASHITEM_EMPTY(hi))
2588 {
2589 ufunc_T *fp = HI2UF(hi);
2590
2591 --todo;
2592 if ((fp->uf_flags & FC_DEAD) == 0
2593 && (regmatch == NULL
2594 ? !message_filtered(fp->uf_name)
2595 && !func_name_refcount(fp->uf_name)
2596 : !isdigit(*fp->uf_name)
2597 && vim_regexec(regmatch, fp->uf_name, 0)))
2598 {
2599 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002600 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002601 {
2602 emsg(_("E454: function list was modified"));
2603 return;
2604 }
2605 }
2606 }
2607 }
2608}
2609
2610/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002611 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002612 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2613 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002614 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002616 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002617def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618{
2619 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002620 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 int j;
2622 int c;
2623 int saved_did_emsg;
2624 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002625 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002626 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002627 char_u *p;
2628 char_u *arg;
2629 char_u *line_arg = NULL;
2630 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002631 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002632 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 garray_T newlines;
2634 int varargs = FALSE;
2635 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002636 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002637 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002638 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 int indent;
2640 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002641#define MAX_FUNC_NESTING 50
2642 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 dictitem_T *v;
2644 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002645 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002648 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002649 linenr_T sourcing_lnum_off;
2650 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002651 int is_heredoc = FALSE;
2652 char_u *skip_until = NULL;
2653 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002654 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002655 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656
2657 /*
2658 * ":function" without argument: list functions.
2659 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002660 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 {
2662 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002663 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002665 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 }
2667
2668 /*
2669 * ":function /pat": list functions matching pattern.
2670 */
2671 if (*eap->arg == '/')
2672 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002673 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 if (!eap->skip)
2675 {
2676 regmatch_T regmatch;
2677
2678 c = *p;
2679 *p = NUL;
2680 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2681 *p = c;
2682 if (regmatch.regprog != NULL)
2683 {
2684 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002685 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 vim_regfree(regmatch.regprog);
2687 }
2688 }
2689 if (*p == '/')
2690 ++p;
2691 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002692 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 }
2694
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002695 ga_init(&newargs);
2696 ga_init(&argtypes);
2697 ga_init(&default_args);
2698
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 /*
2700 * Get the function name. There are these situations:
2701 * func normal function name
2702 * "name" == func, "fudi.fd_dict" == NULL
2703 * dict.func new dictionary entry
2704 * "name" == NULL, "fudi.fd_dict" set,
2705 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2706 * dict.func existing dict entry with a Funcref
2707 * "name" == func, "fudi.fd_dict" set,
2708 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2709 * dict.func existing dict entry that's not a Funcref
2710 * "name" == NULL, "fudi.fd_dict" set,
2711 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2712 * s:func script-local function name
2713 * g:func global function name, same as "func"
2714 */
2715 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002716 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002718 // nested function, argument is (args).
2719 paren = TRUE;
2720 CLEAR_FIELD(fudi);
2721 }
2722 else
2723 {
2724 name = trans_function_name(&p, &is_global, eap->skip,
2725 TFN_NO_AUTOLOAD, &fudi, NULL);
2726 paren = (vim_strchr(p, '(') != NULL);
2727 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002729 /*
2730 * Return on an invalid expression in braces, unless the expression
2731 * evaluation has been cancelled due to an aborting error, an
2732 * interrupt, or an exception.
2733 */
2734 if (!aborting())
2735 {
2736 if (!eap->skip && fudi.fd_newkey != NULL)
2737 semsg(_(e_dictkey), fudi.fd_newkey);
2738 vim_free(fudi.fd_newkey);
2739 return NULL;
2740 }
2741 else
2742 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 }
2745
Bram Moolenaare38eab22019-12-05 21:50:01 +01002746 // An error in a function call during evaluation of an expression in magic
2747 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 saved_did_emsg = did_emsg;
2749 did_emsg = FALSE;
2750
2751 /*
2752 * ":function func" with only function name: list function.
2753 */
2754 if (!paren)
2755 {
2756 if (!ends_excmd(*skipwhite(p)))
2757 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002758 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002759 goto ret_free;
2760 }
2761 eap->nextcmd = check_nextcmd(p);
2762 if (eap->nextcmd != NULL)
2763 *p = NUL;
2764 if (!eap->skip && !got_int)
2765 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002766 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002767 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2768 {
2769 char_u *up = untrans_function_name(name);
2770
2771 // With Vim9 script the name was made script-local, if not
2772 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002773 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002774 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002775 }
2776
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 if (fp != NULL)
2778 {
2779 list_func_head(fp, TRUE);
2780 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2781 {
2782 if (FUNCLINE(fp, j) == NULL)
2783 continue;
2784 msg_putchar('\n');
2785 msg_outnum((long)(j + 1));
2786 if (j < 9)
2787 msg_putchar(' ');
2788 if (j < 99)
2789 msg_putchar(' ');
2790 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002791 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 ui_breakcheck();
2793 }
2794 if (!got_int)
2795 {
2796 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002797 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002798 msg_puts(" enddef");
2799 else
2800 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002801 }
2802 }
2803 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002804 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 }
2806 goto ret_free;
2807 }
2808
2809 /*
2810 * ":function name(arg1, arg2)" Define function.
2811 */
2812 p = skipwhite(p);
2813 if (*p != '(')
2814 {
2815 if (!eap->skip)
2816 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002817 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 goto ret_free;
2819 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002820 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 if (vim_strchr(p, '(') != NULL)
2822 p = vim_strchr(p, '(');
2823 }
2824 p = skipwhite(p + 1);
2825
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002826 // In Vim9 script only global functions can be redefined.
2827 if (vim9script && eap->forceit && !is_global)
2828 {
2829 emsg(_(e_nobang));
2830 goto ret_free;
2831 }
2832
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2834
Bram Moolenaar04b12692020-05-04 23:24:44 +02002835 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002837 // Check the name of the function. Unless it's a dictionary function
2838 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 if (name != NULL)
2840 arg = name;
2841 else
2842 arg = fudi.fd_newkey;
2843 if (arg != NULL && (fudi.fd_di == NULL
2844 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2845 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2846 {
2847 if (*arg == K_SPECIAL)
2848 j = 3;
2849 else
2850 j = 0;
2851 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2852 : eval_isnamec(arg[j])))
2853 ++j;
2854 if (arg[j] != NUL)
2855 emsg_funcname((char *)e_invarg2, arg);
2856 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002857 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002859 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 }
2861
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002862 // This may get more lines and make the pointers into the first line
2863 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002864 if (get_function_args(&p, ')', &newargs,
2865 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002866 &varargs, &default_args, eap->skip,
2867 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 goto errret_2;
2869
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002870 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002872 // find the return type: :def Func(): type
2873 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002875 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002876 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002877 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002878 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002879 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002880 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002881 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002882 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002883 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002884 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002885 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002886 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002888 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002890 else
2891 // find extra arguments "range", "dict", "abort" and "closure"
2892 for (;;)
2893 {
2894 p = skipwhite(p);
2895 if (STRNCMP(p, "range", 5) == 0)
2896 {
2897 flags |= FC_RANGE;
2898 p += 5;
2899 }
2900 else if (STRNCMP(p, "dict", 4) == 0)
2901 {
2902 flags |= FC_DICT;
2903 p += 4;
2904 }
2905 else if (STRNCMP(p, "abort", 5) == 0)
2906 {
2907 flags |= FC_ABORT;
2908 p += 5;
2909 }
2910 else if (STRNCMP(p, "closure", 7) == 0)
2911 {
2912 flags |= FC_CLOSURE;
2913 p += 7;
2914 if (current_funccal == NULL)
2915 {
2916 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2917 name == NULL ? (char_u *)"" : name);
2918 goto erret;
2919 }
2920 }
2921 else
2922 break;
2923 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924
Bram Moolenaare38eab22019-12-05 21:50:01 +01002925 // When there is a line break use what follows for the function body.
2926 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 if (*p == '\n')
2928 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002929 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002930 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2931 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002932 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2933 && !eap->skip
2934 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002935 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936
2937 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002938 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2939 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002940 */
2941 if (KeyTyped)
2942 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002943 // Check if the function already exists, don't let the user type the
2944 // whole function before telling him it doesn't work! For a script we
2945 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946 if (!eap->skip && !eap->forceit)
2947 {
2948 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002949 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002950 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 emsg_funcname(e_funcexts, name);
2952 }
2953
2954 if (!eap->skip && did_emsg)
2955 goto erret;
2956
Bram Moolenaare38eab22019-12-05 21:50:01 +01002957 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958 cmdline_row = msg_row;
2959 }
2960
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002961 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002962 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002963
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964 indent = 2;
2965 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002966 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967 for (;;)
2968 {
2969 if (KeyTyped)
2970 {
2971 msg_scroll = TRUE;
2972 saved_wait_return = FALSE;
2973 }
2974 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975
2976 if (line_arg != NULL)
2977 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002978 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002979 theline = line_arg;
2980 p = vim_strchr(theline, '\n');
2981 if (p == NULL)
2982 line_arg += STRLEN(line_arg);
2983 else
2984 {
2985 *p = NUL;
2986 line_arg = p + 1;
2987 }
2988 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02002990 {
2991 vim_free(line_to_free);
2992 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02002993 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002994 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02002995 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002996 line_to_free = theline;
2997 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 if (KeyTyped)
2999 lines_left = Rows - 1;
3000 if (theline == NULL)
3001 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003002 if (eap->cmdidx == CMD_def)
3003 emsg(_("E1057: Missing :enddef"));
3004 else
3005 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 goto erret;
3007 }
3008
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003009 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003010 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003011 if (SOURCING_LNUM < sourcing_lnum_off)
3012 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013 else
3014 sourcing_lnum_off = 0;
3015
3016 if (skip_until != NULL)
3017 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003019 // * ":append" and "."
3020 // * ":python <<EOF" and "EOF"
3021 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3022 if (heredoc_trimmed == NULL
3023 || (is_heredoc && skipwhite(theline) == theline)
3024 || STRNCMP(theline, heredoc_trimmed,
3025 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003026 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003027 if (heredoc_trimmed == NULL)
3028 p = theline;
3029 else if (is_heredoc)
3030 p = skipwhite(theline) == theline
3031 ? theline : theline + STRLEN(heredoc_trimmed);
3032 else
3033 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003034 if (STRCMP(p, skip_until) == 0)
3035 {
3036 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003037 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02003038 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003039 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003040 }
3041 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042 }
3043 else
3044 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003045 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003046 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 ;
3048
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003049 // Check for "endfunction" or "enddef".
3050 if (checkforcmd(&p, nesting_def[nesting]
3051 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003052 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003053 char_u *nextcmd = NULL;
3054
Bram Moolenaar663bb232017-06-22 19:12:10 +02003055 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003056 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003057 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003058 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003059 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003060 give_warning2(eap->cmdidx == CMD_def
3061 ? (char_u *)_("W1001: Text found after :enddef: %s")
3062 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003063 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003064 if (nextcmd != NULL)
3065 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003066 // Another command follows. If the line came from "eap" we
3067 // can simply point into it, otherwise we need to change
3068 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003069 eap->nextcmd = nextcmd;
3070 if (line_to_free != NULL)
3071 {
3072 vim_free(*eap->cmdlinep);
3073 *eap->cmdlinep = line_to_free;
3074 line_to_free = NULL;
3075 }
3076 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003077 break;
3078 }
3079
Bram Moolenaare38eab22019-12-05 21:50:01 +01003080 // Increase indent inside "if", "while", "for" and "try", decrease
3081 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003082 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003083 indent -= 2;
3084 else if (STRNCMP(p, "if", 2) == 0
3085 || STRNCMP(p, "wh", 2) == 0
3086 || STRNCMP(p, "for", 3) == 0
3087 || STRNCMP(p, "try", 3) == 0)
3088 indent += 2;
3089
Bram Moolenaare38eab22019-12-05 21:50:01 +01003090 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003091 // Only recognize "def" inside "def", not inside "function",
3092 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003093 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003094 if (checkforcmd(&p, "function", 2)
3095 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 {
3097 if (*p == '!')
3098 p = skipwhite(p + 1);
3099 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003100 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003101 if (*skipwhite(p) == '(')
3102 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003103 if (nesting == MAX_FUNC_NESTING - 1)
3104 emsg(_("E1058: function nesting too deep"));
3105 else
3106 {
3107 ++nesting;
3108 nesting_def[nesting] = (c == 'd');
3109 indent += 2;
3110 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 }
3112 }
3113
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003114 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003116 if (eap->cmdidx != CMD_def
3117 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003118 || (p[0] == 'c'
3119 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3120 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3121 && (STRNCMP(&p[3], "nge", 3) != 0
3122 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 || (p[0] == 'i'
3124 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003125 && (!ASCII_ISALPHA(p[2])
3126 || (p[2] == 's'
3127 && (!ASCII_ISALPHA(p[3])
3128 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 skip_until = vim_strsave((char_u *)".");
3130
Bram Moolenaare38eab22019-12-05 21:50:01 +01003131 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003132 arg = skipwhite(skiptowhite(p));
3133 if (arg[0] == '<' && arg[1] =='<'
3134 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003135 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3136 || ((p[2] == '3' || p[2] == 'x')
3137 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 || (p[0] == 'p' && p[1] == 'e'
3139 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3140 || (p[0] == 't' && p[1] == 'c'
3141 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3142 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3143 && !ASCII_ISALPHA(p[3]))
3144 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3145 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3146 || (p[0] == 'm' && p[1] == 'z'
3147 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3148 ))
3149 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003150 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003152 if (STRNCMP(p, "trim", 4) == 0)
3153 {
3154 // Ignore leading white space.
3155 p = skipwhite(p + 4);
3156 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003157 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003158 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159 if (*p == NUL)
3160 skip_until = vim_strsave((char_u *)".");
3161 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003162 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003163 do_concat = FALSE;
3164 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003166
3167 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003168 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003169 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003170 if (*arg == '[')
3171 arg = vim_strchr(arg, ']');
3172 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003173 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003174 arg = skipwhite(skiptowhite(arg));
3175 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3176 && ((p[0] == 'l'
3177 && p[1] == 'e'
3178 && (!ASCII_ISALNUM(p[2])
3179 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003180 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003181 p = skipwhite(arg + 3);
3182 if (STRNCMP(p, "trim", 4) == 0)
3183 {
3184 // Ignore leading white space.
3185 p = skipwhite(p + 4);
3186 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003187 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003188 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003189 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003190 do_concat = FALSE;
3191 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003192 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003193 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 }
3195
Bram Moolenaare38eab22019-12-05 21:50:01 +01003196 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003197 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003199
Bram Moolenaare38eab22019-12-05 21:50:01 +01003200 // Copy the line to newly allocated memory. get_one_sourceline()
3201 // allocates 250 bytes per line, this saves 80% on average. The cost
3202 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003204 if (p == NULL)
3205 goto erret;
3206 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207
Bram Moolenaare38eab22019-12-05 21:50:01 +01003208 // Add NULL lines for continuation lines, so that the line count is
3209 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 while (sourcing_lnum_off-- > 0)
3211 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3212
Bram Moolenaare38eab22019-12-05 21:50:01 +01003213 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214 if (line_arg != NULL && *line_arg == NUL)
3215 line_arg = NULL;
3216 }
3217
Bram Moolenaare38eab22019-12-05 21:50:01 +01003218 // Don't define the function when skipping commands or when an error was
3219 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220 if (eap->skip || did_emsg)
3221 goto erret;
3222
3223 /*
3224 * If there are no errors, add the function
3225 */
3226 if (fudi.fd_dict == NULL)
3227 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003228 hashtab_T *ht;
3229
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 v = find_var(name, &ht, FALSE);
3231 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3232 {
3233 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3234 name);
3235 goto erret;
3236 }
3237
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003238 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003239 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003240 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003241 char_u *uname = untrans_function_name(name);
3242
3243 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3244 }
3245
3246 if (fp != NULL || import != NULL)
3247 {
3248 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003249
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003250 // Function can be replaced with "function!" and when sourcing the
3251 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003252 // A name that is used by an import can not be overruled.
3253 if (import != NULL
3254 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003255 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003256 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003257 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003258 if (vim9script)
3259 emsg_funcname(e_already_defined, name);
3260 else
3261 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003262 goto erret;
3263 }
3264 if (fp->uf_calls > 0)
3265 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003266 emsg_funcname(
3267 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 name);
3269 goto erret;
3270 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003271 if (fp->uf_refcount > 1)
3272 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003273 // This function is referenced somewhere, don't redefine it but
3274 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003275 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003276 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003277 fp = NULL;
3278 overwrite = TRUE;
3279 }
3280 else
3281 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003282 char_u *exp_name = fp->uf_name_exp;
3283
3284 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003285 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003286 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003287 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003288 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003289 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003290#ifdef FEAT_PROFILE
3291 fp->uf_profiling = FALSE;
3292 fp->uf_prof_initialized = FALSE;
3293#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003294 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003295 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 }
3297 }
3298 else
3299 {
3300 char numbuf[20];
3301
3302 fp = NULL;
3303 if (fudi.fd_newkey == NULL && !eap->forceit)
3304 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003305 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 goto erret;
3307 }
3308 if (fudi.fd_di == NULL)
3309 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003310 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003311 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003312 goto erret;
3313 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003314 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003315 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 goto erret;
3317
Bram Moolenaare38eab22019-12-05 21:50:01 +01003318 // Give the function a sequential number. Can only be used with a
3319 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003320 vim_free(name);
3321 sprintf(numbuf, "%d", ++func_nr);
3322 name = vim_strsave((char_u *)numbuf);
3323 if (name == NULL)
3324 goto erret;
3325 }
3326
3327 if (fp == NULL)
3328 {
3329 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3330 {
3331 int slen, plen;
3332 char_u *scriptname;
3333
Bram Moolenaare38eab22019-12-05 21:50:01 +01003334 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003336 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337 {
3338 scriptname = autoload_name(name);
3339 if (scriptname != NULL)
3340 {
3341 p = vim_strchr(scriptname, '/');
3342 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003343 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003345 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 j = OK;
3347 vim_free(scriptname);
3348 }
3349 }
3350 if (j == FAIL)
3351 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003352 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 goto erret;
3354 }
3355 }
3356
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003357 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 if (fp == NULL)
3359 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003360 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003361 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362
3363 if (fudi.fd_dict != NULL)
3364 {
3365 if (fudi.fd_di == NULL)
3366 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003367 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3369 if (fudi.fd_di == NULL)
3370 {
3371 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003372 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 goto erret;
3374 }
3375 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3376 {
3377 vim_free(fudi.fd_di);
3378 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003379 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 goto erret;
3381 }
3382 }
3383 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003384 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385 clear_tv(&fudi.fd_di->di_tv);
3386 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388
Bram Moolenaare38eab22019-12-05 21:50:01 +01003389 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 flags |= FC_DICT;
3391 }
3392
Bram Moolenaare38eab22019-12-05 21:50:01 +01003393 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003394 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003395 if (overwrite)
3396 {
3397 hi = hash_find(&func_hashtab, name);
3398 hi->hi_key = UF2HIKEY(fp);
3399 }
3400 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401 {
3402 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003403 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 goto erret;
3405 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003406 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407 }
3408 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003409 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003410 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003411 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412
3413 if (eap->cmdidx == CMD_def)
3414 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003415 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003416
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003417 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003418
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003419 // error messages are for the first function line
3420 SOURCING_LNUM = sourcing_lnum_top;
3421
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003422 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003423 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003424
3425 if (argtypes.ga_len > 0)
3426 {
3427 // When "varargs" is set the last name/type goes into uf_va_name
3428 // and uf_va_type.
3429 int len = argtypes.ga_len - (varargs ? 1 : 0);
3430
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003431 if (len > 0)
3432 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003433 if (fp->uf_arg_types != NULL)
3434 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003435 int i;
3436 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003437
3438 for (i = 0; i < len; ++ i)
3439 {
3440 p = ((char_u **)argtypes.ga_data)[i];
3441 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003442 // will get the type from the default value
3443 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003444 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003445 type = parse_type(&p, &fp->uf_type_list);
3446 if (type == NULL)
3447 {
3448 SOURCING_LNUM = lnum_save;
3449 goto errret_2;
3450 }
3451 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452 }
3453 }
3454 if (varargs)
3455 {
3456 // Move the last argument "...name: type" to uf_va_name and
3457 // uf_va_type.
3458 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3459 [fp->uf_args.ga_len - 1];
3460 --fp->uf_args.ga_len;
3461 p = ((char_u **)argtypes.ga_data)[len];
3462 if (p == NULL)
3463 // todo: get type from default value
3464 fp->uf_va_type = &t_any;
3465 else
3466 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003467 if (fp->uf_va_type == NULL)
3468 {
3469 SOURCING_LNUM = lnum_save;
3470 goto errret_2;
3471 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003472 }
3473 varargs = FALSE;
3474 }
3475
3476 // parse the return type, if any
3477 if (ret_type == NULL)
3478 fp->uf_ret_type = &t_void;
3479 else
3480 {
3481 p = ret_type;
3482 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3483 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003484 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003485 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003486 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003487 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003488
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003490 if ((flags & FC_CLOSURE) != 0)
3491 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003492 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003493 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003494 }
3495 else
3496 fp->uf_scoped = NULL;
3497
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 if (prof_def_func())
3500 func_do_profile(fp);
3501#endif
3502 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003503 if (sandbox)
3504 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003505 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003506 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 fp->uf_flags = flags;
3508 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003509 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003510 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003511 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003512 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 if (is_export)
3514 {
3515 fp->uf_flags |= FC_EXPORT;
3516 // let ex_export() know the export worked.
3517 is_export = FALSE;
3518 }
3519
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003520 if (eap->cmdidx == CMD_def)
3521 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003522 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3523 // :func does not use Vim9 script syntax, even in a Vim9 script file
3524 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003525
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 goto ret_free;
3527
3528erret:
3529 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003530 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531errret_2:
3532 ga_clear_strings(&newlines);
3533ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003534 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003536 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003538 if (name != name_arg)
3539 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003540 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 did_emsg |= saved_did_emsg;
3542 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003543
3544 return fp;
3545}
3546
3547/*
3548 * ":function"
3549 */
3550 void
3551ex_function(exarg_T *eap)
3552{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003553 (void)def_function(eap, NULL);
3554}
3555
3556/*
3557 * :defcompile - compile all :def functions in the current script.
3558 */
3559 void
3560ex_defcompile(exarg_T *eap UNUSED)
3561{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003562 long todo = (long)func_hashtab.ht_used;
3563 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003564 hashitem_T *hi;
3565 ufunc_T *ufunc;
3566
3567 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3568 {
3569 if (!HASHITEM_EMPTY(hi))
3570 {
3571 --todo;
3572 ufunc = HI2UF(hi);
3573 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003574 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003575 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003576 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003577
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003578 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003579 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003580 // a function has been added or removed, need to start over
3581 todo = (long)func_hashtab.ht_used;
3582 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003583 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003584 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003585 }
3586 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003587 }
3588 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589}
3590
3591/*
3592 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3593 * Return 2 if "p" starts with "s:".
3594 * Return 0 otherwise.
3595 */
3596 int
3597eval_fname_script(char_u *p)
3598{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003599 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3600 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3602 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3603 return 5;
3604 if (p[0] == 's' && p[1] == ':')
3605 return 2;
3606 return 0;
3607}
3608
3609 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003610translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611{
3612 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003613 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003614 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003615}
3616
3617/*
3618 * Return TRUE when "ufunc" has old-style "..." varargs
3619 * or named varargs "...name: type".
3620 */
3621 int
3622has_varargs(ufunc_T *ufunc)
3623{
3624 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625}
3626
3627/*
3628 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003629 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 */
3631 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003632function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633{
3634 char_u *nm = name;
3635 char_u *p;
3636 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003637 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003638 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003640 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3641 if (no_deref)
3642 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003643 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644 nm = skipwhite(nm);
3645
Bram Moolenaare38eab22019-12-05 21:50:01 +01003646 // Only accept "funcname", "funcname ", "funcname (..." and
3647 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003649 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003650 vim_free(p);
3651 return n;
3652}
3653
Bram Moolenaar113e1072019-01-20 15:30:40 +01003654#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 char_u *
3656get_expanded_name(char_u *name, int check)
3657{
3658 char_u *nm = name;
3659 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003660 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003662 p = trans_function_name(&nm, &is_global, FALSE,
3663 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003665 if (p != NULL && *nm == NUL
3666 && (!check || translated_function_exists(p, is_global)))
3667 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668
3669 vim_free(p);
3670 return NULL;
3671}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003672#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674/*
3675 * Function given to ExpandGeneric() to obtain the list of user defined
3676 * function names.
3677 */
3678 char_u *
3679get_user_func_name(expand_T *xp, int idx)
3680{
3681 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003682 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 static hashitem_T *hi;
3684 ufunc_T *fp;
3685
3686 if (idx == 0)
3687 {
3688 done = 0;
3689 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003690 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003691 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003692 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 {
3694 if (done++ > 0)
3695 ++hi;
3696 while (HASHITEM_EMPTY(hi))
3697 ++hi;
3698 fp = HI2UF(hi);
3699
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003700 // don't show dead, dict and lambda functions
3701 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003702 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003703 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704
3705 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003706 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707
3708 cat_func_name(IObuff, fp);
3709 if (xp->xp_context != EXPAND_USER_FUNC)
3710 {
3711 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003712 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 STRCAT(IObuff, ")");
3714 }
3715 return IObuff;
3716 }
3717 return NULL;
3718}
3719
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720/*
3721 * ":delfunction {name}"
3722 */
3723 void
3724ex_delfunction(exarg_T *eap)
3725{
3726 ufunc_T *fp = NULL;
3727 char_u *p;
3728 char_u *name;
3729 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003730 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003731
3732 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003733 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003734 vim_free(fudi.fd_newkey);
3735 if (name == NULL)
3736 {
3737 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003738 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 return;
3740 }
3741 if (!ends_excmd(*skipwhite(p)))
3742 {
3743 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003744 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003745 return;
3746 }
3747 eap->nextcmd = check_nextcmd(p);
3748 if (eap->nextcmd != NULL)
3749 *p = NUL;
3750
3751 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003752 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 vim_free(name);
3754
3755 if (!eap->skip)
3756 {
3757 if (fp == NULL)
3758 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003759 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003760 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 return;
3762 }
3763 if (fp->uf_calls > 0)
3764 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003765 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 return;
3767 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003768 if (fp->uf_flags & FC_VIM9)
3769 {
3770 semsg(_("E1084: Cannot delete Vim9 script function %s"), eap->arg);
3771 return;
3772 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003773
3774 if (fudi.fd_dict != NULL)
3775 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003776 // Delete the dict item that refers to the function, it will
3777 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3779 }
3780 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003781 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003782 // A normal function (not a numbered function or lambda) has a
3783 // refcount of 1 for the entry in the hashtable. When deleting
3784 // it and the refcount is more than one, it should be kept.
3785 // A numbered function and lambda should be kept if the refcount is
3786 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003787 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003788 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003789 // Function is still referenced somewhere. Don't free it but
3790 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003791 if (func_remove(fp))
3792 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003793 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003794 }
3795 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003796 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003797 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 }
3799}
3800
3801/*
3802 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003803 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 */
3805 void
3806func_unref(char_u *name)
3807{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003808 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003810 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003812 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003813 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003816 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003818 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003820 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003822 // Only delete it when it's not being used. Otherwise it's done
3823 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003824 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003825 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003826 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003827}
3828
3829/*
3830 * Unreference a Function: decrement the reference count and free it when it
3831 * becomes zero.
3832 */
3833 void
3834func_ptr_unref(ufunc_T *fp)
3835{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003836 if (fp != NULL && --fp->uf_refcount <= 0)
3837 {
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 Moolenaar97baee82016-07-26 20:46:08 +02003840 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003841 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 }
3843}
3844
3845/*
3846 * Count a reference to a Function.
3847 */
3848 void
3849func_ref(char_u *name)
3850{
3851 ufunc_T *fp;
3852
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003853 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003854 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003855 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003856 if (fp != NULL)
3857 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003859 // Only give an error for a numbered function.
3860 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003861 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003862}
3863
3864/*
3865 * Count a reference to a Function.
3866 */
3867 void
3868func_ptr_ref(ufunc_T *fp)
3869{
3870 if (fp != NULL)
3871 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872}
3873
3874/*
3875 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3876 * referenced from anywhere that is in use.
3877 */
3878 static int
3879can_free_funccal(funccall_T *fc, int copyID)
3880{
3881 return (fc->l_varlist.lv_copyID != copyID
3882 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003883 && fc->l_avars.dv_copyID != copyID
3884 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885}
3886
3887/*
3888 * ":return [expr]"
3889 */
3890 void
3891ex_return(exarg_T *eap)
3892{
3893 char_u *arg = eap->arg;
3894 typval_T rettv;
3895 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003896 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897
3898 if (current_funccal == NULL)
3899 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003900 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901 return;
3902 }
3903
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003904 CLEAR_FIELD(evalarg);
3905 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3906
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907 if (eap->skip)
3908 ++emsg_skip;
3909
3910 eap->nextcmd = NULL;
3911 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003912 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913 {
3914 if (!eap->skip)
3915 returning = do_return(eap, FALSE, TRUE, &rettv);
3916 else
3917 clear_tv(&rettv);
3918 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003919 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 else if (!eap->skip)
3921 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003922 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003923 update_force_abort();
3924
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 /*
3926 * Return unless the expression evaluation has been cancelled due to an
3927 * aborting error, an interrupt, or an exception.
3928 */
3929 if (!aborting())
3930 returning = do_return(eap, FALSE, TRUE, NULL);
3931 }
3932
Bram Moolenaare38eab22019-12-05 21:50:01 +01003933 // When skipping or the return gets pending, advance to the next command
3934 // in this line (!returning). Otherwise, ignore the rest of the line.
3935 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 if (returning)
3937 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003938 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 eap->nextcmd = check_nextcmd(arg);
3940
3941 if (eap->skip)
3942 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003943 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944}
3945
3946/*
3947 * ":1,25call func(arg1, arg2)" function call.
3948 */
3949 void
3950ex_call(exarg_T *eap)
3951{
3952 char_u *arg = eap->arg;
3953 char_u *startarg;
3954 char_u *name;
3955 char_u *tofree;
3956 int len;
3957 typval_T rettv;
3958 linenr_T lnum;
3959 int doesrange;
3960 int failed = FALSE;
3961 funcdict_T fudi;
3962 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003963 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964
Bram Moolenaare6b53242020-07-01 17:28:33 +02003965 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 if (eap->skip)
3967 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003968 // trans_function_name() doesn't work well when skipping, use eval0()
3969 // instead to skip to any following command, e.g. for:
3970 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003972 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 clear_tv(&rettv);
3974 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003975 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003976 return;
3977 }
3978
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003979 tofree = trans_function_name(&arg, NULL, eap->skip,
3980 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 if (fudi.fd_newkey != NULL)
3982 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003983 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003984 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 vim_free(fudi.fd_newkey);
3986 }
3987 if (tofree == NULL)
3988 return;
3989
Bram Moolenaare38eab22019-12-05 21:50:01 +01003990 // Increase refcount on dictionary, it could get deleted when evaluating
3991 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003992 if (fudi.fd_dict != NULL)
3993 ++fudi.fd_dict->dv_refcount;
3994
Bram Moolenaare38eab22019-12-05 21:50:01 +01003995 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
3996 // contents. For VAR_PARTIAL get its partial, unless we already have one
3997 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 len = (int)STRLEN(tofree);
3999 name = deref_func_name(tofree, &len,
4000 partial != NULL ? NULL : &partial, FALSE);
4001
Bram Moolenaare38eab22019-12-05 21:50:01 +01004002 // Skip white space to allow ":call func ()". Not good, but required for
4003 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004005 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006
4007 if (*startarg != '(')
4008 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004009 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 goto end;
4011 }
4012
4013 /*
4014 * When skipping, evaluate the function once, to find the end of the
4015 * arguments.
4016 * When the function takes a range, this is discovered after the first
4017 * call, and the loop is broken.
4018 */
4019 if (eap->skip)
4020 {
4021 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004022 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 }
4024 else
4025 lnum = eap->line1;
4026 for ( ; lnum <= eap->line2; ++lnum)
4027 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004028 funcexe_T funcexe;
4029
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 if (!eap->skip && eap->addr_count > 0)
4031 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004032 if (lnum > curbuf->b_ml.ml_line_count)
4033 {
4034 // If the function deleted lines or switched to another buffer
4035 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004036 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004037 break;
4038 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 curwin->w_cursor.lnum = lnum;
4040 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 }
4043 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004044
Bram Moolenaara80faa82020-04-12 19:37:17 +02004045 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004046 funcexe.firstline = eap->line1;
4047 funcexe.lastline = eap->line2;
4048 funcexe.doesrange = &doesrange;
4049 funcexe.evaluate = !eap->skip;
4050 funcexe.partial = partial;
4051 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004052 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 {
4054 failed = TRUE;
4055 break;
4056 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004057 if (has_watchexpr())
4058 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004060 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004061 if (handle_subscript(&arg, &rettv,
4062 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 {
4064 failed = TRUE;
4065 break;
4066 }
4067
4068 clear_tv(&rettv);
4069 if (doesrange || eap->skip)
4070 break;
4071
Bram Moolenaare38eab22019-12-05 21:50:01 +01004072 // Stop when immediately aborting on error, or when an interrupt
4073 // occurred or an exception was thrown but not caught.
4074 // get_func_tv() returned OK, so that the check for trailing
4075 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 if (aborting())
4077 break;
4078 }
4079 if (eap->skip)
4080 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004081 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082
Bram Moolenaare51bb172020-02-16 19:42:23 +01004083 // When inside :try we need to check for following "| catch".
4084 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004086 // Check for trailing illegal characters and a following command.
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004087 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004089 if (!failed)
4090 {
4091 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004092 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004093 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094 }
4095 else
4096 eap->nextcmd = check_nextcmd(arg);
4097 }
4098
4099end:
4100 dict_unref(fudi.fd_dict);
4101 vim_free(tofree);
4102}
4103
4104/*
4105 * Return from a function. Possibly makes the return pending. Also called
4106 * for a pending return at the ":endtry" or after returning from an extra
4107 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4108 * when called due to a ":return" command. "rettv" may point to a typval_T
4109 * with the return rettv. Returns TRUE when the return can be carried out,
4110 * FALSE when the return gets pending.
4111 */
4112 int
4113do_return(
4114 exarg_T *eap,
4115 int reanimate,
4116 int is_cmd,
4117 void *rettv)
4118{
4119 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004120 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004121
4122 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004123 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 current_funccal->returned = FALSE;
4125
4126 /*
4127 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4128 * not in its finally clause (which then is to be executed next) is found.
4129 * In this case, make the ":return" pending for execution at the ":endtry".
4130 * Otherwise, return normally.
4131 */
4132 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4133 if (idx >= 0)
4134 {
4135 cstack->cs_pending[idx] = CSTP_RETURN;
4136
4137 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004138 // A pending return again gets pending. "rettv" points to an
4139 // allocated variable with the rettv of the original ":return"'s
4140 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 cstack->cs_rettv[idx] = rettv;
4142 else
4143 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004144 // When undoing a return in order to make it pending, get the stored
4145 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 if (reanimate)
4147 rettv = current_funccal->rettv;
4148
4149 if (rettv != NULL)
4150 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004151 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4153 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4154 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004155 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 }
4157 else
4158 cstack->cs_rettv[idx] = NULL;
4159
4160 if (reanimate)
4161 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004162 // The pending return value could be overwritten by a ":return"
4163 // without argument in a finally clause; reset the default
4164 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 current_funccal->rettv->v_type = VAR_NUMBER;
4166 current_funccal->rettv->vval.v_number = 0;
4167 }
4168 }
4169 report_make_pending(CSTP_RETURN, rettv);
4170 }
4171 else
4172 {
4173 current_funccal->returned = TRUE;
4174
Bram Moolenaare38eab22019-12-05 21:50:01 +01004175 // If the return is carried out now, store the return value. For
4176 // a return immediately after reanimation, the value is already
4177 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 if (!reanimate && rettv != NULL)
4179 {
4180 clear_tv(current_funccal->rettv);
4181 *current_funccal->rettv = *(typval_T *)rettv;
4182 if (!is_cmd)
4183 vim_free(rettv);
4184 }
4185 }
4186
4187 return idx < 0;
4188}
4189
4190/*
4191 * Free the variable with a pending return value.
4192 */
4193 void
4194discard_pending_return(void *rettv)
4195{
4196 free_tv((typval_T *)rettv);
4197}
4198
4199/*
4200 * Generate a return command for producing the value of "rettv". The result
4201 * is an allocated string. Used by report_pending() for verbose messages.
4202 */
4203 char_u *
4204get_return_cmd(void *rettv)
4205{
4206 char_u *s = NULL;
4207 char_u *tofree = NULL;
4208 char_u numbuf[NUMBUFLEN];
4209
4210 if (rettv != NULL)
4211 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4212 if (s == NULL)
4213 s = (char_u *)"";
4214
4215 STRCPY(IObuff, ":return ");
4216 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4217 if (STRLEN(s) + 8 >= IOSIZE)
4218 STRCPY(IObuff + IOSIZE - 4, "...");
4219 vim_free(tofree);
4220 return vim_strsave(IObuff);
4221}
4222
4223/*
4224 * Get next function line.
4225 * Called by do_cmdline() to get the next line.
4226 * Returns allocated string, or NULL for end of function.
4227 */
4228 char_u *
4229get_func_line(
4230 int c UNUSED,
4231 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004232 int indent UNUSED,
4233 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234{
4235 funccall_T *fcp = (funccall_T *)cookie;
4236 ufunc_T *fp = fcp->func;
4237 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004238 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239
Bram Moolenaare38eab22019-12-05 21:50:01 +01004240 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 if (fcp->dbg_tick != debug_tick)
4242 {
4243 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004244 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245 fcp->dbg_tick = debug_tick;
4246 }
4247#ifdef FEAT_PROFILE
4248 if (do_profiling == PROF_YES)
4249 func_line_end(cookie);
4250#endif
4251
4252 gap = &fp->uf_lines;
4253 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4254 || fcp->returned)
4255 retval = NULL;
4256 else
4257 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004258 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259 while (fcp->linenr < gap->ga_len
4260 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4261 ++fcp->linenr;
4262 if (fcp->linenr >= gap->ga_len)
4263 retval = NULL;
4264 else
4265 {
4266 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004267 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268#ifdef FEAT_PROFILE
4269 if (do_profiling == PROF_YES)
4270 func_line_start(cookie);
4271#endif
4272 }
4273 }
4274
Bram Moolenaare38eab22019-12-05 21:50:01 +01004275 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004276 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004278 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004279 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004281 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 fcp->dbg_tick = debug_tick;
4283 }
4284
4285 return retval;
4286}
4287
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004288/*
4289 * Return TRUE if the currently active function should be ended, because a
4290 * return was encountered or an error occurred. Used inside a ":while".
4291 */
4292 int
4293func_has_ended(void *cookie)
4294{
4295 funccall_T *fcp = (funccall_T *)cookie;
4296
Bram Moolenaare38eab22019-12-05 21:50:01 +01004297 // Ignore the "abort" flag if the abortion behavior has been changed due to
4298 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004299 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4300 || fcp->returned);
4301}
4302
4303/*
4304 * return TRUE if cookie indicates a function which "abort"s on errors.
4305 */
4306 int
4307func_has_abort(
4308 void *cookie)
4309{
4310 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4311}
4312
4313
4314/*
4315 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4316 * Don't do this when "Func" is already a partial that was bound
4317 * explicitly (pt_auto is FALSE).
4318 * Changes "rettv" in-place.
4319 * Returns the updated "selfdict_in".
4320 */
4321 dict_T *
4322make_partial(dict_T *selfdict_in, typval_T *rettv)
4323{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004324 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 char_u *tofree = NULL;
4326 ufunc_T *fp;
4327 char_u fname_buf[FLEN_FIXED + 1];
4328 int error;
4329 dict_T *selfdict = selfdict_in;
4330
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004331 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4332 fp = rettv->vval.v_partial->pt_func;
4333 else
4334 {
4335 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4336 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004337 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004338 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004339 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004340 vim_free(tofree);
4341 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342
4343 if (fp != NULL && (fp->uf_flags & FC_DICT))
4344 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004345 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346
4347 if (pt != NULL)
4348 {
4349 pt->pt_refcount = 1;
4350 pt->pt_dict = selfdict;
4351 pt->pt_auto = TRUE;
4352 selfdict = NULL;
4353 if (rettv->v_type == VAR_FUNC)
4354 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004355 // Just a function: Take over the function name and use
4356 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357 pt->pt_name = rettv->vval.v_string;
4358 }
4359 else
4360 {
4361 partial_T *ret_pt = rettv->vval.v_partial;
4362 int i;
4363
Bram Moolenaare38eab22019-12-05 21:50:01 +01004364 // Partial: copy the function name, use selfdict and copy
4365 // args. Can't take over name or args, the partial might
4366 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004367 if (ret_pt->pt_name != NULL)
4368 {
4369 pt->pt_name = vim_strsave(ret_pt->pt_name);
4370 func_ref(pt->pt_name);
4371 }
4372 else
4373 {
4374 pt->pt_func = ret_pt->pt_func;
4375 func_ptr_ref(pt->pt_func);
4376 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 if (ret_pt->pt_argc > 0)
4378 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004379 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004380 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004381 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 pt->pt_argc = 0;
4383 else
4384 {
4385 pt->pt_argc = ret_pt->pt_argc;
4386 for (i = 0; i < pt->pt_argc; i++)
4387 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4388 }
4389 }
4390 partial_unref(ret_pt);
4391 }
4392 rettv->v_type = VAR_PARTIAL;
4393 rettv->vval.v_partial = pt;
4394 }
4395 }
4396 return selfdict;
4397}
4398
4399/*
4400 * Return the name of the executed function.
4401 */
4402 char_u *
4403func_name(void *cookie)
4404{
4405 return ((funccall_T *)cookie)->func->uf_name;
4406}
4407
4408/*
4409 * Return the address holding the next breakpoint line for a funccall cookie.
4410 */
4411 linenr_T *
4412func_breakpoint(void *cookie)
4413{
4414 return &((funccall_T *)cookie)->breakpoint;
4415}
4416
4417/*
4418 * Return the address holding the debug tick for a funccall cookie.
4419 */
4420 int *
4421func_dbg_tick(void *cookie)
4422{
4423 return &((funccall_T *)cookie)->dbg_tick;
4424}
4425
4426/*
4427 * Return the nesting level for a funccall cookie.
4428 */
4429 int
4430func_level(void *cookie)
4431{
4432 return ((funccall_T *)cookie)->level;
4433}
4434
4435/*
4436 * Return TRUE when a function was ended by a ":return" command.
4437 */
4438 int
4439current_func_returned(void)
4440{
4441 return current_funccal->returned;
4442}
4443
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004444 int
4445free_unref_funccal(int copyID, int testing)
4446{
4447 int did_free = FALSE;
4448 int did_free_funccal = FALSE;
4449 funccall_T *fc, **pfc;
4450
4451 for (pfc = &previous_funccal; *pfc != NULL; )
4452 {
4453 if (can_free_funccal(*pfc, copyID))
4454 {
4455 fc = *pfc;
4456 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004457 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458 did_free = TRUE;
4459 did_free_funccal = TRUE;
4460 }
4461 else
4462 pfc = &(*pfc)->caller;
4463 }
4464 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004465 // When a funccal was freed some more items might be garbage
4466 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 (void)garbage_collect(testing);
4468
4469 return did_free;
4470}
4471
4472/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004473 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474 */
4475 static funccall_T *
4476get_funccal(void)
4477{
4478 int i;
4479 funccall_T *funccal;
4480 funccall_T *temp_funccal;
4481
4482 funccal = current_funccal;
4483 if (debug_backtrace_level > 0)
4484 {
4485 for (i = 0; i < debug_backtrace_level; i++)
4486 {
4487 temp_funccal = funccal->caller;
4488 if (temp_funccal)
4489 funccal = temp_funccal;
4490 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004491 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004492 debug_backtrace_level = i;
4493 }
4494 }
4495 return funccal;
4496}
4497
4498/*
4499 * Return the hashtable used for local variables in the current funccal.
4500 * Return NULL if there is no current funccal.
4501 */
4502 hashtab_T *
4503get_funccal_local_ht()
4504{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004505 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 return NULL;
4507 return &get_funccal()->l_vars.dv_hashtab;
4508}
4509
4510/*
4511 * Return the l: scope variable.
4512 * Return NULL if there is no current funccal.
4513 */
4514 dictitem_T *
4515get_funccal_local_var()
4516{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004517 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004518 return NULL;
4519 return &get_funccal()->l_vars_var;
4520}
4521
4522/*
4523 * Return the hashtable used for argument in the current funccal.
4524 * Return NULL if there is no current funccal.
4525 */
4526 hashtab_T *
4527get_funccal_args_ht()
4528{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004529 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004530 return NULL;
4531 return &get_funccal()->l_avars.dv_hashtab;
4532}
4533
4534/*
4535 * Return the a: scope variable.
4536 * Return NULL if there is no current funccal.
4537 */
4538 dictitem_T *
4539get_funccal_args_var()
4540{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004541 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004542 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004543 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004544}
4545
4546/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004547 * List function variables, if there is a function.
4548 */
4549 void
4550list_func_vars(int *first)
4551{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004552 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004553 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004554 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555}
4556
4557/*
4558 * If "ht" is the hashtable for local variables in the current funccal, return
4559 * the dict that contains it.
4560 * Otherwise return NULL.
4561 */
4562 dict_T *
4563get_current_funccal_dict(hashtab_T *ht)
4564{
4565 if (current_funccal != NULL
4566 && ht == &current_funccal->l_vars.dv_hashtab)
4567 return &current_funccal->l_vars;
4568 return NULL;
4569}
4570
4571/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004572 * Search hashitem in parent scope.
4573 */
4574 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004575find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004576{
4577 funccall_T *old_current_funccal = current_funccal;
4578 hashtab_T *ht;
4579 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004580 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004581
4582 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4583 return NULL;
4584
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004585 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004586 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004587 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004588 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004589 ht = find_var_ht(name, &varname);
4590 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004591 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004592 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004593 if (!HASHITEM_EMPTY(hi))
4594 {
4595 *pht = ht;
4596 break;
4597 }
4598 }
4599 if (current_funccal == current_funccal->func->uf_scoped)
4600 break;
4601 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004602 }
4603 current_funccal = old_current_funccal;
4604
4605 return hi;
4606}
4607
4608/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004609 * Search variable in parent scope.
4610 */
4611 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004612find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004613{
4614 dictitem_T *v = NULL;
4615 funccall_T *old_current_funccal = current_funccal;
4616 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004617 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004618
4619 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4620 return NULL;
4621
Bram Moolenaare38eab22019-12-05 21:50:01 +01004622 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004623 current_funccal = current_funccal->func->uf_scoped;
4624 while (current_funccal)
4625 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004626 ht = find_var_ht(name, &varname);
4627 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004628 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004629 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004630 if (v != NULL)
4631 break;
4632 }
4633 if (current_funccal == current_funccal->func->uf_scoped)
4634 break;
4635 current_funccal = current_funccal->func->uf_scoped;
4636 }
4637 current_funccal = old_current_funccal;
4638
4639 return v;
4640}
4641
4642/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004643 * Set "copyID + 1" in previous_funccal and callers.
4644 */
4645 int
4646set_ref_in_previous_funccal(int copyID)
4647{
4648 int abort = FALSE;
4649 funccall_T *fc;
4650
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004651 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004652 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004653 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004654 abort = abort
4655 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4656 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004657 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 }
4659 return abort;
4660}
4661
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004662 static int
4663set_ref_in_funccal(funccall_T *fc, int copyID)
4664{
4665 int abort = FALSE;
4666
4667 if (fc->fc_copyID != copyID)
4668 {
4669 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004670 abort = abort
4671 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4672 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004673 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004674 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004675 }
4676 return abort;
4677}
4678
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004679/*
4680 * Set "copyID" in all local vars and arguments in the call stack.
4681 */
4682 int
4683set_ref_in_call_stack(int copyID)
4684{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004685 int abort = FALSE;
4686 funccall_T *fc;
4687 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004689 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004690 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004691
4692 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004693 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4694 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004695 abort = abort || set_ref_in_funccal(fc, copyID);
4696
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004697 return abort;
4698}
4699
4700/*
4701 * Set "copyID" in all functions available by name.
4702 */
4703 int
4704set_ref_in_functions(int copyID)
4705{
4706 int todo;
4707 hashitem_T *hi = NULL;
4708 int abort = FALSE;
4709 ufunc_T *fp;
4710
4711 todo = (int)func_hashtab.ht_used;
4712 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004714 if (!HASHITEM_EMPTY(hi))
4715 {
4716 --todo;
4717 fp = HI2UF(hi);
4718 if (!func_name_refcount(fp->uf_name))
4719 abort = abort || set_ref_in_func(NULL, fp, copyID);
4720 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721 }
4722 return abort;
4723}
4724
4725/*
4726 * Set "copyID" in all function arguments.
4727 */
4728 int
4729set_ref_in_func_args(int copyID)
4730{
4731 int i;
4732 int abort = FALSE;
4733
4734 for (i = 0; i < funcargs.ga_len; ++i)
4735 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4736 copyID, NULL, NULL);
4737 return abort;
4738}
4739
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004740/*
4741 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004742 * Returns TRUE if setting references failed somehow.
4743 */
4744 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004745set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004746{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004747 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004748 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004749 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004750 char_u fname_buf[FLEN_FIXED + 1];
4751 char_u *tofree = NULL;
4752 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004753 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004754
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004755 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004756 return FALSE;
4757
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004758 if (fp_in == NULL)
4759 {
4760 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004761 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004762 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004763 if (fp != NULL)
4764 {
4765 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004766 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004767 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004768
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004769 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004770 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004771}
4772
Bram Moolenaare38eab22019-12-05 21:50:01 +01004773#endif // FEAT_EVAL