blob: 8d06b4916c2f3ffcc6c826925b0fcc302e7fd9ac [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 Moolenaar79efa2e2021-03-27 15:40:11 +010038static void func_clear(ufunc_T *fp, int force);
39static int func_free(ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020040
41 void
42func_init()
43{
44 hash_init(&func_hashtab);
45}
46
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020047/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020048 * Return the function hash table
49 */
50 hashtab_T *
51func_tbl_get(void)
52{
53 return &func_hashtab;
54}
55
56/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020057 * Get one function argument.
58 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010059 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010060 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010061 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010065one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010070 evalarg_T *evalarg,
Bram Moolenaar2a389082021-04-09 20:24:31 +020071 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010072 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073{
Bram Moolenaar6e949782020-04-13 17:21:00 +020074 char_u *p = arg;
75 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
85 semsg(_("E125: Illegal argument: %s"), arg);
86 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
92 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010093 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010095 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
96 return arg;
97 if (newargs != NULL)
98 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010099 int c;
100 int i;
101
102 c = *p;
103 *p = NUL;
104 arg_copy = vim_strsave(arg);
105 if (arg_copy == NULL)
106 {
107 *p = c;
108 return arg;
109 }
110
111 // Check for duplicate argument name.
112 for (i = 0; i < newargs->ga_len; ++i)
113 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
114 {
115 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
116 vim_free(arg_copy);
117 return arg;
118 }
119 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
120 newargs->ga_len++;
121
122 *p = c;
123 }
124
125 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100126 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100127 {
128 char_u *type = NULL;
129
Bram Moolenaar6e949782020-04-13 17:21:00 +0200130 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
131 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200132 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200133 arg_copy == NULL ? arg : arg_copy);
134 p = skipwhite(p);
135 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100136 if (*p == ':')
137 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200138 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100139 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100141 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 return arg;
143 }
144 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200145 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100146 if (!skip)
147 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100148 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100149 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200150 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200151 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 arg_copy == NULL ? arg : arg_copy);
153 return arg;
154 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100155 if (!skip)
156 {
157 if (type == NULL && types_optional)
158 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200159 type = vim_strsave((char_u *)
160 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100161 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
162 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100163 }
164
165 return p;
166}
167
168/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200169 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100170 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100171 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200172 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100173 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200174get_function_args(
175 char_u **argp,
176 char_u endchar,
177 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100178 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100179 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100180 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200181 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200182 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200183 int skip,
184 exarg_T *eap,
185 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200186{
187 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100188 char_u *arg;
189 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200190 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200191 int any_default = FALSE;
192 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100193 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200194
195 if (newargs != NULL)
196 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100197 if (argtypes != NULL)
198 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200199 if (default_args != NULL)
200 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200201
202 if (varargs != NULL)
203 *varargs = FALSE;
204
205 /*
206 * Isolate the arguments: "arg1, arg2, ...)"
207 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100208 arg = skipwhite(*argp);
209 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200210 while (*p != endchar)
211 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200212 while (eap != NULL && eap->getline != NULL
213 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200214 {
215 char_u *theline;
216
217 // End of the line, get the next one.
218 theline = eap->getline(':', eap->cookie, 0, TRUE);
219 if (theline == NULL)
220 break;
221 vim_free(*line_to_free);
222 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200223 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200224 p = skipwhite(theline);
225 }
226
227 if (mustend && *p != endchar)
228 {
229 if (!skip)
230 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100231 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200232 }
233 if (*p == endchar)
234 break;
235
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200236 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
237 {
238 if (varargs != NULL)
239 *varargs = TRUE;
240 p += 3;
241 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100242
243 if (argtypes != NULL)
244 {
245 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200246 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100247 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100248 if (!skip)
249 emsg(_(e_missing_name_after_dots));
250 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100251 }
252
253 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100254 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200255 evalarg, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100256 if (p == arg)
257 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100258 if (*skipwhite(p) == '=')
259 {
260 emsg(_(e_cannot_use_default_for_variable_arguments));
261 break;
262 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100263 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200264 }
265 else
266 {
267 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100268 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar2a389082021-04-09 20:24:31 +0200269 evalarg, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100270 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200271 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200272
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200273 if (*skipwhite(p) == '=' && default_args != NULL)
274 {
275 typval_T rettv;
276
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100277 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200278 any_default = TRUE;
279 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200280 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200281 p = skipwhite(p);
282 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200283 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200284 {
285 if (ga_grow(default_args, 1) == FAIL)
286 goto err_ret;
287
288 // trim trailing whitespace
289 while (p > expr && VIM_ISWHITE(p[-1]))
290 p--;
291 c = *p;
292 *p = NUL;
293 expr = vim_strsave(expr);
294 if (expr == NULL)
295 {
296 *p = c;
297 goto err_ret;
298 }
299 ((char_u **)(default_args->ga_data))
300 [default_args->ga_len] = expr;
301 default_args->ga_len++;
302 *p = c;
303 }
304 else
305 mustend = TRUE;
306 }
307 else if (any_default)
308 {
309 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200310 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200311 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200312
313 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
314 {
315 // Be tolerant when skipping
316 if (!skip)
317 {
318 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
319 goto err_ret;
320 }
321 p = skipwhite(p);
322 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200323 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200324 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200326 // Don't give this error when skipping, it makes the "->" not
327 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100328 // Allow missing space after comma in legacy functions.
329 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200330 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
331 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100332 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200333 goto err_ret;
334 }
335 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200336 else
337 mustend = TRUE;
338 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200339 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200340 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200341 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200342
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200343 if (*p != endchar)
344 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100345 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200346
347 *argp = p;
348 return OK;
349
350err_ret:
351 if (newargs != NULL)
352 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200353 if (default_args != NULL)
354 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200355 return FAIL;
356}
357
358/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100359 * Parse the argument types, filling "fp->uf_arg_types".
360 * Return OK or FAIL.
361 */
362 static int
363parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
364{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200365 int len = 0;
366
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100367 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
368 if (argtypes->ga_len > 0)
369 {
370 // When "varargs" is set the last name/type goes into uf_va_name
371 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200372 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100373
374 if (len > 0)
375 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
376 if (fp->uf_arg_types != NULL)
377 {
378 int i;
379 type_T *type;
380
381 for (i = 0; i < len; ++ i)
382 {
383 char_u *p = ((char_u **)argtypes->ga_data)[i];
384
385 if (p == NULL)
386 // will get the type from the default value
387 type = &t_unknown;
388 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100389 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100390 if (type == NULL)
391 return FAIL;
392 fp->uf_arg_types[i] = type;
393 }
394 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100395 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200396
397 if (varargs)
398 {
399 char_u *p;
400
401 // Move the last argument "...name: type" to uf_va_name and
402 // uf_va_type.
403 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
404 [fp->uf_args.ga_len - 1];
405 --fp->uf_args.ga_len;
406 p = ((char_u **)argtypes->ga_data)[len];
407 if (p == NULL)
408 // TODO: get type from default value
409 fp->uf_va_type = &t_list_any;
410 else
411 {
412 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
413 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
414 {
415 semsg(_(e_variable_arguments_type_must_be_list_str),
416 ((char_u **)argtypes->ga_data)[len]);
417 return FAIL;
418 }
419 }
420 if (fp->uf_va_type == NULL)
421 return FAIL;
422 }
423
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100424 return OK;
425}
426
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100427 static int
428parse_return_type(ufunc_T *fp, char_u *ret_type)
429{
430 if (ret_type == NULL)
431 fp->uf_ret_type = &t_void;
432 else
433 {
434 char_u *p = ret_type;
435
436 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
437 if (fp->uf_ret_type == NULL)
438 {
439 fp->uf_ret_type = &t_void;
440 return FAIL;
441 }
442 }
443 return OK;
444}
445
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100446/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200447 * Register function "fp" as using "current_funccal" as its scope.
448 */
449 static int
450register_closure(ufunc_T *fp)
451{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200452 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100453 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200454 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200455 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200456 fp->uf_scoped = current_funccal;
457 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200458
Bram Moolenaar58016442016-07-31 18:30:22 +0200459 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
460 return FAIL;
461 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
462 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200463 return OK;
464}
465
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100466 static void
467set_ufunc_name(ufunc_T *fp, char_u *name)
468{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100469 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
470 // actually extends beyond the struct.
471 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100472
473 if (name[0] == K_SPECIAL)
474 {
475 fp->uf_name_exp = alloc(STRLEN(name) + 3);
476 if (fp->uf_name_exp != NULL)
477 {
478 STRCPY(fp->uf_name_exp, "<SNR>");
479 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
480 }
481 }
482}
483
Bram Moolenaar58016442016-07-31 18:30:22 +0200484/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200485 * Get a name for a lambda. Returned in static memory.
486 */
487 char_u *
488get_lambda_name(void)
489{
490 static char_u name[30];
491 static int lambda_no = 0;
492
493 sprintf((char*)name, "<lambda>%d", ++lambda_no);
494 return name;
495}
496
Bram Moolenaar801ab062020-06-25 19:27:56 +0200497#if defined(FEAT_LUA) || defined(PROTO)
498/*
499 * Registers a native C callback which can be called from Vim script.
500 * Returns the name of the Vim script function.
501 */
502 char_u *
503register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
504{
505 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200506 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200507
508 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
509 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200510 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200511
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200512 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200513 fp->uf_refcount = 1;
514 fp->uf_varargs = TRUE;
515 fp->uf_flags = FC_CFUNC;
516 fp->uf_calls = 0;
517 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200518 fp->uf_cb = cb;
519 fp->uf_cb_free = cb_free;
520 fp->uf_cb_state = state;
521
522 set_ufunc_name(fp, name);
523 hash_add(&func_hashtab, UF2HIKEY(fp));
524
525 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200526}
527#endif
528
Bram Moolenaar04b12692020-05-04 23:24:44 +0200529/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100530 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100531 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100532 * If "white_error" is not NULL check for correct use of white space and set
533 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100534 * Return NULL if no valid arrow found.
535 */
536 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100537skip_arrow(
538 char_u *start,
539 int equal_arrow,
540 char_u **ret_type,
541 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100542{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100543 char_u *s = start;
544 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100545
546 if (equal_arrow)
547 {
548 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100549 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100550 if (white_error != NULL && !VIM_ISWHITE(s[1]))
551 {
552 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100553 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100554 return NULL;
555 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100556 s = skipwhite(s + 1);
557 *ret_type = s;
558 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100559 if (s == *ret_type)
560 {
561 emsg(_(e_missing_return_type));
562 return NULL;
563 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100564 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100565 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100566 s = skipwhite(s);
567 if (*s != '=')
568 return NULL;
569 ++s;
570 }
571 if (*s != '>')
572 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100573 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
574 || !IS_WHITE_OR_NUL(s[1])))
575 {
576 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100577 semsg(_(e_white_space_required_before_and_after_str_at_str),
578 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100579 return NULL;
580 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100581 return skipwhite(s + 1);
582}
583
584/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100585 * Check if "*cmd" points to a function command and if so advance "*cmd" and
586 * return TRUE.
587 * Otherwise return FALSE;
588 * Do not consider "function(" to be a command.
589 */
590 static int
591is_function_cmd(char_u **cmd)
592{
593 char_u *p = *cmd;
594
595 if (checkforcmd(&p, "function", 2))
596 {
597 if (*p == '(')
598 return FALSE;
599 *cmd = p;
600 return TRUE;
601 }
602 return FALSE;
603}
604
605/*
606 * Read the body of a function, put every line in "newlines".
607 * "newlines" must already have been initialized.
608 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
609 */
610 static int
611get_function_body(
612 exarg_T *eap,
613 garray_T *newlines,
614 char_u *line_arg_in,
615 char_u **line_to_free)
616{
617 linenr_T sourcing_lnum_top = SOURCING_LNUM;
618 linenr_T sourcing_lnum_off;
619 int saved_wait_return = need_wait_return;
620 char_u *line_arg = line_arg_in;
621 int vim9_function = eap->cmdidx == CMD_def
622 || eap->cmdidx == CMD_block;
623#define MAX_FUNC_NESTING 50
624 char nesting_def[MAX_FUNC_NESTING];
625 int nesting = 0;
626 getline_opt_T getline_options;
627 int indent = 2;
628 char_u *skip_until = NULL;
629 int ret = FAIL;
630 int is_heredoc = FALSE;
631 char_u *heredoc_trimmed = NULL;
632
633 // Detect having skipped over comment lines to find the return
634 // type. Add NULL lines to keep the line count correct.
635 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
636 if (SOURCING_LNUM < sourcing_lnum_off)
637 {
638 sourcing_lnum_off -= SOURCING_LNUM;
639 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
640 goto theend;
641 while (sourcing_lnum_off-- > 0)
642 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
643 }
644
645 nesting_def[nesting] = vim9_function;
646 getline_options = vim9_function
647 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
648 for (;;)
649 {
650 char_u *theline;
651 char_u *p;
652 char_u *arg;
653
654 if (KeyTyped)
655 {
656 msg_scroll = TRUE;
657 saved_wait_return = FALSE;
658 }
659 need_wait_return = FALSE;
660
661 if (line_arg != NULL)
662 {
663 // Use eap->arg, split up in parts by line breaks.
664 theline = line_arg;
665 p = vim_strchr(theline, '\n');
666 if (p == NULL)
667 line_arg += STRLEN(line_arg);
668 else
669 {
670 *p = NUL;
671 line_arg = p + 1;
672 }
673 }
674 else
675 {
676 vim_free(*line_to_free);
677 if (eap->getline == NULL)
678 theline = getcmdline(':', 0L, indent, getline_options);
679 else
680 theline = eap->getline(':', eap->cookie, indent,
681 getline_options);
682 *line_to_free = theline;
683 }
684 if (KeyTyped)
685 lines_left = Rows - 1;
686 if (theline == NULL)
687 {
688 // Use the start of the function for the line number.
689 SOURCING_LNUM = sourcing_lnum_top;
690 if (skip_until != NULL)
691 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
692 else if (eap->cmdidx == CMD_def)
693 emsg(_(e_missing_enddef));
694 else if (eap->cmdidx == CMD_block)
695 emsg(_(e_missing_end_block));
696 else
697 emsg(_("E126: Missing :endfunction"));
698 goto theend;
699 }
700
701 // Detect line continuation: SOURCING_LNUM increased more than one.
702 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
703 if (SOURCING_LNUM < sourcing_lnum_off)
704 sourcing_lnum_off -= SOURCING_LNUM;
705 else
706 sourcing_lnum_off = 0;
707
708 if (skip_until != NULL)
709 {
710 // Don't check for ":endfunc"/":enddef" between
711 // * ":append" and "."
712 // * ":python <<EOF" and "EOF"
713 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
714 if (heredoc_trimmed == NULL
715 || (is_heredoc && skipwhite(theline) == theline)
716 || STRNCMP(theline, heredoc_trimmed,
717 STRLEN(heredoc_trimmed)) == 0)
718 {
719 if (heredoc_trimmed == NULL)
720 p = theline;
721 else if (is_heredoc)
722 p = skipwhite(theline) == theline
723 ? theline : theline + STRLEN(heredoc_trimmed);
724 else
725 p = theline + STRLEN(heredoc_trimmed);
726 if (STRCMP(p, skip_until) == 0)
727 {
728 VIM_CLEAR(skip_until);
729 VIM_CLEAR(heredoc_trimmed);
730 getline_options = vim9_function
731 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
732 is_heredoc = FALSE;
733 }
734 }
735 }
736 else
737 {
738 int c;
739
740 // skip ':' and blanks
741 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
742 ;
743
744 // Check for "endfunction", "enddef" or "}".
745 // When a ":" follows it must be a dict key; "enddef: value,"
746 if ((nesting == 0 && eap->cmdidx == CMD_block)
747 ? *p == '}'
748 : (checkforcmd(&p, nesting_def[nesting]
749 ? "enddef" : "endfunction", 4)
750 && *p != ':'))
751 {
752 if (nesting-- == 0)
753 {
754 char_u *nextcmd = NULL;
755
756 if (*p == '|' || *p == '}')
757 nextcmd = p + 1;
758 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
759 nextcmd = line_arg;
760 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100761 && (vim9_function || p_verbose > 0))
762 {
763 if (eap->cmdidx == CMD_def)
764 semsg(_(e_text_found_after_enddef_str), p);
765 else
766 give_warning2((char_u *)
767 _("W22: Text found after :endfunction: %s"),
768 p, TRUE);
769 }
770 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100771 {
772 // Another command follows. If the line came from "eap"
773 // we can simply point into it, otherwise we need to
774 // change "eap->cmdlinep".
775 eap->nextcmd = nextcmd;
776 if (*line_to_free != NULL)
777 {
778 vim_free(*eap->cmdlinep);
779 *eap->cmdlinep = *line_to_free;
780 *line_to_free = NULL;
781 }
782 }
783 break;
784 }
785 }
786
787 // Check for mismatched "endfunc" or "enddef".
788 // We don't check for "def" inside "func" thus we also can't check
789 // for "enddef".
790 // We continue to find the end of the function, although we might
791 // not find it.
792 else if (nesting_def[nesting])
793 {
794 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
795 emsg(_(e_mismatched_endfunction));
796 }
797 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
798 emsg(_(e_mismatched_enddef));
799
800 // Increase indent inside "if", "while", "for" and "try", decrease
801 // at "end".
802 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
803 indent -= 2;
804 else if (STRNCMP(p, "if", 2) == 0
805 || STRNCMP(p, "wh", 2) == 0
806 || STRNCMP(p, "for", 3) == 0
807 || STRNCMP(p, "try", 3) == 0)
808 indent += 2;
809
810 // Check for defining a function inside this function.
811 // Only recognize "def" inside "def", not inside "function",
812 // For backwards compatibility, see Test_function_python().
813 c = *p;
814 if (is_function_cmd(&p)
815 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
816 {
817 if (*p == '!')
818 p = skipwhite(p + 1);
819 p += eval_fname_script(p);
820 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
821 NULL, NULL));
822 if (*skipwhite(p) == '(')
823 {
824 if (nesting == MAX_FUNC_NESTING - 1)
825 emsg(_(e_function_nesting_too_deep));
826 else
827 {
828 ++nesting;
829 nesting_def[nesting] = (c == 'd');
830 indent += 2;
831 }
832 }
833 }
834
835 // Check for ":append", ":change", ":insert". Not for :def.
836 p = skip_range(p, FALSE, NULL);
837 if (!vim9_function
838 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
839 || (p[0] == 'c'
840 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
841 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
842 && (STRNCMP(&p[3], "nge", 3) != 0
843 || !ASCII_ISALPHA(p[6])))))))
844 || (p[0] == 'i'
845 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
846 && (!ASCII_ISALPHA(p[2])
847 || (p[2] == 's'
848 && (!ASCII_ISALPHA(p[3])
849 || p[3] == 'e'))))))))
850 skip_until = vim_strsave((char_u *)".");
851
852 // Check for ":python <<EOF", ":tcl <<EOF", etc.
853 arg = skipwhite(skiptowhite(p));
854 if (arg[0] == '<' && arg[1] =='<'
855 && ((p[0] == 'p' && p[1] == 'y'
856 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
857 || ((p[2] == '3' || p[2] == 'x')
858 && !ASCII_ISALPHA(p[3]))))
859 || (p[0] == 'p' && p[1] == 'e'
860 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
861 || (p[0] == 't' && p[1] == 'c'
862 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
863 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
864 && !ASCII_ISALPHA(p[3]))
865 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
866 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
867 || (p[0] == 'm' && p[1] == 'z'
868 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
869 ))
870 {
871 // ":python <<" continues until a dot, like ":append"
872 p = skipwhite(arg + 2);
873 if (STRNCMP(p, "trim", 4) == 0)
874 {
875 // Ignore leading white space.
876 p = skipwhite(p + 4);
877 heredoc_trimmed = vim_strnsave(theline,
878 skipwhite(theline) - theline);
879 }
880 if (*p == NUL)
881 skip_until = vim_strsave((char_u *)".");
882 else
883 skip_until = vim_strnsave(p, skiptowhite(p) - p);
884 getline_options = GETLINE_NONE;
885 is_heredoc = TRUE;
886 }
887
888 // Check for ":cmd v =<< [trim] EOF"
889 // and ":cmd [a, b] =<< [trim] EOF"
890 // and "lines =<< [trim] EOF" for Vim9
891 // Where "cmd" can be "let", "var", "final" or "const".
892 arg = skipwhite(skiptowhite(p));
893 if (*arg == '[')
894 arg = vim_strchr(arg, ']');
895 if (arg != NULL)
896 {
897 int found = (eap->cmdidx == CMD_def && arg[0] == '='
898 && arg[1] == '<' && arg[2] =='<');
899
900 if (!found)
901 // skip over the argument after "cmd"
902 arg = skipwhite(skiptowhite(arg));
903 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
904 && (checkforcmd(&p, "let", 2)
905 || checkforcmd(&p, "var", 3)
906 || checkforcmd(&p, "final", 5)
907 || checkforcmd(&p, "const", 5))))
908 {
909 p = skipwhite(arg + 3);
910 if (STRNCMP(p, "trim", 4) == 0)
911 {
912 // Ignore leading white space.
913 p = skipwhite(p + 4);
914 heredoc_trimmed = vim_strnsave(theline,
915 skipwhite(theline) - theline);
916 }
917 skip_until = vim_strnsave(p, skiptowhite(p) - p);
918 getline_options = GETLINE_NONE;
919 is_heredoc = TRUE;
920 }
921 }
922 }
923
924 // Add the line to the function.
925 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
926 goto theend;
927
928 // Copy the line to newly allocated memory. get_one_sourceline()
929 // allocates 250 bytes per line, this saves 80% on average. The cost
930 // is an extra alloc/free.
931 p = vim_strsave(theline);
932 if (p == NULL)
933 goto theend;
934 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
935
936 // Add NULL lines for continuation lines, so that the line count is
937 // equal to the index in the growarray.
938 while (sourcing_lnum_off-- > 0)
939 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
940
941 // Check for end of eap->arg.
942 if (line_arg != NULL && *line_arg == NUL)
943 line_arg = NULL;
944 }
945
946 // Don't define the function when skipping commands or when an error was
947 // detected.
948 if (!eap->skip && !did_emsg)
949 ret = OK;
950
951theend:
952 vim_free(skip_until);
953 vim_free(heredoc_trimmed);
954 need_wait_return |= saved_wait_return;
955 return ret;
956}
957
958/*
959 * Handle the body of a lambda. *arg points to the "{", process statements
960 * until the matching "}".
961 * When successful "rettv" is set to a funcref.
962 */
963 static int
964lambda_function_body(
965 char_u **arg,
966 typval_T *rettv,
967 evalarg_T *evalarg,
968 garray_T *newargs,
969 garray_T *argtypes,
970 int varargs,
971 garray_T *default_args,
972 char_u *ret_type)
973{
974 int evaluate = evalarg != NULL
975 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +0100976 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100977 exarg_T eap;
978 garray_T newlines;
979 char_u *cmdline = NULL;
980 int ret = FAIL;
981 char_u *line_to_free = NULL;
982 partial_T *pt;
983 char_u *name;
984 int lnum_save = -1;
985 linenr_T sourcing_lnum_top = SOURCING_LNUM;
986
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100987 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
988 {
989 semsg(_(e_trailing_arg), *arg + 1);
990 return FAIL;
991 }
992
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 CLEAR_FIELD(eap);
994 eap.cmdidx = CMD_block;
995 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100996 eap.cmdlinep = &cmdline;
997 eap.skip = !evaluate;
998 if (evalarg->eval_cctx != NULL)
999 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1000 else
1001 {
1002 eap.getline = evalarg->eval_getline;
1003 eap.cookie = evalarg->eval_cookie;
1004 }
1005
1006 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1007 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001008 {
1009 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001010 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001011 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001012 if (cmdline != NULL)
1013 {
1014 // Something comes after the "}".
1015 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001016
1017 // "arg" points into cmdline, need to keep the line and free it later.
1018 vim_free(evalarg->eval_tofree_cmdline);
1019 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001020 }
1021 else
1022 *arg = (char_u *)"";
1023
1024 name = get_lambda_name();
1025 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1026 if (ufunc == NULL)
1027 goto erret;
1028 set_ufunc_name(ufunc, name);
1029 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001030 goto erret;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001031 ufunc->uf_refcount = 1;
1032 ufunc->uf_args = *newargs;
1033 newargs->ga_data = NULL;
1034 ufunc->uf_def_args = *default_args;
1035 default_args->ga_data = NULL;
1036 ufunc->uf_func_type = &t_func_any;
1037
1038 // error messages are for the first function line
1039 lnum_save = SOURCING_LNUM;
1040 SOURCING_LNUM = sourcing_lnum_top;
1041
1042 // parse argument types
1043 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1044 {
1045 SOURCING_LNUM = lnum_save;
1046 goto erret;
1047 }
1048
1049 // parse the return type, if any
1050 if (parse_return_type(ufunc, ret_type) == FAIL)
1051 goto erret;
1052
1053 pt = ALLOC_CLEAR_ONE(partial_T);
1054 if (pt == NULL)
1055 goto erret;
1056 pt->pt_func = ufunc;
1057 pt->pt_refcount = 1;
1058
1059 ufunc->uf_lines = newlines;
1060 newlines.ga_data = NULL;
1061 if (sandbox)
1062 ufunc->uf_flags |= FC_SANDBOX;
1063 if (!ASCII_ISUPPER(*ufunc->uf_name))
1064 ufunc->uf_flags |= FC_VIM9;
1065 ufunc->uf_script_ctx = current_sctx;
1066 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1067 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1068 set_function_type(ufunc);
1069
1070 rettv->vval.v_partial = pt;
1071 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001072 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001073 ret = OK;
1074
1075erret:
1076 if (lnum_save >= 0)
1077 SOURCING_LNUM = lnum_save;
1078 vim_free(line_to_free);
1079 ga_clear_strings(&newlines);
1080 ga_clear_strings(newargs);
1081 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001082 if (ufunc != NULL)
1083 {
1084 func_clear(ufunc, TRUE);
1085 func_free(ufunc, TRUE);
1086 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001087 return ret;
1088}
1089
1090/*
1091 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001092 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001093 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001094 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1095 */
1096 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001097get_lambda_tv(
1098 char_u **arg,
1099 typval_T *rettv,
1100 int types_optional,
1101 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001102{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001103 int evaluate = evalarg != NULL
1104 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001105 garray_T newargs;
1106 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001107 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001108 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001109 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001110 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001111 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001112 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001113 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001114 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001115 char_u *s;
1116 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001117 int *old_eval_lavars = eval_lavars_used;
1118 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001119 char_u *tofree1 = NULL;
1120 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001121 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001122 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001123 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001124
1125 if (equal_arrow && !in_vim9script())
1126 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001127
1128 ga_init(&newargs);
1129 ga_init(&newlines);
1130
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001131 // First, check if this is really a lambda expression. "->" or "=>" must
1132 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001133 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001134 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001135 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001136 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001137 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001138 {
1139 if (types_optional)
1140 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001141 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001142 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001143
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001144 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001145 if (evaluate)
1146 pnewargs = &newargs;
1147 else
1148 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001149 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001150 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001151 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001152 &varargs, &default_args,
1153 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001154 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001155 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001156 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001157 {
1158 if (types_optional)
1159 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001160 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001161 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001162 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001163 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001164
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001165 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1166 if (ret_type != NULL)
1167 {
1168 ret_type = vim_strsave(ret_type);
1169 tofree2 = ret_type;
1170 }
1171
Bram Moolenaare38eab22019-12-05 21:50:01 +01001172 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001173 if (evaluate)
1174 eval_lavars_used = &eval_lavars;
1175
Bram Moolenaar65c44152020-12-24 15:14:01 +01001176 *arg = skipwhite_and_linebreak(*arg, evalarg);
1177
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001178 // Recognize "{" as the start of a function body.
1179 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001180 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001181 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1182 types_optional ? &argtypes : NULL, varargs,
1183 &default_args, ret_type) == FAIL)
1184 goto errret;
1185 goto theend;
1186 }
1187 if (default_args.ga_len > 0)
1188 {
1189 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001190 goto errret;
1191 }
1192
Bram Moolenaare38eab22019-12-05 21:50:01 +01001193 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001194 start = *arg;
1195 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001196 if (ret == FAIL)
1197 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001198 if (evalarg != NULL)
1199 {
1200 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001201 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001202 evalarg->eval_tofree = NULL;
1203 }
1204
Bram Moolenaar65c44152020-12-24 15:14:01 +01001205 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001206 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001207 *arg = skipwhite_and_linebreak(*arg, evalarg);
1208 if (**arg != '}')
1209 {
1210 semsg(_("E451: Expected }: %s"), *arg);
1211 goto errret;
1212 }
1213 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001214 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001215
1216 if (evaluate)
1217 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001218 int len;
1219 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001220 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001221 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001222
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001223 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001224 if (fp == NULL)
1225 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001226 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001227 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001228 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001229 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001230
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001231 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1232 if (ga_grow(&newlines, 1) == FAIL)
1233 goto errret;
1234
Bram Moolenaare38eab22019-12-05 21:50:01 +01001235 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001236 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001237 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001238 if (p == NULL)
1239 goto errret;
1240 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1241 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001242 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001243 if (strstr((char *)p + 7, "a:") == NULL)
1244 // No a: variables are used for sure.
1245 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001246
1247 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001248 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001249 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001250 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001251 if (types_optional)
1252 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001253 if (parse_argument_types(fp, &argtypes,
1254 in_vim9script() && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001255 goto errret;
1256 if (ret_type != NULL)
1257 {
1258 fp->uf_ret_type = parse_type(&ret_type,
1259 &fp->uf_type_list, TRUE);
1260 if (fp->uf_ret_type == NULL)
1261 goto errret;
1262 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001263 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001264 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001265 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001266
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001267 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001268 if (current_funccal != NULL && eval_lavars)
1269 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001270 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001271 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001272 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001273 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274
1275#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001276 if (prof_def_func())
1277 func_do_profile(fp);
1278#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001279 if (sandbox)
1280 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001281 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001282 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1283 fp->uf_varargs = !in_vim9script() || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001284 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001285 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001286 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001287 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001288
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001289 pt->pt_func = fp;
1290 pt->pt_refcount = 1;
1291 rettv->vval.v_partial = pt;
1292 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001293
1294 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001295 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001296
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001297theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001298 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001299 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001300 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001301 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001302 vim_free(tofree1);
1303 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001304 if (types_optional)
1305 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001306 return OK;
1307
1308errret:
1309 ga_clear_strings(&newargs);
1310 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001311 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001312 if (types_optional)
1313 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001315 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001316 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001317 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001318 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001319 vim_free(tofree1);
1320 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001321 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001322 return FAIL;
1323}
1324
1325/*
1326 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1327 * name it contains, otherwise return "name".
1328 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1329 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001330 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1331 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 */
1333 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001334deref_func_name(
1335 char_u *name,
1336 int *lenp,
1337 partial_T **partialp,
1338 type_T **type,
1339 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001340{
1341 dictitem_T *v;
1342 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001343 char_u *s = NULL;
1344 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001345
1346 if (partialp != NULL)
1347 *partialp = NULL;
1348
1349 cc = name[*lenp];
1350 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001351 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001352 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001353 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001354 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001355 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001356 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001357 if (v->di_tv.vval.v_string == NULL)
1358 {
1359 *lenp = 0;
1360 return (char_u *)""; // just in case
1361 }
1362 s = v->di_tv.vval.v_string;
1363 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001364 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001366 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001368 partial_T *pt = v->di_tv.vval.v_partial;
1369
1370 if (pt == NULL)
1371 {
1372 *lenp = 0;
1373 return (char_u *)""; // just in case
1374 }
1375 if (partialp != NULL)
1376 *partialp = pt;
1377 s = partial_name(pt);
1378 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001380
1381 if (s != NULL)
1382 {
1383 if (type != NULL && ht == get_script_local_ht())
1384 {
1385 svar_T *sv = find_typval_in_script(&v->di_tv);
1386
1387 if (sv != NULL)
1388 *type = sv->sv_type;
1389 }
1390 return s;
1391 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392 }
1393
1394 return name;
1395}
1396
1397/*
1398 * Give an error message with a function name. Handle <SNR> things.
1399 * "ermsg" is to be passed without translation, use N_() instead of _().
1400 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001401 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001402emsg_funcname(char *ermsg, char_u *name)
1403{
1404 char_u *p;
1405
1406 if (*name == K_SPECIAL)
1407 p = concat_str((char_u *)"<SNR>", name + 3);
1408 else
1409 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001410 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001411 if (p != name)
1412 vim_free(p);
1413}
1414
1415/*
1416 * Allocate a variable for the result of a function.
1417 * Return OK or FAIL.
1418 */
1419 int
1420get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001421 char_u *name, // name of the function
1422 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001423 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001424 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001425 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001426 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001427{
1428 char_u *argp;
1429 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001430 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1431 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001432 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433
1434 /*
1435 * Get the arguments.
1436 */
1437 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001438 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1439 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001441 // skip the '(' or ',' and possibly line breaks
1442 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1443
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001444 if (*argp == ')' || *argp == ',' || *argp == NUL)
1445 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001446 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447 {
1448 ret = FAIL;
1449 break;
1450 }
1451 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001452 // The comma should come right after the argument, but this wasn't
1453 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001454 if (vim9script)
1455 {
1456 if (*argp != ',' && *skipwhite(argp) == ',')
1457 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001458 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001459 ret = FAIL;
1460 break;
1461 }
1462 }
1463 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001464 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465 if (*argp != ',')
1466 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001467 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1468 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001469 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001470 ret = FAIL;
1471 break;
1472 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001473 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001474 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 if (*argp == ')')
1476 ++argp;
1477 else
1478 ret = FAIL;
1479
1480 if (ret == OK)
1481 {
1482 int i = 0;
1483
1484 if (get_vim_var_nr(VV_TESTING))
1485 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001486 // Prepare for calling test_garbagecollect_now(), need to know
1487 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001488 if (funcargs.ga_itemsize == 0)
1489 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1490 for (i = 0; i < argcount; ++i)
1491 if (ga_grow(&funcargs, 1) == OK)
1492 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1493 &argvars[i];
1494 }
1495
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001496 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001497
1498 funcargs.ga_len -= i;
1499 }
1500 else if (!aborting())
1501 {
1502 if (argcount == MAX_FUNC_ARGS)
1503 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1504 else
1505 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1506 }
1507
1508 while (--argcount >= 0)
1509 clear_tv(&argvars[argcount]);
1510
Bram Moolenaar8294d492020-08-10 22:40:56 +02001511 if (in_vim9script())
1512 *arg = argp;
1513 else
1514 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 return ret;
1516}
1517
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001518/*
1519 * Return TRUE if "p" starts with "<SID>" or "s:".
1520 * Only works if eval_fname_script() returned non-zero for "p"!
1521 */
1522 static int
1523eval_fname_sid(char_u *p)
1524{
1525 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1526}
1527
1528/*
1529 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1530 * Change <SNR>123_name() to K_SNR 123_name().
1531 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1532 * (slow).
1533 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001534 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001535fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1536{
1537 int llen;
1538 char_u *fname;
1539 int i;
1540
1541 llen = eval_fname_script(name);
1542 if (llen > 0)
1543 {
1544 fname_buf[0] = K_SPECIAL;
1545 fname_buf[1] = KS_EXTRA;
1546 fname_buf[2] = (int)KE_SNR;
1547 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001548 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001549 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001550 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001551 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 else
1553 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001554 sprintf((char *)fname_buf + 3, "%ld_",
1555 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001556 i = (int)STRLEN(fname_buf);
1557 }
1558 }
1559 if (i + STRLEN(name + llen) < FLEN_FIXED)
1560 {
1561 STRCPY(fname_buf + i, name + llen);
1562 fname = fname_buf;
1563 }
1564 else
1565 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001566 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001567 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001568 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569 else
1570 {
1571 *tofree = fname;
1572 mch_memmove(fname, fname_buf, (size_t)i);
1573 STRCPY(fname + i, name + llen);
1574 }
1575 }
1576 }
1577 else
1578 fname = name;
1579 return fname;
1580}
1581
1582/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001583 * Find a function "name" in script "sid".
1584 */
1585 static ufunc_T *
1586find_func_with_sid(char_u *name, int sid)
1587{
1588 hashitem_T *hi;
1589 char_u buffer[200];
1590
1591 buffer[0] = K_SPECIAL;
1592 buffer[1] = KS_EXTRA;
1593 buffer[2] = (int)KE_SNR;
1594 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1595 (long)sid, name);
1596 hi = hash_find(&func_hashtab, buffer);
1597 if (!HASHITEM_EMPTY(hi))
1598 return HI2UF(hi);
1599
1600 return NULL;
1601}
1602
1603/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001604 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001605 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001606 * Return NULL for unknown function.
1607 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001608 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001609find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610{
1611 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001612 ufunc_T *func;
1613 imported_T *imported;
1614
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001615 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001616 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001617 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001618 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001619 int find_script_local = in_vim9script()
1620 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001621
Bram Moolenaar95006e32020-08-29 17:47:08 +02001622 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001623 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001624 // Find script-local function before global one.
1625 func = find_func_with_sid(name, current_sctx.sc_sid);
1626 if (func != NULL)
1627 return func;
1628 }
1629
Bram Moolenaarefa94442020-08-08 22:16:00 +02001630 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001631 && name[1] == KS_EXTRA
1632 && name[2] == KE_SNR)
1633 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001634 // Caller changes s: to <SNR>99_name.
1635
1636 after_script = name + 3;
1637 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001638 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001639 ++after_script;
1640 else
1641 after_script = NULL;
1642 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001643 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001644 {
1645 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001646 if (after_script != NULL && sid != current_sctx.sc_sid)
1647 imported = find_imported_in_script(after_script, 0, sid);
1648 else
1649 imported = find_imported(after_script == NULL
1650 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001651 if (imported != NULL && imported->imp_funcname != NULL)
1652 {
1653 hi = hash_find(&func_hashtab, imported->imp_funcname);
1654 if (!HASHITEM_EMPTY(hi))
1655 return HI2UF(hi);
1656 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001657 }
1658 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001659
Bram Moolenaara26b9702020-04-18 19:53:28 +02001660 hi = hash_find(&func_hashtab,
1661 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001662 if (!HASHITEM_EMPTY(hi))
1663 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001664
1665 return NULL;
1666}
1667
1668/*
1669 * Find a function by name, return pointer to it in ufuncs.
1670 * "cctx" is passed in a :def function to find imported functions.
1671 * Return NULL for unknown or dead function.
1672 */
1673 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001674find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001675{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001676 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001677
1678 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1679 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 return NULL;
1681}
1682
1683/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001684 * Return TRUE if "ufunc" is a global function.
1685 */
1686 int
1687func_is_global(ufunc_T *ufunc)
1688{
1689 return ufunc->uf_name[0] != K_SPECIAL;
1690}
1691
1692/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001693 * Copy the function name of "fp" to buffer "buf".
1694 * "buf" must be able to hold the function name plus three bytes.
1695 * Takes care of script-local function names.
1696 */
1697 static void
1698cat_func_name(char_u *buf, ufunc_T *fp)
1699{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001700 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001701 {
1702 STRCPY(buf, "<SNR>");
1703 STRCAT(buf, fp->uf_name + 3);
1704 }
1705 else
1706 STRCPY(buf, fp->uf_name);
1707}
1708
1709/*
1710 * Add a number variable "name" to dict "dp" with value "nr".
1711 */
1712 static void
1713add_nr_var(
1714 dict_T *dp,
1715 dictitem_T *v,
1716 char *name,
1717 varnumber_T nr)
1718{
1719 STRCPY(v->di_key, name);
1720 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1721 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1722 v->di_tv.v_type = VAR_NUMBER;
1723 v->di_tv.v_lock = VAR_FIXED;
1724 v->di_tv.vval.v_number = nr;
1725}
1726
1727/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001728 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001729 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001730 static void
1731free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001732{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001733 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001734
1735 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1736 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001737 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001738
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001739 // When garbage collecting a funccall_T may be freed before the
1740 // function that references it, clear its uf_scoped field.
1741 // The function may have been redefined and point to another
1742 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001743 if (fp != NULL && fp->uf_scoped == fc)
1744 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001745 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001746 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001748 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 vim_free(fc);
1750}
1751
1752/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001753 * Free "fc" and what it contains.
1754 * Can be called only when "fc" is kept beyond the period of it called,
1755 * i.e. after cleanup_function_call(fc).
1756 */
1757 static void
1758free_funccal_contents(funccall_T *fc)
1759{
1760 listitem_T *li;
1761
1762 // Free all l: variables.
1763 vars_clear(&fc->l_vars.dv_hashtab);
1764
1765 // Free all a: variables.
1766 vars_clear(&fc->l_avars.dv_hashtab);
1767
1768 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001769 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001770 clear_tv(&li->li_tv);
1771
1772 free_funccal(fc);
1773}
1774
1775/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001776 * Handle the last part of returning from a function: free the local hashtable.
1777 * Unless it is still in use by a closure.
1778 */
1779 static void
1780cleanup_function_call(funccall_T *fc)
1781{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001782 int may_free_fc = fc->fc_refcount <= 0;
1783 int free_fc = TRUE;
1784
Bram Moolenaar6914c642017-04-01 21:21:30 +02001785 current_funccal = fc->caller;
1786
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001787 // Free all l: variables if not referred.
1788 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1789 vars_clear(&fc->l_vars.dv_hashtab);
1790 else
1791 free_fc = FALSE;
1792
1793 // If the a:000 list and the l: and a: dicts are not referenced and
1794 // there is no closure using it, we can free the funccall_T and what's
1795 // in it.
1796 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1797 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001798 else
1799 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001800 int todo;
1801 hashitem_T *hi;
1802 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001803
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001804 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001805
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001806 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001807 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1808 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1809 {
1810 if (!HASHITEM_EMPTY(hi))
1811 {
1812 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001813 di = HI2DI(hi);
1814 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001815 }
1816 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001817 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001818
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001819 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1820 fc->l_varlist.lv_first = NULL;
1821 else
1822 {
1823 listitem_T *li;
1824
1825 free_fc = FALSE;
1826
1827 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001828 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001829 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001830 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001831
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001832 if (free_fc)
1833 free_funccal(fc);
1834 else
1835 {
1836 static int made_copy = 0;
1837
1838 // "fc" is still in use. This can happen when returning "a:000",
1839 // assigning "l:" to a global variable or defining a closure.
1840 // Link "fc" in the list for garbage collection later.
1841 fc->caller = previous_funccal;
1842 previous_funccal = fc;
1843
1844 if (want_garbage_collect)
1845 // If garbage collector is ready, clear count.
1846 made_copy = 0;
1847 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001848 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001849 // We have made a lot of copies, worth 4 Mbyte. This can happen
1850 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001851 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001852 // too much memory.
1853 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001854 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001855 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001856 }
1857}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001858
1859/*
1860 * There are two kinds of function names:
1861 * 1. ordinary names, function defined with :function or :def
1862 * 2. numbered functions and lambdas
1863 * For the first we only count the name stored in func_hashtab as a reference,
1864 * using function() does not count as a reference, because the function is
1865 * looked up by name.
1866 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001867 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001868func_name_refcount(char_u *name)
1869{
1870 return isdigit(*name) || *name == '<';
1871}
1872
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001873/*
1874 * Unreference "fc": decrement the reference count and free it when it
1875 * becomes zero. "fp" is detached from "fc".
1876 * When "force" is TRUE we are exiting.
1877 */
1878 static void
1879funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1880{
1881 funccall_T **pfc;
1882 int i;
1883
1884 if (fc == NULL)
1885 return;
1886
1887 if (--fc->fc_refcount <= 0 && (force || (
1888 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1889 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1890 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1891 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1892 {
1893 if (fc == *pfc)
1894 {
1895 *pfc = fc->caller;
1896 free_funccal_contents(fc);
1897 return;
1898 }
1899 }
1900 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1901 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1902 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1903}
1904
1905/*
1906 * Remove the function from the function hashtable. If the function was
1907 * deleted while it still has references this was already done.
1908 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1909 */
1910 static int
1911func_remove(ufunc_T *fp)
1912{
1913 hashitem_T *hi;
1914
1915 // Return if it was already virtually deleted.
1916 if (fp->uf_flags & FC_DEAD)
1917 return FALSE;
1918
1919 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1920 if (!HASHITEM_EMPTY(hi))
1921 {
1922 // When there is a def-function index do not actually remove the
1923 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001924 // Do remove it when it's a copy.
1925 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001926 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001927 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001928 return FALSE;
1929 }
1930 hash_remove(&func_hashtab, hi);
1931 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001932 return TRUE;
1933 }
1934 return FALSE;
1935}
1936
1937 static void
1938func_clear_items(ufunc_T *fp)
1939{
1940 ga_clear_strings(&(fp->uf_args));
1941 ga_clear_strings(&(fp->uf_def_args));
1942 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001943 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001944 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001945 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001946 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001947
1948 // Increment the refcount of this function to avoid it being freed
1949 // recursively when the partial is freed.
1950 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001951 partial_unref(fp->uf_partial);
1952 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001953 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001954
1955#ifdef FEAT_LUA
1956 if (fp->uf_cb_free != NULL)
1957 {
1958 fp->uf_cb_free(fp->uf_cb_state);
1959 fp->uf_cb_free = NULL;
1960 }
1961
1962 fp->uf_cb_state = NULL;
1963 fp->uf_cb = NULL;
1964#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001965#ifdef FEAT_PROFILE
1966 VIM_CLEAR(fp->uf_tml_count);
1967 VIM_CLEAR(fp->uf_tml_total);
1968 VIM_CLEAR(fp->uf_tml_self);
1969#endif
1970}
1971
1972/*
1973 * Free all things that a function contains. Does not free the function
1974 * itself, use func_free() for that.
1975 * When "force" is TRUE we are exiting.
1976 */
1977 static void
1978func_clear(ufunc_T *fp, int force)
1979{
1980 if (fp->uf_cleared)
1981 return;
1982 fp->uf_cleared = TRUE;
1983
1984 // clear this function
1985 func_clear_items(fp);
1986 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001987 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001988}
1989
1990/*
1991 * Free a function and remove it from the list of functions. Does not free
1992 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001993 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001994 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001995 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001996 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001997func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001998{
1999 // Only remove it when not done already, otherwise we would remove a newer
2000 // version of the function with the same name.
2001 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2002 func_remove(fp);
2003
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002004 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002005 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002006 if (fp->uf_dfunc_idx > 0)
2007 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002008 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002010 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002011 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002012 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002013}
2014
2015/*
2016 * Free all things that a function contains and free the function itself.
2017 * When "force" is TRUE we are exiting.
2018 */
2019 static void
2020func_clear_free(ufunc_T *fp, int force)
2021{
2022 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002023 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2024 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002025 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002026 else
2027 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002028}
2029
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002030/*
2031 * Copy already defined function "lambda" to a new function with name "global".
2032 * This is for when a compiled function defines a global function.
2033 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002034 int
2035copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002036{
2037 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002038 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002039
2040 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002041 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002042 semsg(_(e_lambda_function_not_found_str), lambda);
2043 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002044 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002045
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002046 fp = find_func(global, TRUE, NULL);
2047 if (fp != NULL)
2048 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002049 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002050 semsg(_(e_funcexts), global);
2051 return FAIL;
2052 }
2053
2054 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2055 if (fp == NULL)
2056 return FAIL;
2057
2058 fp->uf_varargs = ufunc->uf_varargs;
2059 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2060 fp->uf_def_status = ufunc->uf_def_status;
2061 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2062 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2063 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2064 == FAIL
2065 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2066 goto failed;
2067
2068 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2069 : vim_strsave(ufunc->uf_name_exp);
2070 if (ufunc->uf_arg_types != NULL)
2071 {
2072 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2073 if (fp->uf_arg_types == NULL)
2074 goto failed;
2075 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2076 sizeof(type_T *) * fp->uf_args.ga_len);
2077 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002078 if (ufunc->uf_va_name != NULL)
2079 {
2080 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2081 if (fp->uf_va_name == NULL)
2082 goto failed;
2083 }
2084 fp->uf_ret_type = ufunc->uf_ret_type;
2085
2086 fp->uf_refcount = 1;
2087 STRCPY(fp->uf_name, global);
2088 hash_add(&func_hashtab, UF2HIKEY(fp));
2089
2090 // the referenced dfunc_T is now used one more time
2091 link_def_function(fp);
2092
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002093 // Create a partial to store the context of the function where it was
2094 // instantiated. Only needs to be done once. Do this on the original
2095 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002096 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2097 {
2098 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2099
2100 if (pt == NULL)
2101 goto failed;
2102 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002103 {
2104 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002105 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002106 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002107 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002108 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002109 }
2110
2111 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002112
2113failed:
2114 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002115 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002116}
2117
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002118static int funcdepth = 0;
2119
2120/*
2121 * Increment the function call depth count.
2122 * Return FAIL when going over 'maxfuncdepth'.
2123 * Otherwise return OK, must call funcdepth_decrement() later!
2124 */
2125 int
2126funcdepth_increment(void)
2127{
2128 if (funcdepth >= p_mfd)
2129 {
2130 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2131 return FAIL;
2132 }
2133 ++funcdepth;
2134 return OK;
2135}
2136
2137 void
2138funcdepth_decrement(void)
2139{
2140 --funcdepth;
2141}
2142
2143/*
2144 * Get the current function call depth.
2145 */
2146 int
2147funcdepth_get(void)
2148{
2149 return funcdepth;
2150}
2151
2152/*
2153 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002154 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002155 * times as funcdepth_increment().
2156 */
2157 void
2158funcdepth_restore(int depth)
2159{
2160 funcdepth = depth;
2161}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002162
2163/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002164 * Call a user function.
2165 */
2166 static void
2167call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002168 ufunc_T *fp, // pointer to function
2169 int argcount, // nr of args
2170 typval_T *argvars, // arguments
2171 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002172 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002173 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002174{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002175 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002176 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002177 funccall_T *fc;
2178 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002179 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002180 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002181 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002182 int i;
2183 int ai;
2184 int islambda = FALSE;
2185 char_u numbuf[NUMBUFLEN];
2186 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002187#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002188 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002189#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002190 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002191
Bram Moolenaarb2049902021-01-24 12:53:53 +01002192#ifdef FEAT_PROFILE
2193 CLEAR_FIELD(profile_info);
2194#endif
2195
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002196 // If depth of calling is getting too high, don't execute the function.
2197 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002198 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002199 rettv->v_type = VAR_NUMBER;
2200 rettv->vval.v_number = -1;
2201 return;
2202 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002203
Bram Moolenaare38eab22019-12-05 21:50:01 +01002204 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002205
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002206 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002207 if (fc == NULL)
2208 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002209 fc->caller = current_funccal;
2210 current_funccal = fc;
2211 fc->func = fp;
2212 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002213 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002214 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002215 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2216 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002217 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002218 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002219 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002220
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002221 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002222 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002223#ifdef FEAT_PROFILE
2224 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2225#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002226 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002227#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002228 if (do_profiling == PROF_YES)
2229 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002230#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002231 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002232 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002233#ifdef FEAT_PROFILE
2234 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002235 || (caller != NULL && caller->uf_profiling)))
2236 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002237#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002238 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002239 free_funccal(fc);
2240 return;
2241 }
2242
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002243 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2244 islambda = TRUE;
2245
2246 /*
2247 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2248 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2249 * each argument variable and saves a lot of time.
2250 */
2251 /*
2252 * Init l: variables.
2253 */
2254 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2255 if (selfdict != NULL)
2256 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002257 // Set l:self to "selfdict". Use "name" to avoid a warning from
2258 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002259 v = &fc->fixvar[fixvar_idx++].var;
2260 name = v->di_key;
2261 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002262 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002263 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2264 v->di_tv.v_type = VAR_DICT;
2265 v->di_tv.v_lock = 0;
2266 v->di_tv.vval.v_dict = selfdict;
2267 ++selfdict->dv_refcount;
2268 }
2269
2270 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002271 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002272 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002273 * Set a:000 to a list with room for the "..." arguments.
2274 */
2275 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002276 if ((fp->uf_flags & FC_NOARGS) == 0)
2277 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002278 (varnumber_T)(argcount >= fp->uf_args.ga_len
2279 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002280 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002281 if ((fp->uf_flags & FC_NOARGS) == 0)
2282 {
2283 // Use "name" to avoid a warning from some compiler that checks the
2284 // destination size.
2285 v = &fc->fixvar[fixvar_idx++].var;
2286 name = v->di_key;
2287 STRCPY(name, "000");
2288 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2289 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2290 v->di_tv.v_type = VAR_LIST;
2291 v->di_tv.v_lock = VAR_FIXED;
2292 v->di_tv.vval.v_list = &fc->l_varlist;
2293 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002294 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2296 fc->l_varlist.lv_lock = VAR_FIXED;
2297
2298 /*
2299 * Set a:firstline to "firstline" and a:lastline to "lastline".
2300 * Set a:name to named arguments.
2301 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002302 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002303 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002304 if ((fp->uf_flags & FC_NOARGS) == 0)
2305 {
2306 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002307 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002308 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002309 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002310 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002311 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002312 {
2313 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002314 typval_T def_rettv;
2315 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002316
2317 ai = i - fp->uf_args.ga_len;
2318 if (ai < 0)
2319 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002320 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002321 name = FUNCARG(fp, i);
2322 if (islambda)
2323 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002324
2325 // evaluate named argument default expression
2326 isdefault = ai + fp->uf_def_args.ga_len >= 0
2327 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2328 && argvars[i].vval.v_number == VVAL_NONE));
2329 if (isdefault)
2330 {
2331 char_u *default_expr = NULL;
2332 def_rettv.v_type = VAR_NUMBER;
2333 def_rettv.vval.v_number = -1;
2334
2335 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2336 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002337 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002338 {
2339 default_arg_err = 1;
2340 break;
2341 }
2342 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 }
2344 else
2345 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002346 if ((fp->uf_flags & FC_NOARGS) != 0)
2347 // Bail out if no a: arguments used (in lambda).
2348 break;
2349
Bram Moolenaare38eab22019-12-05 21:50:01 +01002350 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351 sprintf((char *)numbuf, "%d", ai + 1);
2352 name = numbuf;
2353 }
2354 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2355 {
2356 v = &fc->fixvar[fixvar_idx++].var;
2357 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002358 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359 }
2360 else
2361 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002362 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 if (v == NULL)
2364 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002365 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002366 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002368 // Note: the values are copied directly to avoid alloc/free.
2369 // "argvars" must have VAR_FIXED for v_lock.
2370 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 v->di_tv.v_lock = VAR_FIXED;
2372
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 if (addlocal)
2374 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002375 // Named arguments should be accessed without the "a:" prefix in
2376 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002377 copy_tv(&v->di_tv, &v->di_tv);
2378 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002380 else
2381 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382
2383 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2384 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002385 listitem_T *li = &fc->l_listitems[ai];
2386
2387 li->li_tv = argvars[i];
2388 li->li_tv.v_lock = VAR_FIXED;
2389 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390 }
2391 }
2392
Bram Moolenaare38eab22019-12-05 21:50:01 +01002393 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002395
2396 if (fp->uf_flags & FC_SANDBOX)
2397 {
2398 using_sandbox = TRUE;
2399 ++sandbox;
2400 }
2401
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002402 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002403 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002404 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002406 ++no_wait_return;
2407 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002408
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002409 smsg(_("calling %s"), SOURCING_NAME);
2410 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002412 char_u buf[MSG_BUF_LEN];
2413 char_u numbuf2[NUMBUFLEN];
2414 char_u *tofree;
2415 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002417 msg_puts("(");
2418 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002419 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002420 if (i > 0)
2421 msg_puts(", ");
2422 if (argvars[i].v_type == VAR_NUMBER)
2423 msg_outnum((long)argvars[i].vval.v_number);
2424 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002426 // Do not want errors such as E724 here.
2427 ++emsg_off;
2428 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2429 --emsg_off;
2430 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002431 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002432 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002433 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002434 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2435 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002436 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002437 msg_puts((char *)s);
2438 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002439 }
2440 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002441 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002442 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002444 msg_puts("\n"); // don't overwrite this either
2445
2446 verbose_leave_scroll();
2447 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 }
2449#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002450 if (do_profiling == PROF_YES)
2451 profile_may_start_func(&profile_info, fp,
2452 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002453#endif
2454
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002455 save_current_sctx = current_sctx;
2456 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 save_did_emsg = did_emsg;
2458 did_emsg = FALSE;
2459
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002460 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2461 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002462 else if (islambda)
2463 {
2464 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2465
2466 // A Lambda always has the command "return {expr}". It is much faster
2467 // to evaluate {expr} directly.
2468 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002469 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002470 --ex_nesting_level;
2471 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002472 else
2473 // call do_cmdline() to execute the lines
2474 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2476
2477 --RedrawingDisabled;
2478
Bram Moolenaare38eab22019-12-05 21:50:01 +01002479 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002480 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2481 {
2482 clear_tv(rettv);
2483 rettv->v_type = VAR_NUMBER;
2484 rettv->vval.v_number = -1;
2485 }
2486
2487#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002488 if (do_profiling == PROF_YES)
2489 {
2490 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2491
2492 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2493 profile_may_end_func(&profile_info, fp, caller);
2494 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495#endif
2496
Bram Moolenaare38eab22019-12-05 21:50:01 +01002497 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498 if (p_verbose >= 12)
2499 {
2500 ++no_wait_return;
2501 verbose_enter_scroll();
2502
2503 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002504 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002505 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002506 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507 (long)fc->rettv->vval.v_number);
2508 else
2509 {
2510 char_u buf[MSG_BUF_LEN];
2511 char_u numbuf2[NUMBUFLEN];
2512 char_u *tofree;
2513 char_u *s;
2514
Bram Moolenaare38eab22019-12-05 21:50:01 +01002515 // The value may be very long. Skip the middle part, so that we
2516 // have some idea how it starts and ends. smsg() would always
2517 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 ++emsg_off;
2519 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2520 --emsg_off;
2521 if (s != NULL)
2522 {
2523 if (vim_strsize(s) > MSG_BUF_CLEN)
2524 {
2525 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2526 s = buf;
2527 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002528 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529 vim_free(tofree);
2530 }
2531 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002532 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002533
2534 verbose_leave_scroll();
2535 --no_wait_return;
2536 }
2537
Bram Moolenaare31ee862020-01-07 20:59:34 +01002538 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002539 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002540 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002541#ifdef FEAT_PROFILE
2542 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002543 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002544#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002545 if (using_sandbox)
2546 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002547
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002548 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002549 {
2550 ++no_wait_return;
2551 verbose_enter_scroll();
2552
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002553 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002554 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002555
2556 verbose_leave_scroll();
2557 --no_wait_return;
2558 }
2559
2560 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002561 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002562 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002563}
2564
2565/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002566 * Check the argument count for user function "fp".
2567 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2568 */
2569 int
2570check_user_func_argcount(ufunc_T *fp, int argcount)
2571{
2572 int regular_args = fp->uf_args.ga_len;
2573
2574 if (argcount < regular_args - fp->uf_def_args.ga_len)
2575 return FCERR_TOOFEW;
2576 else if (!has_varargs(fp) && argcount > regular_args)
2577 return FCERR_TOOMANY;
2578 return FCERR_UNKNOWN;
2579}
2580
2581/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002582 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002583 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002584 int
2585call_user_func_check(
2586 ufunc_T *fp,
2587 int argcount,
2588 typval_T *argvars,
2589 typval_T *rettv,
2590 funcexe_T *funcexe,
2591 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002592{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002593 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002594
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2596 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002597 error = check_user_func_argcount(fp, argcount);
2598 if (error != FCERR_UNKNOWN)
2599 return error;
2600 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002601 error = FCERR_DICT;
2602 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002603 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002604 int did_save_redo = FALSE;
2605 save_redo_T save_redo;
2606
2607 /*
2608 * Call the user function.
2609 * Save and restore search patterns, script variables and
2610 * redo buffer.
2611 */
2612 save_search_patterns();
2613 if (!ins_compl_active())
2614 {
2615 saveRedobuff(&save_redo);
2616 did_save_redo = TRUE;
2617 }
2618 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002619 call_user_func(fp, argcount, argvars, rettv, funcexe,
2620 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002621 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2622 // Function was unreferenced while being used, free it now.
2623 func_clear_free(fp, FALSE);
2624 if (did_save_redo)
2625 restoreRedobuff(&save_redo);
2626 restore_search_patterns();
2627 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002628 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002629 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002630}
2631
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002632static funccal_entry_T *funccal_stack = NULL;
2633
2634/*
2635 * Save the current function call pointer, and set it to NULL.
2636 * Used when executing autocommands and for ":source".
2637 */
2638 void
2639save_funccal(funccal_entry_T *entry)
2640{
2641 entry->top_funccal = current_funccal;
2642 entry->next = funccal_stack;
2643 funccal_stack = entry;
2644 current_funccal = NULL;
2645}
2646
2647 void
2648restore_funccal(void)
2649{
2650 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002651 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002652 else
2653 {
2654 current_funccal = funccal_stack->top_funccal;
2655 funccal_stack = funccal_stack->next;
2656 }
2657}
2658
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002659 funccall_T *
2660get_current_funccal(void)
2661{
2662 return current_funccal;
2663}
2664
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002665/*
2666 * Mark all functions of script "sid" as deleted.
2667 */
2668 void
2669delete_script_functions(int sid)
2670{
2671 hashitem_T *hi;
2672 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002673 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002674 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002675 size_t len;
2676
2677 buf[0] = K_SPECIAL;
2678 buf[1] = KS_EXTRA;
2679 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002680 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002681 len = STRLEN(buf);
2682
Bram Moolenaarce658352020-07-31 23:47:12 +02002683 while (todo > 0)
2684 {
2685 todo = func_hashtab.ht_used;
2686 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2687 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002688 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002689 fp = HI2UF(hi);
2690 if (STRNCMP(fp->uf_name, buf, len) == 0)
2691 {
2692 int changed = func_hashtab.ht_changed;
2693
2694 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002695
2696 if (fp->uf_calls > 0)
2697 {
2698 // Function is executing, don't free it but do remove
2699 // it from the hashtable.
2700 if (func_remove(fp))
2701 fp->uf_refcount--;
2702 }
2703 else
2704 {
2705 func_clear(fp, TRUE);
2706 // When clearing a function another function can be
2707 // cleared as a side effect. When that happens start
2708 // over.
2709 if (changed != func_hashtab.ht_changed)
2710 break;
2711 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002712 }
2713 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002714 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002715 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002716}
2717
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718#if defined(EXITFREE) || defined(PROTO)
2719 void
2720free_all_functions(void)
2721{
2722 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002723 ufunc_T *fp;
2724 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002725 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002726 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727
Bram Moolenaare38eab22019-12-05 21:50:01 +01002728 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002729 while (current_funccal != NULL)
2730 {
2731 clear_tv(current_funccal->rettv);
2732 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002733 if (current_funccal == NULL && funccal_stack != NULL)
2734 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002735 }
2736
Bram Moolenaare38eab22019-12-05 21:50:01 +01002737 // First clear what the functions contain. Since this may lower the
2738 // reference count of a function, it may also free a function and change
2739 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002740 while (todo > 0)
2741 {
2742 todo = func_hashtab.ht_used;
2743 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2744 if (!HASHITEM_EMPTY(hi))
2745 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002746 // clear the def function index now
2747 fp = HI2UF(hi);
2748 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002749 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002750
Bram Moolenaare38eab22019-12-05 21:50:01 +01002751 // Only free functions that are not refcounted, those are
2752 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002753 if (func_name_refcount(fp->uf_name))
2754 ++skipped;
2755 else
2756 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002757 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002758 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002759 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002760 {
2761 skipped = 0;
2762 break;
2763 }
2764 }
2765 --todo;
2766 }
2767 }
2768
Bram Moolenaare38eab22019-12-05 21:50:01 +01002769 // Now actually free the functions. Need to start all over every time,
2770 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002771 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002772 while (func_hashtab.ht_used > skipped)
2773 {
2774 todo = func_hashtab.ht_used;
2775 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002776 if (!HASHITEM_EMPTY(hi))
2777 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002778 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002779 // Only free functions that are not refcounted, those are
2780 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002781 fp = HI2UF(hi);
2782 if (func_name_refcount(fp->uf_name))
2783 ++skipped;
2784 else
2785 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002786 if (func_free(fp, FALSE) == OK)
2787 {
2788 skipped = 0;
2789 break;
2790 }
2791 // did not actually free it
2792 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002793 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002794 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002795 }
2796 if (skipped == 0)
2797 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002798
2799 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800}
2801#endif
2802
2803/*
2804 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002805 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 * "len" is the length of "name", or -1 for NUL terminated.
2807 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002808 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809builtin_function(char_u *name, int len)
2810{
2811 char_u *p;
2812
Bram Moolenaara26b9702020-04-18 19:53:28 +02002813 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 return FALSE;
2815 p = vim_strchr(name, AUTOLOAD_CHAR);
2816 return p == NULL || (len > 0 && p > name + len);
2817}
2818
2819 int
2820func_call(
2821 char_u *name,
2822 typval_T *args,
2823 partial_T *partial,
2824 dict_T *selfdict,
2825 typval_T *rettv)
2826{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002827 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828 listitem_T *item;
2829 typval_T argv[MAX_FUNC_ARGS + 1];
2830 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831 int r = 0;
2832
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002833 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002834 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 {
2836 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2837 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002838 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839 break;
2840 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002841 // Make a copy of each argument. This is needed to be able to set
2842 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 copy_tv(&item->li_tv, &argv[argc++]);
2844 }
2845
2846 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002847 {
2848 funcexe_T funcexe;
2849
Bram Moolenaara80faa82020-04-12 19:37:17 +02002850 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002851 funcexe.firstline = curwin->w_cursor.lnum;
2852 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002853 funcexe.evaluate = TRUE;
2854 funcexe.partial = partial;
2855 funcexe.selfdict = selfdict;
2856 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2857 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858
Bram Moolenaare38eab22019-12-05 21:50:01 +01002859 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002860 while (argc > 0)
2861 clear_tv(&argv[--argc]);
2862
2863 return r;
2864}
2865
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002866static int callback_depth = 0;
2867
2868 int
2869get_callback_depth(void)
2870{
2871 return callback_depth;
2872}
2873
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002875 * Invoke call_func() with a callback.
2876 */
2877 int
2878call_callback(
2879 callback_T *callback,
2880 int len, // length of "name" or -1 to use strlen()
2881 typval_T *rettv, // return value goes here
2882 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002883 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002884 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002885{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002886 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002887 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002888
Bram Moolenaara80faa82020-04-12 19:37:17 +02002889 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002890 funcexe.evaluate = TRUE;
2891 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002892 ++callback_depth;
2893 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2894 --callback_depth;
2895 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002896}
2897
2898/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002899 * Give an error message for the result of a function.
2900 * Nothing if "error" is FCERR_NONE.
2901 */
2902 void
2903user_func_error(int error, char_u *name)
2904{
2905 switch (error)
2906 {
2907 case FCERR_UNKNOWN:
2908 emsg_funcname(e_unknownfunc, name);
2909 break;
2910 case FCERR_NOTMETHOD:
2911 emsg_funcname(
2912 N_("E276: Cannot use function as a method: %s"), name);
2913 break;
2914 case FCERR_DELETED:
2915 emsg_funcname(N_(e_func_deleted), name);
2916 break;
2917 case FCERR_TOOMANY:
2918 emsg_funcname((char *)e_toomanyarg, name);
2919 break;
2920 case FCERR_TOOFEW:
2921 emsg_funcname((char *)e_toofewarg, name);
2922 break;
2923 case FCERR_SCRIPT:
2924 emsg_funcname(
2925 N_("E120: Using <SID> not in a script context: %s"), name);
2926 break;
2927 case FCERR_DICT:
2928 emsg_funcname(
2929 N_("E725: Calling dict function without Dictionary: %s"),
2930 name);
2931 break;
2932 }
2933}
2934
2935/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002937 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 * Return FAIL when the function can't be called, OK otherwise.
2939 * Also returns OK when an error was encountered while executing the function.
2940 */
2941 int
2942call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002943 char_u *funcname, // name of the function
2944 int len, // length of "name" or -1 to use strlen()
2945 typval_T *rettv, // return value goes here
2946 int argcount_in, // number of "argvars"
2947 typval_T *argvars_in, // vars for arguments, must have "argcount"
2948 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002949 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950{
2951 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002952 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002954 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955 char_u fname_buf[FLEN_FIXED + 1];
2956 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002957 char_u *fname = NULL;
2958 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002959 int argcount = argcount_in;
2960 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002961 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002962 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2963 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002965 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002966 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002968 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2969 // even when call_func() returns FAIL.
2970 rettv->v_type = VAR_UNKNOWN;
2971
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002972 if (partial != NULL)
2973 fp = partial->pt_func;
2974 if (fp == NULL)
2975 {
2976 // Make a copy of the name, if it comes from a funcref variable it
2977 // could be changed or deleted in the called function.
2978 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2979 if (name == NULL)
2980 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002981
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002982 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2983 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002985 if (funcexe->doesrange != NULL)
2986 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002987
2988 if (partial != NULL)
2989 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002990 // When the function has a partial with a dict and there is a dict
2991 // argument, use the dict argument. That is backwards compatible.
2992 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002993 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002995 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002996 {
2997 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002998 {
2999 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3000 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003001 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003002 goto theend;
3003 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003005 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 for (i = 0; i < argcount_in; ++i)
3007 argv[i + argv_clear] = argvars_in[i];
3008 argvars = argv;
3009 argcount = partial->pt_argc + argcount_in;
3010 }
3011 }
3012
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003013 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3014 {
3015 // Check that the argument types are OK for the types of the funcref.
3016 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003017 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003018 error = FCERR_OTHER;
3019 }
3020
Bram Moolenaaref140542019-12-31 21:27:13 +01003021 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 {
3023 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003024 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025
Bram Moolenaar333894b2020-08-01 18:53:07 +02003026 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003027 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003028 {
3029 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003031 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003032
Bram Moolenaare38eab22019-12-05 21:50:01 +01003033 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003034 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003035 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003036
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003037 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038 {
3039 /*
3040 * User defined function.
3041 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003042 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003043 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003044
Bram Moolenaare38eab22019-12-05 21:50:01 +01003045 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046 if (fp == NULL
3047 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003048 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 && !aborting())
3050 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003051 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003052 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003053 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003054 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3056 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003057 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003058 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003059 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003060 if (fp == NULL)
3061 {
3062 char_u *p = untrans_function_name(rfname);
3063
3064 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003065 // Don't do this if the name starts with "s:".
3066 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003067 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003068 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003069
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003070 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003071 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003072#ifdef FEAT_LUA
3073 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3074 {
3075 cfunc_T cb = fp->uf_cb;
3076
3077 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3078 }
3079#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003080 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003081 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003082 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003083 // postponed filling in the arguments, do it now
3084 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003085 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003086
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003087 if (funcexe->basetv != NULL)
3088 {
3089 // Method call: base->Method()
3090 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3091 argv[0] = *funcexe->basetv;
3092 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003093 argvars = argv;
3094 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003095 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003096
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003097 error = call_user_func_check(fp, argcount, argvars, rettv,
3098 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 }
3100 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003101 else if (funcexe->basetv != NULL)
3102 {
3103 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003104 * expr->method(): Find the method name in the table, call its
3105 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003106 */
3107 error = call_internal_method(fname, argcount, argvars, rettv,
3108 funcexe->basetv);
3109 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003110 else
3111 {
3112 /*
3113 * Find the function name in the table, call its implementation.
3114 */
3115 error = call_internal_func(fname, argcount, argvars, rettv);
3116 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003117
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118 /*
3119 * The function call (or "FuncUndefined" autocommand sequence) might
3120 * have been aborted by an error, an interrupt, or an explicitly thrown
3121 * exception that has not been caught so far. This situation can be
3122 * tested for by calling aborting(). For an error in an internal
3123 * function or for the "E132" error in call_user_func(), however, the
3124 * throw point at which the "force_abort" flag (temporarily reset by
3125 * emsg()) is normally updated has not been reached yet. We need to
3126 * update that flag first to make aborting() reliable.
3127 */
3128 update_force_abort();
3129 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003130 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003131 ret = OK;
3132
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003133theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003134 /*
3135 * Report an error unless the argument evaluation or function call has been
3136 * cancelled due to an aborting error, an interrupt, or an exception.
3137 */
3138 if (!aborting())
3139 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003140 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003141 }
3142
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003143 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003145 clear_tv(&argv[--argv_clear + argv_base]);
3146
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003147 vim_free(tofree);
3148 vim_free(name);
3149
3150 return ret;
3151}
3152
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003153 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003154printable_func_name(ufunc_T *fp)
3155{
3156 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3157}
3158
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003160 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003161 */
3162 static void
3163list_func_head(ufunc_T *fp, int indent)
3164{
3165 int j;
3166
3167 msg_start();
3168 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003169 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003170 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003171 msg_puts("def ");
3172 else
3173 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003174 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 msg_putchar('(');
3176 for (j = 0; j < fp->uf_args.ga_len; ++j)
3177 {
3178 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003179 msg_puts(", ");
3180 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003181 if (fp->uf_arg_types != NULL)
3182 {
3183 char *tofree;
3184
3185 msg_puts(": ");
3186 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3187 vim_free(tofree);
3188 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003189 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3190 {
3191 msg_puts(" = ");
3192 msg_puts(((char **)(fp->uf_def_args.ga_data))
3193 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3194 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003195 }
3196 if (fp->uf_varargs)
3197 {
3198 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003199 msg_puts(", ");
3200 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 if (fp->uf_va_name != NULL)
3203 {
3204 if (j)
3205 msg_puts(", ");
3206 msg_puts("...");
3207 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003208 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003209 {
3210 char *tofree;
3211
3212 msg_puts(": ");
3213 msg_puts(type_name(fp->uf_va_type, &tofree));
3214 vim_free(tofree);
3215 }
3216 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003218
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003219 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003220 {
3221 if (fp->uf_ret_type != &t_void)
3222 {
3223 char *tofree;
3224
3225 msg_puts(": ");
3226 msg_puts(type_name(fp->uf_ret_type, &tofree));
3227 vim_free(tofree);
3228 }
3229 }
3230 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003231 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003232 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003233 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003235 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003236 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003237 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003238 msg_clr_eos();
3239 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003240 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241}
3242
3243/*
3244 * Get a function name, translating "<SID>" and "<SNR>".
3245 * Also handles a Funcref in a List or Dictionary.
3246 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003247 * Set "*is_global" to TRUE when the function must be global, unless
3248 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003249 * flags:
3250 * TFN_INT: internal function name OK
3251 * TFN_QUIET: be quiet
3252 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003253 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254 * Advances "pp" to just after the function name (if no error).
3255 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003256 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003257trans_function_name(
3258 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003259 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003260 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003262 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003263 partial_T **partial, // return: partial of a FuncRef
3264 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003265{
3266 char_u *name = NULL;
3267 char_u *start;
3268 char_u *end;
3269 int lead;
3270 char_u sid_buf[20];
3271 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003272 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003275 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276
3277 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003278 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003279 start = *pp;
3280
Bram Moolenaare38eab22019-12-05 21:50:01 +01003281 // Check for hard coded <SNR>: already translated function ID (from a user
3282 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003283 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3284 && (*pp)[2] == (int)KE_SNR)
3285 {
3286 *pp += 3;
3287 len = get_id_len(pp) + 3;
3288 return vim_strnsave(start, len);
3289 }
3290
Bram Moolenaare38eab22019-12-05 21:50:01 +01003291 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3292 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003293 lead = eval_fname_script(start);
3294 if (lead > 2)
3295 start += lead;
3296
Bram Moolenaare38eab22019-12-05 21:50:01 +01003297 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003298 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299 lead > 2 ? 0 : FNE_CHECK_START);
3300 if (end == start)
3301 {
3302 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003303 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003304 goto theend;
3305 }
3306 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3307 {
3308 /*
3309 * Report an invalid expression in braces, unless the expression
3310 * evaluation has been cancelled due to an aborting error, an
3311 * interrupt, or an exception.
3312 */
3313 if (!aborting())
3314 {
3315 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003316 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003317 }
3318 else
3319 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3320 goto theend;
3321 }
3322
3323 if (lv.ll_tv != NULL)
3324 {
3325 if (fdp != NULL)
3326 {
3327 fdp->fd_dict = lv.ll_dict;
3328 fdp->fd_newkey = lv.ll_newkey;
3329 lv.ll_newkey = NULL;
3330 fdp->fd_di = lv.ll_di;
3331 }
3332 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3333 {
3334 name = vim_strsave(lv.ll_tv->vval.v_string);
3335 *pp = end;
3336 }
3337 else if (lv.ll_tv->v_type == VAR_PARTIAL
3338 && lv.ll_tv->vval.v_partial != NULL)
3339 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003340 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 *pp = end;
3342 if (partial != NULL)
3343 *partial = lv.ll_tv->vval.v_partial;
3344 }
3345 else
3346 {
3347 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3348 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003349 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 else
3351 *pp = end;
3352 name = NULL;
3353 }
3354 goto theend;
3355 }
3356
3357 if (lv.ll_name == NULL)
3358 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003359 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003360 *pp = end;
3361 goto theend;
3362 }
3363
Bram Moolenaare38eab22019-12-05 21:50:01 +01003364 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365 if (lv.ll_exp_name != NULL)
3366 {
3367 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003368 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369 flags & TFN_NO_AUTOLOAD);
3370 if (name == lv.ll_exp_name)
3371 name = NULL;
3372 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003373 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003374 {
3375 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003376 name = deref_func_name(*pp, &len, partial, type,
3377 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 if (name == *pp)
3379 name = NULL;
3380 }
3381 if (name != NULL)
3382 {
3383 name = vim_strsave(name);
3384 *pp = end;
3385 if (STRNCMP(name, "<SNR>", 5) == 0)
3386 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003387 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003388 name[0] = K_SPECIAL;
3389 name[1] = KS_EXTRA;
3390 name[2] = (int)KE_SNR;
3391 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3392 }
3393 goto theend;
3394 }
3395
3396 if (lv.ll_exp_name != NULL)
3397 {
3398 len = (int)STRLEN(lv.ll_exp_name);
3399 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3400 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3401 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003402 // When there was "s:" already or the name expanded to get a
3403 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003404 lv.ll_name += 2;
3405 len -= 2;
3406 lead = 2;
3407 }
3408 }
3409 else
3410 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003411 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003412 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003413 {
3414 if (is_global != NULL && lv.ll_name[0] == 'g')
3415 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003417 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003418 len = (int)(end - lv.ll_name);
3419 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003420 if (len <= 0)
3421 {
3422 if (!skip)
3423 emsg(_(e_function_name));
3424 goto theend;
3425 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003427 // In Vim9 script a user function is script-local by default, unless it
3428 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003429 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003430 if (vim9script)
3431 {
3432 char_u *p;
3433
3434 // SomeScript#func() is a global function.
3435 for (p = start; *p != NUL && *p != '('; ++p)
3436 if (*p == AUTOLOAD_CHAR)
3437 vim9script = FALSE;
3438 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003439
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 /*
3441 * Copy the function name to allocated memory.
3442 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3443 * Accept <SNR>123_name() outside a script.
3444 */
3445 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003446 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003447 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003449 if (!vim9script)
3450 lead = 3;
3451 if (vim9script || (lv.ll_exp_name != NULL
3452 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003453 || eval_fname_sid(*pp))
3454 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003455 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003456 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003458 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003459 goto theend;
3460 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003461 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 if (vim9script)
3463 extra = 3 + (int)STRLEN(sid_buf);
3464 else
3465 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 }
3467 }
3468 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3469 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003470 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 start);
3472 goto theend;
3473 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003474 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 {
3476 char_u *cp = vim_strchr(lv.ll_name, ':');
3477
3478 if (cp != NULL && cp < end)
3479 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003480 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003481 goto theend;
3482 }
3483 }
3484
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003485 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 if (name != NULL)
3487 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003488 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003489 {
3490 name[0] = K_SPECIAL;
3491 name[1] = KS_EXTRA;
3492 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003493 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003494 STRCPY(name + 3, sid_buf);
3495 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003496 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3497 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 }
3499 *pp = end;
3500
3501theend:
3502 clear_lval(&lv);
3503 return name;
3504}
3505
3506/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003507 * Assuming "name" is the result of trans_function_name() and it was prefixed
3508 * to use the script-local name, return the unmodified name (points into
3509 * "name"). Otherwise return NULL.
3510 * This can be used to first search for a script-local function and fall back
3511 * to the global function if not found.
3512 */
3513 char_u *
3514untrans_function_name(char_u *name)
3515{
3516 char_u *p;
3517
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003518 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003519 {
3520 p = vim_strchr(name, '_');
3521 if (p != NULL)
3522 return p + 1;
3523 }
3524 return NULL;
3525}
3526
3527/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003528 * List functions. When "regmatch" is NULL all of then.
3529 * Otherwise functions matching "regmatch".
3530 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003531 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003532list_functions(regmatch_T *regmatch)
3533{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003534 int changed = func_hashtab.ht_changed;
3535 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003536 hashitem_T *hi;
3537
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003538 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003539 {
3540 if (!HASHITEM_EMPTY(hi))
3541 {
3542 ufunc_T *fp = HI2UF(hi);
3543
3544 --todo;
3545 if ((fp->uf_flags & FC_DEAD) == 0
3546 && (regmatch == NULL
3547 ? !message_filtered(fp->uf_name)
3548 && !func_name_refcount(fp->uf_name)
3549 : !isdigit(*fp->uf_name)
3550 && vim_regexec(regmatch, fp->uf_name, 0)))
3551 {
3552 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003553 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003554 {
3555 emsg(_("E454: function list was modified"));
3556 return;
3557 }
3558 }
3559 }
3560 }
3561}
3562
3563/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003564 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003565 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3566 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003567 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003569 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003570define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003571{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003572 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 int j;
3574 int c;
3575 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003576 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003577 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 char_u *p;
3579 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003580 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 char_u *line_arg = NULL;
3582 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003583 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003584 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 garray_T newlines;
3586 int varargs = FALSE;
3587 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003588 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003589 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003590 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 dictitem_T *v;
3592 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003593 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003596 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003597 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003598 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599
3600 /*
3601 * ":function" without argument: list functions.
3602 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003603 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 {
3605 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003606 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003608 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003609 }
3610
3611 /*
3612 * ":function /pat": list functions matching pattern.
3613 */
3614 if (*eap->arg == '/')
3615 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003616 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617 if (!eap->skip)
3618 {
3619 regmatch_T regmatch;
3620
3621 c = *p;
3622 *p = NUL;
3623 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3624 *p = c;
3625 if (regmatch.regprog != NULL)
3626 {
3627 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003628 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 vim_regfree(regmatch.regprog);
3630 }
3631 }
3632 if (*p == '/')
3633 ++p;
3634 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003635 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 }
3637
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003638 ga_init(&newargs);
3639 ga_init(&argtypes);
3640 ga_init(&default_args);
3641
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642 /*
3643 * Get the function name. There are these situations:
3644 * func normal function name
3645 * "name" == func, "fudi.fd_dict" == NULL
3646 * dict.func new dictionary entry
3647 * "name" == NULL, "fudi.fd_dict" set,
3648 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3649 * dict.func existing dict entry with a Funcref
3650 * "name" == func, "fudi.fd_dict" set,
3651 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3652 * dict.func existing dict entry that's not a Funcref
3653 * "name" == NULL, "fudi.fd_dict" set,
3654 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3655 * s:func script-local function name
3656 * g:func global function name, same as "func"
3657 */
3658 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003659 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003661 // nested function, argument is (args).
3662 paren = TRUE;
3663 CLEAR_FIELD(fudi);
3664 }
3665 else
3666 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003667 if (STRNCMP(p, "<lambda>", 8) == 0)
3668 {
3669 p += 8;
3670 (void)getdigits(&p);
3671 name = vim_strnsave(eap->arg, p - eap->arg);
3672 CLEAR_FIELD(fudi);
3673 }
3674 else
3675 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003676 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003677 paren = (vim_strchr(p, '(') != NULL);
3678 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003680 /*
3681 * Return on an invalid expression in braces, unless the expression
3682 * evaluation has been cancelled due to an aborting error, an
3683 * interrupt, or an exception.
3684 */
3685 if (!aborting())
3686 {
3687 if (!eap->skip && fudi.fd_newkey != NULL)
3688 semsg(_(e_dictkey), fudi.fd_newkey);
3689 vim_free(fudi.fd_newkey);
3690 return NULL;
3691 }
3692 else
3693 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003694 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003695 }
3696
Bram Moolenaare38eab22019-12-05 21:50:01 +01003697 // An error in a function call during evaluation of an expression in magic
3698 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 saved_did_emsg = did_emsg;
3700 did_emsg = FALSE;
3701
3702 /*
3703 * ":function func" with only function name: list function.
3704 */
3705 if (!paren)
3706 {
3707 if (!ends_excmd(*skipwhite(p)))
3708 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003709 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 goto ret_free;
3711 }
3712 eap->nextcmd = check_nextcmd(p);
3713 if (eap->nextcmd != NULL)
3714 *p = NUL;
3715 if (!eap->skip && !got_int)
3716 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003717 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003718 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3719 {
3720 char_u *up = untrans_function_name(name);
3721
3722 // With Vim9 script the name was made script-local, if not
3723 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003724 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003725 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003726 }
3727
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003728 if (fp != NULL)
3729 {
3730 list_func_head(fp, TRUE);
3731 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3732 {
3733 if (FUNCLINE(fp, j) == NULL)
3734 continue;
3735 msg_putchar('\n');
3736 msg_outnum((long)(j + 1));
3737 if (j < 9)
3738 msg_putchar(' ');
3739 if (j < 99)
3740 msg_putchar(' ');
3741 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003742 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 ui_breakcheck();
3744 }
3745 if (!got_int)
3746 {
3747 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003748 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003749 msg_puts(" enddef");
3750 else
3751 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752 }
3753 }
3754 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003755 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003756 }
3757 goto ret_free;
3758 }
3759
3760 /*
3761 * ":function name(arg1, arg2)" Define function.
3762 */
3763 p = skipwhite(p);
3764 if (*p != '(')
3765 {
3766 if (!eap->skip)
3767 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003768 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 goto ret_free;
3770 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003771 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 if (vim_strchr(p, '(') != NULL)
3773 p = vim_strchr(p, '(');
3774 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003775
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003776 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3777 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003778 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003779 goto ret_free;
3780 }
3781
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003782 // In Vim9 script only global functions can be redefined.
3783 if (vim9script && eap->forceit && !is_global)
3784 {
3785 emsg(_(e_nobang));
3786 goto ret_free;
3787 }
3788
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003789 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790
Bram Moolenaar04b12692020-05-04 23:24:44 +02003791 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003793 // Check the name of the function. Unless it's a dictionary function
3794 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 if (name != NULL)
3796 arg = name;
3797 else
3798 arg = fudi.fd_newkey;
3799 if (arg != NULL && (fudi.fd_di == NULL
3800 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3801 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3802 {
3803 if (*arg == K_SPECIAL)
3804 j = 3;
3805 else
3806 j = 0;
3807 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3808 : eval_isnamec(arg[j])))
3809 ++j;
3810 if (arg[j] != NUL)
3811 emsg_funcname((char *)e_invarg2, arg);
3812 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003813 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003815 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 }
3817
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003818 // This may get more lines and make the pointers into the first line
3819 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003820 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003821 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003822 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003823 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003824 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003826 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003828 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003830 // find the return type: :def Func(): type
3831 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003833 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003834 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003835 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003836 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003837 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003838 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003839 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003840 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003842 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003843 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003844 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003845 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003847 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003849 else
3850 // find extra arguments "range", "dict", "abort" and "closure"
3851 for (;;)
3852 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003853 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003854 p = skipwhite(p);
3855 if (STRNCMP(p, "range", 5) == 0)
3856 {
3857 flags |= FC_RANGE;
3858 p += 5;
3859 }
3860 else if (STRNCMP(p, "dict", 4) == 0)
3861 {
3862 flags |= FC_DICT;
3863 p += 4;
3864 }
3865 else if (STRNCMP(p, "abort", 5) == 0)
3866 {
3867 flags |= FC_ABORT;
3868 p += 5;
3869 }
3870 else if (STRNCMP(p, "closure", 7) == 0)
3871 {
3872 flags |= FC_CLOSURE;
3873 p += 7;
3874 if (current_funccal == NULL)
3875 {
3876 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3877 name == NULL ? (char_u *)"" : name);
3878 goto erret;
3879 }
3880 }
3881 else
3882 break;
3883 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003884
Bram Moolenaare38eab22019-12-05 21:50:01 +01003885 // When there is a line break use what follows for the function body.
3886 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 if (*p == '\n')
3888 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003889 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003890 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3891 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003892 && !(VIM_ISWHITE(*whitep) && *p == '#'
3893 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003894 && !eap->skip
3895 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003896 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003897
3898 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003899 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3900 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003901 */
3902 if (KeyTyped)
3903 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003904 // Check if the function already exists, don't let the user type the
3905 // whole function before telling him it doesn't work! For a script we
3906 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003907 if (!eap->skip && !eap->forceit)
3908 {
3909 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003910 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003911 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003912 emsg_funcname(e_funcexts, name);
3913 }
3914
3915 if (!eap->skip && did_emsg)
3916 goto erret;
3917
Bram Moolenaare38eab22019-12-05 21:50:01 +01003918 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 cmdline_row = msg_row;
3920 }
3921
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003922 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003923 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003924
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003925 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003926 goto erret;
3927
3928 /*
3929 * If there are no errors, add the function
3930 */
3931 if (fudi.fd_dict == NULL)
3932 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003933 hashtab_T *ht;
3934
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003935 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3937 {
3938 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3939 name);
3940 goto erret;
3941 }
3942
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003943 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003944 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003945 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003946 char_u *uname = untrans_function_name(name);
3947
3948 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3949 }
3950
3951 if (fp != NULL || import != NULL)
3952 {
3953 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003954
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003955 // Function can be replaced with "function!" and when sourcing the
3956 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003957 // A name that is used by an import can not be overruled.
3958 if (import != NULL
3959 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003960 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003961 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003962 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003963 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003964 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003965 else
3966 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003967 goto erret;
3968 }
3969 if (fp->uf_calls > 0)
3970 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003971 emsg_funcname(
3972 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003973 name);
3974 goto erret;
3975 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003976 if (fp->uf_refcount > 1)
3977 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003978 // This function is referenced somewhere, don't redefine it but
3979 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003980 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003981 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003982 fp = NULL;
3983 overwrite = TRUE;
3984 }
3985 else
3986 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003987 char_u *exp_name = fp->uf_name_exp;
3988
3989 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003990 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003991 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003992 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003993 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003994 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003995#ifdef FEAT_PROFILE
3996 fp->uf_profiling = FALSE;
3997 fp->uf_prof_initialized = FALSE;
3998#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003999 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004000 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004001 }
4002 }
4003 else
4004 {
4005 char numbuf[20];
4006
4007 fp = NULL;
4008 if (fudi.fd_newkey == NULL && !eap->forceit)
4009 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004010 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 goto erret;
4012 }
4013 if (fudi.fd_di == NULL)
4014 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004015 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004016 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 goto erret;
4018 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004019 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004020 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 goto erret;
4022
Bram Moolenaare38eab22019-12-05 21:50:01 +01004023 // Give the function a sequential number. Can only be used with a
4024 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 vim_free(name);
4026 sprintf(numbuf, "%d", ++func_nr);
4027 name = vim_strsave((char_u *)numbuf);
4028 if (name == NULL)
4029 goto erret;
4030 }
4031
4032 if (fp == NULL)
4033 {
4034 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4035 {
4036 int slen, plen;
4037 char_u *scriptname;
4038
Bram Moolenaare38eab22019-12-05 21:50:01 +01004039 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004041 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004042 {
4043 scriptname = autoload_name(name);
4044 if (scriptname != NULL)
4045 {
4046 p = vim_strchr(scriptname, '/');
4047 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004048 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004049 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004050 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 j = OK;
4052 vim_free(scriptname);
4053 }
4054 }
4055 if (j == FAIL)
4056 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004057 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 goto erret;
4059 }
4060 }
4061
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004062 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004063 if (fp == NULL)
4064 goto erret;
4065
4066 if (fudi.fd_dict != NULL)
4067 {
4068 if (fudi.fd_di == NULL)
4069 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004070 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4072 if (fudi.fd_di == NULL)
4073 {
4074 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004075 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 goto erret;
4077 }
4078 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4079 {
4080 vim_free(fudi.fd_di);
4081 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004082 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004083 goto erret;
4084 }
4085 }
4086 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004087 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088 clear_tv(&fudi.fd_di->di_tv);
4089 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004090 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091
Bram Moolenaare38eab22019-12-05 21:50:01 +01004092 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 flags |= FC_DICT;
4094 }
4095
Bram Moolenaare38eab22019-12-05 21:50:01 +01004096 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004097 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004098 if (overwrite)
4099 {
4100 hi = hash_find(&func_hashtab, name);
4101 hi->hi_key = UF2HIKEY(fp);
4102 }
4103 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004104 {
4105 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004106 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004107 goto erret;
4108 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004109 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 }
4111 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004112 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004113 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004114 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004115
4116 if (eap->cmdidx == CMD_def)
4117 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004118 int lnum_save = SOURCING_LNUM;
4119 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004120
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004121 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004122
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004123 // error messages are for the first function line
4124 SOURCING_LNUM = sourcing_lnum_top;
4125
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004126 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004127 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004128 int count = cstack->cs_idx + 1;
4129 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004130
4131 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004132 // a block that is visible now but not when the function is called
4133 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004134 fp->uf_block_ids = ALLOC_MULT(int, count);
4135 if (fp->uf_block_ids != NULL)
4136 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004137 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004138 sizeof(int) * count);
4139 fp->uf_block_depth = count;
4140 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004141
4142 // Set flag in each block to indicate a function was defined. This
4143 // is used to keep the variable when leaving the block, see
4144 // hide_script_var().
4145 for (i = 0; i <= cstack->cs_idx; ++i)
4146 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004147 }
4148
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004149 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004150 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004151 SOURCING_LNUM = lnum_save;
4152 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004153 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004154 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004155
4156 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004157 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004158 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004159 SOURCING_LNUM = lnum_save;
4160 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004161 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004162 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004163 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004164 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004165 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004166
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004167 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004168 if ((flags & FC_CLOSURE) != 0)
4169 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004170 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004171 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004172 }
4173 else
4174 fp->uf_scoped = NULL;
4175
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004177 if (prof_def_func())
4178 func_do_profile(fp);
4179#endif
4180 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004181 if (sandbox)
4182 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004183 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004184 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004185 fp->uf_flags = flags;
4186 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004187 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004188 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004189 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004190 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004191 if (is_export)
4192 {
4193 fp->uf_flags |= FC_EXPORT;
4194 // let ex_export() know the export worked.
4195 is_export = FALSE;
4196 }
4197
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004198 if (eap->cmdidx == CMD_def)
4199 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004200 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4201 // :func does not use Vim9 script syntax, even in a Vim9 script file
4202 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004203
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 goto ret_free;
4205
4206erret:
4207 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004208 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004209 if (fp != NULL)
4210 {
4211 ga_init(&fp->uf_args);
4212 ga_init(&fp->uf_def_args);
4213 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004214errret_2:
4215 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004216 if (fp != NULL)
4217 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004218ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004219 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004220 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004221 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004222 if (name != name_arg)
4223 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004224 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004225 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004226
4227 return fp;
4228}
4229
4230/*
4231 * ":function"
4232 */
4233 void
4234ex_function(exarg_T *eap)
4235{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004236 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004237}
4238
4239/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004240 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004241 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004242 */
4243 void
4244ex_defcompile(exarg_T *eap UNUSED)
4245{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004246 long todo = (long)func_hashtab.ht_used;
4247 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004248 hashitem_T *hi;
4249 ufunc_T *ufunc;
4250
4251 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4252 {
4253 if (!HASHITEM_EMPTY(hi))
4254 {
4255 --todo;
4256 ufunc = HI2UF(hi);
4257 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004258 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4259 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004260 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004261 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004262
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004263 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004264 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004265 // a function has been added or removed, need to start over
4266 todo = (long)func_hashtab.ht_used;
4267 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004268 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004269 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004270 }
4271 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004272 }
4273 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274}
4275
4276/*
4277 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4278 * Return 2 if "p" starts with "s:".
4279 * Return 0 otherwise.
4280 */
4281 int
4282eval_fname_script(char_u *p)
4283{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004284 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4285 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4287 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4288 return 5;
4289 if (p[0] == 's' && p[1] == ':')
4290 return 2;
4291 return 0;
4292}
4293
4294 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004295translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296{
4297 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004298 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004299 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004300}
4301
4302/*
4303 * Return TRUE when "ufunc" has old-style "..." varargs
4304 * or named varargs "...name: type".
4305 */
4306 int
4307has_varargs(ufunc_T *ufunc)
4308{
4309 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310}
4311
4312/*
4313 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004314 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315 */
4316 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004317function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318{
4319 char_u *nm = name;
4320 char_u *p;
4321 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004322 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004323 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004324
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004325 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4326 if (no_deref)
4327 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004328 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004329 nm = skipwhite(nm);
4330
Bram Moolenaare38eab22019-12-05 21:50:01 +01004331 // Only accept "funcname", "funcname ", "funcname (..." and
4332 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004334 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335 vim_free(p);
4336 return n;
4337}
4338
Bram Moolenaar113e1072019-01-20 15:30:40 +01004339#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004340 char_u *
4341get_expanded_name(char_u *name, int check)
4342{
4343 char_u *nm = name;
4344 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004345 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004347 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004348 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004350 if (p != NULL && *nm == NUL
4351 && (!check || translated_function_exists(p, is_global)))
4352 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353
4354 vim_free(p);
4355 return NULL;
4356}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004357#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004359/*
4360 * Function given to ExpandGeneric() to obtain the list of user defined
4361 * function names.
4362 */
4363 char_u *
4364get_user_func_name(expand_T *xp, int idx)
4365{
4366 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004367 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 static hashitem_T *hi;
4369 ufunc_T *fp;
4370
4371 if (idx == 0)
4372 {
4373 done = 0;
4374 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004375 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004376 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004377 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378 {
4379 if (done++ > 0)
4380 ++hi;
4381 while (HASHITEM_EMPTY(hi))
4382 ++hi;
4383 fp = HI2UF(hi);
4384
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004385 // don't show dead, dict and lambda functions
4386 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004387 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004388 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389
4390 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004391 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004392
4393 cat_func_name(IObuff, fp);
4394 if (xp->xp_context != EXPAND_USER_FUNC)
4395 {
4396 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004397 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 STRCAT(IObuff, ")");
4399 }
4400 return IObuff;
4401 }
4402 return NULL;
4403}
4404
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405/*
4406 * ":delfunction {name}"
4407 */
4408 void
4409ex_delfunction(exarg_T *eap)
4410{
4411 ufunc_T *fp = NULL;
4412 char_u *p;
4413 char_u *name;
4414 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004415 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416
4417 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004418 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4419 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 vim_free(fudi.fd_newkey);
4421 if (name == NULL)
4422 {
4423 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004424 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004425 return;
4426 }
4427 if (!ends_excmd(*skipwhite(p)))
4428 {
4429 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004430 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 return;
4432 }
4433 eap->nextcmd = check_nextcmd(p);
4434 if (eap->nextcmd != NULL)
4435 *p = NUL;
4436
4437 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004438 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 vim_free(name);
4440
4441 if (!eap->skip)
4442 {
4443 if (fp == NULL)
4444 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004445 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004446 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004447 return;
4448 }
4449 if (fp->uf_calls > 0)
4450 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004451 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 return;
4453 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004454 if (fp->uf_flags & FC_VIM9)
4455 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004456 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004457 return;
4458 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459
4460 if (fudi.fd_dict != NULL)
4461 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004462 // Delete the dict item that refers to the function, it will
4463 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4465 }
4466 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004467 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004468 // A normal function (not a numbered function or lambda) has a
4469 // refcount of 1 for the entry in the hashtable. When deleting
4470 // it and the refcount is more than one, it should be kept.
4471 // A numbered function and lambda should be kept if the refcount is
4472 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004473 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004474 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004475 // Function is still referenced somewhere. Don't free it but
4476 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004477 if (func_remove(fp))
4478 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004479 }
4480 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004481 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004482 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004483 }
4484}
4485
4486/*
4487 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004488 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 */
4490 void
4491func_unref(char_u *name)
4492{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004493 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004495 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004497 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004498 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004501 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004503 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004504 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004505 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004506}
4507
4508/*
4509 * Unreference a Function: decrement the reference count and free it when it
4510 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004511 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004512 */
4513 void
4514func_ptr_unref(ufunc_T *fp)
4515{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004516 if (fp != NULL && (--fp->uf_refcount <= 0
4517 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4518 && fp->uf_partial->pt_refcount <= 1
4519 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004520 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004521 // Only delete it when it's not being used. Otherwise it's done
4522 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004523 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004524 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 }
4526}
4527
4528/*
4529 * Count a reference to a Function.
4530 */
4531 void
4532func_ref(char_u *name)
4533{
4534 ufunc_T *fp;
4535
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004536 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004538 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004539 if (fp != NULL)
4540 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004542 // Only give an error for a numbered function.
4543 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004544 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004545}
4546
4547/*
4548 * Count a reference to a Function.
4549 */
4550 void
4551func_ptr_ref(ufunc_T *fp)
4552{
4553 if (fp != NULL)
4554 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004555}
4556
4557/*
4558 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4559 * referenced from anywhere that is in use.
4560 */
4561 static int
4562can_free_funccal(funccall_T *fc, int copyID)
4563{
4564 return (fc->l_varlist.lv_copyID != copyID
4565 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004566 && fc->l_avars.dv_copyID != copyID
4567 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004568}
4569
4570/*
4571 * ":return [expr]"
4572 */
4573 void
4574ex_return(exarg_T *eap)
4575{
4576 char_u *arg = eap->arg;
4577 typval_T rettv;
4578 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004579 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580
4581 if (current_funccal == NULL)
4582 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004583 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004584 return;
4585 }
4586
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004587 CLEAR_FIELD(evalarg);
4588 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4589
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 if (eap->skip)
4591 ++emsg_skip;
4592
4593 eap->nextcmd = NULL;
4594 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004595 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 {
4597 if (!eap->skip)
4598 returning = do_return(eap, FALSE, TRUE, &rettv);
4599 else
4600 clear_tv(&rettv);
4601 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004602 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 else if (!eap->skip)
4604 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004605 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004606 update_force_abort();
4607
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004608 /*
4609 * Return unless the expression evaluation has been cancelled due to an
4610 * aborting error, an interrupt, or an exception.
4611 */
4612 if (!aborting())
4613 returning = do_return(eap, FALSE, TRUE, NULL);
4614 }
4615
Bram Moolenaare38eab22019-12-05 21:50:01 +01004616 // When skipping or the return gets pending, advance to the next command
4617 // in this line (!returning). Otherwise, ignore the rest of the line.
4618 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 if (returning)
4620 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004621 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622 eap->nextcmd = check_nextcmd(arg);
4623
4624 if (eap->skip)
4625 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004626 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627}
4628
4629/*
4630 * ":1,25call func(arg1, arg2)" function call.
4631 */
4632 void
4633ex_call(exarg_T *eap)
4634{
4635 char_u *arg = eap->arg;
4636 char_u *startarg;
4637 char_u *name;
4638 char_u *tofree;
4639 int len;
4640 typval_T rettv;
4641 linenr_T lnum;
4642 int doesrange;
4643 int failed = FALSE;
4644 funcdict_T fudi;
4645 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004646 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004647 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004648
Bram Moolenaare6b53242020-07-01 17:28:33 +02004649 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 if (eap->skip)
4651 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004652 // trans_function_name() doesn't work well when skipping, use eval0()
4653 // instead to skip to any following command, e.g. for:
4654 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004656 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004657 clear_tv(&rettv);
4658 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004659 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004660 return;
4661 }
4662
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004663 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4664 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665 if (fudi.fd_newkey != NULL)
4666 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004667 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004668 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669 vim_free(fudi.fd_newkey);
4670 }
4671 if (tofree == NULL)
4672 return;
4673
Bram Moolenaare38eab22019-12-05 21:50:01 +01004674 // Increase refcount on dictionary, it could get deleted when evaluating
4675 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676 if (fudi.fd_dict != NULL)
4677 ++fudi.fd_dict->dv_refcount;
4678
Bram Moolenaare38eab22019-12-05 21:50:01 +01004679 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4680 // contents. For VAR_PARTIAL get its partial, unless we already have one
4681 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004683 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4684 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004685
Bram Moolenaare38eab22019-12-05 21:50:01 +01004686 // Skip white space to allow ":call func ()". Not good, but required for
4687 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004689 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690
4691 if (*startarg != '(')
4692 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004693 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 goto end;
4695 }
4696
4697 /*
4698 * When skipping, evaluate the function once, to find the end of the
4699 * arguments.
4700 * When the function takes a range, this is discovered after the first
4701 * call, and the loop is broken.
4702 */
4703 if (eap->skip)
4704 {
4705 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004706 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 }
4708 else
4709 lnum = eap->line1;
4710 for ( ; lnum <= eap->line2; ++lnum)
4711 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004712 funcexe_T funcexe;
4713
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004714 if (!eap->skip && eap->addr_count > 0)
4715 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004716 if (lnum > curbuf->b_ml.ml_line_count)
4717 {
4718 // If the function deleted lines or switched to another buffer
4719 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004720 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004721 break;
4722 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 curwin->w_cursor.lnum = lnum;
4724 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004726 }
4727 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004728
Bram Moolenaara80faa82020-04-12 19:37:17 +02004729 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004730 funcexe.firstline = eap->line1;
4731 funcexe.lastline = eap->line2;
4732 funcexe.doesrange = &doesrange;
4733 funcexe.evaluate = !eap->skip;
4734 funcexe.partial = partial;
4735 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004736 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004737 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 {
4739 failed = TRUE;
4740 break;
4741 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004742 if (has_watchexpr())
4743 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004745 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004746 if (handle_subscript(&arg, &rettv,
4747 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748 {
4749 failed = TRUE;
4750 break;
4751 }
4752
4753 clear_tv(&rettv);
4754 if (doesrange || eap->skip)
4755 break;
4756
Bram Moolenaare38eab22019-12-05 21:50:01 +01004757 // Stop when immediately aborting on error, or when an interrupt
4758 // occurred or an exception was thrown but not caught.
4759 // get_func_tv() returned OK, so that the check for trailing
4760 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004761 if (aborting())
4762 break;
4763 }
4764 if (eap->skip)
4765 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004766 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004767
Bram Moolenaare51bb172020-02-16 19:42:23 +01004768 // When inside :try we need to check for following "| catch".
4769 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004770 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004771 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004772 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004773 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004775 if (!failed)
4776 {
4777 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004778 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 }
4781 else
4782 eap->nextcmd = check_nextcmd(arg);
4783 }
4784
4785end:
4786 dict_unref(fudi.fd_dict);
4787 vim_free(tofree);
4788}
4789
4790/*
4791 * Return from a function. Possibly makes the return pending. Also called
4792 * for a pending return at the ":endtry" or after returning from an extra
4793 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4794 * when called due to a ":return" command. "rettv" may point to a typval_T
4795 * with the return rettv. Returns TRUE when the return can be carried out,
4796 * FALSE when the return gets pending.
4797 */
4798 int
4799do_return(
4800 exarg_T *eap,
4801 int reanimate,
4802 int is_cmd,
4803 void *rettv)
4804{
4805 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004806 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807
4808 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004809 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 current_funccal->returned = FALSE;
4811
4812 /*
4813 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4814 * not in its finally clause (which then is to be executed next) is found.
4815 * In this case, make the ":return" pending for execution at the ":endtry".
4816 * Otherwise, return normally.
4817 */
4818 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4819 if (idx >= 0)
4820 {
4821 cstack->cs_pending[idx] = CSTP_RETURN;
4822
4823 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004824 // A pending return again gets pending. "rettv" points to an
4825 // allocated variable with the rettv of the original ":return"'s
4826 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 cstack->cs_rettv[idx] = rettv;
4828 else
4829 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004830 // When undoing a return in order to make it pending, get the stored
4831 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832 if (reanimate)
4833 rettv = current_funccal->rettv;
4834
4835 if (rettv != NULL)
4836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004837 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4839 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4840 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004841 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004842 }
4843 else
4844 cstack->cs_rettv[idx] = NULL;
4845
4846 if (reanimate)
4847 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004848 // The pending return value could be overwritten by a ":return"
4849 // without argument in a finally clause; reset the default
4850 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851 current_funccal->rettv->v_type = VAR_NUMBER;
4852 current_funccal->rettv->vval.v_number = 0;
4853 }
4854 }
4855 report_make_pending(CSTP_RETURN, rettv);
4856 }
4857 else
4858 {
4859 current_funccal->returned = TRUE;
4860
Bram Moolenaare38eab22019-12-05 21:50:01 +01004861 // If the return is carried out now, store the return value. For
4862 // a return immediately after reanimation, the value is already
4863 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004864 if (!reanimate && rettv != NULL)
4865 {
4866 clear_tv(current_funccal->rettv);
4867 *current_funccal->rettv = *(typval_T *)rettv;
4868 if (!is_cmd)
4869 vim_free(rettv);
4870 }
4871 }
4872
4873 return idx < 0;
4874}
4875
4876/*
4877 * Free the variable with a pending return value.
4878 */
4879 void
4880discard_pending_return(void *rettv)
4881{
4882 free_tv((typval_T *)rettv);
4883}
4884
4885/*
4886 * Generate a return command for producing the value of "rettv". The result
4887 * is an allocated string. Used by report_pending() for verbose messages.
4888 */
4889 char_u *
4890get_return_cmd(void *rettv)
4891{
4892 char_u *s = NULL;
4893 char_u *tofree = NULL;
4894 char_u numbuf[NUMBUFLEN];
4895
4896 if (rettv != NULL)
4897 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4898 if (s == NULL)
4899 s = (char_u *)"";
4900
4901 STRCPY(IObuff, ":return ");
4902 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4903 if (STRLEN(s) + 8 >= IOSIZE)
4904 STRCPY(IObuff + IOSIZE - 4, "...");
4905 vim_free(tofree);
4906 return vim_strsave(IObuff);
4907}
4908
4909/*
4910 * Get next function line.
4911 * Called by do_cmdline() to get the next line.
4912 * Returns allocated string, or NULL for end of function.
4913 */
4914 char_u *
4915get_func_line(
4916 int c UNUSED,
4917 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004918 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004919 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004920{
4921 funccall_T *fcp = (funccall_T *)cookie;
4922 ufunc_T *fp = fcp->func;
4923 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004924 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925
Bram Moolenaare38eab22019-12-05 21:50:01 +01004926 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 if (fcp->dbg_tick != debug_tick)
4928 {
4929 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004930 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 fcp->dbg_tick = debug_tick;
4932 }
4933#ifdef FEAT_PROFILE
4934 if (do_profiling == PROF_YES)
4935 func_line_end(cookie);
4936#endif
4937
4938 gap = &fp->uf_lines;
4939 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4940 || fcp->returned)
4941 retval = NULL;
4942 else
4943 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004944 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 while (fcp->linenr < gap->ga_len
4946 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4947 ++fcp->linenr;
4948 if (fcp->linenr >= gap->ga_len)
4949 retval = NULL;
4950 else
4951 {
4952 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004953 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004954#ifdef FEAT_PROFILE
4955 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004956 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004957#endif
4958 }
4959 }
4960
Bram Moolenaare38eab22019-12-05 21:50:01 +01004961 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004962 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004963 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004964 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004965 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004967 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968 fcp->dbg_tick = debug_tick;
4969 }
4970
4971 return retval;
4972}
4973
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974/*
4975 * Return TRUE if the currently active function should be ended, because a
4976 * return was encountered or an error occurred. Used inside a ":while".
4977 */
4978 int
4979func_has_ended(void *cookie)
4980{
4981 funccall_T *fcp = (funccall_T *)cookie;
4982
Bram Moolenaare38eab22019-12-05 21:50:01 +01004983 // Ignore the "abort" flag if the abortion behavior has been changed due to
4984 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4986 || fcp->returned);
4987}
4988
4989/*
4990 * return TRUE if cookie indicates a function which "abort"s on errors.
4991 */
4992 int
4993func_has_abort(
4994 void *cookie)
4995{
4996 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4997}
4998
4999
5000/*
5001 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5002 * Don't do this when "Func" is already a partial that was bound
5003 * explicitly (pt_auto is FALSE).
5004 * Changes "rettv" in-place.
5005 * Returns the updated "selfdict_in".
5006 */
5007 dict_T *
5008make_partial(dict_T *selfdict_in, typval_T *rettv)
5009{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005010 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011 char_u *tofree = NULL;
5012 ufunc_T *fp;
5013 char_u fname_buf[FLEN_FIXED + 1];
5014 int error;
5015 dict_T *selfdict = selfdict_in;
5016
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005017 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5018 fp = rettv->vval.v_partial->pt_func;
5019 else
5020 {
5021 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5022 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005023 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005024 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005025 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005026 vim_free(tofree);
5027 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005028
5029 if (fp != NULL && (fp->uf_flags & FC_DICT))
5030 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005031 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032
5033 if (pt != NULL)
5034 {
5035 pt->pt_refcount = 1;
5036 pt->pt_dict = selfdict;
5037 pt->pt_auto = TRUE;
5038 selfdict = NULL;
5039 if (rettv->v_type == VAR_FUNC)
5040 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005041 // Just a function: Take over the function name and use
5042 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005043 pt->pt_name = rettv->vval.v_string;
5044 }
5045 else
5046 {
5047 partial_T *ret_pt = rettv->vval.v_partial;
5048 int i;
5049
Bram Moolenaare38eab22019-12-05 21:50:01 +01005050 // Partial: copy the function name, use selfdict and copy
5051 // args. Can't take over name or args, the partial might
5052 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005053 if (ret_pt->pt_name != NULL)
5054 {
5055 pt->pt_name = vim_strsave(ret_pt->pt_name);
5056 func_ref(pt->pt_name);
5057 }
5058 else
5059 {
5060 pt->pt_func = ret_pt->pt_func;
5061 func_ptr_ref(pt->pt_func);
5062 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005063 if (ret_pt->pt_argc > 0)
5064 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005065 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005066 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005067 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005068 pt->pt_argc = 0;
5069 else
5070 {
5071 pt->pt_argc = ret_pt->pt_argc;
5072 for (i = 0; i < pt->pt_argc; i++)
5073 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5074 }
5075 }
5076 partial_unref(ret_pt);
5077 }
5078 rettv->v_type = VAR_PARTIAL;
5079 rettv->vval.v_partial = pt;
5080 }
5081 }
5082 return selfdict;
5083}
5084
5085/*
5086 * Return the name of the executed function.
5087 */
5088 char_u *
5089func_name(void *cookie)
5090{
5091 return ((funccall_T *)cookie)->func->uf_name;
5092}
5093
5094/*
5095 * Return the address holding the next breakpoint line for a funccall cookie.
5096 */
5097 linenr_T *
5098func_breakpoint(void *cookie)
5099{
5100 return &((funccall_T *)cookie)->breakpoint;
5101}
5102
5103/*
5104 * Return the address holding the debug tick for a funccall cookie.
5105 */
5106 int *
5107func_dbg_tick(void *cookie)
5108{
5109 return &((funccall_T *)cookie)->dbg_tick;
5110}
5111
5112/*
5113 * Return the nesting level for a funccall cookie.
5114 */
5115 int
5116func_level(void *cookie)
5117{
5118 return ((funccall_T *)cookie)->level;
5119}
5120
5121/*
5122 * Return TRUE when a function was ended by a ":return" command.
5123 */
5124 int
5125current_func_returned(void)
5126{
5127 return current_funccal->returned;
5128}
5129
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 int
5131free_unref_funccal(int copyID, int testing)
5132{
5133 int did_free = FALSE;
5134 int did_free_funccal = FALSE;
5135 funccall_T *fc, **pfc;
5136
5137 for (pfc = &previous_funccal; *pfc != NULL; )
5138 {
5139 if (can_free_funccal(*pfc, copyID))
5140 {
5141 fc = *pfc;
5142 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005143 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005144 did_free = TRUE;
5145 did_free_funccal = TRUE;
5146 }
5147 else
5148 pfc = &(*pfc)->caller;
5149 }
5150 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005151 // When a funccal was freed some more items might be garbage
5152 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005153 (void)garbage_collect(testing);
5154
5155 return did_free;
5156}
5157
5158/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005159 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005160 */
5161 static funccall_T *
5162get_funccal(void)
5163{
5164 int i;
5165 funccall_T *funccal;
5166 funccall_T *temp_funccal;
5167
5168 funccal = current_funccal;
5169 if (debug_backtrace_level > 0)
5170 {
5171 for (i = 0; i < debug_backtrace_level; i++)
5172 {
5173 temp_funccal = funccal->caller;
5174 if (temp_funccal)
5175 funccal = temp_funccal;
5176 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005177 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005178 debug_backtrace_level = i;
5179 }
5180 }
5181 return funccal;
5182}
5183
5184/*
5185 * Return the hashtable used for local variables in the current funccal.
5186 * Return NULL if there is no current funccal.
5187 */
5188 hashtab_T *
5189get_funccal_local_ht()
5190{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005191 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005192 return NULL;
5193 return &get_funccal()->l_vars.dv_hashtab;
5194}
5195
5196/*
5197 * Return the l: scope variable.
5198 * Return NULL if there is no current funccal.
5199 */
5200 dictitem_T *
5201get_funccal_local_var()
5202{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005203 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204 return NULL;
5205 return &get_funccal()->l_vars_var;
5206}
5207
5208/*
5209 * Return the hashtable used for argument in the current funccal.
5210 * Return NULL if there is no current funccal.
5211 */
5212 hashtab_T *
5213get_funccal_args_ht()
5214{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005215 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 return NULL;
5217 return &get_funccal()->l_avars.dv_hashtab;
5218}
5219
5220/*
5221 * Return the a: scope variable.
5222 * Return NULL if there is no current funccal.
5223 */
5224 dictitem_T *
5225get_funccal_args_var()
5226{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005227 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005228 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005229 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005230}
5231
5232/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005233 * List function variables, if there is a function.
5234 */
5235 void
5236list_func_vars(int *first)
5237{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005238 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005239 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005240 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241}
5242
5243/*
5244 * If "ht" is the hashtable for local variables in the current funccal, return
5245 * the dict that contains it.
5246 * Otherwise return NULL.
5247 */
5248 dict_T *
5249get_current_funccal_dict(hashtab_T *ht)
5250{
5251 if (current_funccal != NULL
5252 && ht == &current_funccal->l_vars.dv_hashtab)
5253 return &current_funccal->l_vars;
5254 return NULL;
5255}
5256
5257/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005258 * Search hashitem in parent scope.
5259 */
5260 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005261find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005262{
5263 funccall_T *old_current_funccal = current_funccal;
5264 hashtab_T *ht;
5265 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005266 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005267
5268 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5269 return NULL;
5270
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005271 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005272 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005273 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005274 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005275 ht = find_var_ht(name, &varname);
5276 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005277 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005278 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005279 if (!HASHITEM_EMPTY(hi))
5280 {
5281 *pht = ht;
5282 break;
5283 }
5284 }
5285 if (current_funccal == current_funccal->func->uf_scoped)
5286 break;
5287 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005288 }
5289 current_funccal = old_current_funccal;
5290
5291 return hi;
5292}
5293
5294/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005295 * Search variable in parent scope.
5296 */
5297 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005298find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005299{
5300 dictitem_T *v = NULL;
5301 funccall_T *old_current_funccal = current_funccal;
5302 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005303 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005304
5305 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5306 return NULL;
5307
Bram Moolenaare38eab22019-12-05 21:50:01 +01005308 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005309 current_funccal = current_funccal->func->uf_scoped;
5310 while (current_funccal)
5311 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005312 ht = find_var_ht(name, &varname);
5313 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005314 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005315 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005316 if (v != NULL)
5317 break;
5318 }
5319 if (current_funccal == current_funccal->func->uf_scoped)
5320 break;
5321 current_funccal = current_funccal->func->uf_scoped;
5322 }
5323 current_funccal = old_current_funccal;
5324
5325 return v;
5326}
5327
5328/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005329 * Set "copyID + 1" in previous_funccal and callers.
5330 */
5331 int
5332set_ref_in_previous_funccal(int copyID)
5333{
5334 int abort = FALSE;
5335 funccall_T *fc;
5336
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005337 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005338 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005339 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005340 abort = abort
5341 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5342 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005343 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005344 }
5345 return abort;
5346}
5347
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005348 static int
5349set_ref_in_funccal(funccall_T *fc, int copyID)
5350{
5351 int abort = FALSE;
5352
5353 if (fc->fc_copyID != copyID)
5354 {
5355 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005356 abort = abort
5357 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5358 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005359 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005360 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005361 }
5362 return abort;
5363}
5364
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005365/*
5366 * Set "copyID" in all local vars and arguments in the call stack.
5367 */
5368 int
5369set_ref_in_call_stack(int copyID)
5370{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005371 int abort = FALSE;
5372 funccall_T *fc;
5373 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005374
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005375 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005376 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005377
5378 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005379 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5380 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005381 abort = abort || set_ref_in_funccal(fc, copyID);
5382
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005383 return abort;
5384}
5385
5386/*
5387 * Set "copyID" in all functions available by name.
5388 */
5389 int
5390set_ref_in_functions(int copyID)
5391{
5392 int todo;
5393 hashitem_T *hi = NULL;
5394 int abort = FALSE;
5395 ufunc_T *fp;
5396
5397 todo = (int)func_hashtab.ht_used;
5398 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005400 if (!HASHITEM_EMPTY(hi))
5401 {
5402 --todo;
5403 fp = HI2UF(hi);
5404 if (!func_name_refcount(fp->uf_name))
5405 abort = abort || set_ref_in_func(NULL, fp, copyID);
5406 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005407 }
5408 return abort;
5409}
5410
5411/*
5412 * Set "copyID" in all function arguments.
5413 */
5414 int
5415set_ref_in_func_args(int copyID)
5416{
5417 int i;
5418 int abort = FALSE;
5419
5420 for (i = 0; i < funcargs.ga_len; ++i)
5421 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5422 copyID, NULL, NULL);
5423 return abort;
5424}
5425
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005426/*
5427 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005428 * Returns TRUE if setting references failed somehow.
5429 */
5430 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005431set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005432{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005433 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005434 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005435 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005436 char_u fname_buf[FLEN_FIXED + 1];
5437 char_u *tofree = NULL;
5438 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005439 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005440
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005441 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005442 return FALSE;
5443
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005444 if (fp_in == NULL)
5445 {
5446 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005447 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005448 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005449 if (fp != NULL)
5450 {
5451 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005452 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005453 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005454
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005455 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005456 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005457}
5458
Bram Moolenaare38eab22019-12-05 21:50:01 +01005459#endif // FEAT_EVAL