blob: 7d3039a45952292651f60c20069737010d08802e [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 Moolenaarefa94442020-08-08 22:16:00 +0200794 long sid = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100795
Bram Moolenaar333894b2020-08-01 18:53:07 +0200796 if (vim9script)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100797 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200798 // Find script-local function before global one.
799 func = find_func_with_sid(name, current_sctx.sc_sid);
800 if (func != NULL)
801 return func;
802 }
803
Bram Moolenaarefa94442020-08-08 22:16:00 +0200804 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200805 && name[1] == KS_EXTRA
806 && name[2] == KE_SNR)
807 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200808 // Caller changes s: to <SNR>99_name.
809
810 after_script = name + 3;
811 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +0200812 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200813 ++after_script;
814 else
815 after_script = NULL;
816 }
Bram Moolenaar333894b2020-08-01 18:53:07 +0200817 if (vim9script || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200818 {
819 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +0200820 if (after_script != NULL && sid != current_sctx.sc_sid)
821 imported = find_imported_in_script(after_script, 0, sid);
822 else
823 imported = find_imported(after_script == NULL
824 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200825 if (imported != NULL && imported->imp_funcname != NULL)
826 {
827 hi = hash_find(&func_hashtab, imported->imp_funcname);
828 if (!HASHITEM_EMPTY(hi))
829 return HI2UF(hi);
830 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100831 }
832 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200833
Bram Moolenaara26b9702020-04-18 19:53:28 +0200834 hi = hash_find(&func_hashtab,
835 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200836 if (!HASHITEM_EMPTY(hi))
837 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100838
839 return NULL;
840}
841
842/*
843 * Find a function by name, return pointer to it in ufuncs.
844 * "cctx" is passed in a :def function to find imported functions.
845 * Return NULL for unknown or dead function.
846 */
847 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200848find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100849{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200850 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100851
852 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
853 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200854 return NULL;
855}
856
857/*
858 * Copy the function name of "fp" to buffer "buf".
859 * "buf" must be able to hold the function name plus three bytes.
860 * Takes care of script-local function names.
861 */
862 static void
863cat_func_name(char_u *buf, ufunc_T *fp)
864{
865 if (fp->uf_name[0] == K_SPECIAL)
866 {
867 STRCPY(buf, "<SNR>");
868 STRCAT(buf, fp->uf_name + 3);
869 }
870 else
871 STRCPY(buf, fp->uf_name);
872}
873
874/*
875 * Add a number variable "name" to dict "dp" with value "nr".
876 */
877 static void
878add_nr_var(
879 dict_T *dp,
880 dictitem_T *v,
881 char *name,
882 varnumber_T nr)
883{
884 STRCPY(v->di_key, name);
885 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
886 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
887 v->di_tv.v_type = VAR_NUMBER;
888 v->di_tv.v_lock = VAR_FIXED;
889 v->di_tv.vval.v_number = nr;
890}
891
892/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100893 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200894 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100895 static void
896free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200897{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100898 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200899
900 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
901 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100902 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200903
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100904 // When garbage collecting a funccall_T may be freed before the
905 // function that references it, clear its uf_scoped field.
906 // The function may have been redefined and point to another
907 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200908 if (fp != NULL && fp->uf_scoped == fc)
909 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200910 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200911 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200912
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200913 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200914 vim_free(fc);
915}
916
917/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100918 * Free "fc" and what it contains.
919 * Can be called only when "fc" is kept beyond the period of it called,
920 * i.e. after cleanup_function_call(fc).
921 */
922 static void
923free_funccal_contents(funccall_T *fc)
924{
925 listitem_T *li;
926
927 // Free all l: variables.
928 vars_clear(&fc->l_vars.dv_hashtab);
929
930 // Free all a: variables.
931 vars_clear(&fc->l_avars.dv_hashtab);
932
933 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200934 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100935 clear_tv(&li->li_tv);
936
937 free_funccal(fc);
938}
939
940/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200941 * Handle the last part of returning from a function: free the local hashtable.
942 * Unless it is still in use by a closure.
943 */
944 static void
945cleanup_function_call(funccall_T *fc)
946{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100947 int may_free_fc = fc->fc_refcount <= 0;
948 int free_fc = TRUE;
949
Bram Moolenaar6914c642017-04-01 21:21:30 +0200950 current_funccal = fc->caller;
951
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100952 // Free all l: variables if not referred.
953 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
954 vars_clear(&fc->l_vars.dv_hashtab);
955 else
956 free_fc = FALSE;
957
958 // If the a:000 list and the l: and a: dicts are not referenced and
959 // there is no closure using it, we can free the funccall_T and what's
960 // in it.
961 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
962 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200963 else
964 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100965 int todo;
966 hashitem_T *hi;
967 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200968
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100969 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200970
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100971 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200972 todo = (int)fc->l_avars.dv_hashtab.ht_used;
973 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
974 {
975 if (!HASHITEM_EMPTY(hi))
976 {
977 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100978 di = HI2DI(hi);
979 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200980 }
981 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100982 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200983
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100984 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
985 fc->l_varlist.lv_first = NULL;
986 else
987 {
988 listitem_T *li;
989
990 free_fc = FALSE;
991
992 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200993 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200994 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100995 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100996
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100997 if (free_fc)
998 free_funccal(fc);
999 else
1000 {
1001 static int made_copy = 0;
1002
1003 // "fc" is still in use. This can happen when returning "a:000",
1004 // assigning "l:" to a global variable or defining a closure.
1005 // Link "fc" in the list for garbage collection later.
1006 fc->caller = previous_funccal;
1007 previous_funccal = fc;
1008
1009 if (want_garbage_collect)
1010 // If garbage collector is ready, clear count.
1011 made_copy = 0;
1012 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001013 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001014 // We have made a lot of copies, worth 4 Mbyte. This can happen
1015 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001016 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001017 // too much memory.
1018 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001019 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001020 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001021 }
1022}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001023/*
1024 * Unreference "fc": decrement the reference count and free it when it
1025 * becomes zero. "fp" is detached from "fc".
1026 * When "force" is TRUE we are exiting.
1027 */
1028 static void
1029funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1030{
1031 funccall_T **pfc;
1032 int i;
1033
1034 if (fc == NULL)
1035 return;
1036
1037 if (--fc->fc_refcount <= 0 && (force || (
1038 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1039 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1040 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1041 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1042 {
1043 if (fc == *pfc)
1044 {
1045 *pfc = fc->caller;
1046 free_funccal_contents(fc);
1047 return;
1048 }
1049 }
1050 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1051 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1052 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1053}
1054
1055/*
1056 * Remove the function from the function hashtable. If the function was
1057 * deleted while it still has references this was already done.
1058 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1059 */
1060 static int
1061func_remove(ufunc_T *fp)
1062{
1063 hashitem_T *hi;
1064
1065 // Return if it was already virtually deleted.
1066 if (fp->uf_flags & FC_DEAD)
1067 return FALSE;
1068
1069 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1070 if (!HASHITEM_EMPTY(hi))
1071 {
1072 // When there is a def-function index do not actually remove the
1073 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001074 // Do remove it when it's a copy.
1075 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001076 fp->uf_flags |= FC_DEAD;
1077 else
1078 hash_remove(&func_hashtab, hi);
1079 return TRUE;
1080 }
1081 return FALSE;
1082}
1083
1084 static void
1085func_clear_items(ufunc_T *fp)
1086{
1087 ga_clear_strings(&(fp->uf_args));
1088 ga_clear_strings(&(fp->uf_def_args));
1089 ga_clear_strings(&(fp->uf_lines));
1090 VIM_CLEAR(fp->uf_name_exp);
1091 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001092 VIM_CLEAR(fp->uf_def_arg_idx);
1093 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001094 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001095
1096#ifdef FEAT_LUA
1097 if (fp->uf_cb_free != NULL)
1098 {
1099 fp->uf_cb_free(fp->uf_cb_state);
1100 fp->uf_cb_free = NULL;
1101 }
1102
1103 fp->uf_cb_state = NULL;
1104 fp->uf_cb = NULL;
1105#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001106#ifdef FEAT_PROFILE
1107 VIM_CLEAR(fp->uf_tml_count);
1108 VIM_CLEAR(fp->uf_tml_total);
1109 VIM_CLEAR(fp->uf_tml_self);
1110#endif
1111}
1112
1113/*
1114 * Free all things that a function contains. Does not free the function
1115 * itself, use func_free() for that.
1116 * When "force" is TRUE we are exiting.
1117 */
1118 static void
1119func_clear(ufunc_T *fp, int force)
1120{
1121 if (fp->uf_cleared)
1122 return;
1123 fp->uf_cleared = TRUE;
1124
1125 // clear this function
1126 func_clear_items(fp);
1127 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001128 if ((fp->uf_flags & FC_COPY) == 0)
1129 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001130}
1131
1132/*
1133 * Free a function and remove it from the list of functions. Does not free
1134 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001135 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001136 */
1137 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001138func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001139{
1140 // Only remove it when not done already, otherwise we would remove a newer
1141 // version of the function with the same name.
1142 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1143 func_remove(fp);
1144
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001145 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001146 vim_free(fp);
1147}
1148
1149/*
1150 * Free all things that a function contains and free the function itself.
1151 * When "force" is TRUE we are exiting.
1152 */
1153 static void
1154func_clear_free(ufunc_T *fp, int force)
1155{
1156 func_clear(fp, force);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001157 if (force || fp->uf_dfunc_idx == 0 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001158 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001159 else
1160 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001161}
1162
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001163/*
1164 * Copy already defined function "lambda" to a new function with name "global".
1165 * This is for when a compiled function defines a global function.
1166 */
1167 void
1168copy_func(char_u *lambda, char_u *global)
1169{
1170 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
1171 ufunc_T *fp;
1172
1173 if (ufunc == NULL)
1174 semsg(_("E1102: lambda function not found: %s"), lambda);
1175 else
1176 {
1177 // TODO: handle ! to overwrite
1178 fp = find_func(global, TRUE, NULL);
1179 if (fp != NULL)
1180 {
1181 semsg(_(e_funcexts), global);
1182 return;
1183 }
1184
1185 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1186 if (fp == NULL)
1187 return;
1188
1189 fp->uf_varargs = ufunc->uf_varargs;
1190 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1191 fp->uf_def_status = ufunc->uf_def_status;
1192 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001193 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1194 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001195 == FAIL
Bram Moolenaaraf8edbb2020-08-01 00:03:09 +02001196 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001197 goto failed;
1198
1199 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1200 : vim_strsave(ufunc->uf_name_exp);
1201 if (ufunc->uf_arg_types != NULL)
1202 {
1203 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1204 if (fp->uf_arg_types == NULL)
1205 goto failed;
1206 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1207 sizeof(type_T *) * fp->uf_args.ga_len);
1208 }
1209 if (ufunc->uf_def_arg_idx != NULL)
1210 {
1211 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1212 if (fp->uf_def_arg_idx == NULL)
1213 goto failed;
1214 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1215 sizeof(int) * fp->uf_def_args.ga_len + 1);
1216 }
1217 if (ufunc->uf_va_name != NULL)
1218 {
1219 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1220 if (fp->uf_va_name == NULL)
1221 goto failed;
1222 }
1223
1224 fp->uf_refcount = 1;
1225 STRCPY(fp->uf_name, global);
1226 hash_add(&func_hashtab, UF2HIKEY(fp));
1227 }
1228 return;
1229
1230failed:
1231 func_clear_free(fp, TRUE);
1232}
1233
Bram Moolenaar6914c642017-04-01 21:21:30 +02001234
1235/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001236 * Call a user function.
1237 */
1238 static void
1239call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001240 ufunc_T *fp, // pointer to function
1241 int argcount, // nr of args
1242 typval_T *argvars, // arguments
1243 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001244 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001245 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001246{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001247 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001248 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001249 funccall_T *fc;
1250 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001251 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001252 static int depth = 0;
1253 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001254 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001255 int i;
1256 int ai;
1257 int islambda = FALSE;
1258 char_u numbuf[NUMBUFLEN];
1259 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001260#ifdef FEAT_PROFILE
1261 proftime_T wait_start;
1262 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001263 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001264#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001265 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001266
Bram Moolenaare38eab22019-12-05 21:50:01 +01001267 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001268 if (depth >= p_mfd)
1269 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001270 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001271 rettv->v_type = VAR_NUMBER;
1272 rettv->vval.v_number = -1;
1273 return;
1274 }
1275 ++depth;
1276
Bram Moolenaare38eab22019-12-05 21:50:01 +01001277 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001278
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001279 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001280 if (fc == NULL)
1281 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001282 fc->caller = current_funccal;
1283 current_funccal = fc;
1284 fc->func = fp;
1285 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001286 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001287 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1289 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001290 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001291 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001292 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001293
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001294 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001295 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001296 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001297 save_current_sctx = current_sctx;
1298 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001299
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001300 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001301 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001302 --depth;
1303 current_funccal = fc->caller;
1304
1305 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001306 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001307 free_funccal(fc);
1308 return;
1309 }
1310
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001311 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1312 islambda = TRUE;
1313
1314 /*
1315 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1316 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1317 * each argument variable and saves a lot of time.
1318 */
1319 /*
1320 * Init l: variables.
1321 */
1322 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1323 if (selfdict != NULL)
1324 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001325 // Set l:self to "selfdict". Use "name" to avoid a warning from
1326 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001327 v = &fc->fixvar[fixvar_idx++].var;
1328 name = v->di_key;
1329 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001330 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001331 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1332 v->di_tv.v_type = VAR_DICT;
1333 v->di_tv.v_lock = 0;
1334 v->di_tv.vval.v_dict = selfdict;
1335 ++selfdict->dv_refcount;
1336 }
1337
1338 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001339 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001340 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001341 * Set a:000 to a list with room for the "..." arguments.
1342 */
1343 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001344 if ((fp->uf_flags & FC_NOARGS) == 0)
1345 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001346 (varnumber_T)(argcount >= fp->uf_args.ga_len
1347 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001348 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001349 if ((fp->uf_flags & FC_NOARGS) == 0)
1350 {
1351 // Use "name" to avoid a warning from some compiler that checks the
1352 // destination size.
1353 v = &fc->fixvar[fixvar_idx++].var;
1354 name = v->di_key;
1355 STRCPY(name, "000");
1356 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1357 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1358 v->di_tv.v_type = VAR_LIST;
1359 v->di_tv.v_lock = VAR_FIXED;
1360 v->di_tv.vval.v_list = &fc->l_varlist;
1361 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001362 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1364 fc->l_varlist.lv_lock = VAR_FIXED;
1365
1366 /*
1367 * Set a:firstline to "firstline" and a:lastline to "lastline".
1368 * Set a:name to named arguments.
1369 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001370 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001371 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001372 if ((fp->uf_flags & FC_NOARGS) == 0)
1373 {
1374 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001375 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001376 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001377 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001378 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001379 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001380 {
1381 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001382 typval_T def_rettv;
1383 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001384
1385 ai = i - fp->uf_args.ga_len;
1386 if (ai < 0)
1387 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001388 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001389 name = FUNCARG(fp, i);
1390 if (islambda)
1391 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001392
1393 // evaluate named argument default expression
1394 isdefault = ai + fp->uf_def_args.ga_len >= 0
1395 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1396 && argvars[i].vval.v_number == VVAL_NONE));
1397 if (isdefault)
1398 {
1399 char_u *default_expr = NULL;
1400 def_rettv.v_type = VAR_NUMBER;
1401 def_rettv.vval.v_number = -1;
1402
1403 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1404 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001405 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001406 {
1407 default_arg_err = 1;
1408 break;
1409 }
1410 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001411 }
1412 else
1413 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001414 if ((fp->uf_flags & FC_NOARGS) != 0)
1415 // Bail out if no a: arguments used (in lambda).
1416 break;
1417
Bram Moolenaare38eab22019-12-05 21:50:01 +01001418 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001419 sprintf((char *)numbuf, "%d", ai + 1);
1420 name = numbuf;
1421 }
1422 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1423 {
1424 v = &fc->fixvar[fixvar_idx++].var;
1425 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001426 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001427 }
1428 else
1429 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001430 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001431 if (v == NULL)
1432 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001433 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001436 // Note: the values are copied directly to avoid alloc/free.
1437 // "argvars" must have VAR_FIXED for v_lock.
1438 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001439 v->di_tv.v_lock = VAR_FIXED;
1440
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441 if (addlocal)
1442 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001443 // Named arguments should be accessed without the "a:" prefix in
1444 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001445 copy_tv(&v->di_tv, &v->di_tv);
1446 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001448 else
1449 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450
1451 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1452 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001453 listitem_T *li = &fc->l_listitems[ai];
1454
1455 li->li_tv = argvars[i];
1456 li->li_tv.v_lock = VAR_FIXED;
1457 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001458 }
1459 }
1460
Bram Moolenaare38eab22019-12-05 21:50:01 +01001461 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001463
1464 if (fp->uf_flags & FC_SANDBOX)
1465 {
1466 using_sandbox = TRUE;
1467 ++sandbox;
1468 }
1469
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001470 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001471 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001472 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001473 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001474 ++no_wait_return;
1475 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001477 smsg(_("calling %s"), SOURCING_NAME);
1478 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001479 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001480 char_u buf[MSG_BUF_LEN];
1481 char_u numbuf2[NUMBUFLEN];
1482 char_u *tofree;
1483 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001484
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001485 msg_puts("(");
1486 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001488 if (i > 0)
1489 msg_puts(", ");
1490 if (argvars[i].v_type == VAR_NUMBER)
1491 msg_outnum((long)argvars[i].vval.v_number);
1492 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001493 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001494 // Do not want errors such as E724 here.
1495 ++emsg_off;
1496 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1497 --emsg_off;
1498 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001499 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001500 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001501 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001502 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1503 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001504 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001505 msg_puts((char *)s);
1506 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001507 }
1508 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001510 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001512 msg_puts("\n"); // don't overwrite this either
1513
1514 verbose_leave_scroll();
1515 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 }
1517#ifdef FEAT_PROFILE
1518 if (do_profiling == PROF_YES)
1519 {
1520 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001521 {
1522 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001523 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001524 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 if (fp->uf_profiling
1526 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1527 {
1528 ++fp->uf_tm_count;
1529 profile_start(&call_start);
1530 profile_zero(&fp->uf_tm_children);
1531 }
1532 script_prof_save(&wait_start);
1533 }
1534#endif
1535
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001536 save_current_sctx = current_sctx;
1537 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001538 save_did_emsg = did_emsg;
1539 did_emsg = FALSE;
1540
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001541 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1542 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001543 else if (islambda)
1544 {
1545 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1546
1547 // A Lambda always has the command "return {expr}". It is much faster
1548 // to evaluate {expr} directly.
1549 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001550 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001551 --ex_nesting_level;
1552 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001553 else
1554 // call do_cmdline() to execute the lines
1555 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1557
1558 --RedrawingDisabled;
1559
Bram Moolenaare38eab22019-12-05 21:50:01 +01001560 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1562 {
1563 clear_tv(rettv);
1564 rettv->v_type = VAR_NUMBER;
1565 rettv->vval.v_number = -1;
1566 }
1567
1568#ifdef FEAT_PROFILE
1569 if (do_profiling == PROF_YES && (fp->uf_profiling
1570 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1571 {
1572 profile_end(&call_start);
1573 profile_sub_wait(&wait_start, &call_start);
1574 profile_add(&fp->uf_tm_total, &call_start);
1575 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1576 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1577 {
1578 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1579 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1580 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001581 if (started_profiling)
1582 // make a ":profdel func" stop profiling the function
1583 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 }
1585#endif
1586
Bram Moolenaare38eab22019-12-05 21:50:01 +01001587 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588 if (p_verbose >= 12)
1589 {
1590 ++no_wait_return;
1591 verbose_enter_scroll();
1592
1593 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001594 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001596 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001597 (long)fc->rettv->vval.v_number);
1598 else
1599 {
1600 char_u buf[MSG_BUF_LEN];
1601 char_u numbuf2[NUMBUFLEN];
1602 char_u *tofree;
1603 char_u *s;
1604
Bram Moolenaare38eab22019-12-05 21:50:01 +01001605 // The value may be very long. Skip the middle part, so that we
1606 // have some idea how it starts and ends. smsg() would always
1607 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001608 ++emsg_off;
1609 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1610 --emsg_off;
1611 if (s != NULL)
1612 {
1613 if (vim_strsize(s) > MSG_BUF_CLEN)
1614 {
1615 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1616 s = buf;
1617 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001618 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619 vim_free(tofree);
1620 }
1621 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001622 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623
1624 verbose_leave_scroll();
1625 --no_wait_return;
1626 }
1627
Bram Moolenaare31ee862020-01-07 20:59:34 +01001628 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001629 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001630 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001631#ifdef FEAT_PROFILE
1632 if (do_profiling == PROF_YES)
1633 script_prof_restore(&wait_start);
1634#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001635 if (using_sandbox)
1636 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001638 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 {
1640 ++no_wait_return;
1641 verbose_enter_scroll();
1642
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001643 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001644 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645
1646 verbose_leave_scroll();
1647 --no_wait_return;
1648 }
1649
1650 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001651 --depth;
1652
Bram Moolenaar6914c642017-04-01 21:21:30 +02001653 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654}
1655
1656/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001657 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001658 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001659 int
1660call_user_func_check(
1661 ufunc_T *fp,
1662 int argcount,
1663 typval_T *argvars,
1664 typval_T *rettv,
1665 funcexe_T *funcexe,
1666 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001667{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001668 int error;
1669 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001670
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001671 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1672 *funcexe->doesrange = TRUE;
1673 if (argcount < regular_args - fp->uf_def_args.ga_len)
1674 error = FCERR_TOOFEW;
1675 else if (!has_varargs(fp) && argcount > regular_args)
1676 error = FCERR_TOOMANY;
1677 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1678 error = FCERR_DICT;
1679 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001680 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001681 int did_save_redo = FALSE;
1682 save_redo_T save_redo;
1683
1684 /*
1685 * Call the user function.
1686 * Save and restore search patterns, script variables and
1687 * redo buffer.
1688 */
1689 save_search_patterns();
1690 if (!ins_compl_active())
1691 {
1692 saveRedobuff(&save_redo);
1693 did_save_redo = TRUE;
1694 }
1695 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001696 call_user_func(fp, argcount, argvars, rettv, funcexe,
1697 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001698 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1699 // Function was unreferenced while being used, free it now.
1700 func_clear_free(fp, FALSE);
1701 if (did_save_redo)
1702 restoreRedobuff(&save_redo);
1703 restore_search_patterns();
1704 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001705 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001706 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001707}
1708
1709/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001710 * There are two kinds of function names:
1711 * 1. ordinary names, function defined with :function
1712 * 2. numbered functions and lambdas
1713 * For the first we only count the name stored in func_hashtab as a reference,
1714 * using function() does not count as a reference, because the function is
1715 * looked up by name.
1716 */
1717 static int
1718func_name_refcount(char_u *name)
1719{
1720 return isdigit(*name) || *name == '<';
1721}
1722
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001723static funccal_entry_T *funccal_stack = NULL;
1724
1725/*
1726 * Save the current function call pointer, and set it to NULL.
1727 * Used when executing autocommands and for ":source".
1728 */
1729 void
1730save_funccal(funccal_entry_T *entry)
1731{
1732 entry->top_funccal = current_funccal;
1733 entry->next = funccal_stack;
1734 funccal_stack = entry;
1735 current_funccal = NULL;
1736}
1737
1738 void
1739restore_funccal(void)
1740{
1741 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001742 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001743 else
1744 {
1745 current_funccal = funccal_stack->top_funccal;
1746 funccal_stack = funccal_stack->next;
1747 }
1748}
1749
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001750 funccall_T *
1751get_current_funccal(void)
1752{
1753 return current_funccal;
1754}
1755
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001756/*
1757 * Mark all functions of script "sid" as deleted.
1758 */
1759 void
1760delete_script_functions(int sid)
1761{
1762 hashitem_T *hi;
1763 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02001764 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001765 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001766 size_t len;
1767
1768 buf[0] = K_SPECIAL;
1769 buf[1] = KS_EXTRA;
1770 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001771 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001772 len = STRLEN(buf);
1773
Bram Moolenaarce658352020-07-31 23:47:12 +02001774 while (todo > 0)
1775 {
1776 todo = func_hashtab.ht_used;
1777 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1778 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001779 {
Bram Moolenaarce658352020-07-31 23:47:12 +02001780 fp = HI2UF(hi);
1781 if (STRNCMP(fp->uf_name, buf, len) == 0)
1782 {
1783 int changed = func_hashtab.ht_changed;
1784
1785 fp->uf_flags |= FC_DEAD;
1786 func_clear(fp, TRUE);
1787 // When clearing a function another function can be cleared
1788 // as a side effect. When that happens start over.
1789 if (changed != func_hashtab.ht_changed)
1790 break;
1791 }
1792 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001793 }
Bram Moolenaarce658352020-07-31 23:47:12 +02001794 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001795}
1796
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001797#if defined(EXITFREE) || defined(PROTO)
1798 void
1799free_all_functions(void)
1800{
1801 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001802 ufunc_T *fp;
1803 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001804 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001805 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001806
Bram Moolenaare38eab22019-12-05 21:50:01 +01001807 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001808 while (current_funccal != NULL)
1809 {
1810 clear_tv(current_funccal->rettv);
1811 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001812 if (current_funccal == NULL && funccal_stack != NULL)
1813 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001814 }
1815
Bram Moolenaare38eab22019-12-05 21:50:01 +01001816 // First clear what the functions contain. Since this may lower the
1817 // reference count of a function, it may also free a function and change
1818 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001819 while (todo > 0)
1820 {
1821 todo = func_hashtab.ht_used;
1822 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1823 if (!HASHITEM_EMPTY(hi))
1824 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001825 // clear the def function index now
1826 fp = HI2UF(hi);
1827 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001828 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001829
Bram Moolenaare38eab22019-12-05 21:50:01 +01001830 // Only free functions that are not refcounted, those are
1831 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001832 if (func_name_refcount(fp->uf_name))
1833 ++skipped;
1834 else
1835 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001836 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001837 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001838 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001839 {
1840 skipped = 0;
1841 break;
1842 }
1843 }
1844 --todo;
1845 }
1846 }
1847
Bram Moolenaare38eab22019-12-05 21:50:01 +01001848 // Now actually free the functions. Need to start all over every time,
1849 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001850 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001851 while (func_hashtab.ht_used > skipped)
1852 {
1853 todo = func_hashtab.ht_used;
1854 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 if (!HASHITEM_EMPTY(hi))
1856 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001857 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001858 // Only free functions that are not refcounted, those are
1859 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001860 fp = HI2UF(hi);
1861 if (func_name_refcount(fp->uf_name))
1862 ++skipped;
1863 else
1864 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001865 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001866 skipped = 0;
1867 break;
1868 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001869 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001870 }
1871 if (skipped == 0)
1872 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001873
1874 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875}
1876#endif
1877
1878/*
1879 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001880 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001881 * "len" is the length of "name", or -1 for NUL terminated.
1882 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001883 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001884builtin_function(char_u *name, int len)
1885{
1886 char_u *p;
1887
Bram Moolenaara26b9702020-04-18 19:53:28 +02001888 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001889 return FALSE;
1890 p = vim_strchr(name, AUTOLOAD_CHAR);
1891 return p == NULL || (len > 0 && p > name + len);
1892}
1893
1894 int
1895func_call(
1896 char_u *name,
1897 typval_T *args,
1898 partial_T *partial,
1899 dict_T *selfdict,
1900 typval_T *rettv)
1901{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001902 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001903 listitem_T *item;
1904 typval_T argv[MAX_FUNC_ARGS + 1];
1905 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 int r = 0;
1907
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001908 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001909 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001910 {
1911 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1912 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001913 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001914 break;
1915 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001916 // Make a copy of each argument. This is needed to be able to set
1917 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 copy_tv(&item->li_tv, &argv[argc++]);
1919 }
1920
1921 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001922 {
1923 funcexe_T funcexe;
1924
Bram Moolenaara80faa82020-04-12 19:37:17 +02001925 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001926 funcexe.firstline = curwin->w_cursor.lnum;
1927 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001928 funcexe.evaluate = TRUE;
1929 funcexe.partial = partial;
1930 funcexe.selfdict = selfdict;
1931 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1932 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001933
Bram Moolenaare38eab22019-12-05 21:50:01 +01001934 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 while (argc > 0)
1936 clear_tv(&argv[--argc]);
1937
1938 return r;
1939}
1940
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001941static int callback_depth = 0;
1942
1943 int
1944get_callback_depth(void)
1945{
1946 return callback_depth;
1947}
1948
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001949/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001950 * Invoke call_func() with a callback.
1951 */
1952 int
1953call_callback(
1954 callback_T *callback,
1955 int len, // length of "name" or -1 to use strlen()
1956 typval_T *rettv, // return value goes here
1957 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001958 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001959 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001960{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001961 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001962 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001963
Bram Moolenaara80faa82020-04-12 19:37:17 +02001964 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001965 funcexe.evaluate = TRUE;
1966 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001967 ++callback_depth;
1968 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1969 --callback_depth;
1970 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001971}
1972
1973/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001974 * Give an error message for the result of a function.
1975 * Nothing if "error" is FCERR_NONE.
1976 */
1977 void
1978user_func_error(int error, char_u *name)
1979{
1980 switch (error)
1981 {
1982 case FCERR_UNKNOWN:
1983 emsg_funcname(e_unknownfunc, name);
1984 break;
1985 case FCERR_NOTMETHOD:
1986 emsg_funcname(
1987 N_("E276: Cannot use function as a method: %s"), name);
1988 break;
1989 case FCERR_DELETED:
1990 emsg_funcname(N_(e_func_deleted), name);
1991 break;
1992 case FCERR_TOOMANY:
1993 emsg_funcname((char *)e_toomanyarg, name);
1994 break;
1995 case FCERR_TOOFEW:
1996 emsg_funcname((char *)e_toofewarg, name);
1997 break;
1998 case FCERR_SCRIPT:
1999 emsg_funcname(
2000 N_("E120: Using <SID> not in a script context: %s"), name);
2001 break;
2002 case FCERR_DICT:
2003 emsg_funcname(
2004 N_("E725: Calling dict function without Dictionary: %s"),
2005 name);
2006 break;
2007 }
2008}
2009
2010/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002011 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002012 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002013 * Return FAIL when the function can't be called, OK otherwise.
2014 * Also returns OK when an error was encountered while executing the function.
2015 */
2016 int
2017call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002018 char_u *funcname, // name of the function
2019 int len, // length of "name" or -1 to use strlen()
2020 typval_T *rettv, // return value goes here
2021 int argcount_in, // number of "argvars"
2022 typval_T *argvars_in, // vars for arguments, must have "argcount"
2023 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002024 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002025{
2026 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002027 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002029 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002030 char_u fname_buf[FLEN_FIXED + 1];
2031 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002032 char_u *fname = NULL;
2033 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002034 int argcount = argcount_in;
2035 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002036 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002037 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2038 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002039 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002040 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002041 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002042
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002043 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2044 // even when call_func() returns FAIL.
2045 rettv->v_type = VAR_UNKNOWN;
2046
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002047 if (partial != NULL)
2048 fp = partial->pt_func;
2049 if (fp == NULL)
2050 {
2051 // Make a copy of the name, if it comes from a funcref variable it
2052 // could be changed or deleted in the called function.
2053 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2054 if (name == NULL)
2055 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002056
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002057 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2058 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002059
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002060 if (funcexe->doesrange != NULL)
2061 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002062
2063 if (partial != NULL)
2064 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002065 // When the function has a partial with a dict and there is a dict
2066 // argument, use the dict argument. That is backwards compatible.
2067 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002068 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002069 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002070 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002071 {
2072 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002073 {
2074 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2075 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002076 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002077 goto theend;
2078 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002079 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002080 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002081 for (i = 0; i < argcount_in; ++i)
2082 argv[i + argv_clear] = argvars_in[i];
2083 argvars = argv;
2084 argcount = partial->pt_argc + argcount_in;
2085 }
2086 }
2087
Bram Moolenaaref140542019-12-31 21:27:13 +01002088 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002089 {
2090 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002091 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002092
Bram Moolenaar333894b2020-08-01 18:53:07 +02002093 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002094 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002095 {
2096 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002097 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002098 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002099
Bram Moolenaare38eab22019-12-05 21:50:01 +01002100 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002101 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002102 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002103
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002104 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002105 {
2106 /*
2107 * User defined function.
2108 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002109 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002110 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002111
Bram Moolenaare38eab22019-12-05 21:50:01 +01002112 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002113 if (fp == NULL
2114 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002115 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002116 && !aborting())
2117 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002118 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002119 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002121 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002122 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2123 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002124 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002125 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002126 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002127 if (fp == NULL)
2128 {
2129 char_u *p = untrans_function_name(rfname);
2130
2131 // If using Vim9 script try not local to the script.
2132 // TODO: should not do this if the name started with "s:".
2133 if (p != NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002134 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002135 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002136
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002137 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002138 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002139#ifdef FEAT_LUA
2140 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2141 {
2142 cfunc_T cb = fp->uf_cb;
2143
2144 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2145 }
2146#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002147 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002148 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002149 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002150 // postponed filling in the arguments, do it now
2151 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002152 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002153
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002154 if (funcexe->basetv != NULL)
2155 {
2156 // Method call: base->Method()
2157 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2158 argv[0] = *funcexe->basetv;
2159 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002160 argvars = argv;
2161 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002162 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002163
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002164 error = call_user_func_check(fp, argcount, argvars, rettv,
2165 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002166 }
2167 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002168 else if (funcexe->basetv != NULL)
2169 {
2170 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002171 * expr->method(): Find the method name in the table, call its
2172 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002173 */
2174 error = call_internal_method(fname, argcount, argvars, rettv,
2175 funcexe->basetv);
2176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002177 else
2178 {
2179 /*
2180 * Find the function name in the table, call its implementation.
2181 */
2182 error = call_internal_func(fname, argcount, argvars, rettv);
2183 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002184
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002185 /*
2186 * The function call (or "FuncUndefined" autocommand sequence) might
2187 * have been aborted by an error, an interrupt, or an explicitly thrown
2188 * exception that has not been caught so far. This situation can be
2189 * tested for by calling aborting(). For an error in an internal
2190 * function or for the "E132" error in call_user_func(), however, the
2191 * throw point at which the "force_abort" flag (temporarily reset by
2192 * emsg()) is normally updated has not been reached yet. We need to
2193 * update that flag first to make aborting() reliable.
2194 */
2195 update_force_abort();
2196 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002197 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198 ret = OK;
2199
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002200theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002201 /*
2202 * Report an error unless the argument evaluation or function call has been
2203 * cancelled due to an aborting error, an interrupt, or an exception.
2204 */
2205 if (!aborting())
2206 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002207 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002208 }
2209
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002210 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002212 clear_tv(&argv[--argv_clear + argv_base]);
2213
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 vim_free(tofree);
2215 vim_free(name);
2216
2217 return ret;
2218}
2219
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002220 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002221printable_func_name(ufunc_T *fp)
2222{
2223 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2224}
2225
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002227 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228 */
2229 static void
2230list_func_head(ufunc_T *fp, int indent)
2231{
2232 int j;
2233
2234 msg_start();
2235 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002236 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002237 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002238 msg_puts("def ");
2239 else
2240 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002241 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002242 msg_putchar('(');
2243 for (j = 0; j < fp->uf_args.ga_len; ++j)
2244 {
2245 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002246 msg_puts(", ");
2247 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002248 if (fp->uf_arg_types != NULL)
2249 {
2250 char *tofree;
2251
2252 msg_puts(": ");
2253 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2254 vim_free(tofree);
2255 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002256 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2257 {
2258 msg_puts(" = ");
2259 msg_puts(((char **)(fp->uf_def_args.ga_data))
2260 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2261 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002262 }
2263 if (fp->uf_varargs)
2264 {
2265 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002266 msg_puts(", ");
2267 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002269 if (fp->uf_va_name != NULL)
2270 {
2271 if (j)
2272 msg_puts(", ");
2273 msg_puts("...");
2274 msg_puts((char *)fp->uf_va_name);
2275 if (fp->uf_va_type)
2276 {
2277 char *tofree;
2278
2279 msg_puts(": ");
2280 msg_puts(type_name(fp->uf_va_type, &tofree));
2281 vim_free(tofree);
2282 }
2283 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002285
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002286 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002287 {
2288 if (fp->uf_ret_type != &t_void)
2289 {
2290 char *tofree;
2291
2292 msg_puts(": ");
2293 msg_puts(type_name(fp->uf_ret_type, &tofree));
2294 vim_free(tofree);
2295 }
2296 }
2297 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002298 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002299 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002300 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002301 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002302 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002303 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002304 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002305 msg_clr_eos();
2306 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002307 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002308}
2309
2310/*
2311 * Get a function name, translating "<SID>" and "<SNR>".
2312 * Also handles a Funcref in a List or Dictionary.
2313 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002314 * Set "*is_global" to TRUE when the function must be global, unless
2315 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002316 * flags:
2317 * TFN_INT: internal function name OK
2318 * TFN_QUIET: be quiet
2319 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002320 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002321 * Advances "pp" to just after the function name (if no error).
2322 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002323 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002324trans_function_name(
2325 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002326 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002327 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002329 funcdict_T *fdp, // return: info about dictionary used
2330 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331{
2332 char_u *name = NULL;
2333 char_u *start;
2334 char_u *end;
2335 int lead;
2336 char_u sid_buf[20];
2337 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002338 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002339 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002340 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341
2342 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002343 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344 start = *pp;
2345
Bram Moolenaare38eab22019-12-05 21:50:01 +01002346 // Check for hard coded <SNR>: already translated function ID (from a user
2347 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2349 && (*pp)[2] == (int)KE_SNR)
2350 {
2351 *pp += 3;
2352 len = get_id_len(pp) + 3;
2353 return vim_strnsave(start, len);
2354 }
2355
Bram Moolenaare38eab22019-12-05 21:50:01 +01002356 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2357 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358 lead = eval_fname_script(start);
2359 if (lead > 2)
2360 start += lead;
2361
Bram Moolenaare38eab22019-12-05 21:50:01 +01002362 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002363 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364 lead > 2 ? 0 : FNE_CHECK_START);
2365 if (end == start)
2366 {
2367 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002368 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369 goto theend;
2370 }
2371 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2372 {
2373 /*
2374 * Report an invalid expression in braces, unless the expression
2375 * evaluation has been cancelled due to an aborting error, an
2376 * interrupt, or an exception.
2377 */
2378 if (!aborting())
2379 {
2380 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002381 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 }
2383 else
2384 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2385 goto theend;
2386 }
2387
2388 if (lv.ll_tv != NULL)
2389 {
2390 if (fdp != NULL)
2391 {
2392 fdp->fd_dict = lv.ll_dict;
2393 fdp->fd_newkey = lv.ll_newkey;
2394 lv.ll_newkey = NULL;
2395 fdp->fd_di = lv.ll_di;
2396 }
2397 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2398 {
2399 name = vim_strsave(lv.ll_tv->vval.v_string);
2400 *pp = end;
2401 }
2402 else if (lv.ll_tv->v_type == VAR_PARTIAL
2403 && lv.ll_tv->vval.v_partial != NULL)
2404 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002405 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 *pp = end;
2407 if (partial != NULL)
2408 *partial = lv.ll_tv->vval.v_partial;
2409 }
2410 else
2411 {
2412 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2413 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002414 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002415 else
2416 *pp = end;
2417 name = NULL;
2418 }
2419 goto theend;
2420 }
2421
2422 if (lv.ll_name == NULL)
2423 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002424 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425 *pp = end;
2426 goto theend;
2427 }
2428
Bram Moolenaare38eab22019-12-05 21:50:01 +01002429 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 if (lv.ll_exp_name != NULL)
2431 {
2432 len = (int)STRLEN(lv.ll_exp_name);
2433 name = deref_func_name(lv.ll_exp_name, &len, partial,
2434 flags & TFN_NO_AUTOLOAD);
2435 if (name == lv.ll_exp_name)
2436 name = NULL;
2437 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002438 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439 {
2440 len = (int)(end - *pp);
2441 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2442 if (name == *pp)
2443 name = NULL;
2444 }
2445 if (name != NULL)
2446 {
2447 name = vim_strsave(name);
2448 *pp = end;
2449 if (STRNCMP(name, "<SNR>", 5) == 0)
2450 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002451 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 name[0] = K_SPECIAL;
2453 name[1] = KS_EXTRA;
2454 name[2] = (int)KE_SNR;
2455 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2456 }
2457 goto theend;
2458 }
2459
2460 if (lv.ll_exp_name != NULL)
2461 {
2462 len = (int)STRLEN(lv.ll_exp_name);
2463 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2464 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2465 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002466 // When there was "s:" already or the name expanded to get a
2467 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002468 lv.ll_name += 2;
2469 len -= 2;
2470 lead = 2;
2471 }
2472 }
2473 else
2474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002475 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002477 {
2478 if (is_global != NULL && lv.ll_name[0] == 'g')
2479 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002481 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482 len = (int)(end - lv.ll_name);
2483 }
2484
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002485 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002486 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002487
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002488 /*
2489 * Copy the function name to allocated memory.
2490 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2491 * Accept <SNR>123_name() outside a script.
2492 */
2493 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002494 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002495 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002496 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002497 if (!vim9script)
2498 lead = 3;
2499 if (vim9script || (lv.ll_exp_name != NULL
2500 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 || eval_fname_sid(*pp))
2502 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002503 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002504 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002506 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 goto theend;
2508 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002509 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002510 if (vim9script)
2511 extra = 3 + (int)STRLEN(sid_buf);
2512 else
2513 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002514 }
2515 }
2516 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2517 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002518 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002519 start);
2520 goto theend;
2521 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002522 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 {
2524 char_u *cp = vim_strchr(lv.ll_name, ':');
2525
2526 if (cp != NULL && cp < end)
2527 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002528 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 goto theend;
2530 }
2531 }
2532
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002533 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 if (name != NULL)
2535 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002536 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537 {
2538 name[0] = K_SPECIAL;
2539 name[1] = KS_EXTRA;
2540 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002541 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002542 STRCPY(name + 3, sid_buf);
2543 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002544 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2545 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546 }
2547 *pp = end;
2548
2549theend:
2550 clear_lval(&lv);
2551 return name;
2552}
2553
2554/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002555 * Assuming "name" is the result of trans_function_name() and it was prefixed
2556 * to use the script-local name, return the unmodified name (points into
2557 * "name"). Otherwise return NULL.
2558 * This can be used to first search for a script-local function and fall back
2559 * to the global function if not found.
2560 */
2561 char_u *
2562untrans_function_name(char_u *name)
2563{
2564 char_u *p;
2565
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002566 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002567 {
2568 p = vim_strchr(name, '_');
2569 if (p != NULL)
2570 return p + 1;
2571 }
2572 return NULL;
2573}
2574
2575/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002576 * List functions. When "regmatch" is NULL all of then.
2577 * Otherwise functions matching "regmatch".
2578 */
2579 static void
2580list_functions(regmatch_T *regmatch)
2581{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002582 int changed = func_hashtab.ht_changed;
2583 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002584 hashitem_T *hi;
2585
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002586 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002587 {
2588 if (!HASHITEM_EMPTY(hi))
2589 {
2590 ufunc_T *fp = HI2UF(hi);
2591
2592 --todo;
2593 if ((fp->uf_flags & FC_DEAD) == 0
2594 && (regmatch == NULL
2595 ? !message_filtered(fp->uf_name)
2596 && !func_name_refcount(fp->uf_name)
2597 : !isdigit(*fp->uf_name)
2598 && vim_regexec(regmatch, fp->uf_name, 0)))
2599 {
2600 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002601 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002602 {
2603 emsg(_("E454: function list was modified"));
2604 return;
2605 }
2606 }
2607 }
2608 }
2609}
2610
2611/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002612 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002613 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2614 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002615 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002617 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002618def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619{
2620 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002621 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 int j;
2623 int c;
2624 int saved_did_emsg;
2625 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002626 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002627 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628 char_u *p;
2629 char_u *arg;
2630 char_u *line_arg = NULL;
2631 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002632 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002633 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 garray_T newlines;
2635 int varargs = FALSE;
2636 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002637 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002638 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002639 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 int indent;
2641 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002642#define MAX_FUNC_NESTING 50
2643 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 dictitem_T *v;
2645 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002646 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002649 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002650 linenr_T sourcing_lnum_off;
2651 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002652 int is_heredoc = FALSE;
2653 char_u *skip_until = NULL;
2654 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002655 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02002656 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657
2658 /*
2659 * ":function" without argument: list functions.
2660 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002661 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 {
2663 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002664 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002666 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 }
2668
2669 /*
2670 * ":function /pat": list functions matching pattern.
2671 */
2672 if (*eap->arg == '/')
2673 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002674 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 if (!eap->skip)
2676 {
2677 regmatch_T regmatch;
2678
2679 c = *p;
2680 *p = NUL;
2681 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2682 *p = c;
2683 if (regmatch.regprog != NULL)
2684 {
2685 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002686 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 vim_regfree(regmatch.regprog);
2688 }
2689 }
2690 if (*p == '/')
2691 ++p;
2692 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002693 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002694 }
2695
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002696 ga_init(&newargs);
2697 ga_init(&argtypes);
2698 ga_init(&default_args);
2699
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002700 /*
2701 * Get the function name. There are these situations:
2702 * func normal function name
2703 * "name" == func, "fudi.fd_dict" == NULL
2704 * dict.func new dictionary entry
2705 * "name" == NULL, "fudi.fd_dict" set,
2706 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2707 * dict.func existing dict entry with a Funcref
2708 * "name" == func, "fudi.fd_dict" set,
2709 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2710 * dict.func existing dict entry that's not a Funcref
2711 * "name" == NULL, "fudi.fd_dict" set,
2712 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2713 * s:func script-local function name
2714 * g:func global function name, same as "func"
2715 */
2716 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002717 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002719 // nested function, argument is (args).
2720 paren = TRUE;
2721 CLEAR_FIELD(fudi);
2722 }
2723 else
2724 {
2725 name = trans_function_name(&p, &is_global, eap->skip,
2726 TFN_NO_AUTOLOAD, &fudi, NULL);
2727 paren = (vim_strchr(p, '(') != NULL);
2728 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002729 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002730 /*
2731 * Return on an invalid expression in braces, unless the expression
2732 * evaluation has been cancelled due to an aborting error, an
2733 * interrupt, or an exception.
2734 */
2735 if (!aborting())
2736 {
2737 if (!eap->skip && fudi.fd_newkey != NULL)
2738 semsg(_(e_dictkey), fudi.fd_newkey);
2739 vim_free(fudi.fd_newkey);
2740 return NULL;
2741 }
2742 else
2743 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745 }
2746
Bram Moolenaare38eab22019-12-05 21:50:01 +01002747 // An error in a function call during evaluation of an expression in magic
2748 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002749 saved_did_emsg = did_emsg;
2750 did_emsg = FALSE;
2751
2752 /*
2753 * ":function func" with only function name: list function.
2754 */
2755 if (!paren)
2756 {
2757 if (!ends_excmd(*skipwhite(p)))
2758 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002759 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 goto ret_free;
2761 }
2762 eap->nextcmd = check_nextcmd(p);
2763 if (eap->nextcmd != NULL)
2764 *p = NUL;
2765 if (!eap->skip && !got_int)
2766 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002767 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002768 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2769 {
2770 char_u *up = untrans_function_name(name);
2771
2772 // With Vim9 script the name was made script-local, if not
2773 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002774 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002775 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002776 }
2777
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 if (fp != NULL)
2779 {
2780 list_func_head(fp, TRUE);
2781 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2782 {
2783 if (FUNCLINE(fp, j) == NULL)
2784 continue;
2785 msg_putchar('\n');
2786 msg_outnum((long)(j + 1));
2787 if (j < 9)
2788 msg_putchar(' ');
2789 if (j < 99)
2790 msg_putchar(' ');
2791 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002792 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793 ui_breakcheck();
2794 }
2795 if (!got_int)
2796 {
2797 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002798 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002799 msg_puts(" enddef");
2800 else
2801 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 }
2803 }
2804 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002805 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 }
2807 goto ret_free;
2808 }
2809
2810 /*
2811 * ":function name(arg1, arg2)" Define function.
2812 */
2813 p = skipwhite(p);
2814 if (*p != '(')
2815 {
2816 if (!eap->skip)
2817 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002818 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 goto ret_free;
2820 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002821 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 if (vim_strchr(p, '(') != NULL)
2823 p = vim_strchr(p, '(');
2824 }
2825 p = skipwhite(p + 1);
2826
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002827 // In Vim9 script only global functions can be redefined.
2828 if (vim9script && eap->forceit && !is_global)
2829 {
2830 emsg(_(e_nobang));
2831 goto ret_free;
2832 }
2833
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2835
Bram Moolenaar04b12692020-05-04 23:24:44 +02002836 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002838 // Check the name of the function. Unless it's a dictionary function
2839 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840 if (name != NULL)
2841 arg = name;
2842 else
2843 arg = fudi.fd_newkey;
2844 if (arg != NULL && (fudi.fd_di == NULL
2845 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2846 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2847 {
2848 if (*arg == K_SPECIAL)
2849 j = 3;
2850 else
2851 j = 0;
2852 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2853 : eval_isnamec(arg[j])))
2854 ++j;
2855 if (arg[j] != NUL)
2856 emsg_funcname((char *)e_invarg2, arg);
2857 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002858 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002860 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 }
2862
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002863 // This may get more lines and make the pointers into the first line
2864 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002865 if (get_function_args(&p, ')', &newargs,
2866 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002867 &varargs, &default_args, eap->skip,
2868 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 goto errret_2;
2870
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002871 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002873 // find the return type: :def Func(): type
2874 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002876 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002877 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002878 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002879 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002880 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002881 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002882 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002883 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002884 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002885 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002886 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002887 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002889 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002891 else
2892 // find extra arguments "range", "dict", "abort" and "closure"
2893 for (;;)
2894 {
2895 p = skipwhite(p);
2896 if (STRNCMP(p, "range", 5) == 0)
2897 {
2898 flags |= FC_RANGE;
2899 p += 5;
2900 }
2901 else if (STRNCMP(p, "dict", 4) == 0)
2902 {
2903 flags |= FC_DICT;
2904 p += 4;
2905 }
2906 else if (STRNCMP(p, "abort", 5) == 0)
2907 {
2908 flags |= FC_ABORT;
2909 p += 5;
2910 }
2911 else if (STRNCMP(p, "closure", 7) == 0)
2912 {
2913 flags |= FC_CLOSURE;
2914 p += 7;
2915 if (current_funccal == NULL)
2916 {
2917 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2918 name == NULL ? (char_u *)"" : name);
2919 goto erret;
2920 }
2921 }
2922 else
2923 break;
2924 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002925
Bram Moolenaare38eab22019-12-05 21:50:01 +01002926 // When there is a line break use what follows for the function body.
2927 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928 if (*p == '\n')
2929 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002930 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002931 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2932 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002933 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2934 && !eap->skip
2935 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002936 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002937
2938 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002939 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2940 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941 */
2942 if (KeyTyped)
2943 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002944 // Check if the function already exists, don't let the user type the
2945 // whole function before telling him it doesn't work! For a script we
2946 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002947 if (!eap->skip && !eap->forceit)
2948 {
2949 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002950 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002951 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 emsg_funcname(e_funcexts, name);
2953 }
2954
2955 if (!eap->skip && did_emsg)
2956 goto erret;
2957
Bram Moolenaare38eab22019-12-05 21:50:01 +01002958 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002959 cmdline_row = msg_row;
2960 }
2961
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002962 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002963 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002964
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02002965 // Detect having skipped over comment lines to find the return
2966 // type. Add NULL lines to keep the line count correct.
2967 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
2968 if (SOURCING_LNUM < sourcing_lnum_off)
2969 {
2970 sourcing_lnum_off -= SOURCING_LNUM;
2971 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
2972 goto erret;
2973 while (sourcing_lnum_off-- > 0)
2974 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
2975 }
2976
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002977 indent = 2;
2978 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002979 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980 for (;;)
2981 {
2982 if (KeyTyped)
2983 {
2984 msg_scroll = TRUE;
2985 saved_wait_return = FALSE;
2986 }
2987 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988
2989 if (line_arg != NULL)
2990 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002991 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992 theline = line_arg;
2993 p = vim_strchr(theline, '\n');
2994 if (p == NULL)
2995 line_arg += STRLEN(line_arg);
2996 else
2997 {
2998 *p = NUL;
2999 line_arg = p + 1;
3000 }
3001 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003003 {
3004 vim_free(line_to_free);
3005 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02003006 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003007 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02003008 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003009 line_to_free = theline;
3010 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003011 if (KeyTyped)
3012 lines_left = Rows - 1;
3013 if (theline == NULL)
3014 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003015 if (eap->cmdidx == CMD_def)
3016 emsg(_("E1057: Missing :enddef"));
3017 else
3018 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019 goto erret;
3020 }
3021
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003022 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003023 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003024 if (SOURCING_LNUM < sourcing_lnum_off)
3025 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 else
3027 sourcing_lnum_off = 0;
3028
3029 if (skip_until != NULL)
3030 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003031 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003032 // * ":append" and "."
3033 // * ":python <<EOF" and "EOF"
3034 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3035 if (heredoc_trimmed == NULL
3036 || (is_heredoc && skipwhite(theline) == theline)
3037 || STRNCMP(theline, heredoc_trimmed,
3038 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003039 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003040 if (heredoc_trimmed == NULL)
3041 p = theline;
3042 else if (is_heredoc)
3043 p = skipwhite(theline) == theline
3044 ? theline : theline + STRLEN(heredoc_trimmed);
3045 else
3046 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003047 if (STRCMP(p, skip_until) == 0)
3048 {
3049 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003050 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02003051 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003052 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003053 }
3054 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 }
3056 else
3057 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003058 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003059 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 ;
3061
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003062 // Check for "endfunction" or "enddef".
3063 if (checkforcmd(&p, nesting_def[nesting]
3064 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003065 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02003066 char_u *nextcmd = NULL;
3067
Bram Moolenaar663bb232017-06-22 19:12:10 +02003068 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02003069 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003070 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003071 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02003072 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003073 give_warning2(eap->cmdidx == CMD_def
3074 ? (char_u *)_("W1001: Text found after :enddef: %s")
3075 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02003076 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003077 if (nextcmd != NULL)
3078 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003079 // Another command follows. If the line came from "eap" we
3080 // can simply point into it, otherwise we need to change
3081 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02003082 eap->nextcmd = nextcmd;
3083 if (line_to_free != NULL)
3084 {
3085 vim_free(*eap->cmdlinep);
3086 *eap->cmdlinep = line_to_free;
3087 line_to_free = NULL;
3088 }
3089 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003090 break;
3091 }
3092
Bram Moolenaare38eab22019-12-05 21:50:01 +01003093 // Increase indent inside "if", "while", "for" and "try", decrease
3094 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003095 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003096 indent -= 2;
3097 else if (STRNCMP(p, "if", 2) == 0
3098 || STRNCMP(p, "wh", 2) == 0
3099 || STRNCMP(p, "for", 3) == 0
3100 || STRNCMP(p, "try", 3) == 0)
3101 indent += 2;
3102
Bram Moolenaare38eab22019-12-05 21:50:01 +01003103 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003104 // Only recognize "def" inside "def", not inside "function",
3105 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003106 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003107 if (checkforcmd(&p, "function", 2)
3108 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 {
3110 if (*p == '!')
3111 p = skipwhite(p + 1);
3112 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003113 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003114 if (*skipwhite(p) == '(')
3115 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003116 if (nesting == MAX_FUNC_NESTING - 1)
3117 emsg(_("E1058: function nesting too deep"));
3118 else
3119 {
3120 ++nesting;
3121 nesting_def[nesting] = (c == 'd');
3122 indent += 2;
3123 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124 }
3125 }
3126
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003127 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003129 if (eap->cmdidx != CMD_def
3130 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003131 || (p[0] == 'c'
3132 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3133 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3134 && (STRNCMP(&p[3], "nge", 3) != 0
3135 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136 || (p[0] == 'i'
3137 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003138 && (!ASCII_ISALPHA(p[2])
3139 || (p[2] == 's'
3140 && (!ASCII_ISALPHA(p[3])
3141 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 skip_until = vim_strsave((char_u *)".");
3143
Bram Moolenaare38eab22019-12-05 21:50:01 +01003144 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003145 arg = skipwhite(skiptowhite(p));
3146 if (arg[0] == '<' && arg[1] =='<'
3147 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003148 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3149 || ((p[2] == '3' || p[2] == 'x')
3150 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 || (p[0] == 'p' && p[1] == 'e'
3152 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3153 || (p[0] == 't' && p[1] == 'c'
3154 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3155 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3156 && !ASCII_ISALPHA(p[3]))
3157 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3158 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3159 || (p[0] == 'm' && p[1] == 'z'
3160 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3161 ))
3162 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003163 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003165 if (STRNCMP(p, "trim", 4) == 0)
3166 {
3167 // Ignore leading white space.
3168 p = skipwhite(p + 4);
3169 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003170 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003172 if (*p == NUL)
3173 skip_until = vim_strsave((char_u *)".");
3174 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003175 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003176 do_concat = FALSE;
3177 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003179
3180 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003181 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003182 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003183 if (*arg == '[')
3184 arg = vim_strchr(arg, ']');
3185 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003186 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003187 arg = skipwhite(skiptowhite(arg));
3188 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3189 && ((p[0] == 'l'
3190 && p[1] == 'e'
3191 && (!ASCII_ISALNUM(p[2])
3192 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003193 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003194 p = skipwhite(arg + 3);
3195 if (STRNCMP(p, "trim", 4) == 0)
3196 {
3197 // Ignore leading white space.
3198 p = skipwhite(p + 4);
3199 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003200 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003201 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003202 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003203 do_concat = FALSE;
3204 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003205 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003206 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207 }
3208
Bram Moolenaare38eab22019-12-05 21:50:01 +01003209 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212
Bram Moolenaare38eab22019-12-05 21:50:01 +01003213 // Copy the line to newly allocated memory. get_one_sourceline()
3214 // allocates 250 bytes per line, this saves 80% on average. The cost
3215 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003217 if (p == NULL)
3218 goto erret;
3219 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003220
Bram Moolenaare38eab22019-12-05 21:50:01 +01003221 // Add NULL lines for continuation lines, so that the line count is
3222 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 while (sourcing_lnum_off-- > 0)
3224 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3225
Bram Moolenaare38eab22019-12-05 21:50:01 +01003226 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227 if (line_arg != NULL && *line_arg == NUL)
3228 line_arg = NULL;
3229 }
3230
Bram Moolenaare38eab22019-12-05 21:50:01 +01003231 // Don't define the function when skipping commands or when an error was
3232 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233 if (eap->skip || did_emsg)
3234 goto erret;
3235
3236 /*
3237 * If there are no errors, add the function
3238 */
3239 if (fudi.fd_dict == NULL)
3240 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241 hashtab_T *ht;
3242
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 v = find_var(name, &ht, FALSE);
3244 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3245 {
3246 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3247 name);
3248 goto erret;
3249 }
3250
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003251 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003252 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003254 char_u *uname = untrans_function_name(name);
3255
3256 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3257 }
3258
3259 if (fp != NULL || import != NULL)
3260 {
3261 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003262
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003263 // Function can be replaced with "function!" and when sourcing the
3264 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003265 // A name that is used by an import can not be overruled.
3266 if (import != NULL
3267 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003268 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003269 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003271 if (vim9script)
3272 emsg_funcname(e_already_defined, name);
3273 else
3274 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 goto erret;
3276 }
3277 if (fp->uf_calls > 0)
3278 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003279 emsg_funcname(
3280 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 name);
3282 goto erret;
3283 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003284 if (fp->uf_refcount > 1)
3285 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003286 // This function is referenced somewhere, don't redefine it but
3287 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003288 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003289 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003290 fp = NULL;
3291 overwrite = TRUE;
3292 }
3293 else
3294 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003295 char_u *exp_name = fp->uf_name_exp;
3296
3297 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003298 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003299 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003300 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003301 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003302 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003303#ifdef FEAT_PROFILE
3304 fp->uf_profiling = FALSE;
3305 fp->uf_prof_initialized = FALSE;
3306#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003307 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003308 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 }
3310 }
3311 else
3312 {
3313 char numbuf[20];
3314
3315 fp = NULL;
3316 if (fudi.fd_newkey == NULL && !eap->forceit)
3317 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003318 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319 goto erret;
3320 }
3321 if (fudi.fd_di == NULL)
3322 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003323 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003324 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 goto erret;
3326 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003327 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003328 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329 goto erret;
3330
Bram Moolenaare38eab22019-12-05 21:50:01 +01003331 // Give the function a sequential number. Can only be used with a
3332 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333 vim_free(name);
3334 sprintf(numbuf, "%d", ++func_nr);
3335 name = vim_strsave((char_u *)numbuf);
3336 if (name == NULL)
3337 goto erret;
3338 }
3339
3340 if (fp == NULL)
3341 {
3342 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3343 {
3344 int slen, plen;
3345 char_u *scriptname;
3346
Bram Moolenaare38eab22019-12-05 21:50:01 +01003347 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003349 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 {
3351 scriptname = autoload_name(name);
3352 if (scriptname != NULL)
3353 {
3354 p = vim_strchr(scriptname, '/');
3355 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003356 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003358 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003359 j = OK;
3360 vim_free(scriptname);
3361 }
3362 }
3363 if (j == FAIL)
3364 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003365 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366 goto erret;
3367 }
3368 }
3369
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003370 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 if (fp == NULL)
3372 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003373 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003374 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375
3376 if (fudi.fd_dict != NULL)
3377 {
3378 if (fudi.fd_di == NULL)
3379 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003380 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3382 if (fudi.fd_di == NULL)
3383 {
3384 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003385 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 goto erret;
3387 }
3388 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3389 {
3390 vim_free(fudi.fd_di);
3391 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003392 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 goto erret;
3394 }
3395 }
3396 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003397 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 clear_tv(&fudi.fd_di->di_tv);
3399 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003401
Bram Moolenaare38eab22019-12-05 21:50:01 +01003402 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403 flags |= FC_DICT;
3404 }
3405
Bram Moolenaare38eab22019-12-05 21:50:01 +01003406 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003407 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003408 if (overwrite)
3409 {
3410 hi = hash_find(&func_hashtab, name);
3411 hi->hi_key = UF2HIKEY(fp);
3412 }
3413 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 {
3415 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003416 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 goto erret;
3418 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003419 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 }
3421 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003422 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003423 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003424 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003425
3426 if (eap->cmdidx == CMD_def)
3427 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003428 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003429
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003430 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003431
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003432 // error messages are for the first function line
3433 SOURCING_LNUM = sourcing_lnum_top;
3434
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003435 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003436 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003437
3438 if (argtypes.ga_len > 0)
3439 {
3440 // When "varargs" is set the last name/type goes into uf_va_name
3441 // and uf_va_type.
3442 int len = argtypes.ga_len - (varargs ? 1 : 0);
3443
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003444 if (len > 0)
3445 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003446 if (fp->uf_arg_types != NULL)
3447 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003448 int i;
3449 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003450
3451 for (i = 0; i < len; ++ i)
3452 {
3453 p = ((char_u **)argtypes.ga_data)[i];
3454 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003455 // will get the type from the default value
3456 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003457 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003458 type = parse_type(&p, &fp->uf_type_list);
3459 if (type == NULL)
3460 {
3461 SOURCING_LNUM = lnum_save;
3462 goto errret_2;
3463 }
3464 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003465 }
3466 }
3467 if (varargs)
3468 {
3469 // Move the last argument "...name: type" to uf_va_name and
3470 // uf_va_type.
3471 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3472 [fp->uf_args.ga_len - 1];
3473 --fp->uf_args.ga_len;
3474 p = ((char_u **)argtypes.ga_data)[len];
3475 if (p == NULL)
3476 // todo: get type from default value
3477 fp->uf_va_type = &t_any;
3478 else
3479 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003480 if (fp->uf_va_type == NULL)
3481 {
3482 SOURCING_LNUM = lnum_save;
3483 goto errret_2;
3484 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003485 }
3486 varargs = FALSE;
3487 }
3488
3489 // parse the return type, if any
3490 if (ret_type == NULL)
3491 fp->uf_ret_type = &t_void;
3492 else
3493 {
3494 p = ret_type;
3495 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3496 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003497 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003498 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003499 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003500 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003501
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003503 if ((flags & FC_CLOSURE) != 0)
3504 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003505 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003506 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003507 }
3508 else
3509 fp->uf_scoped = NULL;
3510
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512 if (prof_def_func())
3513 func_do_profile(fp);
3514#endif
3515 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003516 if (sandbox)
3517 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003518 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003519 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 fp->uf_flags = flags;
3521 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003522 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003523 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003524 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003525 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003526 if (is_export)
3527 {
3528 fp->uf_flags |= FC_EXPORT;
3529 // let ex_export() know the export worked.
3530 is_export = FALSE;
3531 }
3532
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003533 if (eap->cmdidx == CMD_def)
3534 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003535 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3536 // :func does not use Vim9 script syntax, even in a Vim9 script file
3537 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003538
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 goto ret_free;
3540
3541erret:
3542 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003543 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544errret_2:
3545 ga_clear_strings(&newlines);
3546ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003547 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003548 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003549 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003551 if (name != name_arg)
3552 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003553 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 did_emsg |= saved_did_emsg;
3555 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003556
3557 return fp;
3558}
3559
3560/*
3561 * ":function"
3562 */
3563 void
3564ex_function(exarg_T *eap)
3565{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003566 (void)def_function(eap, NULL);
3567}
3568
3569/*
3570 * :defcompile - compile all :def functions in the current script.
3571 */
3572 void
3573ex_defcompile(exarg_T *eap UNUSED)
3574{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003575 long todo = (long)func_hashtab.ht_used;
3576 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003577 hashitem_T *hi;
3578 ufunc_T *ufunc;
3579
3580 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3581 {
3582 if (!HASHITEM_EMPTY(hi))
3583 {
3584 --todo;
3585 ufunc = HI2UF(hi);
3586 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003587 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003588 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003589 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003590
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003591 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003592 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003593 // a function has been added or removed, need to start over
3594 todo = (long)func_hashtab.ht_used;
3595 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003596 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003597 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003598 }
3599 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003600 }
3601 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602}
3603
3604/*
3605 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3606 * Return 2 if "p" starts with "s:".
3607 * Return 0 otherwise.
3608 */
3609 int
3610eval_fname_script(char_u *p)
3611{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003612 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3613 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3615 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3616 return 5;
3617 if (p[0] == 's' && p[1] == ':')
3618 return 2;
3619 return 0;
3620}
3621
3622 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003623translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624{
3625 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003626 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003627 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003628}
3629
3630/*
3631 * Return TRUE when "ufunc" has old-style "..." varargs
3632 * or named varargs "...name: type".
3633 */
3634 int
3635has_varargs(ufunc_T *ufunc)
3636{
3637 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638}
3639
3640/*
3641 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003642 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643 */
3644 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003645function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646{
3647 char_u *nm = name;
3648 char_u *p;
3649 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003650 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003651 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003653 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3654 if (no_deref)
3655 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003656 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 nm = skipwhite(nm);
3658
Bram Moolenaare38eab22019-12-05 21:50:01 +01003659 // Only accept "funcname", "funcname ", "funcname (..." and
3660 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003662 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 vim_free(p);
3664 return n;
3665}
3666
Bram Moolenaar113e1072019-01-20 15:30:40 +01003667#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 char_u *
3669get_expanded_name(char_u *name, int check)
3670{
3671 char_u *nm = name;
3672 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003673 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003675 p = trans_function_name(&nm, &is_global, FALSE,
3676 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003678 if (p != NULL && *nm == NUL
3679 && (!check || translated_function_exists(p, is_global)))
3680 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681
3682 vim_free(p);
3683 return NULL;
3684}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003685#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003686
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687/*
3688 * Function given to ExpandGeneric() to obtain the list of user defined
3689 * function names.
3690 */
3691 char_u *
3692get_user_func_name(expand_T *xp, int idx)
3693{
3694 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003695 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 static hashitem_T *hi;
3697 ufunc_T *fp;
3698
3699 if (idx == 0)
3700 {
3701 done = 0;
3702 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003703 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003705 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003706 {
3707 if (done++ > 0)
3708 ++hi;
3709 while (HASHITEM_EMPTY(hi))
3710 ++hi;
3711 fp = HI2UF(hi);
3712
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003713 // don't show dead, dict and lambda functions
3714 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003715 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003716 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717
3718 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003719 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720
3721 cat_func_name(IObuff, fp);
3722 if (xp->xp_context != EXPAND_USER_FUNC)
3723 {
3724 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003725 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 STRCAT(IObuff, ")");
3727 }
3728 return IObuff;
3729 }
3730 return NULL;
3731}
3732
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733/*
3734 * ":delfunction {name}"
3735 */
3736 void
3737ex_delfunction(exarg_T *eap)
3738{
3739 ufunc_T *fp = NULL;
3740 char_u *p;
3741 char_u *name;
3742 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003743 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744
3745 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003746 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 vim_free(fudi.fd_newkey);
3748 if (name == NULL)
3749 {
3750 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003751 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 return;
3753 }
3754 if (!ends_excmd(*skipwhite(p)))
3755 {
3756 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003757 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 return;
3759 }
3760 eap->nextcmd = check_nextcmd(p);
3761 if (eap->nextcmd != NULL)
3762 *p = NUL;
3763
3764 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003765 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 vim_free(name);
3767
3768 if (!eap->skip)
3769 {
3770 if (fp == NULL)
3771 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003772 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003773 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 return;
3775 }
3776 if (fp->uf_calls > 0)
3777 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003778 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003779 return;
3780 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003781 if (fp->uf_flags & FC_VIM9)
3782 {
3783 semsg(_("E1084: Cannot delete Vim9 script function %s"), eap->arg);
3784 return;
3785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003786
3787 if (fudi.fd_dict != NULL)
3788 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003789 // Delete the dict item that refers to the function, it will
3790 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3792 }
3793 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003794 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003795 // A normal function (not a numbered function or lambda) has a
3796 // refcount of 1 for the entry in the hashtable. When deleting
3797 // it and the refcount is more than one, it should be kept.
3798 // A numbered function and lambda should be kept if the refcount is
3799 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003800 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003801 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003802 // Function is still referenced somewhere. Don't free it but
3803 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003804 if (func_remove(fp))
3805 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003806 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003807 }
3808 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003809 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003810 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 }
3812}
3813
3814/*
3815 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003816 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 */
3818 void
3819func_unref(char_u *name)
3820{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003821 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003823 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003825 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003826 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003829 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003831 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003833 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003834 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003835 // Only delete it when it's not being used. Otherwise it's done
3836 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003837 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003838 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003839 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003840}
3841
3842/*
3843 * Unreference a Function: decrement the reference count and free it when it
3844 * becomes zero.
3845 */
3846 void
3847func_ptr_unref(ufunc_T *fp)
3848{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003849 if (fp != NULL && --fp->uf_refcount <= 0)
3850 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003851 // Only delete it when it's not being used. Otherwise it's done
3852 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003853 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003854 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 }
3856}
3857
3858/*
3859 * Count a reference to a Function.
3860 */
3861 void
3862func_ref(char_u *name)
3863{
3864 ufunc_T *fp;
3865
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003866 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003868 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003869 if (fp != NULL)
3870 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003872 // Only give an error for a numbered function.
3873 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003874 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003875}
3876
3877/*
3878 * Count a reference to a Function.
3879 */
3880 void
3881func_ptr_ref(ufunc_T *fp)
3882{
3883 if (fp != NULL)
3884 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885}
3886
3887/*
3888 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3889 * referenced from anywhere that is in use.
3890 */
3891 static int
3892can_free_funccal(funccall_T *fc, int copyID)
3893{
3894 return (fc->l_varlist.lv_copyID != copyID
3895 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003896 && fc->l_avars.dv_copyID != copyID
3897 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003898}
3899
3900/*
3901 * ":return [expr]"
3902 */
3903 void
3904ex_return(exarg_T *eap)
3905{
3906 char_u *arg = eap->arg;
3907 typval_T rettv;
3908 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003909 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910
3911 if (current_funccal == NULL)
3912 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003913 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914 return;
3915 }
3916
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003917 CLEAR_FIELD(evalarg);
3918 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3919
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 if (eap->skip)
3921 ++emsg_skip;
3922
3923 eap->nextcmd = NULL;
3924 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003925 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 {
3927 if (!eap->skip)
3928 returning = do_return(eap, FALSE, TRUE, &rettv);
3929 else
3930 clear_tv(&rettv);
3931 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003932 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 else if (!eap->skip)
3934 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003935 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003936 update_force_abort();
3937
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 /*
3939 * Return unless the expression evaluation has been cancelled due to an
3940 * aborting error, an interrupt, or an exception.
3941 */
3942 if (!aborting())
3943 returning = do_return(eap, FALSE, TRUE, NULL);
3944 }
3945
Bram Moolenaare38eab22019-12-05 21:50:01 +01003946 // When skipping or the return gets pending, advance to the next command
3947 // in this line (!returning). Otherwise, ignore the rest of the line.
3948 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 if (returning)
3950 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003951 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 eap->nextcmd = check_nextcmd(arg);
3953
3954 if (eap->skip)
3955 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003956 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957}
3958
3959/*
3960 * ":1,25call func(arg1, arg2)" function call.
3961 */
3962 void
3963ex_call(exarg_T *eap)
3964{
3965 char_u *arg = eap->arg;
3966 char_u *startarg;
3967 char_u *name;
3968 char_u *tofree;
3969 int len;
3970 typval_T rettv;
3971 linenr_T lnum;
3972 int doesrange;
3973 int failed = FALSE;
3974 funcdict_T fudi;
3975 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003976 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977
Bram Moolenaare6b53242020-07-01 17:28:33 +02003978 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 if (eap->skip)
3980 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003981 // trans_function_name() doesn't work well when skipping, use eval0()
3982 // instead to skip to any following command, e.g. for:
3983 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003985 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 clear_tv(&rettv);
3987 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003988 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 return;
3990 }
3991
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003992 tofree = trans_function_name(&arg, NULL, eap->skip,
3993 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 if (fudi.fd_newkey != NULL)
3995 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003996 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003997 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 vim_free(fudi.fd_newkey);
3999 }
4000 if (tofree == NULL)
4001 return;
4002
Bram Moolenaare38eab22019-12-05 21:50:01 +01004003 // Increase refcount on dictionary, it could get deleted when evaluating
4004 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 if (fudi.fd_dict != NULL)
4006 ++fudi.fd_dict->dv_refcount;
4007
Bram Moolenaare38eab22019-12-05 21:50:01 +01004008 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4009 // contents. For VAR_PARTIAL get its partial, unless we already have one
4010 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 len = (int)STRLEN(tofree);
4012 name = deref_func_name(tofree, &len,
4013 partial != NULL ? NULL : &partial, FALSE);
4014
Bram Moolenaare38eab22019-12-05 21:50:01 +01004015 // Skip white space to allow ":call func ()". Not good, but required for
4016 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004018 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019
4020 if (*startarg != '(')
4021 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004022 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 goto end;
4024 }
4025
4026 /*
4027 * When skipping, evaluate the function once, to find the end of the
4028 * arguments.
4029 * When the function takes a range, this is discovered after the first
4030 * call, and the loop is broken.
4031 */
4032 if (eap->skip)
4033 {
4034 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004035 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036 }
4037 else
4038 lnum = eap->line1;
4039 for ( ; lnum <= eap->line2; ++lnum)
4040 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004041 funcexe_T funcexe;
4042
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 if (!eap->skip && eap->addr_count > 0)
4044 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004045 if (lnum > curbuf->b_ml.ml_line_count)
4046 {
4047 // If the function deleted lines or switched to another buffer
4048 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004049 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004050 break;
4051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 curwin->w_cursor.lnum = lnum;
4053 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 }
4056 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004057
Bram Moolenaara80faa82020-04-12 19:37:17 +02004058 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004059 funcexe.firstline = eap->line1;
4060 funcexe.lastline = eap->line2;
4061 funcexe.doesrange = &doesrange;
4062 funcexe.evaluate = !eap->skip;
4063 funcexe.partial = partial;
4064 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004065 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066 {
4067 failed = TRUE;
4068 break;
4069 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004070 if (has_watchexpr())
4071 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004073 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004074 if (handle_subscript(&arg, &rettv,
4075 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 {
4077 failed = TRUE;
4078 break;
4079 }
4080
4081 clear_tv(&rettv);
4082 if (doesrange || eap->skip)
4083 break;
4084
Bram Moolenaare38eab22019-12-05 21:50:01 +01004085 // Stop when immediately aborting on error, or when an interrupt
4086 // occurred or an exception was thrown but not caught.
4087 // get_func_tv() returned OK, so that the check for trailing
4088 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089 if (aborting())
4090 break;
4091 }
4092 if (eap->skip)
4093 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004094 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004095
Bram Moolenaare51bb172020-02-16 19:42:23 +01004096 // When inside :try we need to check for following "| catch".
4097 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004099 // Check for trailing illegal characters and a following command.
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004100 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004102 if (!failed)
4103 {
4104 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004105 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004106 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 }
4108 else
4109 eap->nextcmd = check_nextcmd(arg);
4110 }
4111
4112end:
4113 dict_unref(fudi.fd_dict);
4114 vim_free(tofree);
4115}
4116
4117/*
4118 * Return from a function. Possibly makes the return pending. Also called
4119 * for a pending return at the ":endtry" or after returning from an extra
4120 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4121 * when called due to a ":return" command. "rettv" may point to a typval_T
4122 * with the return rettv. Returns TRUE when the return can be carried out,
4123 * FALSE when the return gets pending.
4124 */
4125 int
4126do_return(
4127 exarg_T *eap,
4128 int reanimate,
4129 int is_cmd,
4130 void *rettv)
4131{
4132 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004133 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004134
4135 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004136 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004137 current_funccal->returned = FALSE;
4138
4139 /*
4140 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4141 * not in its finally clause (which then is to be executed next) is found.
4142 * In this case, make the ":return" pending for execution at the ":endtry".
4143 * Otherwise, return normally.
4144 */
4145 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4146 if (idx >= 0)
4147 {
4148 cstack->cs_pending[idx] = CSTP_RETURN;
4149
4150 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004151 // A pending return again gets pending. "rettv" points to an
4152 // allocated variable with the rettv of the original ":return"'s
4153 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 cstack->cs_rettv[idx] = rettv;
4155 else
4156 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004157 // When undoing a return in order to make it pending, get the stored
4158 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 if (reanimate)
4160 rettv = current_funccal->rettv;
4161
4162 if (rettv != NULL)
4163 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004164 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4166 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4167 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004168 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 }
4170 else
4171 cstack->cs_rettv[idx] = NULL;
4172
4173 if (reanimate)
4174 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004175 // The pending return value could be overwritten by a ":return"
4176 // without argument in a finally clause; reset the default
4177 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 current_funccal->rettv->v_type = VAR_NUMBER;
4179 current_funccal->rettv->vval.v_number = 0;
4180 }
4181 }
4182 report_make_pending(CSTP_RETURN, rettv);
4183 }
4184 else
4185 {
4186 current_funccal->returned = TRUE;
4187
Bram Moolenaare38eab22019-12-05 21:50:01 +01004188 // If the return is carried out now, store the return value. For
4189 // a return immediately after reanimation, the value is already
4190 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191 if (!reanimate && rettv != NULL)
4192 {
4193 clear_tv(current_funccal->rettv);
4194 *current_funccal->rettv = *(typval_T *)rettv;
4195 if (!is_cmd)
4196 vim_free(rettv);
4197 }
4198 }
4199
4200 return idx < 0;
4201}
4202
4203/*
4204 * Free the variable with a pending return value.
4205 */
4206 void
4207discard_pending_return(void *rettv)
4208{
4209 free_tv((typval_T *)rettv);
4210}
4211
4212/*
4213 * Generate a return command for producing the value of "rettv". The result
4214 * is an allocated string. Used by report_pending() for verbose messages.
4215 */
4216 char_u *
4217get_return_cmd(void *rettv)
4218{
4219 char_u *s = NULL;
4220 char_u *tofree = NULL;
4221 char_u numbuf[NUMBUFLEN];
4222
4223 if (rettv != NULL)
4224 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4225 if (s == NULL)
4226 s = (char_u *)"";
4227
4228 STRCPY(IObuff, ":return ");
4229 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4230 if (STRLEN(s) + 8 >= IOSIZE)
4231 STRCPY(IObuff + IOSIZE - 4, "...");
4232 vim_free(tofree);
4233 return vim_strsave(IObuff);
4234}
4235
4236/*
4237 * Get next function line.
4238 * Called by do_cmdline() to get the next line.
4239 * Returns allocated string, or NULL for end of function.
4240 */
4241 char_u *
4242get_func_line(
4243 int c UNUSED,
4244 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004245 int indent UNUSED,
4246 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247{
4248 funccall_T *fcp = (funccall_T *)cookie;
4249 ufunc_T *fp = fcp->func;
4250 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004251 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252
Bram Moolenaare38eab22019-12-05 21:50:01 +01004253 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254 if (fcp->dbg_tick != debug_tick)
4255 {
4256 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004257 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004258 fcp->dbg_tick = debug_tick;
4259 }
4260#ifdef FEAT_PROFILE
4261 if (do_profiling == PROF_YES)
4262 func_line_end(cookie);
4263#endif
4264
4265 gap = &fp->uf_lines;
4266 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4267 || fcp->returned)
4268 retval = NULL;
4269 else
4270 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004271 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004272 while (fcp->linenr < gap->ga_len
4273 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4274 ++fcp->linenr;
4275 if (fcp->linenr >= gap->ga_len)
4276 retval = NULL;
4277 else
4278 {
4279 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004280 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281#ifdef FEAT_PROFILE
4282 if (do_profiling == PROF_YES)
4283 func_line_start(cookie);
4284#endif
4285 }
4286 }
4287
Bram Moolenaare38eab22019-12-05 21:50:01 +01004288 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004289 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004290 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004291 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004292 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004294 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295 fcp->dbg_tick = debug_tick;
4296 }
4297
4298 return retval;
4299}
4300
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301/*
4302 * Return TRUE if the currently active function should be ended, because a
4303 * return was encountered or an error occurred. Used inside a ":while".
4304 */
4305 int
4306func_has_ended(void *cookie)
4307{
4308 funccall_T *fcp = (funccall_T *)cookie;
4309
Bram Moolenaare38eab22019-12-05 21:50:01 +01004310 // Ignore the "abort" flag if the abortion behavior has been changed due to
4311 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4313 || fcp->returned);
4314}
4315
4316/*
4317 * return TRUE if cookie indicates a function which "abort"s on errors.
4318 */
4319 int
4320func_has_abort(
4321 void *cookie)
4322{
4323 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4324}
4325
4326
4327/*
4328 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4329 * Don't do this when "Func" is already a partial that was bound
4330 * explicitly (pt_auto is FALSE).
4331 * Changes "rettv" in-place.
4332 * Returns the updated "selfdict_in".
4333 */
4334 dict_T *
4335make_partial(dict_T *selfdict_in, typval_T *rettv)
4336{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004337 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004338 char_u *tofree = NULL;
4339 ufunc_T *fp;
4340 char_u fname_buf[FLEN_FIXED + 1];
4341 int error;
4342 dict_T *selfdict = selfdict_in;
4343
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004344 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4345 fp = rettv->vval.v_partial->pt_func;
4346 else
4347 {
4348 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4349 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004350 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004351 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004352 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004353 vim_free(tofree);
4354 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355
4356 if (fp != NULL && (fp->uf_flags & FC_DICT))
4357 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004358 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359
4360 if (pt != NULL)
4361 {
4362 pt->pt_refcount = 1;
4363 pt->pt_dict = selfdict;
4364 pt->pt_auto = TRUE;
4365 selfdict = NULL;
4366 if (rettv->v_type == VAR_FUNC)
4367 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004368 // Just a function: Take over the function name and use
4369 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370 pt->pt_name = rettv->vval.v_string;
4371 }
4372 else
4373 {
4374 partial_T *ret_pt = rettv->vval.v_partial;
4375 int i;
4376
Bram Moolenaare38eab22019-12-05 21:50:01 +01004377 // Partial: copy the function name, use selfdict and copy
4378 // args. Can't take over name or args, the partial might
4379 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004380 if (ret_pt->pt_name != NULL)
4381 {
4382 pt->pt_name = vim_strsave(ret_pt->pt_name);
4383 func_ref(pt->pt_name);
4384 }
4385 else
4386 {
4387 pt->pt_func = ret_pt->pt_func;
4388 func_ptr_ref(pt->pt_func);
4389 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 if (ret_pt->pt_argc > 0)
4391 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004392 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004394 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395 pt->pt_argc = 0;
4396 else
4397 {
4398 pt->pt_argc = ret_pt->pt_argc;
4399 for (i = 0; i < pt->pt_argc; i++)
4400 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4401 }
4402 }
4403 partial_unref(ret_pt);
4404 }
4405 rettv->v_type = VAR_PARTIAL;
4406 rettv->vval.v_partial = pt;
4407 }
4408 }
4409 return selfdict;
4410}
4411
4412/*
4413 * Return the name of the executed function.
4414 */
4415 char_u *
4416func_name(void *cookie)
4417{
4418 return ((funccall_T *)cookie)->func->uf_name;
4419}
4420
4421/*
4422 * Return the address holding the next breakpoint line for a funccall cookie.
4423 */
4424 linenr_T *
4425func_breakpoint(void *cookie)
4426{
4427 return &((funccall_T *)cookie)->breakpoint;
4428}
4429
4430/*
4431 * Return the address holding the debug tick for a funccall cookie.
4432 */
4433 int *
4434func_dbg_tick(void *cookie)
4435{
4436 return &((funccall_T *)cookie)->dbg_tick;
4437}
4438
4439/*
4440 * Return the nesting level for a funccall cookie.
4441 */
4442 int
4443func_level(void *cookie)
4444{
4445 return ((funccall_T *)cookie)->level;
4446}
4447
4448/*
4449 * Return TRUE when a function was ended by a ":return" command.
4450 */
4451 int
4452current_func_returned(void)
4453{
4454 return current_funccal->returned;
4455}
4456
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 int
4458free_unref_funccal(int copyID, int testing)
4459{
4460 int did_free = FALSE;
4461 int did_free_funccal = FALSE;
4462 funccall_T *fc, **pfc;
4463
4464 for (pfc = &previous_funccal; *pfc != NULL; )
4465 {
4466 if (can_free_funccal(*pfc, copyID))
4467 {
4468 fc = *pfc;
4469 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004470 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 did_free = TRUE;
4472 did_free_funccal = TRUE;
4473 }
4474 else
4475 pfc = &(*pfc)->caller;
4476 }
4477 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004478 // When a funccal was freed some more items might be garbage
4479 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004480 (void)garbage_collect(testing);
4481
4482 return did_free;
4483}
4484
4485/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004486 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 */
4488 static funccall_T *
4489get_funccal(void)
4490{
4491 int i;
4492 funccall_T *funccal;
4493 funccall_T *temp_funccal;
4494
4495 funccal = current_funccal;
4496 if (debug_backtrace_level > 0)
4497 {
4498 for (i = 0; i < debug_backtrace_level; i++)
4499 {
4500 temp_funccal = funccal->caller;
4501 if (temp_funccal)
4502 funccal = temp_funccal;
4503 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004504 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004505 debug_backtrace_level = i;
4506 }
4507 }
4508 return funccal;
4509}
4510
4511/*
4512 * Return the hashtable used for local variables in the current funccal.
4513 * Return NULL if there is no current funccal.
4514 */
4515 hashtab_T *
4516get_funccal_local_ht()
4517{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004518 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 return NULL;
4520 return &get_funccal()->l_vars.dv_hashtab;
4521}
4522
4523/*
4524 * Return the l: scope variable.
4525 * Return NULL if there is no current funccal.
4526 */
4527 dictitem_T *
4528get_funccal_local_var()
4529{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004530 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 return NULL;
4532 return &get_funccal()->l_vars_var;
4533}
4534
4535/*
4536 * Return the hashtable used for argument in the current funccal.
4537 * Return NULL if there is no current funccal.
4538 */
4539 hashtab_T *
4540get_funccal_args_ht()
4541{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004542 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543 return NULL;
4544 return &get_funccal()->l_avars.dv_hashtab;
4545}
4546
4547/*
4548 * Return the a: scope variable.
4549 * Return NULL if there is no current funccal.
4550 */
4551 dictitem_T *
4552get_funccal_args_var()
4553{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004554 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004556 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557}
4558
4559/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004560 * List function variables, if there is a function.
4561 */
4562 void
4563list_func_vars(int *first)
4564{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004565 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004566 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004567 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568}
4569
4570/*
4571 * If "ht" is the hashtable for local variables in the current funccal, return
4572 * the dict that contains it.
4573 * Otherwise return NULL.
4574 */
4575 dict_T *
4576get_current_funccal_dict(hashtab_T *ht)
4577{
4578 if (current_funccal != NULL
4579 && ht == &current_funccal->l_vars.dv_hashtab)
4580 return &current_funccal->l_vars;
4581 return NULL;
4582}
4583
4584/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004585 * Search hashitem in parent scope.
4586 */
4587 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004588find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004589{
4590 funccall_T *old_current_funccal = current_funccal;
4591 hashtab_T *ht;
4592 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004593 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004594
4595 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4596 return NULL;
4597
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004598 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004599 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004600 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004601 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004602 ht = find_var_ht(name, &varname);
4603 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004604 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004605 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004606 if (!HASHITEM_EMPTY(hi))
4607 {
4608 *pht = ht;
4609 break;
4610 }
4611 }
4612 if (current_funccal == current_funccal->func->uf_scoped)
4613 break;
4614 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004615 }
4616 current_funccal = old_current_funccal;
4617
4618 return hi;
4619}
4620
4621/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004622 * Search variable in parent scope.
4623 */
4624 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004625find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004626{
4627 dictitem_T *v = NULL;
4628 funccall_T *old_current_funccal = current_funccal;
4629 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004630 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004631
4632 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4633 return NULL;
4634
Bram Moolenaare38eab22019-12-05 21:50:01 +01004635 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004636 current_funccal = current_funccal->func->uf_scoped;
4637 while (current_funccal)
4638 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004639 ht = find_var_ht(name, &varname);
4640 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004641 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004642 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004643 if (v != NULL)
4644 break;
4645 }
4646 if (current_funccal == current_funccal->func->uf_scoped)
4647 break;
4648 current_funccal = current_funccal->func->uf_scoped;
4649 }
4650 current_funccal = old_current_funccal;
4651
4652 return v;
4653}
4654
4655/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656 * Set "copyID + 1" in previous_funccal and callers.
4657 */
4658 int
4659set_ref_in_previous_funccal(int copyID)
4660{
4661 int abort = FALSE;
4662 funccall_T *fc;
4663
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004664 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004666 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004667 abort = abort
4668 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4669 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004670 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671 }
4672 return abort;
4673}
4674
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004675 static int
4676set_ref_in_funccal(funccall_T *fc, int copyID)
4677{
4678 int abort = FALSE;
4679
4680 if (fc->fc_copyID != copyID)
4681 {
4682 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004683 abort = abort
4684 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4685 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004686 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004687 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004688 }
4689 return abort;
4690}
4691
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692/*
4693 * Set "copyID" in all local vars and arguments in the call stack.
4694 */
4695 int
4696set_ref_in_call_stack(int copyID)
4697{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004698 int abort = FALSE;
4699 funccall_T *fc;
4700 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004702 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004703 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004704
4705 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004706 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4707 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004708 abort = abort || set_ref_in_funccal(fc, copyID);
4709
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004710 return abort;
4711}
4712
4713/*
4714 * Set "copyID" in all functions available by name.
4715 */
4716 int
4717set_ref_in_functions(int copyID)
4718{
4719 int todo;
4720 hashitem_T *hi = NULL;
4721 int abort = FALSE;
4722 ufunc_T *fp;
4723
4724 todo = (int)func_hashtab.ht_used;
4725 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004727 if (!HASHITEM_EMPTY(hi))
4728 {
4729 --todo;
4730 fp = HI2UF(hi);
4731 if (!func_name_refcount(fp->uf_name))
4732 abort = abort || set_ref_in_func(NULL, fp, copyID);
4733 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 }
4735 return abort;
4736}
4737
4738/*
4739 * Set "copyID" in all function arguments.
4740 */
4741 int
4742set_ref_in_func_args(int copyID)
4743{
4744 int i;
4745 int abort = FALSE;
4746
4747 for (i = 0; i < funcargs.ga_len; ++i)
4748 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4749 copyID, NULL, NULL);
4750 return abort;
4751}
4752
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004753/*
4754 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004755 * Returns TRUE if setting references failed somehow.
4756 */
4757 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004758set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004759{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004760 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004761 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004762 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004763 char_u fname_buf[FLEN_FIXED + 1];
4764 char_u *tofree = NULL;
4765 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004766 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004767
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004768 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004769 return FALSE;
4770
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004771 if (fp_in == NULL)
4772 {
4773 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004774 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004775 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004776 if (fp != NULL)
4777 {
4778 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004779 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004780 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004781
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004782 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004783 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004784}
4785
Bram Moolenaare38eab22019-12-05 21:50:01 +01004786#endif // FEAT_EVAL