blob: 92166858230060d73d46d0eb9e8bb4e153fcf224 [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 Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
67 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010068{
Bram Moolenaar6e949782020-04-13 17:21:00 +020069 char_u *p = arg;
70 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010071
72 while (ASCII_ISALNUM(*p) || *p == '_')
73 ++p;
74 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020075 || (argtypes == NULL
76 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
77 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010078 {
79 if (!skip)
80 semsg(_("E125: Illegal argument: %s"), arg);
81 return arg;
82 }
83 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
84 return arg;
85 if (newargs != NULL)
86 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010087 int c;
88 int i;
89
90 c = *p;
91 *p = NUL;
92 arg_copy = vim_strsave(arg);
93 if (arg_copy == NULL)
94 {
95 *p = c;
96 return arg;
97 }
98
99 // Check for duplicate argument name.
100 for (i = 0; i < newargs->ga_len; ++i)
101 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
102 {
103 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
104 vim_free(arg_copy);
105 return arg;
106 }
107 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
108 newargs->ga_len++;
109
110 *p = c;
111 }
112
113 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100114 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100115 {
116 char_u *type = NULL;
117
Bram Moolenaar6e949782020-04-13 17:21:00 +0200118 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
119 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200120 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200121 arg_copy == NULL ? arg : arg_copy);
122 p = skipwhite(p);
123 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 if (*p == ':')
125 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200126 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100127 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200128 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200129 semsg(_(e_white_space_required_after_str), ":");
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200130 return arg;
131 }
132 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200133 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100134 if (!skip)
135 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100136 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100137 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200138 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200139 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200140 arg_copy == NULL ? arg : arg_copy);
141 return arg;
142 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 {
145 if (type == NULL && types_optional)
146 // lambda arguments default to "any" type
147 type = vim_strsave((char_u *)"any");
148 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
149 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
151
152 return p;
153}
154
155/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200156 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100157 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100158 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200159 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100160 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200161get_function_args(
162 char_u **argp,
163 char_u endchar,
164 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100166 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200167 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200169 int skip,
170 exarg_T *eap,
171 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200172{
173 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100174 char_u *arg;
175 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200177 int any_default = FALSE;
178 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100179 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200180
181 if (newargs != NULL)
182 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183 if (argtypes != NULL)
184 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200185 if (default_args != NULL)
186 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200187
188 if (varargs != NULL)
189 *varargs = FALSE;
190
191 /*
192 * Isolate the arguments: "arg1, arg2, ...)"
193 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100194 arg = skipwhite(*argp);
195 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196 while (*p != endchar)
197 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200198 while (eap != NULL && eap->getline != NULL
199 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200200 {
201 char_u *theline;
202
203 // End of the line, get the next one.
204 theline = eap->getline(':', eap->cookie, 0, TRUE);
205 if (theline == NULL)
206 break;
207 vim_free(*line_to_free);
208 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200209 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 p = skipwhite(theline);
211 }
212
213 if (mustend && *p != endchar)
214 {
215 if (!skip)
216 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100217 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200218 }
219 if (*p == endchar)
220 break;
221
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
223 {
224 if (varargs != NULL)
225 *varargs = TRUE;
226 p += 3;
227 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228
229 if (argtypes != NULL)
230 {
231 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200232 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100233 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100234 if (!skip)
235 emsg(_(e_missing_name_after_dots));
236 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100237 }
238
239 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100240 p = one_function_arg(p, newargs, argtypes, types_optional,
241 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242 if (p == arg)
243 break;
244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200245 }
246 else
247 {
248 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100249 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100250 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200251 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200252
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200253 if (*skipwhite(p) == '=' && default_args != NULL)
254 {
255 typval_T rettv;
256
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100257 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200258 any_default = TRUE;
259 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200260 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200261 p = skipwhite(p);
262 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200263 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200264 {
265 if (ga_grow(default_args, 1) == FAIL)
266 goto err_ret;
267
268 // trim trailing whitespace
269 while (p > expr && VIM_ISWHITE(p[-1]))
270 p--;
271 c = *p;
272 *p = NUL;
273 expr = vim_strsave(expr);
274 if (expr == NULL)
275 {
276 *p = c;
277 goto err_ret;
278 }
279 ((char_u **)(default_args->ga_data))
280 [default_args->ga_len] = expr;
281 default_args->ga_len++;
282 *p = c;
283 }
284 else
285 mustend = TRUE;
286 }
287 else if (any_default)
288 {
289 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200290 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200292 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200293 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200295 // Don't give this error when skipping, it makes the "->" not
296 // found in "{k,v -> x}" and give a confusing error.
297 if (!skip && in_vim9script()
298 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
299 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200300 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200301 goto err_ret;
302 }
303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304 else
305 mustend = TRUE;
306 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200307 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200309 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200310
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200311 if (*p != endchar)
312 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100313 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314
315 *argp = p;
316 return OK;
317
318err_ret:
319 if (newargs != NULL)
320 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200321 if (default_args != NULL)
322 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 return FAIL;
324}
325
326/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100327 * Parse the argument types, filling "fp->uf_arg_types".
328 * Return OK or FAIL.
329 */
330 static int
331parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
332{
333 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
334 if (argtypes->ga_len > 0)
335 {
336 // When "varargs" is set the last name/type goes into uf_va_name
337 // and uf_va_type.
338 int len = argtypes->ga_len - (varargs ? 1 : 0);
339
340 if (len > 0)
341 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
342 if (fp->uf_arg_types != NULL)
343 {
344 int i;
345 type_T *type;
346
347 for (i = 0; i < len; ++ i)
348 {
349 char_u *p = ((char_u **)argtypes->ga_data)[i];
350
351 if (p == NULL)
352 // will get the type from the default value
353 type = &t_unknown;
354 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100355 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100356 if (type == NULL)
357 return FAIL;
358 fp->uf_arg_types[i] = type;
359 }
360 }
361 if (varargs)
362 {
363 char_u *p;
364
365 // Move the last argument "...name: type" to uf_va_name and
366 // uf_va_type.
367 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
368 [fp->uf_args.ga_len - 1];
369 --fp->uf_args.ga_len;
370 p = ((char_u **)argtypes->ga_data)[len];
371 if (p == NULL)
372 // todo: get type from default value
373 fp->uf_va_type = &t_any;
374 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100375 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100376 if (fp->uf_va_type == NULL)
377 return FAIL;
378 }
379 }
380 return OK;
381}
382
383/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200384 * Register function "fp" as using "current_funccal" as its scope.
385 */
386 static int
387register_closure(ufunc_T *fp)
388{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200389 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100390 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200391 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200392 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200393 fp->uf_scoped = current_funccal;
394 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200395
Bram Moolenaar58016442016-07-31 18:30:22 +0200396 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
397 return FAIL;
398 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
399 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200400 return OK;
401}
402
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100403 static void
404set_ufunc_name(ufunc_T *fp, char_u *name)
405{
406 STRCPY(fp->uf_name, name);
407
408 if (name[0] == K_SPECIAL)
409 {
410 fp->uf_name_exp = alloc(STRLEN(name) + 3);
411 if (fp->uf_name_exp != NULL)
412 {
413 STRCPY(fp->uf_name_exp, "<SNR>");
414 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
415 }
416 }
417}
418
Bram Moolenaar58016442016-07-31 18:30:22 +0200419/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200420 * Get a name for a lambda. Returned in static memory.
421 */
422 char_u *
423get_lambda_name(void)
424{
425 static char_u name[30];
426 static int lambda_no = 0;
427
428 sprintf((char*)name, "<lambda>%d", ++lambda_no);
429 return name;
430}
431
Bram Moolenaar801ab062020-06-25 19:27:56 +0200432#if defined(FEAT_LUA) || defined(PROTO)
433/*
434 * Registers a native C callback which can be called from Vim script.
435 * Returns the name of the Vim script function.
436 */
437 char_u *
438register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
439{
440 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200441 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200442
443 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
444 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200445 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200446
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200447 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200448 fp->uf_refcount = 1;
449 fp->uf_varargs = TRUE;
450 fp->uf_flags = FC_CFUNC;
451 fp->uf_calls = 0;
452 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200453 fp->uf_cb = cb;
454 fp->uf_cb_free = cb_free;
455 fp->uf_cb_state = state;
456
457 set_ufunc_name(fp, name);
458 hash_add(&func_hashtab, UF2HIKEY(fp));
459
460 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200461}
462#endif
463
Bram Moolenaar04b12692020-05-04 23:24:44 +0200464/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100465 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100466 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100467 * If "white_error" is not NULL check for correct use of white space and set
468 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100469 * Return NULL if no valid arrow found.
470 */
471 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100472skip_arrow(
473 char_u *start,
474 int equal_arrow,
475 char_u **ret_type,
476 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100477{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100478 char_u *s = start;
479 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100480
481 if (equal_arrow)
482 {
483 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100484 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100485 if (white_error != NULL && !VIM_ISWHITE(s[1]))
486 {
487 *white_error = TRUE;
488 semsg(_(e_white_space_required_after_str), ":");
489 return NULL;
490 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100491 s = skipwhite(s + 1);
492 *ret_type = s;
493 s = skip_type(s, TRUE);
494 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100495 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100496 s = skipwhite(s);
497 if (*s != '=')
498 return NULL;
499 ++s;
500 }
501 if (*s != '>')
502 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100503 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
504 || !IS_WHITE_OR_NUL(s[1])))
505 {
506 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100507 semsg(_(e_white_space_required_before_and_after_str_at_str),
508 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100509 return NULL;
510 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100511 return skipwhite(s + 1);
512}
513
514/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200515 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100516 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100517 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200518 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
519 */
520 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100521get_lambda_tv(
522 char_u **arg,
523 typval_T *rettv,
524 int types_optional,
525 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200526{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200527 int evaluate = evalarg != NULL
528 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200529 garray_T newargs;
530 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200531 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100532 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200533 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100534 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200535 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100536 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200537 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200538 char_u *s;
539 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200540 int *old_eval_lavars = eval_lavars_used;
541 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100542 char_u *tofree1 = NULL;
543 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100544 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100545 int white_error = FALSE;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100546
547 if (equal_arrow && !in_vim9script())
548 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200549
550 ga_init(&newargs);
551 ga_init(&newlines);
552
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100553 // First, check if this is really a lambda expression. "->" or "=>" must
554 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100555 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100556 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100557 types_optional ? &argtypes : NULL, types_optional,
558 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100559 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100560 {
561 if (types_optional)
562 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200563 return NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100564 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200565
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100566 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200567 if (evaluate)
568 pnewargs = &newargs;
569 else
570 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100571 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100572 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100573 types_optional ? &argtypes : NULL, types_optional,
574 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100575 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100576 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100577 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100578 {
579 if (types_optional)
580 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100581 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100582 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100583 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200585
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100586 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
587 if (ret_type != NULL)
588 {
589 ret_type = vim_strsave(ret_type);
590 tofree2 = ret_type;
591 }
592
Bram Moolenaare38eab22019-12-05 21:50:01 +0100593 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200594 if (evaluate)
595 eval_lavars_used = &eval_lavars;
596
Bram Moolenaar65c44152020-12-24 15:14:01 +0100597 *arg = skipwhite_and_linebreak(*arg, evalarg);
598
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100599 // Recognize "{" as the start of a function body.
600 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100601 {
602 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100603 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100604 emsg("Lambda function body not supported yet");
605 goto errret;
606 }
607
Bram Moolenaare38eab22019-12-05 21:50:01 +0100608 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200609 start = *arg;
610 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200611 if (ret == FAIL)
612 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200613 if (evalarg != NULL)
614 {
615 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100616 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200617 evalarg->eval_tofree = NULL;
618 }
619
Bram Moolenaar65c44152020-12-24 15:14:01 +0100620 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100621 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100622 *arg = skipwhite_and_linebreak(*arg, evalarg);
623 if (**arg != '}')
624 {
625 semsg(_("E451: Expected }: %s"), *arg);
626 goto errret;
627 }
628 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100629 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200630
631 if (evaluate)
632 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200633 int len;
634 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200635 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200636 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200637
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200638 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200639 if (fp == NULL)
640 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200641 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200642 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200643 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200644 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200646 ga_init2(&newlines, (int)sizeof(char_u *), 1);
647 if (ga_grow(&newlines, 1) == FAIL)
648 goto errret;
649
Bram Moolenaare38eab22019-12-05 21:50:01 +0100650 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200651 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200652 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653 if (p == NULL)
654 goto errret;
655 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
656 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200657 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200658 if (strstr((char *)p + 7, "a:") == NULL)
659 // No a: variables are used for sure.
660 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200661
662 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100663 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200664 hash_add(&func_hashtab, UF2HIKEY(fp));
665 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200666 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100667 if (types_optional)
668 {
669 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
670 goto errret;
671 if (ret_type != NULL)
672 {
673 fp->uf_ret_type = parse_type(&ret_type,
674 &fp->uf_type_list, TRUE);
675 if (fp->uf_ret_type == NULL)
676 goto errret;
677 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100678 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100679 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100680 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100681
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200682 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200683 if (current_funccal != NULL && eval_lavars)
684 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200685 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200686 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200687 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200688 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200689
690#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200691 if (prof_def_func())
692 func_do_profile(fp);
693#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200694 if (sandbox)
695 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100696 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200697 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200698 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200699 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200700 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100701 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200702
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200703 pt->pt_func = fp;
704 pt->pt_refcount = 1;
705 rettv->vval.v_partial = pt;
706 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200708
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200709 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200710 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100711 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200712 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100713 vim_free(tofree1);
714 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100715 if (types_optional)
716 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200717 return OK;
718
719errret:
720 ga_clear_strings(&newargs);
721 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100722 if (types_optional)
723 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200724 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100725 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200726 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100727 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200728 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100729 vim_free(tofree1);
730 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200731 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200732 return FAIL;
733}
734
735/*
736 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
737 * name it contains, otherwise return "name".
738 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
739 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100740 * If "type" is not NULL and a Vim9 script-local variable is found look up the
741 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200742 */
743 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100744deref_func_name(
745 char_u *name,
746 int *lenp,
747 partial_T **partialp,
748 type_T **type,
749 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200750{
751 dictitem_T *v;
752 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100753 char_u *s = NULL;
754 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200755
756 if (partialp != NULL)
757 *partialp = NULL;
758
759 cc = name[*lenp];
760 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100761 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200762 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100763 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200764 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100765 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200766 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100767 if (v->di_tv.vval.v_string == NULL)
768 {
769 *lenp = 0;
770 return (char_u *)""; // just in case
771 }
772 s = v->di_tv.vval.v_string;
773 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200774 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200775
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100776 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200777 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100778 partial_T *pt = v->di_tv.vval.v_partial;
779
780 if (pt == NULL)
781 {
782 *lenp = 0;
783 return (char_u *)""; // just in case
784 }
785 if (partialp != NULL)
786 *partialp = pt;
787 s = partial_name(pt);
788 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200789 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100790
791 if (s != NULL)
792 {
793 if (type != NULL && ht == get_script_local_ht())
794 {
795 svar_T *sv = find_typval_in_script(&v->di_tv);
796
797 if (sv != NULL)
798 *type = sv->sv_type;
799 }
800 return s;
801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200802 }
803
804 return name;
805}
806
807/*
808 * Give an error message with a function name. Handle <SNR> things.
809 * "ermsg" is to be passed without translation, use N_() instead of _().
810 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100811 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200812emsg_funcname(char *ermsg, char_u *name)
813{
814 char_u *p;
815
816 if (*name == K_SPECIAL)
817 p = concat_str((char_u *)"<SNR>", name + 3);
818 else
819 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100820 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200821 if (p != name)
822 vim_free(p);
823}
824
825/*
826 * Allocate a variable for the result of a function.
827 * Return OK or FAIL.
828 */
829 int
830get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200831 char_u *name, // name of the function
832 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200833 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200834 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200835 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200836 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200837{
838 char_u *argp;
839 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100840 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
841 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200842 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200843
844 /*
845 * Get the arguments.
846 */
847 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200848 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
849 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200850 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200851 // skip the '(' or ',' and possibly line breaks
852 argp = skipwhite_and_linebreak(argp + 1, evalarg);
853
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200854 if (*argp == ')' || *argp == ',' || *argp == NUL)
855 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200856 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200857 {
858 ret = FAIL;
859 break;
860 }
861 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200862 // The comma should come right after the argument, but this wasn't
863 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200864 if (vim9script)
865 {
866 if (*argp != ',' && *skipwhite(argp) == ',')
867 {
868 semsg(_(e_no_white_space_allowed_before_str), ",");
869 ret = FAIL;
870 break;
871 }
872 }
873 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200874 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200875 if (*argp != ',')
876 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200877 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
878 {
879 semsg(_(e_white_space_required_after_str), ",");
880 ret = FAIL;
881 break;
882 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200883 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200884 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200885 if (*argp == ')')
886 ++argp;
887 else
888 ret = FAIL;
889
890 if (ret == OK)
891 {
892 int i = 0;
893
894 if (get_vim_var_nr(VV_TESTING))
895 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100896 // Prepare for calling test_garbagecollect_now(), need to know
897 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200898 if (funcargs.ga_itemsize == 0)
899 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
900 for (i = 0; i < argcount; ++i)
901 if (ga_grow(&funcargs, 1) == OK)
902 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
903 &argvars[i];
904 }
905
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200906 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200907
908 funcargs.ga_len -= i;
909 }
910 else if (!aborting())
911 {
912 if (argcount == MAX_FUNC_ARGS)
913 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
914 else
915 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
916 }
917
918 while (--argcount >= 0)
919 clear_tv(&argvars[argcount]);
920
Bram Moolenaar8294d492020-08-10 22:40:56 +0200921 if (in_vim9script())
922 *arg = argp;
923 else
924 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200925 return ret;
926}
927
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200928/*
929 * Return TRUE if "p" starts with "<SID>" or "s:".
930 * Only works if eval_fname_script() returned non-zero for "p"!
931 */
932 static int
933eval_fname_sid(char_u *p)
934{
935 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
936}
937
938/*
939 * In a script change <SID>name() and s:name() to K_SNR 123_name().
940 * Change <SNR>123_name() to K_SNR 123_name().
941 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
942 * (slow).
943 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100944 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200945fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
946{
947 int llen;
948 char_u *fname;
949 int i;
950
951 llen = eval_fname_script(name);
952 if (llen > 0)
953 {
954 fname_buf[0] = K_SPECIAL;
955 fname_buf[1] = KS_EXTRA;
956 fname_buf[2] = (int)KE_SNR;
957 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100958 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200959 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200960 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100961 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200962 else
963 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200964 sprintf((char *)fname_buf + 3, "%ld_",
965 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200966 i = (int)STRLEN(fname_buf);
967 }
968 }
969 if (i + STRLEN(name + llen) < FLEN_FIXED)
970 {
971 STRCPY(fname_buf + i, name + llen);
972 fname = fname_buf;
973 }
974 else
975 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200976 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200977 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100978 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200979 else
980 {
981 *tofree = fname;
982 mch_memmove(fname, fname_buf, (size_t)i);
983 STRCPY(fname + i, name + llen);
984 }
985 }
986 }
987 else
988 fname = name;
989 return fname;
990}
991
992/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100993 * Find a function "name" in script "sid".
994 */
995 static ufunc_T *
996find_func_with_sid(char_u *name, int sid)
997{
998 hashitem_T *hi;
999 char_u buffer[200];
1000
1001 buffer[0] = K_SPECIAL;
1002 buffer[1] = KS_EXTRA;
1003 buffer[2] = (int)KE_SNR;
1004 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1005 (long)sid, name);
1006 hi = hash_find(&func_hashtab, buffer);
1007 if (!HASHITEM_EMPTY(hi))
1008 return HI2UF(hi);
1009
1010 return NULL;
1011}
1012
1013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001015 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001016 * Return NULL for unknown function.
1017 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001018 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001019find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001020{
1021 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001022 ufunc_T *func;
1023 imported_T *imported;
1024
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001025 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001026 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001027 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001028 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001029 int find_script_local = in_vim9script()
1030 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001031
Bram Moolenaar95006e32020-08-29 17:47:08 +02001032 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001033 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001034 // Find script-local function before global one.
1035 func = find_func_with_sid(name, current_sctx.sc_sid);
1036 if (func != NULL)
1037 return func;
1038 }
1039
Bram Moolenaarefa94442020-08-08 22:16:00 +02001040 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001041 && name[1] == KS_EXTRA
1042 && name[2] == KE_SNR)
1043 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001044 // Caller changes s: to <SNR>99_name.
1045
1046 after_script = name + 3;
1047 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001048 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001049 ++after_script;
1050 else
1051 after_script = NULL;
1052 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001053 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001054 {
1055 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001056 if (after_script != NULL && sid != current_sctx.sc_sid)
1057 imported = find_imported_in_script(after_script, 0, sid);
1058 else
1059 imported = find_imported(after_script == NULL
1060 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001061 if (imported != NULL && imported->imp_funcname != NULL)
1062 {
1063 hi = hash_find(&func_hashtab, imported->imp_funcname);
1064 if (!HASHITEM_EMPTY(hi))
1065 return HI2UF(hi);
1066 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001067 }
1068 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001069
Bram Moolenaara26b9702020-04-18 19:53:28 +02001070 hi = hash_find(&func_hashtab,
1071 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001072 if (!HASHITEM_EMPTY(hi))
1073 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001074
1075 return NULL;
1076}
1077
1078/*
1079 * Find a function by name, return pointer to it in ufuncs.
1080 * "cctx" is passed in a :def function to find imported functions.
1081 * Return NULL for unknown or dead function.
1082 */
1083 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001084find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001085{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001086 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001087
1088 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1089 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001090 return NULL;
1091}
1092
1093/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001094 * Return TRUE if "ufunc" is a global function.
1095 */
1096 int
1097func_is_global(ufunc_T *ufunc)
1098{
1099 return ufunc->uf_name[0] != K_SPECIAL;
1100}
1101
1102/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001103 * Copy the function name of "fp" to buffer "buf".
1104 * "buf" must be able to hold the function name plus three bytes.
1105 * Takes care of script-local function names.
1106 */
1107 static void
1108cat_func_name(char_u *buf, ufunc_T *fp)
1109{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001110 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111 {
1112 STRCPY(buf, "<SNR>");
1113 STRCAT(buf, fp->uf_name + 3);
1114 }
1115 else
1116 STRCPY(buf, fp->uf_name);
1117}
1118
1119/*
1120 * Add a number variable "name" to dict "dp" with value "nr".
1121 */
1122 static void
1123add_nr_var(
1124 dict_T *dp,
1125 dictitem_T *v,
1126 char *name,
1127 varnumber_T nr)
1128{
1129 STRCPY(v->di_key, name);
1130 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1131 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1132 v->di_tv.v_type = VAR_NUMBER;
1133 v->di_tv.v_lock = VAR_FIXED;
1134 v->di_tv.vval.v_number = nr;
1135}
1136
1137/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001138 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001139 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001140 static void
1141free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001142{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001143 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001144
1145 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1146 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001147 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001148
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001149 // When garbage collecting a funccall_T may be freed before the
1150 // function that references it, clear its uf_scoped field.
1151 // The function may have been redefined and point to another
1152 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001153 if (fp != NULL && fp->uf_scoped == fc)
1154 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001155 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001156 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001157
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001158 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001159 vim_free(fc);
1160}
1161
1162/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001163 * Free "fc" and what it contains.
1164 * Can be called only when "fc" is kept beyond the period of it called,
1165 * i.e. after cleanup_function_call(fc).
1166 */
1167 static void
1168free_funccal_contents(funccall_T *fc)
1169{
1170 listitem_T *li;
1171
1172 // Free all l: variables.
1173 vars_clear(&fc->l_vars.dv_hashtab);
1174
1175 // Free all a: variables.
1176 vars_clear(&fc->l_avars.dv_hashtab);
1177
1178 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001179 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001180 clear_tv(&li->li_tv);
1181
1182 free_funccal(fc);
1183}
1184
1185/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001186 * Handle the last part of returning from a function: free the local hashtable.
1187 * Unless it is still in use by a closure.
1188 */
1189 static void
1190cleanup_function_call(funccall_T *fc)
1191{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001192 int may_free_fc = fc->fc_refcount <= 0;
1193 int free_fc = TRUE;
1194
Bram Moolenaar6914c642017-04-01 21:21:30 +02001195 current_funccal = fc->caller;
1196
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001197 // Free all l: variables if not referred.
1198 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1199 vars_clear(&fc->l_vars.dv_hashtab);
1200 else
1201 free_fc = FALSE;
1202
1203 // If the a:000 list and the l: and a: dicts are not referenced and
1204 // there is no closure using it, we can free the funccall_T and what's
1205 // in it.
1206 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1207 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001208 else
1209 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001210 int todo;
1211 hashitem_T *hi;
1212 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001213
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001214 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001215
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001216 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001217 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1218 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1219 {
1220 if (!HASHITEM_EMPTY(hi))
1221 {
1222 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001223 di = HI2DI(hi);
1224 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001225 }
1226 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001227 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001228
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001229 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1230 fc->l_varlist.lv_first = NULL;
1231 else
1232 {
1233 listitem_T *li;
1234
1235 free_fc = FALSE;
1236
1237 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001238 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001239 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001240 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001241
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001242 if (free_fc)
1243 free_funccal(fc);
1244 else
1245 {
1246 static int made_copy = 0;
1247
1248 // "fc" is still in use. This can happen when returning "a:000",
1249 // assigning "l:" to a global variable or defining a closure.
1250 // Link "fc" in the list for garbage collection later.
1251 fc->caller = previous_funccal;
1252 previous_funccal = fc;
1253
1254 if (want_garbage_collect)
1255 // If garbage collector is ready, clear count.
1256 made_copy = 0;
1257 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001258 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001259 // We have made a lot of copies, worth 4 Mbyte. This can happen
1260 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001261 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001262 // too much memory.
1263 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001264 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001265 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001266 }
1267}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001268
1269/*
1270 * There are two kinds of function names:
1271 * 1. ordinary names, function defined with :function or :def
1272 * 2. numbered functions and lambdas
1273 * For the first we only count the name stored in func_hashtab as a reference,
1274 * using function() does not count as a reference, because the function is
1275 * looked up by name.
1276 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001277 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001278func_name_refcount(char_u *name)
1279{
1280 return isdigit(*name) || *name == '<';
1281}
1282
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001283/*
1284 * Unreference "fc": decrement the reference count and free it when it
1285 * becomes zero. "fp" is detached from "fc".
1286 * When "force" is TRUE we are exiting.
1287 */
1288 static void
1289funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1290{
1291 funccall_T **pfc;
1292 int i;
1293
1294 if (fc == NULL)
1295 return;
1296
1297 if (--fc->fc_refcount <= 0 && (force || (
1298 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1299 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1300 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1301 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1302 {
1303 if (fc == *pfc)
1304 {
1305 *pfc = fc->caller;
1306 free_funccal_contents(fc);
1307 return;
1308 }
1309 }
1310 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1311 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1312 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1313}
1314
1315/*
1316 * Remove the function from the function hashtable. If the function was
1317 * deleted while it still has references this was already done.
1318 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1319 */
1320 static int
1321func_remove(ufunc_T *fp)
1322{
1323 hashitem_T *hi;
1324
1325 // Return if it was already virtually deleted.
1326 if (fp->uf_flags & FC_DEAD)
1327 return FALSE;
1328
1329 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1330 if (!HASHITEM_EMPTY(hi))
1331 {
1332 // When there is a def-function index do not actually remove the
1333 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001334 // Do remove it when it's a copy.
1335 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001336 fp->uf_flags |= FC_DEAD;
1337 else
1338 hash_remove(&func_hashtab, hi);
1339 return TRUE;
1340 }
1341 return FALSE;
1342}
1343
1344 static void
1345func_clear_items(ufunc_T *fp)
1346{
1347 ga_clear_strings(&(fp->uf_args));
1348 ga_clear_strings(&(fp->uf_def_args));
1349 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001350 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001351 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001352 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001353 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001354 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001355
1356 // Increment the refcount of this function to avoid it being freed
1357 // recursively when the partial is freed.
1358 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001359 partial_unref(fp->uf_partial);
1360 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001361 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001362
1363#ifdef FEAT_LUA
1364 if (fp->uf_cb_free != NULL)
1365 {
1366 fp->uf_cb_free(fp->uf_cb_state);
1367 fp->uf_cb_free = NULL;
1368 }
1369
1370 fp->uf_cb_state = NULL;
1371 fp->uf_cb = NULL;
1372#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001373#ifdef FEAT_PROFILE
1374 VIM_CLEAR(fp->uf_tml_count);
1375 VIM_CLEAR(fp->uf_tml_total);
1376 VIM_CLEAR(fp->uf_tml_self);
1377#endif
1378}
1379
1380/*
1381 * Free all things that a function contains. Does not free the function
1382 * itself, use func_free() for that.
1383 * When "force" is TRUE we are exiting.
1384 */
1385 static void
1386func_clear(ufunc_T *fp, int force)
1387{
1388 if (fp->uf_cleared)
1389 return;
1390 fp->uf_cleared = TRUE;
1391
1392 // clear this function
1393 func_clear_items(fp);
1394 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001395 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001396}
1397
1398/*
1399 * Free a function and remove it from the list of functions. Does not free
1400 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001401 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001402 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001403 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001404 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001405func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001406{
1407 // Only remove it when not done already, otherwise we would remove a newer
1408 // version of the function with the same name.
1409 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1410 func_remove(fp);
1411
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001412 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001413 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001414 if (fp->uf_dfunc_idx > 0)
1415 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001416 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001417 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001418 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001419 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001420 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001421}
1422
1423/*
1424 * Free all things that a function contains and free the function itself.
1425 * When "force" is TRUE we are exiting.
1426 */
1427 static void
1428func_clear_free(ufunc_T *fp, int force)
1429{
1430 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001431 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1432 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001433 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001434 else
1435 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001436}
1437
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001438/*
1439 * Copy already defined function "lambda" to a new function with name "global".
1440 * This is for when a compiled function defines a global function.
1441 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001442 int
1443copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001444{
1445 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001446 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001447
1448 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001449 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001450 semsg(_(e_lambda_function_not_found_str), lambda);
1451 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001452 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001453
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001454 fp = find_func(global, TRUE, NULL);
1455 if (fp != NULL)
1456 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001457 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001458 semsg(_(e_funcexts), global);
1459 return FAIL;
1460 }
1461
1462 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1463 if (fp == NULL)
1464 return FAIL;
1465
1466 fp->uf_varargs = ufunc->uf_varargs;
1467 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1468 fp->uf_def_status = ufunc->uf_def_status;
1469 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1470 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1471 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1472 == FAIL
1473 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1474 goto failed;
1475
1476 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1477 : vim_strsave(ufunc->uf_name_exp);
1478 if (ufunc->uf_arg_types != NULL)
1479 {
1480 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1481 if (fp->uf_arg_types == NULL)
1482 goto failed;
1483 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1484 sizeof(type_T *) * fp->uf_args.ga_len);
1485 }
1486 if (ufunc->uf_def_arg_idx != NULL)
1487 {
1488 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1489 if (fp->uf_def_arg_idx == NULL)
1490 goto failed;
1491 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1492 sizeof(int) * fp->uf_def_args.ga_len + 1);
1493 }
1494 if (ufunc->uf_va_name != NULL)
1495 {
1496 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1497 if (fp->uf_va_name == NULL)
1498 goto failed;
1499 }
1500 fp->uf_ret_type = ufunc->uf_ret_type;
1501
1502 fp->uf_refcount = 1;
1503 STRCPY(fp->uf_name, global);
1504 hash_add(&func_hashtab, UF2HIKEY(fp));
1505
1506 // the referenced dfunc_T is now used one more time
1507 link_def_function(fp);
1508
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001509 // Create a partial to store the context of the function where it was
1510 // instantiated. Only needs to be done once. Do this on the original
1511 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001512 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1513 {
1514 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1515
1516 if (pt == NULL)
1517 goto failed;
1518 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001519 {
1520 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001521 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001522 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001523 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001524 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001525 }
1526
1527 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001528
1529failed:
1530 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001531 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001532}
1533
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001534static int funcdepth = 0;
1535
1536/*
1537 * Increment the function call depth count.
1538 * Return FAIL when going over 'maxfuncdepth'.
1539 * Otherwise return OK, must call funcdepth_decrement() later!
1540 */
1541 int
1542funcdepth_increment(void)
1543{
1544 if (funcdepth >= p_mfd)
1545 {
1546 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1547 return FAIL;
1548 }
1549 ++funcdepth;
1550 return OK;
1551}
1552
1553 void
1554funcdepth_decrement(void)
1555{
1556 --funcdepth;
1557}
1558
1559/*
1560 * Get the current function call depth.
1561 */
1562 int
1563funcdepth_get(void)
1564{
1565 return funcdepth;
1566}
1567
1568/*
1569 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001570 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001571 * times as funcdepth_increment().
1572 */
1573 void
1574funcdepth_restore(int depth)
1575{
1576 funcdepth = depth;
1577}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001578
1579/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001580 * Call a user function.
1581 */
1582 static void
1583call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001584 ufunc_T *fp, // pointer to function
1585 int argcount, // nr of args
1586 typval_T *argvars, // arguments
1587 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001588 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001589 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001590{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001591 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001592 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001593 funccall_T *fc;
1594 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001595 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001597 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 int i;
1599 int ai;
1600 int islambda = FALSE;
1601 char_u numbuf[NUMBUFLEN];
1602 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001603#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001604 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001605#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001606 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607
Bram Moolenaarb2049902021-01-24 12:53:53 +01001608#ifdef FEAT_PROFILE
1609 CLEAR_FIELD(profile_info);
1610#endif
1611
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001612 // If depth of calling is getting too high, don't execute the function.
1613 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 rettv->v_type = VAR_NUMBER;
1616 rettv->vval.v_number = -1;
1617 return;
1618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619
Bram Moolenaare38eab22019-12-05 21:50:01 +01001620 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001622 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001623 if (fc == NULL)
1624 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625 fc->caller = current_funccal;
1626 current_funccal = fc;
1627 fc->func = fp;
1628 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001630 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001631 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1632 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001633 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001634 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001635 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001637 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001638 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001639 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01001640#ifdef FEAT_PROFILE
1641 profile_may_start_func(&profile_info, fp, fc);
1642#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001643 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001644 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01001645#ifdef FEAT_PROFILE
1646 if (do_profiling == PROF_YES && (fp->uf_profiling
1647 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1648 profile_may_end_func(&profile_info, fp, fc);
1649#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001650 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001651 free_funccal(fc);
1652 return;
1653 }
1654
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001655 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1656 islambda = TRUE;
1657
1658 /*
1659 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1660 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1661 * each argument variable and saves a lot of time.
1662 */
1663 /*
1664 * Init l: variables.
1665 */
1666 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1667 if (selfdict != NULL)
1668 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001669 // Set l:self to "selfdict". Use "name" to avoid a warning from
1670 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001671 v = &fc->fixvar[fixvar_idx++].var;
1672 name = v->di_key;
1673 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001674 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1676 v->di_tv.v_type = VAR_DICT;
1677 v->di_tv.v_lock = 0;
1678 v->di_tv.vval.v_dict = selfdict;
1679 ++selfdict->dv_refcount;
1680 }
1681
1682 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001683 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001684 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 * Set a:000 to a list with room for the "..." arguments.
1686 */
1687 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001688 if ((fp->uf_flags & FC_NOARGS) == 0)
1689 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001690 (varnumber_T)(argcount >= fp->uf_args.ga_len
1691 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001692 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001693 if ((fp->uf_flags & FC_NOARGS) == 0)
1694 {
1695 // Use "name" to avoid a warning from some compiler that checks the
1696 // destination size.
1697 v = &fc->fixvar[fixvar_idx++].var;
1698 name = v->di_key;
1699 STRCPY(name, "000");
1700 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1701 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1702 v->di_tv.v_type = VAR_LIST;
1703 v->di_tv.v_lock = VAR_FIXED;
1704 v->di_tv.vval.v_list = &fc->l_varlist;
1705 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001706 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1708 fc->l_varlist.lv_lock = VAR_FIXED;
1709
1710 /*
1711 * Set a:firstline to "firstline" and a:lastline to "lastline".
1712 * Set a:name to named arguments.
1713 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001714 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001716 if ((fp->uf_flags & FC_NOARGS) == 0)
1717 {
1718 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001719 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001720 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001721 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001722 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001723 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001724 {
1725 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001726 typval_T def_rettv;
1727 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001728
1729 ai = i - fp->uf_args.ga_len;
1730 if (ai < 0)
1731 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001732 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 name = FUNCARG(fp, i);
1734 if (islambda)
1735 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001736
1737 // evaluate named argument default expression
1738 isdefault = ai + fp->uf_def_args.ga_len >= 0
1739 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1740 && argvars[i].vval.v_number == VVAL_NONE));
1741 if (isdefault)
1742 {
1743 char_u *default_expr = NULL;
1744 def_rettv.v_type = VAR_NUMBER;
1745 def_rettv.vval.v_number = -1;
1746
1747 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1748 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001749 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001750 {
1751 default_arg_err = 1;
1752 break;
1753 }
1754 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001755 }
1756 else
1757 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001758 if ((fp->uf_flags & FC_NOARGS) != 0)
1759 // Bail out if no a: arguments used (in lambda).
1760 break;
1761
Bram Moolenaare38eab22019-12-05 21:50:01 +01001762 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001763 sprintf((char *)numbuf, "%d", ai + 1);
1764 name = numbuf;
1765 }
1766 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1767 {
1768 v = &fc->fixvar[fixvar_idx++].var;
1769 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001770 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 }
1772 else
1773 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001774 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775 if (v == NULL)
1776 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001777 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001779
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001780 // Note: the values are copied directly to avoid alloc/free.
1781 // "argvars" must have VAR_FIXED for v_lock.
1782 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783 v->di_tv.v_lock = VAR_FIXED;
1784
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 if (addlocal)
1786 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001787 // Named arguments should be accessed without the "a:" prefix in
1788 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001789 copy_tv(&v->di_tv, &v->di_tv);
1790 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001791 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001792 else
1793 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001794
1795 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1796 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001797 listitem_T *li = &fc->l_listitems[ai];
1798
1799 li->li_tv = argvars[i];
1800 li->li_tv.v_lock = VAR_FIXED;
1801 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802 }
1803 }
1804
Bram Moolenaare38eab22019-12-05 21:50:01 +01001805 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001806 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001807
1808 if (fp->uf_flags & FC_SANDBOX)
1809 {
1810 using_sandbox = TRUE;
1811 ++sandbox;
1812 }
1813
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001814 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001815 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001816 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001817 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001818 ++no_wait_return;
1819 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001821 smsg(_("calling %s"), SOURCING_NAME);
1822 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001824 char_u buf[MSG_BUF_LEN];
1825 char_u numbuf2[NUMBUFLEN];
1826 char_u *tofree;
1827 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001829 msg_puts("(");
1830 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001832 if (i > 0)
1833 msg_puts(", ");
1834 if (argvars[i].v_type == VAR_NUMBER)
1835 msg_outnum((long)argvars[i].vval.v_number);
1836 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001838 // Do not want errors such as E724 here.
1839 ++emsg_off;
1840 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1841 --emsg_off;
1842 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001844 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001846 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1847 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001849 msg_puts((char *)s);
1850 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 }
1852 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001854 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001855 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001856 msg_puts("\n"); // don't overwrite this either
1857
1858 verbose_leave_scroll();
1859 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001860 }
1861#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001862 profile_may_start_func(&profile_info, fp, fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001863#endif
1864
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001865 save_current_sctx = current_sctx;
1866 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001867 save_did_emsg = did_emsg;
1868 did_emsg = FALSE;
1869
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001870 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1871 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001872 else if (islambda)
1873 {
1874 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1875
1876 // A Lambda always has the command "return {expr}". It is much faster
1877 // to evaluate {expr} directly.
1878 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001879 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001880 --ex_nesting_level;
1881 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001882 else
1883 // call do_cmdline() to execute the lines
1884 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1886
1887 --RedrawingDisabled;
1888
Bram Moolenaare38eab22019-12-05 21:50:01 +01001889 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1891 {
1892 clear_tv(rettv);
1893 rettv->v_type = VAR_NUMBER;
1894 rettv->vval.v_number = -1;
1895 }
1896
1897#ifdef FEAT_PROFILE
1898 if (do_profiling == PROF_YES && (fp->uf_profiling
1899 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
Bram Moolenaarb2049902021-01-24 12:53:53 +01001900 profile_may_end_func(&profile_info, fp, fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001901#endif
1902
Bram Moolenaare38eab22019-12-05 21:50:01 +01001903 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001904 if (p_verbose >= 12)
1905 {
1906 ++no_wait_return;
1907 verbose_enter_scroll();
1908
1909 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001910 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001911 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001912 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001913 (long)fc->rettv->vval.v_number);
1914 else
1915 {
1916 char_u buf[MSG_BUF_LEN];
1917 char_u numbuf2[NUMBUFLEN];
1918 char_u *tofree;
1919 char_u *s;
1920
Bram Moolenaare38eab22019-12-05 21:50:01 +01001921 // The value may be very long. Skip the middle part, so that we
1922 // have some idea how it starts and ends. smsg() would always
1923 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001924 ++emsg_off;
1925 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1926 --emsg_off;
1927 if (s != NULL)
1928 {
1929 if (vim_strsize(s) > MSG_BUF_CLEN)
1930 {
1931 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1932 s = buf;
1933 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001934 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 vim_free(tofree);
1936 }
1937 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001938 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001939
1940 verbose_leave_scroll();
1941 --no_wait_return;
1942 }
1943
Bram Moolenaare31ee862020-01-07 20:59:34 +01001944 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001945 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001946 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947#ifdef FEAT_PROFILE
1948 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01001949 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001950#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001951 if (using_sandbox)
1952 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001953
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001954 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955 {
1956 ++no_wait_return;
1957 verbose_enter_scroll();
1958
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001959 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001960 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961
1962 verbose_leave_scroll();
1963 --no_wait_return;
1964 }
1965
1966 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001967 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001968 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001969}
1970
1971/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001972 * Check the argument count for user function "fp".
1973 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1974 */
1975 int
1976check_user_func_argcount(ufunc_T *fp, int argcount)
1977{
1978 int regular_args = fp->uf_args.ga_len;
1979
1980 if (argcount < regular_args - fp->uf_def_args.ga_len)
1981 return FCERR_TOOFEW;
1982 else if (!has_varargs(fp) && argcount > regular_args)
1983 return FCERR_TOOMANY;
1984 return FCERR_UNKNOWN;
1985}
1986
1987/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001988 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001989 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001990 int
1991call_user_func_check(
1992 ufunc_T *fp,
1993 int argcount,
1994 typval_T *argvars,
1995 typval_T *rettv,
1996 funcexe_T *funcexe,
1997 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001998{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001999 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002000
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002001 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2002 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002003 error = check_user_func_argcount(fp, argcount);
2004 if (error != FCERR_UNKNOWN)
2005 return error;
2006 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002007 error = FCERR_DICT;
2008 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002009 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002010 int did_save_redo = FALSE;
2011 save_redo_T save_redo;
2012
2013 /*
2014 * Call the user function.
2015 * Save and restore search patterns, script variables and
2016 * redo buffer.
2017 */
2018 save_search_patterns();
2019 if (!ins_compl_active())
2020 {
2021 saveRedobuff(&save_redo);
2022 did_save_redo = TRUE;
2023 }
2024 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002025 call_user_func(fp, argcount, argvars, rettv, funcexe,
2026 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2028 // Function was unreferenced while being used, free it now.
2029 func_clear_free(fp, FALSE);
2030 if (did_save_redo)
2031 restoreRedobuff(&save_redo);
2032 restore_search_patterns();
2033 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002034 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002035 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002036}
2037
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002038static funccal_entry_T *funccal_stack = NULL;
2039
2040/*
2041 * Save the current function call pointer, and set it to NULL.
2042 * Used when executing autocommands and for ":source".
2043 */
2044 void
2045save_funccal(funccal_entry_T *entry)
2046{
2047 entry->top_funccal = current_funccal;
2048 entry->next = funccal_stack;
2049 funccal_stack = entry;
2050 current_funccal = NULL;
2051}
2052
2053 void
2054restore_funccal(void)
2055{
2056 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002057 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002058 else
2059 {
2060 current_funccal = funccal_stack->top_funccal;
2061 funccal_stack = funccal_stack->next;
2062 }
2063}
2064
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002065 funccall_T *
2066get_current_funccal(void)
2067{
2068 return current_funccal;
2069}
2070
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002071/*
2072 * Mark all functions of script "sid" as deleted.
2073 */
2074 void
2075delete_script_functions(int sid)
2076{
2077 hashitem_T *hi;
2078 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002079 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002080 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002081 size_t len;
2082
2083 buf[0] = K_SPECIAL;
2084 buf[1] = KS_EXTRA;
2085 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002086 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002087 len = STRLEN(buf);
2088
Bram Moolenaarce658352020-07-31 23:47:12 +02002089 while (todo > 0)
2090 {
2091 todo = func_hashtab.ht_used;
2092 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2093 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002094 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002095 fp = HI2UF(hi);
2096 if (STRNCMP(fp->uf_name, buf, len) == 0)
2097 {
2098 int changed = func_hashtab.ht_changed;
2099
2100 fp->uf_flags |= FC_DEAD;
2101 func_clear(fp, TRUE);
2102 // When clearing a function another function can be cleared
2103 // as a side effect. When that happens start over.
2104 if (changed != func_hashtab.ht_changed)
2105 break;
2106 }
2107 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002108 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002109 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002110}
2111
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112#if defined(EXITFREE) || defined(PROTO)
2113 void
2114free_all_functions(void)
2115{
2116 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002117 ufunc_T *fp;
2118 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002119 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002120 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002121
Bram Moolenaare38eab22019-12-05 21:50:01 +01002122 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002123 while (current_funccal != NULL)
2124 {
2125 clear_tv(current_funccal->rettv);
2126 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002127 if (current_funccal == NULL && funccal_stack != NULL)
2128 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002129 }
2130
Bram Moolenaare38eab22019-12-05 21:50:01 +01002131 // First clear what the functions contain. Since this may lower the
2132 // reference count of a function, it may also free a function and change
2133 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002134 while (todo > 0)
2135 {
2136 todo = func_hashtab.ht_used;
2137 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2138 if (!HASHITEM_EMPTY(hi))
2139 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002140 // clear the def function index now
2141 fp = HI2UF(hi);
2142 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002143 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002144
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 // Only free functions that are not refcounted, those are
2146 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002147 if (func_name_refcount(fp->uf_name))
2148 ++skipped;
2149 else
2150 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002151 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002152 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002153 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002154 {
2155 skipped = 0;
2156 break;
2157 }
2158 }
2159 --todo;
2160 }
2161 }
2162
Bram Moolenaare38eab22019-12-05 21:50:01 +01002163 // Now actually free the functions. Need to start all over every time,
2164 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002165 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002166 while (func_hashtab.ht_used > skipped)
2167 {
2168 todo = func_hashtab.ht_used;
2169 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002170 if (!HASHITEM_EMPTY(hi))
2171 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002172 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002173 // Only free functions that are not refcounted, those are
2174 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002175 fp = HI2UF(hi);
2176 if (func_name_refcount(fp->uf_name))
2177 ++skipped;
2178 else
2179 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002180 if (func_free(fp, FALSE) == OK)
2181 {
2182 skipped = 0;
2183 break;
2184 }
2185 // did not actually free it
2186 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002187 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002188 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002189 }
2190 if (skipped == 0)
2191 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002192
2193 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194}
2195#endif
2196
2197/*
2198 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002199 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002200 * "len" is the length of "name", or -1 for NUL terminated.
2201 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002202 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002203builtin_function(char_u *name, int len)
2204{
2205 char_u *p;
2206
Bram Moolenaara26b9702020-04-18 19:53:28 +02002207 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002208 return FALSE;
2209 p = vim_strchr(name, AUTOLOAD_CHAR);
2210 return p == NULL || (len > 0 && p > name + len);
2211}
2212
2213 int
2214func_call(
2215 char_u *name,
2216 typval_T *args,
2217 partial_T *partial,
2218 dict_T *selfdict,
2219 typval_T *rettv)
2220{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002221 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002222 listitem_T *item;
2223 typval_T argv[MAX_FUNC_ARGS + 1];
2224 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002225 int r = 0;
2226
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002227 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002228 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002229 {
2230 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2231 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002232 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002233 break;
2234 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002235 // Make a copy of each argument. This is needed to be able to set
2236 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002237 copy_tv(&item->li_tv, &argv[argc++]);
2238 }
2239
2240 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002241 {
2242 funcexe_T funcexe;
2243
Bram Moolenaara80faa82020-04-12 19:37:17 +02002244 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002245 funcexe.firstline = curwin->w_cursor.lnum;
2246 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002247 funcexe.evaluate = TRUE;
2248 funcexe.partial = partial;
2249 funcexe.selfdict = selfdict;
2250 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2251 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002252
Bram Moolenaare38eab22019-12-05 21:50:01 +01002253 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002254 while (argc > 0)
2255 clear_tv(&argv[--argc]);
2256
2257 return r;
2258}
2259
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002260static int callback_depth = 0;
2261
2262 int
2263get_callback_depth(void)
2264{
2265 return callback_depth;
2266}
2267
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002269 * Invoke call_func() with a callback.
2270 */
2271 int
2272call_callback(
2273 callback_T *callback,
2274 int len, // length of "name" or -1 to use strlen()
2275 typval_T *rettv, // return value goes here
2276 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002277 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002278 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002279{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002280 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002281 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002282
Bram Moolenaara80faa82020-04-12 19:37:17 +02002283 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002284 funcexe.evaluate = TRUE;
2285 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002286 ++callback_depth;
2287 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2288 --callback_depth;
2289 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002290}
2291
2292/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293 * Give an error message for the result of a function.
2294 * Nothing if "error" is FCERR_NONE.
2295 */
2296 void
2297user_func_error(int error, char_u *name)
2298{
2299 switch (error)
2300 {
2301 case FCERR_UNKNOWN:
2302 emsg_funcname(e_unknownfunc, name);
2303 break;
2304 case FCERR_NOTMETHOD:
2305 emsg_funcname(
2306 N_("E276: Cannot use function as a method: %s"), name);
2307 break;
2308 case FCERR_DELETED:
2309 emsg_funcname(N_(e_func_deleted), name);
2310 break;
2311 case FCERR_TOOMANY:
2312 emsg_funcname((char *)e_toomanyarg, name);
2313 break;
2314 case FCERR_TOOFEW:
2315 emsg_funcname((char *)e_toofewarg, name);
2316 break;
2317 case FCERR_SCRIPT:
2318 emsg_funcname(
2319 N_("E120: Using <SID> not in a script context: %s"), name);
2320 break;
2321 case FCERR_DICT:
2322 emsg_funcname(
2323 N_("E725: Calling dict function without Dictionary: %s"),
2324 name);
2325 break;
2326 }
2327}
2328
2329/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002330 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002331 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 * Return FAIL when the function can't be called, OK otherwise.
2333 * Also returns OK when an error was encountered while executing the function.
2334 */
2335 int
2336call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002337 char_u *funcname, // name of the function
2338 int len, // length of "name" or -1 to use strlen()
2339 typval_T *rettv, // return value goes here
2340 int argcount_in, // number of "argvars"
2341 typval_T *argvars_in, // vars for arguments, must have "argcount"
2342 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002343 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344{
2345 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002346 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002348 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002349 char_u fname_buf[FLEN_FIXED + 1];
2350 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002351 char_u *fname = NULL;
2352 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 int argcount = argcount_in;
2354 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002355 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002356 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2357 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002359 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002360 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002362 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2363 // even when call_func() returns FAIL.
2364 rettv->v_type = VAR_UNKNOWN;
2365
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002366 if (partial != NULL)
2367 fp = partial->pt_func;
2368 if (fp == NULL)
2369 {
2370 // Make a copy of the name, if it comes from a funcref variable it
2371 // could be changed or deleted in the called function.
2372 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2373 if (name == NULL)
2374 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002375
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002376 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2377 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002379 if (funcexe->doesrange != NULL)
2380 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381
2382 if (partial != NULL)
2383 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002384 // When the function has a partial with a dict and there is a dict
2385 // argument, use the dict argument. That is backwards compatible.
2386 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002387 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002388 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002389 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390 {
2391 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002392 {
2393 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2394 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002395 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002396 goto theend;
2397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002399 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002400 for (i = 0; i < argcount_in; ++i)
2401 argv[i + argv_clear] = argvars_in[i];
2402 argvars = argv;
2403 argcount = partial->pt_argc + argcount_in;
2404 }
2405 }
2406
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002407 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2408 {
2409 // Check that the argument types are OK for the types of the funcref.
2410 if (check_argument_types(funcexe->check_type, argvars, argcount,
2411 name) == FAIL)
2412 error = FCERR_OTHER;
2413 }
2414
Bram Moolenaaref140542019-12-31 21:27:13 +01002415 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 {
2417 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002418 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002419
Bram Moolenaar333894b2020-08-01 18:53:07 +02002420 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002421 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002422 {
2423 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002425 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426
Bram Moolenaare38eab22019-12-05 21:50:01 +01002427 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002428 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002429 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002431 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432 {
2433 /*
2434 * User defined function.
2435 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002436 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002437 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438
Bram Moolenaare38eab22019-12-05 21:50:01 +01002439 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 if (fp == NULL
2441 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002442 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443 && !aborting())
2444 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002445 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002446 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002448 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2450 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002451 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002452 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002454 if (fp == NULL)
2455 {
2456 char_u *p = untrans_function_name(rfname);
2457
2458 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002459 // Don't do this if the name starts with "s:".
2460 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002461 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002462 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002464 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002465 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002466#ifdef FEAT_LUA
2467 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2468 {
2469 cfunc_T cb = fp->uf_cb;
2470
2471 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2472 }
2473#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002474 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002476 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002477 // postponed filling in the arguments, do it now
2478 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002479 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002480
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002481 if (funcexe->basetv != NULL)
2482 {
2483 // Method call: base->Method()
2484 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2485 argv[0] = *funcexe->basetv;
2486 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002487 argvars = argv;
2488 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002489 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002490
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002491 error = call_user_func_check(fp, argcount, argvars, rettv,
2492 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 }
2494 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002495 else if (funcexe->basetv != NULL)
2496 {
2497 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002498 * expr->method(): Find the method name in the table, call its
2499 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002500 */
2501 error = call_internal_method(fname, argcount, argvars, rettv,
2502 funcexe->basetv);
2503 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002504 else
2505 {
2506 /*
2507 * Find the function name in the table, call its implementation.
2508 */
2509 error = call_internal_func(fname, argcount, argvars, rettv);
2510 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002511
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 /*
2513 * The function call (or "FuncUndefined" autocommand sequence) might
2514 * have been aborted by an error, an interrupt, or an explicitly thrown
2515 * exception that has not been caught so far. This situation can be
2516 * tested for by calling aborting(). For an error in an internal
2517 * function or for the "E132" error in call_user_func(), however, the
2518 * throw point at which the "force_abort" flag (temporarily reset by
2519 * emsg()) is normally updated has not been reached yet. We need to
2520 * update that flag first to make aborting() reliable.
2521 */
2522 update_force_abort();
2523 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002524 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002525 ret = OK;
2526
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002527theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002528 /*
2529 * Report an error unless the argument evaluation or function call has been
2530 * cancelled due to an aborting error, an interrupt, or an exception.
2531 */
2532 if (!aborting())
2533 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002534 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 }
2536
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002537 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002538 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002539 clear_tv(&argv[--argv_clear + argv_base]);
2540
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 vim_free(tofree);
2542 vim_free(name);
2543
2544 return ret;
2545}
2546
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002547 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002548printable_func_name(ufunc_T *fp)
2549{
2550 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2551}
2552
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002554 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555 */
2556 static void
2557list_func_head(ufunc_T *fp, int indent)
2558{
2559 int j;
2560
2561 msg_start();
2562 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002563 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002564 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002565 msg_puts("def ");
2566 else
2567 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002568 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 msg_putchar('(');
2570 for (j = 0; j < fp->uf_args.ga_len; ++j)
2571 {
2572 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002573 msg_puts(", ");
2574 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002575 if (fp->uf_arg_types != NULL)
2576 {
2577 char *tofree;
2578
2579 msg_puts(": ");
2580 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2581 vim_free(tofree);
2582 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002583 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2584 {
2585 msg_puts(" = ");
2586 msg_puts(((char **)(fp->uf_def_args.ga_data))
2587 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2588 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002589 }
2590 if (fp->uf_varargs)
2591 {
2592 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002593 msg_puts(", ");
2594 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002595 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002596 if (fp->uf_va_name != NULL)
2597 {
2598 if (j)
2599 msg_puts(", ");
2600 msg_puts("...");
2601 msg_puts((char *)fp->uf_va_name);
2602 if (fp->uf_va_type)
2603 {
2604 char *tofree;
2605
2606 msg_puts(": ");
2607 msg_puts(type_name(fp->uf_va_type, &tofree));
2608 vim_free(tofree);
2609 }
2610 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002611 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002612
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002613 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002614 {
2615 if (fp->uf_ret_type != &t_void)
2616 {
2617 char *tofree;
2618
2619 msg_puts(": ");
2620 msg_puts(type_name(fp->uf_ret_type, &tofree));
2621 vim_free(tofree);
2622 }
2623 }
2624 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002625 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002627 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002629 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002630 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002631 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 msg_clr_eos();
2633 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002634 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002635}
2636
2637/*
2638 * Get a function name, translating "<SID>" and "<SNR>".
2639 * Also handles a Funcref in a List or Dictionary.
2640 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002641 * Set "*is_global" to TRUE when the function must be global, unless
2642 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 * flags:
2644 * TFN_INT: internal function name OK
2645 * TFN_QUIET: be quiet
2646 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002647 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648 * Advances "pp" to just after the function name (if no error).
2649 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002650 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651trans_function_name(
2652 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002653 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002654 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002655 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002656 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002657 partial_T **partial, // return: partial of a FuncRef
2658 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659{
2660 char_u *name = NULL;
2661 char_u *start;
2662 char_u *end;
2663 int lead;
2664 char_u sid_buf[20];
2665 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002666 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002668 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002669 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670
2671 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002672 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 start = *pp;
2674
Bram Moolenaare38eab22019-12-05 21:50:01 +01002675 // Check for hard coded <SNR>: already translated function ID (from a user
2676 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2678 && (*pp)[2] == (int)KE_SNR)
2679 {
2680 *pp += 3;
2681 len = get_id_len(pp) + 3;
2682 return vim_strnsave(start, len);
2683 }
2684
Bram Moolenaare38eab22019-12-05 21:50:01 +01002685 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2686 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687 lead = eval_fname_script(start);
2688 if (lead > 2)
2689 start += lead;
2690
Bram Moolenaare38eab22019-12-05 21:50:01 +01002691 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002692 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 lead > 2 ? 0 : FNE_CHECK_START);
2694 if (end == start)
2695 {
2696 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002697 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 goto theend;
2699 }
2700 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2701 {
2702 /*
2703 * Report an invalid expression in braces, unless the expression
2704 * evaluation has been cancelled due to an aborting error, an
2705 * interrupt, or an exception.
2706 */
2707 if (!aborting())
2708 {
2709 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002710 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 }
2712 else
2713 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2714 goto theend;
2715 }
2716
2717 if (lv.ll_tv != NULL)
2718 {
2719 if (fdp != NULL)
2720 {
2721 fdp->fd_dict = lv.ll_dict;
2722 fdp->fd_newkey = lv.ll_newkey;
2723 lv.ll_newkey = NULL;
2724 fdp->fd_di = lv.ll_di;
2725 }
2726 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2727 {
2728 name = vim_strsave(lv.ll_tv->vval.v_string);
2729 *pp = end;
2730 }
2731 else if (lv.ll_tv->v_type == VAR_PARTIAL
2732 && lv.ll_tv->vval.v_partial != NULL)
2733 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002734 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002735 *pp = end;
2736 if (partial != NULL)
2737 *partial = lv.ll_tv->vval.v_partial;
2738 }
2739 else
2740 {
2741 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2742 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002743 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 else
2745 *pp = end;
2746 name = NULL;
2747 }
2748 goto theend;
2749 }
2750
2751 if (lv.ll_name == NULL)
2752 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002753 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754 *pp = end;
2755 goto theend;
2756 }
2757
Bram Moolenaare38eab22019-12-05 21:50:01 +01002758 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002759 if (lv.ll_exp_name != NULL)
2760 {
2761 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002762 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 flags & TFN_NO_AUTOLOAD);
2764 if (name == lv.ll_exp_name)
2765 name = NULL;
2766 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002767 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 {
2769 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002770 name = deref_func_name(*pp, &len, partial, type,
2771 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 if (name == *pp)
2773 name = NULL;
2774 }
2775 if (name != NULL)
2776 {
2777 name = vim_strsave(name);
2778 *pp = end;
2779 if (STRNCMP(name, "<SNR>", 5) == 0)
2780 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002781 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 name[0] = K_SPECIAL;
2783 name[1] = KS_EXTRA;
2784 name[2] = (int)KE_SNR;
2785 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2786 }
2787 goto theend;
2788 }
2789
2790 if (lv.ll_exp_name != NULL)
2791 {
2792 len = (int)STRLEN(lv.ll_exp_name);
2793 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2794 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2795 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002796 // When there was "s:" already or the name expanded to get a
2797 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 lv.ll_name += 2;
2799 len -= 2;
2800 lead = 2;
2801 }
2802 }
2803 else
2804 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002805 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002807 {
2808 if (is_global != NULL && lv.ll_name[0] == 'g')
2809 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002811 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 len = (int)(end - lv.ll_name);
2813 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002814 if (len <= 0)
2815 {
2816 if (!skip)
2817 emsg(_(e_function_name));
2818 goto theend;
2819 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002821 // In Vim9 script a user function is script-local by default, unless it
2822 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002823 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002824 if (vim9script)
2825 {
2826 char_u *p;
2827
2828 // SomeScript#func() is a global function.
2829 for (p = start; *p != NUL && *p != '('; ++p)
2830 if (*p == AUTOLOAD_CHAR)
2831 vim9script = FALSE;
2832 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002833
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 /*
2835 * Copy the function name to allocated memory.
2836 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2837 * Accept <SNR>123_name() outside a script.
2838 */
2839 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002840 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002841 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002843 if (!vim9script)
2844 lead = 3;
2845 if (vim9script || (lv.ll_exp_name != NULL
2846 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002847 || eval_fname_sid(*pp))
2848 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002849 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002850 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002851 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002852 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853 goto theend;
2854 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002855 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002856 if (vim9script)
2857 extra = 3 + (int)STRLEN(sid_buf);
2858 else
2859 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 }
2861 }
2862 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2863 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002864 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 start);
2866 goto theend;
2867 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002868 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 {
2870 char_u *cp = vim_strchr(lv.ll_name, ':');
2871
2872 if (cp != NULL && cp < end)
2873 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002874 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 goto theend;
2876 }
2877 }
2878
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002879 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880 if (name != NULL)
2881 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002882 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 {
2884 name[0] = K_SPECIAL;
2885 name[1] = KS_EXTRA;
2886 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002887 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 STRCPY(name + 3, sid_buf);
2889 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002890 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2891 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892 }
2893 *pp = end;
2894
2895theend:
2896 clear_lval(&lv);
2897 return name;
2898}
2899
2900/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002901 * Assuming "name" is the result of trans_function_name() and it was prefixed
2902 * to use the script-local name, return the unmodified name (points into
2903 * "name"). Otherwise return NULL.
2904 * This can be used to first search for a script-local function and fall back
2905 * to the global function if not found.
2906 */
2907 char_u *
2908untrans_function_name(char_u *name)
2909{
2910 char_u *p;
2911
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002912 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002913 {
2914 p = vim_strchr(name, '_');
2915 if (p != NULL)
2916 return p + 1;
2917 }
2918 return NULL;
2919}
2920
2921/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002922 * List functions. When "regmatch" is NULL all of then.
2923 * Otherwise functions matching "regmatch".
2924 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002925 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002926list_functions(regmatch_T *regmatch)
2927{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002928 int changed = func_hashtab.ht_changed;
2929 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002930 hashitem_T *hi;
2931
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002932 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002933 {
2934 if (!HASHITEM_EMPTY(hi))
2935 {
2936 ufunc_T *fp = HI2UF(hi);
2937
2938 --todo;
2939 if ((fp->uf_flags & FC_DEAD) == 0
2940 && (regmatch == NULL
2941 ? !message_filtered(fp->uf_name)
2942 && !func_name_refcount(fp->uf_name)
2943 : !isdigit(*fp->uf_name)
2944 && vim_regexec(regmatch, fp->uf_name, 0)))
2945 {
2946 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002947 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002948 {
2949 emsg(_("E454: function list was modified"));
2950 return;
2951 }
2952 }
2953 }
2954 }
2955}
2956
2957/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002958 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2959 * return TRUE.
2960 * Otherwise return FALSE;
2961 * Do not consider "function(" to be a command.
2962 */
2963 static int
2964is_function_cmd(char_u **cmd)
2965{
2966 char_u *p = *cmd;
2967
2968 if (checkforcmd(&p, "function", 2))
2969 {
2970 if (*p == '(')
2971 return FALSE;
2972 *cmd = p;
2973 return TRUE;
2974 }
2975 return FALSE;
2976}
2977
2978/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002979 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002980 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2981 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002982 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002984 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002985define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002986{
2987 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002988 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 int j;
2990 int c;
2991 int saved_did_emsg;
2992 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002993 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002994 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 char_u *p;
2996 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01002997 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 char_u *line_arg = NULL;
2999 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003000 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003001 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 garray_T newlines;
3003 int varargs = FALSE;
3004 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003005 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003006 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003007 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 int indent;
3009 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003010#define MAX_FUNC_NESTING 50
3011 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 dictitem_T *v;
3013 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003014 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003015 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003017 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003018 linenr_T sourcing_lnum_off;
3019 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003020 int is_heredoc = FALSE;
3021 char_u *skip_until = NULL;
3022 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003023 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003024 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025
3026 /*
3027 * ":function" without argument: list functions.
3028 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003029 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 {
3031 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003032 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003034 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003035 }
3036
3037 /*
3038 * ":function /pat": list functions matching pattern.
3039 */
3040 if (*eap->arg == '/')
3041 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003042 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043 if (!eap->skip)
3044 {
3045 regmatch_T regmatch;
3046
3047 c = *p;
3048 *p = NUL;
3049 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3050 *p = c;
3051 if (regmatch.regprog != NULL)
3052 {
3053 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003054 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 vim_regfree(regmatch.regprog);
3056 }
3057 }
3058 if (*p == '/')
3059 ++p;
3060 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003061 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003062 }
3063
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003064 ga_init(&newargs);
3065 ga_init(&argtypes);
3066 ga_init(&default_args);
3067
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 /*
3069 * Get the function name. There are these situations:
3070 * func normal function name
3071 * "name" == func, "fudi.fd_dict" == NULL
3072 * dict.func new dictionary entry
3073 * "name" == NULL, "fudi.fd_dict" set,
3074 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3075 * dict.func existing dict entry with a Funcref
3076 * "name" == func, "fudi.fd_dict" set,
3077 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3078 * dict.func existing dict entry that's not a Funcref
3079 * "name" == NULL, "fudi.fd_dict" set,
3080 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3081 * s:func script-local function name
3082 * g:func global function name, same as "func"
3083 */
3084 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003085 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003087 // nested function, argument is (args).
3088 paren = TRUE;
3089 CLEAR_FIELD(fudi);
3090 }
3091 else
3092 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003093 if (STRNCMP(p, "<lambda>", 8) == 0)
3094 {
3095 p += 8;
3096 (void)getdigits(&p);
3097 name = vim_strnsave(eap->arg, p - eap->arg);
3098 CLEAR_FIELD(fudi);
3099 }
3100 else
3101 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003102 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003103 paren = (vim_strchr(p, '(') != NULL);
3104 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003105 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003106 /*
3107 * Return on an invalid expression in braces, unless the expression
3108 * evaluation has been cancelled due to an aborting error, an
3109 * interrupt, or an exception.
3110 */
3111 if (!aborting())
3112 {
3113 if (!eap->skip && fudi.fd_newkey != NULL)
3114 semsg(_(e_dictkey), fudi.fd_newkey);
3115 vim_free(fudi.fd_newkey);
3116 return NULL;
3117 }
3118 else
3119 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003120 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121 }
3122
Bram Moolenaare38eab22019-12-05 21:50:01 +01003123 // An error in a function call during evaluation of an expression in magic
3124 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003125 saved_did_emsg = did_emsg;
3126 did_emsg = FALSE;
3127
3128 /*
3129 * ":function func" with only function name: list function.
3130 */
3131 if (!paren)
3132 {
3133 if (!ends_excmd(*skipwhite(p)))
3134 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003135 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136 goto ret_free;
3137 }
3138 eap->nextcmd = check_nextcmd(p);
3139 if (eap->nextcmd != NULL)
3140 *p = NUL;
3141 if (!eap->skip && !got_int)
3142 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003143 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003144 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3145 {
3146 char_u *up = untrans_function_name(name);
3147
3148 // With Vim9 script the name was made script-local, if not
3149 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003150 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003151 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003152 }
3153
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154 if (fp != NULL)
3155 {
3156 list_func_head(fp, TRUE);
3157 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3158 {
3159 if (FUNCLINE(fp, j) == NULL)
3160 continue;
3161 msg_putchar('\n');
3162 msg_outnum((long)(j + 1));
3163 if (j < 9)
3164 msg_putchar(' ');
3165 if (j < 99)
3166 msg_putchar(' ');
3167 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003168 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003169 ui_breakcheck();
3170 }
3171 if (!got_int)
3172 {
3173 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003174 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003175 msg_puts(" enddef");
3176 else
3177 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 }
3179 }
3180 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003181 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003182 }
3183 goto ret_free;
3184 }
3185
3186 /*
3187 * ":function name(arg1, arg2)" Define function.
3188 */
3189 p = skipwhite(p);
3190 if (*p != '(')
3191 {
3192 if (!eap->skip)
3193 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003194 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195 goto ret_free;
3196 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003197 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003198 if (vim_strchr(p, '(') != NULL)
3199 p = vim_strchr(p, '(');
3200 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003202 // In Vim9 script only global functions can be redefined.
3203 if (vim9script && eap->forceit && !is_global)
3204 {
3205 emsg(_(e_nobang));
3206 goto ret_free;
3207 }
3208
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3210
Bram Moolenaar04b12692020-05-04 23:24:44 +02003211 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003213 // Check the name of the function. Unless it's a dictionary function
3214 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215 if (name != NULL)
3216 arg = name;
3217 else
3218 arg = fudi.fd_newkey;
3219 if (arg != NULL && (fudi.fd_di == NULL
3220 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3221 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3222 {
3223 if (*arg == K_SPECIAL)
3224 j = 3;
3225 else
3226 j = 0;
3227 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3228 : eval_isnamec(arg[j])))
3229 ++j;
3230 if (arg[j] != NUL)
3231 emsg_funcname((char *)e_invarg2, arg);
3232 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003233 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003235 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 }
3237
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003238 // This may get more lines and make the pointers into the first line
3239 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003240 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003242 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003243 &varargs, &default_args, eap->skip,
3244 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003246 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003250 // find the return type: :def Func(): type
3251 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003253 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003254 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003256 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003257 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003258 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003259 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003260 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003261 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003262 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003263 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003264 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003265 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003266 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003267 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003269 else
3270 // find extra arguments "range", "dict", "abort" and "closure"
3271 for (;;)
3272 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003273 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274 p = skipwhite(p);
3275 if (STRNCMP(p, "range", 5) == 0)
3276 {
3277 flags |= FC_RANGE;
3278 p += 5;
3279 }
3280 else if (STRNCMP(p, "dict", 4) == 0)
3281 {
3282 flags |= FC_DICT;
3283 p += 4;
3284 }
3285 else if (STRNCMP(p, "abort", 5) == 0)
3286 {
3287 flags |= FC_ABORT;
3288 p += 5;
3289 }
3290 else if (STRNCMP(p, "closure", 7) == 0)
3291 {
3292 flags |= FC_CLOSURE;
3293 p += 7;
3294 if (current_funccal == NULL)
3295 {
3296 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3297 name == NULL ? (char_u *)"" : name);
3298 goto erret;
3299 }
3300 }
3301 else
3302 break;
3303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304
Bram Moolenaare38eab22019-12-05 21:50:01 +01003305 // When there is a line break use what follows for the function body.
3306 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 if (*p == '\n')
3308 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003309 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003310 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3311 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003312 && !(VIM_ISWHITE(*whitep) && *p == '#'
3313 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003314 && !eap->skip
3315 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003316 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317
3318 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003319 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3320 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321 */
3322 if (KeyTyped)
3323 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003324 // Check if the function already exists, don't let the user type the
3325 // whole function before telling him it doesn't work! For a script we
3326 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327 if (!eap->skip && !eap->forceit)
3328 {
3329 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003330 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003331 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 emsg_funcname(e_funcexts, name);
3333 }
3334
3335 if (!eap->skip && did_emsg)
3336 goto erret;
3337
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 cmdline_row = msg_row;
3340 }
3341
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003342 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003343 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003344
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003345 // Detect having skipped over comment lines to find the return
3346 // type. Add NULL lines to keep the line count correct.
3347 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3348 if (SOURCING_LNUM < sourcing_lnum_off)
3349 {
3350 sourcing_lnum_off -= SOURCING_LNUM;
3351 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3352 goto erret;
3353 while (sourcing_lnum_off-- > 0)
3354 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3355 }
3356
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 indent = 2;
3358 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003359 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003360 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003361 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 for (;;)
3363 {
3364 if (KeyTyped)
3365 {
3366 msg_scroll = TRUE;
3367 saved_wait_return = FALSE;
3368 }
3369 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370
3371 if (line_arg != NULL)
3372 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003373 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003374 theline = line_arg;
3375 p = vim_strchr(theline, '\n');
3376 if (p == NULL)
3377 line_arg += STRLEN(line_arg);
3378 else
3379 {
3380 *p = NUL;
3381 line_arg = p + 1;
3382 }
3383 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003385 {
3386 vim_free(line_to_free);
3387 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003388 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003389 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003390 theline = eap->getline(':', eap->cookie, indent,
3391 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003392 line_to_free = theline;
3393 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394 if (KeyTyped)
3395 lines_left = Rows - 1;
3396 if (theline == NULL)
3397 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003398 // Use the start of the function for the line number.
3399 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003400 if (skip_until != NULL)
3401 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3402 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003403 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003404 else
3405 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406 goto erret;
3407 }
3408
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003409 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003410 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003411 if (SOURCING_LNUM < sourcing_lnum_off)
3412 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003413 else
3414 sourcing_lnum_off = 0;
3415
3416 if (skip_until != NULL)
3417 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003419 // * ":append" and "."
3420 // * ":python <<EOF" and "EOF"
3421 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3422 if (heredoc_trimmed == NULL
3423 || (is_heredoc && skipwhite(theline) == theline)
3424 || STRNCMP(theline, heredoc_trimmed,
3425 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003426 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003427 if (heredoc_trimmed == NULL)
3428 p = theline;
3429 else if (is_heredoc)
3430 p = skipwhite(theline) == theline
3431 ? theline : theline + STRLEN(heredoc_trimmed);
3432 else
3433 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003434 if (STRCMP(p, skip_until) == 0)
3435 {
3436 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003437 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003438 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003439 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003440 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003441 }
3442 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 }
3444 else
3445 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003446 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003447 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 ;
3449
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003450 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003451 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003453 ? "enddef" : "endfunction", 4)
3454 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003456 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003457 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003458 char_u *nextcmd = NULL;
3459
3460 if (*p == '|')
3461 nextcmd = p + 1;
3462 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3463 nextcmd = line_arg;
3464 else if (*p != NUL && *p != '"' && p_verbose > 0)
3465 give_warning2(eap->cmdidx == CMD_def
3466 ? (char_u *)_("W1001: Text found after :enddef: %s")
3467 : (char_u *)_("W22: Text found after :endfunction: %s"),
3468 p, TRUE);
3469 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003470 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003471 // Another command follows. If the line came from "eap"
3472 // we can simply point into it, otherwise we need to
3473 // change "eap->cmdlinep".
3474 eap->nextcmd = nextcmd;
3475 if (line_to_free != NULL)
3476 {
3477 vim_free(*eap->cmdlinep);
3478 *eap->cmdlinep = line_to_free;
3479 line_to_free = NULL;
3480 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003481 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003482 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003483 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 }
3485
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003486 // Check for mismatched "endfunc" or "enddef".
3487 // We don't check for "def" inside "func" thus we also can't check
3488 // for "enddef".
3489 // We continue to find the end of the function, although we might
3490 // not find it.
3491 else if (nesting_def[nesting])
3492 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003493 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003494 emsg(_(e_mismatched_endfunction));
3495 }
3496 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3497 emsg(_(e_mismatched_enddef));
3498
Bram Moolenaare38eab22019-12-05 21:50:01 +01003499 // Increase indent inside "if", "while", "for" and "try", decrease
3500 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003501 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 indent -= 2;
3503 else if (STRNCMP(p, "if", 2) == 0
3504 || STRNCMP(p, "wh", 2) == 0
3505 || STRNCMP(p, "for", 3) == 0
3506 || STRNCMP(p, "try", 3) == 0)
3507 indent += 2;
3508
Bram Moolenaare38eab22019-12-05 21:50:01 +01003509 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003510 // Only recognize "def" inside "def", not inside "function",
3511 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003512 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003513 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003514 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 {
3516 if (*p == '!')
3517 p = skipwhite(p + 1);
3518 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003519 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3520 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003521 if (*skipwhite(p) == '(')
3522 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003523 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003524 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003525 else
3526 {
3527 ++nesting;
3528 nesting_def[nesting] = (c == 'd');
3529 indent += 2;
3530 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531 }
3532 }
3533
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003534 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003535 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003536 if (eap->cmdidx != CMD_def
3537 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003538 || (p[0] == 'c'
3539 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3540 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3541 && (STRNCMP(&p[3], "nge", 3) != 0
3542 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 || (p[0] == 'i'
3544 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003545 && (!ASCII_ISALPHA(p[2])
3546 || (p[2] == 's'
3547 && (!ASCII_ISALPHA(p[3])
3548 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 skip_until = vim_strsave((char_u *)".");
3550
Bram Moolenaare38eab22019-12-05 21:50:01 +01003551 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 arg = skipwhite(skiptowhite(p));
3553 if (arg[0] == '<' && arg[1] =='<'
3554 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003555 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3556 || ((p[2] == '3' || p[2] == 'x')
3557 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 || (p[0] == 'p' && p[1] == 'e'
3559 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3560 || (p[0] == 't' && p[1] == 'c'
3561 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3562 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3563 && !ASCII_ISALPHA(p[3]))
3564 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3565 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3566 || (p[0] == 'm' && p[1] == 'z'
3567 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3568 ))
3569 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003570 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003571 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003572 if (STRNCMP(p, "trim", 4) == 0)
3573 {
3574 // Ignore leading white space.
3575 p = skipwhite(p + 4);
3576 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003577 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003578 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003579 if (*p == NUL)
3580 skip_until = vim_strsave((char_u *)".");
3581 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003582 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003583 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003584 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003586
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003587 // Check for ":cmd v =<< [trim] EOF"
3588 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003589 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003590 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003591 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003592 if (*arg == '[')
3593 arg = vim_strchr(arg, ']');
3594 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003595 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003596 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3597 && arg[1] == '<' && arg[2] =='<');
3598
3599 if (!found)
3600 // skip over the argument after "cmd"
3601 arg = skipwhite(skiptowhite(arg));
3602 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003603 && (checkforcmd(&p, "let", 2)
3604 || checkforcmd(&p, "var", 3)
3605 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003606 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003607 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003608 p = skipwhite(arg + 3);
3609 if (STRNCMP(p, "trim", 4) == 0)
3610 {
3611 // Ignore leading white space.
3612 p = skipwhite(p + 4);
3613 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003614 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003615 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003616 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003617 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003618 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003619 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003620 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 }
3622
Bram Moolenaare38eab22019-12-05 21:50:01 +01003623 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003626
Bram Moolenaare38eab22019-12-05 21:50:01 +01003627 // Copy the line to newly allocated memory. get_one_sourceline()
3628 // allocates 250 bytes per line, this saves 80% on average. The cost
3629 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003631 if (p == NULL)
3632 goto erret;
3633 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 // Add NULL lines for continuation lines, so that the line count is
3636 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003637 while (sourcing_lnum_off-- > 0)
3638 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3639
Bram Moolenaare38eab22019-12-05 21:50:01 +01003640 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003641 if (line_arg != NULL && *line_arg == NUL)
3642 line_arg = NULL;
3643 }
3644
Bram Moolenaare38eab22019-12-05 21:50:01 +01003645 // Don't define the function when skipping commands or when an error was
3646 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003647 if (eap->skip || did_emsg)
3648 goto erret;
3649
3650 /*
3651 * If there are no errors, add the function
3652 */
3653 if (fudi.fd_dict == NULL)
3654 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003655 hashtab_T *ht;
3656
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003657 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3659 {
3660 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3661 name);
3662 goto erret;
3663 }
3664
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003665 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003666 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003668 char_u *uname = untrans_function_name(name);
3669
3670 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3671 }
3672
3673 if (fp != NULL || import != NULL)
3674 {
3675 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003677 // Function can be replaced with "function!" and when sourcing the
3678 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003679 // A name that is used by an import can not be overruled.
3680 if (import != NULL
3681 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003682 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003683 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003685 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003686 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003687 else
3688 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003689 goto erret;
3690 }
3691 if (fp->uf_calls > 0)
3692 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003693 emsg_funcname(
3694 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 name);
3696 goto erret;
3697 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003698 if (fp->uf_refcount > 1)
3699 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003700 // This function is referenced somewhere, don't redefine it but
3701 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003702 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003703 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003704 fp = NULL;
3705 overwrite = TRUE;
3706 }
3707 else
3708 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003709 char_u *exp_name = fp->uf_name_exp;
3710
3711 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003712 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003713 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003714 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003715 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003716 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003717#ifdef FEAT_PROFILE
3718 fp->uf_profiling = FALSE;
3719 fp->uf_prof_initialized = FALSE;
3720#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003721 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003722 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003723 }
3724 }
3725 else
3726 {
3727 char numbuf[20];
3728
3729 fp = NULL;
3730 if (fudi.fd_newkey == NULL && !eap->forceit)
3731 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003732 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 goto erret;
3734 }
3735 if (fudi.fd_di == NULL)
3736 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003737 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003738 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003739 goto erret;
3740 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003741 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003742 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 goto erret;
3744
Bram Moolenaare38eab22019-12-05 21:50:01 +01003745 // Give the function a sequential number. Can only be used with a
3746 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 vim_free(name);
3748 sprintf(numbuf, "%d", ++func_nr);
3749 name = vim_strsave((char_u *)numbuf);
3750 if (name == NULL)
3751 goto erret;
3752 }
3753
3754 if (fp == NULL)
3755 {
3756 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3757 {
3758 int slen, plen;
3759 char_u *scriptname;
3760
Bram Moolenaare38eab22019-12-05 21:50:01 +01003761 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003762 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003763 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 {
3765 scriptname = autoload_name(name);
3766 if (scriptname != NULL)
3767 {
3768 p = vim_strchr(scriptname, '/');
3769 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003770 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003771 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003772 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003773 j = OK;
3774 vim_free(scriptname);
3775 }
3776 }
3777 if (j == FAIL)
3778 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003779 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 goto erret;
3781 }
3782 }
3783
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003784 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 if (fp == NULL)
3786 goto erret;
3787
3788 if (fudi.fd_dict != NULL)
3789 {
3790 if (fudi.fd_di == NULL)
3791 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003792 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3794 if (fudi.fd_di == NULL)
3795 {
3796 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003797 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 goto erret;
3799 }
3800 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3801 {
3802 vim_free(fudi.fd_di);
3803 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003804 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 goto erret;
3806 }
3807 }
3808 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003809 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 clear_tv(&fudi.fd_di->di_tv);
3811 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003813
Bram Moolenaare38eab22019-12-05 21:50:01 +01003814 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 flags |= FC_DICT;
3816 }
3817
Bram Moolenaare38eab22019-12-05 21:50:01 +01003818 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003819 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003820 if (overwrite)
3821 {
3822 hi = hash_find(&func_hashtab, name);
3823 hi->hi_key = UF2HIKEY(fp);
3824 }
3825 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 {
3827 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003828 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 goto erret;
3830 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003831 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 }
3833 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003834 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003835 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003836 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003837
3838 if (eap->cmdidx == CMD_def)
3839 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003840 int lnum_save = SOURCING_LNUM;
3841 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003842
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003843 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003844
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003845 // error messages are for the first function line
3846 SOURCING_LNUM = sourcing_lnum_top;
3847
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003848 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003849 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003850 int count = cstack->cs_idx + 1;
3851 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003852
3853 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003854 // a block that is visible now but not when the function is called
3855 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003856 fp->uf_block_ids = ALLOC_MULT(int, count);
3857 if (fp->uf_block_ids != NULL)
3858 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003859 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003860 sizeof(int) * count);
3861 fp->uf_block_depth = count;
3862 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003863
3864 // Set flag in each block to indicate a function was defined. This
3865 // is used to keep the variable when leaving the block, see
3866 // hide_script_var().
3867 for (i = 0; i <= cstack->cs_idx; ++i)
3868 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003869 }
3870
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003871 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003872 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003873 SOURCING_LNUM = lnum_save;
3874 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003875 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003876 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003877
3878 // parse the return type, if any
3879 if (ret_type == NULL)
3880 fp->uf_ret_type = &t_void;
3881 else
3882 {
3883 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003884 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003885 if (fp->uf_ret_type == NULL)
3886 {
3887 fp->uf_ret_type = &t_void;
3888 SOURCING_LNUM = lnum_save;
3889 goto erret;
3890 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003891 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003892 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003893 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003894 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003895 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003896
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003898 if ((flags & FC_CLOSURE) != 0)
3899 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003900 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003901 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003902 }
3903 else
3904 fp->uf_scoped = NULL;
3905
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907 if (prof_def_func())
3908 func_do_profile(fp);
3909#endif
3910 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003911 if (sandbox)
3912 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003913 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003914 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 fp->uf_flags = flags;
3916 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003917 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003918 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003919 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003920 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003921 if (is_export)
3922 {
3923 fp->uf_flags |= FC_EXPORT;
3924 // let ex_export() know the export worked.
3925 is_export = FALSE;
3926 }
3927
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003928 if (eap->cmdidx == CMD_def)
3929 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003930 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3931 // :func does not use Vim9 script syntax, even in a Vim9 script file
3932 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003933
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 goto ret_free;
3935
3936erret:
3937 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003938 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939errret_2:
3940 ga_clear_strings(&newlines);
3941ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003942 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003944 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003945 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003947 if (name != name_arg)
3948 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003949 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 did_emsg |= saved_did_emsg;
3951 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003952
3953 return fp;
3954}
3955
3956/*
3957 * ":function"
3958 */
3959 void
3960ex_function(exarg_T *eap)
3961{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003962 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003963}
3964
3965/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003966 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01003967 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003968 */
3969 void
3970ex_defcompile(exarg_T *eap UNUSED)
3971{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003972 long todo = (long)func_hashtab.ht_used;
3973 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003974 hashitem_T *hi;
3975 ufunc_T *ufunc;
3976
3977 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3978 {
3979 if (!HASHITEM_EMPTY(hi))
3980 {
3981 --todo;
3982 ufunc = HI2UF(hi);
3983 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003984 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3985 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003986 {
Bram Moolenaarb2049902021-01-24 12:53:53 +01003987 compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003988
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003989 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003990 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003991 // a function has been added or removed, need to start over
3992 todo = (long)func_hashtab.ht_used;
3993 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003994 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02003995 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003996 }
3997 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003998 }
3999 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004000}
4001
4002/*
4003 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4004 * Return 2 if "p" starts with "s:".
4005 * Return 0 otherwise.
4006 */
4007 int
4008eval_fname_script(char_u *p)
4009{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004010 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4011 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4013 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4014 return 5;
4015 if (p[0] == 's' && p[1] == ':')
4016 return 2;
4017 return 0;
4018}
4019
4020 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004021translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022{
4023 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004024 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004025 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004026}
4027
4028/*
4029 * Return TRUE when "ufunc" has old-style "..." varargs
4030 * or named varargs "...name: type".
4031 */
4032 int
4033has_varargs(ufunc_T *ufunc)
4034{
4035 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036}
4037
4038/*
4039 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004040 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 */
4042 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004043function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044{
4045 char_u *nm = name;
4046 char_u *p;
4047 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004048 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004049 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004051 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4052 if (no_deref)
4053 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004054 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 nm = skipwhite(nm);
4056
Bram Moolenaare38eab22019-12-05 21:50:01 +01004057 // Only accept "funcname", "funcname ", "funcname (..." and
4058 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004060 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061 vim_free(p);
4062 return n;
4063}
4064
Bram Moolenaar113e1072019-01-20 15:30:40 +01004065#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066 char_u *
4067get_expanded_name(char_u *name, int check)
4068{
4069 char_u *nm = name;
4070 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004071 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004073 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004074 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004076 if (p != NULL && *nm == NUL
4077 && (!check || translated_function_exists(p, is_global)))
4078 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079
4080 vim_free(p);
4081 return NULL;
4082}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004083#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085/*
4086 * Function given to ExpandGeneric() to obtain the list of user defined
4087 * function names.
4088 */
4089 char_u *
4090get_user_func_name(expand_T *xp, int idx)
4091{
4092 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004093 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094 static hashitem_T *hi;
4095 ufunc_T *fp;
4096
4097 if (idx == 0)
4098 {
4099 done = 0;
4100 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004101 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004103 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 {
4105 if (done++ > 0)
4106 ++hi;
4107 while (HASHITEM_EMPTY(hi))
4108 ++hi;
4109 fp = HI2UF(hi);
4110
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004111 // don't show dead, dict and lambda functions
4112 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004113 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004114 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004115
4116 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004117 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118
4119 cat_func_name(IObuff, fp);
4120 if (xp->xp_context != EXPAND_USER_FUNC)
4121 {
4122 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004123 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004124 STRCAT(IObuff, ")");
4125 }
4126 return IObuff;
4127 }
4128 return NULL;
4129}
4130
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004131/*
4132 * ":delfunction {name}"
4133 */
4134 void
4135ex_delfunction(exarg_T *eap)
4136{
4137 ufunc_T *fp = NULL;
4138 char_u *p;
4139 char_u *name;
4140 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004141 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142
4143 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004144 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4145 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 vim_free(fudi.fd_newkey);
4147 if (name == NULL)
4148 {
4149 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004150 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 return;
4152 }
4153 if (!ends_excmd(*skipwhite(p)))
4154 {
4155 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004156 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004157 return;
4158 }
4159 eap->nextcmd = check_nextcmd(p);
4160 if (eap->nextcmd != NULL)
4161 *p = NUL;
4162
4163 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004164 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 vim_free(name);
4166
4167 if (!eap->skip)
4168 {
4169 if (fp == NULL)
4170 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004171 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004172 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 return;
4174 }
4175 if (fp->uf_calls > 0)
4176 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004177 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 return;
4179 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004180 if (fp->uf_flags & FC_VIM9)
4181 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004182 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004183 return;
4184 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185
4186 if (fudi.fd_dict != NULL)
4187 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004188 // Delete the dict item that refers to the function, it will
4189 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4191 }
4192 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004193 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004194 // A normal function (not a numbered function or lambda) has a
4195 // refcount of 1 for the entry in the hashtable. When deleting
4196 // it and the refcount is more than one, it should be kept.
4197 // A numbered function and lambda should be kept if the refcount is
4198 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004199 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004200 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004201 // Function is still referenced somewhere. Don't free it but
4202 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004203 if (func_remove(fp))
4204 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004205 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004206 }
4207 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004208 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004209 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004210 }
4211}
4212
4213/*
4214 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004215 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004216 */
4217 void
4218func_unref(char_u *name)
4219{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004220 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004222 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004223 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004224 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004225 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004226 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004227#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004228 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004230 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004231 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004232 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004233}
4234
4235/*
4236 * Unreference a Function: decrement the reference count and free it when it
4237 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004238 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004239 */
4240 void
4241func_ptr_unref(ufunc_T *fp)
4242{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004243 if (fp != NULL && (--fp->uf_refcount <= 0
4244 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4245 && fp->uf_partial->pt_refcount <= 1
4246 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004247 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004248 // Only delete it when it's not being used. Otherwise it's done
4249 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004250 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004251 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004252 }
4253}
4254
4255/*
4256 * Count a reference to a Function.
4257 */
4258 void
4259func_ref(char_u *name)
4260{
4261 ufunc_T *fp;
4262
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004263 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004265 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004266 if (fp != NULL)
4267 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004269 // Only give an error for a numbered function.
4270 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004271 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004272}
4273
4274/*
4275 * Count a reference to a Function.
4276 */
4277 void
4278func_ptr_ref(ufunc_T *fp)
4279{
4280 if (fp != NULL)
4281 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282}
4283
4284/*
4285 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4286 * referenced from anywhere that is in use.
4287 */
4288 static int
4289can_free_funccal(funccall_T *fc, int copyID)
4290{
4291 return (fc->l_varlist.lv_copyID != copyID
4292 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004293 && fc->l_avars.dv_copyID != copyID
4294 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295}
4296
4297/*
4298 * ":return [expr]"
4299 */
4300 void
4301ex_return(exarg_T *eap)
4302{
4303 char_u *arg = eap->arg;
4304 typval_T rettv;
4305 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004306 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307
4308 if (current_funccal == NULL)
4309 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004310 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004311 return;
4312 }
4313
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004314 CLEAR_FIELD(evalarg);
4315 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4316
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 if (eap->skip)
4318 ++emsg_skip;
4319
4320 eap->nextcmd = NULL;
4321 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004322 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 {
4324 if (!eap->skip)
4325 returning = do_return(eap, FALSE, TRUE, &rettv);
4326 else
4327 clear_tv(&rettv);
4328 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004329 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004330 else if (!eap->skip)
4331 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004332 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004333 update_force_abort();
4334
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 /*
4336 * Return unless the expression evaluation has been cancelled due to an
4337 * aborting error, an interrupt, or an exception.
4338 */
4339 if (!aborting())
4340 returning = do_return(eap, FALSE, TRUE, NULL);
4341 }
4342
Bram Moolenaare38eab22019-12-05 21:50:01 +01004343 // When skipping or the return gets pending, advance to the next command
4344 // in this line (!returning). Otherwise, ignore the rest of the line.
4345 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 if (returning)
4347 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004348 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 eap->nextcmd = check_nextcmd(arg);
4350
4351 if (eap->skip)
4352 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004353 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004354}
4355
4356/*
4357 * ":1,25call func(arg1, arg2)" function call.
4358 */
4359 void
4360ex_call(exarg_T *eap)
4361{
4362 char_u *arg = eap->arg;
4363 char_u *startarg;
4364 char_u *name;
4365 char_u *tofree;
4366 int len;
4367 typval_T rettv;
4368 linenr_T lnum;
4369 int doesrange;
4370 int failed = FALSE;
4371 funcdict_T fudi;
4372 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004373 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004374 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375
Bram Moolenaare6b53242020-07-01 17:28:33 +02004376 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 if (eap->skip)
4378 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004379 // trans_function_name() doesn't work well when skipping, use eval0()
4380 // instead to skip to any following command, e.g. for:
4381 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004383 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384 clear_tv(&rettv);
4385 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004386 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387 return;
4388 }
4389
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004390 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4391 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392 if (fudi.fd_newkey != NULL)
4393 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004394 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004395 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 vim_free(fudi.fd_newkey);
4397 }
4398 if (tofree == NULL)
4399 return;
4400
Bram Moolenaare38eab22019-12-05 21:50:01 +01004401 // Increase refcount on dictionary, it could get deleted when evaluating
4402 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004403 if (fudi.fd_dict != NULL)
4404 ++fudi.fd_dict->dv_refcount;
4405
Bram Moolenaare38eab22019-12-05 21:50:01 +01004406 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4407 // contents. For VAR_PARTIAL get its partial, unless we already have one
4408 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004409 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004410 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4411 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004412
Bram Moolenaare38eab22019-12-05 21:50:01 +01004413 // Skip white space to allow ":call func ()". Not good, but required for
4414 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004416 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004417
4418 if (*startarg != '(')
4419 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004420 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 goto end;
4422 }
4423
4424 /*
4425 * When skipping, evaluate the function once, to find the end of the
4426 * arguments.
4427 * When the function takes a range, this is discovered after the first
4428 * call, and the loop is broken.
4429 */
4430 if (eap->skip)
4431 {
4432 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004433 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 }
4435 else
4436 lnum = eap->line1;
4437 for ( ; lnum <= eap->line2; ++lnum)
4438 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004439 funcexe_T funcexe;
4440
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004441 if (!eap->skip && eap->addr_count > 0)
4442 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004443 if (lnum > curbuf->b_ml.ml_line_count)
4444 {
4445 // If the function deleted lines or switched to another buffer
4446 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004447 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004448 break;
4449 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 curwin->w_cursor.lnum = lnum;
4451 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453 }
4454 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004455
Bram Moolenaara80faa82020-04-12 19:37:17 +02004456 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004457 funcexe.firstline = eap->line1;
4458 funcexe.lastline = eap->line2;
4459 funcexe.doesrange = &doesrange;
4460 funcexe.evaluate = !eap->skip;
4461 funcexe.partial = partial;
4462 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004463 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004464 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 {
4466 failed = TRUE;
4467 break;
4468 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004469 if (has_watchexpr())
4470 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004472 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004473 if (handle_subscript(&arg, &rettv,
4474 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004475 {
4476 failed = TRUE;
4477 break;
4478 }
4479
4480 clear_tv(&rettv);
4481 if (doesrange || eap->skip)
4482 break;
4483
Bram Moolenaare38eab22019-12-05 21:50:01 +01004484 // Stop when immediately aborting on error, or when an interrupt
4485 // occurred or an exception was thrown but not caught.
4486 // get_func_tv() returned OK, so that the check for trailing
4487 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004488 if (aborting())
4489 break;
4490 }
4491 if (eap->skip)
4492 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004493 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494
Bram Moolenaare51bb172020-02-16 19:42:23 +01004495 // When inside :try we need to check for following "| catch".
4496 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004498 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004499 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004500 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004501 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004502 if (!failed)
4503 {
4504 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004505 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004506 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004507 }
4508 else
4509 eap->nextcmd = check_nextcmd(arg);
4510 }
4511
4512end:
4513 dict_unref(fudi.fd_dict);
4514 vim_free(tofree);
4515}
4516
4517/*
4518 * Return from a function. Possibly makes the return pending. Also called
4519 * for a pending return at the ":endtry" or after returning from an extra
4520 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4521 * when called due to a ":return" command. "rettv" may point to a typval_T
4522 * with the return rettv. Returns TRUE when the return can be carried out,
4523 * FALSE when the return gets pending.
4524 */
4525 int
4526do_return(
4527 exarg_T *eap,
4528 int reanimate,
4529 int is_cmd,
4530 void *rettv)
4531{
4532 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004533 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534
4535 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004536 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 current_funccal->returned = FALSE;
4538
4539 /*
4540 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4541 * not in its finally clause (which then is to be executed next) is found.
4542 * In this case, make the ":return" pending for execution at the ":endtry".
4543 * Otherwise, return normally.
4544 */
4545 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4546 if (idx >= 0)
4547 {
4548 cstack->cs_pending[idx] = CSTP_RETURN;
4549
4550 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004551 // A pending return again gets pending. "rettv" points to an
4552 // allocated variable with the rettv of the original ":return"'s
4553 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 cstack->cs_rettv[idx] = rettv;
4555 else
4556 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004557 // When undoing a return in order to make it pending, get the stored
4558 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 if (reanimate)
4560 rettv = current_funccal->rettv;
4561
4562 if (rettv != NULL)
4563 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004564 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4566 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4567 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004568 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 }
4570 else
4571 cstack->cs_rettv[idx] = NULL;
4572
4573 if (reanimate)
4574 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004575 // The pending return value could be overwritten by a ":return"
4576 // without argument in a finally clause; reset the default
4577 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578 current_funccal->rettv->v_type = VAR_NUMBER;
4579 current_funccal->rettv->vval.v_number = 0;
4580 }
4581 }
4582 report_make_pending(CSTP_RETURN, rettv);
4583 }
4584 else
4585 {
4586 current_funccal->returned = TRUE;
4587
Bram Moolenaare38eab22019-12-05 21:50:01 +01004588 // If the return is carried out now, store the return value. For
4589 // a return immediately after reanimation, the value is already
4590 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591 if (!reanimate && rettv != NULL)
4592 {
4593 clear_tv(current_funccal->rettv);
4594 *current_funccal->rettv = *(typval_T *)rettv;
4595 if (!is_cmd)
4596 vim_free(rettv);
4597 }
4598 }
4599
4600 return idx < 0;
4601}
4602
4603/*
4604 * Free the variable with a pending return value.
4605 */
4606 void
4607discard_pending_return(void *rettv)
4608{
4609 free_tv((typval_T *)rettv);
4610}
4611
4612/*
4613 * Generate a return command for producing the value of "rettv". The result
4614 * is an allocated string. Used by report_pending() for verbose messages.
4615 */
4616 char_u *
4617get_return_cmd(void *rettv)
4618{
4619 char_u *s = NULL;
4620 char_u *tofree = NULL;
4621 char_u numbuf[NUMBUFLEN];
4622
4623 if (rettv != NULL)
4624 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4625 if (s == NULL)
4626 s = (char_u *)"";
4627
4628 STRCPY(IObuff, ":return ");
4629 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4630 if (STRLEN(s) + 8 >= IOSIZE)
4631 STRCPY(IObuff + IOSIZE - 4, "...");
4632 vim_free(tofree);
4633 return vim_strsave(IObuff);
4634}
4635
4636/*
4637 * Get next function line.
4638 * Called by do_cmdline() to get the next line.
4639 * Returns allocated string, or NULL for end of function.
4640 */
4641 char_u *
4642get_func_line(
4643 int c UNUSED,
4644 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004645 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004646 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004647{
4648 funccall_T *fcp = (funccall_T *)cookie;
4649 ufunc_T *fp = fcp->func;
4650 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004651 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004652
Bram Moolenaare38eab22019-12-05 21:50:01 +01004653 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654 if (fcp->dbg_tick != debug_tick)
4655 {
4656 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004657 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 fcp->dbg_tick = debug_tick;
4659 }
4660#ifdef FEAT_PROFILE
4661 if (do_profiling == PROF_YES)
4662 func_line_end(cookie);
4663#endif
4664
4665 gap = &fp->uf_lines;
4666 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4667 || fcp->returned)
4668 retval = NULL;
4669 else
4670 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004671 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 while (fcp->linenr < gap->ga_len
4673 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4674 ++fcp->linenr;
4675 if (fcp->linenr >= gap->ga_len)
4676 retval = NULL;
4677 else
4678 {
4679 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004680 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681#ifdef FEAT_PROFILE
4682 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004683 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684#endif
4685 }
4686 }
4687
Bram Moolenaare38eab22019-12-05 21:50:01 +01004688 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004689 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004691 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004692 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004694 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004695 fcp->dbg_tick = debug_tick;
4696 }
4697
4698 return retval;
4699}
4700
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701/*
4702 * Return TRUE if the currently active function should be ended, because a
4703 * return was encountered or an error occurred. Used inside a ":while".
4704 */
4705 int
4706func_has_ended(void *cookie)
4707{
4708 funccall_T *fcp = (funccall_T *)cookie;
4709
Bram Moolenaare38eab22019-12-05 21:50:01 +01004710 // Ignore the "abort" flag if the abortion behavior has been changed due to
4711 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004712 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4713 || fcp->returned);
4714}
4715
4716/*
4717 * return TRUE if cookie indicates a function which "abort"s on errors.
4718 */
4719 int
4720func_has_abort(
4721 void *cookie)
4722{
4723 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4724}
4725
4726
4727/*
4728 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4729 * Don't do this when "Func" is already a partial that was bound
4730 * explicitly (pt_auto is FALSE).
4731 * Changes "rettv" in-place.
4732 * Returns the updated "selfdict_in".
4733 */
4734 dict_T *
4735make_partial(dict_T *selfdict_in, typval_T *rettv)
4736{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004737 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 char_u *tofree = NULL;
4739 ufunc_T *fp;
4740 char_u fname_buf[FLEN_FIXED + 1];
4741 int error;
4742 dict_T *selfdict = selfdict_in;
4743
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004744 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4745 fp = rettv->vval.v_partial->pt_func;
4746 else
4747 {
4748 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4749 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004750 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004751 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004752 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004753 vim_free(tofree);
4754 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004755
4756 if (fp != NULL && (fp->uf_flags & FC_DICT))
4757 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004758 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004759
4760 if (pt != NULL)
4761 {
4762 pt->pt_refcount = 1;
4763 pt->pt_dict = selfdict;
4764 pt->pt_auto = TRUE;
4765 selfdict = NULL;
4766 if (rettv->v_type == VAR_FUNC)
4767 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004768 // Just a function: Take over the function name and use
4769 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770 pt->pt_name = rettv->vval.v_string;
4771 }
4772 else
4773 {
4774 partial_T *ret_pt = rettv->vval.v_partial;
4775 int i;
4776
Bram Moolenaare38eab22019-12-05 21:50:01 +01004777 // Partial: copy the function name, use selfdict and copy
4778 // args. Can't take over name or args, the partial might
4779 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004780 if (ret_pt->pt_name != NULL)
4781 {
4782 pt->pt_name = vim_strsave(ret_pt->pt_name);
4783 func_ref(pt->pt_name);
4784 }
4785 else
4786 {
4787 pt->pt_func = ret_pt->pt_func;
4788 func_ptr_ref(pt->pt_func);
4789 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004790 if (ret_pt->pt_argc > 0)
4791 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004792 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004793 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004794 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 pt->pt_argc = 0;
4796 else
4797 {
4798 pt->pt_argc = ret_pt->pt_argc;
4799 for (i = 0; i < pt->pt_argc; i++)
4800 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4801 }
4802 }
4803 partial_unref(ret_pt);
4804 }
4805 rettv->v_type = VAR_PARTIAL;
4806 rettv->vval.v_partial = pt;
4807 }
4808 }
4809 return selfdict;
4810}
4811
4812/*
4813 * Return the name of the executed function.
4814 */
4815 char_u *
4816func_name(void *cookie)
4817{
4818 return ((funccall_T *)cookie)->func->uf_name;
4819}
4820
4821/*
4822 * Return the address holding the next breakpoint line for a funccall cookie.
4823 */
4824 linenr_T *
4825func_breakpoint(void *cookie)
4826{
4827 return &((funccall_T *)cookie)->breakpoint;
4828}
4829
4830/*
4831 * Return the address holding the debug tick for a funccall cookie.
4832 */
4833 int *
4834func_dbg_tick(void *cookie)
4835{
4836 return &((funccall_T *)cookie)->dbg_tick;
4837}
4838
4839/*
4840 * Return the nesting level for a funccall cookie.
4841 */
4842 int
4843func_level(void *cookie)
4844{
4845 return ((funccall_T *)cookie)->level;
4846}
4847
4848/*
4849 * Return TRUE when a function was ended by a ":return" command.
4850 */
4851 int
4852current_func_returned(void)
4853{
4854 return current_funccal->returned;
4855}
4856
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 int
4858free_unref_funccal(int copyID, int testing)
4859{
4860 int did_free = FALSE;
4861 int did_free_funccal = FALSE;
4862 funccall_T *fc, **pfc;
4863
4864 for (pfc = &previous_funccal; *pfc != NULL; )
4865 {
4866 if (can_free_funccal(*pfc, copyID))
4867 {
4868 fc = *pfc;
4869 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004870 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004871 did_free = TRUE;
4872 did_free_funccal = TRUE;
4873 }
4874 else
4875 pfc = &(*pfc)->caller;
4876 }
4877 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004878 // When a funccal was freed some more items might be garbage
4879 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880 (void)garbage_collect(testing);
4881
4882 return did_free;
4883}
4884
4885/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004886 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004887 */
4888 static funccall_T *
4889get_funccal(void)
4890{
4891 int i;
4892 funccall_T *funccal;
4893 funccall_T *temp_funccal;
4894
4895 funccal = current_funccal;
4896 if (debug_backtrace_level > 0)
4897 {
4898 for (i = 0; i < debug_backtrace_level; i++)
4899 {
4900 temp_funccal = funccal->caller;
4901 if (temp_funccal)
4902 funccal = temp_funccal;
4903 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004904 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 debug_backtrace_level = i;
4906 }
4907 }
4908 return funccal;
4909}
4910
4911/*
4912 * Return the hashtable used for local variables in the current funccal.
4913 * Return NULL if there is no current funccal.
4914 */
4915 hashtab_T *
4916get_funccal_local_ht()
4917{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004918 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 return NULL;
4920 return &get_funccal()->l_vars.dv_hashtab;
4921}
4922
4923/*
4924 * Return the l: scope variable.
4925 * Return NULL if there is no current funccal.
4926 */
4927 dictitem_T *
4928get_funccal_local_var()
4929{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004930 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 return NULL;
4932 return &get_funccal()->l_vars_var;
4933}
4934
4935/*
4936 * Return the hashtable used for argument in the current funccal.
4937 * Return NULL if there is no current funccal.
4938 */
4939 hashtab_T *
4940get_funccal_args_ht()
4941{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004942 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 return NULL;
4944 return &get_funccal()->l_avars.dv_hashtab;
4945}
4946
4947/*
4948 * Return the a: scope variable.
4949 * Return NULL if there is no current funccal.
4950 */
4951 dictitem_T *
4952get_funccal_args_var()
4953{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004954 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004956 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957}
4958
4959/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004960 * List function variables, if there is a function.
4961 */
4962 void
4963list_func_vars(int *first)
4964{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004965 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004967 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968}
4969
4970/*
4971 * If "ht" is the hashtable for local variables in the current funccal, return
4972 * the dict that contains it.
4973 * Otherwise return NULL.
4974 */
4975 dict_T *
4976get_current_funccal_dict(hashtab_T *ht)
4977{
4978 if (current_funccal != NULL
4979 && ht == &current_funccal->l_vars.dv_hashtab)
4980 return &current_funccal->l_vars;
4981 return NULL;
4982}
4983
4984/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004985 * Search hashitem in parent scope.
4986 */
4987 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004988find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004989{
4990 funccall_T *old_current_funccal = current_funccal;
4991 hashtab_T *ht;
4992 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02004993 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004994
4995 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
4996 return NULL;
4997
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004998 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004999 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005000 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005001 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005002 ht = find_var_ht(name, &varname);
5003 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005004 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005005 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005006 if (!HASHITEM_EMPTY(hi))
5007 {
5008 *pht = ht;
5009 break;
5010 }
5011 }
5012 if (current_funccal == current_funccal->func->uf_scoped)
5013 break;
5014 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005015 }
5016 current_funccal = old_current_funccal;
5017
5018 return hi;
5019}
5020
5021/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005022 * Search variable in parent scope.
5023 */
5024 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005025find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005026{
5027 dictitem_T *v = NULL;
5028 funccall_T *old_current_funccal = current_funccal;
5029 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005030 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005031
5032 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5033 return NULL;
5034
Bram Moolenaare38eab22019-12-05 21:50:01 +01005035 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005036 current_funccal = current_funccal->func->uf_scoped;
5037 while (current_funccal)
5038 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005039 ht = find_var_ht(name, &varname);
5040 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005041 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005042 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005043 if (v != NULL)
5044 break;
5045 }
5046 if (current_funccal == current_funccal->func->uf_scoped)
5047 break;
5048 current_funccal = current_funccal->func->uf_scoped;
5049 }
5050 current_funccal = old_current_funccal;
5051
5052 return v;
5053}
5054
5055/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005056 * Set "copyID + 1" in previous_funccal and callers.
5057 */
5058 int
5059set_ref_in_previous_funccal(int copyID)
5060{
5061 int abort = FALSE;
5062 funccall_T *fc;
5063
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005064 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005065 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005066 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005067 abort = abort
5068 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5069 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005070 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071 }
5072 return abort;
5073}
5074
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005075 static int
5076set_ref_in_funccal(funccall_T *fc, int copyID)
5077{
5078 int abort = FALSE;
5079
5080 if (fc->fc_copyID != copyID)
5081 {
5082 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005083 abort = abort
5084 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5085 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005086 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005087 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005088 }
5089 return abort;
5090}
5091
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005092/*
5093 * Set "copyID" in all local vars and arguments in the call stack.
5094 */
5095 int
5096set_ref_in_call_stack(int copyID)
5097{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005098 int abort = FALSE;
5099 funccall_T *fc;
5100 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005101
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005102 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005103 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005104
5105 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005106 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5107 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005108 abort = abort || set_ref_in_funccal(fc, copyID);
5109
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005110 return abort;
5111}
5112
5113/*
5114 * Set "copyID" in all functions available by name.
5115 */
5116 int
5117set_ref_in_functions(int copyID)
5118{
5119 int todo;
5120 hashitem_T *hi = NULL;
5121 int abort = FALSE;
5122 ufunc_T *fp;
5123
5124 todo = (int)func_hashtab.ht_used;
5125 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005127 if (!HASHITEM_EMPTY(hi))
5128 {
5129 --todo;
5130 fp = HI2UF(hi);
5131 if (!func_name_refcount(fp->uf_name))
5132 abort = abort || set_ref_in_func(NULL, fp, copyID);
5133 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005134 }
5135 return abort;
5136}
5137
5138/*
5139 * Set "copyID" in all function arguments.
5140 */
5141 int
5142set_ref_in_func_args(int copyID)
5143{
5144 int i;
5145 int abort = FALSE;
5146
5147 for (i = 0; i < funcargs.ga_len; ++i)
5148 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5149 copyID, NULL, NULL);
5150 return abort;
5151}
5152
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005153/*
5154 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005155 * Returns TRUE if setting references failed somehow.
5156 */
5157 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005158set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005159{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005160 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005161 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005162 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005163 char_u fname_buf[FLEN_FIXED + 1];
5164 char_u *tofree = NULL;
5165 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005166 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005167
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005168 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005169 return FALSE;
5170
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005171 if (fp_in == NULL)
5172 {
5173 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005174 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005175 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005176 if (fp != NULL)
5177 {
5178 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005179 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005180 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005181
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005182 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005183 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005184}
5185
Bram Moolenaare38eab22019-12-05 21:50:01 +01005186#endif // FEAT_EVAL