blob: 8579c3b3864a4fd454b180704573ecf156cf5ef4 [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 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010083
84 // Vim9 script: cannot use script var name for argument.
85 if (argtypes != NULL && script_var_exists(arg, p - arg, FALSE, NULL) == OK)
86 {
87 semsg(_(e_variable_already_declared_in_script), arg);
88 return arg;
89 }
90
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010091 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
92 return arg;
93 if (newargs != NULL)
94 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010095 int c;
96 int i;
97
98 c = *p;
99 *p = NUL;
100 arg_copy = vim_strsave(arg);
101 if (arg_copy == NULL)
102 {
103 *p = c;
104 return arg;
105 }
106
107 // Check for duplicate argument name.
108 for (i = 0; i < newargs->ga_len; ++i)
109 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
110 {
111 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
112 vim_free(arg_copy);
113 return arg;
114 }
115 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
116 newargs->ga_len++;
117
118 *p = c;
119 }
120
121 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100122 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100123 {
124 char_u *type = NULL;
125
Bram Moolenaar6e949782020-04-13 17:21:00 +0200126 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
127 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200128 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200129 arg_copy == NULL ? arg : arg_copy);
130 p = skipwhite(p);
131 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100132 if (*p == ':')
133 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200134 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100135 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200136 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100137 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200138 return arg;
139 }
140 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200141 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100142 if (!skip)
143 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100144 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100145 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200146 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200147 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200148 arg_copy == NULL ? arg : arg_copy);
149 return arg;
150 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100151 if (!skip)
152 {
153 if (type == NULL && types_optional)
154 // lambda arguments default to "any" type
155 type = vim_strsave((char_u *)"any");
156 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
157 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100158 }
159
160 return p;
161}
162
163/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200164 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100165 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100166 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200167 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100168 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200169get_function_args(
170 char_u **argp,
171 char_u endchar,
172 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100173 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100174 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200175 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200176 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200177 int skip,
178 exarg_T *eap,
179 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200180{
181 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100182 char_u *arg;
183 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200184 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200185 int any_default = FALSE;
186 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100187 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200188
189 if (newargs != NULL)
190 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100191 if (argtypes != NULL)
192 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200193 if (default_args != NULL)
194 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200195
196 if (varargs != NULL)
197 *varargs = FALSE;
198
199 /*
200 * Isolate the arguments: "arg1, arg2, ...)"
201 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 arg = skipwhite(*argp);
203 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200204 while (*p != endchar)
205 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200206 while (eap != NULL && eap->getline != NULL
207 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200208 {
209 char_u *theline;
210
211 // End of the line, get the next one.
212 theline = eap->getline(':', eap->cookie, 0, TRUE);
213 if (theline == NULL)
214 break;
215 vim_free(*line_to_free);
216 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200217 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200218 p = skipwhite(theline);
219 }
220
221 if (mustend && *p != endchar)
222 {
223 if (!skip)
224 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100225 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200226 }
227 if (*p == endchar)
228 break;
229
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200230 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
231 {
232 if (varargs != NULL)
233 *varargs = TRUE;
234 p += 3;
235 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100236
237 if (argtypes != NULL)
238 {
239 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200240 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100241 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100242 if (!skip)
243 emsg(_(e_missing_name_after_dots));
244 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100245 }
246
247 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100248 p = one_function_arg(p, newargs, argtypes, types_optional,
249 skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100250 if (p == arg)
251 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100252 if (*skipwhite(p) == '=')
253 {
254 emsg(_(e_cannot_use_default_for_variable_arguments));
255 break;
256 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100257 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200258 }
259 else
260 {
261 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100262 p = one_function_arg(p, newargs, argtypes, types_optional, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100263 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200264 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200265
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200266 if (*skipwhite(p) == '=' && default_args != NULL)
267 {
268 typval_T rettv;
269
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100270 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200271 any_default = TRUE;
272 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200273 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200274 p = skipwhite(p);
275 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200276 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200277 {
278 if (ga_grow(default_args, 1) == FAIL)
279 goto err_ret;
280
281 // trim trailing whitespace
282 while (p > expr && VIM_ISWHITE(p[-1]))
283 p--;
284 c = *p;
285 *p = NUL;
286 expr = vim_strsave(expr);
287 if (expr == NULL)
288 {
289 *p = c;
290 goto err_ret;
291 }
292 ((char_u **)(default_args->ga_data))
293 [default_args->ga_len] = expr;
294 default_args->ga_len++;
295 *p = c;
296 }
297 else
298 mustend = TRUE;
299 }
300 else if (any_default)
301 {
302 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200303 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200304 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200305 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200306 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200307 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200308 // Don't give this error when skipping, it makes the "->" not
309 // found in "{k,v -> x}" and give a confusing error.
310 if (!skip && in_vim9script()
311 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
312 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100313 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200314 goto err_ret;
315 }
316 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200317 else
318 mustend = TRUE;
319 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200320 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200321 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200322 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200323
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200324 if (*p != endchar)
325 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100326 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200327
328 *argp = p;
329 return OK;
330
331err_ret:
332 if (newargs != NULL)
333 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200334 if (default_args != NULL)
335 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 return FAIL;
337}
338
339/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100340 * Parse the argument types, filling "fp->uf_arg_types".
341 * Return OK or FAIL.
342 */
343 static int
344parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
345{
346 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
347 if (argtypes->ga_len > 0)
348 {
349 // When "varargs" is set the last name/type goes into uf_va_name
350 // and uf_va_type.
351 int len = argtypes->ga_len - (varargs ? 1 : 0);
352
353 if (len > 0)
354 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
355 if (fp->uf_arg_types != NULL)
356 {
357 int i;
358 type_T *type;
359
360 for (i = 0; i < len; ++ i)
361 {
362 char_u *p = ((char_u **)argtypes->ga_data)[i];
363
364 if (p == NULL)
365 // will get the type from the default value
366 type = &t_unknown;
367 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100368 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100369 if (type == NULL)
370 return FAIL;
371 fp->uf_arg_types[i] = type;
372 }
373 }
374 if (varargs)
375 {
376 char_u *p;
377
378 // Move the last argument "...name: type" to uf_va_name and
379 // uf_va_type.
380 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
381 [fp->uf_args.ga_len - 1];
382 --fp->uf_args.ga_len;
383 p = ((char_u **)argtypes->ga_data)[len];
384 if (p == NULL)
385 // todo: get type from default value
386 fp->uf_va_type = &t_any;
387 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100388 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100389 if (fp->uf_va_type == NULL)
390 return FAIL;
391 }
392 }
393 return OK;
394}
395
396/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200397 * Register function "fp" as using "current_funccal" as its scope.
398 */
399 static int
400register_closure(ufunc_T *fp)
401{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200402 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100403 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200404 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200405 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200406 fp->uf_scoped = current_funccal;
407 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200408
Bram Moolenaar58016442016-07-31 18:30:22 +0200409 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
410 return FAIL;
411 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
412 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200413 return OK;
414}
415
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100416 static void
417set_ufunc_name(ufunc_T *fp, char_u *name)
418{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100419 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
420 // actually extends beyond the struct.
421 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100422
423 if (name[0] == K_SPECIAL)
424 {
425 fp->uf_name_exp = alloc(STRLEN(name) + 3);
426 if (fp->uf_name_exp != NULL)
427 {
428 STRCPY(fp->uf_name_exp, "<SNR>");
429 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
430 }
431 }
432}
433
Bram Moolenaar58016442016-07-31 18:30:22 +0200434/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200435 * Get a name for a lambda. Returned in static memory.
436 */
437 char_u *
438get_lambda_name(void)
439{
440 static char_u name[30];
441 static int lambda_no = 0;
442
443 sprintf((char*)name, "<lambda>%d", ++lambda_no);
444 return name;
445}
446
Bram Moolenaar801ab062020-06-25 19:27:56 +0200447#if defined(FEAT_LUA) || defined(PROTO)
448/*
449 * Registers a native C callback which can be called from Vim script.
450 * Returns the name of the Vim script function.
451 */
452 char_u *
453register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
454{
455 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200456 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200457
458 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
459 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200460 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200461
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200462 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200463 fp->uf_refcount = 1;
464 fp->uf_varargs = TRUE;
465 fp->uf_flags = FC_CFUNC;
466 fp->uf_calls = 0;
467 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200468 fp->uf_cb = cb;
469 fp->uf_cb_free = cb_free;
470 fp->uf_cb_state = state;
471
472 set_ufunc_name(fp, name);
473 hash_add(&func_hashtab, UF2HIKEY(fp));
474
475 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200476}
477#endif
478
Bram Moolenaar04b12692020-05-04 23:24:44 +0200479/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100480 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100481 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100482 * If "white_error" is not NULL check for correct use of white space and set
483 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100484 * Return NULL if no valid arrow found.
485 */
486 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100487skip_arrow(
488 char_u *start,
489 int equal_arrow,
490 char_u **ret_type,
491 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100492{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100493 char_u *s = start;
494 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100495
496 if (equal_arrow)
497 {
498 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100499 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100500 if (white_error != NULL && !VIM_ISWHITE(s[1]))
501 {
502 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100503 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100504 return NULL;
505 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100506 s = skipwhite(s + 1);
507 *ret_type = s;
508 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100509 if (s == *ret_type)
510 {
511 emsg(_(e_missing_return_type));
512 return NULL;
513 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100514 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100515 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100516 s = skipwhite(s);
517 if (*s != '=')
518 return NULL;
519 ++s;
520 }
521 if (*s != '>')
522 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100523 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
524 || !IS_WHITE_OR_NUL(s[1])))
525 {
526 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100527 semsg(_(e_white_space_required_before_and_after_str_at_str),
528 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100529 return NULL;
530 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100531 return skipwhite(s + 1);
532}
533
534/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200535 * Parse a lambda expression and get a Funcref from "*arg".
Bram Moolenaar65c44152020-12-24 15:14:01 +0100536 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100537 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200538 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
539 */
540 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100541get_lambda_tv(
542 char_u **arg,
543 typval_T *rettv,
544 int types_optional,
545 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200546{
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200547 int evaluate = evalarg != NULL
548 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200549 garray_T newargs;
550 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200551 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100552 garray_T argtypes;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200553 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100554 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200555 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100556 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200557 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200558 char_u *s;
559 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200560 int *old_eval_lavars = eval_lavars_used;
561 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100562 char_u *tofree1 = NULL;
563 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100564 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +0100566 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100567
568 if (equal_arrow && !in_vim9script())
569 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200570
571 ga_init(&newargs);
572 ga_init(&newlines);
573
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100574 // First, check if this is really a lambda expression. "->" or "=>" must
575 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100576 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100577 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100578 types_optional ? &argtypes : NULL, types_optional,
579 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100580 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100581 {
582 if (types_optional)
583 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100584 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100585 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200586
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100587 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200588 if (evaluate)
589 pnewargs = &newargs;
590 else
591 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100592 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100593 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100594 types_optional ? &argtypes : NULL, types_optional,
595 &varargs, NULL, FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100596 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100597 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +0100598 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100599 {
600 if (types_optional)
601 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +0100602 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100603 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +0100604 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100605 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200606
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100607 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
608 if (ret_type != NULL)
609 {
610 ret_type = vim_strsave(ret_type);
611 tofree2 = ret_type;
612 }
613
Bram Moolenaare38eab22019-12-05 21:50:01 +0100614 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200615 if (evaluate)
616 eval_lavars_used = &eval_lavars;
617
Bram Moolenaar65c44152020-12-24 15:14:01 +0100618 *arg = skipwhite_and_linebreak(*arg, evalarg);
619
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100620 // Recognize "{" as the start of a function body.
621 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +0100622 {
623 // TODO: process the function body upto the "}".
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100624 // Return type is required then.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100625 emsg("Lambda function body not supported yet");
626 goto errret;
627 }
628
Bram Moolenaare38eab22019-12-05 21:50:01 +0100629 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200630 start = *arg;
631 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200632 if (ret == FAIL)
633 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200634 if (evalarg != NULL)
635 {
636 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100637 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200638 evalarg->eval_tofree = NULL;
639 }
640
Bram Moolenaar65c44152020-12-24 15:14:01 +0100641 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +0100642 {
Bram Moolenaar65c44152020-12-24 15:14:01 +0100643 *arg = skipwhite_and_linebreak(*arg, evalarg);
644 if (**arg != '}')
645 {
646 semsg(_("E451: Expected }: %s"), *arg);
647 goto errret;
648 }
649 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +0100650 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200651
652 if (evaluate)
653 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +0200654 int len;
655 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200656 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200657 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200658
Bram Moolenaar47ed5532019-08-08 20:49:14 +0200659 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200660 if (fp == NULL)
661 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +0200662 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200663 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200664 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200665 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200666
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200667 ga_init2(&newlines, (int)sizeof(char_u *), 1);
668 if (ga_grow(&newlines, 1) == FAIL)
669 goto errret;
670
Bram Moolenaare38eab22019-12-05 21:50:01 +0100671 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200672 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200673 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200674 if (p == NULL)
675 goto errret;
676 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
677 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200678 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +0200679 if (strstr((char *)p + 7, "a:") == NULL)
680 // No a: variables are used for sure.
681 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200682
683 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100684 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200685 hash_add(&func_hashtab, UF2HIKEY(fp));
686 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200687 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100688 if (types_optional)
689 {
690 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
691 goto errret;
692 if (ret_type != NULL)
693 {
694 fp->uf_ret_type = parse_type(&ret_type,
695 &fp->uf_type_list, TRUE);
696 if (fp->uf_ret_type == NULL)
697 goto errret;
698 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +0100699 else
Bram Moolenaar328eac22021-01-07 19:23:08 +0100700 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100701 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100702
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200703 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200704 if (current_funccal != NULL && eval_lavars)
705 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200706 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +0200707 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200708 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200709 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200710
711#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200712 if (prof_def_func())
713 func_do_profile(fp);
714#endif
Bram Moolenaar93343722018-07-10 19:39:18 +0200715 if (sandbox)
716 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100717 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200718 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +0200719 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200720 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200721 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100722 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200723
Bram Moolenaar437bafe2016-08-01 15:40:54 +0200724 pt->pt_func = fp;
725 pt->pt_refcount = 1;
726 rettv->vval.v_partial = pt;
727 rettv->v_type = VAR_PARTIAL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200728 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200729
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200730 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200731 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100732 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200733 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100734 vim_free(tofree1);
735 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100736 if (types_optional)
737 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200738 return OK;
739
740errret:
741 ga_clear_strings(&newargs);
742 ga_clear_strings(&newlines);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100743 if (types_optional)
744 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200745 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +0100746 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +0200747 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100748 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +0200749 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +0100750 vim_free(tofree1);
751 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +0200752 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200753 return FAIL;
754}
755
756/*
757 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
758 * name it contains, otherwise return "name".
759 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
760 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100761 * If "type" is not NULL and a Vim9 script-local variable is found look up the
762 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200763 */
764 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100765deref_func_name(
766 char_u *name,
767 int *lenp,
768 partial_T **partialp,
769 type_T **type,
770 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200771{
772 dictitem_T *v;
773 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100774 char_u *s = NULL;
775 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200776
777 if (partialp != NULL)
778 *partialp = NULL;
779
780 cc = name[*lenp];
781 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100782 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200783 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100784 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200785 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100786 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200787 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100788 if (v->di_tv.vval.v_string == NULL)
789 {
790 *lenp = 0;
791 return (char_u *)""; // just in case
792 }
793 s = v->di_tv.vval.v_string;
794 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200795 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200796
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100797 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200798 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100799 partial_T *pt = v->di_tv.vval.v_partial;
800
801 if (pt == NULL)
802 {
803 *lenp = 0;
804 return (char_u *)""; // just in case
805 }
806 if (partialp != NULL)
807 *partialp = pt;
808 s = partial_name(pt);
809 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200810 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +0100811
812 if (s != NULL)
813 {
814 if (type != NULL && ht == get_script_local_ht())
815 {
816 svar_T *sv = find_typval_in_script(&v->di_tv);
817
818 if (sv != NULL)
819 *type = sv->sv_type;
820 }
821 return s;
822 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200823 }
824
825 return name;
826}
827
828/*
829 * Give an error message with a function name. Handle <SNR> things.
830 * "ermsg" is to be passed without translation, use N_() instead of _().
831 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +0100832 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200833emsg_funcname(char *ermsg, char_u *name)
834{
835 char_u *p;
836
837 if (*name == K_SPECIAL)
838 p = concat_str((char_u *)"<SNR>", name + 3);
839 else
840 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100841 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200842 if (p != name)
843 vim_free(p);
844}
845
846/*
847 * Allocate a variable for the result of a function.
848 * Return OK or FAIL.
849 */
850 int
851get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200852 char_u *name, // name of the function
853 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200854 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +0200855 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +0200856 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200857 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200858{
859 char_u *argp;
860 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100861 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
862 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200863 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200864
865 /*
866 * Get the arguments.
867 */
868 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200869 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
870 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200871 {
Bram Moolenaare6b53242020-07-01 17:28:33 +0200872 // skip the '(' or ',' and possibly line breaks
873 argp = skipwhite_and_linebreak(argp + 1, evalarg);
874
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200875 if (*argp == ')' || *argp == ',' || *argp == NUL)
876 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +0200877 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200878 {
879 ret = FAIL;
880 break;
881 }
882 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +0200883 // The comma should come right after the argument, but this wasn't
884 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200885 if (vim9script)
886 {
887 if (*argp != ',' && *skipwhite(argp) == ',')
888 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +0100889 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200890 ret = FAIL;
891 break;
892 }
893 }
894 else
Bram Moolenaar9d489562020-07-30 20:08:50 +0200895 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200896 if (*argp != ',')
897 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200898 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
899 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100900 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +0200901 ret = FAIL;
902 break;
903 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200904 }
Bram Moolenaare6b53242020-07-01 17:28:33 +0200905 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200906 if (*argp == ')')
907 ++argp;
908 else
909 ret = FAIL;
910
911 if (ret == OK)
912 {
913 int i = 0;
914
915 if (get_vim_var_nr(VV_TESTING))
916 {
Bram Moolenaare38eab22019-12-05 21:50:01 +0100917 // Prepare for calling test_garbagecollect_now(), need to know
918 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200919 if (funcargs.ga_itemsize == 0)
920 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
921 for (i = 0; i < argcount; ++i)
922 if (ga_grow(&funcargs, 1) == OK)
923 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
924 &argvars[i];
925 }
926
Bram Moolenaarc6538bc2019-08-03 18:17:11 +0200927 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200928
929 funcargs.ga_len -= i;
930 }
931 else if (!aborting())
932 {
933 if (argcount == MAX_FUNC_ARGS)
934 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
935 else
936 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
937 }
938
939 while (--argcount >= 0)
940 clear_tv(&argvars[argcount]);
941
Bram Moolenaar8294d492020-08-10 22:40:56 +0200942 if (in_vim9script())
943 *arg = argp;
944 else
945 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200946 return ret;
947}
948
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200949/*
950 * Return TRUE if "p" starts with "<SID>" or "s:".
951 * Only works if eval_fname_script() returned non-zero for "p"!
952 */
953 static int
954eval_fname_sid(char_u *p)
955{
956 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
957}
958
959/*
960 * In a script change <SID>name() and s:name() to K_SNR 123_name().
961 * Change <SNR>123_name() to K_SNR 123_name().
962 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
963 * (slow).
964 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +0100965 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200966fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
967{
968 int llen;
969 char_u *fname;
970 int i;
971
972 llen = eval_fname_script(name);
973 if (llen > 0)
974 {
975 fname_buf[0] = K_SPECIAL;
976 fname_buf[1] = KS_EXTRA;
977 fname_buf[2] = (int)KE_SNR;
978 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100979 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200980 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200981 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +0100982 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200983 else
984 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +0200985 sprintf((char *)fname_buf + 3, "%ld_",
986 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200987 i = (int)STRLEN(fname_buf);
988 }
989 }
990 if (i + STRLEN(name + llen) < FLEN_FIXED)
991 {
992 STRCPY(fname_buf + i, name + llen);
993 fname = fname_buf;
994 }
995 else
996 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200997 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200998 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +0100999 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001000 else
1001 {
1002 *tofree = fname;
1003 mch_memmove(fname, fname_buf, (size_t)i);
1004 STRCPY(fname + i, name + llen);
1005 }
1006 }
1007 }
1008 else
1009 fname = name;
1010 return fname;
1011}
1012
1013/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001014 * Find a function "name" in script "sid".
1015 */
1016 static ufunc_T *
1017find_func_with_sid(char_u *name, int sid)
1018{
1019 hashitem_T *hi;
1020 char_u buffer[200];
1021
1022 buffer[0] = K_SPECIAL;
1023 buffer[1] = KS_EXTRA;
1024 buffer[2] = (int)KE_SNR;
1025 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1026 (long)sid, name);
1027 hi = hash_find(&func_hashtab, buffer);
1028 if (!HASHITEM_EMPTY(hi))
1029 return HI2UF(hi);
1030
1031 return NULL;
1032}
1033
1034/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001035 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001036 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001037 * Return NULL for unknown function.
1038 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001039 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001040find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001041{
1042 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001043 ufunc_T *func;
1044 imported_T *imported;
1045
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001046 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001047 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001048 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001049 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001050 int find_script_local = in_vim9script()
1051 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001052
Bram Moolenaar95006e32020-08-29 17:47:08 +02001053 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001054 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001055 // Find script-local function before global one.
1056 func = find_func_with_sid(name, current_sctx.sc_sid);
1057 if (func != NULL)
1058 return func;
1059 }
1060
Bram Moolenaarefa94442020-08-08 22:16:00 +02001061 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001062 && name[1] == KS_EXTRA
1063 && name[2] == KE_SNR)
1064 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001065 // Caller changes s: to <SNR>99_name.
1066
1067 after_script = name + 3;
1068 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001069 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001070 ++after_script;
1071 else
1072 after_script = NULL;
1073 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001074 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001075 {
1076 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001077 if (after_script != NULL && sid != current_sctx.sc_sid)
1078 imported = find_imported_in_script(after_script, 0, sid);
1079 else
1080 imported = find_imported(after_script == NULL
1081 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001082 if (imported != NULL && imported->imp_funcname != NULL)
1083 {
1084 hi = hash_find(&func_hashtab, imported->imp_funcname);
1085 if (!HASHITEM_EMPTY(hi))
1086 return HI2UF(hi);
1087 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001088 }
1089 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001090
Bram Moolenaara26b9702020-04-18 19:53:28 +02001091 hi = hash_find(&func_hashtab,
1092 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001093 if (!HASHITEM_EMPTY(hi))
1094 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001095
1096 return NULL;
1097}
1098
1099/*
1100 * Find a function by name, return pointer to it in ufuncs.
1101 * "cctx" is passed in a :def function to find imported functions.
1102 * Return NULL for unknown or dead function.
1103 */
1104 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001105find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001106{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001107 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001108
1109 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1110 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001111 return NULL;
1112}
1113
1114/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001115 * Return TRUE if "ufunc" is a global function.
1116 */
1117 int
1118func_is_global(ufunc_T *ufunc)
1119{
1120 return ufunc->uf_name[0] != K_SPECIAL;
1121}
1122
1123/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001124 * Copy the function name of "fp" to buffer "buf".
1125 * "buf" must be able to hold the function name plus three bytes.
1126 * Takes care of script-local function names.
1127 */
1128 static void
1129cat_func_name(char_u *buf, ufunc_T *fp)
1130{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001131 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001132 {
1133 STRCPY(buf, "<SNR>");
1134 STRCAT(buf, fp->uf_name + 3);
1135 }
1136 else
1137 STRCPY(buf, fp->uf_name);
1138}
1139
1140/*
1141 * Add a number variable "name" to dict "dp" with value "nr".
1142 */
1143 static void
1144add_nr_var(
1145 dict_T *dp,
1146 dictitem_T *v,
1147 char *name,
1148 varnumber_T nr)
1149{
1150 STRCPY(v->di_key, name);
1151 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1152 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1153 v->di_tv.v_type = VAR_NUMBER;
1154 v->di_tv.v_lock = VAR_FIXED;
1155 v->di_tv.vval.v_number = nr;
1156}
1157
1158/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001159 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001160 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001161 static void
1162free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001163{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001164 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001165
1166 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1167 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001168 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001169
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001170 // When garbage collecting a funccall_T may be freed before the
1171 // function that references it, clear its uf_scoped field.
1172 // The function may have been redefined and point to another
1173 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001174 if (fp != NULL && fp->uf_scoped == fc)
1175 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001176 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001177 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001178
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001179 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001180 vim_free(fc);
1181}
1182
1183/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001184 * Free "fc" and what it contains.
1185 * Can be called only when "fc" is kept beyond the period of it called,
1186 * i.e. after cleanup_function_call(fc).
1187 */
1188 static void
1189free_funccal_contents(funccall_T *fc)
1190{
1191 listitem_T *li;
1192
1193 // Free all l: variables.
1194 vars_clear(&fc->l_vars.dv_hashtab);
1195
1196 // Free all a: variables.
1197 vars_clear(&fc->l_avars.dv_hashtab);
1198
1199 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001200 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001201 clear_tv(&li->li_tv);
1202
1203 free_funccal(fc);
1204}
1205
1206/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001207 * Handle the last part of returning from a function: free the local hashtable.
1208 * Unless it is still in use by a closure.
1209 */
1210 static void
1211cleanup_function_call(funccall_T *fc)
1212{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001213 int may_free_fc = fc->fc_refcount <= 0;
1214 int free_fc = TRUE;
1215
Bram Moolenaar6914c642017-04-01 21:21:30 +02001216 current_funccal = fc->caller;
1217
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001218 // Free all l: variables if not referred.
1219 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1220 vars_clear(&fc->l_vars.dv_hashtab);
1221 else
1222 free_fc = FALSE;
1223
1224 // If the a:000 list and the l: and a: dicts are not referenced and
1225 // there is no closure using it, we can free the funccall_T and what's
1226 // in it.
1227 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1228 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001229 else
1230 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001231 int todo;
1232 hashitem_T *hi;
1233 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001234
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001235 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001236
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001237 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001238 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1239 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1240 {
1241 if (!HASHITEM_EMPTY(hi))
1242 {
1243 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001244 di = HI2DI(hi);
1245 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001246 }
1247 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001248 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001249
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001250 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1251 fc->l_varlist.lv_first = NULL;
1252 else
1253 {
1254 listitem_T *li;
1255
1256 free_fc = FALSE;
1257
1258 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001259 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001260 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001261 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001262
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001263 if (free_fc)
1264 free_funccal(fc);
1265 else
1266 {
1267 static int made_copy = 0;
1268
1269 // "fc" is still in use. This can happen when returning "a:000",
1270 // assigning "l:" to a global variable or defining a closure.
1271 // Link "fc" in the list for garbage collection later.
1272 fc->caller = previous_funccal;
1273 previous_funccal = fc;
1274
1275 if (want_garbage_collect)
1276 // If garbage collector is ready, clear count.
1277 made_copy = 0;
1278 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001279 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001280 // We have made a lot of copies, worth 4 Mbyte. This can happen
1281 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001282 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001283 // too much memory.
1284 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001285 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001286 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001287 }
1288}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001289
1290/*
1291 * There are two kinds of function names:
1292 * 1. ordinary names, function defined with :function or :def
1293 * 2. numbered functions and lambdas
1294 * For the first we only count the name stored in func_hashtab as a reference,
1295 * using function() does not count as a reference, because the function is
1296 * looked up by name.
1297 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001298 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001299func_name_refcount(char_u *name)
1300{
1301 return isdigit(*name) || *name == '<';
1302}
1303
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001304/*
1305 * Unreference "fc": decrement the reference count and free it when it
1306 * becomes zero. "fp" is detached from "fc".
1307 * When "force" is TRUE we are exiting.
1308 */
1309 static void
1310funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1311{
1312 funccall_T **pfc;
1313 int i;
1314
1315 if (fc == NULL)
1316 return;
1317
1318 if (--fc->fc_refcount <= 0 && (force || (
1319 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1320 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1321 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1322 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1323 {
1324 if (fc == *pfc)
1325 {
1326 *pfc = fc->caller;
1327 free_funccal_contents(fc);
1328 return;
1329 }
1330 }
1331 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1332 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1333 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1334}
1335
1336/*
1337 * Remove the function from the function hashtable. If the function was
1338 * deleted while it still has references this was already done.
1339 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1340 */
1341 static int
1342func_remove(ufunc_T *fp)
1343{
1344 hashitem_T *hi;
1345
1346 // Return if it was already virtually deleted.
1347 if (fp->uf_flags & FC_DEAD)
1348 return FALSE;
1349
1350 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1351 if (!HASHITEM_EMPTY(hi))
1352 {
1353 // When there is a def-function index do not actually remove the
1354 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001355 // Do remove it when it's a copy.
1356 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001357 fp->uf_flags |= FC_DEAD;
1358 else
1359 hash_remove(&func_hashtab, hi);
1360 return TRUE;
1361 }
1362 return FALSE;
1363}
1364
1365 static void
1366func_clear_items(ufunc_T *fp)
1367{
1368 ga_clear_strings(&(fp->uf_args));
1369 ga_clear_strings(&(fp->uf_def_args));
1370 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001371 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001372 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001373 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001374 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001375 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001376
1377 // Increment the refcount of this function to avoid it being freed
1378 // recursively when the partial is freed.
1379 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001380 partial_unref(fp->uf_partial);
1381 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001382 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001383
1384#ifdef FEAT_LUA
1385 if (fp->uf_cb_free != NULL)
1386 {
1387 fp->uf_cb_free(fp->uf_cb_state);
1388 fp->uf_cb_free = NULL;
1389 }
1390
1391 fp->uf_cb_state = NULL;
1392 fp->uf_cb = NULL;
1393#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001394#ifdef FEAT_PROFILE
1395 VIM_CLEAR(fp->uf_tml_count);
1396 VIM_CLEAR(fp->uf_tml_total);
1397 VIM_CLEAR(fp->uf_tml_self);
1398#endif
1399}
1400
1401/*
1402 * Free all things that a function contains. Does not free the function
1403 * itself, use func_free() for that.
1404 * When "force" is TRUE we are exiting.
1405 */
1406 static void
1407func_clear(ufunc_T *fp, int force)
1408{
1409 if (fp->uf_cleared)
1410 return;
1411 fp->uf_cleared = TRUE;
1412
1413 // clear this function
1414 func_clear_items(fp);
1415 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001416 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001417}
1418
1419/*
1420 * Free a function and remove it from the list of functions. Does not free
1421 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001422 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001423 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001424 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001425 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001426func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001427{
1428 // Only remove it when not done already, otherwise we would remove a newer
1429 // version of the function with the same name.
1430 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1431 func_remove(fp);
1432
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001433 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001434 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001435 if (fp->uf_dfunc_idx > 0)
1436 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001437 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001438 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001439 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001440 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001441 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001442}
1443
1444/*
1445 * Free all things that a function contains and free the function itself.
1446 * When "force" is TRUE we are exiting.
1447 */
1448 static void
1449func_clear_free(ufunc_T *fp, int force)
1450{
1451 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001452 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1453 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001454 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001455 else
1456 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001457}
1458
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001459/*
1460 * Copy already defined function "lambda" to a new function with name "global".
1461 * This is for when a compiled function defines a global function.
1462 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001463 int
1464copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001465{
1466 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001467 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001468
1469 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001470 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001471 semsg(_(e_lambda_function_not_found_str), lambda);
1472 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001473 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001474
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001475 fp = find_func(global, TRUE, NULL);
1476 if (fp != NULL)
1477 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001478 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001479 semsg(_(e_funcexts), global);
1480 return FAIL;
1481 }
1482
1483 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
1484 if (fp == NULL)
1485 return FAIL;
1486
1487 fp->uf_varargs = ufunc->uf_varargs;
1488 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
1489 fp->uf_def_status = ufunc->uf_def_status;
1490 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
1491 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
1492 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
1493 == FAIL
1494 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
1495 goto failed;
1496
1497 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
1498 : vim_strsave(ufunc->uf_name_exp);
1499 if (ufunc->uf_arg_types != NULL)
1500 {
1501 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
1502 if (fp->uf_arg_types == NULL)
1503 goto failed;
1504 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
1505 sizeof(type_T *) * fp->uf_args.ga_len);
1506 }
1507 if (ufunc->uf_def_arg_idx != NULL)
1508 {
1509 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
1510 if (fp->uf_def_arg_idx == NULL)
1511 goto failed;
1512 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
1513 sizeof(int) * fp->uf_def_args.ga_len + 1);
1514 }
1515 if (ufunc->uf_va_name != NULL)
1516 {
1517 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
1518 if (fp->uf_va_name == NULL)
1519 goto failed;
1520 }
1521 fp->uf_ret_type = ufunc->uf_ret_type;
1522
1523 fp->uf_refcount = 1;
1524 STRCPY(fp->uf_name, global);
1525 hash_add(&func_hashtab, UF2HIKEY(fp));
1526
1527 // the referenced dfunc_T is now used one more time
1528 link_def_function(fp);
1529
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001530 // Create a partial to store the context of the function where it was
1531 // instantiated. Only needs to be done once. Do this on the original
1532 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001533 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
1534 {
1535 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
1536
1537 if (pt == NULL)
1538 goto failed;
1539 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001540 {
1541 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001542 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001543 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001544 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001545 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001546 }
1547
1548 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001549
1550failed:
1551 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001552 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001553}
1554
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001555static int funcdepth = 0;
1556
1557/*
1558 * Increment the function call depth count.
1559 * Return FAIL when going over 'maxfuncdepth'.
1560 * Otherwise return OK, must call funcdepth_decrement() later!
1561 */
1562 int
1563funcdepth_increment(void)
1564{
1565 if (funcdepth >= p_mfd)
1566 {
1567 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
1568 return FAIL;
1569 }
1570 ++funcdepth;
1571 return OK;
1572}
1573
1574 void
1575funcdepth_decrement(void)
1576{
1577 --funcdepth;
1578}
1579
1580/*
1581 * Get the current function call depth.
1582 */
1583 int
1584funcdepth_get(void)
1585{
1586 return funcdepth;
1587}
1588
1589/*
1590 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01001591 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001592 * times as funcdepth_increment().
1593 */
1594 void
1595funcdepth_restore(int depth)
1596{
1597 funcdepth = depth;
1598}
Bram Moolenaar6914c642017-04-01 21:21:30 +02001599
1600/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001601 * Call a user function.
1602 */
1603 static void
1604call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01001605 ufunc_T *fp, // pointer to function
1606 int argcount, // nr of args
1607 typval_T *argvars, // arguments
1608 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001609 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01001610 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001611{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001612 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02001613 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001614 funccall_T *fc;
1615 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001616 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001617 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001618 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619 int i;
1620 int ai;
1621 int islambda = FALSE;
1622 char_u numbuf[NUMBUFLEN];
1623 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01001625 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001626#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01001627 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001628
Bram Moolenaarb2049902021-01-24 12:53:53 +01001629#ifdef FEAT_PROFILE
1630 CLEAR_FIELD(profile_info);
1631#endif
1632
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001633 // If depth of calling is getting too high, don't execute the function.
1634 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001636 rettv->v_type = VAR_NUMBER;
1637 rettv->vval.v_number = -1;
1638 return;
1639 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640
Bram Moolenaare38eab22019-12-05 21:50:01 +01001641 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001642
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001643 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001644 if (fc == NULL)
1645 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001646 fc->caller = current_funccal;
1647 current_funccal = fc;
1648 fc->func = fp;
1649 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001650 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001651 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
1653 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001654 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001655 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001656 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001657
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001658 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001659 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01001660#ifdef FEAT_PROFILE
1661 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
1662#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001663 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01001664#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001665 if (do_profiling == PROF_YES)
1666 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01001667#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001668 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001669 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01001670#ifdef FEAT_PROFILE
1671 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01001672 || (caller != NULL && caller->uf_profiling)))
1673 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01001674#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001675 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001676 free_funccal(fc);
1677 return;
1678 }
1679
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
1681 islambda = TRUE;
1682
1683 /*
1684 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
1685 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
1686 * each argument variable and saves a lot of time.
1687 */
1688 /*
1689 * Init l: variables.
1690 */
1691 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
1692 if (selfdict != NULL)
1693 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001694 // Set l:self to "selfdict". Use "name" to avoid a warning from
1695 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001696 v = &fc->fixvar[fixvar_idx++].var;
1697 name = v->di_key;
1698 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01001699 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
1701 v->di_tv.v_type = VAR_DICT;
1702 v->di_tv.v_lock = 0;
1703 v->di_tv.vval.v_dict = selfdict;
1704 ++selfdict->dv_refcount;
1705 }
1706
1707 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001708 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001709 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 * Set a:000 to a list with room for the "..." arguments.
1711 */
1712 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001713 if ((fp->uf_flags & FC_NOARGS) == 0)
1714 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001715 (varnumber_T)(argcount >= fp->uf_args.ga_len
1716 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01001717 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001718 if ((fp->uf_flags & FC_NOARGS) == 0)
1719 {
1720 // Use "name" to avoid a warning from some compiler that checks the
1721 // destination size.
1722 v = &fc->fixvar[fixvar_idx++].var;
1723 name = v->di_key;
1724 STRCPY(name, "000");
1725 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1726 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
1727 v->di_tv.v_type = VAR_LIST;
1728 v->di_tv.v_lock = VAR_FIXED;
1729 v->di_tv.vval.v_list = &fc->l_varlist;
1730 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02001731 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
1733 fc->l_varlist.lv_lock = VAR_FIXED;
1734
1735 /*
1736 * Set a:firstline to "firstline" and a:lastline to "lastline".
1737 * Set a:name to named arguments.
1738 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001739 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001741 if ((fp->uf_flags & FC_NOARGS) == 0)
1742 {
1743 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001744 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001745 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02001746 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001747 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001748 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 {
1750 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001751 typval_T def_rettv;
1752 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753
1754 ai = i - fp->uf_args.ga_len;
1755 if (ai < 0)
1756 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001757 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758 name = FUNCARG(fp, i);
1759 if (islambda)
1760 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001761
1762 // evaluate named argument default expression
1763 isdefault = ai + fp->uf_def_args.ga_len >= 0
1764 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
1765 && argvars[i].vval.v_number == VVAL_NONE));
1766 if (isdefault)
1767 {
1768 char_u *default_expr = NULL;
1769 def_rettv.v_type = VAR_NUMBER;
1770 def_rettv.vval.v_number = -1;
1771
1772 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
1773 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001774 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001775 {
1776 default_arg_err = 1;
1777 break;
1778 }
1779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780 }
1781 else
1782 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001783 if ((fp->uf_flags & FC_NOARGS) != 0)
1784 // Bail out if no a: arguments used (in lambda).
1785 break;
1786
Bram Moolenaare38eab22019-12-05 21:50:01 +01001787 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 sprintf((char *)numbuf, "%d", ai + 1);
1789 name = numbuf;
1790 }
1791 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
1792 {
1793 v = &fc->fixvar[fixvar_idx++].var;
1794 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001795 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001796 }
1797 else
1798 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001799 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800 if (v == NULL)
1801 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001802 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001803 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001804
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02001805 // Note: the values are copied directly to avoid alloc/free.
1806 // "argvars" must have VAR_FIXED for v_lock.
1807 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001808 v->di_tv.v_lock = VAR_FIXED;
1809
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001810 if (addlocal)
1811 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001812 // Named arguments should be accessed without the "a:" prefix in
1813 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001814 copy_tv(&v->di_tv, &v->di_tv);
1815 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001816 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001817 else
1818 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001819
1820 if (ai >= 0 && ai < MAX_FUNC_ARGS)
1821 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001822 listitem_T *li = &fc->l_listitems[ai];
1823
1824 li->li_tv = argvars[i];
1825 li->li_tv.v_lock = VAR_FIXED;
1826 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 }
1828 }
1829
Bram Moolenaare38eab22019-12-05 21:50:01 +01001830 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02001832
1833 if (fp->uf_flags & FC_SANDBOX)
1834 {
1835 using_sandbox = TRUE;
1836 ++sandbox;
1837 }
1838
Bram Moolenaar25e0f582020-05-25 22:36:50 +02001839 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01001840 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001841 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001842 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001843 ++no_wait_return;
1844 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001846 smsg(_("calling %s"), SOURCING_NAME);
1847 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001849 char_u buf[MSG_BUF_LEN];
1850 char_u numbuf2[NUMBUFLEN];
1851 char_u *tofree;
1852 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001854 msg_puts("(");
1855 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001857 if (i > 0)
1858 msg_puts(", ");
1859 if (argvars[i].v_type == VAR_NUMBER)
1860 msg_outnum((long)argvars[i].vval.v_number);
1861 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001862 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001863 // Do not want errors such as E724 here.
1864 ++emsg_off;
1865 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
1866 --emsg_off;
1867 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001869 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001871 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1872 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001873 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001874 msg_puts((char *)s);
1875 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001876 }
1877 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001878 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001879 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001880 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001881 msg_puts("\n"); // don't overwrite this either
1882
1883 verbose_leave_scroll();
1884 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 }
1886#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001887 if (do_profiling == PROF_YES)
1888 profile_may_start_func(&profile_info, fp,
1889 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001890#endif
1891
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001892 save_current_sctx = current_sctx;
1893 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001894 save_did_emsg = did_emsg;
1895 did_emsg = FALSE;
1896
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001897 if (default_arg_err && (fp->uf_flags & FC_ABORT))
1898 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001899 else if (islambda)
1900 {
1901 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
1902
1903 // A Lambda always has the command "return {expr}". It is much faster
1904 // to evaluate {expr} directly.
1905 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02001906 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001907 --ex_nesting_level;
1908 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001909 else
1910 // call do_cmdline() to execute the lines
1911 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001912 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
1913
1914 --RedrawingDisabled;
1915
Bram Moolenaare38eab22019-12-05 21:50:01 +01001916 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
1918 {
1919 clear_tv(rettv);
1920 rettv->v_type = VAR_NUMBER;
1921 rettv->vval.v_number = -1;
1922 }
1923
1924#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001925 if (do_profiling == PROF_YES)
1926 {
1927 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
1928
1929 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
1930 profile_may_end_func(&profile_info, fp, caller);
1931 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001932#endif
1933
Bram Moolenaare38eab22019-12-05 21:50:01 +01001934 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001935 if (p_verbose >= 12)
1936 {
1937 ++no_wait_return;
1938 verbose_enter_scroll();
1939
1940 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001941 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001942 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001943 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001944 (long)fc->rettv->vval.v_number);
1945 else
1946 {
1947 char_u buf[MSG_BUF_LEN];
1948 char_u numbuf2[NUMBUFLEN];
1949 char_u *tofree;
1950 char_u *s;
1951
Bram Moolenaare38eab22019-12-05 21:50:01 +01001952 // The value may be very long. Skip the middle part, so that we
1953 // have some idea how it starts and ends. smsg() would always
1954 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001955 ++emsg_off;
1956 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
1957 --emsg_off;
1958 if (s != NULL)
1959 {
1960 if (vim_strsize(s) > MSG_BUF_CLEN)
1961 {
1962 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
1963 s = buf;
1964 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001965 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001966 vim_free(tofree);
1967 }
1968 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01001969 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001970
1971 verbose_leave_scroll();
1972 --no_wait_return;
1973 }
1974
Bram Moolenaare31ee862020-01-07 20:59:34 +01001975 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001976 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001977 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001978#ifdef FEAT_PROFILE
1979 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01001980 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001981#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001982 if (using_sandbox)
1983 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001984
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001985 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001986 {
1987 ++no_wait_return;
1988 verbose_enter_scroll();
1989
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001990 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01001991 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001992
1993 verbose_leave_scroll();
1994 --no_wait_return;
1995 }
1996
1997 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001998 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02001999 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002000}
2001
2002/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002003 * Check the argument count for user function "fp".
2004 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2005 */
2006 int
2007check_user_func_argcount(ufunc_T *fp, int argcount)
2008{
2009 int regular_args = fp->uf_args.ga_len;
2010
2011 if (argcount < regular_args - fp->uf_def_args.ga_len)
2012 return FCERR_TOOFEW;
2013 else if (!has_varargs(fp) && argcount > regular_args)
2014 return FCERR_TOOMANY;
2015 return FCERR_UNKNOWN;
2016}
2017
2018/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002019 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002020 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002021 int
2022call_user_func_check(
2023 ufunc_T *fp,
2024 int argcount,
2025 typval_T *argvars,
2026 typval_T *rettv,
2027 funcexe_T *funcexe,
2028 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002029{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002030 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002031
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002032 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2033 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002034 error = check_user_func_argcount(fp, argcount);
2035 if (error != FCERR_UNKNOWN)
2036 return error;
2037 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002038 error = FCERR_DICT;
2039 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002040 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002041 int did_save_redo = FALSE;
2042 save_redo_T save_redo;
2043
2044 /*
2045 * Call the user function.
2046 * Save and restore search patterns, script variables and
2047 * redo buffer.
2048 */
2049 save_search_patterns();
2050 if (!ins_compl_active())
2051 {
2052 saveRedobuff(&save_redo);
2053 did_save_redo = TRUE;
2054 }
2055 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002056 call_user_func(fp, argcount, argvars, rettv, funcexe,
2057 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002058 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2059 // Function was unreferenced while being used, free it now.
2060 func_clear_free(fp, FALSE);
2061 if (did_save_redo)
2062 restoreRedobuff(&save_redo);
2063 restore_search_patterns();
2064 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002065 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002066 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002067}
2068
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002069static funccal_entry_T *funccal_stack = NULL;
2070
2071/*
2072 * Save the current function call pointer, and set it to NULL.
2073 * Used when executing autocommands and for ":source".
2074 */
2075 void
2076save_funccal(funccal_entry_T *entry)
2077{
2078 entry->top_funccal = current_funccal;
2079 entry->next = funccal_stack;
2080 funccal_stack = entry;
2081 current_funccal = NULL;
2082}
2083
2084 void
2085restore_funccal(void)
2086{
2087 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002088 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002089 else
2090 {
2091 current_funccal = funccal_stack->top_funccal;
2092 funccal_stack = funccal_stack->next;
2093 }
2094}
2095
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002096 funccall_T *
2097get_current_funccal(void)
2098{
2099 return current_funccal;
2100}
2101
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002102/*
2103 * Mark all functions of script "sid" as deleted.
2104 */
2105 void
2106delete_script_functions(int sid)
2107{
2108 hashitem_T *hi;
2109 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002110 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002111 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002112 size_t len;
2113
2114 buf[0] = K_SPECIAL;
2115 buf[1] = KS_EXTRA;
2116 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002117 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002118 len = STRLEN(buf);
2119
Bram Moolenaarce658352020-07-31 23:47:12 +02002120 while (todo > 0)
2121 {
2122 todo = func_hashtab.ht_used;
2123 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2124 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002125 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002126 fp = HI2UF(hi);
2127 if (STRNCMP(fp->uf_name, buf, len) == 0)
2128 {
2129 int changed = func_hashtab.ht_changed;
2130
2131 fp->uf_flags |= FC_DEAD;
2132 func_clear(fp, TRUE);
2133 // When clearing a function another function can be cleared
2134 // as a side effect. When that happens start over.
2135 if (changed != func_hashtab.ht_changed)
2136 break;
2137 }
2138 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002139 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002140 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002141}
2142
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002143#if defined(EXITFREE) || defined(PROTO)
2144 void
2145free_all_functions(void)
2146{
2147 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002148 ufunc_T *fp;
2149 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002150 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002151 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002152
Bram Moolenaare38eab22019-12-05 21:50:01 +01002153 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002154 while (current_funccal != NULL)
2155 {
2156 clear_tv(current_funccal->rettv);
2157 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002158 if (current_funccal == NULL && funccal_stack != NULL)
2159 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002160 }
2161
Bram Moolenaare38eab22019-12-05 21:50:01 +01002162 // First clear what the functions contain. Since this may lower the
2163 // reference count of a function, it may also free a function and change
2164 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002165 while (todo > 0)
2166 {
2167 todo = func_hashtab.ht_used;
2168 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2169 if (!HASHITEM_EMPTY(hi))
2170 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002171 // clear the def function index now
2172 fp = HI2UF(hi);
2173 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002174 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002175
Bram Moolenaare38eab22019-12-05 21:50:01 +01002176 // Only free functions that are not refcounted, those are
2177 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002178 if (func_name_refcount(fp->uf_name))
2179 ++skipped;
2180 else
2181 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002182 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002183 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002184 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002185 {
2186 skipped = 0;
2187 break;
2188 }
2189 }
2190 --todo;
2191 }
2192 }
2193
Bram Moolenaare38eab22019-12-05 21:50:01 +01002194 // Now actually free the functions. Need to start all over every time,
2195 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002196 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002197 while (func_hashtab.ht_used > skipped)
2198 {
2199 todo = func_hashtab.ht_used;
2200 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002201 if (!HASHITEM_EMPTY(hi))
2202 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002203 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002204 // Only free functions that are not refcounted, those are
2205 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002206 fp = HI2UF(hi);
2207 if (func_name_refcount(fp->uf_name))
2208 ++skipped;
2209 else
2210 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002211 if (func_free(fp, FALSE) == OK)
2212 {
2213 skipped = 0;
2214 break;
2215 }
2216 // did not actually free it
2217 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002218 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002219 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002220 }
2221 if (skipped == 0)
2222 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002223
2224 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002225}
2226#endif
2227
2228/*
2229 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002230 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 * "len" is the length of "name", or -1 for NUL terminated.
2232 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002233 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002234builtin_function(char_u *name, int len)
2235{
2236 char_u *p;
2237
Bram Moolenaara26b9702020-04-18 19:53:28 +02002238 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002239 return FALSE;
2240 p = vim_strchr(name, AUTOLOAD_CHAR);
2241 return p == NULL || (len > 0 && p > name + len);
2242}
2243
2244 int
2245func_call(
2246 char_u *name,
2247 typval_T *args,
2248 partial_T *partial,
2249 dict_T *selfdict,
2250 typval_T *rettv)
2251{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002252 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002253 listitem_T *item;
2254 typval_T argv[MAX_FUNC_ARGS + 1];
2255 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002256 int r = 0;
2257
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002258 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002259 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002260 {
2261 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2262 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002263 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002264 break;
2265 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002266 // Make a copy of each argument. This is needed to be able to set
2267 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002268 copy_tv(&item->li_tv, &argv[argc++]);
2269 }
2270
2271 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002272 {
2273 funcexe_T funcexe;
2274
Bram Moolenaara80faa82020-04-12 19:37:17 +02002275 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002276 funcexe.firstline = curwin->w_cursor.lnum;
2277 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002278 funcexe.evaluate = TRUE;
2279 funcexe.partial = partial;
2280 funcexe.selfdict = selfdict;
2281 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002283
Bram Moolenaare38eab22019-12-05 21:50:01 +01002284 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285 while (argc > 0)
2286 clear_tv(&argv[--argc]);
2287
2288 return r;
2289}
2290
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002291static int callback_depth = 0;
2292
2293 int
2294get_callback_depth(void)
2295{
2296 return callback_depth;
2297}
2298
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002299/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002300 * Invoke call_func() with a callback.
2301 */
2302 int
2303call_callback(
2304 callback_T *callback,
2305 int len, // length of "name" or -1 to use strlen()
2306 typval_T *rettv, // return value goes here
2307 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002308 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002309 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002310{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002311 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002312 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002313
Bram Moolenaara80faa82020-04-12 19:37:17 +02002314 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002315 funcexe.evaluate = TRUE;
2316 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002317 ++callback_depth;
2318 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2319 --callback_depth;
2320 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002321}
2322
2323/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002324 * Give an error message for the result of a function.
2325 * Nothing if "error" is FCERR_NONE.
2326 */
2327 void
2328user_func_error(int error, char_u *name)
2329{
2330 switch (error)
2331 {
2332 case FCERR_UNKNOWN:
2333 emsg_funcname(e_unknownfunc, name);
2334 break;
2335 case FCERR_NOTMETHOD:
2336 emsg_funcname(
2337 N_("E276: Cannot use function as a method: %s"), name);
2338 break;
2339 case FCERR_DELETED:
2340 emsg_funcname(N_(e_func_deleted), name);
2341 break;
2342 case FCERR_TOOMANY:
2343 emsg_funcname((char *)e_toomanyarg, name);
2344 break;
2345 case FCERR_TOOFEW:
2346 emsg_funcname((char *)e_toofewarg, name);
2347 break;
2348 case FCERR_SCRIPT:
2349 emsg_funcname(
2350 N_("E120: Using <SID> not in a script context: %s"), name);
2351 break;
2352 case FCERR_DICT:
2353 emsg_funcname(
2354 N_("E725: Calling dict function without Dictionary: %s"),
2355 name);
2356 break;
2357 }
2358}
2359
2360/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002361 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002362 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 * Return FAIL when the function can't be called, OK otherwise.
2364 * Also returns OK when an error was encountered while executing the function.
2365 */
2366 int
2367call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002368 char_u *funcname, // name of the function
2369 int len, // length of "name" or -1 to use strlen()
2370 typval_T *rettv, // return value goes here
2371 int argcount_in, // number of "argvars"
2372 typval_T *argvars_in, // vars for arguments, must have "argcount"
2373 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002374 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002375{
2376 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002377 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002378 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002379 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002380 char_u fname_buf[FLEN_FIXED + 1];
2381 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002382 char_u *fname = NULL;
2383 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384 int argcount = argcount_in;
2385 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002386 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002387 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2388 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002389 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002390 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002391 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002392
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002393 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2394 // even when call_func() returns FAIL.
2395 rettv->v_type = VAR_UNKNOWN;
2396
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002397 if (partial != NULL)
2398 fp = partial->pt_func;
2399 if (fp == NULL)
2400 {
2401 // Make a copy of the name, if it comes from a funcref variable it
2402 // could be changed or deleted in the called function.
2403 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2404 if (name == NULL)
2405 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002406
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002407 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2408 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002410 if (funcexe->doesrange != NULL)
2411 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412
2413 if (partial != NULL)
2414 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002415 // When the function has a partial with a dict and there is a dict
2416 // argument, use the dict argument. That is backwards compatible.
2417 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002418 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002419 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002420 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421 {
2422 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002423 {
2424 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2425 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002426 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002427 goto theend;
2428 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002429 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002430 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002431 for (i = 0; i < argcount_in; ++i)
2432 argv[i + argv_clear] = argvars_in[i];
2433 argvars = argv;
2434 argcount = partial->pt_argc + argcount_in;
2435 }
2436 }
2437
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002438 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2439 {
2440 // Check that the argument types are OK for the types of the funcref.
2441 if (check_argument_types(funcexe->check_type, argvars, argcount,
2442 name) == FAIL)
2443 error = FCERR_OTHER;
2444 }
2445
Bram Moolenaaref140542019-12-31 21:27:13 +01002446 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002447 {
2448 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002449 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002450
Bram Moolenaar333894b2020-08-01 18:53:07 +02002451 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002452 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002453 {
2454 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002455 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457
Bram Moolenaare38eab22019-12-05 21:50:01 +01002458 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002459 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01002460 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002461
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002462 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463 {
2464 /*
2465 * User defined function.
2466 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002467 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02002468 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469
Bram Moolenaare38eab22019-12-05 21:50:01 +01002470 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002471 if (fp == NULL
2472 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002473 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 && !aborting())
2475 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002476 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002477 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002478 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
2481 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002482 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02002483 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02002485 if (fp == NULL)
2486 {
2487 char_u *p = untrans_function_name(rfname);
2488
2489 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02002490 // Don't do this if the name starts with "s:".
2491 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02002492 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02002493 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002494
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002495 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01002496 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002497#ifdef FEAT_LUA
2498 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
2499 {
2500 cfunc_T cb = fp->uf_cb;
2501
2502 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
2503 }
2504#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002505 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002507 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01002508 // postponed filling in the arguments, do it now
2509 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002510 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002511
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002512 if (funcexe->basetv != NULL)
2513 {
2514 // Method call: base->Method()
2515 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
2516 argv[0] = *funcexe->basetv;
2517 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002518 argvars = argv;
2519 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002520 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002521
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002522 error = call_user_func_check(fp, argcount, argvars, rettv,
2523 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524 }
2525 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02002526 else if (funcexe->basetv != NULL)
2527 {
2528 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002529 * expr->method(): Find the method name in the table, call its
2530 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02002531 */
2532 error = call_internal_method(fname, argcount, argvars, rettv,
2533 funcexe->basetv);
2534 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002535 else
2536 {
2537 /*
2538 * Find the function name in the table, call its implementation.
2539 */
2540 error = call_internal_func(fname, argcount, argvars, rettv);
2541 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02002542
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002543 /*
2544 * The function call (or "FuncUndefined" autocommand sequence) might
2545 * have been aborted by an error, an interrupt, or an explicitly thrown
2546 * exception that has not been caught so far. This situation can be
2547 * tested for by calling aborting(). For an error in an internal
2548 * function or for the "E132" error in call_user_func(), however, the
2549 * throw point at which the "force_abort" flag (temporarily reset by
2550 * emsg()) is normally updated has not been reached yet. We need to
2551 * update that flag first to make aborting() reliable.
2552 */
2553 update_force_abort();
2554 }
Bram Moolenaaref140542019-12-31 21:27:13 +01002555 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002556 ret = OK;
2557
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002558theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002559 /*
2560 * Report an error unless the argument evaluation or function call has been
2561 * cancelled due to an aborting error, an interrupt, or an exception.
2562 */
2563 if (!aborting())
2564 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002565 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002566 }
2567
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002568 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002569 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002570 clear_tv(&argv[--argv_clear + argv_base]);
2571
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002572 vim_free(tofree);
2573 vim_free(name);
2574
2575 return ret;
2576}
2577
Bram Moolenaar682d0a12020-07-19 20:48:59 +02002578 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002579printable_func_name(ufunc_T *fp)
2580{
2581 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
2582}
2583
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002585 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002586 */
2587 static void
2588list_func_head(ufunc_T *fp, int indent)
2589{
2590 int j;
2591
2592 msg_start();
2593 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002594 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002595 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002596 msg_puts("def ");
2597 else
2598 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002599 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002600 msg_putchar('(');
2601 for (j = 0; j < fp->uf_args.ga_len; ++j)
2602 {
2603 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002604 msg_puts(", ");
2605 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002606 if (fp->uf_arg_types != NULL)
2607 {
2608 char *tofree;
2609
2610 msg_puts(": ");
2611 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
2612 vim_free(tofree);
2613 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002614 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
2615 {
2616 msg_puts(" = ");
2617 msg_puts(((char **)(fp->uf_def_args.ga_data))
2618 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
2619 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002620 }
2621 if (fp->uf_varargs)
2622 {
2623 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002624 msg_puts(", ");
2625 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002627 if (fp->uf_va_name != NULL)
2628 {
2629 if (j)
2630 msg_puts(", ");
2631 msg_puts("...");
2632 msg_puts((char *)fp->uf_va_name);
2633 if (fp->uf_va_type)
2634 {
2635 char *tofree;
2636
2637 msg_puts(": ");
2638 msg_puts(type_name(fp->uf_va_type, &tofree));
2639 vim_free(tofree);
2640 }
2641 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002643
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002644 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01002645 {
2646 if (fp->uf_ret_type != &t_void)
2647 {
2648 char *tofree;
2649
2650 msg_puts(": ");
2651 msg_puts(type_name(fp->uf_ret_type, &tofree));
2652 vim_free(tofree);
2653 }
2654 }
2655 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002656 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002658 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002660 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02002661 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01002662 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663 msg_clr_eos();
2664 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002665 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666}
2667
2668/*
2669 * Get a function name, translating "<SID>" and "<SNR>".
2670 * Also handles a Funcref in a List or Dictionary.
2671 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002672 * Set "*is_global" to TRUE when the function must be global, unless
2673 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002674 * flags:
2675 * TFN_INT: internal function name OK
2676 * TFN_QUIET: be quiet
2677 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002678 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002679 * Advances "pp" to just after the function name (if no error).
2680 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002681 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002682trans_function_name(
2683 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002684 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002685 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01002687 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002688 partial_T **partial, // return: partial of a FuncRef
2689 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002690{
2691 char_u *name = NULL;
2692 char_u *start;
2693 char_u *end;
2694 int lead;
2695 char_u sid_buf[20];
2696 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002697 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002699 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002700 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701
2702 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02002703 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 start = *pp;
2705
Bram Moolenaare38eab22019-12-05 21:50:01 +01002706 // Check for hard coded <SNR>: already translated function ID (from a user
2707 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
2709 && (*pp)[2] == (int)KE_SNR)
2710 {
2711 *pp += 3;
2712 len = get_id_len(pp) + 3;
2713 return vim_strnsave(start, len);
2714 }
2715
Bram Moolenaare38eab22019-12-05 21:50:01 +01002716 // A name starting with "<SID>" or "<SNR>" is local to a script. But
2717 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 lead = eval_fname_script(start);
2719 if (lead > 2)
2720 start += lead;
2721
Bram Moolenaare38eab22019-12-05 21:50:01 +01002722 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01002723 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002724 lead > 2 ? 0 : FNE_CHECK_START);
2725 if (end == start)
2726 {
2727 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002728 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002729 goto theend;
2730 }
2731 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
2732 {
2733 /*
2734 * Report an invalid expression in braces, unless the expression
2735 * evaluation has been cancelled due to an aborting error, an
2736 * interrupt, or an exception.
2737 */
2738 if (!aborting())
2739 {
2740 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002741 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002742 }
2743 else
2744 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
2745 goto theend;
2746 }
2747
2748 if (lv.ll_tv != NULL)
2749 {
2750 if (fdp != NULL)
2751 {
2752 fdp->fd_dict = lv.ll_dict;
2753 fdp->fd_newkey = lv.ll_newkey;
2754 lv.ll_newkey = NULL;
2755 fdp->fd_di = lv.ll_di;
2756 }
2757 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
2758 {
2759 name = vim_strsave(lv.ll_tv->vval.v_string);
2760 *pp = end;
2761 }
2762 else if (lv.ll_tv->v_type == VAR_PARTIAL
2763 && lv.ll_tv->vval.v_partial != NULL)
2764 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002765 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 *pp = end;
2767 if (partial != NULL)
2768 *partial = lv.ll_tv->vval.v_partial;
2769 }
2770 else
2771 {
2772 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
2773 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002774 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 else
2776 *pp = end;
2777 name = NULL;
2778 }
2779 goto theend;
2780 }
2781
2782 if (lv.ll_name == NULL)
2783 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002784 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 *pp = end;
2786 goto theend;
2787 }
2788
Bram Moolenaare38eab22019-12-05 21:50:01 +01002789 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 if (lv.ll_exp_name != NULL)
2791 {
2792 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002793 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 flags & TFN_NO_AUTOLOAD);
2795 if (name == lv.ll_exp_name)
2796 name = NULL;
2797 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002798 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 {
2800 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002801 name = deref_func_name(*pp, &len, partial, type,
2802 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 if (name == *pp)
2804 name = NULL;
2805 }
2806 if (name != NULL)
2807 {
2808 name = vim_strsave(name);
2809 *pp = end;
2810 if (STRNCMP(name, "<SNR>", 5) == 0)
2811 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002812 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 name[0] = K_SPECIAL;
2814 name[1] = KS_EXTRA;
2815 name[2] = (int)KE_SNR;
2816 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
2817 }
2818 goto theend;
2819 }
2820
2821 if (lv.ll_exp_name != NULL)
2822 {
2823 len = (int)STRLEN(lv.ll_exp_name);
2824 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
2825 && STRNCMP(lv.ll_name, "s:", 2) == 0)
2826 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002827 // When there was "s:" already or the name expanded to get a
2828 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 lv.ll_name += 2;
2830 len -= 2;
2831 lead = 2;
2832 }
2833 }
2834 else
2835 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002836 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002838 {
2839 if (is_global != NULL && lv.ll_name[0] == 'g')
2840 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002842 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 len = (int)(end - lv.ll_name);
2844 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02002845 if (len <= 0)
2846 {
2847 if (!skip)
2848 emsg(_(e_function_name));
2849 goto theend;
2850 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002851
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002852 // In Vim9 script a user function is script-local by default, unless it
2853 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002854 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01002855 if (vim9script)
2856 {
2857 char_u *p;
2858
2859 // SomeScript#func() is a global function.
2860 for (p = start; *p != NUL && *p != '('; ++p)
2861 if (*p == AUTOLOAD_CHAR)
2862 vim9script = FALSE;
2863 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002864
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002865 /*
2866 * Copy the function name to allocated memory.
2867 * Accept <SID>name() inside a script, translate into <SNR>123_name().
2868 * Accept <SNR>123_name() outside a script.
2869 */
2870 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01002871 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002872 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002874 if (!vim9script)
2875 lead = 3;
2876 if (vim9script || (lv.ll_exp_name != NULL
2877 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878 || eval_fname_sid(*pp))
2879 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002880 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002881 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002882 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002883 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884 goto theend;
2885 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002886 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002887 if (vim9script)
2888 extra = 3 + (int)STRLEN(sid_buf);
2889 else
2890 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002891 }
2892 }
2893 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
2894 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002895 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 start);
2897 goto theend;
2898 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02002899 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900 {
2901 char_u *cp = vim_strchr(lv.ll_name, ':');
2902
2903 if (cp != NULL && cp < end)
2904 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002905 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 goto theend;
2907 }
2908 }
2909
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002910 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 if (name != NULL)
2912 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01002913 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002914 {
2915 name[0] = K_SPECIAL;
2916 name[1] = KS_EXTRA;
2917 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002918 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919 STRCPY(name + 3, sid_buf);
2920 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002921 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
2922 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 }
2924 *pp = end;
2925
2926theend:
2927 clear_lval(&lv);
2928 return name;
2929}
2930
2931/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02002932 * Assuming "name" is the result of trans_function_name() and it was prefixed
2933 * to use the script-local name, return the unmodified name (points into
2934 * "name"). Otherwise return NULL.
2935 * This can be used to first search for a script-local function and fall back
2936 * to the global function if not found.
2937 */
2938 char_u *
2939untrans_function_name(char_u *name)
2940{
2941 char_u *p;
2942
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002943 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02002944 {
2945 p = vim_strchr(name, '_');
2946 if (p != NULL)
2947 return p + 1;
2948 }
2949 return NULL;
2950}
2951
2952/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002953 * List functions. When "regmatch" is NULL all of then.
2954 * Otherwise functions matching "regmatch".
2955 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01002956 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002957list_functions(regmatch_T *regmatch)
2958{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002959 int changed = func_hashtab.ht_changed;
2960 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002961 hashitem_T *hi;
2962
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002963 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002964 {
2965 if (!HASHITEM_EMPTY(hi))
2966 {
2967 ufunc_T *fp = HI2UF(hi);
2968
2969 --todo;
2970 if ((fp->uf_flags & FC_DEAD) == 0
2971 && (regmatch == NULL
2972 ? !message_filtered(fp->uf_name)
2973 && !func_name_refcount(fp->uf_name)
2974 : !isdigit(*fp->uf_name)
2975 && vim_regexec(regmatch, fp->uf_name, 0)))
2976 {
2977 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002978 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02002979 {
2980 emsg(_("E454: function list was modified"));
2981 return;
2982 }
2983 }
2984 }
2985 }
2986}
2987
2988/*
Bram Moolenaaradc8e442020-12-31 18:28:18 +01002989 * Check if "*cmd" points to a function command and if so advance "*cmd" and
2990 * return TRUE.
2991 * Otherwise return FALSE;
2992 * Do not consider "function(" to be a command.
2993 */
2994 static int
2995is_function_cmd(char_u **cmd)
2996{
2997 char_u *p = *cmd;
2998
2999 if (checkforcmd(&p, "function", 2))
3000 {
3001 if (*p == '(')
3002 return FALSE;
3003 *cmd = p;
3004 return TRUE;
3005 }
3006 return FALSE;
3007}
3008
3009/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003010 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003011 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3012 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003013 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003015 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003016define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017{
3018 char_u *theline;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003019 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 int j;
3021 int c;
3022 int saved_did_emsg;
3023 int saved_wait_return = need_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003024 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003025 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 char_u *p;
3027 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003028 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 char_u *line_arg = NULL;
3030 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003031 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003032 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 garray_T newlines;
3034 int varargs = FALSE;
3035 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003036 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003037 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003038 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003039 int indent;
3040 int nesting;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003041#define MAX_FUNC_NESTING 50
3042 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043 dictitem_T *v;
3044 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003045 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003047 hashitem_T *hi;
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003048 getline_opt_T getline_options;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003049 linenr_T sourcing_lnum_off;
3050 linenr_T sourcing_lnum_top;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003051 int is_heredoc = FALSE;
3052 char_u *skip_until = NULL;
3053 char_u *heredoc_trimmed = NULL;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003054 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003055 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003056
3057 /*
3058 * ":function" without argument: list functions.
3059 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003060 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003061 {
3062 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003063 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003064 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003065 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003066 }
3067
3068 /*
3069 * ":function /pat": list functions matching pattern.
3070 */
3071 if (*eap->arg == '/')
3072 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003073 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003074 if (!eap->skip)
3075 {
3076 regmatch_T regmatch;
3077
3078 c = *p;
3079 *p = NUL;
3080 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3081 *p = c;
3082 if (regmatch.regprog != NULL)
3083 {
3084 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003085 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086 vim_regfree(regmatch.regprog);
3087 }
3088 }
3089 if (*p == '/')
3090 ++p;
3091 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003092 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003093 }
3094
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003095 ga_init(&newargs);
3096 ga_init(&argtypes);
3097 ga_init(&default_args);
3098
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 /*
3100 * Get the function name. There are these situations:
3101 * func normal function name
3102 * "name" == func, "fudi.fd_dict" == NULL
3103 * dict.func new dictionary entry
3104 * "name" == NULL, "fudi.fd_dict" set,
3105 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3106 * dict.func existing dict entry with a Funcref
3107 * "name" == func, "fudi.fd_dict" set,
3108 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3109 * dict.func existing dict entry that's not a Funcref
3110 * "name" == NULL, "fudi.fd_dict" set,
3111 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3112 * s:func script-local function name
3113 * g:func global function name, same as "func"
3114 */
3115 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003116 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003117 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003118 // nested function, argument is (args).
3119 paren = TRUE;
3120 CLEAR_FIELD(fudi);
3121 }
3122 else
3123 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003124 if (STRNCMP(p, "<lambda>", 8) == 0)
3125 {
3126 p += 8;
3127 (void)getdigits(&p);
3128 name = vim_strnsave(eap->arg, p - eap->arg);
3129 CLEAR_FIELD(fudi);
3130 }
3131 else
3132 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003133 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003134 paren = (vim_strchr(p, '(') != NULL);
3135 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003137 /*
3138 * Return on an invalid expression in braces, unless the expression
3139 * evaluation has been cancelled due to an aborting error, an
3140 * interrupt, or an exception.
3141 */
3142 if (!aborting())
3143 {
3144 if (!eap->skip && fudi.fd_newkey != NULL)
3145 semsg(_(e_dictkey), fudi.fd_newkey);
3146 vim_free(fudi.fd_newkey);
3147 return NULL;
3148 }
3149 else
3150 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003151 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 }
3153
Bram Moolenaare38eab22019-12-05 21:50:01 +01003154 // An error in a function call during evaluation of an expression in magic
3155 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003156 saved_did_emsg = did_emsg;
3157 did_emsg = FALSE;
3158
3159 /*
3160 * ":function func" with only function name: list function.
3161 */
3162 if (!paren)
3163 {
3164 if (!ends_excmd(*skipwhite(p)))
3165 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003166 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003167 goto ret_free;
3168 }
3169 eap->nextcmd = check_nextcmd(p);
3170 if (eap->nextcmd != NULL)
3171 *p = NUL;
3172 if (!eap->skip && !got_int)
3173 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003174 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003175 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3176 {
3177 char_u *up = untrans_function_name(name);
3178
3179 // With Vim9 script the name was made script-local, if not
3180 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003181 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003182 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003183 }
3184
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003185 if (fp != NULL)
3186 {
3187 list_func_head(fp, TRUE);
3188 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3189 {
3190 if (FUNCLINE(fp, j) == NULL)
3191 continue;
3192 msg_putchar('\n');
3193 msg_outnum((long)(j + 1));
3194 if (j < 9)
3195 msg_putchar(' ');
3196 if (j < 99)
3197 msg_putchar(' ');
3198 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003199 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 ui_breakcheck();
3201 }
3202 if (!got_int)
3203 {
3204 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003205 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 msg_puts(" enddef");
3207 else
3208 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 }
3210 }
3211 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003212 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003213 }
3214 goto ret_free;
3215 }
3216
3217 /*
3218 * ":function name(arg1, arg2)" Define function.
3219 */
3220 p = skipwhite(p);
3221 if (*p != '(')
3222 {
3223 if (!eap->skip)
3224 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003225 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 goto ret_free;
3227 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003228 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 if (vim_strchr(p, '(') != NULL)
3230 p = vim_strchr(p, '(');
3231 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003233 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3234 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003235 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003236 goto ret_free;
3237 }
3238
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003239 // In Vim9 script only global functions can be redefined.
3240 if (vim9script && eap->forceit && !is_global)
3241 {
3242 emsg(_(e_nobang));
3243 goto ret_free;
3244 }
3245
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003246 ga_init2(&newlines, (int)sizeof(char_u *), 3);
3247
Bram Moolenaar04b12692020-05-04 23:24:44 +02003248 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003250 // Check the name of the function. Unless it's a dictionary function
3251 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 if (name != NULL)
3253 arg = name;
3254 else
3255 arg = fudi.fd_newkey;
3256 if (arg != NULL && (fudi.fd_di == NULL
3257 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3258 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3259 {
3260 if (*arg == K_SPECIAL)
3261 j = 3;
3262 else
3263 j = 0;
3264 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3265 : eval_isnamec(arg[j])))
3266 ++j;
3267 if (arg[j] != NUL)
3268 emsg_funcname((char *)e_invarg2, arg);
3269 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003270 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003271 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003272 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 }
3274
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003275 // This may get more lines and make the pointers into the first line
3276 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003277 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003278 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003279 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003280 &varargs, &default_args, eap->skip,
3281 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003282 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003283 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003287 // find the return type: :def Func(): type
3288 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003290 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003291 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003292 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003293 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003294 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003295 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003296 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003297 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003298 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003299 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003300 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003301 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003302 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003304 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003305 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003306 else
3307 // find extra arguments "range", "dict", "abort" and "closure"
3308 for (;;)
3309 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003310 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003311 p = skipwhite(p);
3312 if (STRNCMP(p, "range", 5) == 0)
3313 {
3314 flags |= FC_RANGE;
3315 p += 5;
3316 }
3317 else if (STRNCMP(p, "dict", 4) == 0)
3318 {
3319 flags |= FC_DICT;
3320 p += 4;
3321 }
3322 else if (STRNCMP(p, "abort", 5) == 0)
3323 {
3324 flags |= FC_ABORT;
3325 p += 5;
3326 }
3327 else if (STRNCMP(p, "closure", 7) == 0)
3328 {
3329 flags |= FC_CLOSURE;
3330 p += 7;
3331 if (current_funccal == NULL)
3332 {
3333 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3334 name == NULL ? (char_u *)"" : name);
3335 goto erret;
3336 }
3337 }
3338 else
3339 break;
3340 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341
Bram Moolenaare38eab22019-12-05 21:50:01 +01003342 // When there is a line break use what follows for the function body.
3343 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 if (*p == '\n')
3345 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003346 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003347 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3348 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003349 && !(VIM_ISWHITE(*whitep) && *p == '#'
3350 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003351 && !eap->skip
3352 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003353 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354
3355 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003356 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3357 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003358 */
3359 if (KeyTyped)
3360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003361 // Check if the function already exists, don't let the user type the
3362 // whole function before telling him it doesn't work! For a script we
3363 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003364 if (!eap->skip && !eap->forceit)
3365 {
3366 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003367 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003368 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 emsg_funcname(e_funcexts, name);
3370 }
3371
3372 if (!eap->skip && did_emsg)
3373 goto erret;
3374
Bram Moolenaare38eab22019-12-05 21:50:01 +01003375 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003376 cmdline_row = msg_row;
3377 }
3378
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003379 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003380 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003381
Bram Moolenaarbf8feb52020-08-08 14:26:31 +02003382 // Detect having skipped over comment lines to find the return
3383 // type. Add NULL lines to keep the line count correct.
3384 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
3385 if (SOURCING_LNUM < sourcing_lnum_off)
3386 {
3387 sourcing_lnum_off -= SOURCING_LNUM;
3388 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL)
3389 goto erret;
3390 while (sourcing_lnum_off-- > 0)
3391 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3392 }
3393
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394 indent = 2;
3395 nesting = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396 nesting_def[nesting] = (eap->cmdidx == CMD_def);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003397 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003398 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003399 for (;;)
3400 {
3401 if (KeyTyped)
3402 {
3403 msg_scroll = TRUE;
3404 saved_wait_return = FALSE;
3405 }
3406 need_wait_return = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003407
3408 if (line_arg != NULL)
3409 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003410 // Use eap->arg, split up in parts by line breaks.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003411 theline = line_arg;
3412 p = vim_strchr(theline, '\n');
3413 if (p == NULL)
3414 line_arg += STRLEN(line_arg);
3415 else
3416 {
3417 *p = NUL;
3418 line_arg = p + 1;
3419 }
3420 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 else
Bram Moolenaar53564f72017-06-24 14:48:11 +02003422 {
3423 vim_free(line_to_free);
3424 if (eap->getline == NULL)
Bram Moolenaar66250c92020-08-20 15:02:42 +02003425 theline = getcmdline(':', 0L, indent, getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003426 else
Bram Moolenaar66250c92020-08-20 15:02:42 +02003427 theline = eap->getline(':', eap->cookie, indent,
3428 getline_options);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003429 line_to_free = theline;
3430 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 if (KeyTyped)
3432 lines_left = Rows - 1;
3433 if (theline == NULL)
3434 {
Bram Moolenaarb8ba9b92021-01-01 18:54:34 +01003435 // Use the start of the function for the line number.
3436 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003437 if (skip_until != NULL)
3438 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
3439 else if (eap->cmdidx == CMD_def)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003440 emsg(_(e_missing_enddef));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003441 else
3442 emsg(_("E126: Missing :endfunction"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 goto erret;
3444 }
3445
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003446 // Detect line continuation: SOURCING_LNUM increased more than one.
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003447 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003448 if (SOURCING_LNUM < sourcing_lnum_off)
3449 sourcing_lnum_off -= SOURCING_LNUM;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 else
3451 sourcing_lnum_off = 0;
3452
3453 if (skip_until != NULL)
3454 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003455 // Don't check for ":endfunc"/":enddef" between
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003456 // * ":append" and "."
3457 // * ":python <<EOF" and "EOF"
3458 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
3459 if (heredoc_trimmed == NULL
3460 || (is_heredoc && skipwhite(theline) == theline)
3461 || STRNCMP(theline, heredoc_trimmed,
3462 STRLEN(heredoc_trimmed)) == 0)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003463 {
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003464 if (heredoc_trimmed == NULL)
3465 p = theline;
3466 else if (is_heredoc)
3467 p = skipwhite(theline) == theline
3468 ? theline : theline + STRLEN(heredoc_trimmed);
3469 else
3470 p = theline + STRLEN(heredoc_trimmed);
Bram Moolenaar8471e572019-05-19 21:37:18 +02003471 if (STRCMP(p, skip_until) == 0)
3472 {
3473 VIM_CLEAR(skip_until);
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003474 VIM_CLEAR(heredoc_trimmed);
Bram Moolenaardcc58e02020-12-28 20:53:21 +01003475 getline_options = eap->cmdidx == CMD_def
Bram Moolenaar8242ebb2020-12-29 11:15:01 +01003476 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
Bram Moolenaarecaa75b2019-07-21 23:04:21 +02003477 is_heredoc = FALSE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003478 }
3479 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003480 }
3481 else
3482 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003483 // skip ':' and blanks
Bram Moolenaar1c465442017-03-12 20:10:05 +01003484 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 ;
3486
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003487 // Check for "endfunction" or "enddef".
Bram Moolenaar832ea892021-01-08 21:55:26 +01003488 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003489 if (checkforcmd(&p, nesting_def[nesting]
Bram Moolenaar832ea892021-01-08 21:55:26 +01003490 ? "enddef" : "endfunction", 4)
3491 && *p != ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003492 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003493 if (nesting-- == 0)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003494 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003495 char_u *nextcmd = NULL;
3496
3497 if (*p == '|')
3498 nextcmd = p + 1;
3499 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
3500 nextcmd = line_arg;
3501 else if (*p != NUL && *p != '"' && p_verbose > 0)
3502 give_warning2(eap->cmdidx == CMD_def
3503 ? (char_u *)_("W1001: Text found after :enddef: %s")
3504 : (char_u *)_("W22: Text found after :endfunction: %s"),
3505 p, TRUE);
3506 if (nextcmd != NULL)
Bram Moolenaar53564f72017-06-24 14:48:11 +02003507 {
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003508 // Another command follows. If the line came from "eap"
3509 // we can simply point into it, otherwise we need to
3510 // change "eap->cmdlinep".
3511 eap->nextcmd = nextcmd;
3512 if (line_to_free != NULL)
3513 {
3514 vim_free(*eap->cmdlinep);
3515 *eap->cmdlinep = line_to_free;
3516 line_to_free = NULL;
3517 }
Bram Moolenaar53564f72017-06-24 14:48:11 +02003518 }
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003519 break;
Bram Moolenaar53564f72017-06-24 14:48:11 +02003520 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003521 }
3522
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003523 // Check for mismatched "endfunc" or "enddef".
3524 // We don't check for "def" inside "func" thus we also can't check
3525 // for "enddef".
3526 // We continue to find the end of the function, although we might
3527 // not find it.
3528 else if (nesting_def[nesting])
3529 {
Bram Moolenaar832ea892021-01-08 21:55:26 +01003530 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
Bram Moolenaar5178b1b2021-01-01 18:43:51 +01003531 emsg(_(e_mismatched_endfunction));
3532 }
3533 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
3534 emsg(_(e_mismatched_enddef));
3535
Bram Moolenaare38eab22019-12-05 21:50:01 +01003536 // Increase indent inside "if", "while", "for" and "try", decrease
3537 // at "end".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003538 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 indent -= 2;
3540 else if (STRNCMP(p, "if", 2) == 0
3541 || STRNCMP(p, "wh", 2) == 0
3542 || STRNCMP(p, "for", 3) == 0
3543 || STRNCMP(p, "try", 3) == 0)
3544 indent += 2;
3545
Bram Moolenaare38eab22019-12-05 21:50:01 +01003546 // Check for defining a function inside this function.
Bram Moolenaar673660a2020-01-26 16:50:05 +01003547 // Only recognize "def" inside "def", not inside "function",
3548 // For backwards compatibility, see Test_function_python().
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003549 c = *p;
Bram Moolenaaradc8e442020-12-31 18:28:18 +01003550 if (is_function_cmd(&p)
Bram Moolenaar673660a2020-01-26 16:50:05 +01003551 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 {
3553 if (*p == '!')
3554 p = skipwhite(p + 1);
3555 p += eval_fname_script(p);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003556 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
3557 NULL, NULL));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 if (*skipwhite(p) == '(')
3559 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003560 if (nesting == MAX_FUNC_NESTING - 1)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003561 emsg(_(e_function_nesting_too_deep));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003562 else
3563 {
3564 ++nesting;
3565 nesting_def[nesting] = (c == 'd');
3566 indent += 2;
3567 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 }
3569 }
3570
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003571 // Check for ":append", ":change", ":insert". Not for :def.
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003572 p = skip_range(p, FALSE, NULL);
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003573 if (eap->cmdidx != CMD_def
3574 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
Bram Moolenaar70bcd732017-01-12 22:20:54 +01003575 || (p[0] == 'c'
3576 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
3577 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
3578 && (STRNCMP(&p[3], "nge", 3) != 0
3579 || !ASCII_ISALPHA(p[6])))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580 || (p[0] == 'i'
3581 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003582 && (!ASCII_ISALPHA(p[2])
3583 || (p[2] == 's'
3584 && (!ASCII_ISALPHA(p[3])
3585 || p[3] == 'e'))))))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 skip_until = vim_strsave((char_u *)".");
3587
Bram Moolenaare38eab22019-12-05 21:50:01 +01003588 // Check for ":python <<EOF", ":tcl <<EOF", etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 arg = skipwhite(skiptowhite(p));
3590 if (arg[0] == '<' && arg[1] =='<'
3591 && ((p[0] == 'p' && p[1] == 'y'
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003592 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
3593 || ((p[2] == '3' || p[2] == 'x')
3594 && !ASCII_ISALPHA(p[3]))))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 || (p[0] == 'p' && p[1] == 'e'
3596 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
3597 || (p[0] == 't' && p[1] == 'c'
3598 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
3599 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
3600 && !ASCII_ISALPHA(p[3]))
3601 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
3602 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
3603 || (p[0] == 'm' && p[1] == 'z'
3604 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
3605 ))
3606 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003607 // ":python <<" continues until a dot, like ":append"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003608 p = skipwhite(arg + 2);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003609 if (STRNCMP(p, "trim", 4) == 0)
3610 {
3611 // Ignore leading white space.
3612 p = skipwhite(p + 4);
3613 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003614 skipwhite(theline) - theline);
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003615 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 if (*p == NUL)
3617 skip_until = vim_strsave((char_u *)".");
3618 else
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003619 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003620 getline_options = GETLINE_NONE;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +02003621 is_heredoc = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003623
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003624 // Check for ":cmd v =<< [trim] EOF"
3625 // and ":cmd [a, b] =<< [trim] EOF"
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003626 // and "lines =<< [trim] EOF" for Vim9
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003627 // Where "cmd" can be "let", "var", "final" or "const".
Bram Moolenaar8471e572019-05-19 21:37:18 +02003628 arg = skipwhite(skiptowhite(p));
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003629 if (*arg == '[')
3630 arg = vim_strchr(arg, ']');
3631 if (arg != NULL)
Bram Moolenaar8471e572019-05-19 21:37:18 +02003632 {
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003633 int found = (eap->cmdidx == CMD_def && arg[0] == '='
3634 && arg[1] == '<' && arg[2] =='<');
3635
3636 if (!found)
3637 // skip over the argument after "cmd"
3638 arg = skipwhite(skiptowhite(arg));
3639 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02003640 && (checkforcmd(&p, "let", 2)
3641 || checkforcmd(&p, "var", 3)
3642 || checkforcmd(&p, "final", 5)
Bram Moolenaarb5b94802020-12-13 17:50:20 +01003643 || checkforcmd(&p, "const", 5))))
Bram Moolenaar8471e572019-05-19 21:37:18 +02003644 {
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003645 p = skipwhite(arg + 3);
3646 if (STRNCMP(p, "trim", 4) == 0)
3647 {
3648 // Ignore leading white space.
3649 p = skipwhite(p + 4);
3650 heredoc_trimmed = vim_strnsave(theline,
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003651 skipwhite(theline) - theline);
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003652 }
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003653 skip_until = vim_strnsave(p, skiptowhite(p) - p);
Bram Moolenaar66250c92020-08-20 15:02:42 +02003654 getline_options = GETLINE_NONE;
Bram Moolenaar1e673b92019-11-06 15:02:50 +01003655 is_heredoc = TRUE;
Bram Moolenaar8471e572019-05-19 21:37:18 +02003656 }
Bram Moolenaar8471e572019-05-19 21:37:18 +02003657 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003658 }
3659
Bram Moolenaare38eab22019-12-05 21:50:01 +01003660 // Add the line to the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662 goto erret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663
Bram Moolenaare38eab22019-12-05 21:50:01 +01003664 // Copy the line to newly allocated memory. get_one_sourceline()
3665 // allocates 250 bytes per line, this saves 80% on average. The cost
3666 // is an extra alloc/free.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 p = vim_strsave(theline);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003668 if (p == NULL)
3669 goto erret;
3670 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671
Bram Moolenaare38eab22019-12-05 21:50:01 +01003672 // Add NULL lines for continuation lines, so that the line count is
3673 // equal to the index in the growarray.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 while (sourcing_lnum_off-- > 0)
3675 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL;
3676
Bram Moolenaare38eab22019-12-05 21:50:01 +01003677 // Check for end of eap->arg.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 if (line_arg != NULL && *line_arg == NUL)
3679 line_arg = NULL;
3680 }
3681
Bram Moolenaare38eab22019-12-05 21:50:01 +01003682 // Don't define the function when skipping commands or when an error was
3683 // detected.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 if (eap->skip || did_emsg)
3685 goto erret;
3686
3687 /*
3688 * If there are no errors, add the function
3689 */
3690 if (fudi.fd_dict == NULL)
3691 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003692 hashtab_T *ht;
3693
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003694 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3696 {
3697 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3698 name);
3699 goto erret;
3700 }
3701
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003703 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003705 char_u *uname = untrans_function_name(name);
3706
3707 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3708 }
3709
3710 if (fp != NULL || import != NULL)
3711 {
3712 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003713
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003714 // Function can be replaced with "function!" and when sourcing the
3715 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003716 // A name that is used by an import can not be overruled.
3717 if (import != NULL
3718 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003719 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003720 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003722 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003723 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003724 else
3725 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 goto erret;
3727 }
3728 if (fp->uf_calls > 0)
3729 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003730 emsg_funcname(
3731 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003732 name);
3733 goto erret;
3734 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003735 if (fp->uf_refcount > 1)
3736 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003737 // This function is referenced somewhere, don't redefine it but
3738 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003739 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003740 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003741 fp = NULL;
3742 overwrite = TRUE;
3743 }
3744 else
3745 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003746 char_u *exp_name = fp->uf_name_exp;
3747
3748 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003749 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003750 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003751 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003752 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003753 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003754#ifdef FEAT_PROFILE
3755 fp->uf_profiling = FALSE;
3756 fp->uf_prof_initialized = FALSE;
3757#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003758 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003759 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 }
3761 }
3762 else
3763 {
3764 char numbuf[20];
3765
3766 fp = NULL;
3767 if (fudi.fd_newkey == NULL && !eap->forceit)
3768 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003769 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003770 goto erret;
3771 }
3772 if (fudi.fd_di == NULL)
3773 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003774 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003775 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 goto erret;
3777 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003778 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003779 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 goto erret;
3781
Bram Moolenaare38eab22019-12-05 21:50:01 +01003782 // Give the function a sequential number. Can only be used with a
3783 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784 vim_free(name);
3785 sprintf(numbuf, "%d", ++func_nr);
3786 name = vim_strsave((char_u *)numbuf);
3787 if (name == NULL)
3788 goto erret;
3789 }
3790
3791 if (fp == NULL)
3792 {
3793 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
3794 {
3795 int slen, plen;
3796 char_u *scriptname;
3797
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003800 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 {
3802 scriptname = autoload_name(name);
3803 if (scriptname != NULL)
3804 {
3805 p = vim_strchr(scriptname, '/');
3806 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003807 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003808 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003809 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 j = OK;
3811 vim_free(scriptname);
3812 }
3813 }
3814 if (j == FAIL)
3815 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003816 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 goto erret;
3818 }
3819 }
3820
Bram Moolenaar47ed5532019-08-08 20:49:14 +02003821 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 if (fp == NULL)
3823 goto erret;
3824
3825 if (fudi.fd_dict != NULL)
3826 {
3827 if (fudi.fd_di == NULL)
3828 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003829 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
3831 if (fudi.fd_di == NULL)
3832 {
3833 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003834 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 goto erret;
3836 }
3837 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
3838 {
3839 vim_free(fudi.fd_di);
3840 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003841 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 goto erret;
3843 }
3844 }
3845 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01003846 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 clear_tv(&fudi.fd_di->di_tv);
3848 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003849 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850
Bram Moolenaare38eab22019-12-05 21:50:01 +01003851 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852 flags |= FC_DICT;
3853 }
3854
Bram Moolenaare38eab22019-12-05 21:50:01 +01003855 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003856 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003857 if (overwrite)
3858 {
3859 hi = hash_find(&func_hashtab, name);
3860 hi->hi_key = UF2HIKEY(fp);
3861 }
3862 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863 {
3864 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02003865 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866 goto erret;
3867 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003868 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 }
3870 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003871 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003872 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003873 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003874
3875 if (eap->cmdidx == CMD_def)
3876 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003877 int lnum_save = SOURCING_LNUM;
3878 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003879
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003880 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02003881
Bram Moolenaarbfe12042020-02-04 21:54:07 +01003882 // error messages are for the first function line
3883 SOURCING_LNUM = sourcing_lnum_top;
3884
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003885 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003886 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003887 int count = cstack->cs_idx + 1;
3888 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003889
3890 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003891 // a block that is visible now but not when the function is called
3892 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003893 fp->uf_block_ids = ALLOC_MULT(int, count);
3894 if (fp->uf_block_ids != NULL)
3895 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003896 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003897 sizeof(int) * count);
3898 fp->uf_block_depth = count;
3899 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02003900
3901 // Set flag in each block to indicate a function was defined. This
3902 // is used to keep the variable when leaving the block, see
3903 // hide_script_var().
3904 for (i = 0; i <= cstack->cs_idx; ++i)
3905 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003906 }
3907
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003908 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003909 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003910 SOURCING_LNUM = lnum_save;
3911 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003912 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003913 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003914
3915 // parse the return type, if any
3916 if (ret_type == NULL)
3917 fp->uf_ret_type = &t_void;
3918 else
3919 {
3920 p = ret_type;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003921 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaar648ea762021-01-15 19:04:32 +01003922 if (fp->uf_ret_type == NULL)
3923 {
3924 fp->uf_ret_type = &t_void;
3925 SOURCING_LNUM = lnum_save;
3926 goto erret;
3927 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003928 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02003929 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003930 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02003931 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003932 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003933
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003934 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003935 if ((flags & FC_CLOSURE) != 0)
3936 {
Bram Moolenaar58016442016-07-31 18:30:22 +02003937 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003938 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003939 }
3940 else
3941 fp->uf_scoped = NULL;
3942
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003943#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 if (prof_def_func())
3945 func_do_profile(fp);
3946#endif
3947 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02003948 if (sandbox)
3949 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003950 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003951 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003952 fp->uf_flags = flags;
3953 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01003954 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003955 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02003956 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003957 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003958 if (is_export)
3959 {
3960 fp->uf_flags |= FC_EXPORT;
3961 // let ex_export() know the export worked.
3962 is_export = FALSE;
3963 }
3964
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003965 if (eap->cmdidx == CMD_def)
3966 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02003967 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
3968 // :func does not use Vim9 script syntax, even in a Vim9 script file
3969 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02003970
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003971 goto ret_free;
3972
3973erret:
3974 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003975 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01003976 if (fp != NULL)
3977 {
3978 ga_init(&fp->uf_args);
3979 ga_init(&fp->uf_def_args);
3980 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981errret_2:
3982 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01003983 if (fp != NULL)
3984 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01003986 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003987 vim_free(skip_until);
Bram Moolenaarfffdf472020-12-13 21:16:55 +01003988 vim_free(heredoc_trimmed);
Bram Moolenaar53564f72017-06-24 14:48:11 +02003989 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003991 if (name != name_arg)
3992 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003993 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 did_emsg |= saved_did_emsg;
3995 need_wait_return |= saved_wait_return;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003996
3997 return fp;
3998}
3999
4000/*
4001 * ":function"
4002 */
4003 void
4004ex_function(exarg_T *eap)
4005{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004006 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004007}
4008
4009/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004010 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004011 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004012 */
4013 void
4014ex_defcompile(exarg_T *eap UNUSED)
4015{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004016 long todo = (long)func_hashtab.ht_used;
4017 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004018 hashitem_T *hi;
4019 ufunc_T *ufunc;
4020
4021 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4022 {
4023 if (!HASHITEM_EMPTY(hi))
4024 {
4025 --todo;
4026 ufunc = HI2UF(hi);
4027 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004028 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4029 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004030 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004031 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004032
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004033 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004034 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004035 // a function has been added or removed, need to start over
4036 todo = (long)func_hashtab.ht_used;
4037 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004038 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004039 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004040 }
4041 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004042 }
4043 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044}
4045
4046/*
4047 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4048 * Return 2 if "p" starts with "s:".
4049 * Return 0 otherwise.
4050 */
4051 int
4052eval_fname_script(char_u *p)
4053{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004054 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4055 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4057 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4058 return 5;
4059 if (p[0] == 's' && p[1] == ':')
4060 return 2;
4061 return 0;
4062}
4063
4064 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004065translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066{
4067 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004068 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004069 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004070}
4071
4072/*
4073 * Return TRUE when "ufunc" has old-style "..." varargs
4074 * or named varargs "...name: type".
4075 */
4076 int
4077has_varargs(ufunc_T *ufunc)
4078{
4079 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080}
4081
4082/*
4083 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004084 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004085 */
4086 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004087function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088{
4089 char_u *nm = name;
4090 char_u *p;
4091 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004092 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004093 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004095 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4096 if (no_deref)
4097 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004098 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099 nm = skipwhite(nm);
4100
Bram Moolenaare38eab22019-12-05 21:50:01 +01004101 // Only accept "funcname", "funcname ", "funcname (..." and
4102 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004103 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004104 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 vim_free(p);
4106 return n;
4107}
4108
Bram Moolenaar113e1072019-01-20 15:30:40 +01004109#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 char_u *
4111get_expanded_name(char_u *name, int check)
4112{
4113 char_u *nm = name;
4114 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004115 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004117 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004118 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004119
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004120 if (p != NULL && *nm == NUL
4121 && (!check || translated_function_exists(p, is_global)))
4122 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004123
4124 vim_free(p);
4125 return NULL;
4126}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004127#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004128
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004129/*
4130 * Function given to ExpandGeneric() to obtain the list of user defined
4131 * function names.
4132 */
4133 char_u *
4134get_user_func_name(expand_T *xp, int idx)
4135{
4136 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004137 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004138 static hashitem_T *hi;
4139 ufunc_T *fp;
4140
4141 if (idx == 0)
4142 {
4143 done = 0;
4144 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004145 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004147 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004148 {
4149 if (done++ > 0)
4150 ++hi;
4151 while (HASHITEM_EMPTY(hi))
4152 ++hi;
4153 fp = HI2UF(hi);
4154
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004155 // don't show dead, dict and lambda functions
4156 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004157 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004158 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159
4160 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004161 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162
4163 cat_func_name(IObuff, fp);
4164 if (xp->xp_context != EXPAND_USER_FUNC)
4165 {
4166 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004167 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004168 STRCAT(IObuff, ")");
4169 }
4170 return IObuff;
4171 }
4172 return NULL;
4173}
4174
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004175/*
4176 * ":delfunction {name}"
4177 */
4178 void
4179ex_delfunction(exarg_T *eap)
4180{
4181 ufunc_T *fp = NULL;
4182 char_u *p;
4183 char_u *name;
4184 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004185 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186
4187 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004188 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4189 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 vim_free(fudi.fd_newkey);
4191 if (name == NULL)
4192 {
4193 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004194 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 return;
4196 }
4197 if (!ends_excmd(*skipwhite(p)))
4198 {
4199 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004200 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004201 return;
4202 }
4203 eap->nextcmd = check_nextcmd(p);
4204 if (eap->nextcmd != NULL)
4205 *p = NUL;
4206
4207 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004208 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004209 vim_free(name);
4210
4211 if (!eap->skip)
4212 {
4213 if (fp == NULL)
4214 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004215 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004216 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004217 return;
4218 }
4219 if (fp->uf_calls > 0)
4220 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004221 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004222 return;
4223 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004224 if (fp->uf_flags & FC_VIM9)
4225 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004226 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004227 return;
4228 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004229
4230 if (fudi.fd_dict != NULL)
4231 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004232 // Delete the dict item that refers to the function, it will
4233 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004234 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4235 }
4236 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004237 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004238 // A normal function (not a numbered function or lambda) has a
4239 // refcount of 1 for the entry in the hashtable. When deleting
4240 // it and the refcount is more than one, it should be kept.
4241 // A numbered function and lambda should be kept if the refcount is
4242 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004243 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004244 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004245 // Function is still referenced somewhere. Don't free it but
4246 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004247 if (func_remove(fp))
4248 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004249 fp->uf_flags |= FC_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004250 }
4251 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004252 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004253 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254 }
4255}
4256
4257/*
4258 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004259 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 */
4261 void
4262func_unref(char_u *name)
4263{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004264 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004266 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004267 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004268 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004269 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004271#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004272 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004274 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004275 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004276 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004277}
4278
4279/*
4280 * Unreference a Function: decrement the reference count and free it when it
4281 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004282 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004283 */
4284 void
4285func_ptr_unref(ufunc_T *fp)
4286{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004287 if (fp != NULL && (--fp->uf_refcount <= 0
4288 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4289 && fp->uf_partial->pt_refcount <= 1
4290 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004291 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004292 // Only delete it when it's not being used. Otherwise it's done
4293 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004294 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004295 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 }
4297}
4298
4299/*
4300 * Count a reference to a Function.
4301 */
4302 void
4303func_ref(char_u *name)
4304{
4305 ufunc_T *fp;
4306
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004307 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004309 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004310 if (fp != NULL)
4311 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004313 // Only give an error for a numbered function.
4314 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004315 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004316}
4317
4318/*
4319 * Count a reference to a Function.
4320 */
4321 void
4322func_ptr_ref(ufunc_T *fp)
4323{
4324 if (fp != NULL)
4325 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004326}
4327
4328/*
4329 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4330 * referenced from anywhere that is in use.
4331 */
4332 static int
4333can_free_funccal(funccall_T *fc, int copyID)
4334{
4335 return (fc->l_varlist.lv_copyID != copyID
4336 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004337 && fc->l_avars.dv_copyID != copyID
4338 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004339}
4340
4341/*
4342 * ":return [expr]"
4343 */
4344 void
4345ex_return(exarg_T *eap)
4346{
4347 char_u *arg = eap->arg;
4348 typval_T rettv;
4349 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004350 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351
4352 if (current_funccal == NULL)
4353 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004354 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 return;
4356 }
4357
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004358 CLEAR_FIELD(evalarg);
4359 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4360
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361 if (eap->skip)
4362 ++emsg_skip;
4363
4364 eap->nextcmd = NULL;
4365 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004366 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 {
4368 if (!eap->skip)
4369 returning = do_return(eap, FALSE, TRUE, &rettv);
4370 else
4371 clear_tv(&rettv);
4372 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004373 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374 else if (!eap->skip)
4375 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004376 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004377 update_force_abort();
4378
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379 /*
4380 * Return unless the expression evaluation has been cancelled due to an
4381 * aborting error, an interrupt, or an exception.
4382 */
4383 if (!aborting())
4384 returning = do_return(eap, FALSE, TRUE, NULL);
4385 }
4386
Bram Moolenaare38eab22019-12-05 21:50:01 +01004387 // When skipping or the return gets pending, advance to the next command
4388 // in this line (!returning). Otherwise, ignore the rest of the line.
4389 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 if (returning)
4391 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004392 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 eap->nextcmd = check_nextcmd(arg);
4394
4395 if (eap->skip)
4396 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004397 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398}
4399
4400/*
4401 * ":1,25call func(arg1, arg2)" function call.
4402 */
4403 void
4404ex_call(exarg_T *eap)
4405{
4406 char_u *arg = eap->arg;
4407 char_u *startarg;
4408 char_u *name;
4409 char_u *tofree;
4410 int len;
4411 typval_T rettv;
4412 linenr_T lnum;
4413 int doesrange;
4414 int failed = FALSE;
4415 funcdict_T fudi;
4416 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004417 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004418 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004419
Bram Moolenaare6b53242020-07-01 17:28:33 +02004420 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 if (eap->skip)
4422 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004423 // trans_function_name() doesn't work well when skipping, use eval0()
4424 // instead to skip to any following command, e.g. for:
4425 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004427 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428 clear_tv(&rettv);
4429 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004430 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 return;
4432 }
4433
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004434 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4435 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 if (fudi.fd_newkey != NULL)
4437 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004438 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004439 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004440 vim_free(fudi.fd_newkey);
4441 }
4442 if (tofree == NULL)
4443 return;
4444
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 // Increase refcount on dictionary, it could get deleted when evaluating
4446 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 if (fudi.fd_dict != NULL)
4448 ++fudi.fd_dict->dv_refcount;
4449
Bram Moolenaare38eab22019-12-05 21:50:01 +01004450 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4451 // contents. For VAR_PARTIAL get its partial, unless we already have one
4452 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004453 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004454 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4455 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004456
Bram Moolenaare38eab22019-12-05 21:50:01 +01004457 // Skip white space to allow ":call func ()". Not good, but required for
4458 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004460 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004461
4462 if (*startarg != '(')
4463 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004464 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 goto end;
4466 }
4467
4468 /*
4469 * When skipping, evaluate the function once, to find the end of the
4470 * arguments.
4471 * When the function takes a range, this is discovered after the first
4472 * call, and the loop is broken.
4473 */
4474 if (eap->skip)
4475 {
4476 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004477 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 }
4479 else
4480 lnum = eap->line1;
4481 for ( ; lnum <= eap->line2; ++lnum)
4482 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004483 funcexe_T funcexe;
4484
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 if (!eap->skip && eap->addr_count > 0)
4486 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004487 if (lnum > curbuf->b_ml.ml_line_count)
4488 {
4489 // If the function deleted lines or switched to another buffer
4490 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004491 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004492 break;
4493 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 curwin->w_cursor.lnum = lnum;
4495 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004497 }
4498 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004499
Bram Moolenaara80faa82020-04-12 19:37:17 +02004500 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004501 funcexe.firstline = eap->line1;
4502 funcexe.lastline = eap->line2;
4503 funcexe.doesrange = &doesrange;
4504 funcexe.evaluate = !eap->skip;
4505 funcexe.partial = partial;
4506 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004507 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004508 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 {
4510 failed = TRUE;
4511 break;
4512 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004513 if (has_watchexpr())
4514 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004516 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004517 if (handle_subscript(&arg, &rettv,
4518 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519 {
4520 failed = TRUE;
4521 break;
4522 }
4523
4524 clear_tv(&rettv);
4525 if (doesrange || eap->skip)
4526 break;
4527
Bram Moolenaare38eab22019-12-05 21:50:01 +01004528 // Stop when immediately aborting on error, or when an interrupt
4529 // occurred or an exception was thrown but not caught.
4530 // get_func_tv() returned OK, so that the check for trailing
4531 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532 if (aborting())
4533 break;
4534 }
4535 if (eap->skip)
4536 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004537 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004538
Bram Moolenaare51bb172020-02-16 19:42:23 +01004539 // When inside :try we need to check for following "| catch".
4540 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004542 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004543 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004544 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004546 if (!failed)
4547 {
4548 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004549 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004550 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004551 }
4552 else
4553 eap->nextcmd = check_nextcmd(arg);
4554 }
4555
4556end:
4557 dict_unref(fudi.fd_dict);
4558 vim_free(tofree);
4559}
4560
4561/*
4562 * Return from a function. Possibly makes the return pending. Also called
4563 * for a pending return at the ":endtry" or after returning from an extra
4564 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4565 * when called due to a ":return" command. "rettv" may point to a typval_T
4566 * with the return rettv. Returns TRUE when the return can be carried out,
4567 * FALSE when the return gets pending.
4568 */
4569 int
4570do_return(
4571 exarg_T *eap,
4572 int reanimate,
4573 int is_cmd,
4574 void *rettv)
4575{
4576 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004577 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578
4579 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004580 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004581 current_funccal->returned = FALSE;
4582
4583 /*
4584 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4585 * not in its finally clause (which then is to be executed next) is found.
4586 * In this case, make the ":return" pending for execution at the ":endtry".
4587 * Otherwise, return normally.
4588 */
4589 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4590 if (idx >= 0)
4591 {
4592 cstack->cs_pending[idx] = CSTP_RETURN;
4593
4594 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004595 // A pending return again gets pending. "rettv" points to an
4596 // allocated variable with the rettv of the original ":return"'s
4597 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 cstack->cs_rettv[idx] = rettv;
4599 else
4600 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004601 // When undoing a return in order to make it pending, get the stored
4602 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 if (reanimate)
4604 rettv = current_funccal->rettv;
4605
4606 if (rettv != NULL)
4607 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004608 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004609 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4610 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4611 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004612 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004613 }
4614 else
4615 cstack->cs_rettv[idx] = NULL;
4616
4617 if (reanimate)
4618 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004619 // The pending return value could be overwritten by a ":return"
4620 // without argument in a finally clause; reset the default
4621 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622 current_funccal->rettv->v_type = VAR_NUMBER;
4623 current_funccal->rettv->vval.v_number = 0;
4624 }
4625 }
4626 report_make_pending(CSTP_RETURN, rettv);
4627 }
4628 else
4629 {
4630 current_funccal->returned = TRUE;
4631
Bram Moolenaare38eab22019-12-05 21:50:01 +01004632 // If the return is carried out now, store the return value. For
4633 // a return immediately after reanimation, the value is already
4634 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004635 if (!reanimate && rettv != NULL)
4636 {
4637 clear_tv(current_funccal->rettv);
4638 *current_funccal->rettv = *(typval_T *)rettv;
4639 if (!is_cmd)
4640 vim_free(rettv);
4641 }
4642 }
4643
4644 return idx < 0;
4645}
4646
4647/*
4648 * Free the variable with a pending return value.
4649 */
4650 void
4651discard_pending_return(void *rettv)
4652{
4653 free_tv((typval_T *)rettv);
4654}
4655
4656/*
4657 * Generate a return command for producing the value of "rettv". The result
4658 * is an allocated string. Used by report_pending() for verbose messages.
4659 */
4660 char_u *
4661get_return_cmd(void *rettv)
4662{
4663 char_u *s = NULL;
4664 char_u *tofree = NULL;
4665 char_u numbuf[NUMBUFLEN];
4666
4667 if (rettv != NULL)
4668 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4669 if (s == NULL)
4670 s = (char_u *)"";
4671
4672 STRCPY(IObuff, ":return ");
4673 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4674 if (STRLEN(s) + 8 >= IOSIZE)
4675 STRCPY(IObuff + IOSIZE - 4, "...");
4676 vim_free(tofree);
4677 return vim_strsave(IObuff);
4678}
4679
4680/*
4681 * Get next function line.
4682 * Called by do_cmdline() to get the next line.
4683 * Returns allocated string, or NULL for end of function.
4684 */
4685 char_u *
4686get_func_line(
4687 int c UNUSED,
4688 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004689 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004690 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691{
4692 funccall_T *fcp = (funccall_T *)cookie;
4693 ufunc_T *fp = fcp->func;
4694 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004695 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696
Bram Moolenaare38eab22019-12-05 21:50:01 +01004697 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698 if (fcp->dbg_tick != debug_tick)
4699 {
4700 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004701 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 fcp->dbg_tick = debug_tick;
4703 }
4704#ifdef FEAT_PROFILE
4705 if (do_profiling == PROF_YES)
4706 func_line_end(cookie);
4707#endif
4708
4709 gap = &fp->uf_lines;
4710 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4711 || fcp->returned)
4712 retval = NULL;
4713 else
4714 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004715 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004716 while (fcp->linenr < gap->ga_len
4717 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4718 ++fcp->linenr;
4719 if (fcp->linenr >= gap->ga_len)
4720 retval = NULL;
4721 else
4722 {
4723 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004724 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725#ifdef FEAT_PROFILE
4726 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004727 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004728#endif
4729 }
4730 }
4731
Bram Moolenaare38eab22019-12-05 21:50:01 +01004732 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004733 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004734 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004735 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004736 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004737 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004738 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004739 fcp->dbg_tick = debug_tick;
4740 }
4741
4742 return retval;
4743}
4744
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004745/*
4746 * Return TRUE if the currently active function should be ended, because a
4747 * return was encountered or an error occurred. Used inside a ":while".
4748 */
4749 int
4750func_has_ended(void *cookie)
4751{
4752 funccall_T *fcp = (funccall_T *)cookie;
4753
Bram Moolenaare38eab22019-12-05 21:50:01 +01004754 // Ignore the "abort" flag if the abortion behavior has been changed due to
4755 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4757 || fcp->returned);
4758}
4759
4760/*
4761 * return TRUE if cookie indicates a function which "abort"s on errors.
4762 */
4763 int
4764func_has_abort(
4765 void *cookie)
4766{
4767 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4768}
4769
4770
4771/*
4772 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4773 * Don't do this when "Func" is already a partial that was bound
4774 * explicitly (pt_auto is FALSE).
4775 * Changes "rettv" in-place.
4776 * Returns the updated "selfdict_in".
4777 */
4778 dict_T *
4779make_partial(dict_T *selfdict_in, typval_T *rettv)
4780{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004781 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 char_u *tofree = NULL;
4783 ufunc_T *fp;
4784 char_u fname_buf[FLEN_FIXED + 1];
4785 int error;
4786 dict_T *selfdict = selfdict_in;
4787
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004788 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4789 fp = rettv->vval.v_partial->pt_func;
4790 else
4791 {
4792 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4793 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004794 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004795 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004796 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004797 vim_free(tofree);
4798 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004799
4800 if (fp != NULL && (fp->uf_flags & FC_DICT))
4801 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004802 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004803
4804 if (pt != NULL)
4805 {
4806 pt->pt_refcount = 1;
4807 pt->pt_dict = selfdict;
4808 pt->pt_auto = TRUE;
4809 selfdict = NULL;
4810 if (rettv->v_type == VAR_FUNC)
4811 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004812 // Just a function: Take over the function name and use
4813 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004814 pt->pt_name = rettv->vval.v_string;
4815 }
4816 else
4817 {
4818 partial_T *ret_pt = rettv->vval.v_partial;
4819 int i;
4820
Bram Moolenaare38eab22019-12-05 21:50:01 +01004821 // Partial: copy the function name, use selfdict and copy
4822 // args. Can't take over name or args, the partial might
4823 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004824 if (ret_pt->pt_name != NULL)
4825 {
4826 pt->pt_name = vim_strsave(ret_pt->pt_name);
4827 func_ref(pt->pt_name);
4828 }
4829 else
4830 {
4831 pt->pt_func = ret_pt->pt_func;
4832 func_ptr_ref(pt->pt_func);
4833 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834 if (ret_pt->pt_argc > 0)
4835 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004836 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004837 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004838 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004839 pt->pt_argc = 0;
4840 else
4841 {
4842 pt->pt_argc = ret_pt->pt_argc;
4843 for (i = 0; i < pt->pt_argc; i++)
4844 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
4845 }
4846 }
4847 partial_unref(ret_pt);
4848 }
4849 rettv->v_type = VAR_PARTIAL;
4850 rettv->vval.v_partial = pt;
4851 }
4852 }
4853 return selfdict;
4854}
4855
4856/*
4857 * Return the name of the executed function.
4858 */
4859 char_u *
4860func_name(void *cookie)
4861{
4862 return ((funccall_T *)cookie)->func->uf_name;
4863}
4864
4865/*
4866 * Return the address holding the next breakpoint line for a funccall cookie.
4867 */
4868 linenr_T *
4869func_breakpoint(void *cookie)
4870{
4871 return &((funccall_T *)cookie)->breakpoint;
4872}
4873
4874/*
4875 * Return the address holding the debug tick for a funccall cookie.
4876 */
4877 int *
4878func_dbg_tick(void *cookie)
4879{
4880 return &((funccall_T *)cookie)->dbg_tick;
4881}
4882
4883/*
4884 * Return the nesting level for a funccall cookie.
4885 */
4886 int
4887func_level(void *cookie)
4888{
4889 return ((funccall_T *)cookie)->level;
4890}
4891
4892/*
4893 * Return TRUE when a function was ended by a ":return" command.
4894 */
4895 int
4896current_func_returned(void)
4897{
4898 return current_funccal->returned;
4899}
4900
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 int
4902free_unref_funccal(int copyID, int testing)
4903{
4904 int did_free = FALSE;
4905 int did_free_funccal = FALSE;
4906 funccall_T *fc, **pfc;
4907
4908 for (pfc = &previous_funccal; *pfc != NULL; )
4909 {
4910 if (can_free_funccal(*pfc, copyID))
4911 {
4912 fc = *pfc;
4913 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01004914 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915 did_free = TRUE;
4916 did_free_funccal = TRUE;
4917 }
4918 else
4919 pfc = &(*pfc)->caller;
4920 }
4921 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004922 // When a funccal was freed some more items might be garbage
4923 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004924 (void)garbage_collect(testing);
4925
4926 return did_free;
4927}
4928
4929/*
Bram Moolenaarba209902016-08-24 22:06:38 +02004930 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 */
4932 static funccall_T *
4933get_funccal(void)
4934{
4935 int i;
4936 funccall_T *funccal;
4937 funccall_T *temp_funccal;
4938
4939 funccal = current_funccal;
4940 if (debug_backtrace_level > 0)
4941 {
4942 for (i = 0; i < debug_backtrace_level; i++)
4943 {
4944 temp_funccal = funccal->caller;
4945 if (temp_funccal)
4946 funccal = temp_funccal;
4947 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004948 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004949 debug_backtrace_level = i;
4950 }
4951 }
4952 return funccal;
4953}
4954
4955/*
4956 * Return the hashtable used for local variables in the current funccal.
4957 * Return NULL if there is no current funccal.
4958 */
4959 hashtab_T *
4960get_funccal_local_ht()
4961{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004962 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004963 return NULL;
4964 return &get_funccal()->l_vars.dv_hashtab;
4965}
4966
4967/*
4968 * Return the l: scope variable.
4969 * Return NULL if there is no current funccal.
4970 */
4971 dictitem_T *
4972get_funccal_local_var()
4973{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004974 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975 return NULL;
4976 return &get_funccal()->l_vars_var;
4977}
4978
4979/*
4980 * Return the hashtable used for argument in the current funccal.
4981 * Return NULL if there is no current funccal.
4982 */
4983 hashtab_T *
4984get_funccal_args_ht()
4985{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004986 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004987 return NULL;
4988 return &get_funccal()->l_avars.dv_hashtab;
4989}
4990
4991/*
4992 * Return the a: scope variable.
4993 * Return NULL if there is no current funccal.
4994 */
4995 dictitem_T *
4996get_funccal_args_var()
4997{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004998 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004999 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005000 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005001}
5002
5003/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004 * List function variables, if there is a function.
5005 */
5006 void
5007list_func_vars(int *first)
5008{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005009 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005010 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005011 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012}
5013
5014/*
5015 * If "ht" is the hashtable for local variables in the current funccal, return
5016 * the dict that contains it.
5017 * Otherwise return NULL.
5018 */
5019 dict_T *
5020get_current_funccal_dict(hashtab_T *ht)
5021{
5022 if (current_funccal != NULL
5023 && ht == &current_funccal->l_vars.dv_hashtab)
5024 return &current_funccal->l_vars;
5025 return NULL;
5026}
5027
5028/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005029 * Search hashitem in parent scope.
5030 */
5031 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005032find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005033{
5034 funccall_T *old_current_funccal = current_funccal;
5035 hashtab_T *ht;
5036 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005037 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005038
5039 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5040 return NULL;
5041
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005042 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005043 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005044 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005045 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005046 ht = find_var_ht(name, &varname);
5047 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005048 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005049 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005050 if (!HASHITEM_EMPTY(hi))
5051 {
5052 *pht = ht;
5053 break;
5054 }
5055 }
5056 if (current_funccal == current_funccal->func->uf_scoped)
5057 break;
5058 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005059 }
5060 current_funccal = old_current_funccal;
5061
5062 return hi;
5063}
5064
5065/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005066 * Search variable in parent scope.
5067 */
5068 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005069find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005070{
5071 dictitem_T *v = NULL;
5072 funccall_T *old_current_funccal = current_funccal;
5073 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005074 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005075
5076 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5077 return NULL;
5078
Bram Moolenaare38eab22019-12-05 21:50:01 +01005079 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005080 current_funccal = current_funccal->func->uf_scoped;
5081 while (current_funccal)
5082 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005083 ht = find_var_ht(name, &varname);
5084 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005085 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005086 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005087 if (v != NULL)
5088 break;
5089 }
5090 if (current_funccal == current_funccal->func->uf_scoped)
5091 break;
5092 current_funccal = current_funccal->func->uf_scoped;
5093 }
5094 current_funccal = old_current_funccal;
5095
5096 return v;
5097}
5098
5099/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005100 * Set "copyID + 1" in previous_funccal and callers.
5101 */
5102 int
5103set_ref_in_previous_funccal(int copyID)
5104{
5105 int abort = FALSE;
5106 funccall_T *fc;
5107
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005108 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005110 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005111 abort = abort
5112 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5113 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005114 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005115 }
5116 return abort;
5117}
5118
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005119 static int
5120set_ref_in_funccal(funccall_T *fc, int copyID)
5121{
5122 int abort = FALSE;
5123
5124 if (fc->fc_copyID != copyID)
5125 {
5126 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005127 abort = abort
5128 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5129 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005130 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005131 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005132 }
5133 return abort;
5134}
5135
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136/*
5137 * Set "copyID" in all local vars and arguments in the call stack.
5138 */
5139 int
5140set_ref_in_call_stack(int copyID)
5141{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005142 int abort = FALSE;
5143 funccall_T *fc;
5144 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005146 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005147 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005148
5149 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005150 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5151 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005152 abort = abort || set_ref_in_funccal(fc, copyID);
5153
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005154 return abort;
5155}
5156
5157/*
5158 * Set "copyID" in all functions available by name.
5159 */
5160 int
5161set_ref_in_functions(int copyID)
5162{
5163 int todo;
5164 hashitem_T *hi = NULL;
5165 int abort = FALSE;
5166 ufunc_T *fp;
5167
5168 todo = (int)func_hashtab.ht_used;
5169 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005170 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005171 if (!HASHITEM_EMPTY(hi))
5172 {
5173 --todo;
5174 fp = HI2UF(hi);
5175 if (!func_name_refcount(fp->uf_name))
5176 abort = abort || set_ref_in_func(NULL, fp, copyID);
5177 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005178 }
5179 return abort;
5180}
5181
5182/*
5183 * Set "copyID" in all function arguments.
5184 */
5185 int
5186set_ref_in_func_args(int copyID)
5187{
5188 int i;
5189 int abort = FALSE;
5190
5191 for (i = 0; i < funcargs.ga_len; ++i)
5192 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5193 copyID, NULL, NULL);
5194 return abort;
5195}
5196
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005197/*
5198 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005199 * Returns TRUE if setting references failed somehow.
5200 */
5201 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005202set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005203{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005204 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005205 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005206 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005207 char_u fname_buf[FLEN_FIXED + 1];
5208 char_u *tofree = NULL;
5209 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005210 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005211
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005212 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005213 return FALSE;
5214
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005215 if (fp_in == NULL)
5216 {
5217 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005218 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005219 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005220 if (fp != NULL)
5221 {
5222 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005223 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005224 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005225
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005226 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005227 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005228}
5229
Bram Moolenaare38eab22019-12-05 21:50:01 +01005230#endif // FEAT_EVAL