blob: de0cdb7ea51c9842d15cadcca5d3ea2026c1c03c [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
369 fp->uf_dfunc_idx = UF_NOT_COMPILED;
370 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 Moolenaar8a7d6542020-01-26 15:56:19 +0100783 static 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 Moolenaar9721fb42020-06-11 23:10:46 +0200792 char_u *after_script = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100793
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200794 if (in_vim9script())
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100795 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +0200796 // Find script-local function before global one.
797 func = find_func_with_sid(name, current_sctx.sc_sid);
798 if (func != NULL)
799 return func;
800 }
801
802 if (!in_vim9script()
803 && name[0] == K_SPECIAL
804 && name[1] == KS_EXTRA
805 && name[2] == KE_SNR)
806 {
807 long sid;
808
809 // Caller changes s: to <SNR>99_name.
810
811 after_script = name + 3;
812 sid = getdigits(&after_script);
813 if (sid == current_sctx.sc_sid && *after_script == '_')
814 ++after_script;
815 else
816 after_script = NULL;
817 }
818 if (in_vim9script() || after_script != NULL)
819 {
820 // Find imported function before global one.
821 imported = find_imported(
822 after_script == NULL ? name : after_script, 0, cctx);
823 if (imported != NULL && imported->imp_funcname != NULL)
824 {
825 hi = hash_find(&func_hashtab, imported->imp_funcname);
826 if (!HASHITEM_EMPTY(hi))
827 return HI2UF(hi);
828 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100829 }
830 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200831
Bram Moolenaara26b9702020-04-18 19:53:28 +0200832 hi = hash_find(&func_hashtab,
833 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200834 if (!HASHITEM_EMPTY(hi))
835 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100836
837 return NULL;
838}
839
840/*
841 * Find a function by name, return pointer to it in ufuncs.
842 * "cctx" is passed in a :def function to find imported functions.
843 * Return NULL for unknown or dead function.
844 */
845 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200846find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100847{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +0200848 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100849
850 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
851 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200852 return NULL;
853}
854
855/*
856 * Copy the function name of "fp" to buffer "buf".
857 * "buf" must be able to hold the function name plus three bytes.
858 * Takes care of script-local function names.
859 */
860 static void
861cat_func_name(char_u *buf, ufunc_T *fp)
862{
863 if (fp->uf_name[0] == K_SPECIAL)
864 {
865 STRCPY(buf, "<SNR>");
866 STRCAT(buf, fp->uf_name + 3);
867 }
868 else
869 STRCPY(buf, fp->uf_name);
870}
871
872/*
873 * Add a number variable "name" to dict "dp" with value "nr".
874 */
875 static void
876add_nr_var(
877 dict_T *dp,
878 dictitem_T *v,
879 char *name,
880 varnumber_T nr)
881{
882 STRCPY(v->di_key, name);
883 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
884 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
885 v->di_tv.v_type = VAR_NUMBER;
886 v->di_tv.v_lock = VAR_FIXED;
887 v->di_tv.vval.v_number = nr;
888}
889
890/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100891 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200892 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100893 static void
894free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200895{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100896 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200897
898 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
899 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100900 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200901
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100902 // When garbage collecting a funccall_T may be freed before the
903 // function that references it, clear its uf_scoped field.
904 // The function may have been redefined and point to another
905 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200906 if (fp != NULL && fp->uf_scoped == fc)
907 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200908 }
Bram Moolenaar58016442016-07-31 18:30:22 +0200909 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200910
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200911 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200912 vim_free(fc);
913}
914
915/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100916 * Free "fc" and what it contains.
917 * Can be called only when "fc" is kept beyond the period of it called,
918 * i.e. after cleanup_function_call(fc).
919 */
920 static void
921free_funccal_contents(funccall_T *fc)
922{
923 listitem_T *li;
924
925 // Free all l: variables.
926 vars_clear(&fc->l_vars.dv_hashtab);
927
928 // Free all a: variables.
929 vars_clear(&fc->l_avars.dv_hashtab);
930
931 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200932 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100933 clear_tv(&li->li_tv);
934
935 free_funccal(fc);
936}
937
938/*
Bram Moolenaar6914c642017-04-01 21:21:30 +0200939 * Handle the last part of returning from a function: free the local hashtable.
940 * Unless it is still in use by a closure.
941 */
942 static void
943cleanup_function_call(funccall_T *fc)
944{
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100945 int may_free_fc = fc->fc_refcount <= 0;
946 int free_fc = TRUE;
947
Bram Moolenaar6914c642017-04-01 21:21:30 +0200948 current_funccal = fc->caller;
949
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100950 // Free all l: variables if not referred.
951 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
952 vars_clear(&fc->l_vars.dv_hashtab);
953 else
954 free_fc = FALSE;
955
956 // If the a:000 list and the l: and a: dicts are not referenced and
957 // there is no closure using it, we can free the funccall_T and what's
958 // in it.
959 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
960 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200961 else
962 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100963 int todo;
964 hashitem_T *hi;
965 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200966
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100967 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +0200968
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100969 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +0200970 todo = (int)fc->l_avars.dv_hashtab.ht_used;
971 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
972 {
973 if (!HASHITEM_EMPTY(hi))
974 {
975 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100976 di = HI2DI(hi);
977 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +0200978 }
979 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100980 }
Bram Moolenaar6914c642017-04-01 21:21:30 +0200981
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100982 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
983 fc->l_varlist.lv_first = NULL;
984 else
985 {
986 listitem_T *li;
987
988 free_fc = FALSE;
989
990 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200991 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +0200992 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100993 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +0100994
Bram Moolenaar209b8e32019-03-14 13:43:24 +0100995 if (free_fc)
996 free_funccal(fc);
997 else
998 {
999 static int made_copy = 0;
1000
1001 // "fc" is still in use. This can happen when returning "a:000",
1002 // assigning "l:" to a global variable or defining a closure.
1003 // Link "fc" in the list for garbage collection later.
1004 fc->caller = previous_funccal;
1005 previous_funccal = fc;
1006
1007 if (want_garbage_collect)
1008 // If garbage collector is ready, clear count.
1009 made_copy = 0;
1010 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001011 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001012 // We have made a lot of copies, worth 4 Mbyte. This can happen
1013 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001014 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001015 // too much memory.
1016 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001017 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001018 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001019 }
1020}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001021/*
1022 * Unreference "fc": decrement the reference count and free it when it
1023 * becomes zero. "fp" is detached from "fc".
1024 * When "force" is TRUE we are exiting.
1025 */
1026 static void
1027funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1028{
1029 funccall_T **pfc;
1030 int i;
1031
1032 if (fc == NULL)
1033 return;
1034
1035 if (--fc->fc_refcount <= 0 && (force || (
1036 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1037 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1038 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1039 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1040 {
1041 if (fc == *pfc)
1042 {
1043 *pfc = fc->caller;
1044 free_funccal_contents(fc);
1045 return;
1046 }
1047 }
1048 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1049 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1050 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1051}
1052
1053/*
1054 * Remove the function from the function hashtable. If the function was
1055 * deleted while it still has references this was already done.
1056 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1057 */
1058 static int
1059func_remove(ufunc_T *fp)
1060{
1061 hashitem_T *hi;
1062
1063 // Return if it was already virtually deleted.
1064 if (fp->uf_flags & FC_DEAD)
1065 return FALSE;
1066
1067 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1068 if (!HASHITEM_EMPTY(hi))
1069 {
1070 // When there is a def-function index do not actually remove the
1071 // function, so we can find the index when defining the function again.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001072 if (fp->uf_def_status == UF_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001073 fp->uf_flags |= FC_DEAD;
1074 else
1075 hash_remove(&func_hashtab, hi);
1076 return TRUE;
1077 }
1078 return FALSE;
1079}
1080
1081 static void
1082func_clear_items(ufunc_T *fp)
1083{
1084 ga_clear_strings(&(fp->uf_args));
1085 ga_clear_strings(&(fp->uf_def_args));
1086 ga_clear_strings(&(fp->uf_lines));
1087 VIM_CLEAR(fp->uf_name_exp);
1088 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001089 VIM_CLEAR(fp->uf_def_arg_idx);
1090 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001091 clear_type_list(&fp->uf_type_list);
Bram Moolenaar801ab062020-06-25 19:27:56 +02001092
1093#ifdef FEAT_LUA
1094 if (fp->uf_cb_free != NULL)
1095 {
1096 fp->uf_cb_free(fp->uf_cb_state);
1097 fp->uf_cb_free = NULL;
1098 }
1099
1100 fp->uf_cb_state = NULL;
1101 fp->uf_cb = NULL;
1102#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001103#ifdef FEAT_PROFILE
1104 VIM_CLEAR(fp->uf_tml_count);
1105 VIM_CLEAR(fp->uf_tml_total);
1106 VIM_CLEAR(fp->uf_tml_self);
1107#endif
1108}
1109
1110/*
1111 * Free all things that a function contains. Does not free the function
1112 * itself, use func_free() for that.
1113 * When "force" is TRUE we are exiting.
1114 */
1115 static void
1116func_clear(ufunc_T *fp, int force)
1117{
1118 if (fp->uf_cleared)
1119 return;
1120 fp->uf_cleared = TRUE;
1121
1122 // clear this function
1123 func_clear_items(fp);
1124 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001125 clear_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001126}
1127
1128/*
1129 * Free a function and remove it from the list of functions. Does not free
1130 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001131 * When "force" is TRUE we are exiting.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001132 */
1133 static void
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001134func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001135{
1136 // Only remove it when not done already, otherwise we would remove a newer
1137 // version of the function with the same name.
1138 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1139 func_remove(fp);
1140
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001141 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001142 vim_free(fp);
1143}
1144
1145/*
1146 * Free all things that a function contains and free the function itself.
1147 * When "force" is TRUE we are exiting.
1148 */
1149 static void
1150func_clear_free(ufunc_T *fp, int force)
1151{
1152 func_clear(fp, force);
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001153 if (force || fp->uf_dfunc_idx == 0)
1154 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001155 else
1156 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001157}
1158
Bram Moolenaar6914c642017-04-01 21:21:30 +02001159
1160/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001161 * Call a user function.
1162 */
1163 static void
1164call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001165 ufunc_T *fp, // pointer to function
1166 int argcount, // nr of args
1167 typval_T *argvars, // arguments
1168 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001169 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001170 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001171{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001172 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001173 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001174 funccall_T *fc;
1175 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001176 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001177 static int depth = 0;
1178 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001179 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001180 int i;
1181 int ai;
1182 int islambda = FALSE;
1183 char_u numbuf[NUMBUFLEN];
1184 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001185#ifdef FEAT_PROFILE
1186 proftime_T wait_start;
1187 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001188 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001189#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001190 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001191
Bram Moolenaare38eab22019-12-05 21:50:01 +01001192 // If depth of calling is getting too high, don't execute the function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001193 if (depth >= p_mfd)
1194 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001195 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001196 rettv->v_type = VAR_NUMBER;
1197 rettv->vval.v_number = -1;
1198 return;
1199 }
1200 ++depth;
1201
Bram Moolenaare38eab22019-12-05 21:50:01 +01001202 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001203
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001204 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001205 if (fc == NULL)
1206 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001207 fc->caller = current_funccal;
1208 current_funccal = fc;
1209 fc->func = fp;
1210 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001211 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001212 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001213 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1214 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001215 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001216 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001217 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001218
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001219 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001220 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001221 estack_push_ufunc(fp, 1);
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001222 save_current_sctx = current_sctx;
1223 current_sctx = fp->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001224
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001225 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001226 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001227 --depth;
1228 current_funccal = fc->caller;
1229
1230 estack_pop();
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01001231 current_sctx = save_current_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001232 free_funccal(fc);
1233 return;
1234 }
1235
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001236 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1237 islambda = TRUE;
1238
1239 /*
1240 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1241 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1242 * each argument variable and saves a lot of time.
1243 */
1244 /*
1245 * Init l: variables.
1246 */
1247 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1248 if (selfdict != NULL)
1249 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001250 // Set l:self to "selfdict". Use "name" to avoid a warning from
1251 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001252 v = &fc->fixvar[fixvar_idx++].var;
1253 name = v->di_key;
1254 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001255 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1257 v->di_tv.v_type = VAR_DICT;
1258 v->di_tv.v_lock = 0;
1259 v->di_tv.vval.v_dict = selfdict;
1260 ++selfdict->dv_refcount;
1261 }
1262
1263 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001264 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001265 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001266 * Set a:000 to a list with room for the "..." arguments.
1267 */
1268 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001269 if ((fp->uf_flags & FC_NOARGS) == 0)
1270 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001271 (varnumber_T)(argcount >= fp->uf_args.ga_len
1272 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001273 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001274 if ((fp->uf_flags & FC_NOARGS) == 0)
1275 {
1276 // Use "name" to avoid a warning from some compiler that checks the
1277 // destination size.
1278 v = &fc->fixvar[fixvar_idx++].var;
1279 name = v->di_key;
1280 STRCPY(name, "000");
1281 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1282 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1283 v->di_tv.v_type = VAR_LIST;
1284 v->di_tv.v_lock = VAR_FIXED;
1285 v->di_tv.vval.v_list = &fc->l_varlist;
1286 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001287 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1289 fc->l_varlist.lv_lock = VAR_FIXED;
1290
1291 /*
1292 * Set a:firstline to "firstline" and a:lastline to "lastline".
1293 * Set a:name to named arguments.
1294 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001295 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001296 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001297 if ((fp->uf_flags & FC_NOARGS) == 0)
1298 {
1299 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001300 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001301 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001302 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001303 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001304 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001305 {
1306 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001307 typval_T def_rettv;
1308 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001309
1310 ai = i - fp->uf_args.ga_len;
1311 if (ai < 0)
1312 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001313 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 name = FUNCARG(fp, i);
1315 if (islambda)
1316 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001317
1318 // evaluate named argument default expression
1319 isdefault = ai + fp->uf_def_args.ga_len >= 0
1320 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1321 && argvars[i].vval.v_number == VVAL_NONE));
1322 if (isdefault)
1323 {
1324 char_u *default_expr = NULL;
1325 def_rettv.v_type = VAR_NUMBER;
1326 def_rettv.vval.v_number = -1;
1327
1328 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1329 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001330 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001331 {
1332 default_arg_err = 1;
1333 break;
1334 }
1335 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001336 }
1337 else
1338 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001339 if ((fp->uf_flags & FC_NOARGS) != 0)
1340 // Bail out if no a: arguments used (in lambda).
1341 break;
1342
Bram Moolenaare38eab22019-12-05 21:50:01 +01001343 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001344 sprintf((char *)numbuf, "%d", ai + 1);
1345 name = numbuf;
1346 }
1347 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1348 {
1349 v = &fc->fixvar[fixvar_idx++].var;
1350 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001351 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001352 }
1353 else
1354 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001355 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 if (v == NULL)
1357 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001358 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001359 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001361 // Note: the values are copied directly to avoid alloc/free.
1362 // "argvars" must have VAR_FIXED for v_lock.
1363 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001364 v->di_tv.v_lock = VAR_FIXED;
1365
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001366 if (addlocal)
1367 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001368 // Named arguments should be accessed without the "a:" prefix in
1369 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001370 copy_tv(&v->di_tv, &v->di_tv);
1371 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001372 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001373 else
1374 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001375
1376 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1377 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001378 listitem_T *li = &fc->l_listitems[ai];
1379
1380 li->li_tv = argvars[i];
1381 li->li_tv.v_lock = VAR_FIXED;
1382 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383 }
1384 }
1385
Bram Moolenaare38eab22019-12-05 21:50:01 +01001386 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001387 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001388
1389 if (fp->uf_flags & FC_SANDBOX)
1390 {
1391 using_sandbox = TRUE;
1392 ++sandbox;
1393 }
1394
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001395 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001396 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001397 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001398 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001399 ++no_wait_return;
1400 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001401
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001402 smsg(_("calling %s"), SOURCING_NAME);
1403 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001405 char_u buf[MSG_BUF_LEN];
1406 char_u numbuf2[NUMBUFLEN];
1407 char_u *tofree;
1408 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001410 msg_puts("(");
1411 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001412 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001413 if (i > 0)
1414 msg_puts(", ");
1415 if (argvars[i].v_type == VAR_NUMBER)
1416 msg_outnum((long)argvars[i].vval.v_number);
1417 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001419 // Do not want errors such as E724 here.
1420 ++emsg_off;
1421 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1422 --emsg_off;
1423 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001424 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001425 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001426 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001427 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1428 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001429 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001430 msg_puts((char *)s);
1431 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 }
1433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001435 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001436 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001437 msg_puts("\n"); // don't overwrite this either
1438
1439 verbose_leave_scroll();
1440 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441 }
1442#ifdef FEAT_PROFILE
1443 if (do_profiling == PROF_YES)
1444 {
1445 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001446 {
1447 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001449 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001450 if (fp->uf_profiling
1451 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1452 {
1453 ++fp->uf_tm_count;
1454 profile_start(&call_start);
1455 profile_zero(&fp->uf_tm_children);
1456 }
1457 script_prof_save(&wait_start);
1458 }
1459#endif
1460
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001461 save_current_sctx = current_sctx;
1462 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001463 save_did_emsg = did_emsg;
1464 did_emsg = FALSE;
1465
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001466 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1467 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001468 else if (islambda)
1469 {
1470 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1471
1472 // A Lambda always has the command "return {expr}". It is much faster
1473 // to evaluate {expr} directly.
1474 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001475 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001476 --ex_nesting_level;
1477 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001478 else
1479 // call do_cmdline() to execute the lines
1480 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001481 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1482
1483 --RedrawingDisabled;
1484
Bram Moolenaare38eab22019-12-05 21:50:01 +01001485 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1487 {
1488 clear_tv(rettv);
1489 rettv->v_type = VAR_NUMBER;
1490 rettv->vval.v_number = -1;
1491 }
1492
1493#ifdef FEAT_PROFILE
1494 if (do_profiling == PROF_YES && (fp->uf_profiling
1495 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1496 {
1497 profile_end(&call_start);
1498 profile_sub_wait(&wait_start, &call_start);
1499 profile_add(&fp->uf_tm_total, &call_start);
1500 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1501 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1502 {
1503 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1504 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1505 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001506 if (started_profiling)
1507 // make a ":profdel func" stop profiling the function
1508 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509 }
1510#endif
1511
Bram Moolenaare38eab22019-12-05 21:50:01 +01001512 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001513 if (p_verbose >= 12)
1514 {
1515 ++no_wait_return;
1516 verbose_enter_scroll();
1517
1518 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001519 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001521 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522 (long)fc->rettv->vval.v_number);
1523 else
1524 {
1525 char_u buf[MSG_BUF_LEN];
1526 char_u numbuf2[NUMBUFLEN];
1527 char_u *tofree;
1528 char_u *s;
1529
Bram Moolenaare38eab22019-12-05 21:50:01 +01001530 // The value may be very long. Skip the middle part, so that we
1531 // have some idea how it starts and ends. smsg() would always
1532 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001533 ++emsg_off;
1534 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1535 --emsg_off;
1536 if (s != NULL)
1537 {
1538 if (vim_strsize(s) > MSG_BUF_CLEN)
1539 {
1540 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1541 s = buf;
1542 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001543 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001544 vim_free(tofree);
1545 }
1546 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001547 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001548
1549 verbose_leave_scroll();
1550 --no_wait_return;
1551 }
1552
Bram Moolenaare31ee862020-01-07 20:59:34 +01001553 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001554 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001555 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556#ifdef FEAT_PROFILE
1557 if (do_profiling == PROF_YES)
1558 script_prof_restore(&wait_start);
1559#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001560 if (using_sandbox)
1561 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001562
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001563 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 {
1565 ++no_wait_return;
1566 verbose_enter_scroll();
1567
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001568 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001569 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570
1571 verbose_leave_scroll();
1572 --no_wait_return;
1573 }
1574
1575 did_emsg |= save_did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 --depth;
1577
Bram Moolenaar6914c642017-04-01 21:21:30 +02001578 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001579}
1580
1581/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001582 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001583 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001584 int
1585call_user_func_check(
1586 ufunc_T *fp,
1587 int argcount,
1588 typval_T *argvars,
1589 typval_T *rettv,
1590 funcexe_T *funcexe,
1591 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001592{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001593 int error;
1594 int regular_args = fp->uf_args.ga_len;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001595
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001596 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
1597 *funcexe->doesrange = TRUE;
1598 if (argcount < regular_args - fp->uf_def_args.ga_len)
1599 error = FCERR_TOOFEW;
1600 else if (!has_varargs(fp) && argcount > regular_args)
1601 error = FCERR_TOOMANY;
1602 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
1603 error = FCERR_DICT;
1604 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001605 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001606 int did_save_redo = FALSE;
1607 save_redo_T save_redo;
1608
1609 /*
1610 * Call the user function.
1611 * Save and restore search patterns, script variables and
1612 * redo buffer.
1613 */
1614 save_search_patterns();
1615 if (!ins_compl_active())
1616 {
1617 saveRedobuff(&save_redo);
1618 did_save_redo = TRUE;
1619 }
1620 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001621 call_user_func(fp, argcount, argvars, rettv, funcexe,
1622 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001623 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
1624 // Function was unreferenced while being used, free it now.
1625 func_clear_free(fp, FALSE);
1626 if (did_save_redo)
1627 restoreRedobuff(&save_redo);
1628 restore_search_patterns();
1629 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02001630 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001631 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001632}
1633
1634/*
Bram Moolenaarc2574872016-08-11 22:51:05 +02001635 * There are two kinds of function names:
1636 * 1. ordinary names, function defined with :function
1637 * 2. numbered functions and lambdas
1638 * For the first we only count the name stored in func_hashtab as a reference,
1639 * using function() does not count as a reference, because the function is
1640 * looked up by name.
1641 */
1642 static int
1643func_name_refcount(char_u *name)
1644{
1645 return isdigit(*name) || *name == '<';
1646}
1647
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001648static funccal_entry_T *funccal_stack = NULL;
1649
1650/*
1651 * Save the current function call pointer, and set it to NULL.
1652 * Used when executing autocommands and for ":source".
1653 */
1654 void
1655save_funccal(funccal_entry_T *entry)
1656{
1657 entry->top_funccal = current_funccal;
1658 entry->next = funccal_stack;
1659 funccal_stack = entry;
1660 current_funccal = NULL;
1661}
1662
1663 void
1664restore_funccal(void)
1665{
1666 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001667 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001668 else
1669 {
1670 current_funccal = funccal_stack->top_funccal;
1671 funccal_stack = funccal_stack->next;
1672 }
1673}
1674
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02001675 funccall_T *
1676get_current_funccal(void)
1677{
1678 return current_funccal;
1679}
1680
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001681/*
1682 * Mark all functions of script "sid" as deleted.
1683 */
1684 void
1685delete_script_functions(int sid)
1686{
1687 hashitem_T *hi;
1688 ufunc_T *fp;
1689 long_u todo;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001690 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001691 size_t len;
1692
1693 buf[0] = K_SPECIAL;
1694 buf[1] = KS_EXTRA;
1695 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02001696 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001697 len = STRLEN(buf);
1698
1699 todo = func_hashtab.ht_used;
1700 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1701 if (!HASHITEM_EMPTY(hi))
1702 {
Bram Moolenaar03afdcf2020-04-27 23:39:30 +02001703 fp = HI2UF(hi);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001704 if (STRNCMP(fp->uf_name, buf, len) == 0)
1705 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001706 fp->uf_flags |= FC_DEAD;
1707 func_clear(fp, TRUE);
1708 }
1709 --todo;
1710 }
1711}
1712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713#if defined(EXITFREE) || defined(PROTO)
1714 void
1715free_all_functions(void)
1716{
1717 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001718 ufunc_T *fp;
1719 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001720 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001721 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001722
Bram Moolenaare38eab22019-12-05 21:50:01 +01001723 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001724 while (current_funccal != NULL)
1725 {
1726 clear_tv(current_funccal->rettv);
1727 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02001728 if (current_funccal == NULL && funccal_stack != NULL)
1729 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001730 }
1731
Bram Moolenaare38eab22019-12-05 21:50:01 +01001732 // First clear what the functions contain. Since this may lower the
1733 // reference count of a function, it may also free a function and change
1734 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001735 while (todo > 0)
1736 {
1737 todo = func_hashtab.ht_used;
1738 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
1739 if (!HASHITEM_EMPTY(hi))
1740 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001741 // clear the def function index now
1742 fp = HI2UF(hi);
1743 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001744 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001745
Bram Moolenaare38eab22019-12-05 21:50:01 +01001746 // Only free functions that are not refcounted, those are
1747 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001748 if (func_name_refcount(fp->uf_name))
1749 ++skipped;
1750 else
1751 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001752 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001753 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02001754 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001755 {
1756 skipped = 0;
1757 break;
1758 }
1759 }
1760 --todo;
1761 }
1762 }
1763
Bram Moolenaare38eab22019-12-05 21:50:01 +01001764 // Now actually free the functions. Need to start all over every time,
1765 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01001766 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02001767 while (func_hashtab.ht_used > skipped)
1768 {
1769 todo = func_hashtab.ht_used;
1770 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 if (!HASHITEM_EMPTY(hi))
1772 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02001773 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001774 // Only free functions that are not refcounted, those are
1775 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02001776 fp = HI2UF(hi);
1777 if (func_name_refcount(fp->uf_name))
1778 ++skipped;
1779 else
1780 {
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001781 func_free(fp, FALSE);
Bram Moolenaarc2574872016-08-11 22:51:05 +02001782 skipped = 0;
1783 break;
1784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02001786 }
1787 if (skipped == 0)
1788 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001789
1790 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001791}
1792#endif
1793
1794/*
1795 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02001796 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001797 * "len" is the length of "name", or -1 for NUL terminated.
1798 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001799 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800builtin_function(char_u *name, int len)
1801{
1802 char_u *p;
1803
Bram Moolenaara26b9702020-04-18 19:53:28 +02001804 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001805 return FALSE;
1806 p = vim_strchr(name, AUTOLOAD_CHAR);
1807 return p == NULL || (len > 0 && p > name + len);
1808}
1809
1810 int
1811func_call(
1812 char_u *name,
1813 typval_T *args,
1814 partial_T *partial,
1815 dict_T *selfdict,
1816 typval_T *rettv)
1817{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01001818 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819 listitem_T *item;
1820 typval_T argv[MAX_FUNC_ARGS + 1];
1821 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001822 int r = 0;
1823
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001824 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02001825 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826 {
1827 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
1828 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001829 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001830 break;
1831 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001832 // Make a copy of each argument. This is needed to be able to set
1833 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834 copy_tv(&item->li_tv, &argv[argc++]);
1835 }
1836
1837 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001838 {
1839 funcexe_T funcexe;
1840
Bram Moolenaara80faa82020-04-12 19:37:17 +02001841 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001842 funcexe.firstline = curwin->w_cursor.lnum;
1843 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001844 funcexe.evaluate = TRUE;
1845 funcexe.partial = partial;
1846 funcexe.selfdict = selfdict;
1847 r = call_func(name, -1, rettv, argc, argv, &funcexe);
1848 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849
Bram Moolenaare38eab22019-12-05 21:50:01 +01001850 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 while (argc > 0)
1852 clear_tv(&argv[--argc]);
1853
1854 return r;
1855}
1856
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001857static int callback_depth = 0;
1858
1859 int
1860get_callback_depth(void)
1861{
1862 return callback_depth;
1863}
1864
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001866 * Invoke call_func() with a callback.
1867 */
1868 int
1869call_callback(
1870 callback_T *callback,
1871 int len, // length of "name" or -1 to use strlen()
1872 typval_T *rettv, // return value goes here
1873 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001874 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001875 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001876{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001877 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001878 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001879
Bram Moolenaara80faa82020-04-12 19:37:17 +02001880 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001881 funcexe.evaluate = TRUE;
1882 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02001883 ++callback_depth;
1884 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
1885 --callback_depth;
1886 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02001887}
1888
1889/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001890 * Give an error message for the result of a function.
1891 * Nothing if "error" is FCERR_NONE.
1892 */
1893 void
1894user_func_error(int error, char_u *name)
1895{
1896 switch (error)
1897 {
1898 case FCERR_UNKNOWN:
1899 emsg_funcname(e_unknownfunc, name);
1900 break;
1901 case FCERR_NOTMETHOD:
1902 emsg_funcname(
1903 N_("E276: Cannot use function as a method: %s"), name);
1904 break;
1905 case FCERR_DELETED:
1906 emsg_funcname(N_(e_func_deleted), name);
1907 break;
1908 case FCERR_TOOMANY:
1909 emsg_funcname((char *)e_toomanyarg, name);
1910 break;
1911 case FCERR_TOOFEW:
1912 emsg_funcname((char *)e_toofewarg, name);
1913 break;
1914 case FCERR_SCRIPT:
1915 emsg_funcname(
1916 N_("E120: Using <SID> not in a script context: %s"), name);
1917 break;
1918 case FCERR_DICT:
1919 emsg_funcname(
1920 N_("E725: Calling dict function without Dictionary: %s"),
1921 name);
1922 break;
1923 }
1924}
1925
1926/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001927 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001928 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001929 * Return FAIL when the function can't be called, OK otherwise.
1930 * Also returns OK when an error was encountered while executing the function.
1931 */
1932 int
1933call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001934 char_u *funcname, // name of the function
1935 int len, // length of "name" or -1 to use strlen()
1936 typval_T *rettv, // return value goes here
1937 int argcount_in, // number of "argvars"
1938 typval_T *argvars_in, // vars for arguments, must have "argcount"
1939 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001940 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001941{
1942 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01001943 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001945 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001946 char_u fname_buf[FLEN_FIXED + 1];
1947 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001948 char_u *fname = NULL;
1949 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950 int argcount = argcount_in;
1951 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001952 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02001953 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
1954 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02001956 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001957 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02001959 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
1960 // even when call_func() returns FAIL.
1961 rettv->v_type = VAR_UNKNOWN;
1962
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001963 if (partial != NULL)
1964 fp = partial->pt_func;
1965 if (fp == NULL)
1966 {
1967 // Make a copy of the name, if it comes from a funcref variable it
1968 // could be changed or deleted in the called function.
1969 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
1970 if (name == NULL)
1971 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001972
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001973 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1974 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001975
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001976 if (funcexe->doesrange != NULL)
1977 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001978
1979 if (partial != NULL)
1980 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001981 // When the function has a partial with a dict and there is a dict
1982 // argument, use the dict argument. That is backwards compatible.
1983 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001984 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001985 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01001986 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001987 {
1988 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001989 {
1990 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
1991 {
Bram Moolenaaref140542019-12-31 21:27:13 +01001992 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001993 goto theend;
1994 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001995 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001996 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001997 for (i = 0; i < argcount_in; ++i)
1998 argv[i + argv_clear] = argvars_in[i];
1999 argvars = argv;
2000 argcount = partial->pt_argc + argcount_in;
2001 }
2002 }
2003
Bram Moolenaaref140542019-12-31 21:27:13 +01002004 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002005 {
2006 char_u *rfname = fname;
2007
Bram Moolenaare38eab22019-12-05 21:50:01 +01002008 // Ignore "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002009 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002010 rfname = fname + 2;
2011
Bram Moolenaare38eab22019-12-05 21:50:01 +01002012 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002013 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002014 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002015
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002016 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002017 {
2018 /*
2019 * User defined function.
2020 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002021 if (fp == NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002022 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002023
Bram Moolenaare38eab22019-12-05 21:50:01 +01002024 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002025 if (fp == NULL
2026 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002027 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002028 && !aborting())
2029 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002030 // executed an autocommand, search for the function again
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002031 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002032 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002033 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002034 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2035 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002036 // loaded a package, search for the function again
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002037 fp = find_func(rfname, FALSE, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002038 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002039 if (fp == NULL)
2040 {
2041 char_u *p = untrans_function_name(rfname);
2042
2043 // If using Vim9 script try not local to the script.
2044 // TODO: should not do this if the name started with "s:".
2045 if (p != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002046 fp = find_func(p, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002047 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002048
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002049 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002050 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002051#ifdef FEAT_LUA
2052 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2053 {
2054 cfunc_T cb = fp->uf_cb;
2055
2056 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2057 }
2058#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002059 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002060 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002061 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002062 // postponed filling in the arguments, do it now
2063 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002064 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002065
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002066 if (funcexe->basetv != NULL)
2067 {
2068 // Method call: base->Method()
2069 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2070 argv[0] = *funcexe->basetv;
2071 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002072 argvars = argv;
2073 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002074 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002075
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002076 error = call_user_func_check(fp, argcount, argvars, rettv,
2077 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 }
2079 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002080 else if (funcexe->basetv != NULL)
2081 {
2082 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002083 * expr->method(): Find the method name in the table, call its
2084 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002085 */
2086 error = call_internal_method(fname, argcount, argvars, rettv,
2087 funcexe->basetv);
2088 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002089 else
2090 {
2091 /*
2092 * Find the function name in the table, call its implementation.
2093 */
2094 error = call_internal_func(fname, argcount, argvars, rettv);
2095 }
2096 /*
2097 * The function call (or "FuncUndefined" autocommand sequence) might
2098 * have been aborted by an error, an interrupt, or an explicitly thrown
2099 * exception that has not been caught so far. This situation can be
2100 * tested for by calling aborting(). For an error in an internal
2101 * function or for the "E132" error in call_user_func(), however, the
2102 * throw point at which the "force_abort" flag (temporarily reset by
2103 * emsg()) is normally updated has not been reached yet. We need to
2104 * update that flag first to make aborting() reliable.
2105 */
2106 update_force_abort();
2107 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002108 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002109 ret = OK;
2110
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002111theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112 /*
2113 * Report an error unless the argument evaluation or function call has been
2114 * cancelled due to an aborting error, an interrupt, or an exception.
2115 */
2116 if (!aborting())
2117 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002118 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002119 }
2120
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002121 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002122 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002123 clear_tv(&argv[--argv_clear + argv_base]);
2124
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002125 vim_free(tofree);
2126 vim_free(name);
2127
2128 return ret;
2129}
2130
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002131 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002132printable_func_name(ufunc_T *fp)
2133{
2134 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2135}
2136
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002137/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002138 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002139 */
2140 static void
2141list_func_head(ufunc_T *fp, int indent)
2142{
2143 int j;
2144
2145 msg_start();
2146 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002147 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002148 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002149 msg_puts("def ");
2150 else
2151 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002152 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002153 msg_putchar('(');
2154 for (j = 0; j < fp->uf_args.ga_len; ++j)
2155 {
2156 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002157 msg_puts(", ");
2158 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002159 if (fp->uf_arg_types != NULL)
2160 {
2161 char *tofree;
2162
2163 msg_puts(": ");
2164 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2165 vim_free(tofree);
2166 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002167 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2168 {
2169 msg_puts(" = ");
2170 msg_puts(((char **)(fp->uf_def_args.ga_data))
2171 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2172 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002173 }
2174 if (fp->uf_varargs)
2175 {
2176 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002177 msg_puts(", ");
2178 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002179 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002180 if (fp->uf_va_name != NULL)
2181 {
2182 if (j)
2183 msg_puts(", ");
2184 msg_puts("...");
2185 msg_puts((char *)fp->uf_va_name);
2186 if (fp->uf_va_type)
2187 {
2188 char *tofree;
2189
2190 msg_puts(": ");
2191 msg_puts(type_name(fp->uf_va_type, &tofree));
2192 vim_free(tofree);
2193 }
2194 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002195 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002196
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002197 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002198 {
2199 if (fp->uf_ret_type != &t_void)
2200 {
2201 char *tofree;
2202
2203 msg_puts(": ");
2204 msg_puts(type_name(fp->uf_ret_type, &tofree));
2205 vim_free(tofree);
2206 }
2207 }
2208 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002209 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002210 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002211 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002213 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002214 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002215 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002216 msg_clr_eos();
2217 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002218 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219}
2220
2221/*
2222 * Get a function name, translating "<SID>" and "<SNR>".
2223 * Also handles a Funcref in a List or Dictionary.
2224 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002225 * Set "*is_global" to TRUE when the function must be global, unless
2226 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002227 * flags:
2228 * TFN_INT: internal function name OK
2229 * TFN_QUIET: be quiet
2230 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002231 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232 * Advances "pp" to just after the function name (if no error).
2233 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002234 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002235trans_function_name(
2236 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002237 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002238 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002239 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002240 funcdict_T *fdp, // return: info about dictionary used
2241 partial_T **partial) // return: partial of a FuncRef
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002242{
2243 char_u *name = NULL;
2244 char_u *start;
2245 char_u *end;
2246 int lead;
2247 char_u sid_buf[20];
2248 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002249 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002250 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002251 int vim9script;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002252
2253 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002254 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002255 start = *pp;
2256
Bram Moolenaare38eab22019-12-05 21:50:01 +01002257 // Check for hard coded <SNR>: already translated function ID (from a user
2258 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002259 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2260 && (*pp)[2] == (int)KE_SNR)
2261 {
2262 *pp += 3;
2263 len = get_id_len(pp) + 3;
2264 return vim_strnsave(start, len);
2265 }
2266
Bram Moolenaare38eab22019-12-05 21:50:01 +01002267 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2268 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 lead = eval_fname_script(start);
2270 if (lead > 2)
2271 start += lead;
2272
Bram Moolenaare38eab22019-12-05 21:50:01 +01002273 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002274 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002275 lead > 2 ? 0 : FNE_CHECK_START);
2276 if (end == start)
2277 {
2278 if (!skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002279 emsg(_("E129: Function name required"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002280 goto theend;
2281 }
2282 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2283 {
2284 /*
2285 * Report an invalid expression in braces, unless the expression
2286 * evaluation has been cancelled due to an aborting error, an
2287 * interrupt, or an exception.
2288 */
2289 if (!aborting())
2290 {
2291 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002292 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002293 }
2294 else
2295 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2296 goto theend;
2297 }
2298
2299 if (lv.ll_tv != NULL)
2300 {
2301 if (fdp != NULL)
2302 {
2303 fdp->fd_dict = lv.ll_dict;
2304 fdp->fd_newkey = lv.ll_newkey;
2305 lv.ll_newkey = NULL;
2306 fdp->fd_di = lv.ll_di;
2307 }
2308 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2309 {
2310 name = vim_strsave(lv.ll_tv->vval.v_string);
2311 *pp = end;
2312 }
2313 else if (lv.ll_tv->v_type == VAR_PARTIAL
2314 && lv.ll_tv->vval.v_partial != NULL)
2315 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002316 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002317 *pp = end;
2318 if (partial != NULL)
2319 *partial = lv.ll_tv->vval.v_partial;
2320 }
2321 else
2322 {
2323 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2324 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002325 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002326 else
2327 *pp = end;
2328 name = NULL;
2329 }
2330 goto theend;
2331 }
2332
2333 if (lv.ll_name == NULL)
2334 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002335 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 *pp = end;
2337 goto theend;
2338 }
2339
Bram Moolenaare38eab22019-12-05 21:50:01 +01002340 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341 if (lv.ll_exp_name != NULL)
2342 {
2343 len = (int)STRLEN(lv.ll_exp_name);
2344 name = deref_func_name(lv.ll_exp_name, &len, partial,
2345 flags & TFN_NO_AUTOLOAD);
2346 if (name == lv.ll_exp_name)
2347 name = NULL;
2348 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002349 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350 {
2351 len = (int)(end - *pp);
2352 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD);
2353 if (name == *pp)
2354 name = NULL;
2355 }
2356 if (name != NULL)
2357 {
2358 name = vim_strsave(name);
2359 *pp = end;
2360 if (STRNCMP(name, "<SNR>", 5) == 0)
2361 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002362 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 name[0] = K_SPECIAL;
2364 name[1] = KS_EXTRA;
2365 name[2] = (int)KE_SNR;
2366 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2367 }
2368 goto theend;
2369 }
2370
2371 if (lv.ll_exp_name != NULL)
2372 {
2373 len = (int)STRLEN(lv.ll_exp_name);
2374 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2375 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2376 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002377 // When there was "s:" already or the name expanded to get a
2378 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 lv.ll_name += 2;
2380 len -= 2;
2381 lead = 2;
2382 }
2383 }
2384 else
2385 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002386 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002388 {
2389 if (is_global != NULL && lv.ll_name[0] == 'g')
2390 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002391 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002392 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 len = (int)(end - lv.ll_name);
2394 }
2395
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002396 // In Vim9 script a user function is script-local by default.
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002397 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002398
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399 /*
2400 * Copy the function name to allocated memory.
2401 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2402 * Accept <SNR>123_name() outside a script.
2403 */
2404 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002405 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002406 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002408 if (!vim9script)
2409 lead = 3;
2410 if (vim9script || (lv.ll_exp_name != NULL
2411 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 || eval_fname_sid(*pp))
2413 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002414 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002415 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002417 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 goto theend;
2419 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002420 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002421 if (vim9script)
2422 extra = 3 + (int)STRLEN(sid_buf);
2423 else
2424 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425 }
2426 }
2427 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2428 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002429 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 start);
2431 goto theend;
2432 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002433 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 {
2435 char_u *cp = vim_strchr(lv.ll_name, ':');
2436
2437 if (cp != NULL && cp < end)
2438 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002439 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 goto theend;
2441 }
2442 }
2443
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002444 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002445 if (name != NULL)
2446 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002447 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 {
2449 name[0] = K_SPECIAL;
2450 name[1] = KS_EXTRA;
2451 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002452 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 STRCPY(name + 3, sid_buf);
2454 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002455 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2456 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 }
2458 *pp = end;
2459
2460theend:
2461 clear_lval(&lv);
2462 return name;
2463}
2464
2465/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002466 * Assuming "name" is the result of trans_function_name() and it was prefixed
2467 * to use the script-local name, return the unmodified name (points into
2468 * "name"). Otherwise return NULL.
2469 * This can be used to first search for a script-local function and fall back
2470 * to the global function if not found.
2471 */
2472 char_u *
2473untrans_function_name(char_u *name)
2474{
2475 char_u *p;
2476
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002477 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002478 {
2479 p = vim_strchr(name, '_');
2480 if (p != NULL)
2481 return p + 1;
2482 }
2483 return NULL;
2484}
2485
2486/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002487 * List functions. When "regmatch" is NULL all of then.
2488 * Otherwise functions matching "regmatch".
2489 */
2490 static void
2491list_functions(regmatch_T *regmatch)
2492{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002493 int changed = func_hashtab.ht_changed;
2494 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002495 hashitem_T *hi;
2496
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002497 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002498 {
2499 if (!HASHITEM_EMPTY(hi))
2500 {
2501 ufunc_T *fp = HI2UF(hi);
2502
2503 --todo;
2504 if ((fp->uf_flags & FC_DEAD) == 0
2505 && (regmatch == NULL
2506 ? !message_filtered(fp->uf_name)
2507 && !func_name_refcount(fp->uf_name)
2508 : !isdigit(*fp->uf_name)
2509 && vim_regexec(regmatch, fp->uf_name, 0)))
2510 {
2511 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002512 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002513 {
2514 emsg(_("E454: function list was modified"));
2515 return;
2516 }
2517 }
2518 }
2519 }
2520}
2521
2522/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002523 * ":function" also supporting nested ":def".
2524 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002526 ufunc_T *
Bram Moolenaar822ba242020-05-24 23:00:18 +02002527def_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528{
2529 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002530 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 int j;
2532 int c;
2533 int saved_did_emsg;
2534 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002535 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002536 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537 char_u *p;
2538 char_u *arg;
2539 char_u *line_arg = NULL;
2540 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002541 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002542 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 garray_T newlines;
2544 int varargs = FALSE;
2545 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002546 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002547 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002548 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 int indent;
2550 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002551#define MAX_FUNC_NESTING 50
2552 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 dictitem_T *v;
2554 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002555 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002557 hashitem_T *hi;
Bram Moolenaare96a2492019-06-25 04:12:16 +02002558 int do_concat = TRUE;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002559 linenr_T sourcing_lnum_off;
2560 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002561 int is_heredoc = FALSE;
2562 char_u *skip_until = NULL;
2563 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002564 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002565
2566 /*
2567 * ":function" without argument: list functions.
2568 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02002569 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002570 {
2571 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002572 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002574 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 }
2576
2577 /*
2578 * ":function /pat": list functions matching pattern.
2579 */
2580 if (*eap->arg == '/')
2581 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02002582 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002583 if (!eap->skip)
2584 {
2585 regmatch_T regmatch;
2586
2587 c = *p;
2588 *p = NUL;
2589 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
2590 *p = c;
2591 if (regmatch.regprog != NULL)
2592 {
2593 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002594 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002595 vim_regfree(regmatch.regprog);
2596 }
2597 }
2598 if (*p == '/')
2599 ++p;
2600 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02002601 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002602 }
2603
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002604 ga_init(&newargs);
2605 ga_init(&argtypes);
2606 ga_init(&default_args);
2607
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608 /*
2609 * Get the function name. There are these situations:
2610 * func normal function name
2611 * "name" == func, "fudi.fd_dict" == NULL
2612 * dict.func new dictionary entry
2613 * "name" == NULL, "fudi.fd_dict" set,
2614 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
2615 * dict.func existing dict entry with a Funcref
2616 * "name" == func, "fudi.fd_dict" set,
2617 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2618 * dict.func existing dict entry that's not a Funcref
2619 * "name" == NULL, "fudi.fd_dict" set,
2620 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
2621 * s:func script-local function name
2622 * g:func global function name, same as "func"
2623 */
2624 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002625 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002627 // nested function, argument is (args).
2628 paren = TRUE;
2629 CLEAR_FIELD(fudi);
2630 }
2631 else
2632 {
2633 name = trans_function_name(&p, &is_global, eap->skip,
2634 TFN_NO_AUTOLOAD, &fudi, NULL);
2635 paren = (vim_strchr(p, '(') != NULL);
2636 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02002638 /*
2639 * Return on an invalid expression in braces, unless the expression
2640 * evaluation has been cancelled due to an aborting error, an
2641 * interrupt, or an exception.
2642 */
2643 if (!aborting())
2644 {
2645 if (!eap->skip && fudi.fd_newkey != NULL)
2646 semsg(_(e_dictkey), fudi.fd_newkey);
2647 vim_free(fudi.fd_newkey);
2648 return NULL;
2649 }
2650 else
2651 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653 }
2654
Bram Moolenaare38eab22019-12-05 21:50:01 +01002655 // An error in a function call during evaluation of an expression in magic
2656 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 saved_did_emsg = did_emsg;
2658 did_emsg = FALSE;
2659
2660 /*
2661 * ":function func" with only function name: list function.
2662 */
2663 if (!paren)
2664 {
2665 if (!ends_excmd(*skipwhite(p)))
2666 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002667 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668 goto ret_free;
2669 }
2670 eap->nextcmd = check_nextcmd(p);
2671 if (eap->nextcmd != NULL)
2672 *p = NUL;
2673 if (!eap->skip && !got_int)
2674 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002675 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002676 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
2677 {
2678 char_u *up = untrans_function_name(name);
2679
2680 // With Vim9 script the name was made script-local, if not
2681 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02002682 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002683 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002684 }
2685
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 if (fp != NULL)
2687 {
2688 list_func_head(fp, TRUE);
2689 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
2690 {
2691 if (FUNCLINE(fp, j) == NULL)
2692 continue;
2693 msg_putchar('\n');
2694 msg_outnum((long)(j + 1));
2695 if (j < 9)
2696 msg_putchar(' ');
2697 if (j < 99)
2698 msg_putchar(' ');
2699 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002700 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 ui_breakcheck();
2702 }
2703 if (!got_int)
2704 {
2705 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002706 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002707 msg_puts(" enddef");
2708 else
2709 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002710 }
2711 }
2712 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02002713 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 }
2715 goto ret_free;
2716 }
2717
2718 /*
2719 * ":function name(arg1, arg2)" Define function.
2720 */
2721 p = skipwhite(p);
2722 if (*p != '(')
2723 {
2724 if (!eap->skip)
2725 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002726 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727 goto ret_free;
2728 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002729 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 if (vim_strchr(p, '(') != NULL)
2731 p = vim_strchr(p, '(');
2732 }
2733 p = skipwhite(p + 1);
2734
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002735 // In Vim9 script only global functions can be redefined.
2736 if (vim9script && eap->forceit && !is_global)
2737 {
2738 emsg(_(e_nobang));
2739 goto ret_free;
2740 }
2741
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 ga_init2(&newlines, (int)sizeof(char_u *), 3);
2743
Bram Moolenaar04b12692020-05-04 23:24:44 +02002744 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002746 // Check the name of the function. Unless it's a dictionary function
2747 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002748 if (name != NULL)
2749 arg = name;
2750 else
2751 arg = fudi.fd_newkey;
2752 if (arg != NULL && (fudi.fd_di == NULL
2753 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
2754 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
2755 {
2756 if (*arg == K_SPECIAL)
2757 j = 3;
2758 else
2759 j = 0;
2760 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
2761 : eval_isnamec(arg[j])))
2762 ++j;
2763 if (arg[j] != NUL)
2764 emsg_funcname((char *)e_invarg2, arg);
2765 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002766 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002768 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 }
2770
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002771 // This may get more lines and make the pointers into the first line
2772 // invalid.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002773 if (get_function_args(&p, ')', &newargs,
2774 eap->cmdidx == CMD_def ? &argtypes : NULL,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002775 &varargs, &default_args, eap->skip,
2776 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 goto errret_2;
2778
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002779 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002781 // find the return type: :def Func(): type
2782 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002784 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02002785 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002786 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002787 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02002788 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002789 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002790 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002791 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002792 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002793 semsg(_("E1056: expected a type: %s"), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02002794 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02002795 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02002797 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002799 else
2800 // find extra arguments "range", "dict", "abort" and "closure"
2801 for (;;)
2802 {
2803 p = skipwhite(p);
2804 if (STRNCMP(p, "range", 5) == 0)
2805 {
2806 flags |= FC_RANGE;
2807 p += 5;
2808 }
2809 else if (STRNCMP(p, "dict", 4) == 0)
2810 {
2811 flags |= FC_DICT;
2812 p += 4;
2813 }
2814 else if (STRNCMP(p, "abort", 5) == 0)
2815 {
2816 flags |= FC_ABORT;
2817 p += 5;
2818 }
2819 else if (STRNCMP(p, "closure", 7) == 0)
2820 {
2821 flags |= FC_CLOSURE;
2822 p += 7;
2823 if (current_funccal == NULL)
2824 {
2825 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
2826 name == NULL ? (char_u *)"" : name);
2827 goto erret;
2828 }
2829 }
2830 else
2831 break;
2832 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002833
Bram Moolenaare38eab22019-12-05 21:50:01 +01002834 // When there is a line break use what follows for the function body.
2835 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836 if (*p == '\n')
2837 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02002838 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02002839 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
2840 && eap->cmdidx != CMD_def)
Bram Moolenaare7e48382020-07-22 18:17:08 +02002841 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def))
2842 && !eap->skip
2843 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02002844 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845
2846 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002847 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
2848 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 */
2850 if (KeyTyped)
2851 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002852 // Check if the function already exists, don't let the user type the
2853 // whole function before telling him it doesn't work! For a script we
2854 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 if (!eap->skip && !eap->forceit)
2856 {
2857 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002858 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002859 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 emsg_funcname(e_funcexts, name);
2861 }
2862
2863 if (!eap->skip && did_emsg)
2864 goto erret;
2865
Bram Moolenaare38eab22019-12-05 21:50:01 +01002866 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 cmdline_row = msg_row;
2868 }
2869
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002870 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002871 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002872
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 indent = 2;
2874 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002875 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876 for (;;)
2877 {
2878 if (KeyTyped)
2879 {
2880 msg_scroll = TRUE;
2881 saved_wait_return = FALSE;
2882 }
2883 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884
2885 if (line_arg != NULL)
2886 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002887 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 theline = line_arg;
2889 p = vim_strchr(theline, '\n');
2890 if (p == NULL)
2891 line_arg += STRLEN(line_arg);
2892 else
2893 {
2894 *p = NUL;
2895 line_arg = p + 1;
2896 }
2897 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02002899 {
2900 vim_free(line_to_free);
2901 if (eap->getline == NULL)
Bram Moolenaare96a2492019-06-25 04:12:16 +02002902 theline = getcmdline(':', 0L, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002903 else
Bram Moolenaare96a2492019-06-25 04:12:16 +02002904 theline = eap->getline(':', eap->cookie, indent, do_concat);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002905 line_to_free = theline;
2906 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 if (KeyTyped)
2908 lines_left = Rows - 1;
2909 if (theline == NULL)
2910 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002911 if (eap->cmdidx == CMD_def)
2912 emsg(_("E1057: Missing :enddef"));
2913 else
2914 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 goto erret;
2916 }
2917
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002918 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02002919 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002920 if (SOURCING_LNUM < sourcing_lnum_off)
2921 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002922 else
2923 sourcing_lnum_off = 0;
2924
2925 if (skip_until != NULL)
2926 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002927 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002928 // * ":append" and "."
2929 // * ":python <<EOF" and "EOF"
2930 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
2931 if (heredoc_trimmed == NULL
2932 || (is_heredoc && skipwhite(theline) == theline)
2933 || STRNCMP(theline, heredoc_trimmed,
2934 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02002935 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002936 if (heredoc_trimmed == NULL)
2937 p = theline;
2938 else if (is_heredoc)
2939 p = skipwhite(theline) == theline
2940 ? theline : theline + STRLEN(heredoc_trimmed);
2941 else
2942 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02002943 if (STRCMP(p, skip_until) == 0)
2944 {
2945 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002946 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaare96a2492019-06-25 04:12:16 +02002947 do_concat = TRUE;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02002948 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02002949 }
2950 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 }
2952 else
2953 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002954 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01002955 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956 ;
2957
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002958 // Check for "endfunction" or "enddef".
2959 if (checkforcmd(&p, nesting_def[nesting]
2960 ? "enddef" : "endfunction", 4) && nesting-- == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961 {
Bram Moolenaar53564f72017-06-24 14:48:11 +02002962 char_u *nextcmd = NULL;
2963
Bram Moolenaar663bb232017-06-22 19:12:10 +02002964 if (*p == '|')
Bram Moolenaar53564f72017-06-24 14:48:11 +02002965 nextcmd = p + 1;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002966 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02002967 nextcmd = line_arg;
Bram Moolenaar663bb232017-06-22 19:12:10 +02002968 else if (*p != NUL && *p != '"' && p_verbose > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002969 give_warning2(eap->cmdidx == CMD_def
2970 ? (char_u *)_("W1001: Text found after :enddef: %s")
2971 : (char_u *)_("W22: Text found after :endfunction: %s"),
Bram Moolenaarf8be4612017-06-23 20:52:40 +02002972 p, TRUE);
Bram Moolenaar53564f72017-06-24 14:48:11 +02002973 if (nextcmd != NULL)
2974 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002975 // Another command follows. If the line came from "eap" we
2976 // can simply point into it, otherwise we need to change
2977 // "eap->cmdlinep".
Bram Moolenaar53564f72017-06-24 14:48:11 +02002978 eap->nextcmd = nextcmd;
2979 if (line_to_free != NULL)
2980 {
2981 vim_free(*eap->cmdlinep);
2982 *eap->cmdlinep = line_to_free;
2983 line_to_free = NULL;
2984 }
2985 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002986 break;
2987 }
2988
Bram Moolenaare38eab22019-12-05 21:50:01 +01002989 // Increase indent inside "if", "while", "for" and "try", decrease
2990 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002991 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992 indent -= 2;
2993 else if (STRNCMP(p, "if", 2) == 0
2994 || STRNCMP(p, "wh", 2) == 0
2995 || STRNCMP(p, "for", 3) == 0
2996 || STRNCMP(p, "try", 3) == 0)
2997 indent += 2;
2998
Bram Moolenaare38eab22019-12-05 21:50:01 +01002999 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003000 // Only recognize "def" inside "def", not inside "function",
3001 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003002 c = *p;
Bram Moolenaar673660a2020-01-26 16:50:05 +01003003 if (checkforcmd(&p, "function", 2)
3004 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005 {
3006 if (*p == '!')
3007 p = skipwhite(p + 1);
3008 p += eval_fname_script(p);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003009 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003010 if (*skipwhite(p) == '(')
3011 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003012 if (nesting == MAX_FUNC_NESTING - 1)
3013 emsg(_("E1058: function nesting too deep"));
3014 else
3015 {
3016 ++nesting;
3017 nesting_def[nesting] = (c == 'd');
3018 indent += 2;
3019 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 }
3021 }
3022
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003023 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024 p = skip_range(p, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003025 if (eap->cmdidx != CMD_def
3026 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003027 || (p[0] == 'c'
3028 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3029 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3030 && (STRNCMP(&p[3], "nge", 3) != 0
3031 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003032 || (p[0] == 'i'
3033 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003034 && (!ASCII_ISALPHA(p[2])
3035 || (p[2] == 's'
3036 && (!ASCII_ISALPHA(p[3])
3037 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 skip_until = vim_strsave((char_u *)".");
3039
Bram Moolenaare38eab22019-12-05 21:50:01 +01003040 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 arg = skipwhite(skiptowhite(p));
3042 if (arg[0] == '<' && arg[1] =='<'
3043 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003044 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3045 || ((p[2] == '3' || p[2] == 'x')
3046 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 || (p[0] == 'p' && p[1] == 'e'
3048 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3049 || (p[0] == 't' && p[1] == 'c'
3050 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3051 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3052 && !ASCII_ISALPHA(p[3]))
3053 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3054 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3055 || (p[0] == 'm' && p[1] == 'z'
3056 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3057 ))
3058 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003059 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003060 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003061 if (STRNCMP(p, "trim", 4) == 0)
3062 {
3063 // Ignore leading white space.
3064 p = skipwhite(p + 4);
3065 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003066 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003067 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 if (*p == NUL)
3069 skip_until = vim_strsave((char_u *)".");
3070 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003071 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003072 do_concat = FALSE;
3073 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003075
3076 // Check for ":let v =<< [trim] EOF"
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003077 // and ":let [a, b] =<< [trim] EOF"
Bram Moolenaar8471e572019-05-19 21:37:18 +02003078 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003079 if (*arg == '[')
3080 arg = vim_strchr(arg, ']');
3081 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003082 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003083 arg = skipwhite(skiptowhite(arg));
3084 if ( arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
3085 && ((p[0] == 'l'
3086 && p[1] == 'e'
3087 && (!ASCII_ISALNUM(p[2])
3088 || (p[2] == 't' && !ASCII_ISALNUM(p[3]))))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003089 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003090 p = skipwhite(arg + 3);
3091 if (STRNCMP(p, "trim", 4) == 0)
3092 {
3093 // Ignore leading white space.
3094 p = skipwhite(p + 4);
3095 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003096 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003097 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003098 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003099 do_concat = FALSE;
3100 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003101 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003102 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 }
3104
Bram Moolenaare38eab22019-12-05 21:50:01 +01003105 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003106 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003107 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108
Bram Moolenaare38eab22019-12-05 21:50:01 +01003109 // Copy the line to newly allocated memory. get_one_sourceline()
3110 // allocates 250 bytes per line, this saves 80% on average. The cost
3111 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003113 if (p == NULL)
3114 goto erret;
3115 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116
Bram Moolenaare38eab22019-12-05 21:50:01 +01003117 // Add NULL lines for continuation lines, so that the line count is
3118 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003119 while (sourcing_lnum_off-- > 0)
3120 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3121
Bram Moolenaare38eab22019-12-05 21:50:01 +01003122 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 if (line_arg != NULL && *line_arg == NUL)
3124 line_arg = NULL;
3125 }
3126
Bram Moolenaare38eab22019-12-05 21:50:01 +01003127 // Don't define the function when skipping commands or when an error was
3128 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 if (eap->skip || did_emsg)
3130 goto erret;
3131
3132 /*
3133 * If there are no errors, add the function
3134 */
3135 if (fudi.fd_dict == NULL)
3136 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003137 hashtab_T *ht;
3138
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 v = find_var(name, &ht, FALSE);
3140 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3141 {
3142 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3143 name);
3144 goto erret;
3145 }
3146
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003147 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003148 if (fp != NULL)
3149 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003150 int dead = fp->uf_flags & FC_DEAD;
3151
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003152 // Function can be replaced with "function!" and when sourcing the
3153 // same script again, but only once.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003154 if (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003155 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
3156 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003157 {
3158 emsg_funcname(e_funcexts, name);
3159 goto erret;
3160 }
3161 if (fp->uf_calls > 0)
3162 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003163 emsg_funcname(
3164 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003165 name);
3166 goto erret;
3167 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003168 if (fp->uf_refcount > 1)
3169 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003170 // This function is referenced somewhere, don't redefine it but
3171 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003172 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003173 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003174 fp = NULL;
3175 overwrite = TRUE;
3176 }
3177 else
3178 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003179 char_u *exp_name = fp->uf_name_exp;
3180
3181 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003182 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003183 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003184 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003185 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003186 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003187#ifdef FEAT_PROFILE
3188 fp->uf_profiling = FALSE;
3189 fp->uf_prof_initialized = FALSE;
3190#endif
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003191 clear_def_function(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003192 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003193 }
3194 }
3195 else
3196 {
3197 char numbuf[20];
3198
3199 fp = NULL;
3200 if (fudi.fd_newkey == NULL && !eap->forceit)
3201 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003202 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 goto erret;
3204 }
3205 if (fudi.fd_di == NULL)
3206 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003207 // Can't add a function to a locked dictionary
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003208 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 goto erret;
3210 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003211 // Can't change an existing function if it is locked
Bram Moolenaar05c00c02019-02-11 22:00:11 +01003212 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 goto erret;
3214
Bram Moolenaare38eab22019-12-05 21:50:01 +01003215 // Give the function a sequential number. Can only be used with a
3216 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 vim_free(name);
3218 sprintf(numbuf, "%d", ++func_nr);
3219 name = vim_strsave((char_u *)numbuf);
3220 if (name == NULL)
3221 goto erret;
3222 }
3223
3224 if (fp == NULL)
3225 {
3226 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3227 {
3228 int slen, plen;
3229 char_u *scriptname;
3230
Bram Moolenaare38eab22019-12-05 21:50:01 +01003231 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003233 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 {
3235 scriptname = autoload_name(name);
3236 if (scriptname != NULL)
3237 {
3238 p = vim_strchr(scriptname, '/');
3239 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003240 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003242 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003243 j = OK;
3244 vim_free(scriptname);
3245 }
3246 }
3247 if (j == FAIL)
3248 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003249 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 goto erret;
3251 }
3252 }
3253
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003254 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003255 if (fp == NULL)
3256 goto erret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003257 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED
Bram Moolenaar822ba242020-05-24 23:00:18 +02003258 : UF_NOT_COMPILED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259
3260 if (fudi.fd_dict != NULL)
3261 {
3262 if (fudi.fd_di == NULL)
3263 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003264 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3266 if (fudi.fd_di == NULL)
3267 {
3268 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003269 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 goto erret;
3271 }
3272 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3273 {
3274 vim_free(fudi.fd_di);
3275 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003276 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 goto erret;
3278 }
3279 }
3280 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003281 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 clear_tv(&fudi.fd_di->di_tv);
3283 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285
Bram Moolenaare38eab22019-12-05 21:50:01 +01003286 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003287 flags |= FC_DICT;
3288 }
3289
Bram Moolenaare38eab22019-12-05 21:50:01 +01003290 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003291 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003292 if (overwrite)
3293 {
3294 hi = hash_find(&func_hashtab, name);
3295 hi->hi_key = UF2HIKEY(fp);
3296 }
3297 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003298 {
3299 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003300 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003301 goto erret;
3302 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003303 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 }
3305 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003306 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003308 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003309
3310 if (eap->cmdidx == CMD_def)
3311 {
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003312 int lnum_save = SOURCING_LNUM;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003313
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003314 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003315
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003316 // error messages are for the first function line
3317 SOURCING_LNUM = sourcing_lnum_top;
3318
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003319 // parse the argument types
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003320 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003321
3322 if (argtypes.ga_len > 0)
3323 {
3324 // When "varargs" is set the last name/type goes into uf_va_name
3325 // and uf_va_type.
3326 int len = argtypes.ga_len - (varargs ? 1 : 0);
3327
Bram Moolenaar0b76b422020-04-07 22:05:08 +02003328 if (len > 0)
3329 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003330 if (fp->uf_arg_types != NULL)
3331 {
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003332 int i;
3333 type_T *type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003334
3335 for (i = 0; i < len; ++ i)
3336 {
3337 p = ((char_u **)argtypes.ga_data)[i];
3338 if (p == NULL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003339 // will get the type from the default value
3340 type = &t_unknown;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003341 else
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003342 type = parse_type(&p, &fp->uf_type_list);
3343 if (type == NULL)
3344 {
3345 SOURCING_LNUM = lnum_save;
3346 goto errret_2;
3347 }
3348 fp->uf_arg_types[i] = type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003349 }
3350 }
3351 if (varargs)
3352 {
3353 // Move the last argument "...name: type" to uf_va_name and
3354 // uf_va_type.
3355 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
3356 [fp->uf_args.ga_len - 1];
3357 --fp->uf_args.ga_len;
3358 p = ((char_u **)argtypes.ga_data)[len];
3359 if (p == NULL)
3360 // todo: get type from default value
3361 fp->uf_va_type = &t_any;
3362 else
3363 fp->uf_va_type = parse_type(&p, &fp->uf_type_list);
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003364 if (fp->uf_va_type == NULL)
3365 {
3366 SOURCING_LNUM = lnum_save;
3367 goto errret_2;
3368 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003369 }
3370 varargs = FALSE;
3371 }
3372
3373 // parse the return type, if any
3374 if (ret_type == NULL)
3375 fp->uf_ret_type = &t_void;
3376 else
3377 {
3378 p = ret_type;
3379 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list);
3380 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003381 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003382 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003383 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003384 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003385
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003387 if ((flags & FC_CLOSURE) != 0)
3388 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003389 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003390 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003391 }
3392 else
3393 fp->uf_scoped = NULL;
3394
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 if (prof_def_func())
3397 func_do_profile(fp);
3398#endif
3399 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003400 if (sandbox)
3401 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003402 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003403 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 fp->uf_flags = flags;
3405 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003406 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003407 fp->uf_script_ctx = current_sctx;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003408 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003409 if (is_export)
3410 {
3411 fp->uf_flags |= FC_EXPORT;
3412 // let ex_export() know the export worked.
3413 is_export = FALSE;
3414 }
3415
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003416 if (eap->cmdidx == CMD_def)
3417 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003418 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3419 // :func does not use Vim9 script syntax, even in a Vim9 script file
3420 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003421
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 goto ret_free;
3423
3424erret:
3425 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003426 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427errret_2:
3428 ga_clear_strings(&newlines);
3429ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003430 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 vim_free(skip_until);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003432 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003434 if (name != name_arg)
3435 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003436 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003437 did_emsg |= saved_did_emsg;
3438 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003439
3440 return fp;
3441}
3442
3443/*
3444 * ":function"
3445 */
3446 void
3447ex_function(exarg_T *eap)
3448{
Bram Moolenaar822ba242020-05-24 23:00:18 +02003449 (void)def_function(eap, NULL);
3450}
3451
3452/*
3453 * :defcompile - compile all :def functions in the current script.
3454 */
3455 void
3456ex_defcompile(exarg_T *eap UNUSED)
3457{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003458 long todo = (long)func_hashtab.ht_used;
3459 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003460 hashitem_T *hi;
3461 ufunc_T *ufunc;
3462
3463 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3464 {
3465 if (!HASHITEM_EMPTY(hi))
3466 {
3467 --todo;
3468 ufunc = HI2UF(hi);
3469 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003470 && ufunc->uf_def_status == UF_TO_BE_COMPILED)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003471 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02003472 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003473
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003474 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003475 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003476 // a function has been added or removed, need to start over
3477 todo = (long)func_hashtab.ht_used;
3478 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003479 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003480 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003481 }
3482 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003483 }
3484 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485}
3486
3487/*
3488 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
3489 * Return 2 if "p" starts with "s:".
3490 * Return 0 otherwise.
3491 */
3492 int
3493eval_fname_script(char_u *p)
3494{
Bram Moolenaare38eab22019-12-05 21:50:01 +01003495 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
3496 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003497 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
3498 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
3499 return 5;
3500 if (p[0] == 's' && p[1] == ':')
3501 return 2;
3502 return 0;
3503}
3504
3505 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003506translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507{
3508 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02003509 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003510 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003511}
3512
3513/*
3514 * Return TRUE when "ufunc" has old-style "..." varargs
3515 * or named varargs "...name: type".
3516 */
3517 int
3518has_varargs(ufunc_T *ufunc)
3519{
3520 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003521}
3522
3523/*
3524 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003525 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526 */
3527 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003528function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003529{
3530 char_u *nm = name;
3531 char_u *p;
3532 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003533 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003534 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003536 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
3537 if (no_deref)
3538 flag |= TFN_NO_DEREF;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003539 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540 nm = skipwhite(nm);
3541
Bram Moolenaare38eab22019-12-05 21:50:01 +01003542 // Only accept "funcname", "funcname ", "funcname (..." and
3543 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003545 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 vim_free(p);
3547 return n;
3548}
3549
Bram Moolenaar113e1072019-01-20 15:30:40 +01003550#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 char_u *
3552get_expanded_name(char_u *name, int check)
3553{
3554 char_u *nm = name;
3555 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003556 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003558 p = trans_function_name(&nm, &is_global, FALSE,
3559 TFN_INT|TFN_QUIET, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003561 if (p != NULL && *nm == NUL
3562 && (!check || translated_function_exists(p, is_global)))
3563 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564
3565 vim_free(p);
3566 return NULL;
3567}
Bram Moolenaar113e1072019-01-20 15:30:40 +01003568#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003569
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570/*
3571 * Function given to ExpandGeneric() to obtain the list of user defined
3572 * function names.
3573 */
3574 char_u *
3575get_user_func_name(expand_T *xp, int idx)
3576{
3577 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003578 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 static hashitem_T *hi;
3580 ufunc_T *fp;
3581
3582 if (idx == 0)
3583 {
3584 done = 0;
3585 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003586 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003588 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 {
3590 if (done++ > 0)
3591 ++hi;
3592 while (HASHITEM_EMPTY(hi))
3593 ++hi;
3594 fp = HI2UF(hi);
3595
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003596 // don't show dead, dict and lambda functions
3597 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02003598 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003599 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600
3601 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003602 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603
3604 cat_func_name(IObuff, fp);
3605 if (xp->xp_context != EXPAND_USER_FUNC)
3606 {
3607 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003608 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 STRCAT(IObuff, ")");
3610 }
3611 return IObuff;
3612 }
3613 return NULL;
3614}
3615
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616/*
3617 * ":delfunction {name}"
3618 */
3619 void
3620ex_delfunction(exarg_T *eap)
3621{
3622 ufunc_T *fp = NULL;
3623 char_u *p;
3624 char_u *name;
3625 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003626 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627
3628 p = eap->arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003629 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 vim_free(fudi.fd_newkey);
3631 if (name == NULL)
3632 {
3633 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003634 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 return;
3636 }
3637 if (!ends_excmd(*skipwhite(p)))
3638 {
3639 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003640 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 return;
3642 }
3643 eap->nextcmd = check_nextcmd(p);
3644 if (eap->nextcmd != NULL)
3645 *p = NUL;
3646
3647 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003648 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 vim_free(name);
3650
3651 if (!eap->skip)
3652 {
3653 if (fp == NULL)
3654 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02003655 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003656 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 return;
3658 }
3659 if (fp->uf_calls > 0)
3660 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003661 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662 return;
3663 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003664 if (fp->uf_flags & FC_VIM9)
3665 {
3666 semsg(_("E1084: Cannot delete Vim9 script function %s"), eap->arg);
3667 return;
3668 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669
3670 if (fudi.fd_dict != NULL)
3671 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003672 // Delete the dict item that refers to the function, it will
3673 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 dictitem_remove(fudi.fd_dict, fudi.fd_di);
3675 }
3676 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003677 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003678 // A normal function (not a numbered function or lambda) has a
3679 // refcount of 1 for the entry in the hashtable. When deleting
3680 // it and the refcount is more than one, it should be kept.
3681 // A numbered function and lambda should be kept if the refcount is
3682 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003683 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003684 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003685 // Function is still referenced somewhere. Don't free it but
3686 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003687 if (func_remove(fp))
3688 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003689 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003690 }
3691 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003692 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003693 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 }
3695}
3696
3697/*
3698 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003699 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 */
3701 void
3702func_unref(char_u *name)
3703{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003704 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003706 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003708 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003709 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003712 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01003714 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003715 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003716 if (fp != NULL && --fp->uf_refcount <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003718 // Only delete it when it's not being used. Otherwise it's done
3719 // when "uf_calls" becomes zero.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003720 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003721 func_clear_free(fp, FALSE);
Bram Moolenaar97baee82016-07-26 20:46:08 +02003722 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003723}
3724
3725/*
3726 * Unreference a Function: decrement the reference count and free it when it
3727 * becomes zero.
3728 */
3729 void
3730func_ptr_unref(ufunc_T *fp)
3731{
Bram Moolenaar97baee82016-07-26 20:46:08 +02003732 if (fp != NULL && --fp->uf_refcount <= 0)
3733 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003734 // Only delete it when it's not being used. Otherwise it's done
3735 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02003736 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003737 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 }
3739}
3740
3741/*
3742 * Count a reference to a Function.
3743 */
3744 void
3745func_ref(char_u *name)
3746{
3747 ufunc_T *fp;
3748
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003749 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003751 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003752 if (fp != NULL)
3753 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 // Only give an error for a numbered function.
3756 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01003757 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003758}
3759
3760/*
3761 * Count a reference to a Function.
3762 */
3763 void
3764func_ptr_ref(ufunc_T *fp)
3765{
3766 if (fp != NULL)
3767 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768}
3769
3770/*
3771 * Return TRUE if items in "fc" do not have "copyID". That means they are not
3772 * referenced from anywhere that is in use.
3773 */
3774 static int
3775can_free_funccal(funccall_T *fc, int copyID)
3776{
3777 return (fc->l_varlist.lv_copyID != copyID
3778 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003779 && fc->l_avars.dv_copyID != copyID
3780 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781}
3782
3783/*
3784 * ":return [expr]"
3785 */
3786 void
3787ex_return(exarg_T *eap)
3788{
3789 char_u *arg = eap->arg;
3790 typval_T rettv;
3791 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003792 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793
3794 if (current_funccal == NULL)
3795 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003796 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 return;
3798 }
3799
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02003800 CLEAR_FIELD(evalarg);
3801 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
3802
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 if (eap->skip)
3804 ++emsg_skip;
3805
3806 eap->nextcmd = NULL;
3807 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02003808 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 {
3810 if (!eap->skip)
3811 returning = do_return(eap, FALSE, TRUE, &rettv);
3812 else
3813 clear_tv(&rettv);
3814 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003815 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 else if (!eap->skip)
3817 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003818 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01003819 update_force_abort();
3820
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 /*
3822 * Return unless the expression evaluation has been cancelled due to an
3823 * aborting error, an interrupt, or an exception.
3824 */
3825 if (!aborting())
3826 returning = do_return(eap, FALSE, TRUE, NULL);
3827 }
3828
Bram Moolenaare38eab22019-12-05 21:50:01 +01003829 // When skipping or the return gets pending, advance to the next command
3830 // in this line (!returning). Otherwise, ignore the rest of the line.
3831 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 if (returning)
3833 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003834 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 eap->nextcmd = check_nextcmd(arg);
3836
3837 if (eap->skip)
3838 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02003839 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840}
3841
3842/*
3843 * ":1,25call func(arg1, arg2)" function call.
3844 */
3845 void
3846ex_call(exarg_T *eap)
3847{
3848 char_u *arg = eap->arg;
3849 char_u *startarg;
3850 char_u *name;
3851 char_u *tofree;
3852 int len;
3853 typval_T rettv;
3854 linenr_T lnum;
3855 int doesrange;
3856 int failed = FALSE;
3857 funcdict_T fudi;
3858 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003859 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003860
Bram Moolenaare6b53242020-07-01 17:28:33 +02003861 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862 if (eap->skip)
3863 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003864 // trans_function_name() doesn't work well when skipping, use eval0()
3865 // instead to skip to any following command, e.g. for:
3866 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003867 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003868 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 clear_tv(&rettv);
3870 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003871 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872 return;
3873 }
3874
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003875 tofree = trans_function_name(&arg, NULL, eap->skip,
3876 TFN_INT, &fudi, &partial);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 if (fudi.fd_newkey != NULL)
3878 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003879 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003880 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 vim_free(fudi.fd_newkey);
3882 }
3883 if (tofree == NULL)
3884 return;
3885
Bram Moolenaare38eab22019-12-05 21:50:01 +01003886 // Increase refcount on dictionary, it could get deleted when evaluating
3887 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888 if (fudi.fd_dict != NULL)
3889 ++fudi.fd_dict->dv_refcount;
3890
Bram Moolenaare38eab22019-12-05 21:50:01 +01003891 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
3892 // contents. For VAR_PARTIAL get its partial, unless we already have one
3893 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 len = (int)STRLEN(tofree);
3895 name = deref_func_name(tofree, &len,
3896 partial != NULL ? NULL : &partial, FALSE);
3897
Bram Moolenaare38eab22019-12-05 21:50:01 +01003898 // Skip white space to allow ":call func ()". Not good, but required for
3899 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003900 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003901 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003902
3903 if (*startarg != '(')
3904 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003905 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 goto end;
3907 }
3908
3909 /*
3910 * When skipping, evaluate the function once, to find the end of the
3911 * arguments.
3912 * When the function takes a range, this is discovered after the first
3913 * call, and the loop is broken.
3914 */
3915 if (eap->skip)
3916 {
3917 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003918 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 }
3920 else
3921 lnum = eap->line1;
3922 for ( ; lnum <= eap->line2; ++lnum)
3923 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003924 funcexe_T funcexe;
3925
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 if (!eap->skip && eap->addr_count > 0)
3927 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003928 if (lnum > curbuf->b_ml.ml_line_count)
3929 {
3930 // If the function deleted lines or switched to another buffer
3931 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003932 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01003933 break;
3934 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 curwin->w_cursor.lnum = lnum;
3936 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003937 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 }
3939 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003940
Bram Moolenaara80faa82020-04-12 19:37:17 +02003941 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003942 funcexe.firstline = eap->line1;
3943 funcexe.lastline = eap->line2;
3944 funcexe.doesrange = &doesrange;
3945 funcexe.evaluate = !eap->skip;
3946 funcexe.partial = partial;
3947 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003948 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003949 {
3950 failed = TRUE;
3951 break;
3952 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01003953 if (has_watchexpr())
3954 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02003956 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02003957 if (handle_subscript(&arg, &rettv,
3958 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003959 {
3960 failed = TRUE;
3961 break;
3962 }
3963
3964 clear_tv(&rettv);
3965 if (doesrange || eap->skip)
3966 break;
3967
Bram Moolenaare38eab22019-12-05 21:50:01 +01003968 // Stop when immediately aborting on error, or when an interrupt
3969 // occurred or an exception was thrown but not caught.
3970 // get_func_tv() returned OK, so that the check for trailing
3971 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003972 if (aborting())
3973 break;
3974 }
3975 if (eap->skip)
3976 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02003977 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978
Bram Moolenaare51bb172020-02-16 19:42:23 +01003979 // When inside :try we need to check for following "| catch".
3980 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003982 // Check for trailing illegal characters and a following command.
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003983 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003984 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01003985 if (!failed)
3986 {
3987 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003988 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01003989 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 }
3991 else
3992 eap->nextcmd = check_nextcmd(arg);
3993 }
3994
3995end:
3996 dict_unref(fudi.fd_dict);
3997 vim_free(tofree);
3998}
3999
4000/*
4001 * Return from a function. Possibly makes the return pending. Also called
4002 * for a pending return at the ":endtry" or after returning from an extra
4003 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4004 * when called due to a ":return" command. "rettv" may point to a typval_T
4005 * with the return rettv. Returns TRUE when the return can be carried out,
4006 * FALSE when the return gets pending.
4007 */
4008 int
4009do_return(
4010 exarg_T *eap,
4011 int reanimate,
4012 int is_cmd,
4013 void *rettv)
4014{
4015 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004016 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017
4018 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004019 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 current_funccal->returned = FALSE;
4021
4022 /*
4023 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4024 * not in its finally clause (which then is to be executed next) is found.
4025 * In this case, make the ":return" pending for execution at the ":endtry".
4026 * Otherwise, return normally.
4027 */
4028 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4029 if (idx >= 0)
4030 {
4031 cstack->cs_pending[idx] = CSTP_RETURN;
4032
4033 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004034 // A pending return again gets pending. "rettv" points to an
4035 // allocated variable with the rettv of the original ":return"'s
4036 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 cstack->cs_rettv[idx] = rettv;
4038 else
4039 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004040 // When undoing a return in order to make it pending, get the stored
4041 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 if (reanimate)
4043 rettv = current_funccal->rettv;
4044
4045 if (rettv != NULL)
4046 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004047 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4049 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4050 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004051 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 }
4053 else
4054 cstack->cs_rettv[idx] = NULL;
4055
4056 if (reanimate)
4057 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004058 // The pending return value could be overwritten by a ":return"
4059 // without argument in a finally clause; reset the default
4060 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061 current_funccal->rettv->v_type = VAR_NUMBER;
4062 current_funccal->rettv->vval.v_number = 0;
4063 }
4064 }
4065 report_make_pending(CSTP_RETURN, rettv);
4066 }
4067 else
4068 {
4069 current_funccal->returned = TRUE;
4070
Bram Moolenaare38eab22019-12-05 21:50:01 +01004071 // If the return is carried out now, store the return value. For
4072 // a return immediately after reanimation, the value is already
4073 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 if (!reanimate && rettv != NULL)
4075 {
4076 clear_tv(current_funccal->rettv);
4077 *current_funccal->rettv = *(typval_T *)rettv;
4078 if (!is_cmd)
4079 vim_free(rettv);
4080 }
4081 }
4082
4083 return idx < 0;
4084}
4085
4086/*
4087 * Free the variable with a pending return value.
4088 */
4089 void
4090discard_pending_return(void *rettv)
4091{
4092 free_tv((typval_T *)rettv);
4093}
4094
4095/*
4096 * Generate a return command for producing the value of "rettv". The result
4097 * is an allocated string. Used by report_pending() for verbose messages.
4098 */
4099 char_u *
4100get_return_cmd(void *rettv)
4101{
4102 char_u *s = NULL;
4103 char_u *tofree = NULL;
4104 char_u numbuf[NUMBUFLEN];
4105
4106 if (rettv != NULL)
4107 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4108 if (s == NULL)
4109 s = (char_u *)"";
4110
4111 STRCPY(IObuff, ":return ");
4112 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4113 if (STRLEN(s) + 8 >= IOSIZE)
4114 STRCPY(IObuff + IOSIZE - 4, "...");
4115 vim_free(tofree);
4116 return vim_strsave(IObuff);
4117}
4118
4119/*
4120 * Get next function line.
4121 * Called by do_cmdline() to get the next line.
4122 * Returns allocated string, or NULL for end of function.
4123 */
4124 char_u *
4125get_func_line(
4126 int c UNUSED,
4127 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004128 int indent UNUSED,
4129 int do_concat UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130{
4131 funccall_T *fcp = (funccall_T *)cookie;
4132 ufunc_T *fp = fcp->func;
4133 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004134 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135
Bram Moolenaare38eab22019-12-05 21:50:01 +01004136 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004137 if (fcp->dbg_tick != debug_tick)
4138 {
4139 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004140 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 fcp->dbg_tick = debug_tick;
4142 }
4143#ifdef FEAT_PROFILE
4144 if (do_profiling == PROF_YES)
4145 func_line_end(cookie);
4146#endif
4147
4148 gap = &fp->uf_lines;
4149 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4150 || fcp->returned)
4151 retval = NULL;
4152 else
4153 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004154 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004155 while (fcp->linenr < gap->ga_len
4156 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4157 ++fcp->linenr;
4158 if (fcp->linenr >= gap->ga_len)
4159 retval = NULL;
4160 else
4161 {
4162 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004163 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004164#ifdef FEAT_PROFILE
4165 if (do_profiling == PROF_YES)
4166 func_line_start(cookie);
4167#endif
4168 }
4169 }
4170
Bram Moolenaare38eab22019-12-05 21:50:01 +01004171 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004172 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004174 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004175 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004177 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 fcp->dbg_tick = debug_tick;
4179 }
4180
4181 return retval;
4182}
4183
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004184/*
4185 * Return TRUE if the currently active function should be ended, because a
4186 * return was encountered or an error occurred. Used inside a ":while".
4187 */
4188 int
4189func_has_ended(void *cookie)
4190{
4191 funccall_T *fcp = (funccall_T *)cookie;
4192
Bram Moolenaare38eab22019-12-05 21:50:01 +01004193 // Ignore the "abort" flag if the abortion behavior has been changed due to
4194 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4196 || fcp->returned);
4197}
4198
4199/*
4200 * return TRUE if cookie indicates a function which "abort"s on errors.
4201 */
4202 int
4203func_has_abort(
4204 void *cookie)
4205{
4206 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4207}
4208
4209
4210/*
4211 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4212 * Don't do this when "Func" is already a partial that was bound
4213 * explicitly (pt_auto is FALSE).
4214 * Changes "rettv" in-place.
4215 * Returns the updated "selfdict_in".
4216 */
4217 dict_T *
4218make_partial(dict_T *selfdict_in, typval_T *rettv)
4219{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004220 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 char_u *tofree = NULL;
4222 ufunc_T *fp;
4223 char_u fname_buf[FLEN_FIXED + 1];
4224 int error;
4225 dict_T *selfdict = selfdict_in;
4226
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004227 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4228 fp = rettv->vval.v_partial->pt_func;
4229 else
4230 {
4231 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4232 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004233 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004234 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004235 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004236 vim_free(tofree);
4237 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238
4239 if (fp != NULL && (fp->uf_flags & FC_DICT))
4240 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004241 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242
4243 if (pt != NULL)
4244 {
4245 pt->pt_refcount = 1;
4246 pt->pt_dict = selfdict;
4247 pt->pt_auto = TRUE;
4248 selfdict = NULL;
4249 if (rettv->v_type == VAR_FUNC)
4250 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004251 // Just a function: Take over the function name and use
4252 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004253 pt->pt_name = rettv->vval.v_string;
4254 }
4255 else
4256 {
4257 partial_T *ret_pt = rettv->vval.v_partial;
4258 int i;
4259
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // Partial: copy the function name, use selfdict and copy
4261 // args. Can't take over name or args, the partial might
4262 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004263 if (ret_pt->pt_name != NULL)
4264 {
4265 pt->pt_name = vim_strsave(ret_pt->pt_name);
4266 func_ref(pt->pt_name);
4267 }
4268 else
4269 {
4270 pt->pt_func = ret_pt->pt_func;
4271 func_ptr_ref(pt->pt_func);
4272 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273 if (ret_pt->pt_argc > 0)
4274 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004275 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004277 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278 pt->pt_argc = 0;
4279 else
4280 {
4281 pt->pt_argc = ret_pt->pt_argc;
4282 for (i = 0; i < pt->pt_argc; i++)
4283 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4284 }
4285 }
4286 partial_unref(ret_pt);
4287 }
4288 rettv->v_type = VAR_PARTIAL;
4289 rettv->vval.v_partial = pt;
4290 }
4291 }
4292 return selfdict;
4293}
4294
4295/*
4296 * Return the name of the executed function.
4297 */
4298 char_u *
4299func_name(void *cookie)
4300{
4301 return ((funccall_T *)cookie)->func->uf_name;
4302}
4303
4304/*
4305 * Return the address holding the next breakpoint line for a funccall cookie.
4306 */
4307 linenr_T *
4308func_breakpoint(void *cookie)
4309{
4310 return &((funccall_T *)cookie)->breakpoint;
4311}
4312
4313/*
4314 * Return the address holding the debug tick for a funccall cookie.
4315 */
4316 int *
4317func_dbg_tick(void *cookie)
4318{
4319 return &((funccall_T *)cookie)->dbg_tick;
4320}
4321
4322/*
4323 * Return the nesting level for a funccall cookie.
4324 */
4325 int
4326func_level(void *cookie)
4327{
4328 return ((funccall_T *)cookie)->level;
4329}
4330
4331/*
4332 * Return TRUE when a function was ended by a ":return" command.
4333 */
4334 int
4335current_func_returned(void)
4336{
4337 return current_funccal->returned;
4338}
4339
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 int
4341free_unref_funccal(int copyID, int testing)
4342{
4343 int did_free = FALSE;
4344 int did_free_funccal = FALSE;
4345 funccall_T *fc, **pfc;
4346
4347 for (pfc = &previous_funccal; *pfc != NULL; )
4348 {
4349 if (can_free_funccal(*pfc, copyID))
4350 {
4351 fc = *pfc;
4352 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004353 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004354 did_free = TRUE;
4355 did_free_funccal = TRUE;
4356 }
4357 else
4358 pfc = &(*pfc)->caller;
4359 }
4360 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004361 // When a funccal was freed some more items might be garbage
4362 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363 (void)garbage_collect(testing);
4364
4365 return did_free;
4366}
4367
4368/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004369 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370 */
4371 static funccall_T *
4372get_funccal(void)
4373{
4374 int i;
4375 funccall_T *funccal;
4376 funccall_T *temp_funccal;
4377
4378 funccal = current_funccal;
4379 if (debug_backtrace_level > 0)
4380 {
4381 for (i = 0; i < debug_backtrace_level; i++)
4382 {
4383 temp_funccal = funccal->caller;
4384 if (temp_funccal)
4385 funccal = temp_funccal;
4386 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004387 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004388 debug_backtrace_level = i;
4389 }
4390 }
4391 return funccal;
4392}
4393
4394/*
4395 * Return the hashtable used for local variables in the current funccal.
4396 * Return NULL if there is no current funccal.
4397 */
4398 hashtab_T *
4399get_funccal_local_ht()
4400{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004401 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 return NULL;
4403 return &get_funccal()->l_vars.dv_hashtab;
4404}
4405
4406/*
4407 * Return the l: scope variable.
4408 * Return NULL if there is no current funccal.
4409 */
4410 dictitem_T *
4411get_funccal_local_var()
4412{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004413 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414 return NULL;
4415 return &get_funccal()->l_vars_var;
4416}
4417
4418/*
4419 * Return the hashtable used for argument in the current funccal.
4420 * Return NULL if there is no current funccal.
4421 */
4422 hashtab_T *
4423get_funccal_args_ht()
4424{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004425 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 return NULL;
4427 return &get_funccal()->l_avars.dv_hashtab;
4428}
4429
4430/*
4431 * Return the a: scope variable.
4432 * Return NULL if there is no current funccal.
4433 */
4434 dictitem_T *
4435get_funccal_args_var()
4436{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004437 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004438 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004439 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440}
4441
4442/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 * List function variables, if there is a function.
4444 */
4445 void
4446list_func_vars(int *first)
4447{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004448 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004450 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004451}
4452
4453/*
4454 * If "ht" is the hashtable for local variables in the current funccal, return
4455 * the dict that contains it.
4456 * Otherwise return NULL.
4457 */
4458 dict_T *
4459get_current_funccal_dict(hashtab_T *ht)
4460{
4461 if (current_funccal != NULL
4462 && ht == &current_funccal->l_vars.dv_hashtab)
4463 return &current_funccal->l_vars;
4464 return NULL;
4465}
4466
4467/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004468 * Search hashitem in parent scope.
4469 */
4470 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004471find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004472{
4473 funccall_T *old_current_funccal = current_funccal;
4474 hashtab_T *ht;
4475 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004476 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004477
4478 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4479 return NULL;
4480
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004481 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004482 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02004483 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004484 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004485 ht = find_var_ht(name, &varname);
4486 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02004487 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004488 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02004489 if (!HASHITEM_EMPTY(hi))
4490 {
4491 *pht = ht;
4492 break;
4493 }
4494 }
4495 if (current_funccal == current_funccal->func->uf_scoped)
4496 break;
4497 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004498 }
4499 current_funccal = old_current_funccal;
4500
4501 return hi;
4502}
4503
4504/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004505 * Search variable in parent scope.
4506 */
4507 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004508find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004509{
4510 dictitem_T *v = NULL;
4511 funccall_T *old_current_funccal = current_funccal;
4512 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004513 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004514
4515 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4516 return NULL;
4517
Bram Moolenaare38eab22019-12-05 21:50:01 +01004518 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004519 current_funccal = current_funccal->func->uf_scoped;
4520 while (current_funccal)
4521 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004522 ht = find_var_ht(name, &varname);
4523 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004524 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004525 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004526 if (v != NULL)
4527 break;
4528 }
4529 if (current_funccal == current_funccal->func->uf_scoped)
4530 break;
4531 current_funccal = current_funccal->func->uf_scoped;
4532 }
4533 current_funccal = old_current_funccal;
4534
4535 return v;
4536}
4537
4538/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539 * Set "copyID + 1" in previous_funccal and callers.
4540 */
4541 int
4542set_ref_in_previous_funccal(int copyID)
4543{
4544 int abort = FALSE;
4545 funccall_T *fc;
4546
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004547 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004549 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004550 abort = abort
4551 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
4552 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004553 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 }
4555 return abort;
4556}
4557
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004558 static int
4559set_ref_in_funccal(funccall_T *fc, int copyID)
4560{
4561 int abort = FALSE;
4562
4563 if (fc->fc_copyID != copyID)
4564 {
4565 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004566 abort = abort
4567 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
4568 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02004569 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02004570 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004571 }
4572 return abort;
4573}
4574
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575/*
4576 * Set "copyID" in all local vars and arguments in the call stack.
4577 */
4578 int
4579set_ref_in_call_stack(int copyID)
4580{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004581 int abort = FALSE;
4582 funccall_T *fc;
4583 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004584
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004585 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004586 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004587
4588 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02004589 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
4590 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02004591 abort = abort || set_ref_in_funccal(fc, copyID);
4592
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004593 return abort;
4594}
4595
4596/*
4597 * Set "copyID" in all functions available by name.
4598 */
4599 int
4600set_ref_in_functions(int copyID)
4601{
4602 int todo;
4603 hashitem_T *hi = NULL;
4604 int abort = FALSE;
4605 ufunc_T *fp;
4606
4607 todo = (int)func_hashtab.ht_used;
4608 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004610 if (!HASHITEM_EMPTY(hi))
4611 {
4612 --todo;
4613 fp = HI2UF(hi);
4614 if (!func_name_refcount(fp->uf_name))
4615 abort = abort || set_ref_in_func(NULL, fp, copyID);
4616 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004617 }
4618 return abort;
4619}
4620
4621/*
4622 * Set "copyID" in all function arguments.
4623 */
4624 int
4625set_ref_in_func_args(int copyID)
4626{
4627 int i;
4628 int abort = FALSE;
4629
4630 for (i = 0; i < funcargs.ga_len; ++i)
4631 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
4632 copyID, NULL, NULL);
4633 return abort;
4634}
4635
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004636/*
4637 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004638 * Returns TRUE if setting references failed somehow.
4639 */
4640 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004641set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004642{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004643 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004644 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01004645 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004646 char_u fname_buf[FLEN_FIXED + 1];
4647 char_u *tofree = NULL;
4648 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004649 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004650
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004651 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004652 return FALSE;
4653
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004654 if (fp_in == NULL)
4655 {
4656 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004657 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004658 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004659 if (fp != NULL)
4660 {
4661 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004662 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004663 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02004664
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004665 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02004666 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004667}
4668
Bram Moolenaare38eab22019-12-05 21:50:01 +01004669#endif // FEAT_EVAL