blob: e220781b1f7b9fb54ef2d5137998df9d04fd79c2 [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 Moolenaarc3fc75d2021-02-07 15:28:09 +0100129 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
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 Moolenaarc3fc75d2021-02-07 15:28:09 +0100300 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
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{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100406 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
407 // actually extends beyond the struct.
408 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100409
410 if (name[0] == K_SPECIAL)
411 {
412 fp->uf_name_exp = alloc(STRLEN(name) + 3);
413 if (fp->uf_name_exp != NULL)
414 {
415 STRCPY(fp->uf_name_exp, "<SNR>");
416 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
417 }
418 }
419}
420
Bram Moolenaar58016442016-07-31 18:30:22 +0200421/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200422 * Get a name for a lambda. Returned in static memory.
423 */
424 char_u *
425get_lambda_name(void)
426{
427 static char_u name[30];
428 static int lambda_no = 0;
429
430 sprintf((char*)name, "<lambda>%d", ++lambda_no);
431 return name;
432}
433
Bram Moolenaar801ab062020-06-25 19:27:56 +0200434#if defined(FEAT_LUA) || defined(PROTO)
435/*
436 * Registers a native C callback which can be called from Vim script.
437 * Returns the name of the Vim script function.
438 */
439 char_u *
440register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
441{
442 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200443 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200444
445 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
446 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200447 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200448
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200449 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200450 fp->uf_refcount = 1;
451 fp->uf_varargs = TRUE;
452 fp->uf_flags = FC_CFUNC;
453 fp->uf_calls = 0;
454 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200455 fp->uf_cb = cb;
456 fp->uf_cb_free = cb_free;
457 fp->uf_cb_state = state;
458
459 set_ufunc_name(fp, name);
460 hash_add(&func_hashtab, UF2HIKEY(fp));
461
462 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200463}
464#endif
465
Bram Moolenaar04b12692020-05-04 23:24:44 +0200466/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100467 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100468 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100469 * If "white_error" is not NULL check for correct use of white space and set
470 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100471 * Return NULL if no valid arrow found.
472 */
473 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100474skip_arrow(
475 char_u *start,
476 int equal_arrow,
477 char_u **ret_type,
478 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100479{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100480 char_u *s = start;
481 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100482
483 if (equal_arrow)
484 {
485 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100486 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100487 if (white_error != NULL && !VIM_ISWHITE(s[1]))
488 {
489 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100490 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100491 return NULL;
492 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100493 s = skipwhite(s + 1);
494 *ret_type = s;
495 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100496 if (s == *ret_type)
497 {
498 emsg(_(e_missing_return_type));
499 return NULL;
500 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100501 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100502 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100503 s = skipwhite(s);
504 if (*s != '=')
505 return NULL;
506 ++s;
507 }
508 if (*s != '>')
509 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100510 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
511 || !IS_WHITE_OR_NUL(s[1])))
512 {
513 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100514 semsg(_(e_white_space_required_before_and_after_str_at_str),
515 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100516 return NULL;
517 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100518 return skipwhite(s + 1);
519}
520
521/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200522 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100523 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100524 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200525 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
526 */
527 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100528get_lambda_tv(
529 char_u **arg,
530 typval_T *rettv,
531 int types_optional,
532 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200533{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200534 int evaluate = evalarg != NULL
535 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200536 garray_T newargs;
537 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200538 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100539 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200540 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100541 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200542 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100543 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200544 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200545 char_u *s;
546 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200547 int *old_eval_lavars = eval_lavars_used;
548 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100549 char_u *tofree1 = NULL;
550 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100551 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100552 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +0100553 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100554
555 if (equal_arrow && !in_vim9script())
556 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200557
558 ga_init(&newargs);
559 ga_init(&newlines);
560
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100561 // First, check if this is really a lambda expression. "->" or "=>" must
562 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100563 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100564 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100565 types_optional ? &argtypes : NULL, types_optional,
566 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100567 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100568 {
569 if (types_optional)
570 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100571 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100572 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200573
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100574 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200575 if (evaluate)
576 pnewargs = &newargs;
577 else
578 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100579 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100580 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100581 types_optional ? &argtypes : NULL, types_optional,
582 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100583 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100584 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100585 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100586 {
587 if (types_optional)
588 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100589 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100591 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100592 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200593
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100594 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
595 if (ret_type != NULL)
596 {
597 ret_type = vim_strsave(ret_type);
598 tofree2 = ret_type;
599 }
600
Bram Moolenaare38eab22019-12-05 21:50:01 +0100601 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200602 if (evaluate)
603 eval_lavars_used = &eval_lavars;
604
Bram Moolenaar65c44152020-12-24 15:14:01 +0100605 *arg = skipwhite_and_linebreak(*arg, evalarg);
606
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100607 // Recognize "{" as the start of a function body.
608 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100609 {
610 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100611 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100612 emsg("Lambda function body not supported yet");
613 goto errret;
614 }
615
Bram Moolenaare38eab22019-12-05 21:50:01 +0100616 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200617 start = *arg;
618 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200619 if (ret == FAIL)
620 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200621 if (evalarg != NULL)
622 {
623 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100624 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200625 evalarg->eval_tofree = NULL;
626 }
627
Bram Moolenaar65c44152020-12-24 15:14:01 +0100628 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100629 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100630 *arg = skipwhite_and_linebreak(*arg, evalarg);
631 if (**arg != '}')
632 {
633 semsg(_("E451: Expected }: %s"), *arg);
634 goto errret;
635 }
636 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100637 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200638
639 if (evaluate)
640 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200641 int len;
642 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200643 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200644 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200645
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200646 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200647 if (fp == NULL)
648 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200649 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200650 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200651 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200652 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200653
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200654 ga_init2(&newlines, (int)sizeof(char_u *), 1);
655 if (ga_grow(&newlines, 1) == FAIL)
656 goto errret;
657
Bram Moolenaare38eab22019-12-05 21:50:01 +0100658 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200659 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200660 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200661 if (p == NULL)
662 goto errret;
663 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
664 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200665 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200666 if (strstr((char *)p + 7, "a:") == NULL)
667 // No a: variables are used for sure.
668 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200669
670 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100671 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200672 hash_add(&func_hashtab, UF2HIKEY(fp));
673 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200674 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100675 if (types_optional)
676 {
677 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
678 goto errret;
679 if (ret_type != NULL)
680 {
681 fp->uf_ret_type = parse_type(&ret_type,
682 &fp->uf_type_list, TRUE);
683 if (fp->uf_ret_type == NULL)
684 goto errret;
685 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100686 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100687 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100688 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100689
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200690 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200691 if (current_funccal != NULL && eval_lavars)
692 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200693 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200694 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200695 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200696 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200697
698#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200699 if (prof_def_func())
700 func_do_profile(fp);
701#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200702 if (sandbox)
703 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100704 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200705 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200706 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200707 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200708 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100709 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200710
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200711 pt->pt_func = fp;
712 pt->pt_refcount = 1;
713 rettv->vval.v_partial = pt;
714 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200715 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200716
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200717 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200718 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100719 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200720 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100721 vim_free(tofree1);
722 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100723 if (types_optional)
724 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200725 return OK;
726
727errret:
728 ga_clear_strings(&newargs);
729 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100730 if (types_optional)
731 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200732 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100733 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200734 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100735 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200736 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100737 vim_free(tofree1);
738 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200739 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200740 return FAIL;
741}
742
743/*
744 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
745 * name it contains, otherwise return "name".
746 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
747 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100748 * If "type" is not NULL and a Vim9 script-local variable is found look up the
749 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200750 */
751 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100752deref_func_name(
753 char_u *name,
754 int *lenp,
755 partial_T **partialp,
756 type_T **type,
757 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200758{
759 dictitem_T *v;
760 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100761 char_u *s = NULL;
762 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200763
764 if (partialp != NULL)
765 *partialp = NULL;
766
767 cc = name[*lenp];
768 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100769 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200770 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100771 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200772 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100773 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200774 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100775 if (v->di_tv.vval.v_string == NULL)
776 {
777 *lenp = 0;
778 return (char_u *)""; // just in case
779 }
780 s = v->di_tv.vval.v_string;
781 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200782 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200783
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100784 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200785 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100786 partial_T *pt = v->di_tv.vval.v_partial;
787
788 if (pt == NULL)
789 {
790 *lenp = 0;
791 return (char_u *)""; // just in case
792 }
793 if (partialp != NULL)
794 *partialp = pt;
795 s = partial_name(pt);
796 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200797 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100798
799 if (s != NULL)
800 {
801 if (type != NULL && ht == get_script_local_ht())
802 {
803 svar_T *sv = find_typval_in_script(&v->di_tv);
804
805 if (sv != NULL)
806 *type = sv->sv_type;
807 }
808 return s;
809 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200810 }
811
812 return name;
813}
814
815/*
816 * Give an error message with a function name. Handle <SNR> things.
817 * "ermsg" is to be passed without translation, use N_() instead of _().
818 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100819 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200820emsg_funcname(char *ermsg, char_u *name)
821{
822 char_u *p;
823
824 if (*name == K_SPECIAL)
825 p = concat_str((char_u *)"<SNR>", name + 3);
826 else
827 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100828 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200829 if (p != name)
830 vim_free(p);
831}
832
833/*
834 * Allocate a variable for the result of a function.
835 * Return OK or FAIL.
836 */
837 int
838get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200839 char_u *name, // name of the function
840 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200841 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200842 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200843 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200844 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200845{
846 char_u *argp;
847 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100848 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
849 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200850 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200851
852 /*
853 * Get the arguments.
854 */
855 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200856 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
857 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200858 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200859 // skip the '(' or ',' and possibly line breaks
860 argp = skipwhite_and_linebreak(argp + 1, evalarg);
861
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200862 if (*argp == ')' || *argp == ',' || *argp == NUL)
863 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200864 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200865 {
866 ret = FAIL;
867 break;
868 }
869 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200870 // The comma should come right after the argument, but this wasn't
871 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200872 if (vim9script)
873 {
874 if (*argp != ',' && *skipwhite(argp) == ',')
875 {
876 semsg(_(e_no_white_space_allowed_before_str), ",");
877 ret = FAIL;
878 break;
879 }
880 }
881 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200882 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200883 if (*argp != ',')
884 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200885 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
886 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100887 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200888 ret = FAIL;
889 break;
890 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200891 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200892 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200893 if (*argp == ')')
894 ++argp;
895 else
896 ret = FAIL;
897
898 if (ret == OK)
899 {
900 int i = 0;
901
902 if (get_vim_var_nr(VV_TESTING))
903 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100904 // Prepare for calling test_garbagecollect_now(), need to know
905 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200906 if (funcargs.ga_itemsize == 0)
907 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
908 for (i = 0; i < argcount; ++i)
909 if (ga_grow(&funcargs, 1) == OK)
910 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
911 &argvars[i];
912 }
913
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200914 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200915
916 funcargs.ga_len -= i;
917 }
918 else if (!aborting())
919 {
920 if (argcount == MAX_FUNC_ARGS)
921 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
922 else
923 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
924 }
925
926 while (--argcount >= 0)
927 clear_tv(&argvars[argcount]);
928
Bram Moolenaar8294d492020-08-10 22:40:56 +0200929 if (in_vim9script())
930 *arg = argp;
931 else
932 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200933 return ret;
934}
935
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200936/*
937 * Return TRUE if "p" starts with "<SID>" or "s:".
938 * Only works if eval_fname_script() returned non-zero for "p"!
939 */
940 static int
941eval_fname_sid(char_u *p)
942{
943 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
944}
945
946/*
947 * In a script change <SID>name() and s:name() to K_SNR 123_name().
948 * Change <SNR>123_name() to K_SNR 123_name().
949 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
950 * (slow).
951 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100952 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200953fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
954{
955 int llen;
956 char_u *fname;
957 int i;
958
959 llen = eval_fname_script(name);
960 if (llen > 0)
961 {
962 fname_buf[0] = K_SPECIAL;
963 fname_buf[1] = KS_EXTRA;
964 fname_buf[2] = (int)KE_SNR;
965 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100966 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200967 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200968 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100969 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200970 else
971 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200972 sprintf((char *)fname_buf + 3, "%ld_",
973 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200974 i = (int)STRLEN(fname_buf);
975 }
976 }
977 if (i + STRLEN(name + llen) < FLEN_FIXED)
978 {
979 STRCPY(fname_buf + i, name + llen);
980 fname = fname_buf;
981 }
982 else
983 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200984 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200985 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100986 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200987 else
988 {
989 *tofree = fname;
990 mch_memmove(fname, fname_buf, (size_t)i);
991 STRCPY(fname + i, name + llen);
992 }
993 }
994 }
995 else
996 fname = name;
997 return fname;
998}
999
1000/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001001 * Find a function "name" in script "sid".
1002 */
1003 static ufunc_T *
1004find_func_with_sid(char_u *name, int sid)
1005{
1006 hashitem_T *hi;
1007 char_u buffer[200];
1008
1009 buffer[0] = K_SPECIAL;
1010 buffer[1] = KS_EXTRA;
1011 buffer[2] = (int)KE_SNR;
1012 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1013 (long)sid, name);
1014 hi = hash_find(&func_hashtab, buffer);
1015 if (!HASHITEM_EMPTY(hi))
1016 return HI2UF(hi);
1017
1018 return NULL;
1019}
1020
1021/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001022 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001023 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001024 * Return NULL for unknown function.
1025 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001026 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001027find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001028{
1029 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001030 ufunc_T *func;
1031 imported_T *imported;
1032
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001033 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001034 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001035 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001036 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001037 int find_script_local = in_vim9script()
1038 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001039
Bram Moolenaar95006e32020-08-29 17:47:08 +02001040 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001041 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001042 // Find script-local function before global one.
1043 func = find_func_with_sid(name, current_sctx.sc_sid);
1044 if (func != NULL)
1045 return func;
1046 }
1047
Bram Moolenaarefa94442020-08-08 22:16:00 +02001048 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001049 && name[1] == KS_EXTRA
1050 && name[2] == KE_SNR)
1051 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001052 // Caller changes s: to <SNR>99_name.
1053
1054 after_script = name + 3;
1055 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001056 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001057 ++after_script;
1058 else
1059 after_script = NULL;
1060 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001061 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001062 {
1063 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001064 if (after_script != NULL && sid != current_sctx.sc_sid)
1065 imported = find_imported_in_script(after_script, 0, sid);
1066 else
1067 imported = find_imported(after_script == NULL
1068 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001069 if (imported != NULL && imported->imp_funcname != NULL)
1070 {
1071 hi = hash_find(&func_hashtab, imported->imp_funcname);
1072 if (!HASHITEM_EMPTY(hi))
1073 return HI2UF(hi);
1074 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001075 }
1076 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001077
Bram Moolenaara26b9702020-04-18 19:53:28 +02001078 hi = hash_find(&func_hashtab,
1079 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080 if (!HASHITEM_EMPTY(hi))
1081 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001082
1083 return NULL;
1084}
1085
1086/*
1087 * Find a function by name, return pointer to it in ufuncs.
1088 * "cctx" is passed in a :def function to find imported functions.
1089 * Return NULL for unknown or dead function.
1090 */
1091 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001092find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001093{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001094 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001095
1096 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1097 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001098 return NULL;
1099}
1100
1101/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001102 * Return TRUE if "ufunc" is a global function.
1103 */
1104 int
1105func_is_global(ufunc_T *ufunc)
1106{
1107 return ufunc->uf_name[0] != K_SPECIAL;
1108}
1109
1110/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111 * Copy the function name of "fp" to buffer "buf".
1112 * "buf" must be able to hold the function name plus three bytes.
1113 * Takes care of script-local function names.
1114 */
1115 static void
1116cat_func_name(char_u *buf, ufunc_T *fp)
1117{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001118 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001119 {
1120 STRCPY(buf, "<SNR>");
1121 STRCAT(buf, fp->uf_name + 3);
1122 }
1123 else
1124 STRCPY(buf, fp->uf_name);
1125}
1126
1127/*
1128 * Add a number variable "name" to dict "dp" with value "nr".
1129 */
1130 static void
1131add_nr_var(
1132 dict_T *dp,
1133 dictitem_T *v,
1134 char *name,
1135 varnumber_T nr)
1136{
1137 STRCPY(v->di_key, name);
1138 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1139 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1140 v->di_tv.v_type = VAR_NUMBER;
1141 v->di_tv.v_lock = VAR_FIXED;
1142 v->di_tv.vval.v_number = nr;
1143}
1144
1145/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001146 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001147 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001148 static void
1149free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001150{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001151 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001152
1153 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1154 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001155 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001156
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001157 // When garbage collecting a funccall_T may be freed before the
1158 // function that references it, clear its uf_scoped field.
1159 // The function may have been redefined and point to another
1160 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001161 if (fp != NULL && fp->uf_scoped == fc)
1162 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001163 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001164 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001165
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001166 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001167 vim_free(fc);
1168}
1169
1170/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001171 * Free "fc" and what it contains.
1172 * Can be called only when "fc" is kept beyond the period of it called,
1173 * i.e. after cleanup_function_call(fc).
1174 */
1175 static void
1176free_funccal_contents(funccall_T *fc)
1177{
1178 listitem_T *li;
1179
1180 // Free all l: variables.
1181 vars_clear(&fc->l_vars.dv_hashtab);
1182
1183 // Free all a: variables.
1184 vars_clear(&fc->l_avars.dv_hashtab);
1185
1186 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001187 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001188 clear_tv(&li->li_tv);
1189
1190 free_funccal(fc);
1191}
1192
1193/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001194 * Handle the last part of returning from a function: free the local hashtable.
1195 * Unless it is still in use by a closure.
1196 */
1197 static void
1198cleanup_function_call(funccall_T *fc)
1199{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001200 int may_free_fc = fc->fc_refcount <= 0;
1201 int free_fc = TRUE;
1202
Bram Moolenaar6914c642017-04-01 21:21:30 +02001203 current_funccal = fc->caller;
1204
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001205 // Free all l: variables if not referred.
1206 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1207 vars_clear(&fc->l_vars.dv_hashtab);
1208 else
1209 free_fc = FALSE;
1210
1211 // If the a:000 list and the l: and a: dicts are not referenced and
1212 // there is no closure using it, we can free the funccall_T and what's
1213 // in it.
1214 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1215 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001216 else
1217 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001218 int todo;
1219 hashitem_T *hi;
1220 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001221
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001222 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001223
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001224 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001225 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1226 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1227 {
1228 if (!HASHITEM_EMPTY(hi))
1229 {
1230 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001231 di = HI2DI(hi);
1232 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001233 }
1234 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001235 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001236
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001237 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1238 fc->l_varlist.lv_first = NULL;
1239 else
1240 {
1241 listitem_T *li;
1242
1243 free_fc = FALSE;
1244
1245 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001246 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001247 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001248 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001249
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001250 if (free_fc)
1251 free_funccal(fc);
1252 else
1253 {
1254 static int made_copy = 0;
1255
1256 // "fc" is still in use. This can happen when returning "a:000",
1257 // assigning "l:" to a global variable or defining a closure.
1258 // Link "fc" in the list for garbage collection later.
1259 fc->caller = previous_funccal;
1260 previous_funccal = fc;
1261
1262 if (want_garbage_collect)
1263 // If garbage collector is ready, clear count.
1264 made_copy = 0;
1265 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001266 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001267 // We have made a lot of copies, worth 4 Mbyte. This can happen
1268 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001269 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001270 // too much memory.
1271 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001272 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001273 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001274 }
1275}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001276
1277/*
1278 * There are two kinds of function names:
1279 * 1. ordinary names, function defined with :function or :def
1280 * 2. numbered functions and lambdas
1281 * For the first we only count the name stored in func_hashtab as a reference,
1282 * using function() does not count as a reference, because the function is
1283 * looked up by name.
1284 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001285 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001286func_name_refcount(char_u *name)
1287{
1288 return isdigit(*name) || *name == '<';
1289}
1290
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001291/*
1292 * Unreference "fc": decrement the reference count and free it when it
1293 * becomes zero. "fp" is detached from "fc".
1294 * When "force" is TRUE we are exiting.
1295 */
1296 static void
1297funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1298{
1299 funccall_T **pfc;
1300 int i;
1301
1302 if (fc == NULL)
1303 return;
1304
1305 if (--fc->fc_refcount <= 0 && (force || (
1306 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1307 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1308 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1309 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1310 {
1311 if (fc == *pfc)
1312 {
1313 *pfc = fc->caller;
1314 free_funccal_contents(fc);
1315 return;
1316 }
1317 }
1318 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1319 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1320 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1321}
1322
1323/*
1324 * Remove the function from the function hashtable. If the function was
1325 * deleted while it still has references this was already done.
1326 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1327 */
1328 static int
1329func_remove(ufunc_T *fp)
1330{
1331 hashitem_T *hi;
1332
1333 // Return if it was already virtually deleted.
1334 if (fp->uf_flags & FC_DEAD)
1335 return FALSE;
1336
1337 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1338 if (!HASHITEM_EMPTY(hi))
1339 {
1340 // When there is a def-function index do not actually remove the
1341 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001342 // Do remove it when it's a copy.
1343 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001344 fp->uf_flags |= FC_DEAD;
1345 else
1346 hash_remove(&func_hashtab, hi);
1347 return TRUE;
1348 }
1349 return FALSE;
1350}
1351
1352 static void
1353func_clear_items(ufunc_T *fp)
1354{
1355 ga_clear_strings(&(fp->uf_args));
1356 ga_clear_strings(&(fp->uf_def_args));
1357 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001358 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001359 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001360 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001361 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001362 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001363
1364 // Increment the refcount of this function to avoid it being freed
1365 // recursively when the partial is freed.
1366 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001367 partial_unref(fp->uf_partial);
1368 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001369 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001370
1371#ifdef FEAT_LUA
1372 if (fp->uf_cb_free != NULL)
1373 {
1374 fp->uf_cb_free(fp->uf_cb_state);
1375 fp->uf_cb_free = NULL;
1376 }
1377
1378 fp->uf_cb_state = NULL;
1379 fp->uf_cb = NULL;
1380#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001381#ifdef FEAT_PROFILE
1382 VIM_CLEAR(fp->uf_tml_count);
1383 VIM_CLEAR(fp->uf_tml_total);
1384 VIM_CLEAR(fp->uf_tml_self);
1385#endif
1386}
1387
1388/*
1389 * Free all things that a function contains. Does not free the function
1390 * itself, use func_free() for that.
1391 * When "force" is TRUE we are exiting.
1392 */
1393 static void
1394func_clear(ufunc_T *fp, int force)
1395{
1396 if (fp->uf_cleared)
1397 return;
1398 fp->uf_cleared = TRUE;
1399
1400 // clear this function
1401 func_clear_items(fp);
1402 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001403 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001404}
1405
1406/*
1407 * Free a function and remove it from the list of functions. Does not free
1408 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001409 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001410 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001411 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001412 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001413func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001414{
1415 // Only remove it when not done already, otherwise we would remove a newer
1416 // version of the function with the same name.
1417 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1418 func_remove(fp);
1419
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001420 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001421 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001422 if (fp->uf_dfunc_idx > 0)
1423 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001424 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001425 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001426 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001427 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001428 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001429}
1430
1431/*
1432 * Free all things that a function contains and free the function itself.
1433 * When "force" is TRUE we are exiting.
1434 */
1435 static void
1436func_clear_free(ufunc_T *fp, int force)
1437{
1438 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001439 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1440 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001441 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001442 else
1443 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001444}
1445
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001446/*
1447 * Copy already defined function "lambda" to a new function with name "global".
1448 * This is for when a compiled function defines a global function.
1449 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001450 int
1451copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001452{
1453 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001454 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001455
1456 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001457 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001458 semsg(_(e_lambda_function_not_found_str), lambda);
1459 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001460 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001461
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001462 fp = find_func(global, TRUE, NULL);
1463 if (fp != NULL)
1464 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001465 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001466 semsg(_(e_funcexts), global);
1467 return FAIL;
1468 }
1469
1470 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1471 if (fp == NULL)
1472 return FAIL;
1473
1474 fp->uf_varargs = ufunc->uf_varargs;
1475 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1476 fp->uf_def_status = ufunc->uf_def_status;
1477 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1478 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1479 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1480 == FAIL
1481 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1482 goto failed;
1483
1484 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1485 : vim_strsave(ufunc->uf_name_exp);
1486 if (ufunc->uf_arg_types != NULL)
1487 {
1488 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1489 if (fp->uf_arg_types == NULL)
1490 goto failed;
1491 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1492 sizeof(type_T *) * fp->uf_args.ga_len);
1493 }
1494 if (ufunc->uf_def_arg_idx != NULL)
1495 {
1496 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1497 if (fp->uf_def_arg_idx == NULL)
1498 goto failed;
1499 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1500 sizeof(int) * fp->uf_def_args.ga_len + 1);
1501 }
1502 if (ufunc->uf_va_name != NULL)
1503 {
1504 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1505 if (fp->uf_va_name == NULL)
1506 goto failed;
1507 }
1508 fp->uf_ret_type = ufunc->uf_ret_type;
1509
1510 fp->uf_refcount = 1;
1511 STRCPY(fp->uf_name, global);
1512 hash_add(&func_hashtab, UF2HIKEY(fp));
1513
1514 // the referenced dfunc_T is now used one more time
1515 link_def_function(fp);
1516
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001517 // Create a partial to store the context of the function where it was
1518 // instantiated. Only needs to be done once. Do this on the original
1519 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001520 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1521 {
1522 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1523
1524 if (pt == NULL)
1525 goto failed;
1526 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001527 {
1528 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001529 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001530 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001531 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001532 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001533 }
1534
1535 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001536
1537failed:
1538 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001539 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001540}
1541
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001542static int funcdepth = 0;
1543
1544/*
1545 * Increment the function call depth count.
1546 * Return FAIL when going over 'maxfuncdepth'.
1547 * Otherwise return OK, must call funcdepth_decrement() later!
1548 */
1549 int
1550funcdepth_increment(void)
1551{
1552 if (funcdepth >= p_mfd)
1553 {
1554 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1555 return FAIL;
1556 }
1557 ++funcdepth;
1558 return OK;
1559}
1560
1561 void
1562funcdepth_decrement(void)
1563{
1564 --funcdepth;
1565}
1566
1567/*
1568 * Get the current function call depth.
1569 */
1570 int
1571funcdepth_get(void)
1572{
1573 return funcdepth;
1574}
1575
1576/*
1577 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001578 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001579 * times as funcdepth_increment().
1580 */
1581 void
1582funcdepth_restore(int depth)
1583{
1584 funcdepth = depth;
1585}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001586
1587/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001588 * Call a user function.
1589 */
1590 static void
1591call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001592 ufunc_T *fp, // pointer to function
1593 int argcount, // nr of args
1594 typval_T *argvars, // arguments
1595 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001596 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001597 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001599 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001600 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 funccall_T *fc;
1602 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001603 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001604 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001605 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001606 int i;
1607 int ai;
1608 int islambda = FALSE;
1609 char_u numbuf[NUMBUFLEN];
1610 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001612 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001614 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615
Bram Moolenaarb2049902021-01-24 12:53:53 +01001616#ifdef FEAT_PROFILE
1617 CLEAR_FIELD(profile_info);
1618#endif
1619
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001620 // If depth of calling is getting too high, don't execute the function.
1621 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 rettv->v_type = VAR_NUMBER;
1624 rettv->vval.v_number = -1;
1625 return;
1626 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627
Bram Moolenaare38eab22019-12-05 21:50:01 +01001628 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001630 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001631 if (fc == NULL)
1632 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001633 fc->caller = current_funccal;
1634 current_funccal = fc;
1635 fc->func = fp;
1636 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001638 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1640 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001641 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001642 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001643 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001645 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001646 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001647 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01001648#ifdef FEAT_PROFILE
1649 profile_may_start_func(&profile_info, fp, fc);
1650#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001651 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001652 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01001653#ifdef FEAT_PROFILE
1654 if (do_profiling == PROF_YES && (fp->uf_profiling
1655 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1656 profile_may_end_func(&profile_info, fp, fc);
1657#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001658 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001659 free_funccal(fc);
1660 return;
1661 }
1662
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001663 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1664 islambda = TRUE;
1665
1666 /*
1667 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1668 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1669 * each argument variable and saves a lot of time.
1670 */
1671 /*
1672 * Init l: variables.
1673 */
1674 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1675 if (selfdict != NULL)
1676 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001677 // Set l:self to "selfdict". Use "name" to avoid a warning from
1678 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001679 v = &fc->fixvar[fixvar_idx++].var;
1680 name = v->di_key;
1681 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001682 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1684 v->di_tv.v_type = VAR_DICT;
1685 v->di_tv.v_lock = 0;
1686 v->di_tv.vval.v_dict = selfdict;
1687 ++selfdict->dv_refcount;
1688 }
1689
1690 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001691 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001692 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 * Set a:000 to a list with room for the "..." arguments.
1694 */
1695 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001696 if ((fp->uf_flags & FC_NOARGS) == 0)
1697 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001698 (varnumber_T)(argcount >= fp->uf_args.ga_len
1699 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001700 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001701 if ((fp->uf_flags & FC_NOARGS) == 0)
1702 {
1703 // Use "name" to avoid a warning from some compiler that checks the
1704 // destination size.
1705 v = &fc->fixvar[fixvar_idx++].var;
1706 name = v->di_key;
1707 STRCPY(name, "000");
1708 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1709 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1710 v->di_tv.v_type = VAR_LIST;
1711 v->di_tv.v_lock = VAR_FIXED;
1712 v->di_tv.vval.v_list = &fc->l_varlist;
1713 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001714 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1716 fc->l_varlist.lv_lock = VAR_FIXED;
1717
1718 /*
1719 * Set a:firstline to "firstline" and a:lastline to "lastline".
1720 * Set a:name to named arguments.
1721 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001722 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001724 if ((fp->uf_flags & FC_NOARGS) == 0)
1725 {
1726 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001727 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001728 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001729 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001730 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001731 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 {
1733 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001734 typval_T def_rettv;
1735 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001736
1737 ai = i - fp->uf_args.ga_len;
1738 if (ai < 0)
1739 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001740 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741 name = FUNCARG(fp, i);
1742 if (islambda)
1743 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001744
1745 // evaluate named argument default expression
1746 isdefault = ai + fp->uf_def_args.ga_len >= 0
1747 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1748 && argvars[i].vval.v_number == VVAL_NONE));
1749 if (isdefault)
1750 {
1751 char_u *default_expr = NULL;
1752 def_rettv.v_type = VAR_NUMBER;
1753 def_rettv.vval.v_number = -1;
1754
1755 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1756 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001757 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001758 {
1759 default_arg_err = 1;
1760 break;
1761 }
1762 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001763 }
1764 else
1765 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001766 if ((fp->uf_flags & FC_NOARGS) != 0)
1767 // Bail out if no a: arguments used (in lambda).
1768 break;
1769
Bram Moolenaare38eab22019-12-05 21:50:01 +01001770 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001771 sprintf((char *)numbuf, "%d", ai + 1);
1772 name = numbuf;
1773 }
1774 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1775 {
1776 v = &fc->fixvar[fixvar_idx++].var;
1777 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001778 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001779 }
1780 else
1781 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001782 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001783 if (v == NULL)
1784 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001785 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001786 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001788 // Note: the values are copied directly to avoid alloc/free.
1789 // "argvars" must have VAR_FIXED for v_lock.
1790 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001791 v->di_tv.v_lock = VAR_FIXED;
1792
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001793 if (addlocal)
1794 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001795 // Named arguments should be accessed without the "a:" prefix in
1796 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001797 copy_tv(&v->di_tv, &v->di_tv);
1798 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001799 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001800 else
1801 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001802
1803 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1804 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001805 listitem_T *li = &fc->l_listitems[ai];
1806
1807 li->li_tv = argvars[i];
1808 li->li_tv.v_lock = VAR_FIXED;
1809 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001810 }
1811 }
1812
Bram Moolenaare38eab22019-12-05 21:50:01 +01001813 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001814 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001815
1816 if (fp->uf_flags & FC_SANDBOX)
1817 {
1818 using_sandbox = TRUE;
1819 ++sandbox;
1820 }
1821
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001822 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001823 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001824 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001826 ++no_wait_return;
1827 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001829 smsg(_("calling %s"), SOURCING_NAME);
1830 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001832 char_u buf[MSG_BUF_LEN];
1833 char_u numbuf2[NUMBUFLEN];
1834 char_u *tofree;
1835 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001836
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001837 msg_puts("(");
1838 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001839 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001840 if (i > 0)
1841 msg_puts(", ");
1842 if (argvars[i].v_type == VAR_NUMBER)
1843 msg_outnum((long)argvars[i].vval.v_number);
1844 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001846 // Do not want errors such as E724 here.
1847 ++emsg_off;
1848 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1849 --emsg_off;
1850 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001852 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001854 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1855 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001857 msg_puts((char *)s);
1858 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001859 }
1860 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001861 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001862 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001863 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001864 msg_puts("\n"); // don't overwrite this either
1865
1866 verbose_leave_scroll();
1867 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 }
1869#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001870 profile_may_start_func(&profile_info, fp, fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001871#endif
1872
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001873 save_current_sctx = current_sctx;
1874 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001875 save_did_emsg = did_emsg;
1876 did_emsg = FALSE;
1877
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001878 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1879 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001880 else if (islambda)
1881 {
1882 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1883
1884 // A Lambda always has the command "return {expr}". It is much faster
1885 // to evaluate {expr} directly.
1886 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001887 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001888 --ex_nesting_level;
1889 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001890 else
1891 // call do_cmdline() to execute the lines
1892 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1894
1895 --RedrawingDisabled;
1896
Bram Moolenaare38eab22019-12-05 21:50:01 +01001897 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001898 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1899 {
1900 clear_tv(rettv);
1901 rettv->v_type = VAR_NUMBER;
1902 rettv->vval.v_number = -1;
1903 }
1904
1905#ifdef FEAT_PROFILE
1906 if (do_profiling == PROF_YES && (fp->uf_profiling
1907 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
Bram Moolenaarb2049902021-01-24 12:53:53 +01001908 profile_may_end_func(&profile_info, fp, fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001909#endif
1910
Bram Moolenaare38eab22019-12-05 21:50:01 +01001911 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001912 if (p_verbose >= 12)
1913 {
1914 ++no_wait_return;
1915 verbose_enter_scroll();
1916
1917 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001918 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001920 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001921 (long)fc->rettv->vval.v_number);
1922 else
1923 {
1924 char_u buf[MSG_BUF_LEN];
1925 char_u numbuf2[NUMBUFLEN];
1926 char_u *tofree;
1927 char_u *s;
1928
Bram Moolenaare38eab22019-12-05 21:50:01 +01001929 // The value may be very long. Skip the middle part, so that we
1930 // have some idea how it starts and ends. smsg() would always
1931 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001932 ++emsg_off;
1933 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1934 --emsg_off;
1935 if (s != NULL)
1936 {
1937 if (vim_strsize(s) > MSG_BUF_CLEN)
1938 {
1939 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1940 s = buf;
1941 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001942 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001943 vim_free(tofree);
1944 }
1945 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001946 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001947
1948 verbose_leave_scroll();
1949 --no_wait_return;
1950 }
1951
Bram Moolenaare31ee862020-01-07 20:59:34 +01001952 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001953 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001954 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955#ifdef FEAT_PROFILE
1956 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01001957 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001958#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001959 if (using_sandbox)
1960 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001962 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001963 {
1964 ++no_wait_return;
1965 verbose_enter_scroll();
1966
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001967 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001968 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001969
1970 verbose_leave_scroll();
1971 --no_wait_return;
1972 }
1973
1974 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001975 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001976 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001977}
1978
1979/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001980 * Check the argument count for user function "fp".
1981 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1982 */
1983 int
1984check_user_func_argcount(ufunc_T *fp, int argcount)
1985{
1986 int regular_args = fp->uf_args.ga_len;
1987
1988 if (argcount < regular_args - fp->uf_def_args.ga_len)
1989 return FCERR_TOOFEW;
1990 else if (!has_varargs(fp) && argcount > regular_args)
1991 return FCERR_TOOMANY;
1992 return FCERR_UNKNOWN;
1993}
1994
1995/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001996 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001997 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998 int
1999call_user_func_check(
2000 ufunc_T *fp,
2001 int argcount,
2002 typval_T *argvars,
2003 typval_T *rettv,
2004 funcexe_T *funcexe,
2005 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002006{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002007 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002008
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2010 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002011 error = check_user_func_argcount(fp, argcount);
2012 if (error != FCERR_UNKNOWN)
2013 return error;
2014 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002015 error = FCERR_DICT;
2016 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002017 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002018 int did_save_redo = FALSE;
2019 save_redo_T save_redo;
2020
2021 /*
2022 * Call the user function.
2023 * Save and restore search patterns, script variables and
2024 * redo buffer.
2025 */
2026 save_search_patterns();
2027 if (!ins_compl_active())
2028 {
2029 saveRedobuff(&save_redo);
2030 did_save_redo = TRUE;
2031 }
2032 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002033 call_user_func(fp, argcount, argvars, rettv, funcexe,
2034 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002035 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2036 // Function was unreferenced while being used, free it now.
2037 func_clear_free(fp, FALSE);
2038 if (did_save_redo)
2039 restoreRedobuff(&save_redo);
2040 restore_search_patterns();
2041 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002042 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002043 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002044}
2045
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002046static funccal_entry_T *funccal_stack = NULL;
2047
2048/*
2049 * Save the current function call pointer, and set it to NULL.
2050 * Used when executing autocommands and for ":source".
2051 */
2052 void
2053save_funccal(funccal_entry_T *entry)
2054{
2055 entry->top_funccal = current_funccal;
2056 entry->next = funccal_stack;
2057 funccal_stack = entry;
2058 current_funccal = NULL;
2059}
2060
2061 void
2062restore_funccal(void)
2063{
2064 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002065 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002066 else
2067 {
2068 current_funccal = funccal_stack->top_funccal;
2069 funccal_stack = funccal_stack->next;
2070 }
2071}
2072
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002073 funccall_T *
2074get_current_funccal(void)
2075{
2076 return current_funccal;
2077}
2078
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002079/*
2080 * Mark all functions of script "sid" as deleted.
2081 */
2082 void
2083delete_script_functions(int sid)
2084{
2085 hashitem_T *hi;
2086 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002087 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002088 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002089 size_t len;
2090
2091 buf[0] = K_SPECIAL;
2092 buf[1] = KS_EXTRA;
2093 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002094 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002095 len = STRLEN(buf);
2096
Bram Moolenaarce658352020-07-31 23:47:12 +02002097 while (todo > 0)
2098 {
2099 todo = func_hashtab.ht_used;
2100 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2101 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002102 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002103 fp = HI2UF(hi);
2104 if (STRNCMP(fp->uf_name, buf, len) == 0)
2105 {
2106 int changed = func_hashtab.ht_changed;
2107
2108 fp->uf_flags |= FC_DEAD;
2109 func_clear(fp, TRUE);
2110 // When clearing a function another function can be cleared
2111 // as a side effect. When that happens start over.
2112 if (changed != func_hashtab.ht_changed)
2113 break;
2114 }
2115 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002116 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002117 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002118}
2119
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002120#if defined(EXITFREE) || defined(PROTO)
2121 void
2122free_all_functions(void)
2123{
2124 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002125 ufunc_T *fp;
2126 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002127 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002128 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002129
Bram Moolenaare38eab22019-12-05 21:50:01 +01002130 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002131 while (current_funccal != NULL)
2132 {
2133 clear_tv(current_funccal->rettv);
2134 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002135 if (current_funccal == NULL && funccal_stack != NULL)
2136 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002137 }
2138
Bram Moolenaare38eab22019-12-05 21:50:01 +01002139 // First clear what the functions contain. Since this may lower the
2140 // reference count of a function, it may also free a function and change
2141 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002142 while (todo > 0)
2143 {
2144 todo = func_hashtab.ht_used;
2145 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2146 if (!HASHITEM_EMPTY(hi))
2147 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002148 // clear the def function index now
2149 fp = HI2UF(hi);
2150 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002151 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002152
Bram Moolenaare38eab22019-12-05 21:50:01 +01002153 // Only free functions that are not refcounted, those are
2154 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002155 if (func_name_refcount(fp->uf_name))
2156 ++skipped;
2157 else
2158 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002159 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002160 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002161 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002162 {
2163 skipped = 0;
2164 break;
2165 }
2166 }
2167 --todo;
2168 }
2169 }
2170
Bram Moolenaare38eab22019-12-05 21:50:01 +01002171 // Now actually free the functions. Need to start all over every time,
2172 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002173 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002174 while (func_hashtab.ht_used > skipped)
2175 {
2176 todo = func_hashtab.ht_used;
2177 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002178 if (!HASHITEM_EMPTY(hi))
2179 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002180 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002181 // Only free functions that are not refcounted, those are
2182 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002183 fp = HI2UF(hi);
2184 if (func_name_refcount(fp->uf_name))
2185 ++skipped;
2186 else
2187 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002188 if (func_free(fp, FALSE) == OK)
2189 {
2190 skipped = 0;
2191 break;
2192 }
2193 // did not actually free it
2194 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002195 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002196 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002197 }
2198 if (skipped == 0)
2199 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002200
2201 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002202}
2203#endif
2204
2205/*
2206 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002207 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002208 * "len" is the length of "name", or -1 for NUL terminated.
2209 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002210 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211builtin_function(char_u *name, int len)
2212{
2213 char_u *p;
2214
Bram Moolenaara26b9702020-04-18 19:53:28 +02002215 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002216 return FALSE;
2217 p = vim_strchr(name, AUTOLOAD_CHAR);
2218 return p == NULL || (len > 0 && p > name + len);
2219}
2220
2221 int
2222func_call(
2223 char_u *name,
2224 typval_T *args,
2225 partial_T *partial,
2226 dict_T *selfdict,
2227 typval_T *rettv)
2228{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002229 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002230 listitem_T *item;
2231 typval_T argv[MAX_FUNC_ARGS + 1];
2232 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002233 int r = 0;
2234
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002235 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002236 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002237 {
2238 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2239 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002240 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 break;
2242 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002243 // Make a copy of each argument. This is needed to be able to set
2244 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002245 copy_tv(&item->li_tv, &argv[argc++]);
2246 }
2247
2248 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002249 {
2250 funcexe_T funcexe;
2251
Bram Moolenaara80faa82020-04-12 19:37:17 +02002252 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002253 funcexe.firstline = curwin->w_cursor.lnum;
2254 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002255 funcexe.evaluate = TRUE;
2256 funcexe.partial = partial;
2257 funcexe.selfdict = selfdict;
2258 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2259 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002260
Bram Moolenaare38eab22019-12-05 21:50:01 +01002261 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002262 while (argc > 0)
2263 clear_tv(&argv[--argc]);
2264
2265 return r;
2266}
2267
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002268static int callback_depth = 0;
2269
2270 int
2271get_callback_depth(void)
2272{
2273 return callback_depth;
2274}
2275
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002276/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002277 * Invoke call_func() with a callback.
2278 */
2279 int
2280call_callback(
2281 callback_T *callback,
2282 int len, // length of "name" or -1 to use strlen()
2283 typval_T *rettv, // return value goes here
2284 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002285 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002286 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002287{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002288 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002289 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002290
Bram Moolenaara80faa82020-04-12 19:37:17 +02002291 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002292 funcexe.evaluate = TRUE;
2293 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002294 ++callback_depth;
2295 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2296 --callback_depth;
2297 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002298}
2299
2300/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002301 * Give an error message for the result of a function.
2302 * Nothing if "error" is FCERR_NONE.
2303 */
2304 void
2305user_func_error(int error, char_u *name)
2306{
2307 switch (error)
2308 {
2309 case FCERR_UNKNOWN:
2310 emsg_funcname(e_unknownfunc, name);
2311 break;
2312 case FCERR_NOTMETHOD:
2313 emsg_funcname(
2314 N_("E276: Cannot use function as a method: %s"), name);
2315 break;
2316 case FCERR_DELETED:
2317 emsg_funcname(N_(e_func_deleted), name);
2318 break;
2319 case FCERR_TOOMANY:
2320 emsg_funcname((char *)e_toomanyarg, name);
2321 break;
2322 case FCERR_TOOFEW:
2323 emsg_funcname((char *)e_toofewarg, name);
2324 break;
2325 case FCERR_SCRIPT:
2326 emsg_funcname(
2327 N_("E120: Using <SID> not in a script context: %s"), name);
2328 break;
2329 case FCERR_DICT:
2330 emsg_funcname(
2331 N_("E725: Calling dict function without Dictionary: %s"),
2332 name);
2333 break;
2334 }
2335}
2336
2337/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002338 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002339 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340 * Return FAIL when the function can't be called, OK otherwise.
2341 * Also returns OK when an error was encountered while executing the function.
2342 */
2343 int
2344call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002345 char_u *funcname, // name of the function
2346 int len, // length of "name" or -1 to use strlen()
2347 typval_T *rettv, // return value goes here
2348 int argcount_in, // number of "argvars"
2349 typval_T *argvars_in, // vars for arguments, must have "argcount"
2350 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002351 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002352{
2353 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002354 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002356 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002357 char_u fname_buf[FLEN_FIXED + 1];
2358 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002359 char_u *fname = NULL;
2360 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 int argcount = argcount_in;
2362 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002363 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002364 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2365 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002367 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002368 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002369
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002370 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2371 // even when call_func() returns FAIL.
2372 rettv->v_type = VAR_UNKNOWN;
2373
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002374 if (partial != NULL)
2375 fp = partial->pt_func;
2376 if (fp == NULL)
2377 {
2378 // Make a copy of the name, if it comes from a funcref variable it
2379 // could be changed or deleted in the called function.
2380 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2381 if (name == NULL)
2382 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002383
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002384 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2385 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002386
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002387 if (funcexe->doesrange != NULL)
2388 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002389
2390 if (partial != NULL)
2391 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002392 // When the function has a partial with a dict and there is a dict
2393 // argument, use the dict argument. That is backwards compatible.
2394 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002395 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002397 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002398 {
2399 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002400 {
2401 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2402 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002403 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002404 goto theend;
2405 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002407 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002408 for (i = 0; i < argcount_in; ++i)
2409 argv[i + argv_clear] = argvars_in[i];
2410 argvars = argv;
2411 argcount = partial->pt_argc + argcount_in;
2412 }
2413 }
2414
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002415 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2416 {
2417 // Check that the argument types are OK for the types of the funcref.
2418 if (check_argument_types(funcexe->check_type, argvars, argcount,
2419 name) == FAIL)
2420 error = FCERR_OTHER;
2421 }
2422
Bram Moolenaaref140542019-12-31 21:27:13 +01002423 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002424 {
2425 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002426 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002427
Bram Moolenaar333894b2020-08-01 18:53:07 +02002428 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002429 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002430 {
2431 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434
Bram Moolenaare38eab22019-12-05 21:50:01 +01002435 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002437 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002439 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002440 {
2441 /*
2442 * User defined function.
2443 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002444 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002445 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446
Bram Moolenaare38eab22019-12-05 21:50:01 +01002447 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 if (fp == NULL
2449 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002450 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002451 && !aborting())
2452 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002453 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002454 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002456 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2458 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002459 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002460 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002462 if (fp == NULL)
2463 {
2464 char_u *p = untrans_function_name(rfname);
2465
2466 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002467 // Don't do this if the name starts with "s:".
2468 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002469 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002470 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002472 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002473 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002474#ifdef FEAT_LUA
2475 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2476 {
2477 cfunc_T cb = fp->uf_cb;
2478
2479 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2480 }
2481#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002482 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002483 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002484 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002485 // postponed filling in the arguments, do it now
2486 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002487 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002488
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002489 if (funcexe->basetv != NULL)
2490 {
2491 // Method call: base->Method()
2492 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2493 argv[0] = *funcexe->basetv;
2494 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002495 argvars = argv;
2496 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002497 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002498
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002499 error = call_user_func_check(fp, argcount, argvars, rettv,
2500 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501 }
2502 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002503 else if (funcexe->basetv != NULL)
2504 {
2505 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002506 * expr->method(): Find the method name in the table, call its
2507 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002508 */
2509 error = call_internal_method(fname, argcount, argvars, rettv,
2510 funcexe->basetv);
2511 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512 else
2513 {
2514 /*
2515 * Find the function name in the table, call its implementation.
2516 */
2517 error = call_internal_func(fname, argcount, argvars, rettv);
2518 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002519
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002520 /*
2521 * The function call (or "FuncUndefined" autocommand sequence) might
2522 * have been aborted by an error, an interrupt, or an explicitly thrown
2523 * exception that has not been caught so far. This situation can be
2524 * tested for by calling aborting(). For an error in an internal
2525 * function or for the "E132" error in call_user_func(), however, the
2526 * throw point at which the "force_abort" flag (temporarily reset by
2527 * emsg()) is normally updated has not been reached yet. We need to
2528 * update that flag first to make aborting() reliable.
2529 */
2530 update_force_abort();
2531 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002532 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533 ret = OK;
2534
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002535theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002536 /*
2537 * Report an error unless the argument evaluation or function call has been
2538 * cancelled due to an aborting error, an interrupt, or an exception.
2539 */
2540 if (!aborting())
2541 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002542 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 }
2544
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002545 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002546 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002547 clear_tv(&argv[--argv_clear + argv_base]);
2548
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 vim_free(tofree);
2550 vim_free(name);
2551
2552 return ret;
2553}
2554
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002555 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002556printable_func_name(ufunc_T *fp)
2557{
2558 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2559}
2560
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002562 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002563 */
2564 static void
2565list_func_head(ufunc_T *fp, int indent)
2566{
2567 int j;
2568
2569 msg_start();
2570 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002571 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002572 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002573 msg_puts("def ");
2574 else
2575 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002576 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002577 msg_putchar('(');
2578 for (j = 0; j < fp->uf_args.ga_len; ++j)
2579 {
2580 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002581 msg_puts(", ");
2582 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 if (fp->uf_arg_types != NULL)
2584 {
2585 char *tofree;
2586
2587 msg_puts(": ");
2588 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2589 vim_free(tofree);
2590 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002591 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2592 {
2593 msg_puts(" = ");
2594 msg_puts(((char **)(fp->uf_def_args.ga_data))
2595 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2596 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002597 }
2598 if (fp->uf_varargs)
2599 {
2600 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002601 msg_puts(", ");
2602 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002604 if (fp->uf_va_name != NULL)
2605 {
2606 if (j)
2607 msg_puts(", ");
2608 msg_puts("...");
2609 msg_puts((char *)fp->uf_va_name);
2610 if (fp->uf_va_type)
2611 {
2612 char *tofree;
2613
2614 msg_puts(": ");
2615 msg_puts(type_name(fp->uf_va_type, &tofree));
2616 vim_free(tofree);
2617 }
2618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002619 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002620
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002621 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002622 {
2623 if (fp->uf_ret_type != &t_void)
2624 {
2625 char *tofree;
2626
2627 msg_puts(": ");
2628 msg_puts(type_name(fp->uf_ret_type, &tofree));
2629 vim_free(tofree);
2630 }
2631 }
2632 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002633 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002635 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002637 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002638 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002639 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 msg_clr_eos();
2641 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002642 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643}
2644
2645/*
2646 * Get a function name, translating "<SID>" and "<SNR>".
2647 * Also handles a Funcref in a List or Dictionary.
2648 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002649 * Set "*is_global" to TRUE when the function must be global, unless
2650 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651 * flags:
2652 * TFN_INT: internal function name OK
2653 * TFN_QUIET: be quiet
2654 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002655 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 * Advances "pp" to just after the function name (if no error).
2657 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002658 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659trans_function_name(
2660 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002661 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002662 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002664 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002665 partial_T **partial, // return: partial of a FuncRef
2666 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667{
2668 char_u *name = NULL;
2669 char_u *start;
2670 char_u *end;
2671 int lead;
2672 char_u sid_buf[20];
2673 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002674 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002675 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002676 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002677 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678
2679 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002680 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 start = *pp;
2682
Bram Moolenaare38eab22019-12-05 21:50:01 +01002683 // Check for hard coded <SNR>: already translated function ID (from a user
2684 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002685 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2686 && (*pp)[2] == (int)KE_SNR)
2687 {
2688 *pp += 3;
2689 len = get_id_len(pp) + 3;
2690 return vim_strnsave(start, len);
2691 }
2692
Bram Moolenaare38eab22019-12-05 21:50:01 +01002693 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2694 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695 lead = eval_fname_script(start);
2696 if (lead > 2)
2697 start += lead;
2698
Bram Moolenaare38eab22019-12-05 21:50:01 +01002699 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002700 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701 lead > 2 ? 0 : FNE_CHECK_START);
2702 if (end == start)
2703 {
2704 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002705 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002706 goto theend;
2707 }
2708 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2709 {
2710 /*
2711 * Report an invalid expression in braces, unless the expression
2712 * evaluation has been cancelled due to an aborting error, an
2713 * interrupt, or an exception.
2714 */
2715 if (!aborting())
2716 {
2717 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002718 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 }
2720 else
2721 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2722 goto theend;
2723 }
2724
2725 if (lv.ll_tv != NULL)
2726 {
2727 if (fdp != NULL)
2728 {
2729 fdp->fd_dict = lv.ll_dict;
2730 fdp->fd_newkey = lv.ll_newkey;
2731 lv.ll_newkey = NULL;
2732 fdp->fd_di = lv.ll_di;
2733 }
2734 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2735 {
2736 name = vim_strsave(lv.ll_tv->vval.v_string);
2737 *pp = end;
2738 }
2739 else if (lv.ll_tv->v_type == VAR_PARTIAL
2740 && lv.ll_tv->vval.v_partial != NULL)
2741 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002742 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002743 *pp = end;
2744 if (partial != NULL)
2745 *partial = lv.ll_tv->vval.v_partial;
2746 }
2747 else
2748 {
2749 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2750 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002751 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002752 else
2753 *pp = end;
2754 name = NULL;
2755 }
2756 goto theend;
2757 }
2758
2759 if (lv.ll_name == NULL)
2760 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002761 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 *pp = end;
2763 goto theend;
2764 }
2765
Bram Moolenaare38eab22019-12-05 21:50:01 +01002766 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002767 if (lv.ll_exp_name != NULL)
2768 {
2769 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002770 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 flags & TFN_NO_AUTOLOAD);
2772 if (name == lv.ll_exp_name)
2773 name = NULL;
2774 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002775 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 {
2777 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002778 name = deref_func_name(*pp, &len, partial, type,
2779 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 if (name == *pp)
2781 name = NULL;
2782 }
2783 if (name != NULL)
2784 {
2785 name = vim_strsave(name);
2786 *pp = end;
2787 if (STRNCMP(name, "<SNR>", 5) == 0)
2788 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002789 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 name[0] = K_SPECIAL;
2791 name[1] = KS_EXTRA;
2792 name[2] = (int)KE_SNR;
2793 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2794 }
2795 goto theend;
2796 }
2797
2798 if (lv.ll_exp_name != NULL)
2799 {
2800 len = (int)STRLEN(lv.ll_exp_name);
2801 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2802 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002804 // When there was "s:" already or the name expanded to get a
2805 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 lv.ll_name += 2;
2807 len -= 2;
2808 lead = 2;
2809 }
2810 }
2811 else
2812 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002813 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002815 {
2816 if (is_global != NULL && lv.ll_name[0] == 'g')
2817 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002819 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 len = (int)(end - lv.ll_name);
2821 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002822 if (len <= 0)
2823 {
2824 if (!skip)
2825 emsg(_(e_function_name));
2826 goto theend;
2827 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002829 // In Vim9 script a user function is script-local by default, unless it
2830 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002831 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002832 if (vim9script)
2833 {
2834 char_u *p;
2835
2836 // SomeScript#func() is a global function.
2837 for (p = start; *p != NUL && *p != '('; ++p)
2838 if (*p == AUTOLOAD_CHAR)
2839 vim9script = FALSE;
2840 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002841
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 /*
2843 * Copy the function name to allocated memory.
2844 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2845 * Accept <SNR>123_name() outside a script.
2846 */
2847 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002848 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002849 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002850 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002851 if (!vim9script)
2852 lead = 3;
2853 if (vim9script || (lv.ll_exp_name != NULL
2854 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 || eval_fname_sid(*pp))
2856 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002857 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002858 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002860 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 goto theend;
2862 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002863 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002864 if (vim9script)
2865 extra = 3 + (int)STRLEN(sid_buf);
2866 else
2867 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 }
2869 }
2870 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2871 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002872 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 start);
2874 goto theend;
2875 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002876 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002877 {
2878 char_u *cp = vim_strchr(lv.ll_name, ':');
2879
2880 if (cp != NULL && cp < end)
2881 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002882 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 goto theend;
2884 }
2885 }
2886
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002887 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 if (name != NULL)
2889 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002890 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891 {
2892 name[0] = K_SPECIAL;
2893 name[1] = KS_EXTRA;
2894 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002895 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 STRCPY(name + 3, sid_buf);
2897 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002898 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2899 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900 }
2901 *pp = end;
2902
2903theend:
2904 clear_lval(&lv);
2905 return name;
2906}
2907
2908/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002909 * Assuming "name" is the result of trans_function_name() and it was prefixed
2910 * to use the script-local name, return the unmodified name (points into
2911 * "name"). Otherwise return NULL.
2912 * This can be used to first search for a script-local function and fall back
2913 * to the global function if not found.
2914 */
2915 char_u *
2916untrans_function_name(char_u *name)
2917{
2918 char_u *p;
2919
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002920 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002921 {
2922 p = vim_strchr(name, '_');
2923 if (p != NULL)
2924 return p + 1;
2925 }
2926 return NULL;
2927}
2928
2929/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002930 * List functions. When "regmatch" is NULL all of then.
2931 * Otherwise functions matching "regmatch".
2932 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002933 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002934list_functions(regmatch_T *regmatch)
2935{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002936 int changed = func_hashtab.ht_changed;
2937 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002938 hashitem_T *hi;
2939
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002940 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002941 {
2942 if (!HASHITEM_EMPTY(hi))
2943 {
2944 ufunc_T *fp = HI2UF(hi);
2945
2946 --todo;
2947 if ((fp->uf_flags & FC_DEAD) == 0
2948 && (regmatch == NULL
2949 ? !message_filtered(fp->uf_name)
2950 && !func_name_refcount(fp->uf_name)
2951 : !isdigit(*fp->uf_name)
2952 && vim_regexec(regmatch, fp->uf_name, 0)))
2953 {
2954 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002955 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002956 {
2957 emsg(_("E454: function list was modified"));
2958 return;
2959 }
2960 }
2961 }
2962 }
2963}
2964
2965/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002966 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2967 * return TRUE.
2968 * Otherwise return FALSE;
2969 * Do not consider "function(" to be a command.
2970 */
2971 static int
2972is_function_cmd(char_u **cmd)
2973{
2974 char_u *p = *cmd;
2975
2976 if (checkforcmd(&p, "function", 2))
2977 {
2978 if (*p == '(')
2979 return FALSE;
2980 *cmd = p;
2981 return TRUE;
2982 }
2983 return FALSE;
2984}
2985
2986/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002987 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002988 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2989 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002990 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002992 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002993define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994{
2995 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002996 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002997 int j;
2998 int c;
2999 int saved_did_emsg;
3000 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003001 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003002 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 char_u *p;
3004 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003005 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 char_u *line_arg = NULL;
3007 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003008 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003009 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003010 garray_T newlines;
3011 int varargs = FALSE;
3012 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003013 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003014 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003015 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016 int indent;
3017 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003018#define MAX_FUNC_NESTING 50
3019 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 dictitem_T *v;
3021 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003022 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003025 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003026 linenr_T sourcing_lnum_off;
3027 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003028 int is_heredoc = FALSE;
3029 char_u *skip_until = NULL;
3030 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003031 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003032 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033
3034 /*
3035 * ":function" without argument: list functions.
3036 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003037 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 {
3039 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003040 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003042 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043 }
3044
3045 /*
3046 * ":function /pat": list functions matching pattern.
3047 */
3048 if (*eap->arg == '/')
3049 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003050 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003051 if (!eap->skip)
3052 {
3053 regmatch_T regmatch;
3054
3055 c = *p;
3056 *p = NUL;
3057 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3058 *p = c;
3059 if (regmatch.regprog != NULL)
3060 {
3061 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003062 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003063 vim_regfree(regmatch.regprog);
3064 }
3065 }
3066 if (*p == '/')
3067 ++p;
3068 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003069 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003070 }
3071
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003072 ga_init(&newargs);
3073 ga_init(&argtypes);
3074 ga_init(&default_args);
3075
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003076 /*
3077 * Get the function name. There are these situations:
3078 * func normal function name
3079 * "name" == func, "fudi.fd_dict" == NULL
3080 * dict.func new dictionary entry
3081 * "name" == NULL, "fudi.fd_dict" set,
3082 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3083 * dict.func existing dict entry with a Funcref
3084 * "name" == func, "fudi.fd_dict" set,
3085 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3086 * dict.func existing dict entry that's not a Funcref
3087 * "name" == NULL, "fudi.fd_dict" set,
3088 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3089 * s:func script-local function name
3090 * g:func global function name, same as "func"
3091 */
3092 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003093 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003094 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003095 // nested function, argument is (args).
3096 paren = TRUE;
3097 CLEAR_FIELD(fudi);
3098 }
3099 else
3100 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003101 if (STRNCMP(p, "<lambda>", 8) == 0)
3102 {
3103 p += 8;
3104 (void)getdigits(&p);
3105 name = vim_strnsave(eap->arg, p - eap->arg);
3106 CLEAR_FIELD(fudi);
3107 }
3108 else
3109 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003110 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003111 paren = (vim_strchr(p, '(') != NULL);
3112 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003114 /*
3115 * Return on an invalid expression in braces, unless the expression
3116 * evaluation has been cancelled due to an aborting error, an
3117 * interrupt, or an exception.
3118 */
3119 if (!aborting())
3120 {
3121 if (!eap->skip && fudi.fd_newkey != NULL)
3122 semsg(_(e_dictkey), fudi.fd_newkey);
3123 vim_free(fudi.fd_newkey);
3124 return NULL;
3125 }
3126 else
3127 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 }
3130
Bram Moolenaare38eab22019-12-05 21:50:01 +01003131 // An error in a function call during evaluation of an expression in magic
3132 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133 saved_did_emsg = did_emsg;
3134 did_emsg = FALSE;
3135
3136 /*
3137 * ":function func" with only function name: list function.
3138 */
3139 if (!paren)
3140 {
3141 if (!ends_excmd(*skipwhite(p)))
3142 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003143 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 goto ret_free;
3145 }
3146 eap->nextcmd = check_nextcmd(p);
3147 if (eap->nextcmd != NULL)
3148 *p = NUL;
3149 if (!eap->skip && !got_int)
3150 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003151 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003152 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3153 {
3154 char_u *up = untrans_function_name(name);
3155
3156 // With Vim9 script the name was made script-local, if not
3157 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003158 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003159 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003160 }
3161
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003162 if (fp != NULL)
3163 {
3164 list_func_head(fp, TRUE);
3165 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3166 {
3167 if (FUNCLINE(fp, j) == NULL)
3168 continue;
3169 msg_putchar('\n');
3170 msg_outnum((long)(j + 1));
3171 if (j < 9)
3172 msg_putchar(' ');
3173 if (j < 99)
3174 msg_putchar(' ');
3175 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003176 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003177 ui_breakcheck();
3178 }
3179 if (!got_int)
3180 {
3181 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003182 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003183 msg_puts(" enddef");
3184 else
3185 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 }
3187 }
3188 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003189 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003190 }
3191 goto ret_free;
3192 }
3193
3194 /*
3195 * ":function name(arg1, arg2)" Define function.
3196 */
3197 p = skipwhite(p);
3198 if (*p != '(')
3199 {
3200 if (!eap->skip)
3201 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003202 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 goto ret_free;
3204 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003205 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003206 if (vim_strchr(p, '(') != NULL)
3207 p = vim_strchr(p, '(');
3208 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003210 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3211 {
3212 semsg(_(e_no_white_space_allowed_before_str), "(");
3213 goto ret_free;
3214 }
3215
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003216 // In Vim9 script only global functions can be redefined.
3217 if (vim9script && eap->forceit && !is_global)
3218 {
3219 emsg(_(e_nobang));
3220 goto ret_free;
3221 }
3222
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3224
Bram Moolenaar04b12692020-05-04 23:24:44 +02003225 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003227 // Check the name of the function. Unless it's a dictionary function
3228 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 if (name != NULL)
3230 arg = name;
3231 else
3232 arg = fudi.fd_newkey;
3233 if (arg != NULL && (fudi.fd_di == NULL
3234 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3235 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3236 {
3237 if (*arg == K_SPECIAL)
3238 j = 3;
3239 else
3240 j = 0;
3241 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3242 : eval_isnamec(arg[j])))
3243 ++j;
3244 if (arg[j] != NUL)
3245 emsg_funcname((char *)e_invarg2, arg);
3246 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003247 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003249 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 }
3251
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003252 // This may get more lines and make the pointers into the first line
3253 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003254 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003256 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003257 &varargs, &default_args, eap->skip,
3258 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003260 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003262 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003263 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003264 // find the return type: :def Func(): type
3265 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003266 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003268 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003269 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003270 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003271 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003272 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003274 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003275 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003276 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003277 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003278 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003279 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003281 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003283 else
3284 // find extra arguments "range", "dict", "abort" and "closure"
3285 for (;;)
3286 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003287 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003288 p = skipwhite(p);
3289 if (STRNCMP(p, "range", 5) == 0)
3290 {
3291 flags |= FC_RANGE;
3292 p += 5;
3293 }
3294 else if (STRNCMP(p, "dict", 4) == 0)
3295 {
3296 flags |= FC_DICT;
3297 p += 4;
3298 }
3299 else if (STRNCMP(p, "abort", 5) == 0)
3300 {
3301 flags |= FC_ABORT;
3302 p += 5;
3303 }
3304 else if (STRNCMP(p, "closure", 7) == 0)
3305 {
3306 flags |= FC_CLOSURE;
3307 p += 7;
3308 if (current_funccal == NULL)
3309 {
3310 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3311 name == NULL ? (char_u *)"" : name);
3312 goto erret;
3313 }
3314 }
3315 else
3316 break;
3317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318
Bram Moolenaare38eab22019-12-05 21:50:01 +01003319 // When there is a line break use what follows for the function body.
3320 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003321 if (*p == '\n')
3322 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003323 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003324 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3325 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003326 && !(VIM_ISWHITE(*whitep) && *p == '#'
3327 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003328 && !eap->skip
3329 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003330 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003331
3332 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003333 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3334 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003335 */
3336 if (KeyTyped)
3337 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 // Check if the function already exists, don't let the user type the
3339 // whole function before telling him it doesn't work! For a script we
3340 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 if (!eap->skip && !eap->forceit)
3342 {
3343 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003344 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003345 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 emsg_funcname(e_funcexts, name);
3347 }
3348
3349 if (!eap->skip && did_emsg)
3350 goto erret;
3351
Bram Moolenaare38eab22019-12-05 21:50:01 +01003352 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003353 cmdline_row = msg_row;
3354 }
3355
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003356 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003357 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003358
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003359 // Detect having skipped over comment lines to find the return
3360 // type. Add NULL lines to keep the line count correct.
3361 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3362 if (SOURCING_LNUM < sourcing_lnum_off)
3363 {
3364 sourcing_lnum_off -= SOURCING_LNUM;
3365 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3366 goto erret;
3367 while (sourcing_lnum_off-- > 0)
3368 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3369 }
3370
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 indent = 2;
3372 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003373 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003374 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003375 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 for (;;)
3377 {
3378 if (KeyTyped)
3379 {
3380 msg_scroll = TRUE;
3381 saved_wait_return = FALSE;
3382 }
3383 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384
3385 if (line_arg != NULL)
3386 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003387 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 theline = line_arg;
3389 p = vim_strchr(theline, '\n');
3390 if (p == NULL)
3391 line_arg += STRLEN(line_arg);
3392 else
3393 {
3394 *p = NUL;
3395 line_arg = p + 1;
3396 }
3397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003398 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003399 {
3400 vim_free(line_to_free);
3401 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003402 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003403 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003404 theline = eap->getline(':', eap->cookie, indent,
3405 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003406 line_to_free = theline;
3407 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 if (KeyTyped)
3409 lines_left = Rows - 1;
3410 if (theline == NULL)
3411 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003412 // Use the start of the function for the line number.
3413 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003414 if (skip_until != NULL)
3415 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3416 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003417 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418 else
3419 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003420 goto erret;
3421 }
3422
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003423 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003424 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003425 if (SOURCING_LNUM < sourcing_lnum_off)
3426 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 else
3428 sourcing_lnum_off = 0;
3429
3430 if (skip_until != NULL)
3431 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003432 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003433 // * ":append" and "."
3434 // * ":python <<EOF" and "EOF"
3435 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3436 if (heredoc_trimmed == NULL
3437 || (is_heredoc && skipwhite(theline) == theline)
3438 || STRNCMP(theline, heredoc_trimmed,
3439 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003440 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003441 if (heredoc_trimmed == NULL)
3442 p = theline;
3443 else if (is_heredoc)
3444 p = skipwhite(theline) == theline
3445 ? theline : theline + STRLEN(heredoc_trimmed);
3446 else
3447 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003448 if (STRCMP(p, skip_until) == 0)
3449 {
3450 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003451 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003452 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003453 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003454 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003455 }
3456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 }
3458 else
3459 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003460 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003461 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 ;
3463
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003465 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003467 ? "enddef" : "endfunction", 4)
3468 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003469 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003470 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003471 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003472 char_u *nextcmd = NULL;
3473
3474 if (*p == '|')
3475 nextcmd = p + 1;
3476 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3477 nextcmd = line_arg;
3478 else if (*p != NUL && *p != '"' && p_verbose > 0)
3479 give_warning2(eap->cmdidx == CMD_def
3480 ? (char_u *)_("W1001: Text found after :enddef: %s")
3481 : (char_u *)_("W22: Text found after :endfunction: %s"),
3482 p, TRUE);
3483 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003484 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003485 // Another command follows. If the line came from "eap"
3486 // we can simply point into it, otherwise we need to
3487 // change "eap->cmdlinep".
3488 eap->nextcmd = nextcmd;
3489 if (line_to_free != NULL)
3490 {
3491 vim_free(*eap->cmdlinep);
3492 *eap->cmdlinep = line_to_free;
3493 line_to_free = NULL;
3494 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003495 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003496 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003497 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 }
3499
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003500 // Check for mismatched "endfunc" or "enddef".
3501 // We don't check for "def" inside "func" thus we also can't check
3502 // for "enddef".
3503 // We continue to find the end of the function, although we might
3504 // not find it.
3505 else if (nesting_def[nesting])
3506 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003507 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003508 emsg(_(e_mismatched_endfunction));
3509 }
3510 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3511 emsg(_(e_mismatched_enddef));
3512
Bram Moolenaare38eab22019-12-05 21:50:01 +01003513 // Increase indent inside "if", "while", "for" and "try", decrease
3514 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003515 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 indent -= 2;
3517 else if (STRNCMP(p, "if", 2) == 0
3518 || STRNCMP(p, "wh", 2) == 0
3519 || STRNCMP(p, "for", 3) == 0
3520 || STRNCMP(p, "try", 3) == 0)
3521 indent += 2;
3522
Bram Moolenaare38eab22019-12-05 21:50:01 +01003523 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003524 // Only recognize "def" inside "def", not inside "function",
3525 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003526 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003527 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003528 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003529 {
3530 if (*p == '!')
3531 p = skipwhite(p + 1);
3532 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003533 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3534 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 if (*skipwhite(p) == '(')
3536 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003537 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003538 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003539 else
3540 {
3541 ++nesting;
3542 nesting_def[nesting] = (c == 'd');
3543 indent += 2;
3544 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 }
3546 }
3547
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003548 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003549 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003550 if (eap->cmdidx != CMD_def
3551 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003552 || (p[0] == 'c'
3553 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3554 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3555 && (STRNCMP(&p[3], "nge", 3) != 0
3556 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 || (p[0] == 'i'
3558 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003559 && (!ASCII_ISALPHA(p[2])
3560 || (p[2] == 's'
3561 && (!ASCII_ISALPHA(p[3])
3562 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 skip_until = vim_strsave((char_u *)".");
3564
Bram Moolenaare38eab22019-12-05 21:50:01 +01003565 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003566 arg = skipwhite(skiptowhite(p));
3567 if (arg[0] == '<' && arg[1] =='<'
3568 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003569 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3570 || ((p[2] == '3' || p[2] == 'x')
3571 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 || (p[0] == 'p' && p[1] == 'e'
3573 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3574 || (p[0] == 't' && p[1] == 'c'
3575 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3576 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3577 && !ASCII_ISALPHA(p[3]))
3578 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3579 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3580 || (p[0] == 'm' && p[1] == 'z'
3581 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3582 ))
3583 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003584 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003586 if (STRNCMP(p, "trim", 4) == 0)
3587 {
3588 // Ignore leading white space.
3589 p = skipwhite(p + 4);
3590 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003591 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003592 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593 if (*p == NUL)
3594 skip_until = vim_strsave((char_u *)".");
3595 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003596 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003597 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003598 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003600
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003601 // Check for ":cmd v =<< [trim] EOF"
3602 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003603 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003604 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003605 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003606 if (*arg == '[')
3607 arg = vim_strchr(arg, ']');
3608 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003609 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003610 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3611 && arg[1] == '<' && arg[2] =='<');
3612
3613 if (!found)
3614 // skip over the argument after "cmd"
3615 arg = skipwhite(skiptowhite(arg));
3616 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003617 && (checkforcmd(&p, "let", 2)
3618 || checkforcmd(&p, "var", 3)
3619 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003620 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003621 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003622 p = skipwhite(arg + 3);
3623 if (STRNCMP(p, "trim", 4) == 0)
3624 {
3625 // Ignore leading white space.
3626 p = skipwhite(p + 4);
3627 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003628 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003629 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003630 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003631 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003632 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003633 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003634 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003635 }
3636
Bram Moolenaare38eab22019-12-05 21:50:01 +01003637 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003640
Bram Moolenaare38eab22019-12-05 21:50:01 +01003641 // Copy the line to newly allocated memory. get_one_sourceline()
3642 // allocates 250 bytes per line, this saves 80% on average. The cost
3643 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003645 if (p == NULL)
3646 goto erret;
3647 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648
Bram Moolenaare38eab22019-12-05 21:50:01 +01003649 // Add NULL lines for continuation lines, so that the line count is
3650 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003651 while (sourcing_lnum_off-- > 0)
3652 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3653
Bram Moolenaare38eab22019-12-05 21:50:01 +01003654 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655 if (line_arg != NULL && *line_arg == NUL)
3656 line_arg = NULL;
3657 }
3658
Bram Moolenaare38eab22019-12-05 21:50:01 +01003659 // Don't define the function when skipping commands or when an error was
3660 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 if (eap->skip || did_emsg)
3662 goto erret;
3663
3664 /*
3665 * If there are no errors, add the function
3666 */
3667 if (fudi.fd_dict == NULL)
3668 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003669 hashtab_T *ht;
3670
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003671 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3673 {
3674 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3675 name);
3676 goto erret;
3677 }
3678
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003679 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003680 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003681 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003682 char_u *uname = untrans_function_name(name);
3683
3684 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3685 }
3686
3687 if (fp != NULL || import != NULL)
3688 {
3689 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003690
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003691 // Function can be replaced with "function!" and when sourcing the
3692 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003693 // A name that is used by an import can not be overruled.
3694 if (import != NULL
3695 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003696 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003697 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003699 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003700 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003701 else
3702 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003703 goto erret;
3704 }
3705 if (fp->uf_calls > 0)
3706 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003707 emsg_funcname(
3708 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 name);
3710 goto erret;
3711 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003712 if (fp->uf_refcount > 1)
3713 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003714 // This function is referenced somewhere, don't redefine it but
3715 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003716 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003717 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003718 fp = NULL;
3719 overwrite = TRUE;
3720 }
3721 else
3722 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003723 char_u *exp_name = fp->uf_name_exp;
3724
3725 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003726 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003727 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003728 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003729 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003730 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003731#ifdef FEAT_PROFILE
3732 fp->uf_profiling = FALSE;
3733 fp->uf_prof_initialized = FALSE;
3734#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003735 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003736 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 }
3738 }
3739 else
3740 {
3741 char numbuf[20];
3742
3743 fp = NULL;
3744 if (fudi.fd_newkey == NULL && !eap->forceit)
3745 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003746 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003747 goto erret;
3748 }
3749 if (fudi.fd_di == NULL)
3750 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003751 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003752 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003753 goto erret;
3754 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003755 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003756 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757 goto erret;
3758
Bram Moolenaare38eab22019-12-05 21:50:01 +01003759 // Give the function a sequential number. Can only be used with a
3760 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 vim_free(name);
3762 sprintf(numbuf, "%d", ++func_nr);
3763 name = vim_strsave((char_u *)numbuf);
3764 if (name == NULL)
3765 goto erret;
3766 }
3767
3768 if (fp == NULL)
3769 {
3770 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3771 {
3772 int slen, plen;
3773 char_u *scriptname;
3774
Bram Moolenaare38eab22019-12-05 21:50:01 +01003775 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003777 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003778 {
3779 scriptname = autoload_name(name);
3780 if (scriptname != NULL)
3781 {
3782 p = vim_strchr(scriptname, '/');
3783 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003784 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003786 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003787 j = OK;
3788 vim_free(scriptname);
3789 }
3790 }
3791 if (j == FAIL)
3792 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003793 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 goto erret;
3795 }
3796 }
3797
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003798 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 if (fp == NULL)
3800 goto erret;
3801
3802 if (fudi.fd_dict != NULL)
3803 {
3804 if (fudi.fd_di == NULL)
3805 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003806 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3808 if (fudi.fd_di == NULL)
3809 {
3810 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003811 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 goto erret;
3813 }
3814 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3815 {
3816 vim_free(fudi.fd_di);
3817 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003818 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 goto erret;
3820 }
3821 }
3822 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003823 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 clear_tv(&fudi.fd_di->di_tv);
3825 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003826 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827
Bram Moolenaare38eab22019-12-05 21:50:01 +01003828 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 flags |= FC_DICT;
3830 }
3831
Bram Moolenaare38eab22019-12-05 21:50:01 +01003832 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003833 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003834 if (overwrite)
3835 {
3836 hi = hash_find(&func_hashtab, name);
3837 hi->hi_key = UF2HIKEY(fp);
3838 }
3839 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 {
3841 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003842 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 goto erret;
3844 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003845 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 }
3847 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003848 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003849 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003850 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003851
3852 if (eap->cmdidx == CMD_def)
3853 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003854 int lnum_save = SOURCING_LNUM;
3855 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003856
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003857 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003858
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003859 // error messages are for the first function line
3860 SOURCING_LNUM = sourcing_lnum_top;
3861
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003862 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003863 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003864 int count = cstack->cs_idx + 1;
3865 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003866
3867 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003868 // a block that is visible now but not when the function is called
3869 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003870 fp->uf_block_ids = ALLOC_MULT(int, count);
3871 if (fp->uf_block_ids != NULL)
3872 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003873 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003874 sizeof(int) * count);
3875 fp->uf_block_depth = count;
3876 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003877
3878 // Set flag in each block to indicate a function was defined. This
3879 // is used to keep the variable when leaving the block, see
3880 // hide_script_var().
3881 for (i = 0; i <= cstack->cs_idx; ++i)
3882 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003883 }
3884
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003885 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003886 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003887 SOURCING_LNUM = lnum_save;
3888 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003890 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003891
3892 // parse the return type, if any
3893 if (ret_type == NULL)
3894 fp->uf_ret_type = &t_void;
3895 else
3896 {
3897 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003898 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003899 if (fp->uf_ret_type == NULL)
3900 {
3901 fp->uf_ret_type = &t_void;
3902 SOURCING_LNUM = lnum_save;
3903 goto erret;
3904 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003905 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003906 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003907 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003908 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003909 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003910
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003912 if ((flags & FC_CLOSURE) != 0)
3913 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003914 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003915 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003916 }
3917 else
3918 fp->uf_scoped = NULL;
3919
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003921 if (prof_def_func())
3922 func_do_profile(fp);
3923#endif
3924 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003925 if (sandbox)
3926 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003927 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003928 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003929 fp->uf_flags = flags;
3930 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003931 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003932 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003933 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003934 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003935 if (is_export)
3936 {
3937 fp->uf_flags |= FC_EXPORT;
3938 // let ex_export() know the export worked.
3939 is_export = FALSE;
3940 }
3941
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003942 if (eap->cmdidx == CMD_def)
3943 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003944 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3945 // :func does not use Vim9 script syntax, even in a Vim9 script file
3946 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003947
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003948 goto ret_free;
3949
3950erret:
3951 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003952 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003953errret_2:
3954 ga_clear_strings(&newlines);
3955ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003956 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003958 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003959 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003960 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003961 if (name != name_arg)
3962 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003963 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003964 did_emsg |= saved_did_emsg;
3965 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003966
3967 return fp;
3968}
3969
3970/*
3971 * ":function"
3972 */
3973 void
3974ex_function(exarg_T *eap)
3975{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003976 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003977}
3978
3979/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003980 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01003981 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003982 */
3983 void
3984ex_defcompile(exarg_T *eap UNUSED)
3985{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003986 long todo = (long)func_hashtab.ht_used;
3987 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003988 hashitem_T *hi;
3989 ufunc_T *ufunc;
3990
3991 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3992 {
3993 if (!HASHITEM_EMPTY(hi))
3994 {
3995 --todo;
3996 ufunc = HI2UF(hi);
3997 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003998 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3999 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004000 {
Bram Moolenaarb2049902021-01-24 12:53:53 +01004001 compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004002
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004003 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004004 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004005 // a function has been added or removed, need to start over
4006 todo = (long)func_hashtab.ht_used;
4007 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004008 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004009 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004010 }
4011 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004012 }
4013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014}
4015
4016/*
4017 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4018 * Return 2 if "p" starts with "s:".
4019 * Return 0 otherwise.
4020 */
4021 int
4022eval_fname_script(char_u *p)
4023{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004024 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4025 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4027 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4028 return 5;
4029 if (p[0] == 's' && p[1] == ':')
4030 return 2;
4031 return 0;
4032}
4033
4034 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004035translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004036{
4037 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004038 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004039 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004040}
4041
4042/*
4043 * Return TRUE when "ufunc" has old-style "..." varargs
4044 * or named varargs "...name: type".
4045 */
4046 int
4047has_varargs(ufunc_T *ufunc)
4048{
4049 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050}
4051
4052/*
4053 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004054 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 */
4056 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004057function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058{
4059 char_u *nm = name;
4060 char_u *p;
4061 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004062 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004063 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004064
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004065 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4066 if (no_deref)
4067 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004068 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 nm = skipwhite(nm);
4070
Bram Moolenaare38eab22019-12-05 21:50:01 +01004071 // Only accept "funcname", "funcname ", "funcname (..." and
4072 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004074 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 vim_free(p);
4076 return n;
4077}
4078
Bram Moolenaar113e1072019-01-20 15:30:40 +01004079#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 char_u *
4081get_expanded_name(char_u *name, int check)
4082{
4083 char_u *nm = name;
4084 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004085 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004087 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004088 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004089
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004090 if (p != NULL && *nm == NUL
4091 && (!check || translated_function_exists(p, is_global)))
4092 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093
4094 vim_free(p);
4095 return NULL;
4096}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004097#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004098
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099/*
4100 * Function given to ExpandGeneric() to obtain the list of user defined
4101 * function names.
4102 */
4103 char_u *
4104get_user_func_name(expand_T *xp, int idx)
4105{
4106 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004107 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 static hashitem_T *hi;
4109 ufunc_T *fp;
4110
4111 if (idx == 0)
4112 {
4113 done = 0;
4114 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004115 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004117 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 {
4119 if (done++ > 0)
4120 ++hi;
4121 while (HASHITEM_EMPTY(hi))
4122 ++hi;
4123 fp = HI2UF(hi);
4124
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004125 // don't show dead, dict and lambda functions
4126 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004127 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004128 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129
4130 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004131 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004132
4133 cat_func_name(IObuff, fp);
4134 if (xp->xp_context != EXPAND_USER_FUNC)
4135 {
4136 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004137 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138 STRCAT(IObuff, ")");
4139 }
4140 return IObuff;
4141 }
4142 return NULL;
4143}
4144
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145/*
4146 * ":delfunction {name}"
4147 */
4148 void
4149ex_delfunction(exarg_T *eap)
4150{
4151 ufunc_T *fp = NULL;
4152 char_u *p;
4153 char_u *name;
4154 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004155 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156
4157 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004158 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4159 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004160 vim_free(fudi.fd_newkey);
4161 if (name == NULL)
4162 {
4163 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004164 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 return;
4166 }
4167 if (!ends_excmd(*skipwhite(p)))
4168 {
4169 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004170 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004171 return;
4172 }
4173 eap->nextcmd = check_nextcmd(p);
4174 if (eap->nextcmd != NULL)
4175 *p = NUL;
4176
4177 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004178 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004179 vim_free(name);
4180
4181 if (!eap->skip)
4182 {
4183 if (fp == NULL)
4184 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004185 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004186 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 return;
4188 }
4189 if (fp->uf_calls > 0)
4190 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004191 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192 return;
4193 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004194 if (fp->uf_flags & FC_VIM9)
4195 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004196 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004197 return;
4198 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199
4200 if (fudi.fd_dict != NULL)
4201 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004202 // Delete the dict item that refers to the function, it will
4203 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4205 }
4206 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004207 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004208 // A normal function (not a numbered function or lambda) has a
4209 // refcount of 1 for the entry in the hashtable. When deleting
4210 // it and the refcount is more than one, it should be kept.
4211 // A numbered function and lambda should be kept if the refcount is
4212 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004213 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004214 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004215 // Function is still referenced somewhere. Don't free it but
4216 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004217 if (func_remove(fp))
4218 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004219 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004220 }
4221 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004222 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004223 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004224 }
4225}
4226
4227/*
4228 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004229 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004230 */
4231 void
4232func_unref(char_u *name)
4233{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004234 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004236 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004237 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004238 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004239 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004240 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004242 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004244 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004246 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004247}
4248
4249/*
4250 * Unreference a Function: decrement the reference count and free it when it
4251 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004252 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004253 */
4254 void
4255func_ptr_unref(ufunc_T *fp)
4256{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004257 if (fp != NULL && (--fp->uf_refcount <= 0
4258 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4259 && fp->uf_partial->pt_refcount <= 1
4260 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004261 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004262 // Only delete it when it's not being used. Otherwise it's done
4263 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004264 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004265 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004266 }
4267}
4268
4269/*
4270 * Count a reference to a Function.
4271 */
4272 void
4273func_ref(char_u *name)
4274{
4275 ufunc_T *fp;
4276
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004277 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004279 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004280 if (fp != NULL)
4281 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004283 // Only give an error for a numbered function.
4284 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004285 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004286}
4287
4288/*
4289 * Count a reference to a Function.
4290 */
4291 void
4292func_ptr_ref(ufunc_T *fp)
4293{
4294 if (fp != NULL)
4295 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296}
4297
4298/*
4299 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4300 * referenced from anywhere that is in use.
4301 */
4302 static int
4303can_free_funccal(funccall_T *fc, int copyID)
4304{
4305 return (fc->l_varlist.lv_copyID != copyID
4306 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004307 && fc->l_avars.dv_copyID != copyID
4308 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309}
4310
4311/*
4312 * ":return [expr]"
4313 */
4314 void
4315ex_return(exarg_T *eap)
4316{
4317 char_u *arg = eap->arg;
4318 typval_T rettv;
4319 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004320 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321
4322 if (current_funccal == NULL)
4323 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004324 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 return;
4326 }
4327
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004328 CLEAR_FIELD(evalarg);
4329 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4330
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004331 if (eap->skip)
4332 ++emsg_skip;
4333
4334 eap->nextcmd = NULL;
4335 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004336 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 {
4338 if (!eap->skip)
4339 returning = do_return(eap, FALSE, TRUE, &rettv);
4340 else
4341 clear_tv(&rettv);
4342 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004343 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344 else if (!eap->skip)
4345 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004346 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004347 update_force_abort();
4348
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 /*
4350 * Return unless the expression evaluation has been cancelled due to an
4351 * aborting error, an interrupt, or an exception.
4352 */
4353 if (!aborting())
4354 returning = do_return(eap, FALSE, TRUE, NULL);
4355 }
4356
Bram Moolenaare38eab22019-12-05 21:50:01 +01004357 // When skipping or the return gets pending, advance to the next command
4358 // in this line (!returning). Otherwise, ignore the rest of the line.
4359 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004360 if (returning)
4361 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004362 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363 eap->nextcmd = check_nextcmd(arg);
4364
4365 if (eap->skip)
4366 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004367 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368}
4369
4370/*
4371 * ":1,25call func(arg1, arg2)" function call.
4372 */
4373 void
4374ex_call(exarg_T *eap)
4375{
4376 char_u *arg = eap->arg;
4377 char_u *startarg;
4378 char_u *name;
4379 char_u *tofree;
4380 int len;
4381 typval_T rettv;
4382 linenr_T lnum;
4383 int doesrange;
4384 int failed = FALSE;
4385 funcdict_T fudi;
4386 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004387 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004388 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389
Bram Moolenaare6b53242020-07-01 17:28:33 +02004390 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004391 if (eap->skip)
4392 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004393 // trans_function_name() doesn't work well when skipping, use eval0()
4394 // instead to skip to any following command, e.g. for:
4395 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004397 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 clear_tv(&rettv);
4399 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004400 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401 return;
4402 }
4403
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004404 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4405 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406 if (fudi.fd_newkey != NULL)
4407 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004408 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004409 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004410 vim_free(fudi.fd_newkey);
4411 }
4412 if (tofree == NULL)
4413 return;
4414
Bram Moolenaare38eab22019-12-05 21:50:01 +01004415 // Increase refcount on dictionary, it could get deleted when evaluating
4416 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004417 if (fudi.fd_dict != NULL)
4418 ++fudi.fd_dict->dv_refcount;
4419
Bram Moolenaare38eab22019-12-05 21:50:01 +01004420 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4421 // contents. For VAR_PARTIAL get its partial, unless we already have one
4422 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004423 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004424 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4425 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426
Bram Moolenaare38eab22019-12-05 21:50:01 +01004427 // Skip white space to allow ":call func ()". Not good, but required for
4428 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004430 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431
4432 if (*startarg != '(')
4433 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004434 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004435 goto end;
4436 }
4437
4438 /*
4439 * When skipping, evaluate the function once, to find the end of the
4440 * arguments.
4441 * When the function takes a range, this is discovered after the first
4442 * call, and the loop is broken.
4443 */
4444 if (eap->skip)
4445 {
4446 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004447 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004448 }
4449 else
4450 lnum = eap->line1;
4451 for ( ; lnum <= eap->line2; ++lnum)
4452 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004453 funcexe_T funcexe;
4454
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 if (!eap->skip && eap->addr_count > 0)
4456 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004457 if (lnum > curbuf->b_ml.ml_line_count)
4458 {
4459 // If the function deleted lines or switched to another buffer
4460 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004461 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004462 break;
4463 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 curwin->w_cursor.lnum = lnum;
4465 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 }
4468 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004469
Bram Moolenaara80faa82020-04-12 19:37:17 +02004470 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004471 funcexe.firstline = eap->line1;
4472 funcexe.lastline = eap->line2;
4473 funcexe.doesrange = &doesrange;
4474 funcexe.evaluate = !eap->skip;
4475 funcexe.partial = partial;
4476 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004477 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004478 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479 {
4480 failed = TRUE;
4481 break;
4482 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004483 if (has_watchexpr())
4484 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004486 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004487 if (handle_subscript(&arg, &rettv,
4488 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 {
4490 failed = TRUE;
4491 break;
4492 }
4493
4494 clear_tv(&rettv);
4495 if (doesrange || eap->skip)
4496 break;
4497
Bram Moolenaare38eab22019-12-05 21:50:01 +01004498 // Stop when immediately aborting on error, or when an interrupt
4499 // occurred or an exception was thrown but not caught.
4500 // get_func_tv() returned OK, so that the check for trailing
4501 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502 if (aborting())
4503 break;
4504 }
4505 if (eap->skip)
4506 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004507 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508
Bram Moolenaare51bb172020-02-16 19:42:23 +01004509 // When inside :try we need to check for following "| catch".
4510 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004512 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004513 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004514 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004516 if (!failed)
4517 {
4518 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004519 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004520 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004521 }
4522 else
4523 eap->nextcmd = check_nextcmd(arg);
4524 }
4525
4526end:
4527 dict_unref(fudi.fd_dict);
4528 vim_free(tofree);
4529}
4530
4531/*
4532 * Return from a function. Possibly makes the return pending. Also called
4533 * for a pending return at the ":endtry" or after returning from an extra
4534 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4535 * when called due to a ":return" command. "rettv" may point to a typval_T
4536 * with the return rettv. Returns TRUE when the return can be carried out,
4537 * FALSE when the return gets pending.
4538 */
4539 int
4540do_return(
4541 exarg_T *eap,
4542 int reanimate,
4543 int is_cmd,
4544 void *rettv)
4545{
4546 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004547 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548
4549 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004550 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551 current_funccal->returned = FALSE;
4552
4553 /*
4554 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4555 * not in its finally clause (which then is to be executed next) is found.
4556 * In this case, make the ":return" pending for execution at the ":endtry".
4557 * Otherwise, return normally.
4558 */
4559 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4560 if (idx >= 0)
4561 {
4562 cstack->cs_pending[idx] = CSTP_RETURN;
4563
4564 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004565 // A pending return again gets pending. "rettv" points to an
4566 // allocated variable with the rettv of the original ":return"'s
4567 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568 cstack->cs_rettv[idx] = rettv;
4569 else
4570 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004571 // When undoing a return in order to make it pending, get the stored
4572 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 if (reanimate)
4574 rettv = current_funccal->rettv;
4575
4576 if (rettv != NULL)
4577 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004578 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004579 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4580 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4581 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004582 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004583 }
4584 else
4585 cstack->cs_rettv[idx] = NULL;
4586
4587 if (reanimate)
4588 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004589 // The pending return value could be overwritten by a ":return"
4590 // without argument in a finally clause; reset the default
4591 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004592 current_funccal->rettv->v_type = VAR_NUMBER;
4593 current_funccal->rettv->vval.v_number = 0;
4594 }
4595 }
4596 report_make_pending(CSTP_RETURN, rettv);
4597 }
4598 else
4599 {
4600 current_funccal->returned = TRUE;
4601
Bram Moolenaare38eab22019-12-05 21:50:01 +01004602 // If the return is carried out now, store the return value. For
4603 // a return immediately after reanimation, the value is already
4604 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004605 if (!reanimate && rettv != NULL)
4606 {
4607 clear_tv(current_funccal->rettv);
4608 *current_funccal->rettv = *(typval_T *)rettv;
4609 if (!is_cmd)
4610 vim_free(rettv);
4611 }
4612 }
4613
4614 return idx < 0;
4615}
4616
4617/*
4618 * Free the variable with a pending return value.
4619 */
4620 void
4621discard_pending_return(void *rettv)
4622{
4623 free_tv((typval_T *)rettv);
4624}
4625
4626/*
4627 * Generate a return command for producing the value of "rettv". The result
4628 * is an allocated string. Used by report_pending() for verbose messages.
4629 */
4630 char_u *
4631get_return_cmd(void *rettv)
4632{
4633 char_u *s = NULL;
4634 char_u *tofree = NULL;
4635 char_u numbuf[NUMBUFLEN];
4636
4637 if (rettv != NULL)
4638 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4639 if (s == NULL)
4640 s = (char_u *)"";
4641
4642 STRCPY(IObuff, ":return ");
4643 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4644 if (STRLEN(s) + 8 >= IOSIZE)
4645 STRCPY(IObuff + IOSIZE - 4, "...");
4646 vim_free(tofree);
4647 return vim_strsave(IObuff);
4648}
4649
4650/*
4651 * Get next function line.
4652 * Called by do_cmdline() to get the next line.
4653 * Returns allocated string, or NULL for end of function.
4654 */
4655 char_u *
4656get_func_line(
4657 int c UNUSED,
4658 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004659 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004660 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661{
4662 funccall_T *fcp = (funccall_T *)cookie;
4663 ufunc_T *fp = fcp->func;
4664 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004665 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004666
Bram Moolenaare38eab22019-12-05 21:50:01 +01004667 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 if (fcp->dbg_tick != debug_tick)
4669 {
4670 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004671 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 fcp->dbg_tick = debug_tick;
4673 }
4674#ifdef FEAT_PROFILE
4675 if (do_profiling == PROF_YES)
4676 func_line_end(cookie);
4677#endif
4678
4679 gap = &fp->uf_lines;
4680 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4681 || fcp->returned)
4682 retval = NULL;
4683 else
4684 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004685 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 while (fcp->linenr < gap->ga_len
4687 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4688 ++fcp->linenr;
4689 if (fcp->linenr >= gap->ga_len)
4690 retval = NULL;
4691 else
4692 {
4693 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004694 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004695#ifdef FEAT_PROFILE
4696 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004697 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698#endif
4699 }
4700 }
4701
Bram Moolenaare38eab22019-12-05 21:50:01 +01004702 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004703 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004704 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004705 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004706 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004708 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004709 fcp->dbg_tick = debug_tick;
4710 }
4711
4712 return retval;
4713}
4714
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715/*
4716 * Return TRUE if the currently active function should be ended, because a
4717 * return was encountered or an error occurred. Used inside a ":while".
4718 */
4719 int
4720func_has_ended(void *cookie)
4721{
4722 funccall_T *fcp = (funccall_T *)cookie;
4723
Bram Moolenaare38eab22019-12-05 21:50:01 +01004724 // Ignore the "abort" flag if the abortion behavior has been changed due to
4725 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4727 || fcp->returned);
4728}
4729
4730/*
4731 * return TRUE if cookie indicates a function which "abort"s on errors.
4732 */
4733 int
4734func_has_abort(
4735 void *cookie)
4736{
4737 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4738}
4739
4740
4741/*
4742 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4743 * Don't do this when "Func" is already a partial that was bound
4744 * explicitly (pt_auto is FALSE).
4745 * Changes "rettv" in-place.
4746 * Returns the updated "selfdict_in".
4747 */
4748 dict_T *
4749make_partial(dict_T *selfdict_in, typval_T *rettv)
4750{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004751 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004752 char_u *tofree = NULL;
4753 ufunc_T *fp;
4754 char_u fname_buf[FLEN_FIXED + 1];
4755 int error;
4756 dict_T *selfdict = selfdict_in;
4757
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004758 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4759 fp = rettv->vval.v_partial->pt_func;
4760 else
4761 {
4762 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4763 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004764 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004765 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004766 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004767 vim_free(tofree);
4768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004769
4770 if (fp != NULL && (fp->uf_flags & FC_DICT))
4771 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004772 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773
4774 if (pt != NULL)
4775 {
4776 pt->pt_refcount = 1;
4777 pt->pt_dict = selfdict;
4778 pt->pt_auto = TRUE;
4779 selfdict = NULL;
4780 if (rettv->v_type == VAR_FUNC)
4781 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004782 // Just a function: Take over the function name and use
4783 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 pt->pt_name = rettv->vval.v_string;
4785 }
4786 else
4787 {
4788 partial_T *ret_pt = rettv->vval.v_partial;
4789 int i;
4790
Bram Moolenaare38eab22019-12-05 21:50:01 +01004791 // Partial: copy the function name, use selfdict and copy
4792 // args. Can't take over name or args, the partial might
4793 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004794 if (ret_pt->pt_name != NULL)
4795 {
4796 pt->pt_name = vim_strsave(ret_pt->pt_name);
4797 func_ref(pt->pt_name);
4798 }
4799 else
4800 {
4801 pt->pt_func = ret_pt->pt_func;
4802 func_ptr_ref(pt->pt_func);
4803 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 if (ret_pt->pt_argc > 0)
4805 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004806 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004808 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 pt->pt_argc = 0;
4810 else
4811 {
4812 pt->pt_argc = ret_pt->pt_argc;
4813 for (i = 0; i < pt->pt_argc; i++)
4814 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4815 }
4816 }
4817 partial_unref(ret_pt);
4818 }
4819 rettv->v_type = VAR_PARTIAL;
4820 rettv->vval.v_partial = pt;
4821 }
4822 }
4823 return selfdict;
4824}
4825
4826/*
4827 * Return the name of the executed function.
4828 */
4829 char_u *
4830func_name(void *cookie)
4831{
4832 return ((funccall_T *)cookie)->func->uf_name;
4833}
4834
4835/*
4836 * Return the address holding the next breakpoint line for a funccall cookie.
4837 */
4838 linenr_T *
4839func_breakpoint(void *cookie)
4840{
4841 return &((funccall_T *)cookie)->breakpoint;
4842}
4843
4844/*
4845 * Return the address holding the debug tick for a funccall cookie.
4846 */
4847 int *
4848func_dbg_tick(void *cookie)
4849{
4850 return &((funccall_T *)cookie)->dbg_tick;
4851}
4852
4853/*
4854 * Return the nesting level for a funccall cookie.
4855 */
4856 int
4857func_level(void *cookie)
4858{
4859 return ((funccall_T *)cookie)->level;
4860}
4861
4862/*
4863 * Return TRUE when a function was ended by a ":return" command.
4864 */
4865 int
4866current_func_returned(void)
4867{
4868 return current_funccal->returned;
4869}
4870
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004871 int
4872free_unref_funccal(int copyID, int testing)
4873{
4874 int did_free = FALSE;
4875 int did_free_funccal = FALSE;
4876 funccall_T *fc, **pfc;
4877
4878 for (pfc = &previous_funccal; *pfc != NULL; )
4879 {
4880 if (can_free_funccal(*pfc, copyID))
4881 {
4882 fc = *pfc;
4883 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004884 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004885 did_free = TRUE;
4886 did_free_funccal = TRUE;
4887 }
4888 else
4889 pfc = &(*pfc)->caller;
4890 }
4891 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004892 // When a funccal was freed some more items might be garbage
4893 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894 (void)garbage_collect(testing);
4895
4896 return did_free;
4897}
4898
4899/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004900 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 */
4902 static funccall_T *
4903get_funccal(void)
4904{
4905 int i;
4906 funccall_T *funccal;
4907 funccall_T *temp_funccal;
4908
4909 funccal = current_funccal;
4910 if (debug_backtrace_level > 0)
4911 {
4912 for (i = 0; i < debug_backtrace_level; i++)
4913 {
4914 temp_funccal = funccal->caller;
4915 if (temp_funccal)
4916 funccal = temp_funccal;
4917 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004918 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 debug_backtrace_level = i;
4920 }
4921 }
4922 return funccal;
4923}
4924
4925/*
4926 * Return the hashtable used for local variables in the current funccal.
4927 * Return NULL if there is no current funccal.
4928 */
4929 hashtab_T *
4930get_funccal_local_ht()
4931{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004932 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004933 return NULL;
4934 return &get_funccal()->l_vars.dv_hashtab;
4935}
4936
4937/*
4938 * Return the l: scope variable.
4939 * Return NULL if there is no current funccal.
4940 */
4941 dictitem_T *
4942get_funccal_local_var()
4943{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004944 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 return NULL;
4946 return &get_funccal()->l_vars_var;
4947}
4948
4949/*
4950 * Return the hashtable used for argument in the current funccal.
4951 * Return NULL if there is no current funccal.
4952 */
4953 hashtab_T *
4954get_funccal_args_ht()
4955{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004956 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957 return NULL;
4958 return &get_funccal()->l_avars.dv_hashtab;
4959}
4960
4961/*
4962 * Return the a: scope variable.
4963 * Return NULL if there is no current funccal.
4964 */
4965 dictitem_T *
4966get_funccal_args_var()
4967{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004968 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004970 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004971}
4972
4973/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974 * List function variables, if there is a function.
4975 */
4976 void
4977list_func_vars(int *first)
4978{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004979 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004981 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982}
4983
4984/*
4985 * If "ht" is the hashtable for local variables in the current funccal, return
4986 * the dict that contains it.
4987 * Otherwise return NULL.
4988 */
4989 dict_T *
4990get_current_funccal_dict(hashtab_T *ht)
4991{
4992 if (current_funccal != NULL
4993 && ht == &current_funccal->l_vars.dv_hashtab)
4994 return &current_funccal->l_vars;
4995 return NULL;
4996}
4997
4998/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004999 * Search hashitem in parent scope.
5000 */
5001 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005002find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005003{
5004 funccall_T *old_current_funccal = current_funccal;
5005 hashtab_T *ht;
5006 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005007 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005008
5009 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5010 return NULL;
5011
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005012 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005013 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005014 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005015 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005016 ht = find_var_ht(name, &varname);
5017 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005018 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005019 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005020 if (!HASHITEM_EMPTY(hi))
5021 {
5022 *pht = ht;
5023 break;
5024 }
5025 }
5026 if (current_funccal == current_funccal->func->uf_scoped)
5027 break;
5028 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005029 }
5030 current_funccal = old_current_funccal;
5031
5032 return hi;
5033}
5034
5035/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005036 * Search variable in parent scope.
5037 */
5038 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005039find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005040{
5041 dictitem_T *v = NULL;
5042 funccall_T *old_current_funccal = current_funccal;
5043 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005044 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005045
5046 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5047 return NULL;
5048
Bram Moolenaare38eab22019-12-05 21:50:01 +01005049 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005050 current_funccal = current_funccal->func->uf_scoped;
5051 while (current_funccal)
5052 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005053 ht = find_var_ht(name, &varname);
5054 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005055 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005056 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005057 if (v != NULL)
5058 break;
5059 }
5060 if (current_funccal == current_funccal->func->uf_scoped)
5061 break;
5062 current_funccal = current_funccal->func->uf_scoped;
5063 }
5064 current_funccal = old_current_funccal;
5065
5066 return v;
5067}
5068
5069/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005070 * Set "copyID + 1" in previous_funccal and callers.
5071 */
5072 int
5073set_ref_in_previous_funccal(int copyID)
5074{
5075 int abort = FALSE;
5076 funccall_T *fc;
5077
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005078 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005079 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005080 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005081 abort = abort
5082 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5083 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005084 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005085 }
5086 return abort;
5087}
5088
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005089 static int
5090set_ref_in_funccal(funccall_T *fc, int copyID)
5091{
5092 int abort = FALSE;
5093
5094 if (fc->fc_copyID != copyID)
5095 {
5096 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005097 abort = abort
5098 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5099 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005100 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005101 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005102 }
5103 return abort;
5104}
5105
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005106/*
5107 * Set "copyID" in all local vars and arguments in the call stack.
5108 */
5109 int
5110set_ref_in_call_stack(int copyID)
5111{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005112 int abort = FALSE;
5113 funccall_T *fc;
5114 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005116 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005117 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005118
5119 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005120 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5121 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005122 abort = abort || set_ref_in_funccal(fc, copyID);
5123
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005124 return abort;
5125}
5126
5127/*
5128 * Set "copyID" in all functions available by name.
5129 */
5130 int
5131set_ref_in_functions(int copyID)
5132{
5133 int todo;
5134 hashitem_T *hi = NULL;
5135 int abort = FALSE;
5136 ufunc_T *fp;
5137
5138 todo = (int)func_hashtab.ht_used;
5139 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005140 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005141 if (!HASHITEM_EMPTY(hi))
5142 {
5143 --todo;
5144 fp = HI2UF(hi);
5145 if (!func_name_refcount(fp->uf_name))
5146 abort = abort || set_ref_in_func(NULL, fp, copyID);
5147 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005148 }
5149 return abort;
5150}
5151
5152/*
5153 * Set "copyID" in all function arguments.
5154 */
5155 int
5156set_ref_in_func_args(int copyID)
5157{
5158 int i;
5159 int abort = FALSE;
5160
5161 for (i = 0; i < funcargs.ga_len; ++i)
5162 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5163 copyID, NULL, NULL);
5164 return abort;
5165}
5166
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005167/*
5168 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005169 * Returns TRUE if setting references failed somehow.
5170 */
5171 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005172set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005173{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005174 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005175 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005176 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005177 char_u fname_buf[FLEN_FIXED + 1];
5178 char_u *tofree = NULL;
5179 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005180 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005181
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005182 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005183 return FALSE;
5184
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005185 if (fp_in == NULL)
5186 {
5187 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005188 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005189 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005190 if (fp != NULL)
5191 {
5192 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005193 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005194 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005195
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005196 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005197 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005198}
5199
Bram Moolenaare38eab22019-12-05 21:50:01 +01005200#endif // FEAT_EVAL