blob: 701edaf30ddb2de626c416efaef8ed2b14f1ea3d [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058 * Return a pointer to after the type.
59 * When something is wrong return "arg".
60 */
61 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010062one_function_arg(
63 char_u *arg,
64 garray_T *newargs,
65 garray_T *argtypes,
66 int types_optional,
67 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010068{
Bram Moolenaar6e949782020-04-13 17:21:00 +020069 char_u *p = arg;
70 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010071
72 while (ASCII_ISALNUM(*p) || *p == '_')
73 ++p;
74 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020075 || (argtypes == NULL
76 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
77 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010078 {
79 if (!skip)
80 semsg(_("E125: Illegal argument: %s"), arg);
81 return arg;
82 }
83 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
84 return arg;
85 if (newargs != NULL)
86 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010087 int c;
88 int i;
89
90 c = *p;
91 *p = NUL;
92 arg_copy = vim_strsave(arg);
93 if (arg_copy == NULL)
94 {
95 *p = c;
96 return arg;
97 }
98
99 // Check for duplicate argument name.
100 for (i = 0; i < newargs->ga_len; ++i)
101 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
102 {
103 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
104 vim_free(arg_copy);
105 return arg;
106 }
107 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
108 newargs->ga_len++;
109
110 *p = c;
111 }
112
113 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100114 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100115 {
116 char_u *type = NULL;
117
Bram Moolenaar6e949782020-04-13 17:21:00 +0200118 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
119 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200120 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200121 arg_copy == NULL ? arg : arg_copy);
122 p = skipwhite(p);
123 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 if (*p == ':')
125 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200126 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100127 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200128 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200129 semsg(_(e_white_space_required_after_str), ":");
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200130 return arg;
131 }
132 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200133 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100134 if (!skip)
135 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100136 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100137 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200138 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200139 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200140 arg_copy == NULL ? arg : arg_copy);
141 return arg;
142 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 {
145 if (type == NULL && types_optional)
146 // lambda arguments default to "any" type
147 type = vim_strsave((char_u *)"any");
148 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
149 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
151
152 return p;
153}
154
155/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200156 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100157 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100158 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200159 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100160 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200161get_function_args(
162 char_u **argp,
163 char_u endchar,
164 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100166 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200167 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200168 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200169 int skip,
170 exarg_T *eap,
171 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200172{
173 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100174 char_u *arg;
175 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200176 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200177 int any_default = FALSE;
178 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100179 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200180
181 if (newargs != NULL)
182 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183 if (argtypes != NULL)
184 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200185 if (default_args != NULL)
186 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200187
188 if (varargs != NULL)
189 *varargs = FALSE;
190
191 /*
192 * Isolate the arguments: "arg1, arg2, ...)"
193 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100194 arg = skipwhite(*argp);
195 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200196 while (*p != endchar)
197 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200198 while (eap != NULL && eap->getline != NULL
199 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200200 {
201 char_u *theline;
202
203 // End of the line, get the next one.
204 theline = eap->getline(':', eap->cookie, 0, TRUE);
205 if (theline == NULL)
206 break;
207 vim_free(*line_to_free);
208 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200209 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 p = skipwhite(theline);
211 }
212
213 if (mustend && *p != endchar)
214 {
215 if (!skip)
216 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100217 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200218 }
219 if (*p == endchar)
220 break;
221
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
223 {
224 if (varargs != NULL)
225 *varargs = TRUE;
226 p += 3;
227 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100228
229 if (argtypes != NULL)
230 {
231 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200232 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100233 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100234 if (!skip)
235 emsg(_(e_missing_name_after_dots));
236 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100237 }
238
239 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100240 p = one_function_arg(p, newargs, argtypes, types_optional,
241 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242 if (p == arg)
243 break;
244 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200245 }
246 else
247 {
248 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100249 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100250 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200251 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200252
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200253 if (*skipwhite(p) == '=' && default_args != NULL)
254 {
255 typval_T rettv;
256
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100257 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200258 any_default = TRUE;
259 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200260 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200261 p = skipwhite(p);
262 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200263 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200264 {
265 if (ga_grow(default_args, 1) == FAIL)
266 goto err_ret;
267
268 // trim trailing whitespace
269 while (p > expr && VIM_ISWHITE(p[-1]))
270 p--;
271 c = *p;
272 *p = NUL;
273 expr = vim_strsave(expr);
274 if (expr == NULL)
275 {
276 *p = c;
277 goto err_ret;
278 }
279 ((char_u **)(default_args->ga_data))
280 [default_args->ga_len] = expr;
281 default_args->ga_len++;
282 *p = c;
283 }
284 else
285 mustend = TRUE;
286 }
287 else if (any_default)
288 {
289 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200290 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200291 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200292 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200293 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200295 // Don't give this error when skipping, it makes the "->" not
296 // found in "{k,v -> x}" and give a confusing error.
297 if (!skip && in_vim9script()
298 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
299 {
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200300 semsg(_(e_white_space_required_after_str), ",");
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200301 goto err_ret;
302 }
303 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304 else
305 mustend = TRUE;
306 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200307 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200309 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200310
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200311 if (*p != endchar)
312 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100313 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200314
315 *argp = p;
316 return OK;
317
318err_ret:
319 if (newargs != NULL)
320 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200321 if (default_args != NULL)
322 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 return FAIL;
324}
325
326/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100327 * Parse the argument types, filling "fp->uf_arg_types".
328 * Return OK or FAIL.
329 */
330 static int
331parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
332{
333 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
334 if (argtypes->ga_len > 0)
335 {
336 // When "varargs" is set the last name/type goes into uf_va_name
337 // and uf_va_type.
338 int len = argtypes->ga_len - (varargs ? 1 : 0);
339
340 if (len > 0)
341 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
342 if (fp->uf_arg_types != NULL)
343 {
344 int i;
345 type_T *type;
346
347 for (i = 0; i < len; ++ i)
348 {
349 char_u *p = ((char_u **)argtypes->ga_data)[i];
350
351 if (p == NULL)
352 // will get the type from the default value
353 type = &t_unknown;
354 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100355 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100356 if (type == NULL)
357 return FAIL;
358 fp->uf_arg_types[i] = type;
359 }
360 }
361 if (varargs)
362 {
363 char_u *p;
364
365 // Move the last argument "...name: type" to uf_va_name and
366 // uf_va_type.
367 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
368 [fp->uf_args.ga_len - 1];
369 --fp->uf_args.ga_len;
370 p = ((char_u **)argtypes->ga_data)[len];
371 if (p == NULL)
372 // todo: get type from default value
373 fp->uf_va_type = &t_any;
374 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100375 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100376 if (fp->uf_va_type == NULL)
377 return FAIL;
378 }
379 }
380 return OK;
381}
382
383/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200384 * Register function "fp" as using "current_funccal" as its scope.
385 */
386 static int
387register_closure(ufunc_T *fp)
388{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200389 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100390 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200391 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200392 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200393 fp->uf_scoped = current_funccal;
394 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200395
Bram Moolenaar58016442016-07-31 18:30:22 +0200396 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
397 return FAIL;
398 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
399 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200400 return OK;
401}
402
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100403 static void
404set_ufunc_name(ufunc_T *fp, char_u *name)
405{
406 STRCPY(fp->uf_name, name);
407
408 if (name[0] == K_SPECIAL)
409 {
410 fp->uf_name_exp = alloc(STRLEN(name) + 3);
411 if (fp->uf_name_exp != NULL)
412 {
413 STRCPY(fp->uf_name_exp, "<SNR>");
414 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
415 }
416 }
417}
418
Bram Moolenaar58016442016-07-31 18:30:22 +0200419/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200420 * Get a name for a lambda. Returned in static memory.
421 */
422 char_u *
423get_lambda_name(void)
424{
425 static char_u name[30];
426 static int lambda_no = 0;
427
428 sprintf((char*)name, "<lambda>%d", ++lambda_no);
429 return name;
430}
431
Bram Moolenaar801ab062020-06-25 19:27:56 +0200432#if defined(FEAT_LUA) || defined(PROTO)
433/*
434 * Registers a native C callback which can be called from Vim script.
435 * Returns the name of the Vim script function.
436 */
437 char_u *
438register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
439{
440 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200441 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200442
443 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
444 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200445 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200446
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200447 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200448 fp->uf_refcount = 1;
449 fp->uf_varargs = TRUE;
450 fp->uf_flags = FC_CFUNC;
451 fp->uf_calls = 0;
452 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200453 fp->uf_cb = cb;
454 fp->uf_cb_free = cb_free;
455 fp->uf_cb_state = state;
456
457 set_ufunc_name(fp, name);
458 hash_add(&func_hashtab, UF2HIKEY(fp));
459
460 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200461}
462#endif
463
Bram Moolenaar04b12692020-05-04 23:24:44 +0200464/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100465 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100466 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100467 * If "white_error" is not NULL check for correct use of white space and set
468 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100469 * Return NULL if no valid arrow found.
470 */
471 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100472skip_arrow(
473 char_u *start,
474 int equal_arrow,
475 char_u **ret_type,
476 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100477{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100478 char_u *s = start;
479 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100480
481 if (equal_arrow)
482 {
483 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100484 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100485 if (white_error != NULL && !VIM_ISWHITE(s[1]))
486 {
487 *white_error = TRUE;
488 semsg(_(e_white_space_required_after_str), ":");
489 return NULL;
490 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100491 s = skipwhite(s + 1);
492 *ret_type = s;
493 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100494 if (s == *ret_type)
495 {
496 emsg(_(e_missing_return_type));
497 return NULL;
498 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100499 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100500 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100501 s = skipwhite(s);
502 if (*s != '=')
503 return NULL;
504 ++s;
505 }
506 if (*s != '>')
507 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100508 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
509 || !IS_WHITE_OR_NUL(s[1])))
510 {
511 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100512 semsg(_(e_white_space_required_before_and_after_str_at_str),
513 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100514 return NULL;
515 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100516 return skipwhite(s + 1);
517}
518
519/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200520 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100521 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100522 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200523 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
524 */
525 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100526get_lambda_tv(
527 char_u **arg,
528 typval_T *rettv,
529 int types_optional,
530 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200531{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200532 int evaluate = evalarg != NULL
533 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200534 garray_T newargs;
535 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200536 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100537 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200538 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100539 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200540 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100541 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200542 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200543 char_u *s;
544 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200545 int *old_eval_lavars = eval_lavars_used;
546 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100547 char_u *tofree1 = NULL;
548 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100549 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100550 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +0100551 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100552
553 if (equal_arrow && !in_vim9script())
554 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200555
556 ga_init(&newargs);
557 ga_init(&newlines);
558
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100559 // First, check if this is really a lambda expression. "->" or "=>" must
560 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100561 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100562 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100563 types_optional ? &argtypes : NULL, types_optional,
564 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100566 {
567 if (types_optional)
568 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100569 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100570 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200571
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100572 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200573 if (evaluate)
574 pnewargs = &newargs;
575 else
576 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100577 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100578 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100579 types_optional ? &argtypes : NULL, types_optional,
580 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100581 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100582 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100583 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100584 {
585 if (types_optional)
586 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100587 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100588 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100589 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100590 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200591
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100592 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
593 if (ret_type != NULL)
594 {
595 ret_type = vim_strsave(ret_type);
596 tofree2 = ret_type;
597 }
598
Bram Moolenaare38eab22019-12-05 21:50:01 +0100599 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200600 if (evaluate)
601 eval_lavars_used = &eval_lavars;
602
Bram Moolenaar65c44152020-12-24 15:14:01 +0100603 *arg = skipwhite_and_linebreak(*arg, evalarg);
604
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100605 // Recognize "{" as the start of a function body.
606 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100607 {
608 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100609 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100610 emsg("Lambda function body not supported yet");
611 goto errret;
612 }
613
Bram Moolenaare38eab22019-12-05 21:50:01 +0100614 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200615 start = *arg;
616 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200617 if (ret == FAIL)
618 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200619 if (evalarg != NULL)
620 {
621 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100622 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200623 evalarg->eval_tofree = NULL;
624 }
625
Bram Moolenaar65c44152020-12-24 15:14:01 +0100626 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100627 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100628 *arg = skipwhite_and_linebreak(*arg, evalarg);
629 if (**arg != '}')
630 {
631 semsg(_("E451: Expected }: %s"), *arg);
632 goto errret;
633 }
634 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100635 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200636
637 if (evaluate)
638 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200639 int len;
640 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200641 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200642 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200643
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200644 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200645 if (fp == NULL)
646 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200647 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200648 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200649 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200650 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200651
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200652 ga_init2(&newlines, (int)sizeof(char_u *), 1);
653 if (ga_grow(&newlines, 1) == FAIL)
654 goto errret;
655
Bram Moolenaare38eab22019-12-05 21:50:01 +0100656 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200657 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200658 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200659 if (p == NULL)
660 goto errret;
661 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
662 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200663 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200664 if (strstr((char *)p + 7, "a:") == NULL)
665 // No a: variables are used for sure.
666 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200667
668 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100669 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200670 hash_add(&func_hashtab, UF2HIKEY(fp));
671 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200672 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100673 if (types_optional)
674 {
675 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
676 goto errret;
677 if (ret_type != NULL)
678 {
679 fp->uf_ret_type = parse_type(&ret_type,
680 &fp->uf_type_list, TRUE);
681 if (fp->uf_ret_type == NULL)
682 goto errret;
683 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100684 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100685 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100686 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100687
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200688 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200689 if (current_funccal != NULL && eval_lavars)
690 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200691 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200692 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200693 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200694 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200695
696#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200697 if (prof_def_func())
698 func_do_profile(fp);
699#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200700 if (sandbox)
701 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100702 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200703 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200704 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200705 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200706 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100707 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200708
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200709 pt->pt_func = fp;
710 pt->pt_refcount = 1;
711 rettv->vval.v_partial = pt;
712 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200713 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200714
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200715 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200716 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100717 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200718 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100719 vim_free(tofree1);
720 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100721 if (types_optional)
722 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200723 return OK;
724
725errret:
726 ga_clear_strings(&newargs);
727 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100728 if (types_optional)
729 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200730 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100731 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200732 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100733 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200734 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100735 vim_free(tofree1);
736 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200737 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200738 return FAIL;
739}
740
741/*
742 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
743 * name it contains, otherwise return "name".
744 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
745 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100746 * If "type" is not NULL and a Vim9 script-local variable is found look up the
747 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200748 */
749 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100750deref_func_name(
751 char_u *name,
752 int *lenp,
753 partial_T **partialp,
754 type_T **type,
755 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200756{
757 dictitem_T *v;
758 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100759 char_u *s = NULL;
760 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200761
762 if (partialp != NULL)
763 *partialp = NULL;
764
765 cc = name[*lenp];
766 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100767 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200768 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100769 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200770 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100771 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200772 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100773 if (v->di_tv.vval.v_string == NULL)
774 {
775 *lenp = 0;
776 return (char_u *)""; // just in case
777 }
778 s = v->di_tv.vval.v_string;
779 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200780 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200781
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100782 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200783 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100784 partial_T *pt = v->di_tv.vval.v_partial;
785
786 if (pt == NULL)
787 {
788 *lenp = 0;
789 return (char_u *)""; // just in case
790 }
791 if (partialp != NULL)
792 *partialp = pt;
793 s = partial_name(pt);
794 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200795 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100796
797 if (s != NULL)
798 {
799 if (type != NULL && ht == get_script_local_ht())
800 {
801 svar_T *sv = find_typval_in_script(&v->di_tv);
802
803 if (sv != NULL)
804 *type = sv->sv_type;
805 }
806 return s;
807 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200808 }
809
810 return name;
811}
812
813/*
814 * Give an error message with a function name. Handle <SNR> things.
815 * "ermsg" is to be passed without translation, use N_() instead of _().
816 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100817 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200818emsg_funcname(char *ermsg, char_u *name)
819{
820 char_u *p;
821
822 if (*name == K_SPECIAL)
823 p = concat_str((char_u *)"<SNR>", name + 3);
824 else
825 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100826 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200827 if (p != name)
828 vim_free(p);
829}
830
831/*
832 * Allocate a variable for the result of a function.
833 * Return OK or FAIL.
834 */
835 int
836get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200837 char_u *name, // name of the function
838 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200839 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200840 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200841 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200842 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200843{
844 char_u *argp;
845 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100846 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
847 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200848 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200849
850 /*
851 * Get the arguments.
852 */
853 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200854 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
855 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200856 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200857 // skip the '(' or ',' and possibly line breaks
858 argp = skipwhite_and_linebreak(argp + 1, evalarg);
859
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200860 if (*argp == ')' || *argp == ',' || *argp == NUL)
861 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200862 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200863 {
864 ret = FAIL;
865 break;
866 }
867 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200868 // The comma should come right after the argument, but this wasn't
869 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200870 if (vim9script)
871 {
872 if (*argp != ',' && *skipwhite(argp) == ',')
873 {
874 semsg(_(e_no_white_space_allowed_before_str), ",");
875 ret = FAIL;
876 break;
877 }
878 }
879 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200880 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200881 if (*argp != ',')
882 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200883 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
884 {
885 semsg(_(e_white_space_required_after_str), ",");
886 ret = FAIL;
887 break;
888 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200889 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200890 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200891 if (*argp == ')')
892 ++argp;
893 else
894 ret = FAIL;
895
896 if (ret == OK)
897 {
898 int i = 0;
899
900 if (get_vim_var_nr(VV_TESTING))
901 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100902 // Prepare for calling test_garbagecollect_now(), need to know
903 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200904 if (funcargs.ga_itemsize == 0)
905 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
906 for (i = 0; i < argcount; ++i)
907 if (ga_grow(&funcargs, 1) == OK)
908 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
909 &argvars[i];
910 }
911
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200912 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200913
914 funcargs.ga_len -= i;
915 }
916 else if (!aborting())
917 {
918 if (argcount == MAX_FUNC_ARGS)
919 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
920 else
921 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
922 }
923
924 while (--argcount >= 0)
925 clear_tv(&argvars[argcount]);
926
Bram Moolenaar8294d492020-08-10 22:40:56 +0200927 if (in_vim9script())
928 *arg = argp;
929 else
930 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200931 return ret;
932}
933
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200934/*
935 * Return TRUE if "p" starts with "<SID>" or "s:".
936 * Only works if eval_fname_script() returned non-zero for "p"!
937 */
938 static int
939eval_fname_sid(char_u *p)
940{
941 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
942}
943
944/*
945 * In a script change <SID>name() and s:name() to K_SNR 123_name().
946 * Change <SNR>123_name() to K_SNR 123_name().
947 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
948 * (slow).
949 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100950 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200951fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
952{
953 int llen;
954 char_u *fname;
955 int i;
956
957 llen = eval_fname_script(name);
958 if (llen > 0)
959 {
960 fname_buf[0] = K_SPECIAL;
961 fname_buf[1] = KS_EXTRA;
962 fname_buf[2] = (int)KE_SNR;
963 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100964 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200965 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200966 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100967 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200968 else
969 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200970 sprintf((char *)fname_buf + 3, "%ld_",
971 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200972 i = (int)STRLEN(fname_buf);
973 }
974 }
975 if (i + STRLEN(name + llen) < FLEN_FIXED)
976 {
977 STRCPY(fname_buf + i, name + llen);
978 fname = fname_buf;
979 }
980 else
981 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200982 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200983 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100984 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200985 else
986 {
987 *tofree = fname;
988 mch_memmove(fname, fname_buf, (size_t)i);
989 STRCPY(fname + i, name + llen);
990 }
991 }
992 }
993 else
994 fname = name;
995 return fname;
996}
997
998/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100999 * Find a function "name" in script "sid".
1000 */
1001 static ufunc_T *
1002find_func_with_sid(char_u *name, int sid)
1003{
1004 hashitem_T *hi;
1005 char_u buffer[200];
1006
1007 buffer[0] = K_SPECIAL;
1008 buffer[1] = KS_EXTRA;
1009 buffer[2] = (int)KE_SNR;
1010 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1011 (long)sid, name);
1012 hi = hash_find(&func_hashtab, buffer);
1013 if (!HASHITEM_EMPTY(hi))
1014 return HI2UF(hi);
1015
1016 return NULL;
1017}
1018
1019/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001020 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001021 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001022 * Return NULL for unknown function.
1023 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001024 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001025find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001026{
1027 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001028 ufunc_T *func;
1029 imported_T *imported;
1030
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001031 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001032 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001033 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001034 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001035 int find_script_local = in_vim9script()
1036 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001037
Bram Moolenaar95006e32020-08-29 17:47:08 +02001038 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001039 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001040 // Find script-local function before global one.
1041 func = find_func_with_sid(name, current_sctx.sc_sid);
1042 if (func != NULL)
1043 return func;
1044 }
1045
Bram Moolenaarefa94442020-08-08 22:16:00 +02001046 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001047 && name[1] == KS_EXTRA
1048 && name[2] == KE_SNR)
1049 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001050 // Caller changes s: to <SNR>99_name.
1051
1052 after_script = name + 3;
1053 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001054 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001055 ++after_script;
1056 else
1057 after_script = NULL;
1058 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001059 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001060 {
1061 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001062 if (after_script != NULL && sid != current_sctx.sc_sid)
1063 imported = find_imported_in_script(after_script, 0, sid);
1064 else
1065 imported = find_imported(after_script == NULL
1066 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001067 if (imported != NULL && imported->imp_funcname != NULL)
1068 {
1069 hi = hash_find(&func_hashtab, imported->imp_funcname);
1070 if (!HASHITEM_EMPTY(hi))
1071 return HI2UF(hi);
1072 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001073 }
1074 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001075
Bram Moolenaara26b9702020-04-18 19:53:28 +02001076 hi = hash_find(&func_hashtab,
1077 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001078 if (!HASHITEM_EMPTY(hi))
1079 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001080
1081 return NULL;
1082}
1083
1084/*
1085 * Find a function by name, return pointer to it in ufuncs.
1086 * "cctx" is passed in a :def function to find imported functions.
1087 * Return NULL for unknown or dead function.
1088 */
1089 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001090find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001091{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001092 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001093
1094 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1095 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001096 return NULL;
1097}
1098
1099/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001100 * Return TRUE if "ufunc" is a global function.
1101 */
1102 int
1103func_is_global(ufunc_T *ufunc)
1104{
1105 return ufunc->uf_name[0] != K_SPECIAL;
1106}
1107
1108/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001109 * Copy the function name of "fp" to buffer "buf".
1110 * "buf" must be able to hold the function name plus three bytes.
1111 * Takes care of script-local function names.
1112 */
1113 static void
1114cat_func_name(char_u *buf, ufunc_T *fp)
1115{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001116 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001117 {
1118 STRCPY(buf, "<SNR>");
1119 STRCAT(buf, fp->uf_name + 3);
1120 }
1121 else
1122 STRCPY(buf, fp->uf_name);
1123}
1124
1125/*
1126 * Add a number variable "name" to dict "dp" with value "nr".
1127 */
1128 static void
1129add_nr_var(
1130 dict_T *dp,
1131 dictitem_T *v,
1132 char *name,
1133 varnumber_T nr)
1134{
1135 STRCPY(v->di_key, name);
1136 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1137 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1138 v->di_tv.v_type = VAR_NUMBER;
1139 v->di_tv.v_lock = VAR_FIXED;
1140 v->di_tv.vval.v_number = nr;
1141}
1142
1143/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001144 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001145 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001146 static void
1147free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001148{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001149 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001150
1151 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1152 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001153 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001154
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001155 // When garbage collecting a funccall_T may be freed before the
1156 // function that references it, clear its uf_scoped field.
1157 // The function may have been redefined and point to another
1158 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001159 if (fp != NULL && fp->uf_scoped == fc)
1160 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001161 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001162 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001163
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001164 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001165 vim_free(fc);
1166}
1167
1168/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001169 * Free "fc" and what it contains.
1170 * Can be called only when "fc" is kept beyond the period of it called,
1171 * i.e. after cleanup_function_call(fc).
1172 */
1173 static void
1174free_funccal_contents(funccall_T *fc)
1175{
1176 listitem_T *li;
1177
1178 // Free all l: variables.
1179 vars_clear(&fc->l_vars.dv_hashtab);
1180
1181 // Free all a: variables.
1182 vars_clear(&fc->l_avars.dv_hashtab);
1183
1184 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001185 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001186 clear_tv(&li->li_tv);
1187
1188 free_funccal(fc);
1189}
1190
1191/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001192 * Handle the last part of returning from a function: free the local hashtable.
1193 * Unless it is still in use by a closure.
1194 */
1195 static void
1196cleanup_function_call(funccall_T *fc)
1197{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001198 int may_free_fc = fc->fc_refcount <= 0;
1199 int free_fc = TRUE;
1200
Bram Moolenaar6914c642017-04-01 21:21:30 +02001201 current_funccal = fc->caller;
1202
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001203 // Free all l: variables if not referred.
1204 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1205 vars_clear(&fc->l_vars.dv_hashtab);
1206 else
1207 free_fc = FALSE;
1208
1209 // If the a:000 list and the l: and a: dicts are not referenced and
1210 // there is no closure using it, we can free the funccall_T and what's
1211 // in it.
1212 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1213 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001214 else
1215 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001216 int todo;
1217 hashitem_T *hi;
1218 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001219
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001220 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001221
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001222 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001223 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1224 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1225 {
1226 if (!HASHITEM_EMPTY(hi))
1227 {
1228 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001229 di = HI2DI(hi);
1230 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001231 }
1232 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001233 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001234
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001235 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1236 fc->l_varlist.lv_first = NULL;
1237 else
1238 {
1239 listitem_T *li;
1240
1241 free_fc = FALSE;
1242
1243 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001244 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001245 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001246 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001247
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001248 if (free_fc)
1249 free_funccal(fc);
1250 else
1251 {
1252 static int made_copy = 0;
1253
1254 // "fc" is still in use. This can happen when returning "a:000",
1255 // assigning "l:" to a global variable or defining a closure.
1256 // Link "fc" in the list for garbage collection later.
1257 fc->caller = previous_funccal;
1258 previous_funccal = fc;
1259
1260 if (want_garbage_collect)
1261 // If garbage collector is ready, clear count.
1262 made_copy = 0;
1263 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001264 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001265 // We have made a lot of copies, worth 4 Mbyte. This can happen
1266 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001267 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001268 // too much memory.
1269 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001270 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001271 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001272 }
1273}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001274
1275/*
1276 * There are two kinds of function names:
1277 * 1. ordinary names, function defined with :function or :def
1278 * 2. numbered functions and lambdas
1279 * For the first we only count the name stored in func_hashtab as a reference,
1280 * using function() does not count as a reference, because the function is
1281 * looked up by name.
1282 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001283 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001284func_name_refcount(char_u *name)
1285{
1286 return isdigit(*name) || *name == '<';
1287}
1288
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001289/*
1290 * Unreference "fc": decrement the reference count and free it when it
1291 * becomes zero. "fp" is detached from "fc".
1292 * When "force" is TRUE we are exiting.
1293 */
1294 static void
1295funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1296{
1297 funccall_T **pfc;
1298 int i;
1299
1300 if (fc == NULL)
1301 return;
1302
1303 if (--fc->fc_refcount <= 0 && (force || (
1304 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1305 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1306 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1307 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1308 {
1309 if (fc == *pfc)
1310 {
1311 *pfc = fc->caller;
1312 free_funccal_contents(fc);
1313 return;
1314 }
1315 }
1316 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1317 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1318 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1319}
1320
1321/*
1322 * Remove the function from the function hashtable. If the function was
1323 * deleted while it still has references this was already done.
1324 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1325 */
1326 static int
1327func_remove(ufunc_T *fp)
1328{
1329 hashitem_T *hi;
1330
1331 // Return if it was already virtually deleted.
1332 if (fp->uf_flags & FC_DEAD)
1333 return FALSE;
1334
1335 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1336 if (!HASHITEM_EMPTY(hi))
1337 {
1338 // When there is a def-function index do not actually remove the
1339 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001340 // Do remove it when it's a copy.
1341 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001342 fp->uf_flags |= FC_DEAD;
1343 else
1344 hash_remove(&func_hashtab, hi);
1345 return TRUE;
1346 }
1347 return FALSE;
1348}
1349
1350 static void
1351func_clear_items(ufunc_T *fp)
1352{
1353 ga_clear_strings(&(fp->uf_args));
1354 ga_clear_strings(&(fp->uf_def_args));
1355 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001356 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001357 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001358 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001359 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001360 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001361
1362 // Increment the refcount of this function to avoid it being freed
1363 // recursively when the partial is freed.
1364 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001365 partial_unref(fp->uf_partial);
1366 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001367 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001368
1369#ifdef FEAT_LUA
1370 if (fp->uf_cb_free != NULL)
1371 {
1372 fp->uf_cb_free(fp->uf_cb_state);
1373 fp->uf_cb_free = NULL;
1374 }
1375
1376 fp->uf_cb_state = NULL;
1377 fp->uf_cb = NULL;
1378#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001379#ifdef FEAT_PROFILE
1380 VIM_CLEAR(fp->uf_tml_count);
1381 VIM_CLEAR(fp->uf_tml_total);
1382 VIM_CLEAR(fp->uf_tml_self);
1383#endif
1384}
1385
1386/*
1387 * Free all things that a function contains. Does not free the function
1388 * itself, use func_free() for that.
1389 * When "force" is TRUE we are exiting.
1390 */
1391 static void
1392func_clear(ufunc_T *fp, int force)
1393{
1394 if (fp->uf_cleared)
1395 return;
1396 fp->uf_cleared = TRUE;
1397
1398 // clear this function
1399 func_clear_items(fp);
1400 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001401 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001402}
1403
1404/*
1405 * Free a function and remove it from the list of functions. Does not free
1406 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001407 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001408 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001409 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001410 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001411func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001412{
1413 // Only remove it when not done already, otherwise we would remove a newer
1414 // version of the function with the same name.
1415 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1416 func_remove(fp);
1417
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001418 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001419 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001420 if (fp->uf_dfunc_idx > 0)
1421 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001422 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001423 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001424 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001425 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001426 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001427}
1428
1429/*
1430 * Free all things that a function contains and free the function itself.
1431 * When "force" is TRUE we are exiting.
1432 */
1433 static void
1434func_clear_free(ufunc_T *fp, int force)
1435{
1436 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001437 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1438 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001439 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001440 else
1441 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001442}
1443
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001444/*
1445 * Copy already defined function "lambda" to a new function with name "global".
1446 * This is for when a compiled function defines a global function.
1447 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001448 int
1449copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001450{
1451 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001452 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001453
1454 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001455 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001456 semsg(_(e_lambda_function_not_found_str), lambda);
1457 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001458 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001459
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001460 fp = find_func(global, TRUE, NULL);
1461 if (fp != NULL)
1462 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001463 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001464 semsg(_(e_funcexts), global);
1465 return FAIL;
1466 }
1467
1468 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1469 if (fp == NULL)
1470 return FAIL;
1471
1472 fp->uf_varargs = ufunc->uf_varargs;
1473 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1474 fp->uf_def_status = ufunc->uf_def_status;
1475 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1476 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1477 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1478 == FAIL
1479 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1480 goto failed;
1481
1482 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1483 : vim_strsave(ufunc->uf_name_exp);
1484 if (ufunc->uf_arg_types != NULL)
1485 {
1486 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1487 if (fp->uf_arg_types == NULL)
1488 goto failed;
1489 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1490 sizeof(type_T *) * fp->uf_args.ga_len);
1491 }
1492 if (ufunc->uf_def_arg_idx != NULL)
1493 {
1494 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1495 if (fp->uf_def_arg_idx == NULL)
1496 goto failed;
1497 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1498 sizeof(int) * fp->uf_def_args.ga_len + 1);
1499 }
1500 if (ufunc->uf_va_name != NULL)
1501 {
1502 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1503 if (fp->uf_va_name == NULL)
1504 goto failed;
1505 }
1506 fp->uf_ret_type = ufunc->uf_ret_type;
1507
1508 fp->uf_refcount = 1;
1509 STRCPY(fp->uf_name, global);
1510 hash_add(&func_hashtab, UF2HIKEY(fp));
1511
1512 // the referenced dfunc_T is now used one more time
1513 link_def_function(fp);
1514
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001515 // Create a partial to store the context of the function where it was
1516 // instantiated. Only needs to be done once. Do this on the original
1517 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001518 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1519 {
1520 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1521
1522 if (pt == NULL)
1523 goto failed;
1524 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001525 {
1526 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001527 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001528 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001529 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001530 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001531 }
1532
1533 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001534
1535failed:
1536 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001537 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001538}
1539
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001540static int funcdepth = 0;
1541
1542/*
1543 * Increment the function call depth count.
1544 * Return FAIL when going over 'maxfuncdepth'.
1545 * Otherwise return OK, must call funcdepth_decrement() later!
1546 */
1547 int
1548funcdepth_increment(void)
1549{
1550 if (funcdepth >= p_mfd)
1551 {
1552 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1553 return FAIL;
1554 }
1555 ++funcdepth;
1556 return OK;
1557}
1558
1559 void
1560funcdepth_decrement(void)
1561{
1562 --funcdepth;
1563}
1564
1565/*
1566 * Get the current function call depth.
1567 */
1568 int
1569funcdepth_get(void)
1570{
1571 return funcdepth;
1572}
1573
1574/*
1575 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001576 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001577 * times as funcdepth_increment().
1578 */
1579 void
1580funcdepth_restore(int depth)
1581{
1582 funcdepth = depth;
1583}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001584
1585/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001586 * Call a user function.
1587 */
1588 static void
1589call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001590 ufunc_T *fp, // pointer to function
1591 int argcount, // nr of args
1592 typval_T *argvars, // arguments
1593 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001594 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001595 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001597 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001598 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001599 funccall_T *fc;
1600 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001601 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001602 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001603 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001604 int i;
1605 int ai;
1606 int islambda = FALSE;
1607 char_u numbuf[NUMBUFLEN];
1608 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001609#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001610 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001612 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001613
Bram Moolenaarb2049902021-01-24 12:53:53 +01001614#ifdef FEAT_PROFILE
1615 CLEAR_FIELD(profile_info);
1616#endif
1617
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001618 // If depth of calling is getting too high, don't execute the function.
1619 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621 rettv->v_type = VAR_NUMBER;
1622 rettv->vval.v_number = -1;
1623 return;
1624 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625
Bram Moolenaare38eab22019-12-05 21:50:01 +01001626 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001628 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001629 if (fc == NULL)
1630 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001631 fc->caller = current_funccal;
1632 current_funccal = fc;
1633 fc->func = fp;
1634 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001636 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1638 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001639 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001640 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001641 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001643 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001644 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001645 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01001646#ifdef FEAT_PROFILE
1647 profile_may_start_func(&profile_info, fp, fc);
1648#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001649 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001650 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01001651#ifdef FEAT_PROFILE
1652 if (do_profiling == PROF_YES && (fp->uf_profiling
1653 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
1654 profile_may_end_func(&profile_info, fp, fc);
1655#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001656 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001657 free_funccal(fc);
1658 return;
1659 }
1660
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1662 islambda = TRUE;
1663
1664 /*
1665 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1666 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1667 * each argument variable and saves a lot of time.
1668 */
1669 /*
1670 * Init l: variables.
1671 */
1672 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1673 if (selfdict != NULL)
1674 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001675 // Set l:self to "selfdict". Use "name" to avoid a warning from
1676 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001677 v = &fc->fixvar[fixvar_idx++].var;
1678 name = v->di_key;
1679 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001680 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1682 v->di_tv.v_type = VAR_DICT;
1683 v->di_tv.v_lock = 0;
1684 v->di_tv.vval.v_dict = selfdict;
1685 ++selfdict->dv_refcount;
1686 }
1687
1688 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001689 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001690 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691 * Set a:000 to a list with room for the "..." arguments.
1692 */
1693 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001694 if ((fp->uf_flags & FC_NOARGS) == 0)
1695 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001696 (varnumber_T)(argcount >= fp->uf_args.ga_len
1697 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001698 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001699 if ((fp->uf_flags & FC_NOARGS) == 0)
1700 {
1701 // Use "name" to avoid a warning from some compiler that checks the
1702 // destination size.
1703 v = &fc->fixvar[fixvar_idx++].var;
1704 name = v->di_key;
1705 STRCPY(name, "000");
1706 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1707 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1708 v->di_tv.v_type = VAR_LIST;
1709 v->di_tv.v_lock = VAR_FIXED;
1710 v->di_tv.vval.v_list = &fc->l_varlist;
1711 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001712 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001713 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1714 fc->l_varlist.lv_lock = VAR_FIXED;
1715
1716 /*
1717 * Set a:firstline to "firstline" and a:lastline to "lastline".
1718 * Set a:name to named arguments.
1719 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001720 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001722 if ((fp->uf_flags & FC_NOARGS) == 0)
1723 {
1724 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001725 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001726 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001727 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001728 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001729 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001730 {
1731 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001732 typval_T def_rettv;
1733 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001734
1735 ai = i - fp->uf_args.ga_len;
1736 if (ai < 0)
1737 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001738 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001739 name = FUNCARG(fp, i);
1740 if (islambda)
1741 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001742
1743 // evaluate named argument default expression
1744 isdefault = ai + fp->uf_def_args.ga_len >= 0
1745 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1746 && argvars[i].vval.v_number == VVAL_NONE));
1747 if (isdefault)
1748 {
1749 char_u *default_expr = NULL;
1750 def_rettv.v_type = VAR_NUMBER;
1751 def_rettv.vval.v_number = -1;
1752
1753 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1754 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001755 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001756 {
1757 default_arg_err = 1;
1758 break;
1759 }
1760 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001761 }
1762 else
1763 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001764 if ((fp->uf_flags & FC_NOARGS) != 0)
1765 // Bail out if no a: arguments used (in lambda).
1766 break;
1767
Bram Moolenaare38eab22019-12-05 21:50:01 +01001768 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001769 sprintf((char *)numbuf, "%d", ai + 1);
1770 name = numbuf;
1771 }
1772 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1773 {
1774 v = &fc->fixvar[fixvar_idx++].var;
1775 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001776 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 }
1778 else
1779 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001780 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001781 if (v == NULL)
1782 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001783 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001786 // Note: the values are copied directly to avoid alloc/free.
1787 // "argvars" must have VAR_FIXED for v_lock.
1788 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001789 v->di_tv.v_lock = VAR_FIXED;
1790
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001791 if (addlocal)
1792 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001793 // Named arguments should be accessed without the "a:" prefix in
1794 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001795 copy_tv(&v->di_tv, &v->di_tv);
1796 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001797 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001798 else
1799 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800
1801 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1802 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001803 listitem_T *li = &fc->l_listitems[ai];
1804
1805 li->li_tv = argvars[i];
1806 li->li_tv.v_lock = VAR_FIXED;
1807 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 }
1809 }
1810
Bram Moolenaare38eab22019-12-05 21:50:01 +01001811 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001812 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001813
1814 if (fp->uf_flags & FC_SANDBOX)
1815 {
1816 using_sandbox = TRUE;
1817 ++sandbox;
1818 }
1819
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001820 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001821 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001822 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001824 ++no_wait_return;
1825 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001827 smsg(_("calling %s"), SOURCING_NAME);
1828 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001829 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001830 char_u buf[MSG_BUF_LEN];
1831 char_u numbuf2[NUMBUFLEN];
1832 char_u *tofree;
1833 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001834
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001835 msg_puts("(");
1836 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001837 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001838 if (i > 0)
1839 msg_puts(", ");
1840 if (argvars[i].v_type == VAR_NUMBER)
1841 msg_outnum((long)argvars[i].vval.v_number);
1842 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001843 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001844 // Do not want errors such as E724 here.
1845 ++emsg_off;
1846 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1847 --emsg_off;
1848 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001850 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001852 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1853 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001855 msg_puts((char *)s);
1856 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001857 }
1858 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001859 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001860 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001861 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001862 msg_puts("\n"); // don't overwrite this either
1863
1864 verbose_leave_scroll();
1865 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001866 }
1867#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001868 profile_may_start_func(&profile_info, fp, fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001869#endif
1870
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001871 save_current_sctx = current_sctx;
1872 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 save_did_emsg = did_emsg;
1874 did_emsg = FALSE;
1875
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001876 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1877 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001878 else if (islambda)
1879 {
1880 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1881
1882 // A Lambda always has the command "return {expr}". It is much faster
1883 // to evaluate {expr} directly.
1884 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001885 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001886 --ex_nesting_level;
1887 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001888 else
1889 // call do_cmdline() to execute the lines
1890 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001891 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1892
1893 --RedrawingDisabled;
1894
Bram Moolenaare38eab22019-12-05 21:50:01 +01001895 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1897 {
1898 clear_tv(rettv);
1899 rettv->v_type = VAR_NUMBER;
1900 rettv->vval.v_number = -1;
1901 }
1902
1903#ifdef FEAT_PROFILE
1904 if (do_profiling == PROF_YES && (fp->uf_profiling
1905 || (fc->caller != NULL && fc->caller->func->uf_profiling)))
Bram Moolenaarb2049902021-01-24 12:53:53 +01001906 profile_may_end_func(&profile_info, fp, fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001907#endif
1908
Bram Moolenaare38eab22019-12-05 21:50:01 +01001909 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001910 if (p_verbose >= 12)
1911 {
1912 ++no_wait_return;
1913 verbose_enter_scroll();
1914
1915 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001916 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001918 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 (long)fc->rettv->vval.v_number);
1920 else
1921 {
1922 char_u buf[MSG_BUF_LEN];
1923 char_u numbuf2[NUMBUFLEN];
1924 char_u *tofree;
1925 char_u *s;
1926
Bram Moolenaare38eab22019-12-05 21:50:01 +01001927 // The value may be very long. Skip the middle part, so that we
1928 // have some idea how it starts and ends. smsg() would always
1929 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001930 ++emsg_off;
1931 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1932 --emsg_off;
1933 if (s != NULL)
1934 {
1935 if (vim_strsize(s) > MSG_BUF_CLEN)
1936 {
1937 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1938 s = buf;
1939 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001940 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001941 vim_free(tofree);
1942 }
1943 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001944 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001945
1946 verbose_leave_scroll();
1947 --no_wait_return;
1948 }
1949
Bram Moolenaare31ee862020-01-07 20:59:34 +01001950 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001951 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001952 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001953#ifdef FEAT_PROFILE
1954 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01001955 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001956#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001957 if (using_sandbox)
1958 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001959
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001960 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001961 {
1962 ++no_wait_return;
1963 verbose_enter_scroll();
1964
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001965 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001966 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001967
1968 verbose_leave_scroll();
1969 --no_wait_return;
1970 }
1971
1972 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001973 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001974 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001975}
1976
1977/*
Bram Moolenaar50824712020-12-20 21:10:17 +01001978 * Check the argument count for user function "fp".
1979 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
1980 */
1981 int
1982check_user_func_argcount(ufunc_T *fp, int argcount)
1983{
1984 int regular_args = fp->uf_args.ga_len;
1985
1986 if (argcount < regular_args - fp->uf_def_args.ga_len)
1987 return FCERR_TOOFEW;
1988 else if (!has_varargs(fp) && argcount > regular_args)
1989 return FCERR_TOOMANY;
1990 return FCERR_UNKNOWN;
1991}
1992
1993/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001994 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001995 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001996 int
1997call_user_func_check(
1998 ufunc_T *fp,
1999 int argcount,
2000 typval_T *argvars,
2001 typval_T *rettv,
2002 funcexe_T *funcexe,
2003 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002004{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002005 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002006
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002007 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2008 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002009 error = check_user_func_argcount(fp, argcount);
2010 if (error != FCERR_UNKNOWN)
2011 return error;
2012 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013 error = FCERR_DICT;
2014 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002015 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002016 int did_save_redo = FALSE;
2017 save_redo_T save_redo;
2018
2019 /*
2020 * Call the user function.
2021 * Save and restore search patterns, script variables and
2022 * redo buffer.
2023 */
2024 save_search_patterns();
2025 if (!ins_compl_active())
2026 {
2027 saveRedobuff(&save_redo);
2028 did_save_redo = TRUE;
2029 }
2030 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002031 call_user_func(fp, argcount, argvars, rettv, funcexe,
2032 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002033 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2034 // Function was unreferenced while being used, free it now.
2035 func_clear_free(fp, FALSE);
2036 if (did_save_redo)
2037 restoreRedobuff(&save_redo);
2038 restore_search_patterns();
2039 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002040 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002041 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002042}
2043
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002044static funccal_entry_T *funccal_stack = NULL;
2045
2046/*
2047 * Save the current function call pointer, and set it to NULL.
2048 * Used when executing autocommands and for ":source".
2049 */
2050 void
2051save_funccal(funccal_entry_T *entry)
2052{
2053 entry->top_funccal = current_funccal;
2054 entry->next = funccal_stack;
2055 funccal_stack = entry;
2056 current_funccal = NULL;
2057}
2058
2059 void
2060restore_funccal(void)
2061{
2062 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002063 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002064 else
2065 {
2066 current_funccal = funccal_stack->top_funccal;
2067 funccal_stack = funccal_stack->next;
2068 }
2069}
2070
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002071 funccall_T *
2072get_current_funccal(void)
2073{
2074 return current_funccal;
2075}
2076
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002077/*
2078 * Mark all functions of script "sid" as deleted.
2079 */
2080 void
2081delete_script_functions(int sid)
2082{
2083 hashitem_T *hi;
2084 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002085 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002086 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002087 size_t len;
2088
2089 buf[0] = K_SPECIAL;
2090 buf[1] = KS_EXTRA;
2091 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002092 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002093 len = STRLEN(buf);
2094
Bram Moolenaarce658352020-07-31 23:47:12 +02002095 while (todo > 0)
2096 {
2097 todo = func_hashtab.ht_used;
2098 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2099 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002100 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002101 fp = HI2UF(hi);
2102 if (STRNCMP(fp->uf_name, buf, len) == 0)
2103 {
2104 int changed = func_hashtab.ht_changed;
2105
2106 fp->uf_flags |= FC_DEAD;
2107 func_clear(fp, TRUE);
2108 // When clearing a function another function can be cleared
2109 // as a side effect. When that happens start over.
2110 if (changed != func_hashtab.ht_changed)
2111 break;
2112 }
2113 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002114 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002115 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002116}
2117
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002118#if defined(EXITFREE) || defined(PROTO)
2119 void
2120free_all_functions(void)
2121{
2122 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002123 ufunc_T *fp;
2124 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002125 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002126 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002127
Bram Moolenaare38eab22019-12-05 21:50:01 +01002128 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002129 while (current_funccal != NULL)
2130 {
2131 clear_tv(current_funccal->rettv);
2132 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002133 if (current_funccal == NULL && funccal_stack != NULL)
2134 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002135 }
2136
Bram Moolenaare38eab22019-12-05 21:50:01 +01002137 // First clear what the functions contain. Since this may lower the
2138 // reference count of a function, it may also free a function and change
2139 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002140 while (todo > 0)
2141 {
2142 todo = func_hashtab.ht_used;
2143 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2144 if (!HASHITEM_EMPTY(hi))
2145 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002146 // clear the def function index now
2147 fp = HI2UF(hi);
2148 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002149 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002150
Bram Moolenaare38eab22019-12-05 21:50:01 +01002151 // Only free functions that are not refcounted, those are
2152 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002153 if (func_name_refcount(fp->uf_name))
2154 ++skipped;
2155 else
2156 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002157 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002158 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002159 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002160 {
2161 skipped = 0;
2162 break;
2163 }
2164 }
2165 --todo;
2166 }
2167 }
2168
Bram Moolenaare38eab22019-12-05 21:50:01 +01002169 // Now actually free the functions. Need to start all over every time,
2170 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002171 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002172 while (func_hashtab.ht_used > skipped)
2173 {
2174 todo = func_hashtab.ht_used;
2175 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 if (!HASHITEM_EMPTY(hi))
2177 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002178 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002179 // Only free functions that are not refcounted, those are
2180 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002181 fp = HI2UF(hi);
2182 if (func_name_refcount(fp->uf_name))
2183 ++skipped;
2184 else
2185 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002186 if (func_free(fp, FALSE) == OK)
2187 {
2188 skipped = 0;
2189 break;
2190 }
2191 // did not actually free it
2192 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002193 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002195 }
2196 if (skipped == 0)
2197 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002198
2199 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002200}
2201#endif
2202
2203/*
2204 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002205 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002206 * "len" is the length of "name", or -1 for NUL terminated.
2207 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002208 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209builtin_function(char_u *name, int len)
2210{
2211 char_u *p;
2212
Bram Moolenaara26b9702020-04-18 19:53:28 +02002213 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002214 return FALSE;
2215 p = vim_strchr(name, AUTOLOAD_CHAR);
2216 return p == NULL || (len > 0 && p > name + len);
2217}
2218
2219 int
2220func_call(
2221 char_u *name,
2222 typval_T *args,
2223 partial_T *partial,
2224 dict_T *selfdict,
2225 typval_T *rettv)
2226{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002227 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228 listitem_T *item;
2229 typval_T argv[MAX_FUNC_ARGS + 1];
2230 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 int r = 0;
2232
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002233 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002234 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002235 {
2236 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2237 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002238 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002239 break;
2240 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002241 // Make a copy of each argument. This is needed to be able to set
2242 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002243 copy_tv(&item->li_tv, &argv[argc++]);
2244 }
2245
2246 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002247 {
2248 funcexe_T funcexe;
2249
Bram Moolenaara80faa82020-04-12 19:37:17 +02002250 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002251 funcexe.firstline = curwin->w_cursor.lnum;
2252 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002253 funcexe.evaluate = TRUE;
2254 funcexe.partial = partial;
2255 funcexe.selfdict = selfdict;
2256 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2257 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002258
Bram Moolenaare38eab22019-12-05 21:50:01 +01002259 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002260 while (argc > 0)
2261 clear_tv(&argv[--argc]);
2262
2263 return r;
2264}
2265
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002266static int callback_depth = 0;
2267
2268 int
2269get_callback_depth(void)
2270{
2271 return callback_depth;
2272}
2273
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002274/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002275 * Invoke call_func() with a callback.
2276 */
2277 int
2278call_callback(
2279 callback_T *callback,
2280 int len, // length of "name" or -1 to use strlen()
2281 typval_T *rettv, // return value goes here
2282 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002283 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002284 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002285{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002286 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002287 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002288
Bram Moolenaara80faa82020-04-12 19:37:17 +02002289 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002290 funcexe.evaluate = TRUE;
2291 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002292 ++callback_depth;
2293 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2294 --callback_depth;
2295 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002296}
2297
2298/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002299 * Give an error message for the result of a function.
2300 * Nothing if "error" is FCERR_NONE.
2301 */
2302 void
2303user_func_error(int error, char_u *name)
2304{
2305 switch (error)
2306 {
2307 case FCERR_UNKNOWN:
2308 emsg_funcname(e_unknownfunc, name);
2309 break;
2310 case FCERR_NOTMETHOD:
2311 emsg_funcname(
2312 N_("E276: Cannot use function as a method: %s"), name);
2313 break;
2314 case FCERR_DELETED:
2315 emsg_funcname(N_(e_func_deleted), name);
2316 break;
2317 case FCERR_TOOMANY:
2318 emsg_funcname((char *)e_toomanyarg, name);
2319 break;
2320 case FCERR_TOOFEW:
2321 emsg_funcname((char *)e_toofewarg, name);
2322 break;
2323 case FCERR_SCRIPT:
2324 emsg_funcname(
2325 N_("E120: Using <SID> not in a script context: %s"), name);
2326 break;
2327 case FCERR_DICT:
2328 emsg_funcname(
2329 N_("E725: Calling dict function without Dictionary: %s"),
2330 name);
2331 break;
2332 }
2333}
2334
2335/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002337 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002338 * Return FAIL when the function can't be called, OK otherwise.
2339 * Also returns OK when an error was encountered while executing the function.
2340 */
2341 int
2342call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002343 char_u *funcname, // name of the function
2344 int len, // length of "name" or -1 to use strlen()
2345 typval_T *rettv, // return value goes here
2346 int argcount_in, // number of "argvars"
2347 typval_T *argvars_in, // vars for arguments, must have "argcount"
2348 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002349 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350{
2351 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002352 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002354 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002355 char_u fname_buf[FLEN_FIXED + 1];
2356 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002357 char_u *fname = NULL;
2358 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359 int argcount = argcount_in;
2360 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002361 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002362 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2363 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002365 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002366 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002368 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2369 // even when call_func() returns FAIL.
2370 rettv->v_type = VAR_UNKNOWN;
2371
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002372 if (partial != NULL)
2373 fp = partial->pt_func;
2374 if (fp == NULL)
2375 {
2376 // Make a copy of the name, if it comes from a funcref variable it
2377 // could be changed or deleted in the called function.
2378 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2379 if (name == NULL)
2380 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002381
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002382 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2383 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002385 if (funcexe->doesrange != NULL)
2386 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387
2388 if (partial != NULL)
2389 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002390 // When the function has a partial with a dict and there is a dict
2391 // argument, use the dict argument. That is backwards compatible.
2392 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002393 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002395 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396 {
2397 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002398 {
2399 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2400 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002401 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002402 goto theend;
2403 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002405 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406 for (i = 0; i < argcount_in; ++i)
2407 argv[i + argv_clear] = argvars_in[i];
2408 argvars = argv;
2409 argcount = partial->pt_argc + argcount_in;
2410 }
2411 }
2412
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002413 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2414 {
2415 // Check that the argument types are OK for the types of the funcref.
2416 if (check_argument_types(funcexe->check_type, argvars, argcount,
2417 name) == FAIL)
2418 error = FCERR_OTHER;
2419 }
2420
Bram Moolenaaref140542019-12-31 21:27:13 +01002421 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 {
2423 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002424 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425
Bram Moolenaar333894b2020-08-01 18:53:07 +02002426 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002427 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002428 {
2429 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002432
Bram Moolenaare38eab22019-12-05 21:50:01 +01002433 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002435 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002437 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002438 {
2439 /*
2440 * User defined function.
2441 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002442 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002443 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444
Bram Moolenaare38eab22019-12-05 21:50:01 +01002445 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002446 if (fp == NULL
2447 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002448 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 && !aborting())
2450 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002451 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002452 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002454 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2456 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002457 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002458 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002459 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002460 if (fp == NULL)
2461 {
2462 char_u *p = untrans_function_name(rfname);
2463
2464 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002465 // Don't do this if the name starts with "s:".
2466 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002467 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002470 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002471 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002472#ifdef FEAT_LUA
2473 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2474 {
2475 cfunc_T cb = fp->uf_cb;
2476
2477 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2478 }
2479#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002480 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002482 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002483 // postponed filling in the arguments, do it now
2484 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002485 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002486
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002487 if (funcexe->basetv != NULL)
2488 {
2489 // Method call: base->Method()
2490 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2491 argv[0] = *funcexe->basetv;
2492 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002493 argvars = argv;
2494 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002495 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002496
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002497 error = call_user_func_check(fp, argcount, argvars, rettv,
2498 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002499 }
2500 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002501 else if (funcexe->basetv != NULL)
2502 {
2503 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002504 * expr->method(): Find the method name in the table, call its
2505 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002506 */
2507 error = call_internal_method(fname, argcount, argvars, rettv,
2508 funcexe->basetv);
2509 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510 else
2511 {
2512 /*
2513 * Find the function name in the table, call its implementation.
2514 */
2515 error = call_internal_func(fname, argcount, argvars, rettv);
2516 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002517
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 /*
2519 * The function call (or "FuncUndefined" autocommand sequence) might
2520 * have been aborted by an error, an interrupt, or an explicitly thrown
2521 * exception that has not been caught so far. This situation can be
2522 * tested for by calling aborting(). For an error in an internal
2523 * function or for the "E132" error in call_user_func(), however, the
2524 * throw point at which the "force_abort" flag (temporarily reset by
2525 * emsg()) is normally updated has not been reached yet. We need to
2526 * update that flag first to make aborting() reliable.
2527 */
2528 update_force_abort();
2529 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002530 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531 ret = OK;
2532
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002533theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002534 /*
2535 * Report an error unless the argument evaluation or function call has been
2536 * cancelled due to an aborting error, an interrupt, or an exception.
2537 */
2538 if (!aborting())
2539 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002540 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541 }
2542
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002543 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002545 clear_tv(&argv[--argv_clear + argv_base]);
2546
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547 vim_free(tofree);
2548 vim_free(name);
2549
2550 return ret;
2551}
2552
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002553 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002554printable_func_name(ufunc_T *fp)
2555{
2556 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2557}
2558
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002560 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002561 */
2562 static void
2563list_func_head(ufunc_T *fp, int indent)
2564{
2565 int j;
2566
2567 msg_start();
2568 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002569 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002570 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002571 msg_puts("def ");
2572 else
2573 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002574 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002575 msg_putchar('(');
2576 for (j = 0; j < fp->uf_args.ga_len; ++j)
2577 {
2578 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002579 msg_puts(", ");
2580 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002581 if (fp->uf_arg_types != NULL)
2582 {
2583 char *tofree;
2584
2585 msg_puts(": ");
2586 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2587 vim_free(tofree);
2588 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002589 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2590 {
2591 msg_puts(" = ");
2592 msg_puts(((char **)(fp->uf_def_args.ga_data))
2593 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2594 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002595 }
2596 if (fp->uf_varargs)
2597 {
2598 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002599 msg_puts(", ");
2600 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002602 if (fp->uf_va_name != NULL)
2603 {
2604 if (j)
2605 msg_puts(", ");
2606 msg_puts("...");
2607 msg_puts((char *)fp->uf_va_name);
2608 if (fp->uf_va_type)
2609 {
2610 char *tofree;
2611
2612 msg_puts(": ");
2613 msg_puts(type_name(fp->uf_va_type, &tofree));
2614 vim_free(tofree);
2615 }
2616 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002617 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002618
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002619 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002620 {
2621 if (fp->uf_ret_type != &t_void)
2622 {
2623 char *tofree;
2624
2625 msg_puts(": ");
2626 msg_puts(type_name(fp->uf_ret_type, &tofree));
2627 vim_free(tofree);
2628 }
2629 }
2630 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002631 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002633 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002634 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002635 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002636 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002637 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 msg_clr_eos();
2639 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002640 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002641}
2642
2643/*
2644 * Get a function name, translating "<SID>" and "<SNR>".
2645 * Also handles a Funcref in a List or Dictionary.
2646 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002647 * Set "*is_global" to TRUE when the function must be global, unless
2648 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649 * flags:
2650 * TFN_INT: internal function name OK
2651 * TFN_QUIET: be quiet
2652 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002653 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002654 * Advances "pp" to just after the function name (if no error).
2655 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002656 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657trans_function_name(
2658 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002659 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002660 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002662 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002663 partial_T **partial, // return: partial of a FuncRef
2664 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665{
2666 char_u *name = NULL;
2667 char_u *start;
2668 char_u *end;
2669 int lead;
2670 char_u sid_buf[20];
2671 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002672 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002674 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002675 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676
2677 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002678 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 start = *pp;
2680
Bram Moolenaare38eab22019-12-05 21:50:01 +01002681 // Check for hard coded <SNR>: already translated function ID (from a user
2682 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002683 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2684 && (*pp)[2] == (int)KE_SNR)
2685 {
2686 *pp += 3;
2687 len = get_id_len(pp) + 3;
2688 return vim_strnsave(start, len);
2689 }
2690
Bram Moolenaare38eab22019-12-05 21:50:01 +01002691 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2692 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002693 lead = eval_fname_script(start);
2694 if (lead > 2)
2695 start += lead;
2696
Bram Moolenaare38eab22019-12-05 21:50:01 +01002697 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002698 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699 lead > 2 ? 0 : FNE_CHECK_START);
2700 if (end == start)
2701 {
2702 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002703 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 goto theend;
2705 }
2706 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2707 {
2708 /*
2709 * Report an invalid expression in braces, unless the expression
2710 * evaluation has been cancelled due to an aborting error, an
2711 * interrupt, or an exception.
2712 */
2713 if (!aborting())
2714 {
2715 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002716 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 }
2718 else
2719 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2720 goto theend;
2721 }
2722
2723 if (lv.ll_tv != NULL)
2724 {
2725 if (fdp != NULL)
2726 {
2727 fdp->fd_dict = lv.ll_dict;
2728 fdp->fd_newkey = lv.ll_newkey;
2729 lv.ll_newkey = NULL;
2730 fdp->fd_di = lv.ll_di;
2731 }
2732 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2733 {
2734 name = vim_strsave(lv.ll_tv->vval.v_string);
2735 *pp = end;
2736 }
2737 else if (lv.ll_tv->v_type == VAR_PARTIAL
2738 && lv.ll_tv->vval.v_partial != NULL)
2739 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002740 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002741 *pp = end;
2742 if (partial != NULL)
2743 *partial = lv.ll_tv->vval.v_partial;
2744 }
2745 else
2746 {
2747 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2748 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002749 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 else
2751 *pp = end;
2752 name = NULL;
2753 }
2754 goto theend;
2755 }
2756
2757 if (lv.ll_name == NULL)
2758 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002759 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 *pp = end;
2761 goto theend;
2762 }
2763
Bram Moolenaare38eab22019-12-05 21:50:01 +01002764 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002765 if (lv.ll_exp_name != NULL)
2766 {
2767 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002768 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 flags & TFN_NO_AUTOLOAD);
2770 if (name == lv.ll_exp_name)
2771 name = NULL;
2772 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002773 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 {
2775 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002776 name = deref_func_name(*pp, &len, partial, type,
2777 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 if (name == *pp)
2779 name = NULL;
2780 }
2781 if (name != NULL)
2782 {
2783 name = vim_strsave(name);
2784 *pp = end;
2785 if (STRNCMP(name, "<SNR>", 5) == 0)
2786 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002787 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 name[0] = K_SPECIAL;
2789 name[1] = KS_EXTRA;
2790 name[2] = (int)KE_SNR;
2791 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2792 }
2793 goto theend;
2794 }
2795
2796 if (lv.ll_exp_name != NULL)
2797 {
2798 len = (int)STRLEN(lv.ll_exp_name);
2799 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2800 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2801 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002802 // When there was "s:" already or the name expanded to get a
2803 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 lv.ll_name += 2;
2805 len -= 2;
2806 lead = 2;
2807 }
2808 }
2809 else
2810 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002811 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002813 {
2814 if (is_global != NULL && lv.ll_name[0] == 'g')
2815 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002817 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 len = (int)(end - lv.ll_name);
2819 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002820 if (len <= 0)
2821 {
2822 if (!skip)
2823 emsg(_(e_function_name));
2824 goto theend;
2825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002827 // In Vim9 script a user function is script-local by default, unless it
2828 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002829 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002830 if (vim9script)
2831 {
2832 char_u *p;
2833
2834 // SomeScript#func() is a global function.
2835 for (p = start; *p != NUL && *p != '('; ++p)
2836 if (*p == AUTOLOAD_CHAR)
2837 vim9script = FALSE;
2838 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002839
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002840 /*
2841 * Copy the function name to allocated memory.
2842 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2843 * Accept <SNR>123_name() outside a script.
2844 */
2845 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002846 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002847 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002849 if (!vim9script)
2850 lead = 3;
2851 if (vim9script || (lv.ll_exp_name != NULL
2852 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853 || eval_fname_sid(*pp))
2854 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002855 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002856 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002858 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 goto theend;
2860 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002861 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002862 if (vim9script)
2863 extra = 3 + (int)STRLEN(sid_buf);
2864 else
2865 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 }
2867 }
2868 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2869 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002870 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 start);
2872 goto theend;
2873 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002874 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 {
2876 char_u *cp = vim_strchr(lv.ll_name, ':');
2877
2878 if (cp != NULL && cp < end)
2879 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002880 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881 goto theend;
2882 }
2883 }
2884
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002885 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002886 if (name != NULL)
2887 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002888 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889 {
2890 name[0] = K_SPECIAL;
2891 name[1] = KS_EXTRA;
2892 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002893 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002894 STRCPY(name + 3, sid_buf);
2895 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002896 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2897 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 }
2899 *pp = end;
2900
2901theend:
2902 clear_lval(&lv);
2903 return name;
2904}
2905
2906/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002907 * Assuming "name" is the result of trans_function_name() and it was prefixed
2908 * to use the script-local name, return the unmodified name (points into
2909 * "name"). Otherwise return NULL.
2910 * This can be used to first search for a script-local function and fall back
2911 * to the global function if not found.
2912 */
2913 char_u *
2914untrans_function_name(char_u *name)
2915{
2916 char_u *p;
2917
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002918 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002919 {
2920 p = vim_strchr(name, '_');
2921 if (p != NULL)
2922 return p + 1;
2923 }
2924 return NULL;
2925}
2926
2927/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002928 * List functions. When "regmatch" is NULL all of then.
2929 * Otherwise functions matching "regmatch".
2930 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002931 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002932list_functions(regmatch_T *regmatch)
2933{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002934 int changed = func_hashtab.ht_changed;
2935 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002936 hashitem_T *hi;
2937
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002938 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002939 {
2940 if (!HASHITEM_EMPTY(hi))
2941 {
2942 ufunc_T *fp = HI2UF(hi);
2943
2944 --todo;
2945 if ((fp->uf_flags & FC_DEAD) == 0
2946 && (regmatch == NULL
2947 ? !message_filtered(fp->uf_name)
2948 && !func_name_refcount(fp->uf_name)
2949 : !isdigit(*fp->uf_name)
2950 && vim_regexec(regmatch, fp->uf_name, 0)))
2951 {
2952 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002953 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002954 {
2955 emsg(_("E454: function list was modified"));
2956 return;
2957 }
2958 }
2959 }
2960 }
2961}
2962
2963/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002964 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2965 * return TRUE.
2966 * Otherwise return FALSE;
2967 * Do not consider "function(" to be a command.
2968 */
2969 static int
2970is_function_cmd(char_u **cmd)
2971{
2972 char_u *p = *cmd;
2973
2974 if (checkforcmd(&p, "function", 2))
2975 {
2976 if (*p == '(')
2977 return FALSE;
2978 *cmd = p;
2979 return TRUE;
2980 }
2981 return FALSE;
2982}
2983
2984/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02002985 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002986 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
2987 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02002988 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002989 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02002990 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002991define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992{
2993 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02002994 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 int j;
2996 int c;
2997 int saved_did_emsg;
2998 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02002999 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003000 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001 char_u *p;
3002 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003003 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 char_u *line_arg = NULL;
3005 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003006 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003007 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 garray_T newlines;
3009 int varargs = FALSE;
3010 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003011 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003012 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003013 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014 int indent;
3015 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003016#define MAX_FUNC_NESTING 50
3017 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018 dictitem_T *v;
3019 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003020 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003023 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003024 linenr_T sourcing_lnum_off;
3025 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003026 int is_heredoc = FALSE;
3027 char_u *skip_until = NULL;
3028 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003029 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003030 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031
3032 /*
3033 * ":function" without argument: list functions.
3034 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003035 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003036 {
3037 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003038 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003040 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041 }
3042
3043 /*
3044 * ":function /pat": list functions matching pattern.
3045 */
3046 if (*eap->arg == '/')
3047 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003048 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 if (!eap->skip)
3050 {
3051 regmatch_T regmatch;
3052
3053 c = *p;
3054 *p = NUL;
3055 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3056 *p = c;
3057 if (regmatch.regprog != NULL)
3058 {
3059 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003060 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 vim_regfree(regmatch.regprog);
3062 }
3063 }
3064 if (*p == '/')
3065 ++p;
3066 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003067 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 }
3069
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003070 ga_init(&newargs);
3071 ga_init(&argtypes);
3072 ga_init(&default_args);
3073
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074 /*
3075 * Get the function name. There are these situations:
3076 * func normal function name
3077 * "name" == func, "fudi.fd_dict" == NULL
3078 * dict.func new dictionary entry
3079 * "name" == NULL, "fudi.fd_dict" set,
3080 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3081 * dict.func existing dict entry with a Funcref
3082 * "name" == func, "fudi.fd_dict" set,
3083 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3084 * dict.func existing dict entry that's not a Funcref
3085 * "name" == NULL, "fudi.fd_dict" set,
3086 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3087 * s:func script-local function name
3088 * g:func global function name, same as "func"
3089 */
3090 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003091 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003093 // nested function, argument is (args).
3094 paren = TRUE;
3095 CLEAR_FIELD(fudi);
3096 }
3097 else
3098 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003099 if (STRNCMP(p, "<lambda>", 8) == 0)
3100 {
3101 p += 8;
3102 (void)getdigits(&p);
3103 name = vim_strnsave(eap->arg, p - eap->arg);
3104 CLEAR_FIELD(fudi);
3105 }
3106 else
3107 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003108 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003109 paren = (vim_strchr(p, '(') != NULL);
3110 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003112 /*
3113 * Return on an invalid expression in braces, unless the expression
3114 * evaluation has been cancelled due to an aborting error, an
3115 * interrupt, or an exception.
3116 */
3117 if (!aborting())
3118 {
3119 if (!eap->skip && fudi.fd_newkey != NULL)
3120 semsg(_(e_dictkey), fudi.fd_newkey);
3121 vim_free(fudi.fd_newkey);
3122 return NULL;
3123 }
3124 else
3125 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003126 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127 }
3128
Bram Moolenaare38eab22019-12-05 21:50:01 +01003129 // An error in a function call during evaluation of an expression in magic
3130 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 saved_did_emsg = did_emsg;
3132 did_emsg = FALSE;
3133
3134 /*
3135 * ":function func" with only function name: list function.
3136 */
3137 if (!paren)
3138 {
3139 if (!ends_excmd(*skipwhite(p)))
3140 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003141 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003142 goto ret_free;
3143 }
3144 eap->nextcmd = check_nextcmd(p);
3145 if (eap->nextcmd != NULL)
3146 *p = NUL;
3147 if (!eap->skip && !got_int)
3148 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003149 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003150 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3151 {
3152 char_u *up = untrans_function_name(name);
3153
3154 // With Vim9 script the name was made script-local, if not
3155 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003156 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003157 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003158 }
3159
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003160 if (fp != NULL)
3161 {
3162 list_func_head(fp, TRUE);
3163 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3164 {
3165 if (FUNCLINE(fp, j) == NULL)
3166 continue;
3167 msg_putchar('\n');
3168 msg_outnum((long)(j + 1));
3169 if (j < 9)
3170 msg_putchar(' ');
3171 if (j < 99)
3172 msg_putchar(' ');
3173 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003174 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 ui_breakcheck();
3176 }
3177 if (!got_int)
3178 {
3179 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003180 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003181 msg_puts(" enddef");
3182 else
3183 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003184 }
3185 }
3186 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003187 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003188 }
3189 goto ret_free;
3190 }
3191
3192 /*
3193 * ":function name(arg1, arg2)" Define function.
3194 */
3195 p = skipwhite(p);
3196 if (*p != '(')
3197 {
3198 if (!eap->skip)
3199 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003200 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 goto ret_free;
3202 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003203 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003204 if (vim_strchr(p, '(') != NULL)
3205 p = vim_strchr(p, '(');
3206 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003208 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3209 {
3210 semsg(_(e_no_white_space_allowed_before_str), "(");
3211 goto ret_free;
3212 }
3213
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003214 // In Vim9 script only global functions can be redefined.
3215 if (vim9script && eap->forceit && !is_global)
3216 {
3217 emsg(_(e_nobang));
3218 goto ret_free;
3219 }
3220
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003221 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3222
Bram Moolenaar04b12692020-05-04 23:24:44 +02003223 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003224 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003225 // Check the name of the function. Unless it's a dictionary function
3226 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227 if (name != NULL)
3228 arg = name;
3229 else
3230 arg = fudi.fd_newkey;
3231 if (arg != NULL && (fudi.fd_di == NULL
3232 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3233 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3234 {
3235 if (*arg == K_SPECIAL)
3236 j = 3;
3237 else
3238 j = 0;
3239 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3240 : eval_isnamec(arg[j])))
3241 ++j;
3242 if (arg[j] != NUL)
3243 emsg_funcname((char *)e_invarg2, arg);
3244 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003245 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003246 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003247 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 }
3249
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003250 // This may get more lines and make the pointers into the first line
3251 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003252 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003253 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003254 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003255 &varargs, &default_args, eap->skip,
3256 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003257 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003258 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003259
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003260 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003262 // find the return type: :def Func(): type
3263 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003264 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003265 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003266 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003268 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003269 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003270 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003271 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003272 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003273 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003274 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003275 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003276 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003277 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003279 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003280 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003281 else
3282 // find extra arguments "range", "dict", "abort" and "closure"
3283 for (;;)
3284 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003285 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003286 p = skipwhite(p);
3287 if (STRNCMP(p, "range", 5) == 0)
3288 {
3289 flags |= FC_RANGE;
3290 p += 5;
3291 }
3292 else if (STRNCMP(p, "dict", 4) == 0)
3293 {
3294 flags |= FC_DICT;
3295 p += 4;
3296 }
3297 else if (STRNCMP(p, "abort", 5) == 0)
3298 {
3299 flags |= FC_ABORT;
3300 p += 5;
3301 }
3302 else if (STRNCMP(p, "closure", 7) == 0)
3303 {
3304 flags |= FC_CLOSURE;
3305 p += 7;
3306 if (current_funccal == NULL)
3307 {
3308 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3309 name == NULL ? (char_u *)"" : name);
3310 goto erret;
3311 }
3312 }
3313 else
3314 break;
3315 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316
Bram Moolenaare38eab22019-12-05 21:50:01 +01003317 // When there is a line break use what follows for the function body.
3318 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319 if (*p == '\n')
3320 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003321 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003322 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3323 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003324 && !(VIM_ISWHITE(*whitep) && *p == '#'
3325 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003326 && !eap->skip
3327 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003328 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329
3330 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003331 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3332 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333 */
3334 if (KeyTyped)
3335 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003336 // Check if the function already exists, don't let the user type the
3337 // whole function before telling him it doesn't work! For a script we
3338 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 if (!eap->skip && !eap->forceit)
3340 {
3341 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003342 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003343 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 emsg_funcname(e_funcexts, name);
3345 }
3346
3347 if (!eap->skip && did_emsg)
3348 goto erret;
3349
Bram Moolenaare38eab22019-12-05 21:50:01 +01003350 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 cmdline_row = msg_row;
3352 }
3353
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003354 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003355 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003356
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003357 // Detect having skipped over comment lines to find the return
3358 // type. Add NULL lines to keep the line count correct.
3359 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3360 if (SOURCING_LNUM < sourcing_lnum_off)
3361 {
3362 sourcing_lnum_off -= SOURCING_LNUM;
3363 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3364 goto erret;
3365 while (sourcing_lnum_off-- > 0)
3366 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3367 }
3368
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 indent = 2;
3370 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003371 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003372 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003373 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003374 for (;;)
3375 {
3376 if (KeyTyped)
3377 {
3378 msg_scroll = TRUE;
3379 saved_wait_return = FALSE;
3380 }
3381 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382
3383 if (line_arg != NULL)
3384 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003385 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 theline = line_arg;
3387 p = vim_strchr(theline, '\n');
3388 if (p == NULL)
3389 line_arg += STRLEN(line_arg);
3390 else
3391 {
3392 *p = NUL;
3393 line_arg = p + 1;
3394 }
3395 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003396 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003397 {
3398 vim_free(line_to_free);
3399 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003400 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003401 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003402 theline = eap->getline(':', eap->cookie, indent,
3403 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003404 line_to_free = theline;
3405 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003406 if (KeyTyped)
3407 lines_left = Rows - 1;
3408 if (theline == NULL)
3409 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003410 // Use the start of the function for the line number.
3411 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003412 if (skip_until != NULL)
3413 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3414 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003415 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003416 else
3417 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 goto erret;
3419 }
3420
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003421 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003422 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003423 if (SOURCING_LNUM < sourcing_lnum_off)
3424 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 else
3426 sourcing_lnum_off = 0;
3427
3428 if (skip_until != NULL)
3429 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003430 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003431 // * ":append" and "."
3432 // * ":python <<EOF" and "EOF"
3433 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3434 if (heredoc_trimmed == NULL
3435 || (is_heredoc && skipwhite(theline) == theline)
3436 || STRNCMP(theline, heredoc_trimmed,
3437 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003438 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003439 if (heredoc_trimmed == NULL)
3440 p = theline;
3441 else if (is_heredoc)
3442 p = skipwhite(theline) == theline
3443 ? theline : theline + STRLEN(heredoc_trimmed);
3444 else
3445 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003446 if (STRCMP(p, skip_until) == 0)
3447 {
3448 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003449 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003450 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003451 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003452 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003453 }
3454 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 }
3456 else
3457 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003458 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003459 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 ;
3461
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003463 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003465 ? "enddef" : "endfunction", 4)
3466 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003468 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003469 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003470 char_u *nextcmd = NULL;
3471
3472 if (*p == '|')
3473 nextcmd = p + 1;
3474 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3475 nextcmd = line_arg;
3476 else if (*p != NUL && *p != '"' && p_verbose > 0)
3477 give_warning2(eap->cmdidx == CMD_def
3478 ? (char_u *)_("W1001: Text found after :enddef: %s")
3479 : (char_u *)_("W22: Text found after :endfunction: %s"),
3480 p, TRUE);
3481 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003482 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003483 // Another command follows. If the line came from "eap"
3484 // we can simply point into it, otherwise we need to
3485 // change "eap->cmdlinep".
3486 eap->nextcmd = nextcmd;
3487 if (line_to_free != NULL)
3488 {
3489 vim_free(*eap->cmdlinep);
3490 *eap->cmdlinep = line_to_free;
3491 line_to_free = NULL;
3492 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003493 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003494 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003495 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 }
3497
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003498 // Check for mismatched "endfunc" or "enddef".
3499 // We don't check for "def" inside "func" thus we also can't check
3500 // for "enddef".
3501 // We continue to find the end of the function, although we might
3502 // not find it.
3503 else if (nesting_def[nesting])
3504 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003505 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003506 emsg(_(e_mismatched_endfunction));
3507 }
3508 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3509 emsg(_(e_mismatched_enddef));
3510
Bram Moolenaare38eab22019-12-05 21:50:01 +01003511 // Increase indent inside "if", "while", "for" and "try", decrease
3512 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003514 indent -= 2;
3515 else if (STRNCMP(p, "if", 2) == 0
3516 || STRNCMP(p, "wh", 2) == 0
3517 || STRNCMP(p, "for", 3) == 0
3518 || STRNCMP(p, "try", 3) == 0)
3519 indent += 2;
3520
Bram Moolenaare38eab22019-12-05 21:50:01 +01003521 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003522 // Only recognize "def" inside "def", not inside "function",
3523 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003524 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003525 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003526 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003527 {
3528 if (*p == '!')
3529 p = skipwhite(p + 1);
3530 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003531 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3532 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533 if (*skipwhite(p) == '(')
3534 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003535 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003536 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003537 else
3538 {
3539 ++nesting;
3540 nesting_def[nesting] = (c == 'd');
3541 indent += 2;
3542 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 }
3544 }
3545
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003546 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003547 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003548 if (eap->cmdidx != CMD_def
3549 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003550 || (p[0] == 'c'
3551 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3552 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3553 && (STRNCMP(&p[3], "nge", 3) != 0
3554 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 || (p[0] == 'i'
3556 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003557 && (!ASCII_ISALPHA(p[2])
3558 || (p[2] == 's'
3559 && (!ASCII_ISALPHA(p[3])
3560 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 skip_until = vim_strsave((char_u *)".");
3562
Bram Moolenaare38eab22019-12-05 21:50:01 +01003563 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 arg = skipwhite(skiptowhite(p));
3565 if (arg[0] == '<' && arg[1] =='<'
3566 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003567 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3568 || ((p[2] == '3' || p[2] == 'x')
3569 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 || (p[0] == 'p' && p[1] == 'e'
3571 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3572 || (p[0] == 't' && p[1] == 'c'
3573 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3574 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3575 && !ASCII_ISALPHA(p[3]))
3576 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3577 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3578 || (p[0] == 'm' && p[1] == 'z'
3579 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3580 ))
3581 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003582 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003584 if (STRNCMP(p, "trim", 4) == 0)
3585 {
3586 // Ignore leading white space.
3587 p = skipwhite(p + 4);
3588 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003589 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003590 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 if (*p == NUL)
3592 skip_until = vim_strsave((char_u *)".");
3593 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003594 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003595 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003596 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003598
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003599 // Check for ":cmd v =<< [trim] EOF"
3600 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003601 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003602 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003603 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003604 if (*arg == '[')
3605 arg = vim_strchr(arg, ']');
3606 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003607 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003608 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3609 && arg[1] == '<' && arg[2] =='<');
3610
3611 if (!found)
3612 // skip over the argument after "cmd"
3613 arg = skipwhite(skiptowhite(arg));
3614 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003615 && (checkforcmd(&p, "let", 2)
3616 || checkforcmd(&p, "var", 3)
3617 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003618 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003619 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003620 p = skipwhite(arg + 3);
3621 if (STRNCMP(p, "trim", 4) == 0)
3622 {
3623 // Ignore leading white space.
3624 p = skipwhite(p + 4);
3625 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003626 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003627 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003628 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003629 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003630 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003631 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003632 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 }
3634
Bram Moolenaare38eab22019-12-05 21:50:01 +01003635 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003637 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003638
Bram Moolenaare38eab22019-12-05 21:50:01 +01003639 // Copy the line to newly allocated memory. get_one_sourceline()
3640 // allocates 250 bytes per line, this saves 80% on average. The cost
3641 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003643 if (p == NULL)
3644 goto erret;
3645 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646
Bram Moolenaare38eab22019-12-05 21:50:01 +01003647 // Add NULL lines for continuation lines, so that the line count is
3648 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 while (sourcing_lnum_off-- > 0)
3650 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3651
Bram Moolenaare38eab22019-12-05 21:50:01 +01003652 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 if (line_arg != NULL && *line_arg == NUL)
3654 line_arg = NULL;
3655 }
3656
Bram Moolenaare38eab22019-12-05 21:50:01 +01003657 // Don't define the function when skipping commands or when an error was
3658 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003659 if (eap->skip || did_emsg)
3660 goto erret;
3661
3662 /*
3663 * If there are no errors, add the function
3664 */
3665 if (fudi.fd_dict == NULL)
3666 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003667 hashtab_T *ht;
3668
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003669 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003670 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3671 {
3672 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3673 name);
3674 goto erret;
3675 }
3676
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003677 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003678 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003680 char_u *uname = untrans_function_name(name);
3681
3682 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3683 }
3684
3685 if (fp != NULL || import != NULL)
3686 {
3687 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003688
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003689 // Function can be replaced with "function!" and when sourcing the
3690 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003691 // A name that is used by an import can not be overruled.
3692 if (import != NULL
3693 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003694 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003695 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003697 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003698 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003699 else
3700 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 goto erret;
3702 }
3703 if (fp->uf_calls > 0)
3704 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003705 emsg_funcname(
3706 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 name);
3708 goto erret;
3709 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003710 if (fp->uf_refcount > 1)
3711 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003712 // This function is referenced somewhere, don't redefine it but
3713 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003714 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003715 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003716 fp = NULL;
3717 overwrite = TRUE;
3718 }
3719 else
3720 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003721 char_u *exp_name = fp->uf_name_exp;
3722
3723 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003724 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003725 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003726 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003727 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003728 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003729#ifdef FEAT_PROFILE
3730 fp->uf_profiling = FALSE;
3731 fp->uf_prof_initialized = FALSE;
3732#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003733 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003734 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 }
3736 }
3737 else
3738 {
3739 char numbuf[20];
3740
3741 fp = NULL;
3742 if (fudi.fd_newkey == NULL && !eap->forceit)
3743 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003744 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003745 goto erret;
3746 }
3747 if (fudi.fd_di == NULL)
3748 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003749 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003750 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003751 goto erret;
3752 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003753 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003754 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 goto erret;
3756
Bram Moolenaare38eab22019-12-05 21:50:01 +01003757 // Give the function a sequential number. Can only be used with a
3758 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759 vim_free(name);
3760 sprintf(numbuf, "%d", ++func_nr);
3761 name = vim_strsave((char_u *)numbuf);
3762 if (name == NULL)
3763 goto erret;
3764 }
3765
3766 if (fp == NULL)
3767 {
3768 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3769 {
3770 int slen, plen;
3771 char_u *scriptname;
3772
Bram Moolenaare38eab22019-12-05 21:50:01 +01003773 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003774 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003775 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 {
3777 scriptname = autoload_name(name);
3778 if (scriptname != NULL)
3779 {
3780 p = vim_strchr(scriptname, '/');
3781 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003782 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003784 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 j = OK;
3786 vim_free(scriptname);
3787 }
3788 }
3789 if (j == FAIL)
3790 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003791 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 goto erret;
3793 }
3794 }
3795
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003796 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 if (fp == NULL)
3798 goto erret;
3799
3800 if (fudi.fd_dict != NULL)
3801 {
3802 if (fudi.fd_di == NULL)
3803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003804 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003805 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3806 if (fudi.fd_di == NULL)
3807 {
3808 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003809 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 goto erret;
3811 }
3812 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3813 {
3814 vim_free(fudi.fd_di);
3815 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003816 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 goto erret;
3818 }
3819 }
3820 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003821 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 clear_tv(&fudi.fd_di->di_tv);
3823 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825
Bram Moolenaare38eab22019-12-05 21:50:01 +01003826 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 flags |= FC_DICT;
3828 }
3829
Bram Moolenaare38eab22019-12-05 21:50:01 +01003830 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003831 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003832 if (overwrite)
3833 {
3834 hi = hash_find(&func_hashtab, name);
3835 hi->hi_key = UF2HIKEY(fp);
3836 }
3837 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003838 {
3839 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003840 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003841 goto erret;
3842 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003843 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003844 }
3845 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003846 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003847 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003848 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003849
3850 if (eap->cmdidx == CMD_def)
3851 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003852 int lnum_save = SOURCING_LNUM;
3853 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003854
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003855 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003856
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003857 // error messages are for the first function line
3858 SOURCING_LNUM = sourcing_lnum_top;
3859
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003860 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003861 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003862 int count = cstack->cs_idx + 1;
3863 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003864
3865 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003866 // a block that is visible now but not when the function is called
3867 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003868 fp->uf_block_ids = ALLOC_MULT(int, count);
3869 if (fp->uf_block_ids != NULL)
3870 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003871 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003872 sizeof(int) * count);
3873 fp->uf_block_depth = count;
3874 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003875
3876 // Set flag in each block to indicate a function was defined. This
3877 // is used to keep the variable when leaving the block, see
3878 // hide_script_var().
3879 for (i = 0; i <= cstack->cs_idx; ++i)
3880 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003881 }
3882
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003883 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003884 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003885 SOURCING_LNUM = lnum_save;
3886 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003887 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003888 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889
3890 // parse the return type, if any
3891 if (ret_type == NULL)
3892 fp->uf_ret_type = &t_void;
3893 else
3894 {
3895 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003896 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003897 if (fp->uf_ret_type == NULL)
3898 {
3899 fp->uf_ret_type = &t_void;
3900 SOURCING_LNUM = lnum_save;
3901 goto erret;
3902 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003903 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003904 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003905 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003906 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003907 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003908
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003910 if ((flags & FC_CLOSURE) != 0)
3911 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003912 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003913 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003914 }
3915 else
3916 fp->uf_scoped = NULL;
3917
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 if (prof_def_func())
3920 func_do_profile(fp);
3921#endif
3922 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003923 if (sandbox)
3924 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003925 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003926 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 fp->uf_flags = flags;
3928 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003929 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003930 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003931 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003932 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003933 if (is_export)
3934 {
3935 fp->uf_flags |= FC_EXPORT;
3936 // let ex_export() know the export worked.
3937 is_export = FALSE;
3938 }
3939
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003940 if (eap->cmdidx == CMD_def)
3941 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003942 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3943 // :func does not use Vim9 script syntax, even in a Vim9 script file
3944 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003945
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 goto ret_free;
3947
3948erret:
3949 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003950 ga_clear_strings(&default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003951errret_2:
3952 ga_clear_strings(&newlines);
3953ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003954 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003955 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003956 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003957 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003958 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003959 if (name != name_arg)
3960 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003961 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003962 did_emsg |= saved_did_emsg;
3963 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003964
3965 return fp;
3966}
3967
3968/*
3969 * ":function"
3970 */
3971 void
3972ex_function(exarg_T *eap)
3973{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003974 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02003975}
3976
3977/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003978 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01003979 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02003980 */
3981 void
3982ex_defcompile(exarg_T *eap UNUSED)
3983{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02003984 long todo = (long)func_hashtab.ht_used;
3985 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003986 hashitem_T *hi;
3987 ufunc_T *ufunc;
3988
3989 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3990 {
3991 if (!HASHITEM_EMPTY(hi))
3992 {
3993 --todo;
3994 ufunc = HI2UF(hi);
3995 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02003996 && ufunc->uf_def_status == UF_TO_BE_COMPILED
3997 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02003998 {
Bram Moolenaarb2049902021-01-24 12:53:53 +01003999 compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004000
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004001 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004002 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004003 // a function has been added or removed, need to start over
4004 todo = (long)func_hashtab.ht_used;
4005 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004006 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004007 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004008 }
4009 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004010 }
4011 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012}
4013
4014/*
4015 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4016 * Return 2 if "p" starts with "s:".
4017 * Return 0 otherwise.
4018 */
4019 int
4020eval_fname_script(char_u *p)
4021{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004022 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4023 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4025 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4026 return 5;
4027 if (p[0] == 's' && p[1] == ':')
4028 return 2;
4029 return 0;
4030}
4031
4032 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004033translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034{
4035 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004036 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004037 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004038}
4039
4040/*
4041 * Return TRUE when "ufunc" has old-style "..." varargs
4042 * or named varargs "...name: type".
4043 */
4044 int
4045has_varargs(ufunc_T *ufunc)
4046{
4047 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048}
4049
4050/*
4051 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004052 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 */
4054 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004055function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056{
4057 char_u *nm = name;
4058 char_u *p;
4059 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004060 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004061 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004063 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4064 if (no_deref)
4065 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004066 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 nm = skipwhite(nm);
4068
Bram Moolenaare38eab22019-12-05 21:50:01 +01004069 // Only accept "funcname", "funcname ", "funcname (..." and
4070 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004072 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 vim_free(p);
4074 return n;
4075}
4076
Bram Moolenaar113e1072019-01-20 15:30:40 +01004077#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 char_u *
4079get_expanded_name(char_u *name, int check)
4080{
4081 char_u *nm = name;
4082 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004083 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004085 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004086 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004088 if (p != NULL && *nm == NUL
4089 && (!check || translated_function_exists(p, is_global)))
4090 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091
4092 vim_free(p);
4093 return NULL;
4094}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004095#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004096
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004097/*
4098 * Function given to ExpandGeneric() to obtain the list of user defined
4099 * function names.
4100 */
4101 char_u *
4102get_user_func_name(expand_T *xp, int idx)
4103{
4104 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004105 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004106 static hashitem_T *hi;
4107 ufunc_T *fp;
4108
4109 if (idx == 0)
4110 {
4111 done = 0;
4112 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004113 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004114 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004115 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116 {
4117 if (done++ > 0)
4118 ++hi;
4119 while (HASHITEM_EMPTY(hi))
4120 ++hi;
4121 fp = HI2UF(hi);
4122
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004123 // don't show dead, dict and lambda functions
4124 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004125 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004126 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004127
4128 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004129 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004130
4131 cat_func_name(IObuff, fp);
4132 if (xp->xp_context != EXPAND_USER_FUNC)
4133 {
4134 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 STRCAT(IObuff, ")");
4137 }
4138 return IObuff;
4139 }
4140 return NULL;
4141}
4142
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004143/*
4144 * ":delfunction {name}"
4145 */
4146 void
4147ex_delfunction(exarg_T *eap)
4148{
4149 ufunc_T *fp = NULL;
4150 char_u *p;
4151 char_u *name;
4152 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004153 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154
4155 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004156 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4157 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 vim_free(fudi.fd_newkey);
4159 if (name == NULL)
4160 {
4161 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004162 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004163 return;
4164 }
4165 if (!ends_excmd(*skipwhite(p)))
4166 {
4167 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004168 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 return;
4170 }
4171 eap->nextcmd = check_nextcmd(p);
4172 if (eap->nextcmd != NULL)
4173 *p = NUL;
4174
4175 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004176 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 vim_free(name);
4178
4179 if (!eap->skip)
4180 {
4181 if (fp == NULL)
4182 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004183 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004184 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 return;
4186 }
4187 if (fp->uf_calls > 0)
4188 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004189 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 return;
4191 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004192 if (fp->uf_flags & FC_VIM9)
4193 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004194 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004195 return;
4196 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004197
4198 if (fudi.fd_dict != NULL)
4199 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004200 // Delete the dict item that refers to the function, it will
4201 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4203 }
4204 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004205 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004206 // A normal function (not a numbered function or lambda) has a
4207 // refcount of 1 for the entry in the hashtable. When deleting
4208 // it and the refcount is more than one, it should be kept.
4209 // A numbered function and lambda should be kept if the refcount is
4210 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004211 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004212 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004213 // Function is still referenced somewhere. Don't free it but
4214 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004215 if (func_remove(fp))
4216 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004217 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004218 }
4219 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004220 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004221 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222 }
4223}
4224
4225/*
4226 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004227 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004228 */
4229 void
4230func_unref(char_u *name)
4231{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004232 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004233
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004234 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004236 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004237 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004238 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004239#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004240 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004242 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004244 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004245}
4246
4247/*
4248 * Unreference a Function: decrement the reference count and free it when it
4249 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004250 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004251 */
4252 void
4253func_ptr_unref(ufunc_T *fp)
4254{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004255 if (fp != NULL && (--fp->uf_refcount <= 0
4256 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4257 && fp->uf_partial->pt_refcount <= 1
4258 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004259 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004260 // Only delete it when it's not being used. Otherwise it's done
4261 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004262 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004263 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264 }
4265}
4266
4267/*
4268 * Count a reference to a Function.
4269 */
4270 void
4271func_ref(char_u *name)
4272{
4273 ufunc_T *fp;
4274
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004275 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004276 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004277 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004278 if (fp != NULL)
4279 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004281 // Only give an error for a numbered function.
4282 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004283 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004284}
4285
4286/*
4287 * Count a reference to a Function.
4288 */
4289 void
4290func_ptr_ref(ufunc_T *fp)
4291{
4292 if (fp != NULL)
4293 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294}
4295
4296/*
4297 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4298 * referenced from anywhere that is in use.
4299 */
4300 static int
4301can_free_funccal(funccall_T *fc, int copyID)
4302{
4303 return (fc->l_varlist.lv_copyID != copyID
4304 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004305 && fc->l_avars.dv_copyID != copyID
4306 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307}
4308
4309/*
4310 * ":return [expr]"
4311 */
4312 void
4313ex_return(exarg_T *eap)
4314{
4315 char_u *arg = eap->arg;
4316 typval_T rettv;
4317 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004318 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319
4320 if (current_funccal == NULL)
4321 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004322 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323 return;
4324 }
4325
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004326 CLEAR_FIELD(evalarg);
4327 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4328
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 if (eap->skip)
4330 ++emsg_skip;
4331
4332 eap->nextcmd = NULL;
4333 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004334 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 {
4336 if (!eap->skip)
4337 returning = do_return(eap, FALSE, TRUE, &rettv);
4338 else
4339 clear_tv(&rettv);
4340 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004341 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342 else if (!eap->skip)
4343 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004344 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004345 update_force_abort();
4346
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 /*
4348 * Return unless the expression evaluation has been cancelled due to an
4349 * aborting error, an interrupt, or an exception.
4350 */
4351 if (!aborting())
4352 returning = do_return(eap, FALSE, TRUE, NULL);
4353 }
4354
Bram Moolenaare38eab22019-12-05 21:50:01 +01004355 // When skipping or the return gets pending, advance to the next command
4356 // in this line (!returning). Otherwise, ignore the rest of the line.
4357 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358 if (returning)
4359 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004360 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 eap->nextcmd = check_nextcmd(arg);
4362
4363 if (eap->skip)
4364 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004365 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366}
4367
4368/*
4369 * ":1,25call func(arg1, arg2)" function call.
4370 */
4371 void
4372ex_call(exarg_T *eap)
4373{
4374 char_u *arg = eap->arg;
4375 char_u *startarg;
4376 char_u *name;
4377 char_u *tofree;
4378 int len;
4379 typval_T rettv;
4380 linenr_T lnum;
4381 int doesrange;
4382 int failed = FALSE;
4383 funcdict_T fudi;
4384 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004385 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004386 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004387
Bram Moolenaare6b53242020-07-01 17:28:33 +02004388 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389 if (eap->skip)
4390 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004391 // trans_function_name() doesn't work well when skipping, use eval0()
4392 // instead to skip to any following command, e.g. for:
4393 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004395 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004396 clear_tv(&rettv);
4397 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004398 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 return;
4400 }
4401
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004402 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4403 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404 if (fudi.fd_newkey != NULL)
4405 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004406 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004407 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 vim_free(fudi.fd_newkey);
4409 }
4410 if (tofree == NULL)
4411 return;
4412
Bram Moolenaare38eab22019-12-05 21:50:01 +01004413 // Increase refcount on dictionary, it could get deleted when evaluating
4414 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 if (fudi.fd_dict != NULL)
4416 ++fudi.fd_dict->dv_refcount;
4417
Bram Moolenaare38eab22019-12-05 21:50:01 +01004418 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4419 // contents. For VAR_PARTIAL get its partial, unless we already have one
4420 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004422 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4423 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424
Bram Moolenaare38eab22019-12-05 21:50:01 +01004425 // Skip white space to allow ":call func ()". Not good, but required for
4426 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004428 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429
4430 if (*startarg != '(')
4431 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004432 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 goto end;
4434 }
4435
4436 /*
4437 * When skipping, evaluate the function once, to find the end of the
4438 * arguments.
4439 * When the function takes a range, this is discovered after the first
4440 * call, and the loop is broken.
4441 */
4442 if (eap->skip)
4443 {
4444 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 }
4447 else
4448 lnum = eap->line1;
4449 for ( ; lnum <= eap->line2; ++lnum)
4450 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004451 funcexe_T funcexe;
4452
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453 if (!eap->skip && eap->addr_count > 0)
4454 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004455 if (lnum > curbuf->b_ml.ml_line_count)
4456 {
4457 // If the function deleted lines or switched to another buffer
4458 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004459 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004460 break;
4461 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462 curwin->w_cursor.lnum = lnum;
4463 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 }
4466 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004467
Bram Moolenaara80faa82020-04-12 19:37:17 +02004468 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004469 funcexe.firstline = eap->line1;
4470 funcexe.lastline = eap->line2;
4471 funcexe.doesrange = &doesrange;
4472 funcexe.evaluate = !eap->skip;
4473 funcexe.partial = partial;
4474 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004475 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004476 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477 {
4478 failed = TRUE;
4479 break;
4480 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004481 if (has_watchexpr())
4482 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004484 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004485 if (handle_subscript(&arg, &rettv,
4486 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 {
4488 failed = TRUE;
4489 break;
4490 }
4491
4492 clear_tv(&rettv);
4493 if (doesrange || eap->skip)
4494 break;
4495
Bram Moolenaare38eab22019-12-05 21:50:01 +01004496 // Stop when immediately aborting on error, or when an interrupt
4497 // occurred or an exception was thrown but not caught.
4498 // get_func_tv() returned OK, so that the check for trailing
4499 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 if (aborting())
4501 break;
4502 }
4503 if (eap->skip)
4504 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004505 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506
Bram Moolenaare51bb172020-02-16 19:42:23 +01004507 // When inside :try we need to check for following "| catch".
4508 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004510 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004511 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004512 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004513 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004514 if (!failed)
4515 {
4516 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004517 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 }
4520 else
4521 eap->nextcmd = check_nextcmd(arg);
4522 }
4523
4524end:
4525 dict_unref(fudi.fd_dict);
4526 vim_free(tofree);
4527}
4528
4529/*
4530 * Return from a function. Possibly makes the return pending. Also called
4531 * for a pending return at the ":endtry" or after returning from an extra
4532 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4533 * when called due to a ":return" command. "rettv" may point to a typval_T
4534 * with the return rettv. Returns TRUE when the return can be carried out,
4535 * FALSE when the return gets pending.
4536 */
4537 int
4538do_return(
4539 exarg_T *eap,
4540 int reanimate,
4541 int is_cmd,
4542 void *rettv)
4543{
4544 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004545 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546
4547 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004548 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 current_funccal->returned = FALSE;
4550
4551 /*
4552 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4553 * not in its finally clause (which then is to be executed next) is found.
4554 * In this case, make the ":return" pending for execution at the ":endtry".
4555 * Otherwise, return normally.
4556 */
4557 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4558 if (idx >= 0)
4559 {
4560 cstack->cs_pending[idx] = CSTP_RETURN;
4561
4562 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004563 // A pending return again gets pending. "rettv" points to an
4564 // allocated variable with the rettv of the original ":return"'s
4565 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004566 cstack->cs_rettv[idx] = rettv;
4567 else
4568 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004569 // When undoing a return in order to make it pending, get the stored
4570 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 if (reanimate)
4572 rettv = current_funccal->rettv;
4573
4574 if (rettv != NULL)
4575 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004576 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4578 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4579 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004580 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 }
4582 else
4583 cstack->cs_rettv[idx] = NULL;
4584
4585 if (reanimate)
4586 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004587 // The pending return value could be overwritten by a ":return"
4588 // without argument in a finally clause; reset the default
4589 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 current_funccal->rettv->v_type = VAR_NUMBER;
4591 current_funccal->rettv->vval.v_number = 0;
4592 }
4593 }
4594 report_make_pending(CSTP_RETURN, rettv);
4595 }
4596 else
4597 {
4598 current_funccal->returned = TRUE;
4599
Bram Moolenaare38eab22019-12-05 21:50:01 +01004600 // If the return is carried out now, store the return value. For
4601 // a return immediately after reanimation, the value is already
4602 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 if (!reanimate && rettv != NULL)
4604 {
4605 clear_tv(current_funccal->rettv);
4606 *current_funccal->rettv = *(typval_T *)rettv;
4607 if (!is_cmd)
4608 vim_free(rettv);
4609 }
4610 }
4611
4612 return idx < 0;
4613}
4614
4615/*
4616 * Free the variable with a pending return value.
4617 */
4618 void
4619discard_pending_return(void *rettv)
4620{
4621 free_tv((typval_T *)rettv);
4622}
4623
4624/*
4625 * Generate a return command for producing the value of "rettv". The result
4626 * is an allocated string. Used by report_pending() for verbose messages.
4627 */
4628 char_u *
4629get_return_cmd(void *rettv)
4630{
4631 char_u *s = NULL;
4632 char_u *tofree = NULL;
4633 char_u numbuf[NUMBUFLEN];
4634
4635 if (rettv != NULL)
4636 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4637 if (s == NULL)
4638 s = (char_u *)"";
4639
4640 STRCPY(IObuff, ":return ");
4641 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4642 if (STRLEN(s) + 8 >= IOSIZE)
4643 STRCPY(IObuff + IOSIZE - 4, "...");
4644 vim_free(tofree);
4645 return vim_strsave(IObuff);
4646}
4647
4648/*
4649 * Get next function line.
4650 * Called by do_cmdline() to get the next line.
4651 * Returns allocated string, or NULL for end of function.
4652 */
4653 char_u *
4654get_func_line(
4655 int c UNUSED,
4656 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004657 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004658 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659{
4660 funccall_T *fcp = (funccall_T *)cookie;
4661 ufunc_T *fp = fcp->func;
4662 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004663 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664
Bram Moolenaare38eab22019-12-05 21:50:01 +01004665 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004666 if (fcp->dbg_tick != debug_tick)
4667 {
4668 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004669 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670 fcp->dbg_tick = debug_tick;
4671 }
4672#ifdef FEAT_PROFILE
4673 if (do_profiling == PROF_YES)
4674 func_line_end(cookie);
4675#endif
4676
4677 gap = &fp->uf_lines;
4678 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4679 || fcp->returned)
4680 retval = NULL;
4681 else
4682 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004683 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 while (fcp->linenr < gap->ga_len
4685 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4686 ++fcp->linenr;
4687 if (fcp->linenr >= gap->ga_len)
4688 retval = NULL;
4689 else
4690 {
4691 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004692 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693#ifdef FEAT_PROFILE
4694 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004695 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696#endif
4697 }
4698 }
4699
Bram Moolenaare38eab22019-12-05 21:50:01 +01004700 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004701 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004703 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004704 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004705 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004706 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 fcp->dbg_tick = debug_tick;
4708 }
4709
4710 return retval;
4711}
4712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713/*
4714 * Return TRUE if the currently active function should be ended, because a
4715 * return was encountered or an error occurred. Used inside a ":while".
4716 */
4717 int
4718func_has_ended(void *cookie)
4719{
4720 funccall_T *fcp = (funccall_T *)cookie;
4721
Bram Moolenaare38eab22019-12-05 21:50:01 +01004722 // Ignore the "abort" flag if the abortion behavior has been changed due to
4723 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4725 || fcp->returned);
4726}
4727
4728/*
4729 * return TRUE if cookie indicates a function which "abort"s on errors.
4730 */
4731 int
4732func_has_abort(
4733 void *cookie)
4734{
4735 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4736}
4737
4738
4739/*
4740 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4741 * Don't do this when "Func" is already a partial that was bound
4742 * explicitly (pt_auto is FALSE).
4743 * Changes "rettv" in-place.
4744 * Returns the updated "selfdict_in".
4745 */
4746 dict_T *
4747make_partial(dict_T *selfdict_in, typval_T *rettv)
4748{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004749 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004750 char_u *tofree = NULL;
4751 ufunc_T *fp;
4752 char_u fname_buf[FLEN_FIXED + 1];
4753 int error;
4754 dict_T *selfdict = selfdict_in;
4755
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004756 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4757 fp = rettv->vval.v_partial->pt_func;
4758 else
4759 {
4760 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4761 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004762 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004763 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004764 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004765 vim_free(tofree);
4766 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767
4768 if (fp != NULL && (fp->uf_flags & FC_DICT))
4769 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004770 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771
4772 if (pt != NULL)
4773 {
4774 pt->pt_refcount = 1;
4775 pt->pt_dict = selfdict;
4776 pt->pt_auto = TRUE;
4777 selfdict = NULL;
4778 if (rettv->v_type == VAR_FUNC)
4779 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004780 // Just a function: Take over the function name and use
4781 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 pt->pt_name = rettv->vval.v_string;
4783 }
4784 else
4785 {
4786 partial_T *ret_pt = rettv->vval.v_partial;
4787 int i;
4788
Bram Moolenaare38eab22019-12-05 21:50:01 +01004789 // Partial: copy the function name, use selfdict and copy
4790 // args. Can't take over name or args, the partial might
4791 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004792 if (ret_pt->pt_name != NULL)
4793 {
4794 pt->pt_name = vim_strsave(ret_pt->pt_name);
4795 func_ref(pt->pt_name);
4796 }
4797 else
4798 {
4799 pt->pt_func = ret_pt->pt_func;
4800 func_ptr_ref(pt->pt_func);
4801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004802 if (ret_pt->pt_argc > 0)
4803 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004804 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004805 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004806 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 pt->pt_argc = 0;
4808 else
4809 {
4810 pt->pt_argc = ret_pt->pt_argc;
4811 for (i = 0; i < pt->pt_argc; i++)
4812 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4813 }
4814 }
4815 partial_unref(ret_pt);
4816 }
4817 rettv->v_type = VAR_PARTIAL;
4818 rettv->vval.v_partial = pt;
4819 }
4820 }
4821 return selfdict;
4822}
4823
4824/*
4825 * Return the name of the executed function.
4826 */
4827 char_u *
4828func_name(void *cookie)
4829{
4830 return ((funccall_T *)cookie)->func->uf_name;
4831}
4832
4833/*
4834 * Return the address holding the next breakpoint line for a funccall cookie.
4835 */
4836 linenr_T *
4837func_breakpoint(void *cookie)
4838{
4839 return &((funccall_T *)cookie)->breakpoint;
4840}
4841
4842/*
4843 * Return the address holding the debug tick for a funccall cookie.
4844 */
4845 int *
4846func_dbg_tick(void *cookie)
4847{
4848 return &((funccall_T *)cookie)->dbg_tick;
4849}
4850
4851/*
4852 * Return the nesting level for a funccall cookie.
4853 */
4854 int
4855func_level(void *cookie)
4856{
4857 return ((funccall_T *)cookie)->level;
4858}
4859
4860/*
4861 * Return TRUE when a function was ended by a ":return" command.
4862 */
4863 int
4864current_func_returned(void)
4865{
4866 return current_funccal->returned;
4867}
4868
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869 int
4870free_unref_funccal(int copyID, int testing)
4871{
4872 int did_free = FALSE;
4873 int did_free_funccal = FALSE;
4874 funccall_T *fc, **pfc;
4875
4876 for (pfc = &previous_funccal; *pfc != NULL; )
4877 {
4878 if (can_free_funccal(*pfc, copyID))
4879 {
4880 fc = *pfc;
4881 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004882 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004883 did_free = TRUE;
4884 did_free_funccal = TRUE;
4885 }
4886 else
4887 pfc = &(*pfc)->caller;
4888 }
4889 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004890 // When a funccal was freed some more items might be garbage
4891 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004892 (void)garbage_collect(testing);
4893
4894 return did_free;
4895}
4896
4897/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004898 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004899 */
4900 static funccall_T *
4901get_funccal(void)
4902{
4903 int i;
4904 funccall_T *funccal;
4905 funccall_T *temp_funccal;
4906
4907 funccal = current_funccal;
4908 if (debug_backtrace_level > 0)
4909 {
4910 for (i = 0; i < debug_backtrace_level; i++)
4911 {
4912 temp_funccal = funccal->caller;
4913 if (temp_funccal)
4914 funccal = temp_funccal;
4915 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004916 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004917 debug_backtrace_level = i;
4918 }
4919 }
4920 return funccal;
4921}
4922
4923/*
4924 * Return the hashtable used for local variables in the current funccal.
4925 * Return NULL if there is no current funccal.
4926 */
4927 hashtab_T *
4928get_funccal_local_ht()
4929{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004930 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 return NULL;
4932 return &get_funccal()->l_vars.dv_hashtab;
4933}
4934
4935/*
4936 * Return the l: scope variable.
4937 * Return NULL if there is no current funccal.
4938 */
4939 dictitem_T *
4940get_funccal_local_var()
4941{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004942 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 return NULL;
4944 return &get_funccal()->l_vars_var;
4945}
4946
4947/*
4948 * Return the hashtable used for argument in the current funccal.
4949 * Return NULL if there is no current funccal.
4950 */
4951 hashtab_T *
4952get_funccal_args_ht()
4953{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004954 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004955 return NULL;
4956 return &get_funccal()->l_avars.dv_hashtab;
4957}
4958
4959/*
4960 * Return the a: scope variable.
4961 * Return NULL if there is no current funccal.
4962 */
4963 dictitem_T *
4964get_funccal_args_var()
4965{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004966 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004967 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01004968 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004969}
4970
4971/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004972 * List function variables, if there is a function.
4973 */
4974 void
4975list_func_vars(int *first)
4976{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004977 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01004979 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980}
4981
4982/*
4983 * If "ht" is the hashtable for local variables in the current funccal, return
4984 * the dict that contains it.
4985 * Otherwise return NULL.
4986 */
4987 dict_T *
4988get_current_funccal_dict(hashtab_T *ht)
4989{
4990 if (current_funccal != NULL
4991 && ht == &current_funccal->l_vars.dv_hashtab)
4992 return &current_funccal->l_vars;
4993 return NULL;
4994}
4995
4996/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004997 * Search hashitem in parent scope.
4998 */
4999 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005000find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005001{
5002 funccall_T *old_current_funccal = current_funccal;
5003 hashtab_T *ht;
5004 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005005 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005006
5007 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5008 return NULL;
5009
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005010 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005011 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005012 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005013 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005014 ht = find_var_ht(name, &varname);
5015 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005016 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005017 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005018 if (!HASHITEM_EMPTY(hi))
5019 {
5020 *pht = ht;
5021 break;
5022 }
5023 }
5024 if (current_funccal == current_funccal->func->uf_scoped)
5025 break;
5026 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005027 }
5028 current_funccal = old_current_funccal;
5029
5030 return hi;
5031}
5032
5033/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005034 * Search variable in parent scope.
5035 */
5036 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005037find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005038{
5039 dictitem_T *v = NULL;
5040 funccall_T *old_current_funccal = current_funccal;
5041 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005042 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005043
5044 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5045 return NULL;
5046
Bram Moolenaare38eab22019-12-05 21:50:01 +01005047 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005048 current_funccal = current_funccal->func->uf_scoped;
5049 while (current_funccal)
5050 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005051 ht = find_var_ht(name, &varname);
5052 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005053 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005054 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005055 if (v != NULL)
5056 break;
5057 }
5058 if (current_funccal == current_funccal->func->uf_scoped)
5059 break;
5060 current_funccal = current_funccal->func->uf_scoped;
5061 }
5062 current_funccal = old_current_funccal;
5063
5064 return v;
5065}
5066
5067/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068 * Set "copyID + 1" in previous_funccal and callers.
5069 */
5070 int
5071set_ref_in_previous_funccal(int copyID)
5072{
5073 int abort = FALSE;
5074 funccall_T *fc;
5075
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005076 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005077 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005078 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005079 abort = abort
5080 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5081 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005082 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005083 }
5084 return abort;
5085}
5086
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005087 static int
5088set_ref_in_funccal(funccall_T *fc, int copyID)
5089{
5090 int abort = FALSE;
5091
5092 if (fc->fc_copyID != copyID)
5093 {
5094 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005095 abort = abort
5096 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5097 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005098 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005099 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005100 }
5101 return abort;
5102}
5103
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104/*
5105 * Set "copyID" in all local vars and arguments in the call stack.
5106 */
5107 int
5108set_ref_in_call_stack(int copyID)
5109{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005110 int abort = FALSE;
5111 funccall_T *fc;
5112 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005114 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005115 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005116
5117 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005118 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5119 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005120 abort = abort || set_ref_in_funccal(fc, copyID);
5121
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005122 return abort;
5123}
5124
5125/*
5126 * Set "copyID" in all functions available by name.
5127 */
5128 int
5129set_ref_in_functions(int copyID)
5130{
5131 int todo;
5132 hashitem_T *hi = NULL;
5133 int abort = FALSE;
5134 ufunc_T *fp;
5135
5136 todo = (int)func_hashtab.ht_used;
5137 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005138 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005139 if (!HASHITEM_EMPTY(hi))
5140 {
5141 --todo;
5142 fp = HI2UF(hi);
5143 if (!func_name_refcount(fp->uf_name))
5144 abort = abort || set_ref_in_func(NULL, fp, copyID);
5145 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146 }
5147 return abort;
5148}
5149
5150/*
5151 * Set "copyID" in all function arguments.
5152 */
5153 int
5154set_ref_in_func_args(int copyID)
5155{
5156 int i;
5157 int abort = FALSE;
5158
5159 for (i = 0; i < funcargs.ga_len; ++i)
5160 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5161 copyID, NULL, NULL);
5162 return abort;
5163}
5164
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005165/*
5166 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005167 * Returns TRUE if setting references failed somehow.
5168 */
5169 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005170set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005171{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005172 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005173 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005174 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005175 char_u fname_buf[FLEN_FIXED + 1];
5176 char_u *tofree = NULL;
5177 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005178 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005179
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005180 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005181 return FALSE;
5182
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005183 if (fp_in == NULL)
5184 {
5185 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005186 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005187 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005188 if (fp != NULL)
5189 {
5190 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005191 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005192 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005193
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005194 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005195 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005196}
5197
Bram Moolenaare38eab22019-12-05 21:50:01 +01005198#endif // FEAT_EVAL