blob: 5372260d6d423ad5407d78bd290293674dbe3a9b [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
1604 proftime_T wait_start;
1605 proftime_T call_start;
Bram Moolenaarad648092018-06-30 18:28:03 +02001606 int started_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001608 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001610 // If depth of calling is getting too high, don't execute the function.
1611 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613 rettv->v_type = VAR_NUMBER;
1614 rettv->vval.v_number = -1;
1615 return;
1616 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001617
Bram Moolenaare38eab22019-12-05 21:50:01 +01001618 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001620 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001621 if (fc == NULL)
1622 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 fc->caller = current_funccal;
1624 current_funccal = fc;
1625 fc->func = fp;
1626 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001628 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1630 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001631 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001632 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001633 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001634
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001635 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001636 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001637 // Execute the function, possibly compiling it first.
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001638 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001639 funcdepth_decrement();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001640 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001641 free_funccal(fc);
1642 return;
1643 }
1644
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1646 islambda = TRUE;
1647
1648 /*
1649 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1650 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1651 * each argument variable and saves a lot of time.
1652 */
1653 /*
1654 * Init l: variables.
1655 */
1656 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1657 if (selfdict != NULL)
1658 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001659 // Set l:self to "selfdict". Use "name" to avoid a warning from
1660 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 v = &fc->fixvar[fixvar_idx++].var;
1662 name = v->di_key;
1663 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001664 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001665 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1666 v->di_tv.v_type = VAR_DICT;
1667 v->di_tv.v_lock = 0;
1668 v->di_tv.vval.v_dict = selfdict;
1669 ++selfdict->dv_refcount;
1670 }
1671
1672 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001673 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001674 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001675 * Set a:000 to a list with room for the "..." arguments.
1676 */
1677 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001678 if ((fp->uf_flags & FC_NOARGS) == 0)
1679 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001680 (varnumber_T)(argcount >= fp->uf_args.ga_len
1681 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001682 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001683 if ((fp->uf_flags & FC_NOARGS) == 0)
1684 {
1685 // Use "name" to avoid a warning from some compiler that checks the
1686 // destination size.
1687 v = &fc->fixvar[fixvar_idx++].var;
1688 name = v->di_key;
1689 STRCPY(name, "000");
1690 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1691 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1692 v->di_tv.v_type = VAR_LIST;
1693 v->di_tv.v_lock = VAR_FIXED;
1694 v->di_tv.vval.v_list = &fc->l_varlist;
1695 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001696 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1698 fc->l_varlist.lv_lock = VAR_FIXED;
1699
1700 /*
1701 * Set a:firstline to "firstline" and a:lastline to "lastline".
1702 * Set a:name to named arguments.
1703 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001704 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001705 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001706 if ((fp->uf_flags & FC_NOARGS) == 0)
1707 {
1708 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001709 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001710 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001711 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001712 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001713 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 {
1715 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001716 typval_T def_rettv;
1717 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718
1719 ai = i - fp->uf_args.ga_len;
1720 if (ai < 0)
1721 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001722 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723 name = FUNCARG(fp, i);
1724 if (islambda)
1725 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001726
1727 // evaluate named argument default expression
1728 isdefault = ai + fp->uf_def_args.ga_len >= 0
1729 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1730 && argvars[i].vval.v_number == VVAL_NONE));
1731 if (isdefault)
1732 {
1733 char_u *default_expr = NULL;
1734 def_rettv.v_type = VAR_NUMBER;
1735 def_rettv.vval.v_number = -1;
1736
1737 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1738 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001739 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001740 {
1741 default_arg_err = 1;
1742 break;
1743 }
1744 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 }
1746 else
1747 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001748 if ((fp->uf_flags & FC_NOARGS) != 0)
1749 // Bail out if no a: arguments used (in lambda).
1750 break;
1751
Bram Moolenaare38eab22019-12-05 21:50:01 +01001752 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 sprintf((char *)numbuf, "%d", ai + 1);
1754 name = numbuf;
1755 }
1756 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1757 {
1758 v = &fc->fixvar[fixvar_idx++].var;
1759 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001760 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761 }
1762 else
1763 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001764 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001765 if (v == NULL)
1766 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001767 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001770 // Note: the values are copied directly to avoid alloc/free.
1771 // "argvars" must have VAR_FIXED for v_lock.
1772 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 v->di_tv.v_lock = VAR_FIXED;
1774
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001775 if (addlocal)
1776 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001777 // Named arguments should be accessed without the "a:" prefix in
1778 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001779 copy_tv(&v->di_tv, &v->di_tv);
1780 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001782 else
1783 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784
1785 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1786 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001787 listitem_T *li = &fc->l_listitems[ai];
1788
1789 li->li_tv = argvars[i];
1790 li->li_tv.v_lock = VAR_FIXED;
1791 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001792 }
1793 }
1794
Bram Moolenaare38eab22019-12-05 21:50:01 +01001795 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001797
1798 if (fp->uf_flags & FC_SANDBOX)
1799 {
1800 using_sandbox = TRUE;
1801 ++sandbox;
1802 }
1803
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001804 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001805 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001806 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001807 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001808 ++no_wait_return;
1809 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001810
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001811 smsg(_("calling %s"), SOURCING_NAME);
1812 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001813 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001814 char_u buf[MSG_BUF_LEN];
1815 char_u numbuf2[NUMBUFLEN];
1816 char_u *tofree;
1817 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001818
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001819 msg_puts("(");
1820 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001822 if (i > 0)
1823 msg_puts(", ");
1824 if (argvars[i].v_type == VAR_NUMBER)
1825 msg_outnum((long)argvars[i].vval.v_number);
1826 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001828 // Do not want errors such as E724 here.
1829 ++emsg_off;
1830 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1831 --emsg_off;
1832 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001834 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001836 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1837 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001838 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001839 msg_puts((char *)s);
1840 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841 }
1842 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001844 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001846 msg_puts("\n"); // don't overwrite this either
1847
1848 verbose_leave_scroll();
1849 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 }
1851#ifdef FEAT_PROFILE
1852 if (do_profiling == PROF_YES)
1853 {
1854 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL))
Bram Moolenaarad648092018-06-30 18:28:03 +02001855 {
1856 started_profiling = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001857 func_do_profile(fp);
Bram Moolenaarad648092018-06-30 18:28:03 +02001858 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001859 if (fp->uf_profiling
1860 || (fc->caller != NULL && fc->caller->func->uf_profiling))
1861 {
1862 ++fp->uf_tm_count;
1863 profile_start(&call_start);
1864 profile_zero(&fp->uf_tm_children);
1865 }
1866 script_prof_save(&wait_start);
1867 }
1868#endif
1869
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001870 save_current_sctx = current_sctx;
1871 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001872 save_did_emsg = did_emsg;
1873 did_emsg = FALSE;
1874
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001875 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1876 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001877 else if (islambda)
1878 {
1879 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1880
1881 // A Lambda always has the command "return {expr}". It is much faster
1882 // to evaluate {expr} directly.
1883 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001884 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001885 --ex_nesting_level;
1886 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001887 else
1888 // call do_cmdline() to execute the lines
1889 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1891
1892 --RedrawingDisabled;
1893
Bram Moolenaare38eab22019-12-05 21:50:01 +01001894 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001895 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1896 {
1897 clear_tv(rettv);
1898 rettv->v_type = VAR_NUMBER;
1899 rettv->vval.v_number = -1;
1900 }
1901
1902#ifdef FEAT_PROFILE
1903 if (do_profiling == PROF_YES && (fp->uf_profiling
1904 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1905 {
1906 profile_end(&call_start);
1907 profile_sub_wait(&wait_start, &call_start);
1908 profile_add(&fp->uf_tm_total, &call_start);
1909 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children);
1910 if (fc->caller != NULL && fc->caller->func->uf_profiling)
1911 {
1912 profile_add(&fc->caller->func->uf_tm_children, &call_start);
1913 profile_add(&fc->caller->func->uf_tml_children, &call_start);
1914 }
Bram Moolenaarad648092018-06-30 18:28:03 +02001915 if (started_profiling)
1916 // make a ":profdel func" stop profiling the function
1917 fp->uf_profiling = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001918 }
1919#endif
1920
Bram Moolenaare38eab22019-12-05 21:50:01 +01001921 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001922 if (p_verbose >= 12)
1923 {
1924 ++no_wait_return;
1925 verbose_enter_scroll();
1926
1927 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001928 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001929 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001930 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001931 (long)fc->rettv->vval.v_number);
1932 else
1933 {
1934 char_u buf[MSG_BUF_LEN];
1935 char_u numbuf2[NUMBUFLEN];
1936 char_u *tofree;
1937 char_u *s;
1938
Bram Moolenaare38eab22019-12-05 21:50:01 +01001939 // The value may be very long. Skip the middle part, so that we
1940 // have some idea how it starts and ends. smsg() would always
1941 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001942 ++emsg_off;
1943 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1944 --emsg_off;
1945 if (s != NULL)
1946 {
1947 if (vim_strsize(s) > MSG_BUF_CLEN)
1948 {
1949 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1950 s = buf;
1951 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001952 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001953 vim_free(tofree);
1954 }
1955 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001956 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001957
1958 verbose_leave_scroll();
1959 --no_wait_return;
1960 }
1961
Bram Moolenaare31ee862020-01-07 20:59:34 +01001962 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001963 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001964 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001965#ifdef FEAT_PROFILE
1966 if (do_profiling == PROF_YES)
1967 script_prof_restore(&wait_start);
1968#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001969 if (using_sandbox)
1970 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001971
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001972 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001973 {
1974 ++no_wait_return;
1975 verbose_enter_scroll();
1976
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001977 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001978 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001979
1980 verbose_leave_scroll();
1981 --no_wait_return;
1982 }
1983
1984 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001985 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001986 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001987}
1988
1989/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001990 * Check the argument count for user function "fp".
1991 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1992 */
1993 int
1994check_user_func_argcount(ufunc_T *fp, int argcount)
1995{
1996 int regular_args = fp->uf_args.ga_len;
1997
1998 if (argcount < regular_args - fp->uf_def_args.ga_len)
1999 return FCERR_TOOFEW;
2000 else if (!has_varargs(fp) && argcount > regular_args)
2001 return FCERR_TOOMANY;
2002 return FCERR_UNKNOWN;
2003}
2004
2005/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002006 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002007 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002008 int
2009call_user_func_check(
2010 ufunc_T *fp,
2011 int argcount,
2012 typval_T *argvars,
2013 typval_T *rettv,
2014 funcexe_T *funcexe,
2015 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002016{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002017 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002018
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002019 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2020 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002021 error = check_user_func_argcount(fp, argcount);
2022 if (error != FCERR_UNKNOWN)
2023 return error;
2024 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025 error = FCERR_DICT;
2026 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002027 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002028 int did_save_redo = FALSE;
2029 save_redo_T save_redo;
2030
2031 /*
2032 * Call the user function.
2033 * Save and restore search patterns, script variables and
2034 * redo buffer.
2035 */
2036 save_search_patterns();
2037 if (!ins_compl_active())
2038 {
2039 saveRedobuff(&save_redo);
2040 did_save_redo = TRUE;
2041 }
2042 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002043 call_user_func(fp, argcount, argvars, rettv, funcexe,
2044 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002045 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2046 // Function was unreferenced while being used, free it now.
2047 func_clear_free(fp, FALSE);
2048 if (did_save_redo)
2049 restoreRedobuff(&save_redo);
2050 restore_search_patterns();
2051 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002052 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002054}
2055
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002056static funccal_entry_T *funccal_stack = NULL;
2057
2058/*
2059 * Save the current function call pointer, and set it to NULL.
2060 * Used when executing autocommands and for ":source".
2061 */
2062 void
2063save_funccal(funccal_entry_T *entry)
2064{
2065 entry->top_funccal = current_funccal;
2066 entry->next = funccal_stack;
2067 funccal_stack = entry;
2068 current_funccal = NULL;
2069}
2070
2071 void
2072restore_funccal(void)
2073{
2074 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002075 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002076 else
2077 {
2078 current_funccal = funccal_stack->top_funccal;
2079 funccal_stack = funccal_stack->next;
2080 }
2081}
2082
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002083 funccall_T *
2084get_current_funccal(void)
2085{
2086 return current_funccal;
2087}
2088
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002089/*
2090 * Mark all functions of script "sid" as deleted.
2091 */
2092 void
2093delete_script_functions(int sid)
2094{
2095 hashitem_T *hi;
2096 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002097 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002098 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002099 size_t len;
2100
2101 buf[0] = K_SPECIAL;
2102 buf[1] = KS_EXTRA;
2103 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002104 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002105 len = STRLEN(buf);
2106
Bram Moolenaarce658352020-07-31 23:47:12 +02002107 while (todo > 0)
2108 {
2109 todo = func_hashtab.ht_used;
2110 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2111 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002112 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002113 fp = HI2UF(hi);
2114 if (STRNCMP(fp->uf_name, buf, len) == 0)
2115 {
2116 int changed = func_hashtab.ht_changed;
2117
2118 fp->uf_flags |= FC_DEAD;
2119 func_clear(fp, TRUE);
2120 // When clearing a function another function can be cleared
2121 // as a side effect. When that happens start over.
2122 if (changed != func_hashtab.ht_changed)
2123 break;
2124 }
2125 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002126 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002127 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002128}
2129
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002130#if defined(EXITFREE) || defined(PROTO)
2131 void
2132free_all_functions(void)
2133{
2134 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002135 ufunc_T *fp;
2136 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002137 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002138 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002139
Bram Moolenaare38eab22019-12-05 21:50:01 +01002140 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002141 while (current_funccal != NULL)
2142 {
2143 clear_tv(current_funccal->rettv);
2144 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002145 if (current_funccal == NULL && funccal_stack != NULL)
2146 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002147 }
2148
Bram Moolenaare38eab22019-12-05 21:50:01 +01002149 // First clear what the functions contain. Since this may lower the
2150 // reference count of a function, it may also free a function and change
2151 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002152 while (todo > 0)
2153 {
2154 todo = func_hashtab.ht_used;
2155 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2156 if (!HASHITEM_EMPTY(hi))
2157 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002158 // clear the def function index now
2159 fp = HI2UF(hi);
2160 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002161 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002162
Bram Moolenaare38eab22019-12-05 21:50:01 +01002163 // Only free functions that are not refcounted, those are
2164 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002165 if (func_name_refcount(fp->uf_name))
2166 ++skipped;
2167 else
2168 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002169 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002170 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002171 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002172 {
2173 skipped = 0;
2174 break;
2175 }
2176 }
2177 --todo;
2178 }
2179 }
2180
Bram Moolenaare38eab22019-12-05 21:50:01 +01002181 // Now actually free the functions. Need to start all over every time,
2182 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002183 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002184 while (func_hashtab.ht_used > skipped)
2185 {
2186 todo = func_hashtab.ht_used;
2187 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002188 if (!HASHITEM_EMPTY(hi))
2189 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002190 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002191 // Only free functions that are not refcounted, those are
2192 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002193 fp = HI2UF(hi);
2194 if (func_name_refcount(fp->uf_name))
2195 ++skipped;
2196 else
2197 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002198 if (func_free(fp, FALSE) == OK)
2199 {
2200 skipped = 0;
2201 break;
2202 }
2203 // did not actually free it
2204 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002205 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002207 }
2208 if (skipped == 0)
2209 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002210
2211 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212}
2213#endif
2214
2215/*
2216 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002217 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002218 * "len" is the length of "name", or -1 for NUL terminated.
2219 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002220 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002221builtin_function(char_u *name, int len)
2222{
2223 char_u *p;
2224
Bram Moolenaara26b9702020-04-18 19:53:28 +02002225 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002226 return FALSE;
2227 p = vim_strchr(name, AUTOLOAD_CHAR);
2228 return p == NULL || (len > 0 && p > name + len);
2229}
2230
2231 int
2232func_call(
2233 char_u *name,
2234 typval_T *args,
2235 partial_T *partial,
2236 dict_T *selfdict,
2237 typval_T *rettv)
2238{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002239 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002240 listitem_T *item;
2241 typval_T argv[MAX_FUNC_ARGS + 1];
2242 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002243 int r = 0;
2244
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002245 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002246 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 {
2248 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2249 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002250 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002251 break;
2252 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002253 // Make a copy of each argument. This is needed to be able to set
2254 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002255 copy_tv(&item->li_tv, &argv[argc++]);
2256 }
2257
2258 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002259 {
2260 funcexe_T funcexe;
2261
Bram Moolenaara80faa82020-04-12 19:37:17 +02002262 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002263 funcexe.firstline = curwin->w_cursor.lnum;
2264 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002265 funcexe.evaluate = TRUE;
2266 funcexe.partial = partial;
2267 funcexe.selfdict = selfdict;
2268 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2269 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002270
Bram Moolenaare38eab22019-12-05 21:50:01 +01002271 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002272 while (argc > 0)
2273 clear_tv(&argv[--argc]);
2274
2275 return r;
2276}
2277
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002278static int callback_depth = 0;
2279
2280 int
2281get_callback_depth(void)
2282{
2283 return callback_depth;
2284}
2285
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002287 * Invoke call_func() with a callback.
2288 */
2289 int
2290call_callback(
2291 callback_T *callback,
2292 int len, // length of "name" or -1 to use strlen()
2293 typval_T *rettv, // return value goes here
2294 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002295 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002296 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002297{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002298 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002299 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002300
Bram Moolenaara80faa82020-04-12 19:37:17 +02002301 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002302 funcexe.evaluate = TRUE;
2303 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002304 ++callback_depth;
2305 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2306 --callback_depth;
2307 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002308}
2309
2310/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002311 * Give an error message for the result of a function.
2312 * Nothing if "error" is FCERR_NONE.
2313 */
2314 void
2315user_func_error(int error, char_u *name)
2316{
2317 switch (error)
2318 {
2319 case FCERR_UNKNOWN:
2320 emsg_funcname(e_unknownfunc, name);
2321 break;
2322 case FCERR_NOTMETHOD:
2323 emsg_funcname(
2324 N_("E276: Cannot use function as a method: %s"), name);
2325 break;
2326 case FCERR_DELETED:
2327 emsg_funcname(N_(e_func_deleted), name);
2328 break;
2329 case FCERR_TOOMANY:
2330 emsg_funcname((char *)e_toomanyarg, name);
2331 break;
2332 case FCERR_TOOFEW:
2333 emsg_funcname((char *)e_toofewarg, name);
2334 break;
2335 case FCERR_SCRIPT:
2336 emsg_funcname(
2337 N_("E120: Using <SID> not in a script context: %s"), name);
2338 break;
2339 case FCERR_DICT:
2340 emsg_funcname(
2341 N_("E725: Calling dict function without Dictionary: %s"),
2342 name);
2343 break;
2344 }
2345}
2346
2347/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002349 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350 * Return FAIL when the function can't be called, OK otherwise.
2351 * Also returns OK when an error was encountered while executing the function.
2352 */
2353 int
2354call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002355 char_u *funcname, // name of the function
2356 int len, // length of "name" or -1 to use strlen()
2357 typval_T *rettv, // return value goes here
2358 int argcount_in, // number of "argvars"
2359 typval_T *argvars_in, // vars for arguments, must have "argcount"
2360 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002361 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362{
2363 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002364 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002365 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002366 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 char_u fname_buf[FLEN_FIXED + 1];
2368 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002369 char_u *fname = NULL;
2370 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 int argcount = argcount_in;
2372 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002373 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002374 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2375 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002377 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002378 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002380 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2381 // even when call_func() returns FAIL.
2382 rettv->v_type = VAR_UNKNOWN;
2383
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002384 if (partial != NULL)
2385 fp = partial->pt_func;
2386 if (fp == NULL)
2387 {
2388 // Make a copy of the name, if it comes from a funcref variable it
2389 // could be changed or deleted in the called function.
2390 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2391 if (name == NULL)
2392 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002394 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2395 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002397 if (funcexe->doesrange != NULL)
2398 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399
2400 if (partial != NULL)
2401 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002402 // When the function has a partial with a dict and there is a dict
2403 // argument, use the dict argument. That is backwards compatible.
2404 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002405 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002407 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002408 {
2409 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002410 {
2411 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2412 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002413 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002414 goto theend;
2415 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002417 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 for (i = 0; i < argcount_in; ++i)
2419 argv[i + argv_clear] = argvars_in[i];
2420 argvars = argv;
2421 argcount = partial->pt_argc + argcount_in;
2422 }
2423 }
2424
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002425 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2426 {
2427 // Check that the argument types are OK for the types of the funcref.
2428 if (check_argument_types(funcexe->check_type, argvars, argcount,
2429 name) == FAIL)
2430 error = FCERR_OTHER;
2431 }
2432
Bram Moolenaaref140542019-12-31 21:27:13 +01002433 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 {
2435 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002436 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002437
Bram Moolenaar333894b2020-08-01 18:53:07 +02002438 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002439 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002440 {
2441 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002442 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002443 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444
Bram Moolenaare38eab22019-12-05 21:50:01 +01002445 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002447 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002449 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450 {
2451 /*
2452 * User defined function.
2453 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002454 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002455 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002456
Bram Moolenaare38eab22019-12-05 21:50:01 +01002457 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002458 if (fp == NULL
2459 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002460 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 && !aborting())
2462 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002463 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002464 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002465 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002466 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2468 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002469 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002470 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002472 if (fp == NULL)
2473 {
2474 char_u *p = untrans_function_name(rfname);
2475
2476 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002477 // Don't do this if the name starts with "s:".
2478 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002479 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002480 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002482 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002483 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002484#ifdef FEAT_LUA
2485 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2486 {
2487 cfunc_T cb = fp->uf_cb;
2488
2489 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2490 }
2491#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002492 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002493 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002494 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002495 // postponed filling in the arguments, do it now
2496 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002497 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002498
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002499 if (funcexe->basetv != NULL)
2500 {
2501 // Method call: base->Method()
2502 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2503 argv[0] = *funcexe->basetv;
2504 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002505 argvars = argv;
2506 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002507 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002508
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002509 error = call_user_func_check(fp, argcount, argvars, rettv,
2510 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002511 }
2512 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002513 else if (funcexe->basetv != NULL)
2514 {
2515 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002516 * expr->method(): Find the method name in the table, call its
2517 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002518 */
2519 error = call_internal_method(fname, argcount, argvars, rettv,
2520 funcexe->basetv);
2521 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002522 else
2523 {
2524 /*
2525 * Find the function name in the table, call its implementation.
2526 */
2527 error = call_internal_func(fname, argcount, argvars, rettv);
2528 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002529
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002530 /*
2531 * The function call (or "FuncUndefined" autocommand sequence) might
2532 * have been aborted by an error, an interrupt, or an explicitly thrown
2533 * exception that has not been caught so far. This situation can be
2534 * tested for by calling aborting(). For an error in an internal
2535 * function or for the "E132" error in call_user_func(), however, the
2536 * throw point at which the "force_abort" flag (temporarily reset by
2537 * emsg()) is normally updated has not been reached yet. We need to
2538 * update that flag first to make aborting() reliable.
2539 */
2540 update_force_abort();
2541 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002542 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 ret = OK;
2544
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002545theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546 /*
2547 * Report an error unless the argument evaluation or function call has been
2548 * cancelled due to an aborting error, an interrupt, or an exception.
2549 */
2550 if (!aborting())
2551 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002552 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002553 }
2554
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002555 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002557 clear_tv(&argv[--argv_clear + argv_base]);
2558
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 vim_free(tofree);
2560 vim_free(name);
2561
2562 return ret;
2563}
2564
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002565 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002566printable_func_name(ufunc_T *fp)
2567{
2568 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2569}
2570
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002571/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002572 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002573 */
2574 static void
2575list_func_head(ufunc_T *fp, int indent)
2576{
2577 int j;
2578
2579 msg_start();
2580 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002581 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002582 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002583 msg_puts("def ");
2584 else
2585 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002586 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002587 msg_putchar('(');
2588 for (j = 0; j < fp->uf_args.ga_len; ++j)
2589 {
2590 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002591 msg_puts(", ");
2592 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002593 if (fp->uf_arg_types != NULL)
2594 {
2595 char *tofree;
2596
2597 msg_puts(": ");
2598 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2599 vim_free(tofree);
2600 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002601 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2602 {
2603 msg_puts(" = ");
2604 msg_puts(((char **)(fp->uf_def_args.ga_data))
2605 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2606 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002607 }
2608 if (fp->uf_varargs)
2609 {
2610 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002611 msg_puts(", ");
2612 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002613 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002614 if (fp->uf_va_name != NULL)
2615 {
2616 if (j)
2617 msg_puts(", ");
2618 msg_puts("...");
2619 msg_puts((char *)fp->uf_va_name);
2620 if (fp->uf_va_type)
2621 {
2622 char *tofree;
2623
2624 msg_puts(": ");
2625 msg_puts(type_name(fp->uf_va_type, &tofree));
2626 vim_free(tofree);
2627 }
2628 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002629 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002630
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002631 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002632 {
2633 if (fp->uf_ret_type != &t_void)
2634 {
2635 char *tofree;
2636
2637 msg_puts(": ");
2638 msg_puts(type_name(fp->uf_ret_type, &tofree));
2639 vim_free(tofree);
2640 }
2641 }
2642 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002643 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002644 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002645 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002646 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002647 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002648 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002649 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650 msg_clr_eos();
2651 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002652 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653}
2654
2655/*
2656 * Get a function name, translating "<SID>" and "<SNR>".
2657 * Also handles a Funcref in a List or Dictionary.
2658 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002659 * Set "*is_global" to TRUE when the function must be global, unless
2660 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 * flags:
2662 * TFN_INT: internal function name OK
2663 * TFN_QUIET: be quiet
2664 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002665 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666 * Advances "pp" to just after the function name (if no error).
2667 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002668 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002669trans_function_name(
2670 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002671 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002672 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002674 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002675 partial_T **partial, // return: partial of a FuncRef
2676 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677{
2678 char_u *name = NULL;
2679 char_u *start;
2680 char_u *end;
2681 int lead;
2682 char_u sid_buf[20];
2683 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002684 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002686 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002687 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688
2689 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002690 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 start = *pp;
2692
Bram Moolenaare38eab22019-12-05 21:50:01 +01002693 // Check for hard coded <SNR>: already translated function ID (from a user
2694 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2696 && (*pp)[2] == (int)KE_SNR)
2697 {
2698 *pp += 3;
2699 len = get_id_len(pp) + 3;
2700 return vim_strnsave(start, len);
2701 }
2702
Bram Moolenaare38eab22019-12-05 21:50:01 +01002703 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2704 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002705 lead = eval_fname_script(start);
2706 if (lead > 2)
2707 start += lead;
2708
Bram Moolenaare38eab22019-12-05 21:50:01 +01002709 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002710 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002711 lead > 2 ? 0 : FNE_CHECK_START);
2712 if (end == start)
2713 {
2714 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002715 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002716 goto theend;
2717 }
2718 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2719 {
2720 /*
2721 * Report an invalid expression in braces, unless the expression
2722 * evaluation has been cancelled due to an aborting error, an
2723 * interrupt, or an exception.
2724 */
2725 if (!aborting())
2726 {
2727 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002728 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002729 }
2730 else
2731 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2732 goto theend;
2733 }
2734
2735 if (lv.ll_tv != NULL)
2736 {
2737 if (fdp != NULL)
2738 {
2739 fdp->fd_dict = lv.ll_dict;
2740 fdp->fd_newkey = lv.ll_newkey;
2741 lv.ll_newkey = NULL;
2742 fdp->fd_di = lv.ll_di;
2743 }
2744 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2745 {
2746 name = vim_strsave(lv.ll_tv->vval.v_string);
2747 *pp = end;
2748 }
2749 else if (lv.ll_tv->v_type == VAR_PARTIAL
2750 && lv.ll_tv->vval.v_partial != NULL)
2751 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002752 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753 *pp = end;
2754 if (partial != NULL)
2755 *partial = lv.ll_tv->vval.v_partial;
2756 }
2757 else
2758 {
2759 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2760 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002761 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 else
2763 *pp = end;
2764 name = NULL;
2765 }
2766 goto theend;
2767 }
2768
2769 if (lv.ll_name == NULL)
2770 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002771 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002772 *pp = end;
2773 goto theend;
2774 }
2775
Bram Moolenaare38eab22019-12-05 21:50:01 +01002776 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 if (lv.ll_exp_name != NULL)
2778 {
2779 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002780 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002781 flags & TFN_NO_AUTOLOAD);
2782 if (name == lv.ll_exp_name)
2783 name = NULL;
2784 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002785 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786 {
2787 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002788 name = deref_func_name(*pp, &len, partial, type,
2789 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 if (name == *pp)
2791 name = NULL;
2792 }
2793 if (name != NULL)
2794 {
2795 name = vim_strsave(name);
2796 *pp = end;
2797 if (STRNCMP(name, "<SNR>", 5) == 0)
2798 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002799 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 name[0] = K_SPECIAL;
2801 name[1] = KS_EXTRA;
2802 name[2] = (int)KE_SNR;
2803 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2804 }
2805 goto theend;
2806 }
2807
2808 if (lv.ll_exp_name != NULL)
2809 {
2810 len = (int)STRLEN(lv.ll_exp_name);
2811 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2812 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2813 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002814 // When there was "s:" already or the name expanded to get a
2815 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 lv.ll_name += 2;
2817 len -= 2;
2818 lead = 2;
2819 }
2820 }
2821 else
2822 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002823 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002825 {
2826 if (is_global != NULL && lv.ll_name[0] == 'g')
2827 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002829 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830 len = (int)(end - lv.ll_name);
2831 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002832 if (len <= 0)
2833 {
2834 if (!skip)
2835 emsg(_(e_function_name));
2836 goto theend;
2837 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002839 // In Vim9 script a user function is script-local by default, unless it
2840 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002841 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002842 if (vim9script)
2843 {
2844 char_u *p;
2845
2846 // SomeScript#func() is a global function.
2847 for (p = start; *p != NUL && *p != '('; ++p)
2848 if (*p == AUTOLOAD_CHAR)
2849 vim9script = FALSE;
2850 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002851
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 /*
2853 * Copy the function name to allocated memory.
2854 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2855 * Accept <SNR>123_name() outside a script.
2856 */
2857 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002858 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002859 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002861 if (!vim9script)
2862 lead = 3;
2863 if (vim9script || (lv.ll_exp_name != NULL
2864 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 || eval_fname_sid(*pp))
2866 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002867 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002868 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002870 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 goto theend;
2872 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002873 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002874 if (vim9script)
2875 extra = 3 + (int)STRLEN(sid_buf);
2876 else
2877 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878 }
2879 }
2880 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2881 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002882 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 start);
2884 goto theend;
2885 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002886 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 {
2888 char_u *cp = vim_strchr(lv.ll_name, ':');
2889
2890 if (cp != NULL && cp < end)
2891 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002892 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 goto theend;
2894 }
2895 }
2896
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002897 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 if (name != NULL)
2899 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002900 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 {
2902 name[0] = K_SPECIAL;
2903 name[1] = KS_EXTRA;
2904 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 STRCPY(name + 3, sid_buf);
2907 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002908 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2909 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002910 }
2911 *pp = end;
2912
2913theend:
2914 clear_lval(&lv);
2915 return name;
2916}
2917
2918/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002919 * Assuming "name" is the result of trans_function_name() and it was prefixed
2920 * to use the script-local name, return the unmodified name (points into
2921 * "name"). Otherwise return NULL.
2922 * This can be used to first search for a script-local function and fall back
2923 * to the global function if not found.
2924 */
2925 char_u *
2926untrans_function_name(char_u *name)
2927{
2928 char_u *p;
2929
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002930 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002931 {
2932 p = vim_strchr(name, '_');
2933 if (p != NULL)
2934 return p + 1;
2935 }
2936 return NULL;
2937}
2938
2939/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002940 * List functions. When "regmatch" is NULL all of then.
2941 * Otherwise functions matching "regmatch".
2942 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002943 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002944list_functions(regmatch_T *regmatch)
2945{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002946 int changed = func_hashtab.ht_changed;
2947 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002948 hashitem_T *hi;
2949
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002950 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002951 {
2952 if (!HASHITEM_EMPTY(hi))
2953 {
2954 ufunc_T *fp = HI2UF(hi);
2955
2956 --todo;
2957 if ((fp->uf_flags & FC_DEAD) == 0
2958 && (regmatch == NULL
2959 ? !message_filtered(fp->uf_name)
2960 && !func_name_refcount(fp->uf_name)
2961 : !isdigit(*fp->uf_name)
2962 && vim_regexec(regmatch, fp->uf_name, 0)))
2963 {
2964 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002965 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002966 {
2967 emsg(_("E454: function list was modified"));
2968 return;
2969 }
2970 }
2971 }
2972 }
2973}
2974
2975/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002976 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2977 * return TRUE.
2978 * Otherwise return FALSE;
2979 * Do not consider "function(" to be a command.
2980 */
2981 static int
2982is_function_cmd(char_u **cmd)
2983{
2984 char_u *p = *cmd;
2985
2986 if (checkforcmd(&p, "function", 2))
2987 {
2988 if (*p == '(')
2989 return FALSE;
2990 *cmd = p;
2991 return TRUE;
2992 }
2993 return FALSE;
2994}
2995
2996/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002997 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002998 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2999 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003000 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003002 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003003define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004{
3005 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003006 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 int j;
3008 int c;
3009 int saved_did_emsg;
3010 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003011 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003012 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013 char_u *p;
3014 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003015 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 char_u *line_arg = NULL;
3017 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003019 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 garray_T newlines;
3021 int varargs = FALSE;
3022 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003024 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003025 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 int indent;
3027 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003028#define MAX_FUNC_NESTING 50
3029 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 dictitem_T *v;
3031 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003032 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003035 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003036 linenr_T sourcing_lnum_off;
3037 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003038 int is_heredoc = FALSE;
3039 char_u *skip_until = NULL;
3040 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003041 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003042 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043
3044 /*
3045 * ":function" without argument: list functions.
3046 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003047 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003048 {
3049 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003050 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003052 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 }
3054
3055 /*
3056 * ":function /pat": list functions matching pattern.
3057 */
3058 if (*eap->arg == '/')
3059 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003060 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 if (!eap->skip)
3062 {
3063 regmatch_T regmatch;
3064
3065 c = *p;
3066 *p = NUL;
3067 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3068 *p = c;
3069 if (regmatch.regprog != NULL)
3070 {
3071 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003072 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073 vim_regfree(regmatch.regprog);
3074 }
3075 }
3076 if (*p == '/')
3077 ++p;
3078 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003079 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003080 }
3081
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003082 ga_init(&newargs);
3083 ga_init(&argtypes);
3084 ga_init(&default_args);
3085
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086 /*
3087 * Get the function name. There are these situations:
3088 * func normal function name
3089 * "name" == func, "fudi.fd_dict" == NULL
3090 * dict.func new dictionary entry
3091 * "name" == NULL, "fudi.fd_dict" set,
3092 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3093 * dict.func existing dict entry with a Funcref
3094 * "name" == func, "fudi.fd_dict" set,
3095 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3096 * dict.func existing dict entry that's not a Funcref
3097 * "name" == NULL, "fudi.fd_dict" set,
3098 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3099 * s:func script-local function name
3100 * g:func global function name, same as "func"
3101 */
3102 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003103 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003104 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003105 // nested function, argument is (args).
3106 paren = TRUE;
3107 CLEAR_FIELD(fudi);
3108 }
3109 else
3110 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003111 if (STRNCMP(p, "<lambda>", 8) == 0)
3112 {
3113 p += 8;
3114 (void)getdigits(&p);
3115 name = vim_strnsave(eap->arg, p - eap->arg);
3116 CLEAR_FIELD(fudi);
3117 }
3118 else
3119 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003120 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003121 paren = (vim_strchr(p, '(') != NULL);
3122 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003123 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003124 /*
3125 * Return on an invalid expression in braces, unless the expression
3126 * evaluation has been cancelled due to an aborting error, an
3127 * interrupt, or an exception.
3128 */
3129 if (!aborting())
3130 {
3131 if (!eap->skip && fudi.fd_newkey != NULL)
3132 semsg(_(e_dictkey), fudi.fd_newkey);
3133 vim_free(fudi.fd_newkey);
3134 return NULL;
3135 }
3136 else
3137 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003139 }
3140
Bram Moolenaare38eab22019-12-05 21:50:01 +01003141 // An error in a function call during evaluation of an expression in magic
3142 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 saved_did_emsg = did_emsg;
3144 did_emsg = FALSE;
3145
3146 /*
3147 * ":function func" with only function name: list function.
3148 */
3149 if (!paren)
3150 {
3151 if (!ends_excmd(*skipwhite(p)))
3152 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003153 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003154 goto ret_free;
3155 }
3156 eap->nextcmd = check_nextcmd(p);
3157 if (eap->nextcmd != NULL)
3158 *p = NUL;
3159 if (!eap->skip && !got_int)
3160 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003161 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003162 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3163 {
3164 char_u *up = untrans_function_name(name);
3165
3166 // With Vim9 script the name was made script-local, if not
3167 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003168 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003169 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003170 }
3171
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003172 if (fp != NULL)
3173 {
3174 list_func_head(fp, TRUE);
3175 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3176 {
3177 if (FUNCLINE(fp, j) == NULL)
3178 continue;
3179 msg_putchar('\n');
3180 msg_outnum((long)(j + 1));
3181 if (j < 9)
3182 msg_putchar(' ');
3183 if (j < 99)
3184 msg_putchar(' ');
3185 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003186 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003187 ui_breakcheck();
3188 }
3189 if (!got_int)
3190 {
3191 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003192 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003193 msg_puts(" enddef");
3194 else
3195 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003196 }
3197 }
3198 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003199 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 }
3201 goto ret_free;
3202 }
3203
3204 /*
3205 * ":function name(arg1, arg2)" Define function.
3206 */
3207 p = skipwhite(p);
3208 if (*p != '(')
3209 {
3210 if (!eap->skip)
3211 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003212 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 goto ret_free;
3214 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003215 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003216 if (vim_strchr(p, '(') != NULL)
3217 p = vim_strchr(p, '(');
3218 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003220 // In Vim9 script only global functions can be redefined.
3221 if (vim9script && eap->forceit && !is_global)
3222 {
3223 emsg(_(e_nobang));
3224 goto ret_free;
3225 }
3226
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3228
Bram Moolenaar04b12692020-05-04 23:24:44 +02003229 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003231 // Check the name of the function. Unless it's a dictionary function
3232 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233 if (name != NULL)
3234 arg = name;
3235 else
3236 arg = fudi.fd_newkey;
3237 if (arg != NULL && (fudi.fd_di == NULL
3238 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3239 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3240 {
3241 if (*arg == K_SPECIAL)
3242 j = 3;
3243 else
3244 j = 0;
3245 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3246 : eval_isnamec(arg[j])))
3247 ++j;
3248 if (arg[j] != NUL)
3249 emsg_funcname((char *)e_invarg2, arg);
3250 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003251 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003253 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254 }
3255
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003256 // This may get more lines and make the pointers into the first line
3257 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003258 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003259 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003260 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003261 &varargs, &default_args, eap->skip,
3262 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003264 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 // find the return type: :def Func(): type
3269 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003271 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003272 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003274 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003275 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003276 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003277 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003278 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003279 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003280 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003281 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003282 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003283 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003285 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287 else
3288 // find extra arguments "range", "dict", "abort" and "closure"
3289 for (;;)
3290 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003291 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003292 p = skipwhite(p);
3293 if (STRNCMP(p, "range", 5) == 0)
3294 {
3295 flags |= FC_RANGE;
3296 p += 5;
3297 }
3298 else if (STRNCMP(p, "dict", 4) == 0)
3299 {
3300 flags |= FC_DICT;
3301 p += 4;
3302 }
3303 else if (STRNCMP(p, "abort", 5) == 0)
3304 {
3305 flags |= FC_ABORT;
3306 p += 5;
3307 }
3308 else if (STRNCMP(p, "closure", 7) == 0)
3309 {
3310 flags |= FC_CLOSURE;
3311 p += 7;
3312 if (current_funccal == NULL)
3313 {
3314 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3315 name == NULL ? (char_u *)"" : name);
3316 goto erret;
3317 }
3318 }
3319 else
3320 break;
3321 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003322
Bram Moolenaare38eab22019-12-05 21:50:01 +01003323 // When there is a line break use what follows for the function body.
3324 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325 if (*p == '\n')
3326 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003327 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003328 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3329 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003330 && !(VIM_ISWHITE(*whitep) && *p == '#'
3331 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003332 && !eap->skip
3333 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003334 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335
3336 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003337 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3338 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 */
3340 if (KeyTyped)
3341 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003342 // Check if the function already exists, don't let the user type the
3343 // whole function before telling him it doesn't work! For a script we
3344 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003345 if (!eap->skip && !eap->forceit)
3346 {
3347 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003348 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003349 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 emsg_funcname(e_funcexts, name);
3351 }
3352
3353 if (!eap->skip && did_emsg)
3354 goto erret;
3355
Bram Moolenaare38eab22019-12-05 21:50:01 +01003356 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 cmdline_row = msg_row;
3358 }
3359
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003360 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003361 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003362
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003363 // Detect having skipped over comment lines to find the return
3364 // type. Add NULL lines to keep the line count correct.
3365 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3366 if (SOURCING_LNUM < sourcing_lnum_off)
3367 {
3368 sourcing_lnum_off -= SOURCING_LNUM;
3369 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3370 goto erret;
3371 while (sourcing_lnum_off-- > 0)
3372 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3373 }
3374
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003375 indent = 2;
3376 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003377 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003378 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003379 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 for (;;)
3381 {
3382 if (KeyTyped)
3383 {
3384 msg_scroll = TRUE;
3385 saved_wait_return = FALSE;
3386 }
3387 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388
3389 if (line_arg != NULL)
3390 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003391 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 theline = line_arg;
3393 p = vim_strchr(theline, '\n');
3394 if (p == NULL)
3395 line_arg += STRLEN(line_arg);
3396 else
3397 {
3398 *p = NUL;
3399 line_arg = p + 1;
3400 }
3401 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003402 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003403 {
3404 vim_free(line_to_free);
3405 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003406 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003407 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003408 theline = eap->getline(':', eap->cookie, indent,
3409 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003410 line_to_free = theline;
3411 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412 if (KeyTyped)
3413 lines_left = Rows - 1;
3414 if (theline == NULL)
3415 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003416 // Use the start of the function for the line number.
3417 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003418 if (skip_until != NULL)
3419 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3420 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003421 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003422 else
3423 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 goto erret;
3425 }
3426
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003427 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003428 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003429 if (SOURCING_LNUM < sourcing_lnum_off)
3430 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 else
3432 sourcing_lnum_off = 0;
3433
3434 if (skip_until != NULL)
3435 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003436 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003437 // * ":append" and "."
3438 // * ":python <<EOF" and "EOF"
3439 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3440 if (heredoc_trimmed == NULL
3441 || (is_heredoc && skipwhite(theline) == theline)
3442 || STRNCMP(theline, heredoc_trimmed,
3443 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003444 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003445 if (heredoc_trimmed == NULL)
3446 p = theline;
3447 else if (is_heredoc)
3448 p = skipwhite(theline) == theline
3449 ? theline : theline + STRLEN(heredoc_trimmed);
3450 else
3451 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003452 if (STRCMP(p, skip_until) == 0)
3453 {
3454 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003455 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003456 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003457 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003458 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003459 }
3460 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003461 }
3462 else
3463 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003464 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003465 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 ;
3467
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003468 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003469 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003471 ? "enddef" : "endfunction", 4)
3472 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003473 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003474 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003475 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003476 char_u *nextcmd = NULL;
3477
3478 if (*p == '|')
3479 nextcmd = p + 1;
3480 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3481 nextcmd = line_arg;
3482 else if (*p != NUL && *p != '"' && p_verbose > 0)
3483 give_warning2(eap->cmdidx == CMD_def
3484 ? (char_u *)_("W1001: Text found after :enddef: %s")
3485 : (char_u *)_("W22: Text found after :endfunction: %s"),
3486 p, TRUE);
3487 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003488 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003489 // Another command follows. If the line came from "eap"
3490 // we can simply point into it, otherwise we need to
3491 // change "eap->cmdlinep".
3492 eap->nextcmd = nextcmd;
3493 if (line_to_free != NULL)
3494 {
3495 vim_free(*eap->cmdlinep);
3496 *eap->cmdlinep = line_to_free;
3497 line_to_free = NULL;
3498 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003499 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003500 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003501 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 }
3503
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003504 // Check for mismatched "endfunc" or "enddef".
3505 // We don't check for "def" inside "func" thus we also can't check
3506 // for "enddef".
3507 // We continue to find the end of the function, although we might
3508 // not find it.
3509 else if (nesting_def[nesting])
3510 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003511 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003512 emsg(_(e_mismatched_endfunction));
3513 }
3514 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3515 emsg(_(e_mismatched_enddef));
3516
Bram Moolenaare38eab22019-12-05 21:50:01 +01003517 // Increase indent inside "if", "while", "for" and "try", decrease
3518 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003519 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003520 indent -= 2;
3521 else if (STRNCMP(p, "if", 2) == 0
3522 || STRNCMP(p, "wh", 2) == 0
3523 || STRNCMP(p, "for", 3) == 0
3524 || STRNCMP(p, "try", 3) == 0)
3525 indent += 2;
3526
Bram Moolenaare38eab22019-12-05 21:50:01 +01003527 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003528 // Only recognize "def" inside "def", not inside "function",
3529 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003530 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003531 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003532 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 {
3534 if (*p == '!')
3535 p = skipwhite(p + 1);
3536 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003537 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3538 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 if (*skipwhite(p) == '(')
3540 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003541 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003542 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003543 else
3544 {
3545 ++nesting;
3546 nesting_def[nesting] = (c == 'd');
3547 indent += 2;
3548 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 }
3550 }
3551
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003552 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003553 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003554 if (eap->cmdidx != CMD_def
3555 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003556 || (p[0] == 'c'
3557 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3558 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3559 && (STRNCMP(&p[3], "nge", 3) != 0
3560 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 || (p[0] == 'i'
3562 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003563 && (!ASCII_ISALPHA(p[2])
3564 || (p[2] == 's'
3565 && (!ASCII_ISALPHA(p[3])
3566 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567 skip_until = vim_strsave((char_u *)".");
3568
Bram Moolenaare38eab22019-12-05 21:50:01 +01003569 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 arg = skipwhite(skiptowhite(p));
3571 if (arg[0] == '<' && arg[1] =='<'
3572 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003573 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3574 || ((p[2] == '3' || p[2] == 'x')
3575 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 || (p[0] == 'p' && p[1] == 'e'
3577 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3578 || (p[0] == 't' && p[1] == 'c'
3579 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3580 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3581 && !ASCII_ISALPHA(p[3]))
3582 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3583 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3584 || (p[0] == 'm' && p[1] == 'z'
3585 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3586 ))
3587 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003588 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003590 if (STRNCMP(p, "trim", 4) == 0)
3591 {
3592 // Ignore leading white space.
3593 p = skipwhite(p + 4);
3594 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003595 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003596 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 if (*p == NUL)
3598 skip_until = vim_strsave((char_u *)".");
3599 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003600 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003601 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003602 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003604
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003605 // Check for ":cmd v =<< [trim] EOF"
3606 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003607 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003608 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003609 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003610 if (*arg == '[')
3611 arg = vim_strchr(arg, ']');
3612 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003613 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003614 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3615 && arg[1] == '<' && arg[2] =='<');
3616
3617 if (!found)
3618 // skip over the argument after "cmd"
3619 arg = skipwhite(skiptowhite(arg));
3620 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003621 && (checkforcmd(&p, "let", 2)
3622 || checkforcmd(&p, "var", 3)
3623 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003624 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003625 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003626 p = skipwhite(arg + 3);
3627 if (STRNCMP(p, "trim", 4) == 0)
3628 {
3629 // Ignore leading white space.
3630 p = skipwhite(p + 4);
3631 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003632 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003633 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003634 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003635 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003636 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003637 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003638 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639 }
3640
Bram Moolenaare38eab22019-12-05 21:50:01 +01003641 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644
Bram Moolenaare38eab22019-12-05 21:50:01 +01003645 // Copy the line to newly allocated memory. get_one_sourceline()
3646 // allocates 250 bytes per line, this saves 80% on average. The cost
3647 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003649 if (p == NULL)
3650 goto erret;
3651 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003652
Bram Moolenaare38eab22019-12-05 21:50:01 +01003653 // Add NULL lines for continuation lines, so that the line count is
3654 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 while (sourcing_lnum_off-- > 0)
3656 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3657
Bram Moolenaare38eab22019-12-05 21:50:01 +01003658 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 if (line_arg != NULL && *line_arg == NUL)
3660 line_arg = NULL;
3661 }
3662
Bram Moolenaare38eab22019-12-05 21:50:01 +01003663 // Don't define the function when skipping commands or when an error was
3664 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 if (eap->skip || did_emsg)
3666 goto erret;
3667
3668 /*
3669 * If there are no errors, add the function
3670 */
3671 if (fudi.fd_dict == NULL)
3672 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003673 hashtab_T *ht;
3674
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003675 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3677 {
3678 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3679 name);
3680 goto erret;
3681 }
3682
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003683 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003684 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003686 char_u *uname = untrans_function_name(name);
3687
3688 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3689 }
3690
3691 if (fp != NULL || import != NULL)
3692 {
3693 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003694
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003695 // Function can be replaced with "function!" and when sourcing the
3696 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003697 // A name that is used by an import can not be overruled.
3698 if (import != NULL
3699 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003700 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003701 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003703 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003704 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003705 else
3706 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 goto erret;
3708 }
3709 if (fp->uf_calls > 0)
3710 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003711 emsg_funcname(
3712 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003713 name);
3714 goto erret;
3715 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003716 if (fp->uf_refcount > 1)
3717 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003718 // This function is referenced somewhere, don't redefine it but
3719 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003720 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003721 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003722 fp = NULL;
3723 overwrite = TRUE;
3724 }
3725 else
3726 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003727 char_u *exp_name = fp->uf_name_exp;
3728
3729 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003730 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003731 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003732 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003733 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003734 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003735#ifdef FEAT_PROFILE
3736 fp->uf_profiling = FALSE;
3737 fp->uf_prof_initialized = FALSE;
3738#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003739 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003740 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 }
3742 }
3743 else
3744 {
3745 char numbuf[20];
3746
3747 fp = NULL;
3748 if (fudi.fd_newkey == NULL && !eap->forceit)
3749 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003750 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 goto erret;
3752 }
3753 if (fudi.fd_di == NULL)
3754 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003756 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 goto erret;
3758 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003759 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003760 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 goto erret;
3762
Bram Moolenaare38eab22019-12-05 21:50:01 +01003763 // Give the function a sequential number. Can only be used with a
3764 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 vim_free(name);
3766 sprintf(numbuf, "%d", ++func_nr);
3767 name = vim_strsave((char_u *)numbuf);
3768 if (name == NULL)
3769 goto erret;
3770 }
3771
3772 if (fp == NULL)
3773 {
3774 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3775 {
3776 int slen, plen;
3777 char_u *scriptname;
3778
Bram Moolenaare38eab22019-12-05 21:50:01 +01003779 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003781 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 {
3783 scriptname = autoload_name(name);
3784 if (scriptname != NULL)
3785 {
3786 p = vim_strchr(scriptname, '/');
3787 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003788 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003789 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003790 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 j = OK;
3792 vim_free(scriptname);
3793 }
3794 }
3795 if (j == FAIL)
3796 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003797 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 goto erret;
3799 }
3800 }
3801
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003802 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 if (fp == NULL)
3804 goto erret;
3805
3806 if (fudi.fd_dict != NULL)
3807 {
3808 if (fudi.fd_di == NULL)
3809 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003810 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3812 if (fudi.fd_di == NULL)
3813 {
3814 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003815 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 goto erret;
3817 }
3818 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3819 {
3820 vim_free(fudi.fd_di);
3821 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003822 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 goto erret;
3824 }
3825 }
3826 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003827 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828 clear_tv(&fudi.fd_di->di_tv);
3829 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831
Bram Moolenaare38eab22019-12-05 21:50:01 +01003832 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 flags |= FC_DICT;
3834 }
3835
Bram Moolenaare38eab22019-12-05 21:50:01 +01003836 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003837 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003838 if (overwrite)
3839 {
3840 hi = hash_find(&func_hashtab, name);
3841 hi->hi_key = UF2HIKEY(fp);
3842 }
3843 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 {
3845 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003846 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 goto erret;
3848 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003849 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850 }
3851 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003852 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003853 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003854 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003855
3856 if (eap->cmdidx == CMD_def)
3857 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003858 int lnum_save = SOURCING_LNUM;
3859 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003860
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003861 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003862
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003863 // error messages are for the first function line
3864 SOURCING_LNUM = sourcing_lnum_top;
3865
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003866 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003867 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003868 int count = cstack->cs_idx + 1;
3869 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003870
3871 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003872 // a block that is visible now but not when the function is called
3873 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003874 fp->uf_block_ids = ALLOC_MULT(int, count);
3875 if (fp->uf_block_ids != NULL)
3876 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003877 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003878 sizeof(int) * count);
3879 fp->uf_block_depth = count;
3880 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003881
3882 // Set flag in each block to indicate a function was defined. This
3883 // is used to keep the variable when leaving the block, see
3884 // hide_script_var().
3885 for (i = 0; i <= cstack->cs_idx; ++i)
3886 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003887 }
3888
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003889 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003890 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003891 SOURCING_LNUM = lnum_save;
3892 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003893 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003894 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003895
3896 // parse the return type, if any
3897 if (ret_type == NULL)
3898 fp->uf_ret_type = &t_void;
3899 else
3900 {
3901 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003902 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003903 if (fp->uf_ret_type == NULL)
3904 {
3905 fp->uf_ret_type = &t_void;
3906 SOURCING_LNUM = lnum_save;
3907 goto erret;
3908 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003909 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003910 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003911 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003912 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003913 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003914
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003916 if ((flags & FC_CLOSURE) != 0)
3917 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003918 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003919 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003920 }
3921 else
3922 fp->uf_scoped = NULL;
3923
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003924#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 if (prof_def_func())
3926 func_do_profile(fp);
3927#endif
3928 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003929 if (sandbox)
3930 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003931 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003932 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 fp->uf_flags = flags;
3934 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003935 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003936 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003937 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003938 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003939 if (is_export)
3940 {
3941 fp->uf_flags |= FC_EXPORT;
3942 // let ex_export() know the export worked.
3943 is_export = FALSE;
3944 }
3945
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003946 if (eap->cmdidx == CMD_def)
3947 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003948 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3949 // :func does not use Vim9 script syntax, even in a Vim9 script file
3950 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003951
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 goto ret_free;
3953
3954erret:
3955 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003956 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957errret_2:
3958 ga_clear_strings(&newlines);
3959ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003960 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003961 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003962 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003963 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003965 if (name != name_arg)
3966 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003967 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 did_emsg |= saved_did_emsg;
3969 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003970
3971 return fp;
3972}
3973
3974/*
3975 * ":function"
3976 */
3977 void
3978ex_function(exarg_T *eap)
3979{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003980 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003981}
3982
3983/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003984 * :defcompile - compile all :def functions in the current script that need to
3985 * be compiled. Except dead functions.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003986 */
3987 void
3988ex_defcompile(exarg_T *eap UNUSED)
3989{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003990 long todo = (long)func_hashtab.ht_used;
3991 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003992 hashitem_T *hi;
3993 ufunc_T *ufunc;
3994
3995 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3996 {
3997 if (!HASHITEM_EMPTY(hi))
3998 {
3999 --todo;
4000 ufunc = HI2UF(hi);
4001 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004002 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4003 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004004 {
Bram Moolenaar822ba242020-05-24 23:00:18 +02004005 compile_def_function(ufunc, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004006
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004007 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004008 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004009 // a function has been added or removed, need to start over
4010 todo = (long)func_hashtab.ht_used;
4011 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004012 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004013 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004014 }
4015 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004016 }
4017 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004018}
4019
4020/*
4021 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4022 * Return 2 if "p" starts with "s:".
4023 * Return 0 otherwise.
4024 */
4025 int
4026eval_fname_script(char_u *p)
4027{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004028 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4029 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4031 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4032 return 5;
4033 if (p[0] == 's' && p[1] == ':')
4034 return 2;
4035 return 0;
4036}
4037
4038 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004039translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040{
4041 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004042 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004043 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004044}
4045
4046/*
4047 * Return TRUE when "ufunc" has old-style "..." varargs
4048 * or named varargs "...name: type".
4049 */
4050 int
4051has_varargs(ufunc_T *ufunc)
4052{
4053 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004054}
4055
4056/*
4057 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004058 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 */
4060 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004061function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062{
4063 char_u *nm = name;
4064 char_u *p;
4065 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004066 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004067 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004069 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4070 if (no_deref)
4071 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004072 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 nm = skipwhite(nm);
4074
Bram Moolenaare38eab22019-12-05 21:50:01 +01004075 // Only accept "funcname", "funcname ", "funcname (..." and
4076 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004078 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 vim_free(p);
4080 return n;
4081}
4082
Bram Moolenaar113e1072019-01-20 15:30:40 +01004083#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 char_u *
4085get_expanded_name(char_u *name, int check)
4086{
4087 char_u *nm = name;
4088 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004089 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004091 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004092 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004094 if (p != NULL && *nm == NUL
4095 && (!check || translated_function_exists(p, is_global)))
4096 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097
4098 vim_free(p);
4099 return NULL;
4100}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004101#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004102
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103/*
4104 * Function given to ExpandGeneric() to obtain the list of user defined
4105 * function names.
4106 */
4107 char_u *
4108get_user_func_name(expand_T *xp, int idx)
4109{
4110 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004111 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004112 static hashitem_T *hi;
4113 ufunc_T *fp;
4114
4115 if (idx == 0)
4116 {
4117 done = 0;
4118 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004119 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004120 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004121 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004122 {
4123 if (done++ > 0)
4124 ++hi;
4125 while (HASHITEM_EMPTY(hi))
4126 ++hi;
4127 fp = HI2UF(hi);
4128
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004129 // don't show dead, dict and lambda functions
4130 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004131 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004133
4134 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004135 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136
4137 cat_func_name(IObuff, fp);
4138 if (xp->xp_context != EXPAND_USER_FUNC)
4139 {
4140 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004141 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004142 STRCAT(IObuff, ")");
4143 }
4144 return IObuff;
4145 }
4146 return NULL;
4147}
4148
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004149/*
4150 * ":delfunction {name}"
4151 */
4152 void
4153ex_delfunction(exarg_T *eap)
4154{
4155 ufunc_T *fp = NULL;
4156 char_u *p;
4157 char_u *name;
4158 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004159 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160
4161 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004162 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4163 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004164 vim_free(fudi.fd_newkey);
4165 if (name == NULL)
4166 {
4167 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004168 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 return;
4170 }
4171 if (!ends_excmd(*skipwhite(p)))
4172 {
4173 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004174 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175 return;
4176 }
4177 eap->nextcmd = check_nextcmd(p);
4178 if (eap->nextcmd != NULL)
4179 *p = NUL;
4180
4181 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004182 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183 vim_free(name);
4184
4185 if (!eap->skip)
4186 {
4187 if (fp == NULL)
4188 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004189 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004190 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191 return;
4192 }
4193 if (fp->uf_calls > 0)
4194 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004195 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004196 return;
4197 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004198 if (fp->uf_flags & FC_VIM9)
4199 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004200 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004201 return;
4202 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004203
4204 if (fudi.fd_dict != NULL)
4205 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004206 // Delete the dict item that refers to the function, it will
4207 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004208 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4209 }
4210 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004211 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004212 // A normal function (not a numbered function or lambda) has a
4213 // refcount of 1 for the entry in the hashtable. When deleting
4214 // it and the refcount is more than one, it should be kept.
4215 // A numbered function and lambda should be kept if the refcount is
4216 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004217 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004218 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004219 // Function is still referenced somewhere. Don't free it but
4220 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004221 if (func_remove(fp))
4222 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004223 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004224 }
4225 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004226 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004227 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004228 }
4229}
4230
4231/*
4232 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004233 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234 */
4235 void
4236func_unref(char_u *name)
4237{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004238 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004240 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004242 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004243 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004244 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004246 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004247#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004248 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004249 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004250 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004251}
4252
4253/*
4254 * Unreference a Function: decrement the reference count and free it when it
4255 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004256 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004257 */
4258 void
4259func_ptr_unref(ufunc_T *fp)
4260{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004261 if (fp != NULL && (--fp->uf_refcount <= 0
4262 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4263 && fp->uf_partial->pt_refcount <= 1
4264 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004265 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004266 // Only delete it when it's not being used. Otherwise it's done
4267 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004268 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004269 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 }
4271}
4272
4273/*
4274 * Count a reference to a Function.
4275 */
4276 void
4277func_ref(char_u *name)
4278{
4279 ufunc_T *fp;
4280
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004281 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004283 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004284 if (fp != NULL)
4285 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004287 // Only give an error for a numbered function.
4288 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004289 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004290}
4291
4292/*
4293 * Count a reference to a Function.
4294 */
4295 void
4296func_ptr_ref(ufunc_T *fp)
4297{
4298 if (fp != NULL)
4299 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004300}
4301
4302/*
4303 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4304 * referenced from anywhere that is in use.
4305 */
4306 static int
4307can_free_funccal(funccall_T *fc, int copyID)
4308{
4309 return (fc->l_varlist.lv_copyID != copyID
4310 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004311 && fc->l_avars.dv_copyID != copyID
4312 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004313}
4314
4315/*
4316 * ":return [expr]"
4317 */
4318 void
4319ex_return(exarg_T *eap)
4320{
4321 char_u *arg = eap->arg;
4322 typval_T rettv;
4323 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004324 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325
4326 if (current_funccal == NULL)
4327 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004328 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 return;
4330 }
4331
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004332 CLEAR_FIELD(evalarg);
4333 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4334
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 if (eap->skip)
4336 ++emsg_skip;
4337
4338 eap->nextcmd = NULL;
4339 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004340 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004341 {
4342 if (!eap->skip)
4343 returning = do_return(eap, FALSE, TRUE, &rettv);
4344 else
4345 clear_tv(&rettv);
4346 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004347 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004348 else if (!eap->skip)
4349 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004350 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004351 update_force_abort();
4352
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353 /*
4354 * Return unless the expression evaluation has been cancelled due to an
4355 * aborting error, an interrupt, or an exception.
4356 */
4357 if (!aborting())
4358 returning = do_return(eap, FALSE, TRUE, NULL);
4359 }
4360
Bram Moolenaare38eab22019-12-05 21:50:01 +01004361 // When skipping or the return gets pending, advance to the next command
4362 // in this line (!returning). Otherwise, ignore the rest of the line.
4363 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004364 if (returning)
4365 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004366 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 eap->nextcmd = check_nextcmd(arg);
4368
4369 if (eap->skip)
4370 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004371 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372}
4373
4374/*
4375 * ":1,25call func(arg1, arg2)" function call.
4376 */
4377 void
4378ex_call(exarg_T *eap)
4379{
4380 char_u *arg = eap->arg;
4381 char_u *startarg;
4382 char_u *name;
4383 char_u *tofree;
4384 int len;
4385 typval_T rettv;
4386 linenr_T lnum;
4387 int doesrange;
4388 int failed = FALSE;
4389 funcdict_T fudi;
4390 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004391 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004392 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393
Bram Moolenaare6b53242020-07-01 17:28:33 +02004394 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004395 if (eap->skip)
4396 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004397 // trans_function_name() doesn't work well when skipping, use eval0()
4398 // instead to skip to any following command, e.g. for:
4399 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004401 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 clear_tv(&rettv);
4403 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004404 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 return;
4406 }
4407
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004408 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4409 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 if (fudi.fd_newkey != NULL)
4411 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004412 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004413 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004414 vim_free(fudi.fd_newkey);
4415 }
4416 if (tofree == NULL)
4417 return;
4418
Bram Moolenaare38eab22019-12-05 21:50:01 +01004419 // Increase refcount on dictionary, it could get deleted when evaluating
4420 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 if (fudi.fd_dict != NULL)
4422 ++fudi.fd_dict->dv_refcount;
4423
Bram Moolenaare38eab22019-12-05 21:50:01 +01004424 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4425 // contents. For VAR_PARTIAL get its partial, unless we already have one
4426 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004428 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4429 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004430
Bram Moolenaare38eab22019-12-05 21:50:01 +01004431 // Skip white space to allow ":call func ()". Not good, but required for
4432 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004434 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004435
4436 if (*startarg != '(')
4437 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004438 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 goto end;
4440 }
4441
4442 /*
4443 * When skipping, evaluate the function once, to find the end of the
4444 * arguments.
4445 * When the function takes a range, this is discovered after the first
4446 * call, and the loop is broken.
4447 */
4448 if (eap->skip)
4449 {
4450 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004451 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 }
4453 else
4454 lnum = eap->line1;
4455 for ( ; lnum <= eap->line2; ++lnum)
4456 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004457 funcexe_T funcexe;
4458
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 if (!eap->skip && eap->addr_count > 0)
4460 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004461 if (lnum > curbuf->b_ml.ml_line_count)
4462 {
4463 // If the function deleted lines or switched to another buffer
4464 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004465 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004466 break;
4467 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 curwin->w_cursor.lnum = lnum;
4469 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471 }
4472 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004473
Bram Moolenaara80faa82020-04-12 19:37:17 +02004474 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004475 funcexe.firstline = eap->line1;
4476 funcexe.lastline = eap->line2;
4477 funcexe.doesrange = &doesrange;
4478 funcexe.evaluate = !eap->skip;
4479 funcexe.partial = partial;
4480 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004481 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004482 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 {
4484 failed = TRUE;
4485 break;
4486 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004487 if (has_watchexpr())
4488 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004490 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004491 if (handle_subscript(&arg, &rettv,
4492 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493 {
4494 failed = TRUE;
4495 break;
4496 }
4497
4498 clear_tv(&rettv);
4499 if (doesrange || eap->skip)
4500 break;
4501
Bram Moolenaare38eab22019-12-05 21:50:01 +01004502 // Stop when immediately aborting on error, or when an interrupt
4503 // occurred or an exception was thrown but not caught.
4504 // get_func_tv() returned OK, so that the check for trailing
4505 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 if (aborting())
4507 break;
4508 }
4509 if (eap->skip)
4510 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004511 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004512
Bram Moolenaare51bb172020-02-16 19:42:23 +01004513 // When inside :try we need to check for following "| catch".
4514 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004516 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004517 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004518 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004520 if (!failed)
4521 {
4522 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004523 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004524 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 }
4526 else
4527 eap->nextcmd = check_nextcmd(arg);
4528 }
4529
4530end:
4531 dict_unref(fudi.fd_dict);
4532 vim_free(tofree);
4533}
4534
4535/*
4536 * Return from a function. Possibly makes the return pending. Also called
4537 * for a pending return at the ":endtry" or after returning from an extra
4538 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4539 * when called due to a ":return" command. "rettv" may point to a typval_T
4540 * with the return rettv. Returns TRUE when the return can be carried out,
4541 * FALSE when the return gets pending.
4542 */
4543 int
4544do_return(
4545 exarg_T *eap,
4546 int reanimate,
4547 int is_cmd,
4548 void *rettv)
4549{
4550 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004551 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552
4553 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004554 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555 current_funccal->returned = FALSE;
4556
4557 /*
4558 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4559 * not in its finally clause (which then is to be executed next) is found.
4560 * In this case, make the ":return" pending for execution at the ":endtry".
4561 * Otherwise, return normally.
4562 */
4563 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4564 if (idx >= 0)
4565 {
4566 cstack->cs_pending[idx] = CSTP_RETURN;
4567
4568 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004569 // A pending return again gets pending. "rettv" points to an
4570 // allocated variable with the rettv of the original ":return"'s
4571 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 cstack->cs_rettv[idx] = rettv;
4573 else
4574 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004575 // When undoing a return in order to make it pending, get the stored
4576 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 if (reanimate)
4578 rettv = current_funccal->rettv;
4579
4580 if (rettv != NULL)
4581 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004582 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4584 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4585 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004586 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 }
4588 else
4589 cstack->cs_rettv[idx] = NULL;
4590
4591 if (reanimate)
4592 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004593 // The pending return value could be overwritten by a ":return"
4594 // without argument in a finally clause; reset the default
4595 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 current_funccal->rettv->v_type = VAR_NUMBER;
4597 current_funccal->rettv->vval.v_number = 0;
4598 }
4599 }
4600 report_make_pending(CSTP_RETURN, rettv);
4601 }
4602 else
4603 {
4604 current_funccal->returned = TRUE;
4605
Bram Moolenaare38eab22019-12-05 21:50:01 +01004606 // If the return is carried out now, store the return value. For
4607 // a return immediately after reanimation, the value is already
4608 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 if (!reanimate && rettv != NULL)
4610 {
4611 clear_tv(current_funccal->rettv);
4612 *current_funccal->rettv = *(typval_T *)rettv;
4613 if (!is_cmd)
4614 vim_free(rettv);
4615 }
4616 }
4617
4618 return idx < 0;
4619}
4620
4621/*
4622 * Free the variable with a pending return value.
4623 */
4624 void
4625discard_pending_return(void *rettv)
4626{
4627 free_tv((typval_T *)rettv);
4628}
4629
4630/*
4631 * Generate a return command for producing the value of "rettv". The result
4632 * is an allocated string. Used by report_pending() for verbose messages.
4633 */
4634 char_u *
4635get_return_cmd(void *rettv)
4636{
4637 char_u *s = NULL;
4638 char_u *tofree = NULL;
4639 char_u numbuf[NUMBUFLEN];
4640
4641 if (rettv != NULL)
4642 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4643 if (s == NULL)
4644 s = (char_u *)"";
4645
4646 STRCPY(IObuff, ":return ");
4647 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4648 if (STRLEN(s) + 8 >= IOSIZE)
4649 STRCPY(IObuff + IOSIZE - 4, "...");
4650 vim_free(tofree);
4651 return vim_strsave(IObuff);
4652}
4653
4654/*
4655 * Get next function line.
4656 * Called by do_cmdline() to get the next line.
4657 * Returns allocated string, or NULL for end of function.
4658 */
4659 char_u *
4660get_func_line(
4661 int c UNUSED,
4662 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004663 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004664 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665{
4666 funccall_T *fcp = (funccall_T *)cookie;
4667 ufunc_T *fp = fcp->func;
4668 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004669 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670
Bram Moolenaare38eab22019-12-05 21:50:01 +01004671 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 if (fcp->dbg_tick != debug_tick)
4673 {
4674 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004675 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676 fcp->dbg_tick = debug_tick;
4677 }
4678#ifdef FEAT_PROFILE
4679 if (do_profiling == PROF_YES)
4680 func_line_end(cookie);
4681#endif
4682
4683 gap = &fp->uf_lines;
4684 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4685 || fcp->returned)
4686 retval = NULL;
4687 else
4688 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004689 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 while (fcp->linenr < gap->ga_len
4691 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4692 ++fcp->linenr;
4693 if (fcp->linenr >= gap->ga_len)
4694 retval = NULL;
4695 else
4696 {
4697 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004698 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699#ifdef FEAT_PROFILE
4700 if (do_profiling == PROF_YES)
4701 func_line_start(cookie);
4702#endif
4703 }
4704 }
4705
Bram Moolenaare38eab22019-12-05 21:50:01 +01004706 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004707 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004709 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004710 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004711 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004712 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713 fcp->dbg_tick = debug_tick;
4714 }
4715
4716 return retval;
4717}
4718
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004719/*
4720 * Return TRUE if the currently active function should be ended, because a
4721 * return was encountered or an error occurred. Used inside a ":while".
4722 */
4723 int
4724func_has_ended(void *cookie)
4725{
4726 funccall_T *fcp = (funccall_T *)cookie;
4727
Bram Moolenaare38eab22019-12-05 21:50:01 +01004728 // Ignore the "abort" flag if the abortion behavior has been changed due to
4729 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4731 || fcp->returned);
4732}
4733
4734/*
4735 * return TRUE if cookie indicates a function which "abort"s on errors.
4736 */
4737 int
4738func_has_abort(
4739 void *cookie)
4740{
4741 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4742}
4743
4744
4745/*
4746 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4747 * Don't do this when "Func" is already a partial that was bound
4748 * explicitly (pt_auto is FALSE).
4749 * Changes "rettv" in-place.
4750 * Returns the updated "selfdict_in".
4751 */
4752 dict_T *
4753make_partial(dict_T *selfdict_in, typval_T *rettv)
4754{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004755 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 char_u *tofree = NULL;
4757 ufunc_T *fp;
4758 char_u fname_buf[FLEN_FIXED + 1];
4759 int error;
4760 dict_T *selfdict = selfdict_in;
4761
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004762 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4763 fp = rettv->vval.v_partial->pt_func;
4764 else
4765 {
4766 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4767 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004768 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004769 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004770 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004771 vim_free(tofree);
4772 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773
4774 if (fp != NULL && (fp->uf_flags & FC_DICT))
4775 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004776 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777
4778 if (pt != NULL)
4779 {
4780 pt->pt_refcount = 1;
4781 pt->pt_dict = selfdict;
4782 pt->pt_auto = TRUE;
4783 selfdict = NULL;
4784 if (rettv->v_type == VAR_FUNC)
4785 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004786 // Just a function: Take over the function name and use
4787 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004788 pt->pt_name = rettv->vval.v_string;
4789 }
4790 else
4791 {
4792 partial_T *ret_pt = rettv->vval.v_partial;
4793 int i;
4794
Bram Moolenaare38eab22019-12-05 21:50:01 +01004795 // Partial: copy the function name, use selfdict and copy
4796 // args. Can't take over name or args, the partial might
4797 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004798 if (ret_pt->pt_name != NULL)
4799 {
4800 pt->pt_name = vim_strsave(ret_pt->pt_name);
4801 func_ref(pt->pt_name);
4802 }
4803 else
4804 {
4805 pt->pt_func = ret_pt->pt_func;
4806 func_ptr_ref(pt->pt_func);
4807 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004808 if (ret_pt->pt_argc > 0)
4809 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004810 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004812 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004813 pt->pt_argc = 0;
4814 else
4815 {
4816 pt->pt_argc = ret_pt->pt_argc;
4817 for (i = 0; i < pt->pt_argc; i++)
4818 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4819 }
4820 }
4821 partial_unref(ret_pt);
4822 }
4823 rettv->v_type = VAR_PARTIAL;
4824 rettv->vval.v_partial = pt;
4825 }
4826 }
4827 return selfdict;
4828}
4829
4830/*
4831 * Return the name of the executed function.
4832 */
4833 char_u *
4834func_name(void *cookie)
4835{
4836 return ((funccall_T *)cookie)->func->uf_name;
4837}
4838
4839/*
4840 * Return the address holding the next breakpoint line for a funccall cookie.
4841 */
4842 linenr_T *
4843func_breakpoint(void *cookie)
4844{
4845 return &((funccall_T *)cookie)->breakpoint;
4846}
4847
4848/*
4849 * Return the address holding the debug tick for a funccall cookie.
4850 */
4851 int *
4852func_dbg_tick(void *cookie)
4853{
4854 return &((funccall_T *)cookie)->dbg_tick;
4855}
4856
4857/*
4858 * Return the nesting level for a funccall cookie.
4859 */
4860 int
4861func_level(void *cookie)
4862{
4863 return ((funccall_T *)cookie)->level;
4864}
4865
4866/*
4867 * Return TRUE when a function was ended by a ":return" command.
4868 */
4869 int
4870current_func_returned(void)
4871{
4872 return current_funccal->returned;
4873}
4874
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004875 int
4876free_unref_funccal(int copyID, int testing)
4877{
4878 int did_free = FALSE;
4879 int did_free_funccal = FALSE;
4880 funccall_T *fc, **pfc;
4881
4882 for (pfc = &previous_funccal; *pfc != NULL; )
4883 {
4884 if (can_free_funccal(*pfc, copyID))
4885 {
4886 fc = *pfc;
4887 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004888 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004889 did_free = TRUE;
4890 did_free_funccal = TRUE;
4891 }
4892 else
4893 pfc = &(*pfc)->caller;
4894 }
4895 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004896 // When a funccal was freed some more items might be garbage
4897 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 (void)garbage_collect(testing);
4899
4900 return did_free;
4901}
4902
4903/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004904 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 */
4906 static funccall_T *
4907get_funccal(void)
4908{
4909 int i;
4910 funccall_T *funccal;
4911 funccall_T *temp_funccal;
4912
4913 funccal = current_funccal;
4914 if (debug_backtrace_level > 0)
4915 {
4916 for (i = 0; i < debug_backtrace_level; i++)
4917 {
4918 temp_funccal = funccal->caller;
4919 if (temp_funccal)
4920 funccal = temp_funccal;
4921 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004922 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923 debug_backtrace_level = i;
4924 }
4925 }
4926 return funccal;
4927}
4928
4929/*
4930 * Return the hashtable used for local variables in the current funccal.
4931 * Return NULL if there is no current funccal.
4932 */
4933 hashtab_T *
4934get_funccal_local_ht()
4935{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004936 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937 return NULL;
4938 return &get_funccal()->l_vars.dv_hashtab;
4939}
4940
4941/*
4942 * Return the l: scope variable.
4943 * Return NULL if there is no current funccal.
4944 */
4945 dictitem_T *
4946get_funccal_local_var()
4947{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004948 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949 return NULL;
4950 return &get_funccal()->l_vars_var;
4951}
4952
4953/*
4954 * Return the hashtable used for argument in the current funccal.
4955 * Return NULL if there is no current funccal.
4956 */
4957 hashtab_T *
4958get_funccal_args_ht()
4959{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004960 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004961 return NULL;
4962 return &get_funccal()->l_avars.dv_hashtab;
4963}
4964
4965/*
4966 * Return the a: scope variable.
4967 * Return NULL if there is no current funccal.
4968 */
4969 dictitem_T *
4970get_funccal_args_var()
4971{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004972 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004974 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975}
4976
4977/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978 * List function variables, if there is a function.
4979 */
4980 void
4981list_func_vars(int *first)
4982{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004983 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004984 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004985 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004986}
4987
4988/*
4989 * If "ht" is the hashtable for local variables in the current funccal, return
4990 * the dict that contains it.
4991 * Otherwise return NULL.
4992 */
4993 dict_T *
4994get_current_funccal_dict(hashtab_T *ht)
4995{
4996 if (current_funccal != NULL
4997 && ht == &current_funccal->l_vars.dv_hashtab)
4998 return &current_funccal->l_vars;
4999 return NULL;
5000}
5001
5002/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005003 * Search hashitem in parent scope.
5004 */
5005 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005006find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005007{
5008 funccall_T *old_current_funccal = current_funccal;
5009 hashtab_T *ht;
5010 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005011 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005012
5013 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5014 return NULL;
5015
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005016 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005017 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005018 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005019 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005020 ht = find_var_ht(name, &varname);
5021 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005022 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005023 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005024 if (!HASHITEM_EMPTY(hi))
5025 {
5026 *pht = ht;
5027 break;
5028 }
5029 }
5030 if (current_funccal == current_funccal->func->uf_scoped)
5031 break;
5032 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005033 }
5034 current_funccal = old_current_funccal;
5035
5036 return hi;
5037}
5038
5039/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005040 * Search variable in parent scope.
5041 */
5042 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005043find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005044{
5045 dictitem_T *v = NULL;
5046 funccall_T *old_current_funccal = current_funccal;
5047 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005048 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005049
5050 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5051 return NULL;
5052
Bram Moolenaare38eab22019-12-05 21:50:01 +01005053 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005054 current_funccal = current_funccal->func->uf_scoped;
5055 while (current_funccal)
5056 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005057 ht = find_var_ht(name, &varname);
5058 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005059 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005060 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005061 if (v != NULL)
5062 break;
5063 }
5064 if (current_funccal == current_funccal->func->uf_scoped)
5065 break;
5066 current_funccal = current_funccal->func->uf_scoped;
5067 }
5068 current_funccal = old_current_funccal;
5069
5070 return v;
5071}
5072
5073/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005074 * Set "copyID + 1" in previous_funccal and callers.
5075 */
5076 int
5077set_ref_in_previous_funccal(int copyID)
5078{
5079 int abort = FALSE;
5080 funccall_T *fc;
5081
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005082 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005083 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005084 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005085 abort = abort
5086 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5087 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005088 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005089 }
5090 return abort;
5091}
5092
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005093 static int
5094set_ref_in_funccal(funccall_T *fc, int copyID)
5095{
5096 int abort = FALSE;
5097
5098 if (fc->fc_copyID != copyID)
5099 {
5100 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005101 abort = abort
5102 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5103 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005104 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005105 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005106 }
5107 return abort;
5108}
5109
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005110/*
5111 * Set "copyID" in all local vars and arguments in the call stack.
5112 */
5113 int
5114set_ref_in_call_stack(int copyID)
5115{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005116 int abort = FALSE;
5117 funccall_T *fc;
5118 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005120 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005121 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005122
5123 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005124 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5125 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005126 abort = abort || set_ref_in_funccal(fc, copyID);
5127
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005128 return abort;
5129}
5130
5131/*
5132 * Set "copyID" in all functions available by name.
5133 */
5134 int
5135set_ref_in_functions(int copyID)
5136{
5137 int todo;
5138 hashitem_T *hi = NULL;
5139 int abort = FALSE;
5140 ufunc_T *fp;
5141
5142 todo = (int)func_hashtab.ht_used;
5143 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005144 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005145 if (!HASHITEM_EMPTY(hi))
5146 {
5147 --todo;
5148 fp = HI2UF(hi);
5149 if (!func_name_refcount(fp->uf_name))
5150 abort = abort || set_ref_in_func(NULL, fp, copyID);
5151 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 }
5153 return abort;
5154}
5155
5156/*
5157 * Set "copyID" in all function arguments.
5158 */
5159 int
5160set_ref_in_func_args(int copyID)
5161{
5162 int i;
5163 int abort = FALSE;
5164
5165 for (i = 0; i < funcargs.ga_len; ++i)
5166 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5167 copyID, NULL, NULL);
5168 return abort;
5169}
5170
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005171/*
5172 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005173 * Returns TRUE if setting references failed somehow.
5174 */
5175 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005176set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005177{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005178 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005179 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005180 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005181 char_u fname_buf[FLEN_FIXED + 1];
5182 char_u *tofree = NULL;
5183 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005184 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005185
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005186 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005187 return FALSE;
5188
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005189 if (fp_in == NULL)
5190 {
5191 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005192 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005193 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005194 if (fp != NULL)
5195 {
5196 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005197 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005198 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005199
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005200 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005201 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005202}
5203
Bram Moolenaare38eab22019-12-05 21:50:01 +01005204#endif // FEAT_EVAL