blob: 51894dc101fea874a7d114befff2879b949a53a0 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010058 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010069 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010070{
Bram Moolenaar6e949782020-04-13 17:21:00 +020071 char_u *p = arg;
72 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073
74 while (ASCII_ISALNUM(*p) || *p == '_')
75 ++p;
76 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020077 || (argtypes == NULL
78 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
79 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010080 {
81 if (!skip)
82 semsg(_("E125: Illegal argument: %s"), arg);
83 return arg;
84 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010085
Bram Moolenaar057e84a2021-02-28 16:55:11 +010086 // Vim9 script: cannot use script var name for argument. In function: also
87 // check local vars and arguments.
88 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
89 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010090 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010091
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010092 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
93 return arg;
94 if (newargs != NULL)
95 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 int c;
97 int i;
98
99 c = *p;
100 *p = NUL;
101 arg_copy = vim_strsave(arg);
102 if (arg_copy == NULL)
103 {
104 *p = c;
105 return arg;
106 }
107
108 // Check for duplicate argument name.
109 for (i = 0; i < newargs->ga_len; ++i)
110 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
111 {
112 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
113 vim_free(arg_copy);
114 return arg;
115 }
116 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
117 newargs->ga_len++;
118
119 *p = c;
120 }
121
122 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100123 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 {
125 char_u *type = NULL;
126
Bram Moolenaar6e949782020-04-13 17:21:00 +0200127 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
128 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200129 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200130 arg_copy == NULL ? arg : arg_copy);
131 p = skipwhite(p);
132 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100133 if (*p == ':')
134 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200135 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100136 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200137 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100138 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 return arg;
140 }
141 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200142 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100146 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200147 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200148 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200149 arg_copy == NULL ? arg : arg_copy);
150 return arg;
151 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100152 if (!skip)
153 {
154 if (type == NULL && types_optional)
155 // lambda arguments default to "any" type
156 type = vim_strsave((char_u *)"any");
157 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
158 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100159 }
160
161 return p;
162}
163
164/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200165 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100166 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100167 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200168 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100169 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170get_function_args(
171 char_u **argp,
172 char_u endchar,
173 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100174 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100175 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100176 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200177 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200178 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200179 int skip,
180 exarg_T *eap,
181 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200182{
183 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100184 char_u *arg;
185 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200186 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200187 int any_default = FALSE;
188 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100189 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200190
191 if (newargs != NULL)
192 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100193 if (argtypes != NULL)
194 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200195 if (default_args != NULL)
196 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200197
198 if (varargs != NULL)
199 *varargs = FALSE;
200
201 /*
202 * Isolate the arguments: "arg1, arg2, ...)"
203 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100204 arg = skipwhite(*argp);
205 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206 while (*p != endchar)
207 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200208 while (eap != NULL && eap->getline != NULL
209 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 {
211 char_u *theline;
212
213 // End of the line, get the next one.
214 theline = eap->getline(':', eap->cookie, 0, TRUE);
215 if (theline == NULL)
216 break;
217 vim_free(*line_to_free);
218 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200219 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200220 p = skipwhite(theline);
221 }
222
223 if (mustend && *p != endchar)
224 {
225 if (!skip)
226 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100227 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200228 }
229 if (*p == endchar)
230 break;
231
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200232 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
233 {
234 if (varargs != NULL)
235 *varargs = TRUE;
236 p += 3;
237 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100238
239 if (argtypes != NULL)
240 {
241 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200242 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100243 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100244 if (!skip)
245 emsg(_(e_missing_name_after_dots));
246 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100247 }
248
249 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100251 evalarg, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100252 if (p == arg)
253 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100254 if (*skipwhite(p) == '=')
255 {
256 emsg(_(e_cannot_use_default_for_variable_arguments));
257 break;
258 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100259 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200260 }
261 else
262 {
263 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100264 p = one_function_arg(p, newargs, argtypes, types_optional,
265 evalarg, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100266 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200267 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200268
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200269 if (*skipwhite(p) == '=' && default_args != NULL)
270 {
271 typval_T rettv;
272
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100273 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200274 any_default = TRUE;
275 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200276 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200277 p = skipwhite(p);
278 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200279 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200280 {
281 if (ga_grow(default_args, 1) == FAIL)
282 goto err_ret;
283
284 // trim trailing whitespace
285 while (p > expr && VIM_ISWHITE(p[-1]))
286 p--;
287 c = *p;
288 *p = NUL;
289 expr = vim_strsave(expr);
290 if (expr == NULL)
291 {
292 *p = c;
293 goto err_ret;
294 }
295 ((char_u **)(default_args->ga_data))
296 [default_args->ga_len] = expr;
297 default_args->ga_len++;
298 *p = c;
299 }
300 else
301 mustend = TRUE;
302 }
303 else if (any_default)
304 {
305 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200306 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200307 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200309 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200310 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200311 // Don't give this error when skipping, it makes the "->" not
312 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100313 // Allow missing space after comma in legacy functions.
314 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200315 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
316 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100317 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200318 goto err_ret;
319 }
320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200321 else
322 mustend = TRUE;
323 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200324 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200326 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200327
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200328 if (*p != endchar)
329 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100330 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200331
332 *argp = p;
333 return OK;
334
335err_ret:
336 if (newargs != NULL)
337 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200338 if (default_args != NULL)
339 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200340 return FAIL;
341}
342
343/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100344 * Parse the argument types, filling "fp->uf_arg_types".
345 * Return OK or FAIL.
346 */
347 static int
348parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
349{
350 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
351 if (argtypes->ga_len > 0)
352 {
353 // When "varargs" is set the last name/type goes into uf_va_name
354 // and uf_va_type.
355 int len = argtypes->ga_len - (varargs ? 1 : 0);
356
357 if (len > 0)
358 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
359 if (fp->uf_arg_types != NULL)
360 {
361 int i;
362 type_T *type;
363
364 for (i = 0; i < len; ++ i)
365 {
366 char_u *p = ((char_u **)argtypes->ga_data)[i];
367
368 if (p == NULL)
369 // will get the type from the default value
370 type = &t_unknown;
371 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100372 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100373 if (type == NULL)
374 return FAIL;
375 fp->uf_arg_types[i] = type;
376 }
377 }
378 if (varargs)
379 {
380 char_u *p;
381
382 // Move the last argument "...name: type" to uf_va_name and
383 // uf_va_type.
384 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
385 [fp->uf_args.ga_len - 1];
386 --fp->uf_args.ga_len;
387 p = ((char_u **)argtypes->ga_data)[len];
388 if (p == NULL)
389 // todo: get type from default value
390 fp->uf_va_type = &t_any;
391 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100392 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100393 if (fp->uf_va_type == NULL)
394 return FAIL;
395 }
396 }
397 return OK;
398}
399
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100400 static int
401parse_return_type(ufunc_T *fp, char_u *ret_type)
402{
403 if (ret_type == NULL)
404 fp->uf_ret_type = &t_void;
405 else
406 {
407 char_u *p = ret_type;
408
409 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
410 if (fp->uf_ret_type == NULL)
411 {
412 fp->uf_ret_type = &t_void;
413 return FAIL;
414 }
415 }
416 return OK;
417}
418
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100419/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200420 * Register function "fp" as using "current_funccal" as its scope.
421 */
422 static int
423register_closure(ufunc_T *fp)
424{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200425 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100426 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200427 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200428 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200429 fp->uf_scoped = current_funccal;
430 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200431
Bram Moolenaar58016442016-07-31 18:30:22 +0200432 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
433 return FAIL;
434 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
435 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200436 return OK;
437}
438
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100439 static void
440set_ufunc_name(ufunc_T *fp, char_u *name)
441{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100442 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
443 // actually extends beyond the struct.
444 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100445
446 if (name[0] == K_SPECIAL)
447 {
448 fp->uf_name_exp = alloc(STRLEN(name) + 3);
449 if (fp->uf_name_exp != NULL)
450 {
451 STRCPY(fp->uf_name_exp, "<SNR>");
452 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
453 }
454 }
455}
456
Bram Moolenaar58016442016-07-31 18:30:22 +0200457/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200458 * Get a name for a lambda. Returned in static memory.
459 */
460 char_u *
461get_lambda_name(void)
462{
463 static char_u name[30];
464 static int lambda_no = 0;
465
466 sprintf((char*)name, "<lambda>%d", ++lambda_no);
467 return name;
468}
469
Bram Moolenaar801ab062020-06-25 19:27:56 +0200470#if defined(FEAT_LUA) || defined(PROTO)
471/*
472 * Registers a native C callback which can be called from Vim script.
473 * Returns the name of the Vim script function.
474 */
475 char_u *
476register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
477{
478 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200479 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200480
481 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
482 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200483 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200484
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200485 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200486 fp->uf_refcount = 1;
487 fp->uf_varargs = TRUE;
488 fp->uf_flags = FC_CFUNC;
489 fp->uf_calls = 0;
490 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200491 fp->uf_cb = cb;
492 fp->uf_cb_free = cb_free;
493 fp->uf_cb_state = state;
494
495 set_ufunc_name(fp, name);
496 hash_add(&func_hashtab, UF2HIKEY(fp));
497
498 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200499}
500#endif
501
Bram Moolenaar04b12692020-05-04 23:24:44 +0200502/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100503 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100504 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100505 * If "white_error" is not NULL check for correct use of white space and set
506 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100507 * Return NULL if no valid arrow found.
508 */
509 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100510skip_arrow(
511 char_u *start,
512 int equal_arrow,
513 char_u **ret_type,
514 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100515{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100516 char_u *s = start;
517 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100518
519 if (equal_arrow)
520 {
521 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100522 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100523 if (white_error != NULL && !VIM_ISWHITE(s[1]))
524 {
525 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100526 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100527 return NULL;
528 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100529 s = skipwhite(s + 1);
530 *ret_type = s;
531 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100532 if (s == *ret_type)
533 {
534 emsg(_(e_missing_return_type));
535 return NULL;
536 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100537 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100538 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100539 s = skipwhite(s);
540 if (*s != '=')
541 return NULL;
542 ++s;
543 }
544 if (*s != '>')
545 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100546 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
547 || !IS_WHITE_OR_NUL(s[1])))
548 {
549 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100550 semsg(_(e_white_space_required_before_and_after_str_at_str),
551 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100552 return NULL;
553 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100554 return skipwhite(s + 1);
555}
556
557/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100558 * Check if "*cmd" points to a function command and if so advance "*cmd" and
559 * return TRUE.
560 * Otherwise return FALSE;
561 * Do not consider "function(" to be a command.
562 */
563 static int
564is_function_cmd(char_u **cmd)
565{
566 char_u *p = *cmd;
567
568 if (checkforcmd(&p, "function", 2))
569 {
570 if (*p == '(')
571 return FALSE;
572 *cmd = p;
573 return TRUE;
574 }
575 return FALSE;
576}
577
578/*
579 * Read the body of a function, put every line in "newlines".
580 * "newlines" must already have been initialized.
581 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
582 */
583 static int
584get_function_body(
585 exarg_T *eap,
586 garray_T *newlines,
587 char_u *line_arg_in,
588 char_u **line_to_free)
589{
590 linenr_T sourcing_lnum_top = SOURCING_LNUM;
591 linenr_T sourcing_lnum_off;
592 int saved_wait_return = need_wait_return;
593 char_u *line_arg = line_arg_in;
594 int vim9_function = eap->cmdidx == CMD_def
595 || eap->cmdidx == CMD_block;
596#define MAX_FUNC_NESTING 50
597 char nesting_def[MAX_FUNC_NESTING];
598 int nesting = 0;
599 getline_opt_T getline_options;
600 int indent = 2;
601 char_u *skip_until = NULL;
602 int ret = FAIL;
603 int is_heredoc = FALSE;
604 char_u *heredoc_trimmed = NULL;
605
606 // Detect having skipped over comment lines to find the return
607 // type. Add NULL lines to keep the line count correct.
608 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
609 if (SOURCING_LNUM < sourcing_lnum_off)
610 {
611 sourcing_lnum_off -= SOURCING_LNUM;
612 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
613 goto theend;
614 while (sourcing_lnum_off-- > 0)
615 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
616 }
617
618 nesting_def[nesting] = vim9_function;
619 getline_options = vim9_function
620 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
621 for (;;)
622 {
623 char_u *theline;
624 char_u *p;
625 char_u *arg;
626
627 if (KeyTyped)
628 {
629 msg_scroll = TRUE;
630 saved_wait_return = FALSE;
631 }
632 need_wait_return = FALSE;
633
634 if (line_arg != NULL)
635 {
636 // Use eap->arg, split up in parts by line breaks.
637 theline = line_arg;
638 p = vim_strchr(theline, '\n');
639 if (p == NULL)
640 line_arg += STRLEN(line_arg);
641 else
642 {
643 *p = NUL;
644 line_arg = p + 1;
645 }
646 }
647 else
648 {
649 vim_free(*line_to_free);
650 if (eap->getline == NULL)
651 theline = getcmdline(':', 0L, indent, getline_options);
652 else
653 theline = eap->getline(':', eap->cookie, indent,
654 getline_options);
655 *line_to_free = theline;
656 }
657 if (KeyTyped)
658 lines_left = Rows - 1;
659 if (theline == NULL)
660 {
661 // Use the start of the function for the line number.
662 SOURCING_LNUM = sourcing_lnum_top;
663 if (skip_until != NULL)
664 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
665 else if (eap->cmdidx == CMD_def)
666 emsg(_(e_missing_enddef));
667 else if (eap->cmdidx == CMD_block)
668 emsg(_(e_missing_end_block));
669 else
670 emsg(_("E126: Missing :endfunction"));
671 goto theend;
672 }
673
674 // Detect line continuation: SOURCING_LNUM increased more than one.
675 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
676 if (SOURCING_LNUM < sourcing_lnum_off)
677 sourcing_lnum_off -= SOURCING_LNUM;
678 else
679 sourcing_lnum_off = 0;
680
681 if (skip_until != NULL)
682 {
683 // Don't check for ":endfunc"/":enddef" between
684 // * ":append" and "."
685 // * ":python <<EOF" and "EOF"
686 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
687 if (heredoc_trimmed == NULL
688 || (is_heredoc && skipwhite(theline) == theline)
689 || STRNCMP(theline, heredoc_trimmed,
690 STRLEN(heredoc_trimmed)) == 0)
691 {
692 if (heredoc_trimmed == NULL)
693 p = theline;
694 else if (is_heredoc)
695 p = skipwhite(theline) == theline
696 ? theline : theline + STRLEN(heredoc_trimmed);
697 else
698 p = theline + STRLEN(heredoc_trimmed);
699 if (STRCMP(p, skip_until) == 0)
700 {
701 VIM_CLEAR(skip_until);
702 VIM_CLEAR(heredoc_trimmed);
703 getline_options = vim9_function
704 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
705 is_heredoc = FALSE;
706 }
707 }
708 }
709 else
710 {
711 int c;
712
713 // skip ':' and blanks
714 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
715 ;
716
717 // Check for "endfunction", "enddef" or "}".
718 // When a ":" follows it must be a dict key; "enddef: value,"
719 if ((nesting == 0 && eap->cmdidx == CMD_block)
720 ? *p == '}'
721 : (checkforcmd(&p, nesting_def[nesting]
722 ? "enddef" : "endfunction", 4)
723 && *p != ':'))
724 {
725 if (nesting-- == 0)
726 {
727 char_u *nextcmd = NULL;
728
729 if (*p == '|' || *p == '}')
730 nextcmd = p + 1;
731 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
732 nextcmd = line_arg;
733 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
734 && p_verbose > 0
735 && eap->cmdidx != CMD_block)
736 give_warning2(eap->cmdidx == CMD_def
737 ? (char_u *)_("W1001: Text found after :enddef: %s")
738 : (char_u *)_("W22: Text found after :endfunction: %s"),
739 p, TRUE);
740 if (nextcmd != NULL)
741 {
742 // Another command follows. If the line came from "eap"
743 // we can simply point into it, otherwise we need to
744 // change "eap->cmdlinep".
745 eap->nextcmd = nextcmd;
746 if (*line_to_free != NULL)
747 {
748 vim_free(*eap->cmdlinep);
749 *eap->cmdlinep = *line_to_free;
750 *line_to_free = NULL;
751 }
752 }
753 break;
754 }
755 }
756
757 // Check for mismatched "endfunc" or "enddef".
758 // We don't check for "def" inside "func" thus we also can't check
759 // for "enddef".
760 // We continue to find the end of the function, although we might
761 // not find it.
762 else if (nesting_def[nesting])
763 {
764 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
765 emsg(_(e_mismatched_endfunction));
766 }
767 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
768 emsg(_(e_mismatched_enddef));
769
770 // Increase indent inside "if", "while", "for" and "try", decrease
771 // at "end".
772 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
773 indent -= 2;
774 else if (STRNCMP(p, "if", 2) == 0
775 || STRNCMP(p, "wh", 2) == 0
776 || STRNCMP(p, "for", 3) == 0
777 || STRNCMP(p, "try", 3) == 0)
778 indent += 2;
779
780 // Check for defining a function inside this function.
781 // Only recognize "def" inside "def", not inside "function",
782 // For backwards compatibility, see Test_function_python().
783 c = *p;
784 if (is_function_cmd(&p)
785 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
786 {
787 if (*p == '!')
788 p = skipwhite(p + 1);
789 p += eval_fname_script(p);
790 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
791 NULL, NULL));
792 if (*skipwhite(p) == '(')
793 {
794 if (nesting == MAX_FUNC_NESTING - 1)
795 emsg(_(e_function_nesting_too_deep));
796 else
797 {
798 ++nesting;
799 nesting_def[nesting] = (c == 'd');
800 indent += 2;
801 }
802 }
803 }
804
805 // Check for ":append", ":change", ":insert". Not for :def.
806 p = skip_range(p, FALSE, NULL);
807 if (!vim9_function
808 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
809 || (p[0] == 'c'
810 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
811 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
812 && (STRNCMP(&p[3], "nge", 3) != 0
813 || !ASCII_ISALPHA(p[6])))))))
814 || (p[0] == 'i'
815 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
816 && (!ASCII_ISALPHA(p[2])
817 || (p[2] == 's'
818 && (!ASCII_ISALPHA(p[3])
819 || p[3] == 'e'))))))))
820 skip_until = vim_strsave((char_u *)".");
821
822 // Check for ":python <<EOF", ":tcl <<EOF", etc.
823 arg = skipwhite(skiptowhite(p));
824 if (arg[0] == '<' && arg[1] =='<'
825 && ((p[0] == 'p' && p[1] == 'y'
826 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
827 || ((p[2] == '3' || p[2] == 'x')
828 && !ASCII_ISALPHA(p[3]))))
829 || (p[0] == 'p' && p[1] == 'e'
830 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
831 || (p[0] == 't' && p[1] == 'c'
832 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
833 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
834 && !ASCII_ISALPHA(p[3]))
835 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
836 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
837 || (p[0] == 'm' && p[1] == 'z'
838 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
839 ))
840 {
841 // ":python <<" continues until a dot, like ":append"
842 p = skipwhite(arg + 2);
843 if (STRNCMP(p, "trim", 4) == 0)
844 {
845 // Ignore leading white space.
846 p = skipwhite(p + 4);
847 heredoc_trimmed = vim_strnsave(theline,
848 skipwhite(theline) - theline);
849 }
850 if (*p == NUL)
851 skip_until = vim_strsave((char_u *)".");
852 else
853 skip_until = vim_strnsave(p, skiptowhite(p) - p);
854 getline_options = GETLINE_NONE;
855 is_heredoc = TRUE;
856 }
857
858 // Check for ":cmd v =<< [trim] EOF"
859 // and ":cmd [a, b] =<< [trim] EOF"
860 // and "lines =<< [trim] EOF" for Vim9
861 // Where "cmd" can be "let", "var", "final" or "const".
862 arg = skipwhite(skiptowhite(p));
863 if (*arg == '[')
864 arg = vim_strchr(arg, ']');
865 if (arg != NULL)
866 {
867 int found = (eap->cmdidx == CMD_def && arg[0] == '='
868 && arg[1] == '<' && arg[2] =='<');
869
870 if (!found)
871 // skip over the argument after "cmd"
872 arg = skipwhite(skiptowhite(arg));
873 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
874 && (checkforcmd(&p, "let", 2)
875 || checkforcmd(&p, "var", 3)
876 || checkforcmd(&p, "final", 5)
877 || checkforcmd(&p, "const", 5))))
878 {
879 p = skipwhite(arg + 3);
880 if (STRNCMP(p, "trim", 4) == 0)
881 {
882 // Ignore leading white space.
883 p = skipwhite(p + 4);
884 heredoc_trimmed = vim_strnsave(theline,
885 skipwhite(theline) - theline);
886 }
887 skip_until = vim_strnsave(p, skiptowhite(p) - p);
888 getline_options = GETLINE_NONE;
889 is_heredoc = TRUE;
890 }
891 }
892 }
893
894 // Add the line to the function.
895 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
896 goto theend;
897
898 // Copy the line to newly allocated memory. get_one_sourceline()
899 // allocates 250 bytes per line, this saves 80% on average. The cost
900 // is an extra alloc/free.
901 p = vim_strsave(theline);
902 if (p == NULL)
903 goto theend;
904 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
905
906 // Add NULL lines for continuation lines, so that the line count is
907 // equal to the index in the growarray.
908 while (sourcing_lnum_off-- > 0)
909 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
910
911 // Check for end of eap->arg.
912 if (line_arg != NULL && *line_arg == NUL)
913 line_arg = NULL;
914 }
915
916 // Don't define the function when skipping commands or when an error was
917 // detected.
918 if (!eap->skip && !did_emsg)
919 ret = OK;
920
921theend:
922 vim_free(skip_until);
923 vim_free(heredoc_trimmed);
924 need_wait_return |= saved_wait_return;
925 return ret;
926}
927
928/*
929 * Handle the body of a lambda. *arg points to the "{", process statements
930 * until the matching "}".
931 * When successful "rettv" is set to a funcref.
932 */
933 static int
934lambda_function_body(
935 char_u **arg,
936 typval_T *rettv,
937 evalarg_T *evalarg,
938 garray_T *newargs,
939 garray_T *argtypes,
940 int varargs,
941 garray_T *default_args,
942 char_u *ret_type)
943{
944 int evaluate = evalarg != NULL
945 && (evalarg->eval_flags & EVAL_EVALUATE);
946 ufunc_T *ufunc;
947 exarg_T eap;
948 garray_T newlines;
949 char_u *cmdline = NULL;
950 int ret = FAIL;
951 char_u *line_to_free = NULL;
952 partial_T *pt;
953 char_u *name;
954 int lnum_save = -1;
955 linenr_T sourcing_lnum_top = SOURCING_LNUM;
956
957 CLEAR_FIELD(eap);
958 eap.cmdidx = CMD_block;
959 eap.forceit = FALSE;
960 eap.arg = *arg + 1;
961 eap.cmdlinep = &cmdline;
962 eap.skip = !evaluate;
963 if (evalarg->eval_cctx != NULL)
964 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
965 else
966 {
967 eap.getline = evalarg->eval_getline;
968 eap.cookie = evalarg->eval_cookie;
969 }
970
971 ga_init2(&newlines, (int)sizeof(char_u *), 10);
972 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
973 goto erret;
974 if (cmdline != NULL)
975 {
976 // Something comes after the "}".
977 *arg = eap.nextcmd;
978 if (evalarg->eval_cctx == NULL)
979 {
980 // Need to keep the line and free it/ later.
981 vim_free(evalarg->eval_tofree_lambda);
982 evalarg->eval_tofree_lambda = cmdline;
983 }
984 }
985 else
986 *arg = (char_u *)"";
987
988 name = get_lambda_name();
989 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
990 if (ufunc == NULL)
991 goto erret;
992 set_ufunc_name(ufunc, name);
993 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
994 {
995 vim_free(ufunc);
996 goto erret;
997 }
998 ufunc->uf_refcount = 1;
999 ufunc->uf_args = *newargs;
1000 newargs->ga_data = NULL;
1001 ufunc->uf_def_args = *default_args;
1002 default_args->ga_data = NULL;
1003 ufunc->uf_func_type = &t_func_any;
1004
1005 // error messages are for the first function line
1006 lnum_save = SOURCING_LNUM;
1007 SOURCING_LNUM = sourcing_lnum_top;
1008
1009 // parse argument types
1010 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1011 {
1012 SOURCING_LNUM = lnum_save;
1013 goto erret;
1014 }
1015
1016 // parse the return type, if any
1017 if (parse_return_type(ufunc, ret_type) == FAIL)
1018 goto erret;
1019
1020 pt = ALLOC_CLEAR_ONE(partial_T);
1021 if (pt == NULL)
1022 goto erret;
1023 pt->pt_func = ufunc;
1024 pt->pt_refcount = 1;
1025
1026 ufunc->uf_lines = newlines;
1027 newlines.ga_data = NULL;
1028 if (sandbox)
1029 ufunc->uf_flags |= FC_SANDBOX;
1030 if (!ASCII_ISUPPER(*ufunc->uf_name))
1031 ufunc->uf_flags |= FC_VIM9;
1032 ufunc->uf_script_ctx = current_sctx;
1033 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1034 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1035 set_function_type(ufunc);
1036
1037 rettv->vval.v_partial = pt;
1038 rettv->v_type = VAR_PARTIAL;
1039 ret = OK;
1040
1041erret:
1042 if (lnum_save >= 0)
1043 SOURCING_LNUM = lnum_save;
1044 vim_free(line_to_free);
1045 ga_clear_strings(&newlines);
1046 ga_clear_strings(newargs);
1047 ga_clear_strings(default_args);
1048 return ret;
1049}
1050
1051/*
1052 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001053 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001054 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001055 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1056 */
1057 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001058get_lambda_tv(
1059 char_u **arg,
1060 typval_T *rettv,
1061 int types_optional,
1062 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001063{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001064 int evaluate = evalarg != NULL
1065 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001066 garray_T newargs;
1067 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001068 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001069 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001070 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001071 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001072 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001073 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001074 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001075 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001076 char_u *s;
1077 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001078 int *old_eval_lavars = eval_lavars_used;
1079 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001080 char_u *tofree1 = NULL;
1081 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001082 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001083 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001084 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001085
1086 if (equal_arrow && !in_vim9script())
1087 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001088
1089 ga_init(&newargs);
1090 ga_init(&newlines);
1091
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001092 // First, check if this is really a lambda expression. "->" or "=>" must
1093 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001094 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001095 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001096 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001097 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001098 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001099 {
1100 if (types_optional)
1101 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001102 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001103 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001104
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001105 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001106 if (evaluate)
1107 pnewargs = &newargs;
1108 else
1109 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001110 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001111 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001112 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001113 &varargs, &default_args,
1114 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001115 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001116 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001117 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001118 {
1119 if (types_optional)
1120 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001121 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001122 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001123 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001124 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001125
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001126 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1127 if (ret_type != NULL)
1128 {
1129 ret_type = vim_strsave(ret_type);
1130 tofree2 = ret_type;
1131 }
1132
Bram Moolenaare38eab22019-12-05 21:50:01 +01001133 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001134 if (evaluate)
1135 eval_lavars_used = &eval_lavars;
1136
Bram Moolenaar65c44152020-12-24 15:14:01 +01001137 *arg = skipwhite_and_linebreak(*arg, evalarg);
1138
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001139 // Recognize "{" as the start of a function body.
1140 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001141 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1143 types_optional ? &argtypes : NULL, varargs,
1144 &default_args, ret_type) == FAIL)
1145 goto errret;
1146 goto theend;
1147 }
1148 if (default_args.ga_len > 0)
1149 {
1150 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001151 goto errret;
1152 }
1153
Bram Moolenaare38eab22019-12-05 21:50:01 +01001154 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001155 start = *arg;
1156 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001157 if (ret == FAIL)
1158 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001159 if (evalarg != NULL)
1160 {
1161 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001162 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001163 evalarg->eval_tofree = NULL;
1164 }
1165
Bram Moolenaar65c44152020-12-24 15:14:01 +01001166 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001167 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001168 *arg = skipwhite_and_linebreak(*arg, evalarg);
1169 if (**arg != '}')
1170 {
1171 semsg(_("E451: Expected }: %s"), *arg);
1172 goto errret;
1173 }
1174 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001175 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001176
1177 if (evaluate)
1178 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001179 int len;
1180 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001181 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001182 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001183
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001184 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001185 if (fp == NULL)
1186 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001187 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001188 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001189 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001190 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001191
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001192 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1193 if (ga_grow(&newlines, 1) == FAIL)
1194 goto errret;
1195
Bram Moolenaare38eab22019-12-05 21:50:01 +01001196 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001197 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001198 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001199 if (p == NULL)
1200 goto errret;
1201 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1202 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001203 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001204 if (strstr((char *)p + 7, "a:") == NULL)
1205 // No a: variables are used for sure.
1206 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001207
1208 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001209 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001210 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001211 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001212 if (types_optional)
1213 {
1214 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
1215 goto errret;
1216 if (ret_type != NULL)
1217 {
1218 fp->uf_ret_type = parse_type(&ret_type,
1219 &fp->uf_type_list, TRUE);
1220 if (fp->uf_ret_type == NULL)
1221 goto errret;
1222 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001223 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001224 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001225 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001226
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001227 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001228 if (current_funccal != NULL && eval_lavars)
1229 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001230 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001231 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001232 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001233 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001234
1235#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001236 if (prof_def_func())
1237 func_do_profile(fp);
1238#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001239 if (sandbox)
1240 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001241 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001242 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001243 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001244 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001245 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001246 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001247
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001248 pt->pt_func = fp;
1249 pt->pt_refcount = 1;
1250 rettv->vval.v_partial = pt;
1251 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001252
1253 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001254 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001255
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001256theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001257 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001258 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001259 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001260 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001261 vim_free(tofree1);
1262 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001263 if (types_optional)
1264 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001265 return OK;
1266
1267errret:
1268 ga_clear_strings(&newargs);
1269 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001270 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001271 if (types_optional)
1272 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001273 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001274 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001275 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001276 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001277 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001278 vim_free(tofree1);
1279 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001280 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001281 return FAIL;
1282}
1283
1284/*
1285 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1286 * name it contains, otherwise return "name".
1287 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1288 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001289 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1290 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001291 */
1292 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001293deref_func_name(
1294 char_u *name,
1295 int *lenp,
1296 partial_T **partialp,
1297 type_T **type,
1298 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001299{
1300 dictitem_T *v;
1301 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001302 char_u *s = NULL;
1303 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001304
1305 if (partialp != NULL)
1306 *partialp = NULL;
1307
1308 cc = name[*lenp];
1309 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001310 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001311 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001312 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001313 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001314 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001315 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001316 if (v->di_tv.vval.v_string == NULL)
1317 {
1318 *lenp = 0;
1319 return (char_u *)""; // just in case
1320 }
1321 s = v->di_tv.vval.v_string;
1322 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001323 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001325 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001326 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001327 partial_T *pt = v->di_tv.vval.v_partial;
1328
1329 if (pt == NULL)
1330 {
1331 *lenp = 0;
1332 return (char_u *)""; // just in case
1333 }
1334 if (partialp != NULL)
1335 *partialp = pt;
1336 s = partial_name(pt);
1337 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001338 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001339
1340 if (s != NULL)
1341 {
1342 if (type != NULL && ht == get_script_local_ht())
1343 {
1344 svar_T *sv = find_typval_in_script(&v->di_tv);
1345
1346 if (sv != NULL)
1347 *type = sv->sv_type;
1348 }
1349 return s;
1350 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001351 }
1352
1353 return name;
1354}
1355
1356/*
1357 * Give an error message with a function name. Handle <SNR> things.
1358 * "ermsg" is to be passed without translation, use N_() instead of _().
1359 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001360 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001361emsg_funcname(char *ermsg, char_u *name)
1362{
1363 char_u *p;
1364
1365 if (*name == K_SPECIAL)
1366 p = concat_str((char_u *)"<SNR>", name + 3);
1367 else
1368 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001369 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001370 if (p != name)
1371 vim_free(p);
1372}
1373
1374/*
1375 * Allocate a variable for the result of a function.
1376 * Return OK or FAIL.
1377 */
1378 int
1379get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001380 char_u *name, // name of the function
1381 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001382 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001383 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001384 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001385 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001386{
1387 char_u *argp;
1388 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001389 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1390 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001391 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392
1393 /*
1394 * Get the arguments.
1395 */
1396 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001397 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1398 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001400 // skip the '(' or ',' and possibly line breaks
1401 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1402
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001403 if (*argp == ')' || *argp == ',' || *argp == NUL)
1404 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001405 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001406 {
1407 ret = FAIL;
1408 break;
1409 }
1410 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001411 // The comma should come right after the argument, but this wasn't
1412 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001413 if (vim9script)
1414 {
1415 if (*argp != ',' && *skipwhite(argp) == ',')
1416 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001417 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001418 ret = FAIL;
1419 break;
1420 }
1421 }
1422 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001423 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001424 if (*argp != ',')
1425 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001426 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1427 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001428 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001429 ret = FAIL;
1430 break;
1431 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001432 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001433 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001434 if (*argp == ')')
1435 ++argp;
1436 else
1437 ret = FAIL;
1438
1439 if (ret == OK)
1440 {
1441 int i = 0;
1442
1443 if (get_vim_var_nr(VV_TESTING))
1444 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001445 // Prepare for calling test_garbagecollect_now(), need to know
1446 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001447 if (funcargs.ga_itemsize == 0)
1448 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1449 for (i = 0; i < argcount; ++i)
1450 if (ga_grow(&funcargs, 1) == OK)
1451 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1452 &argvars[i];
1453 }
1454
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001455 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456
1457 funcargs.ga_len -= i;
1458 }
1459 else if (!aborting())
1460 {
1461 if (argcount == MAX_FUNC_ARGS)
1462 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1463 else
1464 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1465 }
1466
1467 while (--argcount >= 0)
1468 clear_tv(&argvars[argcount]);
1469
Bram Moolenaar8294d492020-08-10 22:40:56 +02001470 if (in_vim9script())
1471 *arg = argp;
1472 else
1473 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001474 return ret;
1475}
1476
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477/*
1478 * Return TRUE if "p" starts with "<SID>" or "s:".
1479 * Only works if eval_fname_script() returned non-zero for "p"!
1480 */
1481 static int
1482eval_fname_sid(char_u *p)
1483{
1484 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1485}
1486
1487/*
1488 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1489 * Change <SNR>123_name() to K_SNR 123_name().
1490 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1491 * (slow).
1492 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001493 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1495{
1496 int llen;
1497 char_u *fname;
1498 int i;
1499
1500 llen = eval_fname_script(name);
1501 if (llen > 0)
1502 {
1503 fname_buf[0] = K_SPECIAL;
1504 fname_buf[1] = KS_EXTRA;
1505 fname_buf[2] = (int)KE_SNR;
1506 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001507 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001508 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001509 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001510 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001511 else
1512 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001513 sprintf((char *)fname_buf + 3, "%ld_",
1514 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001515 i = (int)STRLEN(fname_buf);
1516 }
1517 }
1518 if (i + STRLEN(name + llen) < FLEN_FIXED)
1519 {
1520 STRCPY(fname_buf + i, name + llen);
1521 fname = fname_buf;
1522 }
1523 else
1524 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001525 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001526 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001527 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001528 else
1529 {
1530 *tofree = fname;
1531 mch_memmove(fname, fname_buf, (size_t)i);
1532 STRCPY(fname + i, name + llen);
1533 }
1534 }
1535 }
1536 else
1537 fname = name;
1538 return fname;
1539}
1540
1541/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001542 * Find a function "name" in script "sid".
1543 */
1544 static ufunc_T *
1545find_func_with_sid(char_u *name, int sid)
1546{
1547 hashitem_T *hi;
1548 char_u buffer[200];
1549
1550 buffer[0] = K_SPECIAL;
1551 buffer[1] = KS_EXTRA;
1552 buffer[2] = (int)KE_SNR;
1553 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1554 (long)sid, name);
1555 hi = hash_find(&func_hashtab, buffer);
1556 if (!HASHITEM_EMPTY(hi))
1557 return HI2UF(hi);
1558
1559 return NULL;
1560}
1561
1562/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001564 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565 * Return NULL for unknown function.
1566 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001567 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001568find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569{
1570 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001571 ufunc_T *func;
1572 imported_T *imported;
1573
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001574 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001575 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001576 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001577 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001578 int find_script_local = in_vim9script()
1579 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001580
Bram Moolenaar95006e32020-08-29 17:47:08 +02001581 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001582 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001583 // Find script-local function before global one.
1584 func = find_func_with_sid(name, current_sctx.sc_sid);
1585 if (func != NULL)
1586 return func;
1587 }
1588
Bram Moolenaarefa94442020-08-08 22:16:00 +02001589 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001590 && name[1] == KS_EXTRA
1591 && name[2] == KE_SNR)
1592 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001593 // Caller changes s: to <SNR>99_name.
1594
1595 after_script = name + 3;
1596 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001597 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001598 ++after_script;
1599 else
1600 after_script = NULL;
1601 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001602 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001603 {
1604 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001605 if (after_script != NULL && sid != current_sctx.sc_sid)
1606 imported = find_imported_in_script(after_script, 0, sid);
1607 else
1608 imported = find_imported(after_script == NULL
1609 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001610 if (imported != NULL && imported->imp_funcname != NULL)
1611 {
1612 hi = hash_find(&func_hashtab, imported->imp_funcname);
1613 if (!HASHITEM_EMPTY(hi))
1614 return HI2UF(hi);
1615 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001616 }
1617 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001618
Bram Moolenaara26b9702020-04-18 19:53:28 +02001619 hi = hash_find(&func_hashtab,
1620 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001621 if (!HASHITEM_EMPTY(hi))
1622 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001623
1624 return NULL;
1625}
1626
1627/*
1628 * Find a function by name, return pointer to it in ufuncs.
1629 * "cctx" is passed in a :def function to find imported functions.
1630 * Return NULL for unknown or dead function.
1631 */
1632 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001633find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001634{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001635 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001636
1637 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1638 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 return NULL;
1640}
1641
1642/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001643 * Return TRUE if "ufunc" is a global function.
1644 */
1645 int
1646func_is_global(ufunc_T *ufunc)
1647{
1648 return ufunc->uf_name[0] != K_SPECIAL;
1649}
1650
1651/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 * Copy the function name of "fp" to buffer "buf".
1653 * "buf" must be able to hold the function name plus three bytes.
1654 * Takes care of script-local function names.
1655 */
1656 static void
1657cat_func_name(char_u *buf, ufunc_T *fp)
1658{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001659 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001660 {
1661 STRCPY(buf, "<SNR>");
1662 STRCAT(buf, fp->uf_name + 3);
1663 }
1664 else
1665 STRCPY(buf, fp->uf_name);
1666}
1667
1668/*
1669 * Add a number variable "name" to dict "dp" with value "nr".
1670 */
1671 static void
1672add_nr_var(
1673 dict_T *dp,
1674 dictitem_T *v,
1675 char *name,
1676 varnumber_T nr)
1677{
1678 STRCPY(v->di_key, name);
1679 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1680 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1681 v->di_tv.v_type = VAR_NUMBER;
1682 v->di_tv.v_lock = VAR_FIXED;
1683 v->di_tv.vval.v_number = nr;
1684}
1685
1686/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001687 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001688 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001689 static void
1690free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001691{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001692 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001693
1694 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1695 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001696 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001697
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001698 // When garbage collecting a funccall_T may be freed before the
1699 // function that references it, clear its uf_scoped field.
1700 // The function may have been redefined and point to another
1701 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001702 if (fp != NULL && fp->uf_scoped == fc)
1703 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001704 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001705 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001706
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001707 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 vim_free(fc);
1709}
1710
1711/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001712 * Free "fc" and what it contains.
1713 * Can be called only when "fc" is kept beyond the period of it called,
1714 * i.e. after cleanup_function_call(fc).
1715 */
1716 static void
1717free_funccal_contents(funccall_T *fc)
1718{
1719 listitem_T *li;
1720
1721 // Free all l: variables.
1722 vars_clear(&fc->l_vars.dv_hashtab);
1723
1724 // Free all a: variables.
1725 vars_clear(&fc->l_avars.dv_hashtab);
1726
1727 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001728 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001729 clear_tv(&li->li_tv);
1730
1731 free_funccal(fc);
1732}
1733
1734/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001735 * Handle the last part of returning from a function: free the local hashtable.
1736 * Unless it is still in use by a closure.
1737 */
1738 static void
1739cleanup_function_call(funccall_T *fc)
1740{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001741 int may_free_fc = fc->fc_refcount <= 0;
1742 int free_fc = TRUE;
1743
Bram Moolenaar6914c642017-04-01 21:21:30 +02001744 current_funccal = fc->caller;
1745
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001746 // Free all l: variables if not referred.
1747 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1748 vars_clear(&fc->l_vars.dv_hashtab);
1749 else
1750 free_fc = FALSE;
1751
1752 // If the a:000 list and the l: and a: dicts are not referenced and
1753 // there is no closure using it, we can free the funccall_T and what's
1754 // in it.
1755 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1756 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001757 else
1758 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001759 int todo;
1760 hashitem_T *hi;
1761 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001762
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001763 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001764
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001765 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001766 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1767 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1768 {
1769 if (!HASHITEM_EMPTY(hi))
1770 {
1771 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001772 di = HI2DI(hi);
1773 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001774 }
1775 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001776 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001777
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001778 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1779 fc->l_varlist.lv_first = NULL;
1780 else
1781 {
1782 listitem_T *li;
1783
1784 free_fc = FALSE;
1785
1786 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001787 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001788 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001789 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001790
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001791 if (free_fc)
1792 free_funccal(fc);
1793 else
1794 {
1795 static int made_copy = 0;
1796
1797 // "fc" is still in use. This can happen when returning "a:000",
1798 // assigning "l:" to a global variable or defining a closure.
1799 // Link "fc" in the list for garbage collection later.
1800 fc->caller = previous_funccal;
1801 previous_funccal = fc;
1802
1803 if (want_garbage_collect)
1804 // If garbage collector is ready, clear count.
1805 made_copy = 0;
1806 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001807 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001808 // We have made a lot of copies, worth 4 Mbyte. This can happen
1809 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001810 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001811 // too much memory.
1812 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001813 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001814 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001815 }
1816}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001817
1818/*
1819 * There are two kinds of function names:
1820 * 1. ordinary names, function defined with :function or :def
1821 * 2. numbered functions and lambdas
1822 * For the first we only count the name stored in func_hashtab as a reference,
1823 * using function() does not count as a reference, because the function is
1824 * looked up by name.
1825 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001826 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001827func_name_refcount(char_u *name)
1828{
1829 return isdigit(*name) || *name == '<';
1830}
1831
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001832/*
1833 * Unreference "fc": decrement the reference count and free it when it
1834 * becomes zero. "fp" is detached from "fc".
1835 * When "force" is TRUE we are exiting.
1836 */
1837 static void
1838funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1839{
1840 funccall_T **pfc;
1841 int i;
1842
1843 if (fc == NULL)
1844 return;
1845
1846 if (--fc->fc_refcount <= 0 && (force || (
1847 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1848 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1849 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1850 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1851 {
1852 if (fc == *pfc)
1853 {
1854 *pfc = fc->caller;
1855 free_funccal_contents(fc);
1856 return;
1857 }
1858 }
1859 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1860 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1861 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1862}
1863
1864/*
1865 * Remove the function from the function hashtable. If the function was
1866 * deleted while it still has references this was already done.
1867 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1868 */
1869 static int
1870func_remove(ufunc_T *fp)
1871{
1872 hashitem_T *hi;
1873
1874 // Return if it was already virtually deleted.
1875 if (fp->uf_flags & FC_DEAD)
1876 return FALSE;
1877
1878 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1879 if (!HASHITEM_EMPTY(hi))
1880 {
1881 // When there is a def-function index do not actually remove the
1882 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001883 // Do remove it when it's a copy.
1884 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001885 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001886 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001887 return FALSE;
1888 }
1889 hash_remove(&func_hashtab, hi);
1890 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001891 return TRUE;
1892 }
1893 return FALSE;
1894}
1895
1896 static void
1897func_clear_items(ufunc_T *fp)
1898{
1899 ga_clear_strings(&(fp->uf_args));
1900 ga_clear_strings(&(fp->uf_def_args));
1901 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001902 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001903 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001904 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001905 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001906 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001907
1908 // Increment the refcount of this function to avoid it being freed
1909 // recursively when the partial is freed.
1910 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001911 partial_unref(fp->uf_partial);
1912 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001913 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001914
1915#ifdef FEAT_LUA
1916 if (fp->uf_cb_free != NULL)
1917 {
1918 fp->uf_cb_free(fp->uf_cb_state);
1919 fp->uf_cb_free = NULL;
1920 }
1921
1922 fp->uf_cb_state = NULL;
1923 fp->uf_cb = NULL;
1924#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001925#ifdef FEAT_PROFILE
1926 VIM_CLEAR(fp->uf_tml_count);
1927 VIM_CLEAR(fp->uf_tml_total);
1928 VIM_CLEAR(fp->uf_tml_self);
1929#endif
1930}
1931
1932/*
1933 * Free all things that a function contains. Does not free the function
1934 * itself, use func_free() for that.
1935 * When "force" is TRUE we are exiting.
1936 */
1937 static void
1938func_clear(ufunc_T *fp, int force)
1939{
1940 if (fp->uf_cleared)
1941 return;
1942 fp->uf_cleared = TRUE;
1943
1944 // clear this function
1945 func_clear_items(fp);
1946 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001947 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948}
1949
1950/*
1951 * Free a function and remove it from the list of functions. Does not free
1952 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001953 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001954 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001956 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001957func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001958{
1959 // Only remove it when not done already, otherwise we would remove a newer
1960 // version of the function with the same name.
1961 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1962 func_remove(fp);
1963
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001964 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001965 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001966 if (fp->uf_dfunc_idx > 0)
1967 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001968 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001969 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001970 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001971 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001972 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001973}
1974
1975/*
1976 * Free all things that a function contains and free the function itself.
1977 * When "force" is TRUE we are exiting.
1978 */
1979 static void
1980func_clear_free(ufunc_T *fp, int force)
1981{
1982 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001983 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1984 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001985 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001986 else
1987 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001988}
1989
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001990/*
1991 * Copy already defined function "lambda" to a new function with name "global".
1992 * This is for when a compiled function defines a global function.
1993 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001994 int
1995copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001996{
1997 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001998 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001999
2000 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002001 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002002 semsg(_(e_lambda_function_not_found_str), lambda);
2003 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002004 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002005
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002006 fp = find_func(global, TRUE, NULL);
2007 if (fp != NULL)
2008 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002009 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002010 semsg(_(e_funcexts), global);
2011 return FAIL;
2012 }
2013
2014 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2015 if (fp == NULL)
2016 return FAIL;
2017
2018 fp->uf_varargs = ufunc->uf_varargs;
2019 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2020 fp->uf_def_status = ufunc->uf_def_status;
2021 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2022 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2023 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2024 == FAIL
2025 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2026 goto failed;
2027
2028 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2029 : vim_strsave(ufunc->uf_name_exp);
2030 if (ufunc->uf_arg_types != NULL)
2031 {
2032 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2033 if (fp->uf_arg_types == NULL)
2034 goto failed;
2035 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2036 sizeof(type_T *) * fp->uf_args.ga_len);
2037 }
2038 if (ufunc->uf_def_arg_idx != NULL)
2039 {
2040 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
2041 if (fp->uf_def_arg_idx == NULL)
2042 goto failed;
2043 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
2044 sizeof(int) * fp->uf_def_args.ga_len + 1);
2045 }
2046 if (ufunc->uf_va_name != NULL)
2047 {
2048 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2049 if (fp->uf_va_name == NULL)
2050 goto failed;
2051 }
2052 fp->uf_ret_type = ufunc->uf_ret_type;
2053
2054 fp->uf_refcount = 1;
2055 STRCPY(fp->uf_name, global);
2056 hash_add(&func_hashtab, UF2HIKEY(fp));
2057
2058 // the referenced dfunc_T is now used one more time
2059 link_def_function(fp);
2060
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002061 // Create a partial to store the context of the function where it was
2062 // instantiated. Only needs to be done once. Do this on the original
2063 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002064 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2065 {
2066 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2067
2068 if (pt == NULL)
2069 goto failed;
2070 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002071 {
2072 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002073 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002074 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002075 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002076 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002077 }
2078
2079 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002080
2081failed:
2082 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002083 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002084}
2085
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002086static int funcdepth = 0;
2087
2088/*
2089 * Increment the function call depth count.
2090 * Return FAIL when going over 'maxfuncdepth'.
2091 * Otherwise return OK, must call funcdepth_decrement() later!
2092 */
2093 int
2094funcdepth_increment(void)
2095{
2096 if (funcdepth >= p_mfd)
2097 {
2098 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2099 return FAIL;
2100 }
2101 ++funcdepth;
2102 return OK;
2103}
2104
2105 void
2106funcdepth_decrement(void)
2107{
2108 --funcdepth;
2109}
2110
2111/*
2112 * Get the current function call depth.
2113 */
2114 int
2115funcdepth_get(void)
2116{
2117 return funcdepth;
2118}
2119
2120/*
2121 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002122 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002123 * times as funcdepth_increment().
2124 */
2125 void
2126funcdepth_restore(int depth)
2127{
2128 funcdepth = depth;
2129}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002130
2131/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002132 * Call a user function.
2133 */
2134 static void
2135call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002136 ufunc_T *fp, // pointer to function
2137 int argcount, // nr of args
2138 typval_T *argvars, // arguments
2139 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002140 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002141 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002142{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002143 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002144 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002145 funccall_T *fc;
2146 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002147 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002148 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002149 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002150 int i;
2151 int ai;
2152 int islambda = FALSE;
2153 char_u numbuf[NUMBUFLEN];
2154 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002155#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002156 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002157#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002158 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159
Bram Moolenaarb2049902021-01-24 12:53:53 +01002160#ifdef FEAT_PROFILE
2161 CLEAR_FIELD(profile_info);
2162#endif
2163
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002164 // If depth of calling is getting too high, don't execute the function.
2165 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002166 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002167 rettv->v_type = VAR_NUMBER;
2168 rettv->vval.v_number = -1;
2169 return;
2170 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002171
Bram Moolenaare38eab22019-12-05 21:50:01 +01002172 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002173
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002174 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002175 if (fc == NULL)
2176 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002177 fc->caller = current_funccal;
2178 current_funccal = fc;
2179 fc->func = fp;
2180 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002181 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002182 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2184 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002185 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002186 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002187 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002188
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002189 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002190 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002191#ifdef FEAT_PROFILE
2192 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2193#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002194 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002195#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002196 if (do_profiling == PROF_YES)
2197 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002198#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002199 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002200 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002201#ifdef FEAT_PROFILE
2202 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002203 || (caller != NULL && caller->uf_profiling)))
2204 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002205#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002206 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002207 free_funccal(fc);
2208 return;
2209 }
2210
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002211 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2212 islambda = TRUE;
2213
2214 /*
2215 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2216 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2217 * each argument variable and saves a lot of time.
2218 */
2219 /*
2220 * Init l: variables.
2221 */
2222 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2223 if (selfdict != NULL)
2224 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002225 // Set l:self to "selfdict". Use "name" to avoid a warning from
2226 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002227 v = &fc->fixvar[fixvar_idx++].var;
2228 name = v->di_key;
2229 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002230 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002231 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2232 v->di_tv.v_type = VAR_DICT;
2233 v->di_tv.v_lock = 0;
2234 v->di_tv.vval.v_dict = selfdict;
2235 ++selfdict->dv_refcount;
2236 }
2237
2238 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002239 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002240 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002241 * Set a:000 to a list with room for the "..." arguments.
2242 */
2243 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002244 if ((fp->uf_flags & FC_NOARGS) == 0)
2245 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002246 (varnumber_T)(argcount >= fp->uf_args.ga_len
2247 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002248 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002249 if ((fp->uf_flags & FC_NOARGS) == 0)
2250 {
2251 // Use "name" to avoid a warning from some compiler that checks the
2252 // destination size.
2253 v = &fc->fixvar[fixvar_idx++].var;
2254 name = v->di_key;
2255 STRCPY(name, "000");
2256 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2257 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2258 v->di_tv.v_type = VAR_LIST;
2259 v->di_tv.v_lock = VAR_FIXED;
2260 v->di_tv.vval.v_list = &fc->l_varlist;
2261 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002262 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002263 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2264 fc->l_varlist.lv_lock = VAR_FIXED;
2265
2266 /*
2267 * Set a:firstline to "firstline" and a:lastline to "lastline".
2268 * Set a:name to named arguments.
2269 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002270 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002271 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002272 if ((fp->uf_flags & FC_NOARGS) == 0)
2273 {
2274 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002275 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002276 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002277 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002278 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002279 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002280 {
2281 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002282 typval_T def_rettv;
2283 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002284
2285 ai = i - fp->uf_args.ga_len;
2286 if (ai < 0)
2287 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002288 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289 name = FUNCARG(fp, i);
2290 if (islambda)
2291 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002292
2293 // evaluate named argument default expression
2294 isdefault = ai + fp->uf_def_args.ga_len >= 0
2295 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2296 && argvars[i].vval.v_number == VVAL_NONE));
2297 if (isdefault)
2298 {
2299 char_u *default_expr = NULL;
2300 def_rettv.v_type = VAR_NUMBER;
2301 def_rettv.vval.v_number = -1;
2302
2303 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2304 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002305 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002306 {
2307 default_arg_err = 1;
2308 break;
2309 }
2310 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002311 }
2312 else
2313 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002314 if ((fp->uf_flags & FC_NOARGS) != 0)
2315 // Bail out if no a: arguments used (in lambda).
2316 break;
2317
Bram Moolenaare38eab22019-12-05 21:50:01 +01002318 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002319 sprintf((char *)numbuf, "%d", ai + 1);
2320 name = numbuf;
2321 }
2322 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2323 {
2324 v = &fc->fixvar[fixvar_idx++].var;
2325 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002326 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002327 }
2328 else
2329 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002330 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002331 if (v == NULL)
2332 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002333 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002334 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002335
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002336 // Note: the values are copied directly to avoid alloc/free.
2337 // "argvars" must have VAR_FIXED for v_lock.
2338 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002339 v->di_tv.v_lock = VAR_FIXED;
2340
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341 if (addlocal)
2342 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002343 // Named arguments should be accessed without the "a:" prefix in
2344 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002345 copy_tv(&v->di_tv, &v->di_tv);
2346 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002348 else
2349 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350
2351 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2352 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002353 listitem_T *li = &fc->l_listitems[ai];
2354
2355 li->li_tv = argvars[i];
2356 li->li_tv.v_lock = VAR_FIXED;
2357 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002358 }
2359 }
2360
Bram Moolenaare38eab22019-12-05 21:50:01 +01002361 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002362 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002363
2364 if (fp->uf_flags & FC_SANDBOX)
2365 {
2366 using_sandbox = TRUE;
2367 ++sandbox;
2368 }
2369
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002370 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002371 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002372 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002373 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002374 ++no_wait_return;
2375 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002376
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002377 smsg(_("calling %s"), SOURCING_NAME);
2378 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002380 char_u buf[MSG_BUF_LEN];
2381 char_u numbuf2[NUMBUFLEN];
2382 char_u *tofree;
2383 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002384
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002385 msg_puts("(");
2386 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002387 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002388 if (i > 0)
2389 msg_puts(", ");
2390 if (argvars[i].v_type == VAR_NUMBER)
2391 msg_outnum((long)argvars[i].vval.v_number);
2392 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002394 // Do not want errors such as E724 here.
2395 ++emsg_off;
2396 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2397 --emsg_off;
2398 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002400 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002401 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002402 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2403 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002404 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002405 msg_puts((char *)s);
2406 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 }
2408 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002409 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002410 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002411 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002412 msg_puts("\n"); // don't overwrite this either
2413
2414 verbose_leave_scroll();
2415 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 }
2417#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002418 if (do_profiling == PROF_YES)
2419 profile_may_start_func(&profile_info, fp,
2420 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002421#endif
2422
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002423 save_current_sctx = current_sctx;
2424 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425 save_did_emsg = did_emsg;
2426 did_emsg = FALSE;
2427
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002428 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2429 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002430 else if (islambda)
2431 {
2432 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2433
2434 // A Lambda always has the command "return {expr}". It is much faster
2435 // to evaluate {expr} directly.
2436 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002437 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002438 --ex_nesting_level;
2439 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002440 else
2441 // call do_cmdline() to execute the lines
2442 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002443 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2444
2445 --RedrawingDisabled;
2446
Bram Moolenaare38eab22019-12-05 21:50:01 +01002447 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002448 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2449 {
2450 clear_tv(rettv);
2451 rettv->v_type = VAR_NUMBER;
2452 rettv->vval.v_number = -1;
2453 }
2454
2455#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002456 if (do_profiling == PROF_YES)
2457 {
2458 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2459
2460 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2461 profile_may_end_func(&profile_info, fp, caller);
2462 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002463#endif
2464
Bram Moolenaare38eab22019-12-05 21:50:01 +01002465 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002466 if (p_verbose >= 12)
2467 {
2468 ++no_wait_return;
2469 verbose_enter_scroll();
2470
2471 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002472 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002473 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002474 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 (long)fc->rettv->vval.v_number);
2476 else
2477 {
2478 char_u buf[MSG_BUF_LEN];
2479 char_u numbuf2[NUMBUFLEN];
2480 char_u *tofree;
2481 char_u *s;
2482
Bram Moolenaare38eab22019-12-05 21:50:01 +01002483 // The value may be very long. Skip the middle part, so that we
2484 // have some idea how it starts and ends. smsg() would always
2485 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002486 ++emsg_off;
2487 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2488 --emsg_off;
2489 if (s != NULL)
2490 {
2491 if (vim_strsize(s) > MSG_BUF_CLEN)
2492 {
2493 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2494 s = buf;
2495 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002496 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002497 vim_free(tofree);
2498 }
2499 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002500 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002501
2502 verbose_leave_scroll();
2503 --no_wait_return;
2504 }
2505
Bram Moolenaare31ee862020-01-07 20:59:34 +01002506 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002507 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002508 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002509#ifdef FEAT_PROFILE
2510 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002511 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002512#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002513 if (using_sandbox)
2514 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002516 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002517 {
2518 ++no_wait_return;
2519 verbose_enter_scroll();
2520
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002521 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002522 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523
2524 verbose_leave_scroll();
2525 --no_wait_return;
2526 }
2527
2528 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002529 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002530 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002531}
2532
2533/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002534 * Check the argument count for user function "fp".
2535 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2536 */
2537 int
2538check_user_func_argcount(ufunc_T *fp, int argcount)
2539{
2540 int regular_args = fp->uf_args.ga_len;
2541
2542 if (argcount < regular_args - fp->uf_def_args.ga_len)
2543 return FCERR_TOOFEW;
2544 else if (!has_varargs(fp) && argcount > regular_args)
2545 return FCERR_TOOMANY;
2546 return FCERR_UNKNOWN;
2547}
2548
2549/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002550 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002551 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002552 int
2553call_user_func_check(
2554 ufunc_T *fp,
2555 int argcount,
2556 typval_T *argvars,
2557 typval_T *rettv,
2558 funcexe_T *funcexe,
2559 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002560{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002561 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002562
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002563 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2564 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002565 error = check_user_func_argcount(fp, argcount);
2566 if (error != FCERR_UNKNOWN)
2567 return error;
2568 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002569 error = FCERR_DICT;
2570 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002571 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002572 int did_save_redo = FALSE;
2573 save_redo_T save_redo;
2574
2575 /*
2576 * Call the user function.
2577 * Save and restore search patterns, script variables and
2578 * redo buffer.
2579 */
2580 save_search_patterns();
2581 if (!ins_compl_active())
2582 {
2583 saveRedobuff(&save_redo);
2584 did_save_redo = TRUE;
2585 }
2586 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002587 call_user_func(fp, argcount, argvars, rettv, funcexe,
2588 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002589 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2590 // Function was unreferenced while being used, free it now.
2591 func_clear_free(fp, FALSE);
2592 if (did_save_redo)
2593 restoreRedobuff(&save_redo);
2594 restore_search_patterns();
2595 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002596 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002597 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002598}
2599
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002600static funccal_entry_T *funccal_stack = NULL;
2601
2602/*
2603 * Save the current function call pointer, and set it to NULL.
2604 * Used when executing autocommands and for ":source".
2605 */
2606 void
2607save_funccal(funccal_entry_T *entry)
2608{
2609 entry->top_funccal = current_funccal;
2610 entry->next = funccal_stack;
2611 funccal_stack = entry;
2612 current_funccal = NULL;
2613}
2614
2615 void
2616restore_funccal(void)
2617{
2618 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002619 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002620 else
2621 {
2622 current_funccal = funccal_stack->top_funccal;
2623 funccal_stack = funccal_stack->next;
2624 }
2625}
2626
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002627 funccall_T *
2628get_current_funccal(void)
2629{
2630 return current_funccal;
2631}
2632
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002633/*
2634 * Mark all functions of script "sid" as deleted.
2635 */
2636 void
2637delete_script_functions(int sid)
2638{
2639 hashitem_T *hi;
2640 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002641 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002642 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002643 size_t len;
2644
2645 buf[0] = K_SPECIAL;
2646 buf[1] = KS_EXTRA;
2647 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002648 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002649 len = STRLEN(buf);
2650
Bram Moolenaarce658352020-07-31 23:47:12 +02002651 while (todo > 0)
2652 {
2653 todo = func_hashtab.ht_used;
2654 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2655 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002656 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002657 fp = HI2UF(hi);
2658 if (STRNCMP(fp->uf_name, buf, len) == 0)
2659 {
2660 int changed = func_hashtab.ht_changed;
2661
2662 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002663
2664 if (fp->uf_calls > 0)
2665 {
2666 // Function is executing, don't free it but do remove
2667 // it from the hashtable.
2668 if (func_remove(fp))
2669 fp->uf_refcount--;
2670 }
2671 else
2672 {
2673 func_clear(fp, TRUE);
2674 // When clearing a function another function can be
2675 // cleared as a side effect. When that happens start
2676 // over.
2677 if (changed != func_hashtab.ht_changed)
2678 break;
2679 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002680 }
2681 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002682 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002683 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002684}
2685
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002686#if defined(EXITFREE) || defined(PROTO)
2687 void
2688free_all_functions(void)
2689{
2690 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002691 ufunc_T *fp;
2692 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002693 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002694 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695
Bram Moolenaare38eab22019-12-05 21:50:01 +01002696 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002697 while (current_funccal != NULL)
2698 {
2699 clear_tv(current_funccal->rettv);
2700 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002701 if (current_funccal == NULL && funccal_stack != NULL)
2702 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002703 }
2704
Bram Moolenaare38eab22019-12-05 21:50:01 +01002705 // First clear what the functions contain. Since this may lower the
2706 // reference count of a function, it may also free a function and change
2707 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002708 while (todo > 0)
2709 {
2710 todo = func_hashtab.ht_used;
2711 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2712 if (!HASHITEM_EMPTY(hi))
2713 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002714 // clear the def function index now
2715 fp = HI2UF(hi);
2716 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002717 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002718
Bram Moolenaare38eab22019-12-05 21:50:01 +01002719 // Only free functions that are not refcounted, those are
2720 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002721 if (func_name_refcount(fp->uf_name))
2722 ++skipped;
2723 else
2724 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002725 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002726 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002727 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002728 {
2729 skipped = 0;
2730 break;
2731 }
2732 }
2733 --todo;
2734 }
2735 }
2736
Bram Moolenaare38eab22019-12-05 21:50:01 +01002737 // Now actually free the functions. Need to start all over every time,
2738 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002739 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002740 while (func_hashtab.ht_used > skipped)
2741 {
2742 todo = func_hashtab.ht_used;
2743 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002744 if (!HASHITEM_EMPTY(hi))
2745 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002746 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002747 // Only free functions that are not refcounted, those are
2748 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002749 fp = HI2UF(hi);
2750 if (func_name_refcount(fp->uf_name))
2751 ++skipped;
2752 else
2753 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002754 if (func_free(fp, FALSE) == OK)
2755 {
2756 skipped = 0;
2757 break;
2758 }
2759 // did not actually free it
2760 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002763 }
2764 if (skipped == 0)
2765 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002766
2767 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768}
2769#endif
2770
2771/*
2772 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002773 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774 * "len" is the length of "name", or -1 for NUL terminated.
2775 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002776 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777builtin_function(char_u *name, int len)
2778{
2779 char_u *p;
2780
Bram Moolenaara26b9702020-04-18 19:53:28 +02002781 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 return FALSE;
2783 p = vim_strchr(name, AUTOLOAD_CHAR);
2784 return p == NULL || (len > 0 && p > name + len);
2785}
2786
2787 int
2788func_call(
2789 char_u *name,
2790 typval_T *args,
2791 partial_T *partial,
2792 dict_T *selfdict,
2793 typval_T *rettv)
2794{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002795 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 listitem_T *item;
2797 typval_T argv[MAX_FUNC_ARGS + 1];
2798 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002799 int r = 0;
2800
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002801 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002802 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 {
2804 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2805 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002806 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002807 break;
2808 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002809 // Make a copy of each argument. This is needed to be able to set
2810 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002811 copy_tv(&item->li_tv, &argv[argc++]);
2812 }
2813
2814 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002815 {
2816 funcexe_T funcexe;
2817
Bram Moolenaara80faa82020-04-12 19:37:17 +02002818 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002819 funcexe.firstline = curwin->w_cursor.lnum;
2820 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002821 funcexe.evaluate = TRUE;
2822 funcexe.partial = partial;
2823 funcexe.selfdict = selfdict;
2824 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826
Bram Moolenaare38eab22019-12-05 21:50:01 +01002827 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828 while (argc > 0)
2829 clear_tv(&argv[--argc]);
2830
2831 return r;
2832}
2833
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002834static int callback_depth = 0;
2835
2836 int
2837get_callback_depth(void)
2838{
2839 return callback_depth;
2840}
2841
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002843 * Invoke call_func() with a callback.
2844 */
2845 int
2846call_callback(
2847 callback_T *callback,
2848 int len, // length of "name" or -1 to use strlen()
2849 typval_T *rettv, // return value goes here
2850 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002851 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002852 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002853{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002854 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002855 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002856
Bram Moolenaara80faa82020-04-12 19:37:17 +02002857 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002858 funcexe.evaluate = TRUE;
2859 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002860 ++callback_depth;
2861 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2862 --callback_depth;
2863 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002864}
2865
2866/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002867 * Give an error message for the result of a function.
2868 * Nothing if "error" is FCERR_NONE.
2869 */
2870 void
2871user_func_error(int error, char_u *name)
2872{
2873 switch (error)
2874 {
2875 case FCERR_UNKNOWN:
2876 emsg_funcname(e_unknownfunc, name);
2877 break;
2878 case FCERR_NOTMETHOD:
2879 emsg_funcname(
2880 N_("E276: Cannot use function as a method: %s"), name);
2881 break;
2882 case FCERR_DELETED:
2883 emsg_funcname(N_(e_func_deleted), name);
2884 break;
2885 case FCERR_TOOMANY:
2886 emsg_funcname((char *)e_toomanyarg, name);
2887 break;
2888 case FCERR_TOOFEW:
2889 emsg_funcname((char *)e_toofewarg, name);
2890 break;
2891 case FCERR_SCRIPT:
2892 emsg_funcname(
2893 N_("E120: Using <SID> not in a script context: %s"), name);
2894 break;
2895 case FCERR_DICT:
2896 emsg_funcname(
2897 N_("E725: Calling dict function without Dictionary: %s"),
2898 name);
2899 break;
2900 }
2901}
2902
2903/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002904 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002905 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 * Return FAIL when the function can't be called, OK otherwise.
2907 * Also returns OK when an error was encountered while executing the function.
2908 */
2909 int
2910call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002911 char_u *funcname, // name of the function
2912 int len, // length of "name" or -1 to use strlen()
2913 typval_T *rettv, // return value goes here
2914 int argcount_in, // number of "argvars"
2915 typval_T *argvars_in, // vars for arguments, must have "argcount"
2916 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002917 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002918{
2919 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002920 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002922 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002923 char_u fname_buf[FLEN_FIXED + 1];
2924 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002925 char_u *fname = NULL;
2926 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 int argcount = argcount_in;
2928 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002929 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002930 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2931 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002933 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002934 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002935
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002936 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2937 // even when call_func() returns FAIL.
2938 rettv->v_type = VAR_UNKNOWN;
2939
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002940 if (partial != NULL)
2941 fp = partial->pt_func;
2942 if (fp == NULL)
2943 {
2944 // Make a copy of the name, if it comes from a funcref variable it
2945 // could be changed or deleted in the called function.
2946 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2947 if (name == NULL)
2948 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002949
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002950 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2951 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002953 if (funcexe->doesrange != NULL)
2954 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955
2956 if (partial != NULL)
2957 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002958 // When the function has a partial with a dict and there is a dict
2959 // argument, use the dict argument. That is backwards compatible.
2960 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002961 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002962 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002963 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964 {
2965 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002966 {
2967 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2968 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002969 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002970 goto theend;
2971 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002973 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002974 for (i = 0; i < argcount_in; ++i)
2975 argv[i + argv_clear] = argvars_in[i];
2976 argvars = argv;
2977 argcount = partial->pt_argc + argcount_in;
2978 }
2979 }
2980
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002981 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2982 {
2983 // Check that the argument types are OK for the types of the funcref.
2984 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01002985 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002986 error = FCERR_OTHER;
2987 }
2988
Bram Moolenaaref140542019-12-31 21:27:13 +01002989 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002990 {
2991 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002992 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993
Bram Moolenaar333894b2020-08-01 18:53:07 +02002994 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002995 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002996 {
2997 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002998 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002999 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003000
Bram Moolenaare38eab22019-12-05 21:50:01 +01003001 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003003 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003005 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006 {
3007 /*
3008 * User defined function.
3009 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003010 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003011 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012
Bram Moolenaare38eab22019-12-05 21:50:01 +01003013 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003014 if (fp == NULL
3015 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003016 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017 && !aborting())
3018 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003019 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003020 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003022 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3024 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003025 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003026 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003028 if (fp == NULL)
3029 {
3030 char_u *p = untrans_function_name(rfname);
3031
3032 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003033 // Don't do this if the name starts with "s:".
3034 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003035 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003036 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003037
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003038 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003039 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003040#ifdef FEAT_LUA
3041 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3042 {
3043 cfunc_T cb = fp->uf_cb;
3044
3045 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3046 }
3047#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003048 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003049 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003050 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003051 // postponed filling in the arguments, do it now
3052 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003053 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003054
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003055 if (funcexe->basetv != NULL)
3056 {
3057 // Method call: base->Method()
3058 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3059 argv[0] = *funcexe->basetv;
3060 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003061 argvars = argv;
3062 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003063 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003064
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003065 error = call_user_func_check(fp, argcount, argvars, rettv,
3066 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003067 }
3068 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003069 else if (funcexe->basetv != NULL)
3070 {
3071 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003072 * expr->method(): Find the method name in the table, call its
3073 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003074 */
3075 error = call_internal_method(fname, argcount, argvars, rettv,
3076 funcexe->basetv);
3077 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003078 else
3079 {
3080 /*
3081 * Find the function name in the table, call its implementation.
3082 */
3083 error = call_internal_func(fname, argcount, argvars, rettv);
3084 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003085
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003086 /*
3087 * The function call (or "FuncUndefined" autocommand sequence) might
3088 * have been aborted by an error, an interrupt, or an explicitly thrown
3089 * exception that has not been caught so far. This situation can be
3090 * tested for by calling aborting(). For an error in an internal
3091 * function or for the "E132" error in call_user_func(), however, the
3092 * throw point at which the "force_abort" flag (temporarily reset by
3093 * emsg()) is normally updated has not been reached yet. We need to
3094 * update that flag first to make aborting() reliable.
3095 */
3096 update_force_abort();
3097 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003098 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003099 ret = OK;
3100
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003101theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003102 /*
3103 * Report an error unless the argument evaluation or function call has been
3104 * cancelled due to an aborting error, an interrupt, or an exception.
3105 */
3106 if (!aborting())
3107 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003108 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003109 }
3110
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003111 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003112 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003113 clear_tv(&argv[--argv_clear + argv_base]);
3114
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 vim_free(tofree);
3116 vim_free(name);
3117
3118 return ret;
3119}
3120
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003121 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003122printable_func_name(ufunc_T *fp)
3123{
3124 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3125}
3126
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003127/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003128 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003129 */
3130 static void
3131list_func_head(ufunc_T *fp, int indent)
3132{
3133 int j;
3134
3135 msg_start();
3136 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003137 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003138 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003139 msg_puts("def ");
3140 else
3141 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003142 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003143 msg_putchar('(');
3144 for (j = 0; j < fp->uf_args.ga_len; ++j)
3145 {
3146 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003147 msg_puts(", ");
3148 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003149 if (fp->uf_arg_types != NULL)
3150 {
3151 char *tofree;
3152
3153 msg_puts(": ");
3154 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3155 vim_free(tofree);
3156 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003157 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3158 {
3159 msg_puts(" = ");
3160 msg_puts(((char **)(fp->uf_def_args.ga_data))
3161 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3162 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003163 }
3164 if (fp->uf_varargs)
3165 {
3166 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003167 msg_puts(", ");
3168 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003169 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003170 if (fp->uf_va_name != NULL)
3171 {
3172 if (j)
3173 msg_puts(", ");
3174 msg_puts("...");
3175 msg_puts((char *)fp->uf_va_name);
3176 if (fp->uf_va_type)
3177 {
3178 char *tofree;
3179
3180 msg_puts(": ");
3181 msg_puts(type_name(fp->uf_va_type, &tofree));
3182 vim_free(tofree);
3183 }
3184 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003185 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003186
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003187 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003188 {
3189 if (fp->uf_ret_type != &t_void)
3190 {
3191 char *tofree;
3192
3193 msg_puts(": ");
3194 msg_puts(type_name(fp->uf_ret_type, &tofree));
3195 vim_free(tofree);
3196 }
3197 }
3198 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003199 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003200 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003201 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003202 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003203 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003204 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003205 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003206 msg_clr_eos();
3207 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003208 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209}
3210
3211/*
3212 * Get a function name, translating "<SID>" and "<SNR>".
3213 * Also handles a Funcref in a List or Dictionary.
3214 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003215 * Set "*is_global" to TRUE when the function must be global, unless
3216 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 * flags:
3218 * TFN_INT: internal function name OK
3219 * TFN_QUIET: be quiet
3220 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003221 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003222 * Advances "pp" to just after the function name (if no error).
3223 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003224 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003225trans_function_name(
3226 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003227 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003228 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003229 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003230 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003231 partial_T **partial, // return: partial of a FuncRef
3232 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003233{
3234 char_u *name = NULL;
3235 char_u *start;
3236 char_u *end;
3237 int lead;
3238 char_u sid_buf[20];
3239 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003240 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003242 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003243 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003244
3245 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003246 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247 start = *pp;
3248
Bram Moolenaare38eab22019-12-05 21:50:01 +01003249 // Check for hard coded <SNR>: already translated function ID (from a user
3250 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003251 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3252 && (*pp)[2] == (int)KE_SNR)
3253 {
3254 *pp += 3;
3255 len = get_id_len(pp) + 3;
3256 return vim_strnsave(start, len);
3257 }
3258
Bram Moolenaare38eab22019-12-05 21:50:01 +01003259 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3260 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003261 lead = eval_fname_script(start);
3262 if (lead > 2)
3263 start += lead;
3264
Bram Moolenaare38eab22019-12-05 21:50:01 +01003265 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003266 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 lead > 2 ? 0 : FNE_CHECK_START);
3268 if (end == start)
3269 {
3270 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003271 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003272 goto theend;
3273 }
3274 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3275 {
3276 /*
3277 * Report an invalid expression in braces, unless the expression
3278 * evaluation has been cancelled due to an aborting error, an
3279 * interrupt, or an exception.
3280 */
3281 if (!aborting())
3282 {
3283 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003284 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003285 }
3286 else
3287 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3288 goto theend;
3289 }
3290
3291 if (lv.ll_tv != NULL)
3292 {
3293 if (fdp != NULL)
3294 {
3295 fdp->fd_dict = lv.ll_dict;
3296 fdp->fd_newkey = lv.ll_newkey;
3297 lv.ll_newkey = NULL;
3298 fdp->fd_di = lv.ll_di;
3299 }
3300 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3301 {
3302 name = vim_strsave(lv.ll_tv->vval.v_string);
3303 *pp = end;
3304 }
3305 else if (lv.ll_tv->v_type == VAR_PARTIAL
3306 && lv.ll_tv->vval.v_partial != NULL)
3307 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003308 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309 *pp = end;
3310 if (partial != NULL)
3311 *partial = lv.ll_tv->vval.v_partial;
3312 }
3313 else
3314 {
3315 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3316 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003317 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 else
3319 *pp = end;
3320 name = NULL;
3321 }
3322 goto theend;
3323 }
3324
3325 if (lv.ll_name == NULL)
3326 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003327 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328 *pp = end;
3329 goto theend;
3330 }
3331
Bram Moolenaare38eab22019-12-05 21:50:01 +01003332 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003333 if (lv.ll_exp_name != NULL)
3334 {
3335 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003336 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337 flags & TFN_NO_AUTOLOAD);
3338 if (name == lv.ll_exp_name)
3339 name = NULL;
3340 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003341 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 {
3343 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003344 name = deref_func_name(*pp, &len, partial, type,
3345 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 if (name == *pp)
3347 name = NULL;
3348 }
3349 if (name != NULL)
3350 {
3351 name = vim_strsave(name);
3352 *pp = end;
3353 if (STRNCMP(name, "<SNR>", 5) == 0)
3354 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003355 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356 name[0] = K_SPECIAL;
3357 name[1] = KS_EXTRA;
3358 name[2] = (int)KE_SNR;
3359 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3360 }
3361 goto theend;
3362 }
3363
3364 if (lv.ll_exp_name != NULL)
3365 {
3366 len = (int)STRLEN(lv.ll_exp_name);
3367 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3368 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3369 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003370 // When there was "s:" already or the name expanded to get a
3371 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 lv.ll_name += 2;
3373 len -= 2;
3374 lead = 2;
3375 }
3376 }
3377 else
3378 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003379 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003380 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003381 {
3382 if (is_global != NULL && lv.ll_name[0] == 'g')
3383 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003384 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003385 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 len = (int)(end - lv.ll_name);
3387 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003388 if (len <= 0)
3389 {
3390 if (!skip)
3391 emsg(_(e_function_name));
3392 goto theend;
3393 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003394
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003395 // In Vim9 script a user function is script-local by default, unless it
3396 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003397 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003398 if (vim9script)
3399 {
3400 char_u *p;
3401
3402 // SomeScript#func() is a global function.
3403 for (p = start; *p != NUL && *p != '('; ++p)
3404 if (*p == AUTOLOAD_CHAR)
3405 vim9script = FALSE;
3406 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003407
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003408 /*
3409 * Copy the function name to allocated memory.
3410 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3411 * Accept <SNR>123_name() outside a script.
3412 */
3413 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003414 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003415 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003416 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003417 if (!vim9script)
3418 lead = 3;
3419 if (vim9script || (lv.ll_exp_name != NULL
3420 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003421 || eval_fname_sid(*pp))
3422 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003423 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003424 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003426 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 goto theend;
3428 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003429 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003430 if (vim9script)
3431 extra = 3 + (int)STRLEN(sid_buf);
3432 else
3433 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 }
3435 }
3436 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3437 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003438 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003439 start);
3440 goto theend;
3441 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003442 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 {
3444 char_u *cp = vim_strchr(lv.ll_name, ':');
3445
3446 if (cp != NULL && cp < end)
3447 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003448 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449 goto theend;
3450 }
3451 }
3452
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003453 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003454 if (name != NULL)
3455 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003456 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457 {
3458 name[0] = K_SPECIAL;
3459 name[1] = KS_EXTRA;
3460 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003461 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 STRCPY(name + 3, sid_buf);
3463 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3465 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 }
3467 *pp = end;
3468
3469theend:
3470 clear_lval(&lv);
3471 return name;
3472}
3473
3474/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003475 * Assuming "name" is the result of trans_function_name() and it was prefixed
3476 * to use the script-local name, return the unmodified name (points into
3477 * "name"). Otherwise return NULL.
3478 * This can be used to first search for a script-local function and fall back
3479 * to the global function if not found.
3480 */
3481 char_u *
3482untrans_function_name(char_u *name)
3483{
3484 char_u *p;
3485
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003486 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003487 {
3488 p = vim_strchr(name, '_');
3489 if (p != NULL)
3490 return p + 1;
3491 }
3492 return NULL;
3493}
3494
3495/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003496 * List functions. When "regmatch" is NULL all of then.
3497 * Otherwise functions matching "regmatch".
3498 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003499 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003500list_functions(regmatch_T *regmatch)
3501{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003502 int changed = func_hashtab.ht_changed;
3503 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003504 hashitem_T *hi;
3505
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003506 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003507 {
3508 if (!HASHITEM_EMPTY(hi))
3509 {
3510 ufunc_T *fp = HI2UF(hi);
3511
3512 --todo;
3513 if ((fp->uf_flags & FC_DEAD) == 0
3514 && (regmatch == NULL
3515 ? !message_filtered(fp->uf_name)
3516 && !func_name_refcount(fp->uf_name)
3517 : !isdigit(*fp->uf_name)
3518 && vim_regexec(regmatch, fp->uf_name, 0)))
3519 {
3520 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003521 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003522 {
3523 emsg(_("E454: function list was modified"));
3524 return;
3525 }
3526 }
3527 }
3528 }
3529}
3530
3531/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003532 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003533 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3534 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003535 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003537 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003538define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003540 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 int j;
3542 int c;
3543 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003544 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003545 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 char_u *p;
3547 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003548 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 char_u *line_arg = NULL;
3550 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003551 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003552 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 garray_T newlines;
3554 int varargs = FALSE;
3555 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003556 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003557 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003558 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559 dictitem_T *v;
3560 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003561 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003562 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003564 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003565 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003566 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003567
3568 /*
3569 * ":function" without argument: list functions.
3570 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003571 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 {
3573 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003574 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003576 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003577 }
3578
3579 /*
3580 * ":function /pat": list functions matching pattern.
3581 */
3582 if (*eap->arg == '/')
3583 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003584 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 if (!eap->skip)
3586 {
3587 regmatch_T regmatch;
3588
3589 c = *p;
3590 *p = NUL;
3591 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3592 *p = c;
3593 if (regmatch.regprog != NULL)
3594 {
3595 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003596 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 vim_regfree(regmatch.regprog);
3598 }
3599 }
3600 if (*p == '/')
3601 ++p;
3602 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003603 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 }
3605
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003606 ga_init(&newargs);
3607 ga_init(&argtypes);
3608 ga_init(&default_args);
3609
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003610 /*
3611 * Get the function name. There are these situations:
3612 * func normal function name
3613 * "name" == func, "fudi.fd_dict" == NULL
3614 * dict.func new dictionary entry
3615 * "name" == NULL, "fudi.fd_dict" set,
3616 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3617 * dict.func existing dict entry with a Funcref
3618 * "name" == func, "fudi.fd_dict" set,
3619 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3620 * dict.func existing dict entry that's not a Funcref
3621 * "name" == NULL, "fudi.fd_dict" set,
3622 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3623 * s:func script-local function name
3624 * g:func global function name, same as "func"
3625 */
3626 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003627 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003629 // nested function, argument is (args).
3630 paren = TRUE;
3631 CLEAR_FIELD(fudi);
3632 }
3633 else
3634 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003635 if (STRNCMP(p, "<lambda>", 8) == 0)
3636 {
3637 p += 8;
3638 (void)getdigits(&p);
3639 name = vim_strnsave(eap->arg, p - eap->arg);
3640 CLEAR_FIELD(fudi);
3641 }
3642 else
3643 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003644 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003645 paren = (vim_strchr(p, '(') != NULL);
3646 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003647 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003648 /*
3649 * Return on an invalid expression in braces, unless the expression
3650 * evaluation has been cancelled due to an aborting error, an
3651 * interrupt, or an exception.
3652 */
3653 if (!aborting())
3654 {
3655 if (!eap->skip && fudi.fd_newkey != NULL)
3656 semsg(_(e_dictkey), fudi.fd_newkey);
3657 vim_free(fudi.fd_newkey);
3658 return NULL;
3659 }
3660 else
3661 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003662 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 }
3664
Bram Moolenaare38eab22019-12-05 21:50:01 +01003665 // An error in a function call during evaluation of an expression in magic
3666 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003667 saved_did_emsg = did_emsg;
3668 did_emsg = FALSE;
3669
3670 /*
3671 * ":function func" with only function name: list function.
3672 */
3673 if (!paren)
3674 {
3675 if (!ends_excmd(*skipwhite(p)))
3676 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003677 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003678 goto ret_free;
3679 }
3680 eap->nextcmd = check_nextcmd(p);
3681 if (eap->nextcmd != NULL)
3682 *p = NUL;
3683 if (!eap->skip && !got_int)
3684 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003685 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003686 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3687 {
3688 char_u *up = untrans_function_name(name);
3689
3690 // With Vim9 script the name was made script-local, if not
3691 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003692 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003693 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003694 }
3695
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 if (fp != NULL)
3697 {
3698 list_func_head(fp, TRUE);
3699 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3700 {
3701 if (FUNCLINE(fp, j) == NULL)
3702 continue;
3703 msg_putchar('\n');
3704 msg_outnum((long)(j + 1));
3705 if (j < 9)
3706 msg_putchar(' ');
3707 if (j < 99)
3708 msg_putchar(' ');
3709 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003710 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003711 ui_breakcheck();
3712 }
3713 if (!got_int)
3714 {
3715 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003716 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003717 msg_puts(" enddef");
3718 else
3719 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720 }
3721 }
3722 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003723 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 }
3725 goto ret_free;
3726 }
3727
3728 /*
3729 * ":function name(arg1, arg2)" Define function.
3730 */
3731 p = skipwhite(p);
3732 if (*p != '(')
3733 {
3734 if (!eap->skip)
3735 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003736 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003737 goto ret_free;
3738 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003739 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003740 if (vim_strchr(p, '(') != NULL)
3741 p = vim_strchr(p, '(');
3742 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003744 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3745 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003746 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003747 goto ret_free;
3748 }
3749
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003750 // In Vim9 script only global functions can be redefined.
3751 if (vim9script && eap->forceit && !is_global)
3752 {
3753 emsg(_(e_nobang));
3754 goto ret_free;
3755 }
3756
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003757 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758
Bram Moolenaar04b12692020-05-04 23:24:44 +02003759 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003761 // Check the name of the function. Unless it's a dictionary function
3762 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003763 if (name != NULL)
3764 arg = name;
3765 else
3766 arg = fudi.fd_newkey;
3767 if (arg != NULL && (fudi.fd_di == NULL
3768 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3769 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3770 {
3771 if (*arg == K_SPECIAL)
3772 j = 3;
3773 else
3774 j = 0;
3775 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3776 : eval_isnamec(arg[j])))
3777 ++j;
3778 if (arg[j] != NUL)
3779 emsg_funcname((char *)e_invarg2, arg);
3780 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003781 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003782 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003783 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784 }
3785
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003786 // This may get more lines and make the pointers into the first line
3787 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003788 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003789 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003790 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003791 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003792 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003794 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003796 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003798 // find the return type: :def Func(): type
3799 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003801 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003802 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003803 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003804 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003805 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003806 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003807 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003808 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003809 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003810 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003811 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003812 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003813 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003815 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003817 else
3818 // find extra arguments "range", "dict", "abort" and "closure"
3819 for (;;)
3820 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003821 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003822 p = skipwhite(p);
3823 if (STRNCMP(p, "range", 5) == 0)
3824 {
3825 flags |= FC_RANGE;
3826 p += 5;
3827 }
3828 else if (STRNCMP(p, "dict", 4) == 0)
3829 {
3830 flags |= FC_DICT;
3831 p += 4;
3832 }
3833 else if (STRNCMP(p, "abort", 5) == 0)
3834 {
3835 flags |= FC_ABORT;
3836 p += 5;
3837 }
3838 else if (STRNCMP(p, "closure", 7) == 0)
3839 {
3840 flags |= FC_CLOSURE;
3841 p += 7;
3842 if (current_funccal == NULL)
3843 {
3844 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3845 name == NULL ? (char_u *)"" : name);
3846 goto erret;
3847 }
3848 }
3849 else
3850 break;
3851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852
Bram Moolenaare38eab22019-12-05 21:50:01 +01003853 // When there is a line break use what follows for the function body.
3854 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003855 if (*p == '\n')
3856 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003857 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003858 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3859 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003860 && !(VIM_ISWHITE(*whitep) && *p == '#'
3861 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003862 && !eap->skip
3863 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003864 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003865
3866 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003867 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3868 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 */
3870 if (KeyTyped)
3871 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003872 // Check if the function already exists, don't let the user type the
3873 // whole function before telling him it doesn't work! For a script we
3874 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003875 if (!eap->skip && !eap->forceit)
3876 {
3877 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003878 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003879 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003880 emsg_funcname(e_funcexts, name);
3881 }
3882
3883 if (!eap->skip && did_emsg)
3884 goto erret;
3885
Bram Moolenaare38eab22019-12-05 21:50:01 +01003886 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 cmdline_row = msg_row;
3888 }
3889
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003890 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003891 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003892
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003893 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 goto erret;
3895
3896 /*
3897 * If there are no errors, add the function
3898 */
3899 if (fudi.fd_dict == NULL)
3900 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003901 hashtab_T *ht;
3902
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003903 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003904 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3905 {
3906 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3907 name);
3908 goto erret;
3909 }
3910
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003911 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003912 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003914 char_u *uname = untrans_function_name(name);
3915
3916 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3917 }
3918
3919 if (fp != NULL || import != NULL)
3920 {
3921 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003922
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003923 // Function can be replaced with "function!" and when sourcing the
3924 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003925 // A name that is used by an import can not be overruled.
3926 if (import != NULL
3927 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003928 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003929 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003931 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003932 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003933 else
3934 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 goto erret;
3936 }
3937 if (fp->uf_calls > 0)
3938 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003939 emsg_funcname(
3940 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 name);
3942 goto erret;
3943 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003944 if (fp->uf_refcount > 1)
3945 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003946 // This function is referenced somewhere, don't redefine it but
3947 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003948 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003949 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003950 fp = NULL;
3951 overwrite = TRUE;
3952 }
3953 else
3954 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003955 char_u *exp_name = fp->uf_name_exp;
3956
3957 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003958 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003959 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003960 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003961 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003962 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003963#ifdef FEAT_PROFILE
3964 fp->uf_profiling = FALSE;
3965 fp->uf_prof_initialized = FALSE;
3966#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003967 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003968 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003969 }
3970 }
3971 else
3972 {
3973 char numbuf[20];
3974
3975 fp = NULL;
3976 if (fudi.fd_newkey == NULL && !eap->forceit)
3977 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003978 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003979 goto erret;
3980 }
3981 if (fudi.fd_di == NULL)
3982 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003983 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003984 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 goto erret;
3986 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003987 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003988 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003989 goto erret;
3990
Bram Moolenaare38eab22019-12-05 21:50:01 +01003991 // Give the function a sequential number. Can only be used with a
3992 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 vim_free(name);
3994 sprintf(numbuf, "%d", ++func_nr);
3995 name = vim_strsave((char_u *)numbuf);
3996 if (name == NULL)
3997 goto erret;
3998 }
3999
4000 if (fp == NULL)
4001 {
4002 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4003 {
4004 int slen, plen;
4005 char_u *scriptname;
4006
Bram Moolenaare38eab22019-12-05 21:50:01 +01004007 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004009 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004010 {
4011 scriptname = autoload_name(name);
4012 if (scriptname != NULL)
4013 {
4014 p = vim_strchr(scriptname, '/');
4015 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004016 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004018 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019 j = OK;
4020 vim_free(scriptname);
4021 }
4022 }
4023 if (j == FAIL)
4024 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004025 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 goto erret;
4027 }
4028 }
4029
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004030 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004031 if (fp == NULL)
4032 goto erret;
4033
4034 if (fudi.fd_dict != NULL)
4035 {
4036 if (fudi.fd_di == NULL)
4037 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004038 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004039 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4040 if (fudi.fd_di == NULL)
4041 {
4042 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004043 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004044 goto erret;
4045 }
4046 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4047 {
4048 vim_free(fudi.fd_di);
4049 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004050 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 goto erret;
4052 }
4053 }
4054 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004055 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 clear_tv(&fudi.fd_di->di_tv);
4057 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059
Bram Moolenaare38eab22019-12-05 21:50:01 +01004060 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004061 flags |= FC_DICT;
4062 }
4063
Bram Moolenaare38eab22019-12-05 21:50:01 +01004064 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004065 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004066 if (overwrite)
4067 {
4068 hi = hash_find(&func_hashtab, name);
4069 hi->hi_key = UF2HIKEY(fp);
4070 }
4071 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004072 {
4073 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004074 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 goto erret;
4076 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004077 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 }
4079 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004080 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004081 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004082 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004083
4084 if (eap->cmdidx == CMD_def)
4085 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004086 int lnum_save = SOURCING_LNUM;
4087 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004088
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004089 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004090
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004091 // error messages are for the first function line
4092 SOURCING_LNUM = sourcing_lnum_top;
4093
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004094 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004095 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004096 int count = cstack->cs_idx + 1;
4097 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004098
4099 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004100 // a block that is visible now but not when the function is called
4101 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004102 fp->uf_block_ids = ALLOC_MULT(int, count);
4103 if (fp->uf_block_ids != NULL)
4104 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004105 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004106 sizeof(int) * count);
4107 fp->uf_block_depth = count;
4108 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004109
4110 // Set flag in each block to indicate a function was defined. This
4111 // is used to keep the variable when leaving the block, see
4112 // hide_script_var().
4113 for (i = 0; i <= cstack->cs_idx; ++i)
4114 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004115 }
4116
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004117 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004118 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004119 SOURCING_LNUM = lnum_save;
4120 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004121 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004122 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004123
4124 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004125 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004126 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004127 SOURCING_LNUM = lnum_save;
4128 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004129 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004130 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004131 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004132 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004133 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004134
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004135 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004136 if ((flags & FC_CLOSURE) != 0)
4137 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004138 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004139 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004140 }
4141 else
4142 fp->uf_scoped = NULL;
4143
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004144#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145 if (prof_def_func())
4146 func_do_profile(fp);
4147#endif
4148 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004149 if (sandbox)
4150 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004151 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004152 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004153 fp->uf_flags = flags;
4154 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004155 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004156 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004157 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004158 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004159 if (is_export)
4160 {
4161 fp->uf_flags |= FC_EXPORT;
4162 // let ex_export() know the export worked.
4163 is_export = FALSE;
4164 }
4165
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004166 if (eap->cmdidx == CMD_def)
4167 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004168 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4169 // :func does not use Vim9 script syntax, even in a Vim9 script file
4170 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004171
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004172 goto ret_free;
4173
4174erret:
4175 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004176 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004177 if (fp != NULL)
4178 {
4179 ga_init(&fp->uf_args);
4180 ga_init(&fp->uf_def_args);
4181 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182errret_2:
4183 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004184 if (fp != NULL)
4185 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004186ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004187 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004188 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004189 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004190 if (name != name_arg)
4191 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004192 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004193 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004194
4195 return fp;
4196}
4197
4198/*
4199 * ":function"
4200 */
4201 void
4202ex_function(exarg_T *eap)
4203{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004204 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004205}
4206
4207/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004208 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004209 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004210 */
4211 void
4212ex_defcompile(exarg_T *eap UNUSED)
4213{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004214 long todo = (long)func_hashtab.ht_used;
4215 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004216 hashitem_T *hi;
4217 ufunc_T *ufunc;
4218
4219 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4220 {
4221 if (!HASHITEM_EMPTY(hi))
4222 {
4223 --todo;
4224 ufunc = HI2UF(hi);
4225 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004226 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4227 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004228 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004229 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004230
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004231 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004232 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004233 // a function has been added or removed, need to start over
4234 todo = (long)func_hashtab.ht_used;
4235 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004236 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004237 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004238 }
4239 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004240 }
4241 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004242}
4243
4244/*
4245 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4246 * Return 2 if "p" starts with "s:".
4247 * Return 0 otherwise.
4248 */
4249 int
4250eval_fname_script(char_u *p)
4251{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004252 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4253 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004254 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4255 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4256 return 5;
4257 if (p[0] == 's' && p[1] == ':')
4258 return 2;
4259 return 0;
4260}
4261
4262 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004263translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264{
4265 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004266 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004267 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004268}
4269
4270/*
4271 * Return TRUE when "ufunc" has old-style "..." varargs
4272 * or named varargs "...name: type".
4273 */
4274 int
4275has_varargs(ufunc_T *ufunc)
4276{
4277 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278}
4279
4280/*
4281 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004282 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283 */
4284 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004285function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286{
4287 char_u *nm = name;
4288 char_u *p;
4289 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004290 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004291 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004293 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4294 if (no_deref)
4295 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004296 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004297 nm = skipwhite(nm);
4298
Bram Moolenaare38eab22019-12-05 21:50:01 +01004299 // Only accept "funcname", "funcname ", "funcname (..." and
4300 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004302 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 vim_free(p);
4304 return n;
4305}
4306
Bram Moolenaar113e1072019-01-20 15:30:40 +01004307#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 char_u *
4309get_expanded_name(char_u *name, int check)
4310{
4311 char_u *nm = name;
4312 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004313 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004315 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004316 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004318 if (p != NULL && *nm == NUL
4319 && (!check || translated_function_exists(p, is_global)))
4320 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004321
4322 vim_free(p);
4323 return NULL;
4324}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004325#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004326
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327/*
4328 * Function given to ExpandGeneric() to obtain the list of user defined
4329 * function names.
4330 */
4331 char_u *
4332get_user_func_name(expand_T *xp, int idx)
4333{
4334 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004335 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336 static hashitem_T *hi;
4337 ufunc_T *fp;
4338
4339 if (idx == 0)
4340 {
4341 done = 0;
4342 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004343 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004345 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 {
4347 if (done++ > 0)
4348 ++hi;
4349 while (HASHITEM_EMPTY(hi))
4350 ++hi;
4351 fp = HI2UF(hi);
4352
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004353 // don't show dead, dict and lambda functions
4354 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004355 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004356 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357
4358 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004359 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004360
4361 cat_func_name(IObuff, fp);
4362 if (xp->xp_context != EXPAND_USER_FUNC)
4363 {
4364 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004365 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366 STRCAT(IObuff, ")");
4367 }
4368 return IObuff;
4369 }
4370 return NULL;
4371}
4372
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004373/*
4374 * ":delfunction {name}"
4375 */
4376 void
4377ex_delfunction(exarg_T *eap)
4378{
4379 ufunc_T *fp = NULL;
4380 char_u *p;
4381 char_u *name;
4382 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004383 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004384
4385 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004386 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4387 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004388 vim_free(fudi.fd_newkey);
4389 if (name == NULL)
4390 {
4391 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004392 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 return;
4394 }
4395 if (!ends_excmd(*skipwhite(p)))
4396 {
4397 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004398 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 return;
4400 }
4401 eap->nextcmd = check_nextcmd(p);
4402 if (eap->nextcmd != NULL)
4403 *p = NUL;
4404
4405 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004406 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 vim_free(name);
4408
4409 if (!eap->skip)
4410 {
4411 if (fp == NULL)
4412 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004413 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004414 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004415 return;
4416 }
4417 if (fp->uf_calls > 0)
4418 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004419 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004420 return;
4421 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004422 if (fp->uf_flags & FC_VIM9)
4423 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004424 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004425 return;
4426 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004427
4428 if (fudi.fd_dict != NULL)
4429 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004430 // Delete the dict item that refers to the function, it will
4431 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004432 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4433 }
4434 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004435 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004436 // A normal function (not a numbered function or lambda) has a
4437 // refcount of 1 for the entry in the hashtable. When deleting
4438 // it and the refcount is more than one, it should be kept.
4439 // A numbered function and lambda should be kept if the refcount is
4440 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004441 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004442 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004443 // Function is still referenced somewhere. Don't free it but
4444 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004445 if (func_remove(fp))
4446 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004447 }
4448 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004449 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004450 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004451 }
4452}
4453
4454/*
4455 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004456 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 */
4458 void
4459func_unref(char_u *name)
4460{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004461 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004462
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004463 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004464 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004465 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004466 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004469 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004471 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004473 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004474}
4475
4476/*
4477 * Unreference a Function: decrement the reference count and free it when it
4478 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004479 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004480 */
4481 void
4482func_ptr_unref(ufunc_T *fp)
4483{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004484 if (fp != NULL && (--fp->uf_refcount <= 0
4485 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4486 && fp->uf_partial->pt_refcount <= 1
4487 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004488 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004489 // Only delete it when it's not being used. Otherwise it's done
4490 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004491 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004492 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493 }
4494}
4495
4496/*
4497 * Count a reference to a Function.
4498 */
4499 void
4500func_ref(char_u *name)
4501{
4502 ufunc_T *fp;
4503
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004504 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004505 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004506 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004507 if (fp != NULL)
4508 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004510 // Only give an error for a numbered function.
4511 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004512 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004513}
4514
4515/*
4516 * Count a reference to a Function.
4517 */
4518 void
4519func_ptr_ref(ufunc_T *fp)
4520{
4521 if (fp != NULL)
4522 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004523}
4524
4525/*
4526 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4527 * referenced from anywhere that is in use.
4528 */
4529 static int
4530can_free_funccal(funccall_T *fc, int copyID)
4531{
4532 return (fc->l_varlist.lv_copyID != copyID
4533 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004534 && fc->l_avars.dv_copyID != copyID
4535 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536}
4537
4538/*
4539 * ":return [expr]"
4540 */
4541 void
4542ex_return(exarg_T *eap)
4543{
4544 char_u *arg = eap->arg;
4545 typval_T rettv;
4546 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004547 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548
4549 if (current_funccal == NULL)
4550 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004551 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552 return;
4553 }
4554
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004555 CLEAR_FIELD(evalarg);
4556 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4557
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 if (eap->skip)
4559 ++emsg_skip;
4560
4561 eap->nextcmd = NULL;
4562 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004563 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564 {
4565 if (!eap->skip)
4566 returning = do_return(eap, FALSE, TRUE, &rettv);
4567 else
4568 clear_tv(&rettv);
4569 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004570 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 else if (!eap->skip)
4572 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004573 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004574 update_force_abort();
4575
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004576 /*
4577 * Return unless the expression evaluation has been cancelled due to an
4578 * aborting error, an interrupt, or an exception.
4579 */
4580 if (!aborting())
4581 returning = do_return(eap, FALSE, TRUE, NULL);
4582 }
4583
Bram Moolenaare38eab22019-12-05 21:50:01 +01004584 // When skipping or the return gets pending, advance to the next command
4585 // in this line (!returning). Otherwise, ignore the rest of the line.
4586 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004587 if (returning)
4588 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004589 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 eap->nextcmd = check_nextcmd(arg);
4591
4592 if (eap->skip)
4593 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004594 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595}
4596
4597/*
4598 * ":1,25call func(arg1, arg2)" function call.
4599 */
4600 void
4601ex_call(exarg_T *eap)
4602{
4603 char_u *arg = eap->arg;
4604 char_u *startarg;
4605 char_u *name;
4606 char_u *tofree;
4607 int len;
4608 typval_T rettv;
4609 linenr_T lnum;
4610 int doesrange;
4611 int failed = FALSE;
4612 funcdict_T fudi;
4613 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004614 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004615 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616
Bram Moolenaare6b53242020-07-01 17:28:33 +02004617 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004618 if (eap->skip)
4619 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004620 // trans_function_name() doesn't work well when skipping, use eval0()
4621 // instead to skip to any following command, e.g. for:
4622 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004623 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004624 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625 clear_tv(&rettv);
4626 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004627 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004628 return;
4629 }
4630
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004631 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4632 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 if (fudi.fd_newkey != NULL)
4634 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004635 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004636 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 vim_free(fudi.fd_newkey);
4638 }
4639 if (tofree == NULL)
4640 return;
4641
Bram Moolenaare38eab22019-12-05 21:50:01 +01004642 // Increase refcount on dictionary, it could get deleted when evaluating
4643 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004644 if (fudi.fd_dict != NULL)
4645 ++fudi.fd_dict->dv_refcount;
4646
Bram Moolenaare38eab22019-12-05 21:50:01 +01004647 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4648 // contents. For VAR_PARTIAL get its partial, unless we already have one
4649 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004651 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4652 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004653
Bram Moolenaare38eab22019-12-05 21:50:01 +01004654 // Skip white space to allow ":call func ()". Not good, but required for
4655 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004657 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658
4659 if (*startarg != '(')
4660 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004661 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 goto end;
4663 }
4664
4665 /*
4666 * When skipping, evaluate the function once, to find the end of the
4667 * arguments.
4668 * When the function takes a range, this is discovered after the first
4669 * call, and the loop is broken.
4670 */
4671 if (eap->skip)
4672 {
4673 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004674 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675 }
4676 else
4677 lnum = eap->line1;
4678 for ( ; lnum <= eap->line2; ++lnum)
4679 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004680 funcexe_T funcexe;
4681
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004682 if (!eap->skip && eap->addr_count > 0)
4683 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004684 if (lnum > curbuf->b_ml.ml_line_count)
4685 {
4686 // If the function deleted lines or switched to another buffer
4687 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004688 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004689 break;
4690 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691 curwin->w_cursor.lnum = lnum;
4692 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004693 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 }
4695 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004696
Bram Moolenaara80faa82020-04-12 19:37:17 +02004697 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004698 funcexe.firstline = eap->line1;
4699 funcexe.lastline = eap->line2;
4700 funcexe.doesrange = &doesrange;
4701 funcexe.evaluate = !eap->skip;
4702 funcexe.partial = partial;
4703 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004704 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004705 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004706 {
4707 failed = TRUE;
4708 break;
4709 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004710 if (has_watchexpr())
4711 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004712
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004713 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004714 if (handle_subscript(&arg, &rettv,
4715 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004716 {
4717 failed = TRUE;
4718 break;
4719 }
4720
4721 clear_tv(&rettv);
4722 if (doesrange || eap->skip)
4723 break;
4724
Bram Moolenaare38eab22019-12-05 21:50:01 +01004725 // Stop when immediately aborting on error, or when an interrupt
4726 // occurred or an exception was thrown but not caught.
4727 // get_func_tv() returned OK, so that the check for trailing
4728 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729 if (aborting())
4730 break;
4731 }
4732 if (eap->skip)
4733 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004734 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735
Bram Moolenaare51bb172020-02-16 19:42:23 +01004736 // When inside :try we need to check for following "| catch".
4737 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004739 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004740 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004741 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004742 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004743 if (!failed)
4744 {
4745 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004746 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004747 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748 }
4749 else
4750 eap->nextcmd = check_nextcmd(arg);
4751 }
4752
4753end:
4754 dict_unref(fudi.fd_dict);
4755 vim_free(tofree);
4756}
4757
4758/*
4759 * Return from a function. Possibly makes the return pending. Also called
4760 * for a pending return at the ":endtry" or after returning from an extra
4761 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4762 * when called due to a ":return" command. "rettv" may point to a typval_T
4763 * with the return rettv. Returns TRUE when the return can be carried out,
4764 * FALSE when the return gets pending.
4765 */
4766 int
4767do_return(
4768 exarg_T *eap,
4769 int reanimate,
4770 int is_cmd,
4771 void *rettv)
4772{
4773 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004774 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004775
4776 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004777 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 current_funccal->returned = FALSE;
4779
4780 /*
4781 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4782 * not in its finally clause (which then is to be executed next) is found.
4783 * In this case, make the ":return" pending for execution at the ":endtry".
4784 * Otherwise, return normally.
4785 */
4786 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4787 if (idx >= 0)
4788 {
4789 cstack->cs_pending[idx] = CSTP_RETURN;
4790
4791 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004792 // A pending return again gets pending. "rettv" points to an
4793 // allocated variable with the rettv of the original ":return"'s
4794 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 cstack->cs_rettv[idx] = rettv;
4796 else
4797 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004798 // When undoing a return in order to make it pending, get the stored
4799 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004800 if (reanimate)
4801 rettv = current_funccal->rettv;
4802
4803 if (rettv != NULL)
4804 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004805 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4807 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4808 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004809 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 }
4811 else
4812 cstack->cs_rettv[idx] = NULL;
4813
4814 if (reanimate)
4815 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004816 // The pending return value could be overwritten by a ":return"
4817 // without argument in a finally clause; reset the default
4818 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 current_funccal->rettv->v_type = VAR_NUMBER;
4820 current_funccal->rettv->vval.v_number = 0;
4821 }
4822 }
4823 report_make_pending(CSTP_RETURN, rettv);
4824 }
4825 else
4826 {
4827 current_funccal->returned = TRUE;
4828
Bram Moolenaare38eab22019-12-05 21:50:01 +01004829 // If the return is carried out now, store the return value. For
4830 // a return immediately after reanimation, the value is already
4831 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832 if (!reanimate && rettv != NULL)
4833 {
4834 clear_tv(current_funccal->rettv);
4835 *current_funccal->rettv = *(typval_T *)rettv;
4836 if (!is_cmd)
4837 vim_free(rettv);
4838 }
4839 }
4840
4841 return idx < 0;
4842}
4843
4844/*
4845 * Free the variable with a pending return value.
4846 */
4847 void
4848discard_pending_return(void *rettv)
4849{
4850 free_tv((typval_T *)rettv);
4851}
4852
4853/*
4854 * Generate a return command for producing the value of "rettv". The result
4855 * is an allocated string. Used by report_pending() for verbose messages.
4856 */
4857 char_u *
4858get_return_cmd(void *rettv)
4859{
4860 char_u *s = NULL;
4861 char_u *tofree = NULL;
4862 char_u numbuf[NUMBUFLEN];
4863
4864 if (rettv != NULL)
4865 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4866 if (s == NULL)
4867 s = (char_u *)"";
4868
4869 STRCPY(IObuff, ":return ");
4870 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4871 if (STRLEN(s) + 8 >= IOSIZE)
4872 STRCPY(IObuff + IOSIZE - 4, "...");
4873 vim_free(tofree);
4874 return vim_strsave(IObuff);
4875}
4876
4877/*
4878 * Get next function line.
4879 * Called by do_cmdline() to get the next line.
4880 * Returns allocated string, or NULL for end of function.
4881 */
4882 char_u *
4883get_func_line(
4884 int c UNUSED,
4885 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004886 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004887 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888{
4889 funccall_T *fcp = (funccall_T *)cookie;
4890 ufunc_T *fp = fcp->func;
4891 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004892 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004893
Bram Moolenaare38eab22019-12-05 21:50:01 +01004894 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895 if (fcp->dbg_tick != debug_tick)
4896 {
4897 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004898 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004899 fcp->dbg_tick = debug_tick;
4900 }
4901#ifdef FEAT_PROFILE
4902 if (do_profiling == PROF_YES)
4903 func_line_end(cookie);
4904#endif
4905
4906 gap = &fp->uf_lines;
4907 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4908 || fcp->returned)
4909 retval = NULL;
4910 else
4911 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004912 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004913 while (fcp->linenr < gap->ga_len
4914 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4915 ++fcp->linenr;
4916 if (fcp->linenr >= gap->ga_len)
4917 retval = NULL;
4918 else
4919 {
4920 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004921 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922#ifdef FEAT_PROFILE
4923 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004924 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925#endif
4926 }
4927 }
4928
Bram Moolenaare38eab22019-12-05 21:50:01 +01004929 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004930 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004932 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004933 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004935 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004936 fcp->dbg_tick = debug_tick;
4937 }
4938
4939 return retval;
4940}
4941
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942/*
4943 * Return TRUE if the currently active function should be ended, because a
4944 * return was encountered or an error occurred. Used inside a ":while".
4945 */
4946 int
4947func_has_ended(void *cookie)
4948{
4949 funccall_T *fcp = (funccall_T *)cookie;
4950
Bram Moolenaare38eab22019-12-05 21:50:01 +01004951 // Ignore the "abort" flag if the abortion behavior has been changed due to
4952 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004953 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4954 || fcp->returned);
4955}
4956
4957/*
4958 * return TRUE if cookie indicates a function which "abort"s on errors.
4959 */
4960 int
4961func_has_abort(
4962 void *cookie)
4963{
4964 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4965}
4966
4967
4968/*
4969 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4970 * Don't do this when "Func" is already a partial that was bound
4971 * explicitly (pt_auto is FALSE).
4972 * Changes "rettv" in-place.
4973 * Returns the updated "selfdict_in".
4974 */
4975 dict_T *
4976make_partial(dict_T *selfdict_in, typval_T *rettv)
4977{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004978 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979 char_u *tofree = NULL;
4980 ufunc_T *fp;
4981 char_u fname_buf[FLEN_FIXED + 1];
4982 int error;
4983 dict_T *selfdict = selfdict_in;
4984
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004985 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4986 fp = rettv->vval.v_partial->pt_func;
4987 else
4988 {
4989 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4990 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004991 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004992 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004993 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004994 vim_free(tofree);
4995 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996
4997 if (fp != NULL && (fp->uf_flags & FC_DICT))
4998 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02004999 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005000
5001 if (pt != NULL)
5002 {
5003 pt->pt_refcount = 1;
5004 pt->pt_dict = selfdict;
5005 pt->pt_auto = TRUE;
5006 selfdict = NULL;
5007 if (rettv->v_type == VAR_FUNC)
5008 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005009 // Just a function: Take over the function name and use
5010 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011 pt->pt_name = rettv->vval.v_string;
5012 }
5013 else
5014 {
5015 partial_T *ret_pt = rettv->vval.v_partial;
5016 int i;
5017
Bram Moolenaare38eab22019-12-05 21:50:01 +01005018 // Partial: copy the function name, use selfdict and copy
5019 // args. Can't take over name or args, the partial might
5020 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005021 if (ret_pt->pt_name != NULL)
5022 {
5023 pt->pt_name = vim_strsave(ret_pt->pt_name);
5024 func_ref(pt->pt_name);
5025 }
5026 else
5027 {
5028 pt->pt_func = ret_pt->pt_func;
5029 func_ptr_ref(pt->pt_func);
5030 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031 if (ret_pt->pt_argc > 0)
5032 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005033 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005034 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005035 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005036 pt->pt_argc = 0;
5037 else
5038 {
5039 pt->pt_argc = ret_pt->pt_argc;
5040 for (i = 0; i < pt->pt_argc; i++)
5041 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5042 }
5043 }
5044 partial_unref(ret_pt);
5045 }
5046 rettv->v_type = VAR_PARTIAL;
5047 rettv->vval.v_partial = pt;
5048 }
5049 }
5050 return selfdict;
5051}
5052
5053/*
5054 * Return the name of the executed function.
5055 */
5056 char_u *
5057func_name(void *cookie)
5058{
5059 return ((funccall_T *)cookie)->func->uf_name;
5060}
5061
5062/*
5063 * Return the address holding the next breakpoint line for a funccall cookie.
5064 */
5065 linenr_T *
5066func_breakpoint(void *cookie)
5067{
5068 return &((funccall_T *)cookie)->breakpoint;
5069}
5070
5071/*
5072 * Return the address holding the debug tick for a funccall cookie.
5073 */
5074 int *
5075func_dbg_tick(void *cookie)
5076{
5077 return &((funccall_T *)cookie)->dbg_tick;
5078}
5079
5080/*
5081 * Return the nesting level for a funccall cookie.
5082 */
5083 int
5084func_level(void *cookie)
5085{
5086 return ((funccall_T *)cookie)->level;
5087}
5088
5089/*
5090 * Return TRUE when a function was ended by a ":return" command.
5091 */
5092 int
5093current_func_returned(void)
5094{
5095 return current_funccal->returned;
5096}
5097
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005098 int
5099free_unref_funccal(int copyID, int testing)
5100{
5101 int did_free = FALSE;
5102 int did_free_funccal = FALSE;
5103 funccall_T *fc, **pfc;
5104
5105 for (pfc = &previous_funccal; *pfc != NULL; )
5106 {
5107 if (can_free_funccal(*pfc, copyID))
5108 {
5109 fc = *pfc;
5110 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005111 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005112 did_free = TRUE;
5113 did_free_funccal = TRUE;
5114 }
5115 else
5116 pfc = &(*pfc)->caller;
5117 }
5118 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005119 // When a funccal was freed some more items might be garbage
5120 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005121 (void)garbage_collect(testing);
5122
5123 return did_free;
5124}
5125
5126/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005127 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128 */
5129 static funccall_T *
5130get_funccal(void)
5131{
5132 int i;
5133 funccall_T *funccal;
5134 funccall_T *temp_funccal;
5135
5136 funccal = current_funccal;
5137 if (debug_backtrace_level > 0)
5138 {
5139 for (i = 0; i < debug_backtrace_level; i++)
5140 {
5141 temp_funccal = funccal->caller;
5142 if (temp_funccal)
5143 funccal = temp_funccal;
5144 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005145 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005146 debug_backtrace_level = i;
5147 }
5148 }
5149 return funccal;
5150}
5151
5152/*
5153 * Return the hashtable used for local variables in the current funccal.
5154 * Return NULL if there is no current funccal.
5155 */
5156 hashtab_T *
5157get_funccal_local_ht()
5158{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005159 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005160 return NULL;
5161 return &get_funccal()->l_vars.dv_hashtab;
5162}
5163
5164/*
5165 * Return the l: scope variable.
5166 * Return NULL if there is no current funccal.
5167 */
5168 dictitem_T *
5169get_funccal_local_var()
5170{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005171 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005172 return NULL;
5173 return &get_funccal()->l_vars_var;
5174}
5175
5176/*
5177 * Return the hashtable used for argument in the current funccal.
5178 * Return NULL if there is no current funccal.
5179 */
5180 hashtab_T *
5181get_funccal_args_ht()
5182{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005183 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005184 return NULL;
5185 return &get_funccal()->l_avars.dv_hashtab;
5186}
5187
5188/*
5189 * Return the a: scope variable.
5190 * Return NULL if there is no current funccal.
5191 */
5192 dictitem_T *
5193get_funccal_args_var()
5194{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005195 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005196 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005197 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005198}
5199
5200/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005201 * List function variables, if there is a function.
5202 */
5203 void
5204list_func_vars(int *first)
5205{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005206 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005208 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209}
5210
5211/*
5212 * If "ht" is the hashtable for local variables in the current funccal, return
5213 * the dict that contains it.
5214 * Otherwise return NULL.
5215 */
5216 dict_T *
5217get_current_funccal_dict(hashtab_T *ht)
5218{
5219 if (current_funccal != NULL
5220 && ht == &current_funccal->l_vars.dv_hashtab)
5221 return &current_funccal->l_vars;
5222 return NULL;
5223}
5224
5225/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005226 * Search hashitem in parent scope.
5227 */
5228 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005229find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005230{
5231 funccall_T *old_current_funccal = current_funccal;
5232 hashtab_T *ht;
5233 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005234 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005235
5236 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5237 return NULL;
5238
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005239 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005240 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005241 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005242 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005243 ht = find_var_ht(name, &varname);
5244 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005245 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005246 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005247 if (!HASHITEM_EMPTY(hi))
5248 {
5249 *pht = ht;
5250 break;
5251 }
5252 }
5253 if (current_funccal == current_funccal->func->uf_scoped)
5254 break;
5255 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005256 }
5257 current_funccal = old_current_funccal;
5258
5259 return hi;
5260}
5261
5262/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005263 * Search variable in parent scope.
5264 */
5265 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005266find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005267{
5268 dictitem_T *v = NULL;
5269 funccall_T *old_current_funccal = current_funccal;
5270 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005271 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005272
5273 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5274 return NULL;
5275
Bram Moolenaare38eab22019-12-05 21:50:01 +01005276 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005277 current_funccal = current_funccal->func->uf_scoped;
5278 while (current_funccal)
5279 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005280 ht = find_var_ht(name, &varname);
5281 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005282 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005283 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005284 if (v != NULL)
5285 break;
5286 }
5287 if (current_funccal == current_funccal->func->uf_scoped)
5288 break;
5289 current_funccal = current_funccal->func->uf_scoped;
5290 }
5291 current_funccal = old_current_funccal;
5292
5293 return v;
5294}
5295
5296/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005297 * Set "copyID + 1" in previous_funccal and callers.
5298 */
5299 int
5300set_ref_in_previous_funccal(int copyID)
5301{
5302 int abort = FALSE;
5303 funccall_T *fc;
5304
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005305 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005306 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005307 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005308 abort = abort
5309 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5310 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005311 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 }
5313 return abort;
5314}
5315
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005316 static int
5317set_ref_in_funccal(funccall_T *fc, int copyID)
5318{
5319 int abort = FALSE;
5320
5321 if (fc->fc_copyID != copyID)
5322 {
5323 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005324 abort = abort
5325 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5326 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005327 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005328 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005329 }
5330 return abort;
5331}
5332
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005333/*
5334 * Set "copyID" in all local vars and arguments in the call stack.
5335 */
5336 int
5337set_ref_in_call_stack(int copyID)
5338{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005339 int abort = FALSE;
5340 funccall_T *fc;
5341 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005343 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005344 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005345
5346 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005347 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5348 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005349 abort = abort || set_ref_in_funccal(fc, copyID);
5350
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005351 return abort;
5352}
5353
5354/*
5355 * Set "copyID" in all functions available by name.
5356 */
5357 int
5358set_ref_in_functions(int copyID)
5359{
5360 int todo;
5361 hashitem_T *hi = NULL;
5362 int abort = FALSE;
5363 ufunc_T *fp;
5364
5365 todo = (int)func_hashtab.ht_used;
5366 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005367 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005368 if (!HASHITEM_EMPTY(hi))
5369 {
5370 --todo;
5371 fp = HI2UF(hi);
5372 if (!func_name_refcount(fp->uf_name))
5373 abort = abort || set_ref_in_func(NULL, fp, copyID);
5374 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005375 }
5376 return abort;
5377}
5378
5379/*
5380 * Set "copyID" in all function arguments.
5381 */
5382 int
5383set_ref_in_func_args(int copyID)
5384{
5385 int i;
5386 int abort = FALSE;
5387
5388 for (i = 0; i < funcargs.ga_len; ++i)
5389 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5390 copyID, NULL, NULL);
5391 return abort;
5392}
5393
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005394/*
5395 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005396 * Returns TRUE if setting references failed somehow.
5397 */
5398 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005399set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005400{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005401 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005402 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005403 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005404 char_u fname_buf[FLEN_FIXED + 1];
5405 char_u *tofree = NULL;
5406 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005407 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005408
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005409 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005410 return FALSE;
5411
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005412 if (fp_in == NULL)
5413 {
5414 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005415 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005416 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005417 if (fp != NULL)
5418 {
5419 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005420 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005421 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005422
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005423 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005424 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005425}
5426
Bram Moolenaare38eab22019-12-05 21:50:01 +01005427#endif // FEAT_EVAL