blob: a53c4769c7274c51641bbd4bd4fa2d9ecdebbeed [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)
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100973 {
974 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100975 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100976 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100977 if (cmdline != NULL)
978 {
979 // Something comes after the "}".
980 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100981
982 // "arg" points into cmdline, need to keep the line and free it later.
983 vim_free(evalarg->eval_tofree_cmdline);
984 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100985 }
986 else
987 *arg = (char_u *)"";
988
989 name = get_lambda_name();
990 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
991 if (ufunc == NULL)
992 goto erret;
993 set_ufunc_name(ufunc, name);
994 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
995 {
996 vim_free(ufunc);
997 goto erret;
998 }
999 ufunc->uf_refcount = 1;
1000 ufunc->uf_args = *newargs;
1001 newargs->ga_data = NULL;
1002 ufunc->uf_def_args = *default_args;
1003 default_args->ga_data = NULL;
1004 ufunc->uf_func_type = &t_func_any;
1005
1006 // error messages are for the first function line
1007 lnum_save = SOURCING_LNUM;
1008 SOURCING_LNUM = sourcing_lnum_top;
1009
1010 // parse argument types
1011 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1012 {
1013 SOURCING_LNUM = lnum_save;
1014 goto erret;
1015 }
1016
1017 // parse the return type, if any
1018 if (parse_return_type(ufunc, ret_type) == FAIL)
1019 goto erret;
1020
1021 pt = ALLOC_CLEAR_ONE(partial_T);
1022 if (pt == NULL)
1023 goto erret;
1024 pt->pt_func = ufunc;
1025 pt->pt_refcount = 1;
1026
1027 ufunc->uf_lines = newlines;
1028 newlines.ga_data = NULL;
1029 if (sandbox)
1030 ufunc->uf_flags |= FC_SANDBOX;
1031 if (!ASCII_ISUPPER(*ufunc->uf_name))
1032 ufunc->uf_flags |= FC_VIM9;
1033 ufunc->uf_script_ctx = current_sctx;
1034 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1035 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1036 set_function_type(ufunc);
1037
1038 rettv->vval.v_partial = pt;
1039 rettv->v_type = VAR_PARTIAL;
1040 ret = OK;
1041
1042erret:
1043 if (lnum_save >= 0)
1044 SOURCING_LNUM = lnum_save;
1045 vim_free(line_to_free);
1046 ga_clear_strings(&newlines);
1047 ga_clear_strings(newargs);
1048 ga_clear_strings(default_args);
1049 return ret;
1050}
1051
1052/*
1053 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001054 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001055 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001056 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1057 */
1058 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001059get_lambda_tv(
1060 char_u **arg,
1061 typval_T *rettv,
1062 int types_optional,
1063 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001064{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001065 int evaluate = evalarg != NULL
1066 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001067 garray_T newargs;
1068 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001069 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001070 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001071 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001072 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001073 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001074 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001075 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001076 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001077 char_u *s;
1078 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001079 int *old_eval_lavars = eval_lavars_used;
1080 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001081 char_u *tofree1 = NULL;
1082 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001083 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001084 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001085 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001086
1087 if (equal_arrow && !in_vim9script())
1088 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001089
1090 ga_init(&newargs);
1091 ga_init(&newlines);
1092
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001093 // First, check if this is really a lambda expression. "->" or "=>" must
1094 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001095 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001096 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001097 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001098 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001099 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001100 {
1101 if (types_optional)
1102 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001103 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001104 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001105
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001106 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001107 if (evaluate)
1108 pnewargs = &newargs;
1109 else
1110 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001111 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001112 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001113 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001114 &varargs, &default_args,
1115 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001116 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001117 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001118 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001119 {
1120 if (types_optional)
1121 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001122 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001123 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001124 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001125 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001126
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001127 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1128 if (ret_type != NULL)
1129 {
1130 ret_type = vim_strsave(ret_type);
1131 tofree2 = ret_type;
1132 }
1133
Bram Moolenaare38eab22019-12-05 21:50:01 +01001134 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001135 if (evaluate)
1136 eval_lavars_used = &eval_lavars;
1137
Bram Moolenaar65c44152020-12-24 15:14:01 +01001138 *arg = skipwhite_and_linebreak(*arg, evalarg);
1139
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001140 // Recognize "{" as the start of a function body.
1141 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001142 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001143 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1144 types_optional ? &argtypes : NULL, varargs,
1145 &default_args, ret_type) == FAIL)
1146 goto errret;
1147 goto theend;
1148 }
1149 if (default_args.ga_len > 0)
1150 {
1151 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001152 goto errret;
1153 }
1154
Bram Moolenaare38eab22019-12-05 21:50:01 +01001155 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001156 start = *arg;
1157 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001158 if (ret == FAIL)
1159 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001160 if (evalarg != NULL)
1161 {
1162 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001163 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001164 evalarg->eval_tofree = NULL;
1165 }
1166
Bram Moolenaar65c44152020-12-24 15:14:01 +01001167 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001168 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001169 *arg = skipwhite_and_linebreak(*arg, evalarg);
1170 if (**arg != '}')
1171 {
1172 semsg(_("E451: Expected }: %s"), *arg);
1173 goto errret;
1174 }
1175 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001177
1178 if (evaluate)
1179 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001180 int len;
1181 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001182 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001183 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001184
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001185 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001186 if (fp == NULL)
1187 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001188 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001189 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001190 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001191 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001192
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001193 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1194 if (ga_grow(&newlines, 1) == FAIL)
1195 goto errret;
1196
Bram Moolenaare38eab22019-12-05 21:50:01 +01001197 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001198 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001199 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001200 if (p == NULL)
1201 goto errret;
1202 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1203 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001204 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001205 if (strstr((char *)p + 7, "a:") == NULL)
1206 // No a: variables are used for sure.
1207 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001208
1209 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001210 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001211 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001212 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001213 if (types_optional)
1214 {
1215 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
1216 goto errret;
1217 if (ret_type != NULL)
1218 {
1219 fp->uf_ret_type = parse_type(&ret_type,
1220 &fp->uf_type_list, TRUE);
1221 if (fp->uf_ret_type == NULL)
1222 goto errret;
1223 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001224 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001225 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001226 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001227
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001228 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001229 if (current_funccal != NULL && eval_lavars)
1230 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001231 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001232 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001233 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001234 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001235
1236#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001237 if (prof_def_func())
1238 func_do_profile(fp);
1239#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001240 if (sandbox)
1241 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001242 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001243 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001244 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001245 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001246 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001247 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001248
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001249 pt->pt_func = fp;
1250 pt->pt_refcount = 1;
1251 rettv->vval.v_partial = pt;
1252 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001253
1254 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001255 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001257theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001258 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001259 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001260 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001261 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001262 vim_free(tofree1);
1263 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001264 if (types_optional)
1265 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001266 return OK;
1267
1268errret:
1269 ga_clear_strings(&newargs);
1270 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001271 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001272 if (types_optional)
1273 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001275 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001276 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001277 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001278 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001279 vim_free(tofree1);
1280 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001281 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001282 return FAIL;
1283}
1284
1285/*
1286 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1287 * name it contains, otherwise return "name".
1288 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1289 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001290 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1291 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001292 */
1293 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001294deref_func_name(
1295 char_u *name,
1296 int *lenp,
1297 partial_T **partialp,
1298 type_T **type,
1299 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001300{
1301 dictitem_T *v;
1302 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001303 char_u *s = NULL;
1304 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001305
1306 if (partialp != NULL)
1307 *partialp = NULL;
1308
1309 cc = name[*lenp];
1310 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001311 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001312 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001313 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001314 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001315 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001316 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001317 if (v->di_tv.vval.v_string == NULL)
1318 {
1319 *lenp = 0;
1320 return (char_u *)""; // just in case
1321 }
1322 s = v->di_tv.vval.v_string;
1323 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001325
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001326 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001327 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001328 partial_T *pt = v->di_tv.vval.v_partial;
1329
1330 if (pt == NULL)
1331 {
1332 *lenp = 0;
1333 return (char_u *)""; // just in case
1334 }
1335 if (partialp != NULL)
1336 *partialp = pt;
1337 s = partial_name(pt);
1338 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001339 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001340
1341 if (s != NULL)
1342 {
1343 if (type != NULL && ht == get_script_local_ht())
1344 {
1345 svar_T *sv = find_typval_in_script(&v->di_tv);
1346
1347 if (sv != NULL)
1348 *type = sv->sv_type;
1349 }
1350 return s;
1351 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001352 }
1353
1354 return name;
1355}
1356
1357/*
1358 * Give an error message with a function name. Handle <SNR> things.
1359 * "ermsg" is to be passed without translation, use N_() instead of _().
1360 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001361 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001362emsg_funcname(char *ermsg, char_u *name)
1363{
1364 char_u *p;
1365
1366 if (*name == K_SPECIAL)
1367 p = concat_str((char_u *)"<SNR>", name + 3);
1368 else
1369 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001370 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001371 if (p != name)
1372 vim_free(p);
1373}
1374
1375/*
1376 * Allocate a variable for the result of a function.
1377 * Return OK or FAIL.
1378 */
1379 int
1380get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001381 char_u *name, // name of the function
1382 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001384 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001385 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001386 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001387{
1388 char_u *argp;
1389 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001390 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1391 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001392 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001393
1394 /*
1395 * Get the arguments.
1396 */
1397 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001398 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1399 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001400 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001401 // skip the '(' or ',' and possibly line breaks
1402 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1403
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001404 if (*argp == ')' || *argp == ',' || *argp == NUL)
1405 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001406 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001407 {
1408 ret = FAIL;
1409 break;
1410 }
1411 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001412 // The comma should come right after the argument, but this wasn't
1413 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001414 if (vim9script)
1415 {
1416 if (*argp != ',' && *skipwhite(argp) == ',')
1417 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001418 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001419 ret = FAIL;
1420 break;
1421 }
1422 }
1423 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001424 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001425 if (*argp != ',')
1426 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001427 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1428 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001429 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001430 ret = FAIL;
1431 break;
1432 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001434 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001435 if (*argp == ')')
1436 ++argp;
1437 else
1438 ret = FAIL;
1439
1440 if (ret == OK)
1441 {
1442 int i = 0;
1443
1444 if (get_vim_var_nr(VV_TESTING))
1445 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001446 // Prepare for calling test_garbagecollect_now(), need to know
1447 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001448 if (funcargs.ga_itemsize == 0)
1449 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1450 for (i = 0; i < argcount; ++i)
1451 if (ga_grow(&funcargs, 1) == OK)
1452 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1453 &argvars[i];
1454 }
1455
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001456 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457
1458 funcargs.ga_len -= i;
1459 }
1460 else if (!aborting())
1461 {
1462 if (argcount == MAX_FUNC_ARGS)
1463 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1464 else
1465 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1466 }
1467
1468 while (--argcount >= 0)
1469 clear_tv(&argvars[argcount]);
1470
Bram Moolenaar8294d492020-08-10 22:40:56 +02001471 if (in_vim9script())
1472 *arg = argp;
1473 else
1474 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001475 return ret;
1476}
1477
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001478/*
1479 * Return TRUE if "p" starts with "<SID>" or "s:".
1480 * Only works if eval_fname_script() returned non-zero for "p"!
1481 */
1482 static int
1483eval_fname_sid(char_u *p)
1484{
1485 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1486}
1487
1488/*
1489 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1490 * Change <SNR>123_name() to K_SNR 123_name().
1491 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1492 * (slow).
1493 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001494 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001495fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1496{
1497 int llen;
1498 char_u *fname;
1499 int i;
1500
1501 llen = eval_fname_script(name);
1502 if (llen > 0)
1503 {
1504 fname_buf[0] = K_SPECIAL;
1505 fname_buf[1] = KS_EXTRA;
1506 fname_buf[2] = (int)KE_SNR;
1507 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001508 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001509 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001510 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001511 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001512 else
1513 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001514 sprintf((char *)fname_buf + 3, "%ld_",
1515 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001516 i = (int)STRLEN(fname_buf);
1517 }
1518 }
1519 if (i + STRLEN(name + llen) < FLEN_FIXED)
1520 {
1521 STRCPY(fname_buf + i, name + llen);
1522 fname = fname_buf;
1523 }
1524 else
1525 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001526 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001527 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001528 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001529 else
1530 {
1531 *tofree = fname;
1532 mch_memmove(fname, fname_buf, (size_t)i);
1533 STRCPY(fname + i, name + llen);
1534 }
1535 }
1536 }
1537 else
1538 fname = name;
1539 return fname;
1540}
1541
1542/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001543 * Find a function "name" in script "sid".
1544 */
1545 static ufunc_T *
1546find_func_with_sid(char_u *name, int sid)
1547{
1548 hashitem_T *hi;
1549 char_u buffer[200];
1550
1551 buffer[0] = K_SPECIAL;
1552 buffer[1] = KS_EXTRA;
1553 buffer[2] = (int)KE_SNR;
1554 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1555 (long)sid, name);
1556 hi = hash_find(&func_hashtab, buffer);
1557 if (!HASHITEM_EMPTY(hi))
1558 return HI2UF(hi);
1559
1560 return NULL;
1561}
1562
1563/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001564 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001565 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001566 * Return NULL for unknown function.
1567 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001568 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001569find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570{
1571 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001572 ufunc_T *func;
1573 imported_T *imported;
1574
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001575 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001576 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001577 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001578 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001579 int find_script_local = in_vim9script()
1580 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001581
Bram Moolenaar95006e32020-08-29 17:47:08 +02001582 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001583 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001584 // Find script-local function before global one.
1585 func = find_func_with_sid(name, current_sctx.sc_sid);
1586 if (func != NULL)
1587 return func;
1588 }
1589
Bram Moolenaarefa94442020-08-08 22:16:00 +02001590 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001591 && name[1] == KS_EXTRA
1592 && name[2] == KE_SNR)
1593 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001594 // Caller changes s: to <SNR>99_name.
1595
1596 after_script = name + 3;
1597 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001598 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001599 ++after_script;
1600 else
1601 after_script = NULL;
1602 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001603 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001604 {
1605 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001606 if (after_script != NULL && sid != current_sctx.sc_sid)
1607 imported = find_imported_in_script(after_script, 0, sid);
1608 else
1609 imported = find_imported(after_script == NULL
1610 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001611 if (imported != NULL && imported->imp_funcname != NULL)
1612 {
1613 hi = hash_find(&func_hashtab, imported->imp_funcname);
1614 if (!HASHITEM_EMPTY(hi))
1615 return HI2UF(hi);
1616 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001617 }
1618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001619
Bram Moolenaara26b9702020-04-18 19:53:28 +02001620 hi = hash_find(&func_hashtab,
1621 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622 if (!HASHITEM_EMPTY(hi))
1623 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001624
1625 return NULL;
1626}
1627
1628/*
1629 * Find a function by name, return pointer to it in ufuncs.
1630 * "cctx" is passed in a :def function to find imported functions.
1631 * Return NULL for unknown or dead function.
1632 */
1633 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001634find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001635{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001636 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001637
1638 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1639 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 return NULL;
1641}
1642
1643/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001644 * Return TRUE if "ufunc" is a global function.
1645 */
1646 int
1647func_is_global(ufunc_T *ufunc)
1648{
1649 return ufunc->uf_name[0] != K_SPECIAL;
1650}
1651
1652/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001653 * Copy the function name of "fp" to buffer "buf".
1654 * "buf" must be able to hold the function name plus three bytes.
1655 * Takes care of script-local function names.
1656 */
1657 static void
1658cat_func_name(char_u *buf, ufunc_T *fp)
1659{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001660 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 {
1662 STRCPY(buf, "<SNR>");
1663 STRCAT(buf, fp->uf_name + 3);
1664 }
1665 else
1666 STRCPY(buf, fp->uf_name);
1667}
1668
1669/*
1670 * Add a number variable "name" to dict "dp" with value "nr".
1671 */
1672 static void
1673add_nr_var(
1674 dict_T *dp,
1675 dictitem_T *v,
1676 char *name,
1677 varnumber_T nr)
1678{
1679 STRCPY(v->di_key, name);
1680 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1681 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1682 v->di_tv.v_type = VAR_NUMBER;
1683 v->di_tv.v_lock = VAR_FIXED;
1684 v->di_tv.vval.v_number = nr;
1685}
1686
1687/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001688 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001689 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001690 static void
1691free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001692{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001693 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001694
1695 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1696 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001697 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001698
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001699 // When garbage collecting a funccall_T may be freed before the
1700 // function that references it, clear its uf_scoped field.
1701 // The function may have been redefined and point to another
1702 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001703 if (fp != NULL && fp->uf_scoped == fc)
1704 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001705 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001706 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001707
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001708 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001709 vim_free(fc);
1710}
1711
1712/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001713 * Free "fc" and what it contains.
1714 * Can be called only when "fc" is kept beyond the period of it called,
1715 * i.e. after cleanup_function_call(fc).
1716 */
1717 static void
1718free_funccal_contents(funccall_T *fc)
1719{
1720 listitem_T *li;
1721
1722 // Free all l: variables.
1723 vars_clear(&fc->l_vars.dv_hashtab);
1724
1725 // Free all a: variables.
1726 vars_clear(&fc->l_avars.dv_hashtab);
1727
1728 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001729 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001730 clear_tv(&li->li_tv);
1731
1732 free_funccal(fc);
1733}
1734
1735/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001736 * Handle the last part of returning from a function: free the local hashtable.
1737 * Unless it is still in use by a closure.
1738 */
1739 static void
1740cleanup_function_call(funccall_T *fc)
1741{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001742 int may_free_fc = fc->fc_refcount <= 0;
1743 int free_fc = TRUE;
1744
Bram Moolenaar6914c642017-04-01 21:21:30 +02001745 current_funccal = fc->caller;
1746
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001747 // Free all l: variables if not referred.
1748 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1749 vars_clear(&fc->l_vars.dv_hashtab);
1750 else
1751 free_fc = FALSE;
1752
1753 // If the a:000 list and the l: and a: dicts are not referenced and
1754 // there is no closure using it, we can free the funccall_T and what's
1755 // in it.
1756 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1757 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001758 else
1759 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001760 int todo;
1761 hashitem_T *hi;
1762 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001763
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001764 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001765
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001766 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001767 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1768 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1769 {
1770 if (!HASHITEM_EMPTY(hi))
1771 {
1772 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001773 di = HI2DI(hi);
1774 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001775 }
1776 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001777 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001778
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001779 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1780 fc->l_varlist.lv_first = NULL;
1781 else
1782 {
1783 listitem_T *li;
1784
1785 free_fc = FALSE;
1786
1787 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001788 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001789 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001790 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001791
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001792 if (free_fc)
1793 free_funccal(fc);
1794 else
1795 {
1796 static int made_copy = 0;
1797
1798 // "fc" is still in use. This can happen when returning "a:000",
1799 // assigning "l:" to a global variable or defining a closure.
1800 // Link "fc" in the list for garbage collection later.
1801 fc->caller = previous_funccal;
1802 previous_funccal = fc;
1803
1804 if (want_garbage_collect)
1805 // If garbage collector is ready, clear count.
1806 made_copy = 0;
1807 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001808 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001809 // We have made a lot of copies, worth 4 Mbyte. This can happen
1810 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001811 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001812 // too much memory.
1813 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001814 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001815 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001816 }
1817}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001818
1819/*
1820 * There are two kinds of function names:
1821 * 1. ordinary names, function defined with :function or :def
1822 * 2. numbered functions and lambdas
1823 * For the first we only count the name stored in func_hashtab as a reference,
1824 * using function() does not count as a reference, because the function is
1825 * looked up by name.
1826 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001827 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001828func_name_refcount(char_u *name)
1829{
1830 return isdigit(*name) || *name == '<';
1831}
1832
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001833/*
1834 * Unreference "fc": decrement the reference count and free it when it
1835 * becomes zero. "fp" is detached from "fc".
1836 * When "force" is TRUE we are exiting.
1837 */
1838 static void
1839funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1840{
1841 funccall_T **pfc;
1842 int i;
1843
1844 if (fc == NULL)
1845 return;
1846
1847 if (--fc->fc_refcount <= 0 && (force || (
1848 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1849 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1850 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1851 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1852 {
1853 if (fc == *pfc)
1854 {
1855 *pfc = fc->caller;
1856 free_funccal_contents(fc);
1857 return;
1858 }
1859 }
1860 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1861 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1862 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1863}
1864
1865/*
1866 * Remove the function from the function hashtable. If the function was
1867 * deleted while it still has references this was already done.
1868 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1869 */
1870 static int
1871func_remove(ufunc_T *fp)
1872{
1873 hashitem_T *hi;
1874
1875 // Return if it was already virtually deleted.
1876 if (fp->uf_flags & FC_DEAD)
1877 return FALSE;
1878
1879 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1880 if (!HASHITEM_EMPTY(hi))
1881 {
1882 // When there is a def-function index do not actually remove the
1883 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001884 // Do remove it when it's a copy.
1885 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001886 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001887 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001888 return FALSE;
1889 }
1890 hash_remove(&func_hashtab, hi);
1891 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001892 return TRUE;
1893 }
1894 return FALSE;
1895}
1896
1897 static void
1898func_clear_items(ufunc_T *fp)
1899{
1900 ga_clear_strings(&(fp->uf_args));
1901 ga_clear_strings(&(fp->uf_def_args));
1902 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001903 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001904 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001905 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001906 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001907 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001908
1909 // Increment the refcount of this function to avoid it being freed
1910 // recursively when the partial is freed.
1911 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001912 partial_unref(fp->uf_partial);
1913 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001914 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001915
1916#ifdef FEAT_LUA
1917 if (fp->uf_cb_free != NULL)
1918 {
1919 fp->uf_cb_free(fp->uf_cb_state);
1920 fp->uf_cb_free = NULL;
1921 }
1922
1923 fp->uf_cb_state = NULL;
1924 fp->uf_cb = NULL;
1925#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001926#ifdef FEAT_PROFILE
1927 VIM_CLEAR(fp->uf_tml_count);
1928 VIM_CLEAR(fp->uf_tml_total);
1929 VIM_CLEAR(fp->uf_tml_self);
1930#endif
1931}
1932
1933/*
1934 * Free all things that a function contains. Does not free the function
1935 * itself, use func_free() for that.
1936 * When "force" is TRUE we are exiting.
1937 */
1938 static void
1939func_clear(ufunc_T *fp, int force)
1940{
1941 if (fp->uf_cleared)
1942 return;
1943 fp->uf_cleared = TRUE;
1944
1945 // clear this function
1946 func_clear_items(fp);
1947 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001948 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001949}
1950
1951/*
1952 * Free a function and remove it from the list of functions. Does not free
1953 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001954 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001955 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001956 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001957 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001958func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001959{
1960 // Only remove it when not done already, otherwise we would remove a newer
1961 // version of the function with the same name.
1962 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1963 func_remove(fp);
1964
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001965 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001966 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001967 if (fp->uf_dfunc_idx > 0)
1968 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001969 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001970 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001971 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001972 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001973 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001974}
1975
1976/*
1977 * Free all things that a function contains and free the function itself.
1978 * When "force" is TRUE we are exiting.
1979 */
1980 static void
1981func_clear_free(ufunc_T *fp, int force)
1982{
1983 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001984 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1985 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001986 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001987 else
1988 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001989}
1990
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001991/*
1992 * Copy already defined function "lambda" to a new function with name "global".
1993 * This is for when a compiled function defines a global function.
1994 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001995 int
1996copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001997{
1998 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01001999 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002000
2001 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002002 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002003 semsg(_(e_lambda_function_not_found_str), lambda);
2004 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002005 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002006
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002007 fp = find_func(global, TRUE, NULL);
2008 if (fp != NULL)
2009 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002010 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002011 semsg(_(e_funcexts), global);
2012 return FAIL;
2013 }
2014
2015 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2016 if (fp == NULL)
2017 return FAIL;
2018
2019 fp->uf_varargs = ufunc->uf_varargs;
2020 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2021 fp->uf_def_status = ufunc->uf_def_status;
2022 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2023 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2024 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2025 == FAIL
2026 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2027 goto failed;
2028
2029 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2030 : vim_strsave(ufunc->uf_name_exp);
2031 if (ufunc->uf_arg_types != NULL)
2032 {
2033 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2034 if (fp->uf_arg_types == NULL)
2035 goto failed;
2036 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2037 sizeof(type_T *) * fp->uf_args.ga_len);
2038 }
2039 if (ufunc->uf_def_arg_idx != NULL)
2040 {
2041 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
2042 if (fp->uf_def_arg_idx == NULL)
2043 goto failed;
2044 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
2045 sizeof(int) * fp->uf_def_args.ga_len + 1);
2046 }
2047 if (ufunc->uf_va_name != NULL)
2048 {
2049 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2050 if (fp->uf_va_name == NULL)
2051 goto failed;
2052 }
2053 fp->uf_ret_type = ufunc->uf_ret_type;
2054
2055 fp->uf_refcount = 1;
2056 STRCPY(fp->uf_name, global);
2057 hash_add(&func_hashtab, UF2HIKEY(fp));
2058
2059 // the referenced dfunc_T is now used one more time
2060 link_def_function(fp);
2061
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002062 // Create a partial to store the context of the function where it was
2063 // instantiated. Only needs to be done once. Do this on the original
2064 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002065 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2066 {
2067 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2068
2069 if (pt == NULL)
2070 goto failed;
2071 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002072 {
2073 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002074 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002075 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002076 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002077 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002078 }
2079
2080 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002081
2082failed:
2083 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002084 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002085}
2086
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002087static int funcdepth = 0;
2088
2089/*
2090 * Increment the function call depth count.
2091 * Return FAIL when going over 'maxfuncdepth'.
2092 * Otherwise return OK, must call funcdepth_decrement() later!
2093 */
2094 int
2095funcdepth_increment(void)
2096{
2097 if (funcdepth >= p_mfd)
2098 {
2099 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2100 return FAIL;
2101 }
2102 ++funcdepth;
2103 return OK;
2104}
2105
2106 void
2107funcdepth_decrement(void)
2108{
2109 --funcdepth;
2110}
2111
2112/*
2113 * Get the current function call depth.
2114 */
2115 int
2116funcdepth_get(void)
2117{
2118 return funcdepth;
2119}
2120
2121/*
2122 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002123 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002124 * times as funcdepth_increment().
2125 */
2126 void
2127funcdepth_restore(int depth)
2128{
2129 funcdepth = depth;
2130}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002131
2132/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002133 * Call a user function.
2134 */
2135 static void
2136call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002137 ufunc_T *fp, // pointer to function
2138 int argcount, // nr of args
2139 typval_T *argvars, // arguments
2140 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002141 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002142 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002143{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002144 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002145 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002146 funccall_T *fc;
2147 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002148 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002149 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002150 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151 int i;
2152 int ai;
2153 int islambda = FALSE;
2154 char_u numbuf[NUMBUFLEN];
2155 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002157 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002158#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002159 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002160
Bram Moolenaarb2049902021-01-24 12:53:53 +01002161#ifdef FEAT_PROFILE
2162 CLEAR_FIELD(profile_info);
2163#endif
2164
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002165 // If depth of calling is getting too high, don't execute the function.
2166 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002167 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002168 rettv->v_type = VAR_NUMBER;
2169 rettv->vval.v_number = -1;
2170 return;
2171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002172
Bram Moolenaare38eab22019-12-05 21:50:01 +01002173 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002174
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002175 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002176 if (fc == NULL)
2177 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002178 fc->caller = current_funccal;
2179 current_funccal = fc;
2180 fc->func = fp;
2181 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002182 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002183 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002184 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2185 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002186 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002187 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002188 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002189
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002190 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002191 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002192#ifdef FEAT_PROFILE
2193 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2194#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002195 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002196#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002197 if (do_profiling == PROF_YES)
2198 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002199#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002200 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002201 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002202#ifdef FEAT_PROFILE
2203 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002204 || (caller != NULL && caller->uf_profiling)))
2205 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002206#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002207 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002208 free_funccal(fc);
2209 return;
2210 }
2211
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002212 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2213 islambda = TRUE;
2214
2215 /*
2216 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2217 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2218 * each argument variable and saves a lot of time.
2219 */
2220 /*
2221 * Init l: variables.
2222 */
2223 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2224 if (selfdict != NULL)
2225 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002226 // Set l:self to "selfdict". Use "name" to avoid a warning from
2227 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002228 v = &fc->fixvar[fixvar_idx++].var;
2229 name = v->di_key;
2230 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002231 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002232 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2233 v->di_tv.v_type = VAR_DICT;
2234 v->di_tv.v_lock = 0;
2235 v->di_tv.vval.v_dict = selfdict;
2236 ++selfdict->dv_refcount;
2237 }
2238
2239 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002240 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002241 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002242 * Set a:000 to a list with room for the "..." arguments.
2243 */
2244 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002245 if ((fp->uf_flags & FC_NOARGS) == 0)
2246 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002247 (varnumber_T)(argcount >= fp->uf_args.ga_len
2248 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002249 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002250 if ((fp->uf_flags & FC_NOARGS) == 0)
2251 {
2252 // Use "name" to avoid a warning from some compiler that checks the
2253 // destination size.
2254 v = &fc->fixvar[fixvar_idx++].var;
2255 name = v->di_key;
2256 STRCPY(name, "000");
2257 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2258 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2259 v->di_tv.v_type = VAR_LIST;
2260 v->di_tv.v_lock = VAR_FIXED;
2261 v->di_tv.vval.v_list = &fc->l_varlist;
2262 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002263 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002264 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2265 fc->l_varlist.lv_lock = VAR_FIXED;
2266
2267 /*
2268 * Set a:firstline to "firstline" and a:lastline to "lastline".
2269 * Set a:name to named arguments.
2270 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002271 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002272 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002273 if ((fp->uf_flags & FC_NOARGS) == 0)
2274 {
2275 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002276 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002277 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002278 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002279 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002280 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002281 {
2282 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002283 typval_T def_rettv;
2284 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002285
2286 ai = i - fp->uf_args.ga_len;
2287 if (ai < 0)
2288 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002289 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290 name = FUNCARG(fp, i);
2291 if (islambda)
2292 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002293
2294 // evaluate named argument default expression
2295 isdefault = ai + fp->uf_def_args.ga_len >= 0
2296 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2297 && argvars[i].vval.v_number == VVAL_NONE));
2298 if (isdefault)
2299 {
2300 char_u *default_expr = NULL;
2301 def_rettv.v_type = VAR_NUMBER;
2302 def_rettv.vval.v_number = -1;
2303
2304 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2305 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002306 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002307 {
2308 default_arg_err = 1;
2309 break;
2310 }
2311 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002312 }
2313 else
2314 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002315 if ((fp->uf_flags & FC_NOARGS) != 0)
2316 // Bail out if no a: arguments used (in lambda).
2317 break;
2318
Bram Moolenaare38eab22019-12-05 21:50:01 +01002319 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320 sprintf((char *)numbuf, "%d", ai + 1);
2321 name = numbuf;
2322 }
2323 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2324 {
2325 v = &fc->fixvar[fixvar_idx++].var;
2326 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002327 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328 }
2329 else
2330 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002331 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002332 if (v == NULL)
2333 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002334 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002335 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002337 // Note: the values are copied directly to avoid alloc/free.
2338 // "argvars" must have VAR_FIXED for v_lock.
2339 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340 v->di_tv.v_lock = VAR_FIXED;
2341
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002342 if (addlocal)
2343 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002344 // Named arguments should be accessed without the "a:" prefix in
2345 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002346 copy_tv(&v->di_tv, &v->di_tv);
2347 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002349 else
2350 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002351
2352 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2353 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002354 listitem_T *li = &fc->l_listitems[ai];
2355
2356 li->li_tv = argvars[i];
2357 li->li_tv.v_lock = VAR_FIXED;
2358 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359 }
2360 }
2361
Bram Moolenaare38eab22019-12-05 21:50:01 +01002362 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002363 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002364
2365 if (fp->uf_flags & FC_SANDBOX)
2366 {
2367 using_sandbox = TRUE;
2368 ++sandbox;
2369 }
2370
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002371 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002372 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002373 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002374 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002375 ++no_wait_return;
2376 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002377
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002378 smsg(_("calling %s"), SOURCING_NAME);
2379 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002380 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002381 char_u buf[MSG_BUF_LEN];
2382 char_u numbuf2[NUMBUFLEN];
2383 char_u *tofree;
2384 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002386 msg_puts("(");
2387 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002388 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002389 if (i > 0)
2390 msg_puts(", ");
2391 if (argvars[i].v_type == VAR_NUMBER)
2392 msg_outnum((long)argvars[i].vval.v_number);
2393 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002394 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002395 // Do not want errors such as E724 here.
2396 ++emsg_off;
2397 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2398 --emsg_off;
2399 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002400 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002401 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002402 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002403 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2404 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002406 msg_puts((char *)s);
2407 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002408 }
2409 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002411 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002412 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002413 msg_puts("\n"); // don't overwrite this either
2414
2415 verbose_leave_scroll();
2416 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002417 }
2418#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002419 if (do_profiling == PROF_YES)
2420 profile_may_start_func(&profile_info, fp,
2421 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422#endif
2423
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002424 save_current_sctx = current_sctx;
2425 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002426 save_did_emsg = did_emsg;
2427 did_emsg = FALSE;
2428
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002429 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2430 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002431 else if (islambda)
2432 {
2433 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2434
2435 // A Lambda always has the command "return {expr}". It is much faster
2436 // to evaluate {expr} directly.
2437 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002438 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002439 --ex_nesting_level;
2440 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002441 else
2442 // call do_cmdline() to execute the lines
2443 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002444 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2445
2446 --RedrawingDisabled;
2447
Bram Moolenaare38eab22019-12-05 21:50:01 +01002448 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2450 {
2451 clear_tv(rettv);
2452 rettv->v_type = VAR_NUMBER;
2453 rettv->vval.v_number = -1;
2454 }
2455
2456#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002457 if (do_profiling == PROF_YES)
2458 {
2459 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2460
2461 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2462 profile_may_end_func(&profile_info, fp, caller);
2463 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002464#endif
2465
Bram Moolenaare38eab22019-12-05 21:50:01 +01002466 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002467 if (p_verbose >= 12)
2468 {
2469 ++no_wait_return;
2470 verbose_enter_scroll();
2471
2472 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002473 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002474 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002475 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002476 (long)fc->rettv->vval.v_number);
2477 else
2478 {
2479 char_u buf[MSG_BUF_LEN];
2480 char_u numbuf2[NUMBUFLEN];
2481 char_u *tofree;
2482 char_u *s;
2483
Bram Moolenaare38eab22019-12-05 21:50:01 +01002484 // The value may be very long. Skip the middle part, so that we
2485 // have some idea how it starts and ends. smsg() would always
2486 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002487 ++emsg_off;
2488 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2489 --emsg_off;
2490 if (s != NULL)
2491 {
2492 if (vim_strsize(s) > MSG_BUF_CLEN)
2493 {
2494 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2495 s = buf;
2496 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002497 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002498 vim_free(tofree);
2499 }
2500 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002501 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002502
2503 verbose_leave_scroll();
2504 --no_wait_return;
2505 }
2506
Bram Moolenaare31ee862020-01-07 20:59:34 +01002507 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002508 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002509 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510#ifdef FEAT_PROFILE
2511 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002512 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002513#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002514 if (using_sandbox)
2515 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002516
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002517 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518 {
2519 ++no_wait_return;
2520 verbose_enter_scroll();
2521
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002522 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002523 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524
2525 verbose_leave_scroll();
2526 --no_wait_return;
2527 }
2528
2529 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002530 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002531 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532}
2533
2534/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002535 * Check the argument count for user function "fp".
2536 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2537 */
2538 int
2539check_user_func_argcount(ufunc_T *fp, int argcount)
2540{
2541 int regular_args = fp->uf_args.ga_len;
2542
2543 if (argcount < regular_args - fp->uf_def_args.ga_len)
2544 return FCERR_TOOFEW;
2545 else if (!has_varargs(fp) && argcount > regular_args)
2546 return FCERR_TOOMANY;
2547 return FCERR_UNKNOWN;
2548}
2549
2550/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002551 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002552 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002553 int
2554call_user_func_check(
2555 ufunc_T *fp,
2556 int argcount,
2557 typval_T *argvars,
2558 typval_T *rettv,
2559 funcexe_T *funcexe,
2560 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002561{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002562 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002563
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002564 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2565 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002566 error = check_user_func_argcount(fp, argcount);
2567 if (error != FCERR_UNKNOWN)
2568 return error;
2569 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002570 error = FCERR_DICT;
2571 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002572 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002573 int did_save_redo = FALSE;
2574 save_redo_T save_redo;
2575
2576 /*
2577 * Call the user function.
2578 * Save and restore search patterns, script variables and
2579 * redo buffer.
2580 */
2581 save_search_patterns();
2582 if (!ins_compl_active())
2583 {
2584 saveRedobuff(&save_redo);
2585 did_save_redo = TRUE;
2586 }
2587 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002588 call_user_func(fp, argcount, argvars, rettv, funcexe,
2589 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002590 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2591 // Function was unreferenced while being used, free it now.
2592 func_clear_free(fp, FALSE);
2593 if (did_save_redo)
2594 restoreRedobuff(&save_redo);
2595 restore_search_patterns();
2596 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002597 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002598 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002599}
2600
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002601static funccal_entry_T *funccal_stack = NULL;
2602
2603/*
2604 * Save the current function call pointer, and set it to NULL.
2605 * Used when executing autocommands and for ":source".
2606 */
2607 void
2608save_funccal(funccal_entry_T *entry)
2609{
2610 entry->top_funccal = current_funccal;
2611 entry->next = funccal_stack;
2612 funccal_stack = entry;
2613 current_funccal = NULL;
2614}
2615
2616 void
2617restore_funccal(void)
2618{
2619 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002620 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002621 else
2622 {
2623 current_funccal = funccal_stack->top_funccal;
2624 funccal_stack = funccal_stack->next;
2625 }
2626}
2627
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002628 funccall_T *
2629get_current_funccal(void)
2630{
2631 return current_funccal;
2632}
2633
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002634/*
2635 * Mark all functions of script "sid" as deleted.
2636 */
2637 void
2638delete_script_functions(int sid)
2639{
2640 hashitem_T *hi;
2641 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002642 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002643 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002644 size_t len;
2645
2646 buf[0] = K_SPECIAL;
2647 buf[1] = KS_EXTRA;
2648 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002649 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002650 len = STRLEN(buf);
2651
Bram Moolenaarce658352020-07-31 23:47:12 +02002652 while (todo > 0)
2653 {
2654 todo = func_hashtab.ht_used;
2655 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2656 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002657 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002658 fp = HI2UF(hi);
2659 if (STRNCMP(fp->uf_name, buf, len) == 0)
2660 {
2661 int changed = func_hashtab.ht_changed;
2662
2663 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002664
2665 if (fp->uf_calls > 0)
2666 {
2667 // Function is executing, don't free it but do remove
2668 // it from the hashtable.
2669 if (func_remove(fp))
2670 fp->uf_refcount--;
2671 }
2672 else
2673 {
2674 func_clear(fp, TRUE);
2675 // When clearing a function another function can be
2676 // cleared as a side effect. When that happens start
2677 // over.
2678 if (changed != func_hashtab.ht_changed)
2679 break;
2680 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002681 }
2682 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002683 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002684 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002685}
2686
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002687#if defined(EXITFREE) || defined(PROTO)
2688 void
2689free_all_functions(void)
2690{
2691 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002692 ufunc_T *fp;
2693 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002694 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002695 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002696
Bram Moolenaare38eab22019-12-05 21:50:01 +01002697 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002698 while (current_funccal != NULL)
2699 {
2700 clear_tv(current_funccal->rettv);
2701 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002702 if (current_funccal == NULL && funccal_stack != NULL)
2703 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002704 }
2705
Bram Moolenaare38eab22019-12-05 21:50:01 +01002706 // First clear what the functions contain. Since this may lower the
2707 // reference count of a function, it may also free a function and change
2708 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002709 while (todo > 0)
2710 {
2711 todo = func_hashtab.ht_used;
2712 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2713 if (!HASHITEM_EMPTY(hi))
2714 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002715 // clear the def function index now
2716 fp = HI2UF(hi);
2717 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002718 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002719
Bram Moolenaare38eab22019-12-05 21:50:01 +01002720 // Only free functions that are not refcounted, those are
2721 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002722 if (func_name_refcount(fp->uf_name))
2723 ++skipped;
2724 else
2725 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002726 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002727 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002728 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002729 {
2730 skipped = 0;
2731 break;
2732 }
2733 }
2734 --todo;
2735 }
2736 }
2737
Bram Moolenaare38eab22019-12-05 21:50:01 +01002738 // Now actually free the functions. Need to start all over every time,
2739 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002740 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002741 while (func_hashtab.ht_used > skipped)
2742 {
2743 todo = func_hashtab.ht_used;
2744 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002745 if (!HASHITEM_EMPTY(hi))
2746 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002747 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002748 // Only free functions that are not refcounted, those are
2749 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002750 fp = HI2UF(hi);
2751 if (func_name_refcount(fp->uf_name))
2752 ++skipped;
2753 else
2754 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002755 if (func_free(fp, FALSE) == OK)
2756 {
2757 skipped = 0;
2758 break;
2759 }
2760 // did not actually free it
2761 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002762 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002763 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002764 }
2765 if (skipped == 0)
2766 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002767
2768 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769}
2770#endif
2771
2772/*
2773 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002774 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 * "len" is the length of "name", or -1 for NUL terminated.
2776 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002777 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778builtin_function(char_u *name, int len)
2779{
2780 char_u *p;
2781
Bram Moolenaara26b9702020-04-18 19:53:28 +02002782 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 return FALSE;
2784 p = vim_strchr(name, AUTOLOAD_CHAR);
2785 return p == NULL || (len > 0 && p > name + len);
2786}
2787
2788 int
2789func_call(
2790 char_u *name,
2791 typval_T *args,
2792 partial_T *partial,
2793 dict_T *selfdict,
2794 typval_T *rettv)
2795{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002796 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 listitem_T *item;
2798 typval_T argv[MAX_FUNC_ARGS + 1];
2799 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002800 int r = 0;
2801
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002802 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002803 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002804 {
2805 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2806 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002807 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808 break;
2809 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002810 // Make a copy of each argument. This is needed to be able to set
2811 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 copy_tv(&item->li_tv, &argv[argc++]);
2813 }
2814
2815 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002816 {
2817 funcexe_T funcexe;
2818
Bram Moolenaara80faa82020-04-12 19:37:17 +02002819 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002820 funcexe.firstline = curwin->w_cursor.lnum;
2821 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002822 funcexe.evaluate = TRUE;
2823 funcexe.partial = partial;
2824 funcexe.selfdict = selfdict;
2825 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2826 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827
Bram Moolenaare38eab22019-12-05 21:50:01 +01002828 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 while (argc > 0)
2830 clear_tv(&argv[--argc]);
2831
2832 return r;
2833}
2834
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002835static int callback_depth = 0;
2836
2837 int
2838get_callback_depth(void)
2839{
2840 return callback_depth;
2841}
2842
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002844 * Invoke call_func() with a callback.
2845 */
2846 int
2847call_callback(
2848 callback_T *callback,
2849 int len, // length of "name" or -1 to use strlen()
2850 typval_T *rettv, // return value goes here
2851 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002852 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002853 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002854{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002855 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002856 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002857
Bram Moolenaara80faa82020-04-12 19:37:17 +02002858 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002859 funcexe.evaluate = TRUE;
2860 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002861 ++callback_depth;
2862 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2863 --callback_depth;
2864 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002865}
2866
2867/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002868 * Give an error message for the result of a function.
2869 * Nothing if "error" is FCERR_NONE.
2870 */
2871 void
2872user_func_error(int error, char_u *name)
2873{
2874 switch (error)
2875 {
2876 case FCERR_UNKNOWN:
2877 emsg_funcname(e_unknownfunc, name);
2878 break;
2879 case FCERR_NOTMETHOD:
2880 emsg_funcname(
2881 N_("E276: Cannot use function as a method: %s"), name);
2882 break;
2883 case FCERR_DELETED:
2884 emsg_funcname(N_(e_func_deleted), name);
2885 break;
2886 case FCERR_TOOMANY:
2887 emsg_funcname((char *)e_toomanyarg, name);
2888 break;
2889 case FCERR_TOOFEW:
2890 emsg_funcname((char *)e_toofewarg, name);
2891 break;
2892 case FCERR_SCRIPT:
2893 emsg_funcname(
2894 N_("E120: Using <SID> not in a script context: %s"), name);
2895 break;
2896 case FCERR_DICT:
2897 emsg_funcname(
2898 N_("E725: Calling dict function without Dictionary: %s"),
2899 name);
2900 break;
2901 }
2902}
2903
2904/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002906 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 * Return FAIL when the function can't be called, OK otherwise.
2908 * Also returns OK when an error was encountered while executing the function.
2909 */
2910 int
2911call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002912 char_u *funcname, // name of the function
2913 int len, // length of "name" or -1 to use strlen()
2914 typval_T *rettv, // return value goes here
2915 int argcount_in, // number of "argvars"
2916 typval_T *argvars_in, // vars for arguments, must have "argcount"
2917 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002918 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002919{
2920 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002921 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002922 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002923 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 char_u fname_buf[FLEN_FIXED + 1];
2925 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002926 char_u *fname = NULL;
2927 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928 int argcount = argcount_in;
2929 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002930 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002931 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2932 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002933 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002934 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002935 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002937 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2938 // even when call_func() returns FAIL.
2939 rettv->v_type = VAR_UNKNOWN;
2940
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002941 if (partial != NULL)
2942 fp = partial->pt_func;
2943 if (fp == NULL)
2944 {
2945 // Make a copy of the name, if it comes from a funcref variable it
2946 // could be changed or deleted in the called function.
2947 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2948 if (name == NULL)
2949 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002951 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2952 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002954 if (funcexe->doesrange != NULL)
2955 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002956
2957 if (partial != NULL)
2958 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002959 // When the function has a partial with a dict and there is a dict
2960 // argument, use the dict argument. That is backwards compatible.
2961 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002962 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002963 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002964 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 {
2966 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002967 {
2968 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2969 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002970 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002971 goto theend;
2972 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002973 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002974 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002975 for (i = 0; i < argcount_in; ++i)
2976 argv[i + argv_clear] = argvars_in[i];
2977 argvars = argv;
2978 argcount = partial->pt_argc + argcount_in;
2979 }
2980 }
2981
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002982 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2983 {
2984 // Check that the argument types are OK for the types of the funcref.
2985 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01002986 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002987 error = FCERR_OTHER;
2988 }
2989
Bram Moolenaaref140542019-12-31 21:27:13 +01002990 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 {
2992 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002993 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994
Bram Moolenaar333894b2020-08-01 18:53:07 +02002995 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002996 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02002997 {
2998 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002999 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003000 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003001
Bram Moolenaare38eab22019-12-05 21:50:01 +01003002 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003004 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003005
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003006 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 {
3008 /*
3009 * User defined function.
3010 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003011 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003012 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013
Bram Moolenaare38eab22019-12-05 21:50:01 +01003014 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003015 if (fp == NULL
3016 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003017 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018 && !aborting())
3019 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003020 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003021 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003023 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3025 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003026 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003027 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003029 if (fp == NULL)
3030 {
3031 char_u *p = untrans_function_name(rfname);
3032
3033 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003034 // Don't do this if the name starts with "s:".
3035 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003036 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003037 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003039 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003040 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003041#ifdef FEAT_LUA
3042 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3043 {
3044 cfunc_T cb = fp->uf_cb;
3045
3046 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3047 }
3048#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003049 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003050 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003051 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003052 // postponed filling in the arguments, do it now
3053 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003054 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003055
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003056 if (funcexe->basetv != NULL)
3057 {
3058 // Method call: base->Method()
3059 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3060 argv[0] = *funcexe->basetv;
3061 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003062 argvars = argv;
3063 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003064 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003065
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003066 error = call_user_func_check(fp, argcount, argvars, rettv,
3067 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003068 }
3069 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003070 else if (funcexe->basetv != NULL)
3071 {
3072 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003073 * expr->method(): Find the method name in the table, call its
3074 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003075 */
3076 error = call_internal_method(fname, argcount, argvars, rettv,
3077 funcexe->basetv);
3078 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003079 else
3080 {
3081 /*
3082 * Find the function name in the table, call its implementation.
3083 */
3084 error = call_internal_func(fname, argcount, argvars, rettv);
3085 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003086
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 /*
3088 * The function call (or "FuncUndefined" autocommand sequence) might
3089 * have been aborted by an error, an interrupt, or an explicitly thrown
3090 * exception that has not been caught so far. This situation can be
3091 * tested for by calling aborting(). For an error in an internal
3092 * function or for the "E132" error in call_user_func(), however, the
3093 * throw point at which the "force_abort" flag (temporarily reset by
3094 * emsg()) is normally updated has not been reached yet. We need to
3095 * update that flag first to make aborting() reliable.
3096 */
3097 update_force_abort();
3098 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003099 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003100 ret = OK;
3101
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003102theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003103 /*
3104 * Report an error unless the argument evaluation or function call has been
3105 * cancelled due to an aborting error, an interrupt, or an exception.
3106 */
3107 if (!aborting())
3108 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003109 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003110 }
3111
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003112 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003113 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003114 clear_tv(&argv[--argv_clear + argv_base]);
3115
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003116 vim_free(tofree);
3117 vim_free(name);
3118
3119 return ret;
3120}
3121
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003122 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003123printable_func_name(ufunc_T *fp)
3124{
3125 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3126}
3127
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003128/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003129 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003130 */
3131 static void
3132list_func_head(ufunc_T *fp, int indent)
3133{
3134 int j;
3135
3136 msg_start();
3137 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003138 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003139 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003140 msg_puts("def ");
3141 else
3142 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003143 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003144 msg_putchar('(');
3145 for (j = 0; j < fp->uf_args.ga_len; ++j)
3146 {
3147 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003148 msg_puts(", ");
3149 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003150 if (fp->uf_arg_types != NULL)
3151 {
3152 char *tofree;
3153
3154 msg_puts(": ");
3155 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3156 vim_free(tofree);
3157 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003158 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3159 {
3160 msg_puts(" = ");
3161 msg_puts(((char **)(fp->uf_def_args.ga_data))
3162 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3163 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003164 }
3165 if (fp->uf_varargs)
3166 {
3167 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003168 msg_puts(", ");
3169 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003170 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003171 if (fp->uf_va_name != NULL)
3172 {
3173 if (j)
3174 msg_puts(", ");
3175 msg_puts("...");
3176 msg_puts((char *)fp->uf_va_name);
3177 if (fp->uf_va_type)
3178 {
3179 char *tofree;
3180
3181 msg_puts(": ");
3182 msg_puts(type_name(fp->uf_va_type, &tofree));
3183 vim_free(tofree);
3184 }
3185 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003186 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003187
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003188 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003189 {
3190 if (fp->uf_ret_type != &t_void)
3191 {
3192 char *tofree;
3193
3194 msg_puts(": ");
3195 msg_puts(type_name(fp->uf_ret_type, &tofree));
3196 vim_free(tofree);
3197 }
3198 }
3199 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003200 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003201 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003202 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003203 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003204 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003205 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003206 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003207 msg_clr_eos();
3208 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003209 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003210}
3211
3212/*
3213 * Get a function name, translating "<SID>" and "<SNR>".
3214 * Also handles a Funcref in a List or Dictionary.
3215 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003216 * Set "*is_global" to TRUE when the function must be global, unless
3217 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218 * flags:
3219 * TFN_INT: internal function name OK
3220 * TFN_QUIET: be quiet
3221 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003222 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 * Advances "pp" to just after the function name (if no error).
3224 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003225 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226trans_function_name(
3227 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003228 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003230 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003231 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003232 partial_T **partial, // return: partial of a FuncRef
3233 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234{
3235 char_u *name = NULL;
3236 char_u *start;
3237 char_u *end;
3238 int lead;
3239 char_u sid_buf[20];
3240 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003241 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003244 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003245
3246 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003247 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 start = *pp;
3249
Bram Moolenaare38eab22019-12-05 21:50:01 +01003250 // Check for hard coded <SNR>: already translated function ID (from a user
3251 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003252 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3253 && (*pp)[2] == (int)KE_SNR)
3254 {
3255 *pp += 3;
3256 len = get_id_len(pp) + 3;
3257 return vim_strnsave(start, len);
3258 }
3259
Bram Moolenaare38eab22019-12-05 21:50:01 +01003260 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3261 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003262 lead = eval_fname_script(start);
3263 if (lead > 2)
3264 start += lead;
3265
Bram Moolenaare38eab22019-12-05 21:50:01 +01003266 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003267 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003268 lead > 2 ? 0 : FNE_CHECK_START);
3269 if (end == start)
3270 {
3271 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003272 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 goto theend;
3274 }
3275 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3276 {
3277 /*
3278 * Report an invalid expression in braces, unless the expression
3279 * evaluation has been cancelled due to an aborting error, an
3280 * interrupt, or an exception.
3281 */
3282 if (!aborting())
3283 {
3284 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003285 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003286 }
3287 else
3288 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3289 goto theend;
3290 }
3291
3292 if (lv.ll_tv != NULL)
3293 {
3294 if (fdp != NULL)
3295 {
3296 fdp->fd_dict = lv.ll_dict;
3297 fdp->fd_newkey = lv.ll_newkey;
3298 lv.ll_newkey = NULL;
3299 fdp->fd_di = lv.ll_di;
3300 }
3301 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3302 {
3303 name = vim_strsave(lv.ll_tv->vval.v_string);
3304 *pp = end;
3305 }
3306 else if (lv.ll_tv->v_type == VAR_PARTIAL
3307 && lv.ll_tv->vval.v_partial != NULL)
3308 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003309 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310 *pp = end;
3311 if (partial != NULL)
3312 *partial = lv.ll_tv->vval.v_partial;
3313 }
3314 else
3315 {
3316 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3317 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003318 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003319 else
3320 *pp = end;
3321 name = NULL;
3322 }
3323 goto theend;
3324 }
3325
3326 if (lv.ll_name == NULL)
3327 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003328 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329 *pp = end;
3330 goto theend;
3331 }
3332
Bram Moolenaare38eab22019-12-05 21:50:01 +01003333 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334 if (lv.ll_exp_name != NULL)
3335 {
3336 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003337 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003338 flags & TFN_NO_AUTOLOAD);
3339 if (name == lv.ll_exp_name)
3340 name = NULL;
3341 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003342 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343 {
3344 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003345 name = deref_func_name(*pp, &len, partial, type,
3346 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 if (name == *pp)
3348 name = NULL;
3349 }
3350 if (name != NULL)
3351 {
3352 name = vim_strsave(name);
3353 *pp = end;
3354 if (STRNCMP(name, "<SNR>", 5) == 0)
3355 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003356 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003357 name[0] = K_SPECIAL;
3358 name[1] = KS_EXTRA;
3359 name[2] = (int)KE_SNR;
3360 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3361 }
3362 goto theend;
3363 }
3364
3365 if (lv.ll_exp_name != NULL)
3366 {
3367 len = (int)STRLEN(lv.ll_exp_name);
3368 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3369 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3370 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003371 // When there was "s:" already or the name expanded to get a
3372 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 lv.ll_name += 2;
3374 len -= 2;
3375 lead = 2;
3376 }
3377 }
3378 else
3379 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003380 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003382 {
3383 if (is_global != NULL && lv.ll_name[0] == 'g')
3384 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003386 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387 len = (int)(end - lv.ll_name);
3388 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003389 if (len <= 0)
3390 {
3391 if (!skip)
3392 emsg(_(e_function_name));
3393 goto theend;
3394 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003396 // In Vim9 script a user function is script-local by default, unless it
3397 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003398 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003399 if (vim9script)
3400 {
3401 char_u *p;
3402
3403 // SomeScript#func() is a global function.
3404 for (p = start; *p != NUL && *p != '('; ++p)
3405 if (*p == AUTOLOAD_CHAR)
3406 vim9script = FALSE;
3407 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003408
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003409 /*
3410 * Copy the function name to allocated memory.
3411 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3412 * Accept <SNR>123_name() outside a script.
3413 */
3414 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003415 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003416 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418 if (!vim9script)
3419 lead = 3;
3420 if (vim9script || (lv.ll_exp_name != NULL
3421 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 || eval_fname_sid(*pp))
3423 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003424 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003425 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003427 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003428 goto theend;
3429 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003430 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003431 if (vim9script)
3432 extra = 3 + (int)STRLEN(sid_buf);
3433 else
3434 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003435 }
3436 }
3437 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3438 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003439 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 start);
3441 goto theend;
3442 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003443 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003444 {
3445 char_u *cp = vim_strchr(lv.ll_name, ':');
3446
3447 if (cp != NULL && cp < end)
3448 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003449 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003450 goto theend;
3451 }
3452 }
3453
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003454 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 if (name != NULL)
3456 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003457 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 {
3459 name[0] = K_SPECIAL;
3460 name[1] = KS_EXTRA;
3461 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 STRCPY(name + 3, sid_buf);
3464 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003465 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3466 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003467 }
3468 *pp = end;
3469
3470theend:
3471 clear_lval(&lv);
3472 return name;
3473}
3474
3475/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003476 * Assuming "name" is the result of trans_function_name() and it was prefixed
3477 * to use the script-local name, return the unmodified name (points into
3478 * "name"). Otherwise return NULL.
3479 * This can be used to first search for a script-local function and fall back
3480 * to the global function if not found.
3481 */
3482 char_u *
3483untrans_function_name(char_u *name)
3484{
3485 char_u *p;
3486
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003487 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003488 {
3489 p = vim_strchr(name, '_');
3490 if (p != NULL)
3491 return p + 1;
3492 }
3493 return NULL;
3494}
3495
3496/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003497 * List functions. When "regmatch" is NULL all of then.
3498 * Otherwise functions matching "regmatch".
3499 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003500 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003501list_functions(regmatch_T *regmatch)
3502{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003503 int changed = func_hashtab.ht_changed;
3504 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003505 hashitem_T *hi;
3506
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003507 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003508 {
3509 if (!HASHITEM_EMPTY(hi))
3510 {
3511 ufunc_T *fp = HI2UF(hi);
3512
3513 --todo;
3514 if ((fp->uf_flags & FC_DEAD) == 0
3515 && (regmatch == NULL
3516 ? !message_filtered(fp->uf_name)
3517 && !func_name_refcount(fp->uf_name)
3518 : !isdigit(*fp->uf_name)
3519 && vim_regexec(regmatch, fp->uf_name, 0)))
3520 {
3521 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003522 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003523 {
3524 emsg(_("E454: function list was modified"));
3525 return;
3526 }
3527 }
3528 }
3529 }
3530}
3531
3532/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003533 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003534 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3535 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003536 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003538 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003539define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003541 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 int j;
3543 int c;
3544 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003545 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003546 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 char_u *p;
3548 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003549 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 char_u *line_arg = NULL;
3551 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003552 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003553 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 garray_T newlines;
3555 int varargs = FALSE;
3556 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003557 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003558 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003559 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003560 dictitem_T *v;
3561 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003562 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003565 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003566 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003567 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568
3569 /*
3570 * ":function" without argument: list functions.
3571 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003572 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573 {
3574 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003575 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003577 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 }
3579
3580 /*
3581 * ":function /pat": list functions matching pattern.
3582 */
3583 if (*eap->arg == '/')
3584 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003585 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 if (!eap->skip)
3587 {
3588 regmatch_T regmatch;
3589
3590 c = *p;
3591 *p = NUL;
3592 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3593 *p = c;
3594 if (regmatch.regprog != NULL)
3595 {
3596 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003597 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 vim_regfree(regmatch.regprog);
3599 }
3600 }
3601 if (*p == '/')
3602 ++p;
3603 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003604 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 }
3606
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003607 ga_init(&newargs);
3608 ga_init(&argtypes);
3609 ga_init(&default_args);
3610
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003611 /*
3612 * Get the function name. There are these situations:
3613 * func normal function name
3614 * "name" == func, "fudi.fd_dict" == NULL
3615 * dict.func new dictionary entry
3616 * "name" == NULL, "fudi.fd_dict" set,
3617 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3618 * dict.func existing dict entry with a Funcref
3619 * "name" == func, "fudi.fd_dict" set,
3620 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3621 * dict.func existing dict entry that's not a Funcref
3622 * "name" == NULL, "fudi.fd_dict" set,
3623 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3624 * s:func script-local function name
3625 * g:func global function name, same as "func"
3626 */
3627 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003628 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003630 // nested function, argument is (args).
3631 paren = TRUE;
3632 CLEAR_FIELD(fudi);
3633 }
3634 else
3635 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003636 if (STRNCMP(p, "<lambda>", 8) == 0)
3637 {
3638 p += 8;
3639 (void)getdigits(&p);
3640 name = vim_strnsave(eap->arg, p - eap->arg);
3641 CLEAR_FIELD(fudi);
3642 }
3643 else
3644 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003645 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003646 paren = (vim_strchr(p, '(') != NULL);
3647 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003649 /*
3650 * Return on an invalid expression in braces, unless the expression
3651 * evaluation has been cancelled due to an aborting error, an
3652 * interrupt, or an exception.
3653 */
3654 if (!aborting())
3655 {
3656 if (!eap->skip && fudi.fd_newkey != NULL)
3657 semsg(_(e_dictkey), fudi.fd_newkey);
3658 vim_free(fudi.fd_newkey);
3659 return NULL;
3660 }
3661 else
3662 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003663 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 }
3665
Bram Moolenaare38eab22019-12-05 21:50:01 +01003666 // An error in a function call during evaluation of an expression in magic
3667 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 saved_did_emsg = did_emsg;
3669 did_emsg = FALSE;
3670
3671 /*
3672 * ":function func" with only function name: list function.
3673 */
3674 if (!paren)
3675 {
3676 if (!ends_excmd(*skipwhite(p)))
3677 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003678 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003679 goto ret_free;
3680 }
3681 eap->nextcmd = check_nextcmd(p);
3682 if (eap->nextcmd != NULL)
3683 *p = NUL;
3684 if (!eap->skip && !got_int)
3685 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003686 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003687 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3688 {
3689 char_u *up = untrans_function_name(name);
3690
3691 // With Vim9 script the name was made script-local, if not
3692 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003693 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003694 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003695 }
3696
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 if (fp != NULL)
3698 {
3699 list_func_head(fp, TRUE);
3700 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3701 {
3702 if (FUNCLINE(fp, j) == NULL)
3703 continue;
3704 msg_putchar('\n');
3705 msg_outnum((long)(j + 1));
3706 if (j < 9)
3707 msg_putchar(' ');
3708 if (j < 99)
3709 msg_putchar(' ');
3710 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003711 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 ui_breakcheck();
3713 }
3714 if (!got_int)
3715 {
3716 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003717 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003718 msg_puts(" enddef");
3719 else
3720 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 }
3722 }
3723 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003724 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 }
3726 goto ret_free;
3727 }
3728
3729 /*
3730 * ":function name(arg1, arg2)" Define function.
3731 */
3732 p = skipwhite(p);
3733 if (*p != '(')
3734 {
3735 if (!eap->skip)
3736 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003737 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 goto ret_free;
3739 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003740 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003741 if (vim_strchr(p, '(') != NULL)
3742 p = vim_strchr(p, '(');
3743 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003745 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3746 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003747 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003748 goto ret_free;
3749 }
3750
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003751 // In Vim9 script only global functions can be redefined.
3752 if (vim9script && eap->forceit && !is_global)
3753 {
3754 emsg(_(e_nobang));
3755 goto ret_free;
3756 }
3757
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003758 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759
Bram Moolenaar04b12692020-05-04 23:24:44 +02003760 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003762 // Check the name of the function. Unless it's a dictionary function
3763 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 if (name != NULL)
3765 arg = name;
3766 else
3767 arg = fudi.fd_newkey;
3768 if (arg != NULL && (fudi.fd_di == NULL
3769 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3770 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3771 {
3772 if (*arg == K_SPECIAL)
3773 j = 3;
3774 else
3775 j = 0;
3776 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3777 : eval_isnamec(arg[j])))
3778 ++j;
3779 if (arg[j] != NUL)
3780 emsg_funcname((char *)e_invarg2, arg);
3781 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003782 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003784 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 }
3786
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003787 // This may get more lines and make the pointers into the first line
3788 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003789 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003790 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003791 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003792 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003793 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003794 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003795 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003797 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003799 // find the return type: :def Func(): type
3800 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003802 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003803 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003804 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003805 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003806 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003807 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003808 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003809 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003811 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003812 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003813 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003814 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003816 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003818 else
3819 // find extra arguments "range", "dict", "abort" and "closure"
3820 for (;;)
3821 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003822 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003823 p = skipwhite(p);
3824 if (STRNCMP(p, "range", 5) == 0)
3825 {
3826 flags |= FC_RANGE;
3827 p += 5;
3828 }
3829 else if (STRNCMP(p, "dict", 4) == 0)
3830 {
3831 flags |= FC_DICT;
3832 p += 4;
3833 }
3834 else if (STRNCMP(p, "abort", 5) == 0)
3835 {
3836 flags |= FC_ABORT;
3837 p += 5;
3838 }
3839 else if (STRNCMP(p, "closure", 7) == 0)
3840 {
3841 flags |= FC_CLOSURE;
3842 p += 7;
3843 if (current_funccal == NULL)
3844 {
3845 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3846 name == NULL ? (char_u *)"" : name);
3847 goto erret;
3848 }
3849 }
3850 else
3851 break;
3852 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003853
Bram Moolenaare38eab22019-12-05 21:50:01 +01003854 // When there is a line break use what follows for the function body.
3855 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003856 if (*p == '\n')
3857 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003858 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003859 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3860 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003861 && !(VIM_ISWHITE(*whitep) && *p == '#'
3862 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003863 && !eap->skip
3864 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003865 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866
3867 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003868 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3869 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 */
3871 if (KeyTyped)
3872 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003873 // Check if the function already exists, don't let the user type the
3874 // whole function before telling him it doesn't work! For a script we
3875 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003876 if (!eap->skip && !eap->forceit)
3877 {
3878 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003879 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003880 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 emsg_funcname(e_funcexts, name);
3882 }
3883
3884 if (!eap->skip && did_emsg)
3885 goto erret;
3886
Bram Moolenaare38eab22019-12-05 21:50:01 +01003887 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888 cmdline_row = msg_row;
3889 }
3890
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003891 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003892 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003893
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003894 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003895 goto erret;
3896
3897 /*
3898 * If there are no errors, add the function
3899 */
3900 if (fudi.fd_dict == NULL)
3901 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003902 hashtab_T *ht;
3903
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003904 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003905 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3906 {
3907 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3908 name);
3909 goto erret;
3910 }
3911
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003912 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003913 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003914 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003915 char_u *uname = untrans_function_name(name);
3916
3917 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3918 }
3919
3920 if (fp != NULL || import != NULL)
3921 {
3922 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003923
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003924 // Function can be replaced with "function!" and when sourcing the
3925 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003926 // A name that is used by an import can not be overruled.
3927 if (import != NULL
3928 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003929 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003930 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003932 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003933 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003934 else
3935 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 goto erret;
3937 }
3938 if (fp->uf_calls > 0)
3939 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003940 emsg_funcname(
3941 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003942 name);
3943 goto erret;
3944 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003945 if (fp->uf_refcount > 1)
3946 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003947 // This function is referenced somewhere, don't redefine it but
3948 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003949 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003950 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003951 fp = NULL;
3952 overwrite = TRUE;
3953 }
3954 else
3955 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003956 char_u *exp_name = fp->uf_name_exp;
3957
3958 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003959 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003960 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003961 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003962 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003963 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003964#ifdef FEAT_PROFILE
3965 fp->uf_profiling = FALSE;
3966 fp->uf_prof_initialized = FALSE;
3967#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003968 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003969 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 }
3971 }
3972 else
3973 {
3974 char numbuf[20];
3975
3976 fp = NULL;
3977 if (fudi.fd_newkey == NULL && !eap->forceit)
3978 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003979 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 goto erret;
3981 }
3982 if (fudi.fd_di == NULL)
3983 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003984 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003985 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003986 goto erret;
3987 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003988 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003989 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003990 goto erret;
3991
Bram Moolenaare38eab22019-12-05 21:50:01 +01003992 // Give the function a sequential number. Can only be used with a
3993 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 vim_free(name);
3995 sprintf(numbuf, "%d", ++func_nr);
3996 name = vim_strsave((char_u *)numbuf);
3997 if (name == NULL)
3998 goto erret;
3999 }
4000
4001 if (fp == NULL)
4002 {
4003 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4004 {
4005 int slen, plen;
4006 char_u *scriptname;
4007
Bram Moolenaare38eab22019-12-05 21:50:01 +01004008 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004009 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004010 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004011 {
4012 scriptname = autoload_name(name);
4013 if (scriptname != NULL)
4014 {
4015 p = vim_strchr(scriptname, '/');
4016 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004017 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004018 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004019 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 j = OK;
4021 vim_free(scriptname);
4022 }
4023 }
4024 if (j == FAIL)
4025 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004026 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027 goto erret;
4028 }
4029 }
4030
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004031 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 if (fp == NULL)
4033 goto erret;
4034
4035 if (fudi.fd_dict != NULL)
4036 {
4037 if (fudi.fd_di == NULL)
4038 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004039 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4041 if (fudi.fd_di == NULL)
4042 {
4043 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004044 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 goto erret;
4046 }
4047 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4048 {
4049 vim_free(fudi.fd_di);
4050 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004051 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 goto erret;
4053 }
4054 }
4055 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004056 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 clear_tv(&fudi.fd_di->di_tv);
4058 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060
Bram Moolenaare38eab22019-12-05 21:50:01 +01004061 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 flags |= FC_DICT;
4063 }
4064
Bram Moolenaare38eab22019-12-05 21:50:01 +01004065 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004066 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004067 if (overwrite)
4068 {
4069 hi = hash_find(&func_hashtab, name);
4070 hi->hi_key = UF2HIKEY(fp);
4071 }
4072 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 {
4074 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004075 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 goto erret;
4077 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004078 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 }
4080 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004081 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004082 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004083 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004084
4085 if (eap->cmdidx == CMD_def)
4086 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004087 int lnum_save = SOURCING_LNUM;
4088 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004089
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004090 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004091
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004092 // error messages are for the first function line
4093 SOURCING_LNUM = sourcing_lnum_top;
4094
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004095 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004096 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004097 int count = cstack->cs_idx + 1;
4098 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004099
4100 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004101 // a block that is visible now but not when the function is called
4102 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004103 fp->uf_block_ids = ALLOC_MULT(int, count);
4104 if (fp->uf_block_ids != NULL)
4105 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004106 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004107 sizeof(int) * count);
4108 fp->uf_block_depth = count;
4109 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004110
4111 // Set flag in each block to indicate a function was defined. This
4112 // is used to keep the variable when leaving the block, see
4113 // hide_script_var().
4114 for (i = 0; i <= cstack->cs_idx; ++i)
4115 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004116 }
4117
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004118 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004119 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004120 SOURCING_LNUM = lnum_save;
4121 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004122 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004123 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004124
4125 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004126 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004127 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004128 SOURCING_LNUM = lnum_save;
4129 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004130 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004131 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004133 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004134 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004136 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004137 if ((flags & FC_CLOSURE) != 0)
4138 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004139 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004140 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004141 }
4142 else
4143 fp->uf_scoped = NULL;
4144
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004145#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004146 if (prof_def_func())
4147 func_do_profile(fp);
4148#endif
4149 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004150 if (sandbox)
4151 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004152 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004153 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 fp->uf_flags = flags;
4155 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004156 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004157 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004158 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004159 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004160 if (is_export)
4161 {
4162 fp->uf_flags |= FC_EXPORT;
4163 // let ex_export() know the export worked.
4164 is_export = FALSE;
4165 }
4166
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004167 if (eap->cmdidx == CMD_def)
4168 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004169 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4170 // :func does not use Vim9 script syntax, even in a Vim9 script file
4171 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004172
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 goto ret_free;
4174
4175erret:
4176 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004177 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004178 if (fp != NULL)
4179 {
4180 ga_init(&fp->uf_args);
4181 ga_init(&fp->uf_def_args);
4182 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004183errret_2:
4184 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004185 if (fp != NULL)
4186 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004188 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004189 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004191 if (name != name_arg)
4192 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004193 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004194 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004195
4196 return fp;
4197}
4198
4199/*
4200 * ":function"
4201 */
4202 void
4203ex_function(exarg_T *eap)
4204{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004205 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004206}
4207
4208/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004209 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004210 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004211 */
4212 void
4213ex_defcompile(exarg_T *eap UNUSED)
4214{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004215 long todo = (long)func_hashtab.ht_used;
4216 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004217 hashitem_T *hi;
4218 ufunc_T *ufunc;
4219
4220 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4221 {
4222 if (!HASHITEM_EMPTY(hi))
4223 {
4224 --todo;
4225 ufunc = HI2UF(hi);
4226 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004227 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4228 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004229 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004230 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004231
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004232 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004233 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004234 // a function has been added or removed, need to start over
4235 todo = (long)func_hashtab.ht_used;
4236 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004237 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004238 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004239 }
4240 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004241 }
4242 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004243}
4244
4245/*
4246 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4247 * Return 2 if "p" starts with "s:".
4248 * Return 0 otherwise.
4249 */
4250 int
4251eval_fname_script(char_u *p)
4252{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004253 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4254 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004255 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4256 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4257 return 5;
4258 if (p[0] == 's' && p[1] == ':')
4259 return 2;
4260 return 0;
4261}
4262
4263 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004264translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265{
4266 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004267 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004268 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004269}
4270
4271/*
4272 * Return TRUE when "ufunc" has old-style "..." varargs
4273 * or named varargs "...name: type".
4274 */
4275 int
4276has_varargs(ufunc_T *ufunc)
4277{
4278 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004279}
4280
4281/*
4282 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004283 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284 */
4285 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004286function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004287{
4288 char_u *nm = name;
4289 char_u *p;
4290 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004291 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004292 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004294 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4295 if (no_deref)
4296 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004297 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298 nm = skipwhite(nm);
4299
Bram Moolenaare38eab22019-12-05 21:50:01 +01004300 // Only accept "funcname", "funcname ", "funcname (..." and
4301 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004302 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004303 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 vim_free(p);
4305 return n;
4306}
4307
Bram Moolenaar113e1072019-01-20 15:30:40 +01004308#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 char_u *
4310get_expanded_name(char_u *name, int check)
4311{
4312 char_u *nm = name;
4313 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004314 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004315
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004316 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004317 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004318
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004319 if (p != NULL && *nm == NUL
4320 && (!check || translated_function_exists(p, is_global)))
4321 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322
4323 vim_free(p);
4324 return NULL;
4325}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004326#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004328/*
4329 * Function given to ExpandGeneric() to obtain the list of user defined
4330 * function names.
4331 */
4332 char_u *
4333get_user_func_name(expand_T *xp, int idx)
4334{
4335 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004336 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004337 static hashitem_T *hi;
4338 ufunc_T *fp;
4339
4340 if (idx == 0)
4341 {
4342 done = 0;
4343 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004344 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004346 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004347 {
4348 if (done++ > 0)
4349 ++hi;
4350 while (HASHITEM_EMPTY(hi))
4351 ++hi;
4352 fp = HI2UF(hi);
4353
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004354 // don't show dead, dict and lambda functions
4355 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004356 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004357 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004358
4359 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004360 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004361
4362 cat_func_name(IObuff, fp);
4363 if (xp->xp_context != EXPAND_USER_FUNC)
4364 {
4365 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004366 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004367 STRCAT(IObuff, ")");
4368 }
4369 return IObuff;
4370 }
4371 return NULL;
4372}
4373
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374/*
4375 * ":delfunction {name}"
4376 */
4377 void
4378ex_delfunction(exarg_T *eap)
4379{
4380 ufunc_T *fp = NULL;
4381 char_u *p;
4382 char_u *name;
4383 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004384 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004385
4386 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004387 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4388 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389 vim_free(fudi.fd_newkey);
4390 if (name == NULL)
4391 {
4392 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004393 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 return;
4395 }
4396 if (!ends_excmd(*skipwhite(p)))
4397 {
4398 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004399 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004400 return;
4401 }
4402 eap->nextcmd = check_nextcmd(p);
4403 if (eap->nextcmd != NULL)
4404 *p = NUL;
4405
4406 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004407 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 vim_free(name);
4409
4410 if (!eap->skip)
4411 {
4412 if (fp == NULL)
4413 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004414 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004415 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 return;
4417 }
4418 if (fp->uf_calls > 0)
4419 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004420 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 return;
4422 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004423 if (fp->uf_flags & FC_VIM9)
4424 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004425 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004426 return;
4427 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004428
4429 if (fudi.fd_dict != NULL)
4430 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004431 // Delete the dict item that refers to the function, it will
4432 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4434 }
4435 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004436 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004437 // A normal function (not a numbered function or lambda) has a
4438 // refcount of 1 for the entry in the hashtable. When deleting
4439 // it and the refcount is more than one, it should be kept.
4440 // A numbered function and lambda should be kept if the refcount is
4441 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004442 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004443 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004444 // Function is still referenced somewhere. Don't free it but
4445 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004446 if (func_remove(fp))
4447 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004448 }
4449 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004450 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004451 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 }
4453}
4454
4455/*
4456 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004457 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004458 */
4459 void
4460func_unref(char_u *name)
4461{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004462 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004463
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004464 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004465 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004466 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004467 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004470 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004472 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004474 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004475}
4476
4477/*
4478 * Unreference a Function: decrement the reference count and free it when it
4479 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004480 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004481 */
4482 void
4483func_ptr_unref(ufunc_T *fp)
4484{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004485 if (fp != NULL && (--fp->uf_refcount <= 0
4486 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4487 && fp->uf_partial->pt_refcount <= 1
4488 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004489 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004490 // Only delete it when it's not being used. Otherwise it's done
4491 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004492 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004493 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 }
4495}
4496
4497/*
4498 * Count a reference to a Function.
4499 */
4500 void
4501func_ref(char_u *name)
4502{
4503 ufunc_T *fp;
4504
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004505 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004506 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004507 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004508 if (fp != NULL)
4509 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004511 // Only give an error for a numbered function.
4512 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004513 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004514}
4515
4516/*
4517 * Count a reference to a Function.
4518 */
4519 void
4520func_ptr_ref(ufunc_T *fp)
4521{
4522 if (fp != NULL)
4523 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004524}
4525
4526/*
4527 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4528 * referenced from anywhere that is in use.
4529 */
4530 static int
4531can_free_funccal(funccall_T *fc, int copyID)
4532{
4533 return (fc->l_varlist.lv_copyID != copyID
4534 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004535 && fc->l_avars.dv_copyID != copyID
4536 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537}
4538
4539/*
4540 * ":return [expr]"
4541 */
4542 void
4543ex_return(exarg_T *eap)
4544{
4545 char_u *arg = eap->arg;
4546 typval_T rettv;
4547 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004548 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549
4550 if (current_funccal == NULL)
4551 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004552 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004553 return;
4554 }
4555
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004556 CLEAR_FIELD(evalarg);
4557 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4558
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004559 if (eap->skip)
4560 ++emsg_skip;
4561
4562 eap->nextcmd = NULL;
4563 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004564 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004565 {
4566 if (!eap->skip)
4567 returning = do_return(eap, FALSE, TRUE, &rettv);
4568 else
4569 clear_tv(&rettv);
4570 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004571 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 else if (!eap->skip)
4573 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004574 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004575 update_force_abort();
4576
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 /*
4578 * Return unless the expression evaluation has been cancelled due to an
4579 * aborting error, an interrupt, or an exception.
4580 */
4581 if (!aborting())
4582 returning = do_return(eap, FALSE, TRUE, NULL);
4583 }
4584
Bram Moolenaare38eab22019-12-05 21:50:01 +01004585 // When skipping or the return gets pending, advance to the next command
4586 // in this line (!returning). Otherwise, ignore the rest of the line.
4587 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588 if (returning)
4589 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004590 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591 eap->nextcmd = check_nextcmd(arg);
4592
4593 if (eap->skip)
4594 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004595 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596}
4597
4598/*
4599 * ":1,25call func(arg1, arg2)" function call.
4600 */
4601 void
4602ex_call(exarg_T *eap)
4603{
4604 char_u *arg = eap->arg;
4605 char_u *startarg;
4606 char_u *name;
4607 char_u *tofree;
4608 int len;
4609 typval_T rettv;
4610 linenr_T lnum;
4611 int doesrange;
4612 int failed = FALSE;
4613 funcdict_T fudi;
4614 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004615 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004616 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004617
Bram Moolenaare6b53242020-07-01 17:28:33 +02004618 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 if (eap->skip)
4620 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004621 // trans_function_name() doesn't work well when skipping, use eval0()
4622 // instead to skip to any following command, e.g. for:
4623 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004624 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004625 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004626 clear_tv(&rettv);
4627 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004628 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629 return;
4630 }
4631
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004632 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4633 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 if (fudi.fd_newkey != NULL)
4635 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004636 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004637 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004638 vim_free(fudi.fd_newkey);
4639 }
4640 if (tofree == NULL)
4641 return;
4642
Bram Moolenaare38eab22019-12-05 21:50:01 +01004643 // Increase refcount on dictionary, it could get deleted when evaluating
4644 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 if (fudi.fd_dict != NULL)
4646 ++fudi.fd_dict->dv_refcount;
4647
Bram Moolenaare38eab22019-12-05 21:50:01 +01004648 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4649 // contents. For VAR_PARTIAL get its partial, unless we already have one
4650 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004652 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4653 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004654
Bram Moolenaare38eab22019-12-05 21:50:01 +01004655 // Skip white space to allow ":call func ()". Not good, but required for
4656 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004657 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659
4660 if (*startarg != '(')
4661 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004662 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004663 goto end;
4664 }
4665
4666 /*
4667 * When skipping, evaluate the function once, to find the end of the
4668 * arguments.
4669 * When the function takes a range, this is discovered after the first
4670 * call, and the loop is broken.
4671 */
4672 if (eap->skip)
4673 {
4674 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004675 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004676 }
4677 else
4678 lnum = eap->line1;
4679 for ( ; lnum <= eap->line2; ++lnum)
4680 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004681 funcexe_T funcexe;
4682
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004683 if (!eap->skip && eap->addr_count > 0)
4684 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004685 if (lnum > curbuf->b_ml.ml_line_count)
4686 {
4687 // If the function deleted lines or switched to another buffer
4688 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004689 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004690 break;
4691 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692 curwin->w_cursor.lnum = lnum;
4693 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004695 }
4696 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004697
Bram Moolenaara80faa82020-04-12 19:37:17 +02004698 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004699 funcexe.firstline = eap->line1;
4700 funcexe.lastline = eap->line2;
4701 funcexe.doesrange = &doesrange;
4702 funcexe.evaluate = !eap->skip;
4703 funcexe.partial = partial;
4704 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004705 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004706 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004707 {
4708 failed = TRUE;
4709 break;
4710 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004711 if (has_watchexpr())
4712 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004713
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004714 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004715 if (handle_subscript(&arg, &rettv,
4716 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004717 {
4718 failed = TRUE;
4719 break;
4720 }
4721
4722 clear_tv(&rettv);
4723 if (doesrange || eap->skip)
4724 break;
4725
Bram Moolenaare38eab22019-12-05 21:50:01 +01004726 // Stop when immediately aborting on error, or when an interrupt
4727 // occurred or an exception was thrown but not caught.
4728 // get_func_tv() returned OK, so that the check for trailing
4729 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004730 if (aborting())
4731 break;
4732 }
4733 if (eap->skip)
4734 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004735 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004736
Bram Moolenaare51bb172020-02-16 19:42:23 +01004737 // When inside :try we need to check for following "| catch".
4738 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004739 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004740 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004741 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004742 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004743 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004744 if (!failed)
4745 {
4746 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004747 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004748 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749 }
4750 else
4751 eap->nextcmd = check_nextcmd(arg);
4752 }
4753
4754end:
4755 dict_unref(fudi.fd_dict);
4756 vim_free(tofree);
4757}
4758
4759/*
4760 * Return from a function. Possibly makes the return pending. Also called
4761 * for a pending return at the ":endtry" or after returning from an extra
4762 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4763 * when called due to a ":return" command. "rettv" may point to a typval_T
4764 * with the return rettv. Returns TRUE when the return can be carried out,
4765 * FALSE when the return gets pending.
4766 */
4767 int
4768do_return(
4769 exarg_T *eap,
4770 int reanimate,
4771 int is_cmd,
4772 void *rettv)
4773{
4774 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004775 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004776
4777 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004778 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004779 current_funccal->returned = FALSE;
4780
4781 /*
4782 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4783 * not in its finally clause (which then is to be executed next) is found.
4784 * In this case, make the ":return" pending for execution at the ":endtry".
4785 * Otherwise, return normally.
4786 */
4787 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4788 if (idx >= 0)
4789 {
4790 cstack->cs_pending[idx] = CSTP_RETURN;
4791
4792 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004793 // A pending return again gets pending. "rettv" points to an
4794 // allocated variable with the rettv of the original ":return"'s
4795 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004796 cstack->cs_rettv[idx] = rettv;
4797 else
4798 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004799 // When undoing a return in order to make it pending, get the stored
4800 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004801 if (reanimate)
4802 rettv = current_funccal->rettv;
4803
4804 if (rettv != NULL)
4805 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004806 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4808 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4809 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004810 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004811 }
4812 else
4813 cstack->cs_rettv[idx] = NULL;
4814
4815 if (reanimate)
4816 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004817 // The pending return value could be overwritten by a ":return"
4818 // without argument in a finally clause; reset the default
4819 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820 current_funccal->rettv->v_type = VAR_NUMBER;
4821 current_funccal->rettv->vval.v_number = 0;
4822 }
4823 }
4824 report_make_pending(CSTP_RETURN, rettv);
4825 }
4826 else
4827 {
4828 current_funccal->returned = TRUE;
4829
Bram Moolenaare38eab22019-12-05 21:50:01 +01004830 // If the return is carried out now, store the return value. For
4831 // a return immediately after reanimation, the value is already
4832 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 if (!reanimate && rettv != NULL)
4834 {
4835 clear_tv(current_funccal->rettv);
4836 *current_funccal->rettv = *(typval_T *)rettv;
4837 if (!is_cmd)
4838 vim_free(rettv);
4839 }
4840 }
4841
4842 return idx < 0;
4843}
4844
4845/*
4846 * Free the variable with a pending return value.
4847 */
4848 void
4849discard_pending_return(void *rettv)
4850{
4851 free_tv((typval_T *)rettv);
4852}
4853
4854/*
4855 * Generate a return command for producing the value of "rettv". The result
4856 * is an allocated string. Used by report_pending() for verbose messages.
4857 */
4858 char_u *
4859get_return_cmd(void *rettv)
4860{
4861 char_u *s = NULL;
4862 char_u *tofree = NULL;
4863 char_u numbuf[NUMBUFLEN];
4864
4865 if (rettv != NULL)
4866 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4867 if (s == NULL)
4868 s = (char_u *)"";
4869
4870 STRCPY(IObuff, ":return ");
4871 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4872 if (STRLEN(s) + 8 >= IOSIZE)
4873 STRCPY(IObuff + IOSIZE - 4, "...");
4874 vim_free(tofree);
4875 return vim_strsave(IObuff);
4876}
4877
4878/*
4879 * Get next function line.
4880 * Called by do_cmdline() to get the next line.
4881 * Returns allocated string, or NULL for end of function.
4882 */
4883 char_u *
4884get_func_line(
4885 int c UNUSED,
4886 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004887 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004888 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004889{
4890 funccall_T *fcp = (funccall_T *)cookie;
4891 ufunc_T *fp = fcp->func;
4892 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004893 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894
Bram Moolenaare38eab22019-12-05 21:50:01 +01004895 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004896 if (fcp->dbg_tick != debug_tick)
4897 {
4898 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004899 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004900 fcp->dbg_tick = debug_tick;
4901 }
4902#ifdef FEAT_PROFILE
4903 if (do_profiling == PROF_YES)
4904 func_line_end(cookie);
4905#endif
4906
4907 gap = &fp->uf_lines;
4908 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4909 || fcp->returned)
4910 retval = NULL;
4911 else
4912 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004913 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004914 while (fcp->linenr < gap->ga_len
4915 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4916 ++fcp->linenr;
4917 if (fcp->linenr >= gap->ga_len)
4918 retval = NULL;
4919 else
4920 {
4921 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004922 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004923#ifdef FEAT_PROFILE
4924 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004925 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004926#endif
4927 }
4928 }
4929
Bram Moolenaare38eab22019-12-05 21:50:01 +01004930 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004931 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004932 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004933 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004934 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004936 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937 fcp->dbg_tick = debug_tick;
4938 }
4939
4940 return retval;
4941}
4942
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943/*
4944 * Return TRUE if the currently active function should be ended, because a
4945 * return was encountered or an error occurred. Used inside a ":while".
4946 */
4947 int
4948func_has_ended(void *cookie)
4949{
4950 funccall_T *fcp = (funccall_T *)cookie;
4951
Bram Moolenaare38eab22019-12-05 21:50:01 +01004952 // Ignore the "abort" flag if the abortion behavior has been changed due to
4953 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004954 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4955 || fcp->returned);
4956}
4957
4958/*
4959 * return TRUE if cookie indicates a function which "abort"s on errors.
4960 */
4961 int
4962func_has_abort(
4963 void *cookie)
4964{
4965 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4966}
4967
4968
4969/*
4970 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4971 * Don't do this when "Func" is already a partial that was bound
4972 * explicitly (pt_auto is FALSE).
4973 * Changes "rettv" in-place.
4974 * Returns the updated "selfdict_in".
4975 */
4976 dict_T *
4977make_partial(dict_T *selfdict_in, typval_T *rettv)
4978{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004979 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004980 char_u *tofree = NULL;
4981 ufunc_T *fp;
4982 char_u fname_buf[FLEN_FIXED + 1];
4983 int error;
4984 dict_T *selfdict = selfdict_in;
4985
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004986 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4987 fp = rettv->vval.v_partial->pt_func;
4988 else
4989 {
4990 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4991 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004992 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004993 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004994 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004995 vim_free(tofree);
4996 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004997
4998 if (fp != NULL && (fp->uf_flags & FC_DICT))
4999 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005000 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005001
5002 if (pt != NULL)
5003 {
5004 pt->pt_refcount = 1;
5005 pt->pt_dict = selfdict;
5006 pt->pt_auto = TRUE;
5007 selfdict = NULL;
5008 if (rettv->v_type == VAR_FUNC)
5009 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005010 // Just a function: Take over the function name and use
5011 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005012 pt->pt_name = rettv->vval.v_string;
5013 }
5014 else
5015 {
5016 partial_T *ret_pt = rettv->vval.v_partial;
5017 int i;
5018
Bram Moolenaare38eab22019-12-05 21:50:01 +01005019 // Partial: copy the function name, use selfdict and copy
5020 // args. Can't take over name or args, the partial might
5021 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005022 if (ret_pt->pt_name != NULL)
5023 {
5024 pt->pt_name = vim_strsave(ret_pt->pt_name);
5025 func_ref(pt->pt_name);
5026 }
5027 else
5028 {
5029 pt->pt_func = ret_pt->pt_func;
5030 func_ptr_ref(pt->pt_func);
5031 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005032 if (ret_pt->pt_argc > 0)
5033 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005034 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005035 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005036 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037 pt->pt_argc = 0;
5038 else
5039 {
5040 pt->pt_argc = ret_pt->pt_argc;
5041 for (i = 0; i < pt->pt_argc; i++)
5042 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5043 }
5044 }
5045 partial_unref(ret_pt);
5046 }
5047 rettv->v_type = VAR_PARTIAL;
5048 rettv->vval.v_partial = pt;
5049 }
5050 }
5051 return selfdict;
5052}
5053
5054/*
5055 * Return the name of the executed function.
5056 */
5057 char_u *
5058func_name(void *cookie)
5059{
5060 return ((funccall_T *)cookie)->func->uf_name;
5061}
5062
5063/*
5064 * Return the address holding the next breakpoint line for a funccall cookie.
5065 */
5066 linenr_T *
5067func_breakpoint(void *cookie)
5068{
5069 return &((funccall_T *)cookie)->breakpoint;
5070}
5071
5072/*
5073 * Return the address holding the debug tick for a funccall cookie.
5074 */
5075 int *
5076func_dbg_tick(void *cookie)
5077{
5078 return &((funccall_T *)cookie)->dbg_tick;
5079}
5080
5081/*
5082 * Return the nesting level for a funccall cookie.
5083 */
5084 int
5085func_level(void *cookie)
5086{
5087 return ((funccall_T *)cookie)->level;
5088}
5089
5090/*
5091 * Return TRUE when a function was ended by a ":return" command.
5092 */
5093 int
5094current_func_returned(void)
5095{
5096 return current_funccal->returned;
5097}
5098
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005099 int
5100free_unref_funccal(int copyID, int testing)
5101{
5102 int did_free = FALSE;
5103 int did_free_funccal = FALSE;
5104 funccall_T *fc, **pfc;
5105
5106 for (pfc = &previous_funccal; *pfc != NULL; )
5107 {
5108 if (can_free_funccal(*pfc, copyID))
5109 {
5110 fc = *pfc;
5111 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005112 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005113 did_free = TRUE;
5114 did_free_funccal = TRUE;
5115 }
5116 else
5117 pfc = &(*pfc)->caller;
5118 }
5119 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005120 // When a funccal was freed some more items might be garbage
5121 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005122 (void)garbage_collect(testing);
5123
5124 return did_free;
5125}
5126
5127/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005128 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005129 */
5130 static funccall_T *
5131get_funccal(void)
5132{
5133 int i;
5134 funccall_T *funccal;
5135 funccall_T *temp_funccal;
5136
5137 funccal = current_funccal;
5138 if (debug_backtrace_level > 0)
5139 {
5140 for (i = 0; i < debug_backtrace_level; i++)
5141 {
5142 temp_funccal = funccal->caller;
5143 if (temp_funccal)
5144 funccal = temp_funccal;
5145 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005146 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005147 debug_backtrace_level = i;
5148 }
5149 }
5150 return funccal;
5151}
5152
5153/*
5154 * Return the hashtable used for local variables in the current funccal.
5155 * Return NULL if there is no current funccal.
5156 */
5157 hashtab_T *
5158get_funccal_local_ht()
5159{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005160 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005161 return NULL;
5162 return &get_funccal()->l_vars.dv_hashtab;
5163}
5164
5165/*
5166 * Return the l: scope variable.
5167 * Return NULL if there is no current funccal.
5168 */
5169 dictitem_T *
5170get_funccal_local_var()
5171{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005172 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005173 return NULL;
5174 return &get_funccal()->l_vars_var;
5175}
5176
5177/*
5178 * Return the hashtable used for argument in the current funccal.
5179 * Return NULL if there is no current funccal.
5180 */
5181 hashtab_T *
5182get_funccal_args_ht()
5183{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005184 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005185 return NULL;
5186 return &get_funccal()->l_avars.dv_hashtab;
5187}
5188
5189/*
5190 * Return the a: scope variable.
5191 * Return NULL if there is no current funccal.
5192 */
5193 dictitem_T *
5194get_funccal_args_var()
5195{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005196 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005197 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005198 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199}
5200
5201/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005202 * List function variables, if there is a function.
5203 */
5204 void
5205list_func_vars(int *first)
5206{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005207 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005209 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005210}
5211
5212/*
5213 * If "ht" is the hashtable for local variables in the current funccal, return
5214 * the dict that contains it.
5215 * Otherwise return NULL.
5216 */
5217 dict_T *
5218get_current_funccal_dict(hashtab_T *ht)
5219{
5220 if (current_funccal != NULL
5221 && ht == &current_funccal->l_vars.dv_hashtab)
5222 return &current_funccal->l_vars;
5223 return NULL;
5224}
5225
5226/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005227 * Search hashitem in parent scope.
5228 */
5229 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005230find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005231{
5232 funccall_T *old_current_funccal = current_funccal;
5233 hashtab_T *ht;
5234 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005235 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005236
5237 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5238 return NULL;
5239
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005240 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005241 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005242 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005243 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005244 ht = find_var_ht(name, &varname);
5245 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005246 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005247 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005248 if (!HASHITEM_EMPTY(hi))
5249 {
5250 *pht = ht;
5251 break;
5252 }
5253 }
5254 if (current_funccal == current_funccal->func->uf_scoped)
5255 break;
5256 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005257 }
5258 current_funccal = old_current_funccal;
5259
5260 return hi;
5261}
5262
5263/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005264 * Search variable in parent scope.
5265 */
5266 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005267find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005268{
5269 dictitem_T *v = NULL;
5270 funccall_T *old_current_funccal = current_funccal;
5271 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005272 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005273
5274 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5275 return NULL;
5276
Bram Moolenaare38eab22019-12-05 21:50:01 +01005277 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005278 current_funccal = current_funccal->func->uf_scoped;
5279 while (current_funccal)
5280 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005281 ht = find_var_ht(name, &varname);
5282 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005283 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005284 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005285 if (v != NULL)
5286 break;
5287 }
5288 if (current_funccal == current_funccal->func->uf_scoped)
5289 break;
5290 current_funccal = current_funccal->func->uf_scoped;
5291 }
5292 current_funccal = old_current_funccal;
5293
5294 return v;
5295}
5296
5297/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005298 * Set "copyID + 1" in previous_funccal and callers.
5299 */
5300 int
5301set_ref_in_previous_funccal(int copyID)
5302{
5303 int abort = FALSE;
5304 funccall_T *fc;
5305
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005306 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005307 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005308 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005309 abort = abort
5310 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5311 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005312 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005313 }
5314 return abort;
5315}
5316
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005317 static int
5318set_ref_in_funccal(funccall_T *fc, int copyID)
5319{
5320 int abort = FALSE;
5321
5322 if (fc->fc_copyID != copyID)
5323 {
5324 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005325 abort = abort
5326 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5327 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005328 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005329 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005330 }
5331 return abort;
5332}
5333
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005334/*
5335 * Set "copyID" in all local vars and arguments in the call stack.
5336 */
5337 int
5338set_ref_in_call_stack(int copyID)
5339{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005340 int abort = FALSE;
5341 funccall_T *fc;
5342 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005343
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005344 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005345 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005346
5347 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005348 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5349 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005350 abort = abort || set_ref_in_funccal(fc, copyID);
5351
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005352 return abort;
5353}
5354
5355/*
5356 * Set "copyID" in all functions available by name.
5357 */
5358 int
5359set_ref_in_functions(int copyID)
5360{
5361 int todo;
5362 hashitem_T *hi = NULL;
5363 int abort = FALSE;
5364 ufunc_T *fp;
5365
5366 todo = (int)func_hashtab.ht_used;
5367 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005368 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005369 if (!HASHITEM_EMPTY(hi))
5370 {
5371 --todo;
5372 fp = HI2UF(hi);
5373 if (!func_name_refcount(fp->uf_name))
5374 abort = abort || set_ref_in_func(NULL, fp, copyID);
5375 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 }
5377 return abort;
5378}
5379
5380/*
5381 * Set "copyID" in all function arguments.
5382 */
5383 int
5384set_ref_in_func_args(int copyID)
5385{
5386 int i;
5387 int abort = FALSE;
5388
5389 for (i = 0; i < funcargs.ga_len; ++i)
5390 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5391 copyID, NULL, NULL);
5392 return abort;
5393}
5394
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005395/*
5396 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005397 * Returns TRUE if setting references failed somehow.
5398 */
5399 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005400set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005401{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005402 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005403 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005404 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005405 char_u fname_buf[FLEN_FIXED + 1];
5406 char_u *tofree = NULL;
5407 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005408 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005409
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005410 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005411 return FALSE;
5412
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005413 if (fp_in == NULL)
5414 {
5415 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005416 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005417 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005418 if (fp != NULL)
5419 {
5420 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005421 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005422 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005423
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005424 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005425 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005426}
5427
Bram Moolenaare38eab22019-12-05 21:50:01 +01005428#endif // FEAT_EVAL