blob: 57669419d29b81b6c9ef7f4b549111165f6e1534 [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 ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100734 && (vim9_function || p_verbose > 0))
735 {
736 if (eap->cmdidx == CMD_def)
737 semsg(_(e_text_found_after_enddef_str), p);
738 else
739 give_warning2((char_u *)
740 _("W22: Text found after :endfunction: %s"),
741 p, TRUE);
742 }
743 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100744 {
745 // Another command follows. If the line came from "eap"
746 // we can simply point into it, otherwise we need to
747 // change "eap->cmdlinep".
748 eap->nextcmd = nextcmd;
749 if (*line_to_free != NULL)
750 {
751 vim_free(*eap->cmdlinep);
752 *eap->cmdlinep = *line_to_free;
753 *line_to_free = NULL;
754 }
755 }
756 break;
757 }
758 }
759
760 // Check for mismatched "endfunc" or "enddef".
761 // We don't check for "def" inside "func" thus we also can't check
762 // for "enddef".
763 // We continue to find the end of the function, although we might
764 // not find it.
765 else if (nesting_def[nesting])
766 {
767 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
768 emsg(_(e_mismatched_endfunction));
769 }
770 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
771 emsg(_(e_mismatched_enddef));
772
773 // Increase indent inside "if", "while", "for" and "try", decrease
774 // at "end".
775 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
776 indent -= 2;
777 else if (STRNCMP(p, "if", 2) == 0
778 || STRNCMP(p, "wh", 2) == 0
779 || STRNCMP(p, "for", 3) == 0
780 || STRNCMP(p, "try", 3) == 0)
781 indent += 2;
782
783 // Check for defining a function inside this function.
784 // Only recognize "def" inside "def", not inside "function",
785 // For backwards compatibility, see Test_function_python().
786 c = *p;
787 if (is_function_cmd(&p)
788 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
789 {
790 if (*p == '!')
791 p = skipwhite(p + 1);
792 p += eval_fname_script(p);
793 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
794 NULL, NULL));
795 if (*skipwhite(p) == '(')
796 {
797 if (nesting == MAX_FUNC_NESTING - 1)
798 emsg(_(e_function_nesting_too_deep));
799 else
800 {
801 ++nesting;
802 nesting_def[nesting] = (c == 'd');
803 indent += 2;
804 }
805 }
806 }
807
808 // Check for ":append", ":change", ":insert". Not for :def.
809 p = skip_range(p, FALSE, NULL);
810 if (!vim9_function
811 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
812 || (p[0] == 'c'
813 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
814 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
815 && (STRNCMP(&p[3], "nge", 3) != 0
816 || !ASCII_ISALPHA(p[6])))))))
817 || (p[0] == 'i'
818 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
819 && (!ASCII_ISALPHA(p[2])
820 || (p[2] == 's'
821 && (!ASCII_ISALPHA(p[3])
822 || p[3] == 'e'))))))))
823 skip_until = vim_strsave((char_u *)".");
824
825 // Check for ":python <<EOF", ":tcl <<EOF", etc.
826 arg = skipwhite(skiptowhite(p));
827 if (arg[0] == '<' && arg[1] =='<'
828 && ((p[0] == 'p' && p[1] == 'y'
829 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
830 || ((p[2] == '3' || p[2] == 'x')
831 && !ASCII_ISALPHA(p[3]))))
832 || (p[0] == 'p' && p[1] == 'e'
833 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
834 || (p[0] == 't' && p[1] == 'c'
835 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
836 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
837 && !ASCII_ISALPHA(p[3]))
838 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
839 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
840 || (p[0] == 'm' && p[1] == 'z'
841 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
842 ))
843 {
844 // ":python <<" continues until a dot, like ":append"
845 p = skipwhite(arg + 2);
846 if (STRNCMP(p, "trim", 4) == 0)
847 {
848 // Ignore leading white space.
849 p = skipwhite(p + 4);
850 heredoc_trimmed = vim_strnsave(theline,
851 skipwhite(theline) - theline);
852 }
853 if (*p == NUL)
854 skip_until = vim_strsave((char_u *)".");
855 else
856 skip_until = vim_strnsave(p, skiptowhite(p) - p);
857 getline_options = GETLINE_NONE;
858 is_heredoc = TRUE;
859 }
860
861 // Check for ":cmd v =<< [trim] EOF"
862 // and ":cmd [a, b] =<< [trim] EOF"
863 // and "lines =<< [trim] EOF" for Vim9
864 // Where "cmd" can be "let", "var", "final" or "const".
865 arg = skipwhite(skiptowhite(p));
866 if (*arg == '[')
867 arg = vim_strchr(arg, ']');
868 if (arg != NULL)
869 {
870 int found = (eap->cmdidx == CMD_def && arg[0] == '='
871 && arg[1] == '<' && arg[2] =='<');
872
873 if (!found)
874 // skip over the argument after "cmd"
875 arg = skipwhite(skiptowhite(arg));
876 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
877 && (checkforcmd(&p, "let", 2)
878 || checkforcmd(&p, "var", 3)
879 || checkforcmd(&p, "final", 5)
880 || checkforcmd(&p, "const", 5))))
881 {
882 p = skipwhite(arg + 3);
883 if (STRNCMP(p, "trim", 4) == 0)
884 {
885 // Ignore leading white space.
886 p = skipwhite(p + 4);
887 heredoc_trimmed = vim_strnsave(theline,
888 skipwhite(theline) - theline);
889 }
890 skip_until = vim_strnsave(p, skiptowhite(p) - p);
891 getline_options = GETLINE_NONE;
892 is_heredoc = TRUE;
893 }
894 }
895 }
896
897 // Add the line to the function.
898 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
899 goto theend;
900
901 // Copy the line to newly allocated memory. get_one_sourceline()
902 // allocates 250 bytes per line, this saves 80% on average. The cost
903 // is an extra alloc/free.
904 p = vim_strsave(theline);
905 if (p == NULL)
906 goto theend;
907 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
908
909 // Add NULL lines for continuation lines, so that the line count is
910 // equal to the index in the growarray.
911 while (sourcing_lnum_off-- > 0)
912 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
913
914 // Check for end of eap->arg.
915 if (line_arg != NULL && *line_arg == NUL)
916 line_arg = NULL;
917 }
918
919 // Don't define the function when skipping commands or when an error was
920 // detected.
921 if (!eap->skip && !did_emsg)
922 ret = OK;
923
924theend:
925 vim_free(skip_until);
926 vim_free(heredoc_trimmed);
927 need_wait_return |= saved_wait_return;
928 return ret;
929}
930
931/*
932 * Handle the body of a lambda. *arg points to the "{", process statements
933 * until the matching "}".
934 * When successful "rettv" is set to a funcref.
935 */
936 static int
937lambda_function_body(
938 char_u **arg,
939 typval_T *rettv,
940 evalarg_T *evalarg,
941 garray_T *newargs,
942 garray_T *argtypes,
943 int varargs,
944 garray_T *default_args,
945 char_u *ret_type)
946{
947 int evaluate = evalarg != NULL
948 && (evalarg->eval_flags & EVAL_EVALUATE);
949 ufunc_T *ufunc;
950 exarg_T eap;
951 garray_T newlines;
952 char_u *cmdline = NULL;
953 int ret = FAIL;
954 char_u *line_to_free = NULL;
955 partial_T *pt;
956 char_u *name;
957 int lnum_save = -1;
958 linenr_T sourcing_lnum_top = SOURCING_LNUM;
959
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100960 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
961 {
962 semsg(_(e_trailing_arg), *arg + 1);
963 return FAIL;
964 }
965
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100966 CLEAR_FIELD(eap);
967 eap.cmdidx = CMD_block;
968 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100969 eap.cmdlinep = &cmdline;
970 eap.skip = !evaluate;
971 if (evalarg->eval_cctx != NULL)
972 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
973 else
974 {
975 eap.getline = evalarg->eval_getline;
976 eap.cookie = evalarg->eval_cookie;
977 }
978
979 ga_init2(&newlines, (int)sizeof(char_u *), 10);
980 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100981 {
982 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100983 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100984 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100985 if (cmdline != NULL)
986 {
987 // Something comes after the "}".
988 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100989
990 // "arg" points into cmdline, need to keep the line and free it later.
991 vim_free(evalarg->eval_tofree_cmdline);
992 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 }
994 else
995 *arg = (char_u *)"";
996
997 name = get_lambda_name();
998 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
999 if (ufunc == NULL)
1000 goto erret;
1001 set_ufunc_name(ufunc, name);
1002 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
1003 {
1004 vim_free(ufunc);
1005 goto erret;
1006 }
1007 ufunc->uf_refcount = 1;
1008 ufunc->uf_args = *newargs;
1009 newargs->ga_data = NULL;
1010 ufunc->uf_def_args = *default_args;
1011 default_args->ga_data = NULL;
1012 ufunc->uf_func_type = &t_func_any;
1013
1014 // error messages are for the first function line
1015 lnum_save = SOURCING_LNUM;
1016 SOURCING_LNUM = sourcing_lnum_top;
1017
1018 // parse argument types
1019 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1020 {
1021 SOURCING_LNUM = lnum_save;
1022 goto erret;
1023 }
1024
1025 // parse the return type, if any
1026 if (parse_return_type(ufunc, ret_type) == FAIL)
1027 goto erret;
1028
1029 pt = ALLOC_CLEAR_ONE(partial_T);
1030 if (pt == NULL)
1031 goto erret;
1032 pt->pt_func = ufunc;
1033 pt->pt_refcount = 1;
1034
1035 ufunc->uf_lines = newlines;
1036 newlines.ga_data = NULL;
1037 if (sandbox)
1038 ufunc->uf_flags |= FC_SANDBOX;
1039 if (!ASCII_ISUPPER(*ufunc->uf_name))
1040 ufunc->uf_flags |= FC_VIM9;
1041 ufunc->uf_script_ctx = current_sctx;
1042 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1043 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1044 set_function_type(ufunc);
1045
1046 rettv->vval.v_partial = pt;
1047 rettv->v_type = VAR_PARTIAL;
1048 ret = OK;
1049
1050erret:
1051 if (lnum_save >= 0)
1052 SOURCING_LNUM = lnum_save;
1053 vim_free(line_to_free);
1054 ga_clear_strings(&newlines);
1055 ga_clear_strings(newargs);
1056 ga_clear_strings(default_args);
1057 return ret;
1058}
1059
1060/*
1061 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001062 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001063 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001064 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1065 */
1066 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001067get_lambda_tv(
1068 char_u **arg,
1069 typval_T *rettv,
1070 int types_optional,
1071 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001072{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001073 int evaluate = evalarg != NULL
1074 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001075 garray_T newargs;
1076 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001077 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001078 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001079 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001080 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001081 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001082 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001083 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001084 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001085 char_u *s;
1086 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001087 int *old_eval_lavars = eval_lavars_used;
1088 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001089 char_u *tofree1 = NULL;
1090 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001091 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001092 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001093 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001094
1095 if (equal_arrow && !in_vim9script())
1096 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001097
1098 ga_init(&newargs);
1099 ga_init(&newlines);
1100
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001101 // First, check if this is really a lambda expression. "->" or "=>" must
1102 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001103 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001104 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001105 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001106 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001107 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001108 {
1109 if (types_optional)
1110 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001111 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001112 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001113
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001114 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001115 if (evaluate)
1116 pnewargs = &newargs;
1117 else
1118 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001119 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001120 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001121 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001122 &varargs, &default_args,
1123 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001124 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001125 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001126 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001127 {
1128 if (types_optional)
1129 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001130 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001131 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001132 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001133 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001134
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001135 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1136 if (ret_type != NULL)
1137 {
1138 ret_type = vim_strsave(ret_type);
1139 tofree2 = ret_type;
1140 }
1141
Bram Moolenaare38eab22019-12-05 21:50:01 +01001142 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001143 if (evaluate)
1144 eval_lavars_used = &eval_lavars;
1145
Bram Moolenaar65c44152020-12-24 15:14:01 +01001146 *arg = skipwhite_and_linebreak(*arg, evalarg);
1147
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001148 // Recognize "{" as the start of a function body.
1149 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001150 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001151 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1152 types_optional ? &argtypes : NULL, varargs,
1153 &default_args, ret_type) == FAIL)
1154 goto errret;
1155 goto theend;
1156 }
1157 if (default_args.ga_len > 0)
1158 {
1159 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001160 goto errret;
1161 }
1162
Bram Moolenaare38eab22019-12-05 21:50:01 +01001163 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001164 start = *arg;
1165 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001166 if (ret == FAIL)
1167 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001168 if (evalarg != NULL)
1169 {
1170 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001171 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001172 evalarg->eval_tofree = NULL;
1173 }
1174
Bram Moolenaar65c44152020-12-24 15:14:01 +01001175 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001176 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001177 *arg = skipwhite_and_linebreak(*arg, evalarg);
1178 if (**arg != '}')
1179 {
1180 semsg(_("E451: Expected }: %s"), *arg);
1181 goto errret;
1182 }
1183 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001184 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001185
1186 if (evaluate)
1187 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001188 int len;
1189 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001190 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001191 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001192
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001193 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001194 if (fp == NULL)
1195 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001196 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001197 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001198 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001199 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001200
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001201 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1202 if (ga_grow(&newlines, 1) == FAIL)
1203 goto errret;
1204
Bram Moolenaare38eab22019-12-05 21:50:01 +01001205 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001206 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001207 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001208 if (p == NULL)
1209 goto errret;
1210 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1211 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001212 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001213 if (strstr((char *)p + 7, "a:") == NULL)
1214 // No a: variables are used for sure.
1215 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001216
1217 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001218 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001219 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001220 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001221 if (types_optional)
1222 {
1223 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
1224 goto errret;
1225 if (ret_type != NULL)
1226 {
1227 fp->uf_ret_type = parse_type(&ret_type,
1228 &fp->uf_type_list, TRUE);
1229 if (fp->uf_ret_type == NULL)
1230 goto errret;
1231 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001232 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001233 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001234 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001235
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001236 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001237 if (current_funccal != NULL && eval_lavars)
1238 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001239 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001240 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001241 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001242 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001243
1244#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001245 if (prof_def_func())
1246 func_do_profile(fp);
1247#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001248 if (sandbox)
1249 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001250 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001251 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001252 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001253 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001254 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001255 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001256
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001257 pt->pt_func = fp;
1258 pt->pt_refcount = 1;
1259 rettv->vval.v_partial = pt;
1260 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001261
1262 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001263 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001264
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001265theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001266 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001267 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001268 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001269 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001270 vim_free(tofree1);
1271 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001272 if (types_optional)
1273 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001274 return OK;
1275
1276errret:
1277 ga_clear_strings(&newargs);
1278 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001279 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001280 if (types_optional)
1281 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001282 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001283 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001284 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001285 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001286 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001287 vim_free(tofree1);
1288 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001289 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001290 return FAIL;
1291}
1292
1293/*
1294 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1295 * name it contains, otherwise return "name".
1296 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1297 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001298 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1299 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001300 */
1301 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001302deref_func_name(
1303 char_u *name,
1304 int *lenp,
1305 partial_T **partialp,
1306 type_T **type,
1307 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001308{
1309 dictitem_T *v;
1310 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001311 char_u *s = NULL;
1312 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001313
1314 if (partialp != NULL)
1315 *partialp = NULL;
1316
1317 cc = name[*lenp];
1318 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001319 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001320 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001321 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001322 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001323 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001324 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001325 if (v->di_tv.vval.v_string == NULL)
1326 {
1327 *lenp = 0;
1328 return (char_u *)""; // just in case
1329 }
1330 s = v->di_tv.vval.v_string;
1331 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001333
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001334 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001335 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001336 partial_T *pt = v->di_tv.vval.v_partial;
1337
1338 if (pt == NULL)
1339 {
1340 *lenp = 0;
1341 return (char_u *)""; // just in case
1342 }
1343 if (partialp != NULL)
1344 *partialp = pt;
1345 s = partial_name(pt);
1346 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001348
1349 if (s != NULL)
1350 {
1351 if (type != NULL && ht == get_script_local_ht())
1352 {
1353 svar_T *sv = find_typval_in_script(&v->di_tv);
1354
1355 if (sv != NULL)
1356 *type = sv->sv_type;
1357 }
1358 return s;
1359 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 }
1361
1362 return name;
1363}
1364
1365/*
1366 * Give an error message with a function name. Handle <SNR> things.
1367 * "ermsg" is to be passed without translation, use N_() instead of _().
1368 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001369 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001370emsg_funcname(char *ermsg, char_u *name)
1371{
1372 char_u *p;
1373
1374 if (*name == K_SPECIAL)
1375 p = concat_str((char_u *)"<SNR>", name + 3);
1376 else
1377 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001378 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001379 if (p != name)
1380 vim_free(p);
1381}
1382
1383/*
1384 * Allocate a variable for the result of a function.
1385 * Return OK or FAIL.
1386 */
1387 int
1388get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001389 char_u *name, // name of the function
1390 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001391 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001392 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001393 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001394 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001395{
1396 char_u *argp;
1397 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001398 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1399 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001400 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001401
1402 /*
1403 * Get the arguments.
1404 */
1405 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001406 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1407 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001408 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001409 // skip the '(' or ',' and possibly line breaks
1410 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1411
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001412 if (*argp == ')' || *argp == ',' || *argp == NUL)
1413 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001414 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001415 {
1416 ret = FAIL;
1417 break;
1418 }
1419 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001420 // The comma should come right after the argument, but this wasn't
1421 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001422 if (vim9script)
1423 {
1424 if (*argp != ',' && *skipwhite(argp) == ',')
1425 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001426 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001427 ret = FAIL;
1428 break;
1429 }
1430 }
1431 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001432 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001433 if (*argp != ',')
1434 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001435 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1436 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001437 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001438 ret = FAIL;
1439 break;
1440 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001441 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001442 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001443 if (*argp == ')')
1444 ++argp;
1445 else
1446 ret = FAIL;
1447
1448 if (ret == OK)
1449 {
1450 int i = 0;
1451
1452 if (get_vim_var_nr(VV_TESTING))
1453 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001454 // Prepare for calling test_garbagecollect_now(), need to know
1455 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456 if (funcargs.ga_itemsize == 0)
1457 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1458 for (i = 0; i < argcount; ++i)
1459 if (ga_grow(&funcargs, 1) == OK)
1460 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1461 &argvars[i];
1462 }
1463
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001464 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001465
1466 funcargs.ga_len -= i;
1467 }
1468 else if (!aborting())
1469 {
1470 if (argcount == MAX_FUNC_ARGS)
1471 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1472 else
1473 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1474 }
1475
1476 while (--argcount >= 0)
1477 clear_tv(&argvars[argcount]);
1478
Bram Moolenaar8294d492020-08-10 22:40:56 +02001479 if (in_vim9script())
1480 *arg = argp;
1481 else
1482 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483 return ret;
1484}
1485
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486/*
1487 * Return TRUE if "p" starts with "<SID>" or "s:".
1488 * Only works if eval_fname_script() returned non-zero for "p"!
1489 */
1490 static int
1491eval_fname_sid(char_u *p)
1492{
1493 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1494}
1495
1496/*
1497 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1498 * Change <SNR>123_name() to K_SNR 123_name().
1499 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1500 * (slow).
1501 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001502 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001503fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1504{
1505 int llen;
1506 char_u *fname;
1507 int i;
1508
1509 llen = eval_fname_script(name);
1510 if (llen > 0)
1511 {
1512 fname_buf[0] = K_SPECIAL;
1513 fname_buf[1] = KS_EXTRA;
1514 fname_buf[2] = (int)KE_SNR;
1515 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001516 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001518 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001519 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001520 else
1521 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001522 sprintf((char *)fname_buf + 3, "%ld_",
1523 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524 i = (int)STRLEN(fname_buf);
1525 }
1526 }
1527 if (i + STRLEN(name + llen) < FLEN_FIXED)
1528 {
1529 STRCPY(fname_buf + i, name + llen);
1530 fname = fname_buf;
1531 }
1532 else
1533 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001534 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001535 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001536 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001537 else
1538 {
1539 *tofree = fname;
1540 mch_memmove(fname, fname_buf, (size_t)i);
1541 STRCPY(fname + i, name + llen);
1542 }
1543 }
1544 }
1545 else
1546 fname = name;
1547 return fname;
1548}
1549
1550/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001551 * Find a function "name" in script "sid".
1552 */
1553 static ufunc_T *
1554find_func_with_sid(char_u *name, int sid)
1555{
1556 hashitem_T *hi;
1557 char_u buffer[200];
1558
1559 buffer[0] = K_SPECIAL;
1560 buffer[1] = KS_EXTRA;
1561 buffer[2] = (int)KE_SNR;
1562 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1563 (long)sid, name);
1564 hi = hash_find(&func_hashtab, buffer);
1565 if (!HASHITEM_EMPTY(hi))
1566 return HI2UF(hi);
1567
1568 return NULL;
1569}
1570
1571/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001572 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001573 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 * Return NULL for unknown function.
1575 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001576 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001577find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001578{
1579 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001580 ufunc_T *func;
1581 imported_T *imported;
1582
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001583 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001584 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001585 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001586 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001587 int find_script_local = in_vim9script()
1588 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001589
Bram Moolenaar95006e32020-08-29 17:47:08 +02001590 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001591 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001592 // Find script-local function before global one.
1593 func = find_func_with_sid(name, current_sctx.sc_sid);
1594 if (func != NULL)
1595 return func;
1596 }
1597
Bram Moolenaarefa94442020-08-08 22:16:00 +02001598 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001599 && name[1] == KS_EXTRA
1600 && name[2] == KE_SNR)
1601 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001602 // Caller changes s: to <SNR>99_name.
1603
1604 after_script = name + 3;
1605 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001606 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001607 ++after_script;
1608 else
1609 after_script = NULL;
1610 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001611 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001612 {
1613 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001614 if (after_script != NULL && sid != current_sctx.sc_sid)
1615 imported = find_imported_in_script(after_script, 0, sid);
1616 else
1617 imported = find_imported(after_script == NULL
1618 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001619 if (imported != NULL && imported->imp_funcname != NULL)
1620 {
1621 hi = hash_find(&func_hashtab, imported->imp_funcname);
1622 if (!HASHITEM_EMPTY(hi))
1623 return HI2UF(hi);
1624 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001625 }
1626 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627
Bram Moolenaara26b9702020-04-18 19:53:28 +02001628 hi = hash_find(&func_hashtab,
1629 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001630 if (!HASHITEM_EMPTY(hi))
1631 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001632
1633 return NULL;
1634}
1635
1636/*
1637 * Find a function by name, return pointer to it in ufuncs.
1638 * "cctx" is passed in a :def function to find imported functions.
1639 * Return NULL for unknown or dead function.
1640 */
1641 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001642find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001643{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001644 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001645
1646 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1647 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001648 return NULL;
1649}
1650
1651/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001652 * Return TRUE if "ufunc" is a global function.
1653 */
1654 int
1655func_is_global(ufunc_T *ufunc)
1656{
1657 return ufunc->uf_name[0] != K_SPECIAL;
1658}
1659
1660/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001661 * Copy the function name of "fp" to buffer "buf".
1662 * "buf" must be able to hold the function name plus three bytes.
1663 * Takes care of script-local function names.
1664 */
1665 static void
1666cat_func_name(char_u *buf, ufunc_T *fp)
1667{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001668 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001669 {
1670 STRCPY(buf, "<SNR>");
1671 STRCAT(buf, fp->uf_name + 3);
1672 }
1673 else
1674 STRCPY(buf, fp->uf_name);
1675}
1676
1677/*
1678 * Add a number variable "name" to dict "dp" with value "nr".
1679 */
1680 static void
1681add_nr_var(
1682 dict_T *dp,
1683 dictitem_T *v,
1684 char *name,
1685 varnumber_T nr)
1686{
1687 STRCPY(v->di_key, name);
1688 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1689 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1690 v->di_tv.v_type = VAR_NUMBER;
1691 v->di_tv.v_lock = VAR_FIXED;
1692 v->di_tv.vval.v_number = nr;
1693}
1694
1695/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001696 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001698 static void
1699free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001701 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001702
1703 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1704 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001705 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001706
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001707 // When garbage collecting a funccall_T may be freed before the
1708 // function that references it, clear its uf_scoped field.
1709 // The function may have been redefined and point to another
1710 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001711 if (fp != NULL && fp->uf_scoped == fc)
1712 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001713 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001714 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001715
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001716 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001717 vim_free(fc);
1718}
1719
1720/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001721 * Free "fc" and what it contains.
1722 * Can be called only when "fc" is kept beyond the period of it called,
1723 * i.e. after cleanup_function_call(fc).
1724 */
1725 static void
1726free_funccal_contents(funccall_T *fc)
1727{
1728 listitem_T *li;
1729
1730 // Free all l: variables.
1731 vars_clear(&fc->l_vars.dv_hashtab);
1732
1733 // Free all a: variables.
1734 vars_clear(&fc->l_avars.dv_hashtab);
1735
1736 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001737 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001738 clear_tv(&li->li_tv);
1739
1740 free_funccal(fc);
1741}
1742
1743/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001744 * Handle the last part of returning from a function: free the local hashtable.
1745 * Unless it is still in use by a closure.
1746 */
1747 static void
1748cleanup_function_call(funccall_T *fc)
1749{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001750 int may_free_fc = fc->fc_refcount <= 0;
1751 int free_fc = TRUE;
1752
Bram Moolenaar6914c642017-04-01 21:21:30 +02001753 current_funccal = fc->caller;
1754
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001755 // Free all l: variables if not referred.
1756 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1757 vars_clear(&fc->l_vars.dv_hashtab);
1758 else
1759 free_fc = FALSE;
1760
1761 // If the a:000 list and the l: and a: dicts are not referenced and
1762 // there is no closure using it, we can free the funccall_T and what's
1763 // in it.
1764 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1765 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001766 else
1767 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001768 int todo;
1769 hashitem_T *hi;
1770 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001771
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001772 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001773
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001774 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001775 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1776 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1777 {
1778 if (!HASHITEM_EMPTY(hi))
1779 {
1780 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001781 di = HI2DI(hi);
1782 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001783 }
1784 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001785 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001786
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001787 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1788 fc->l_varlist.lv_first = NULL;
1789 else
1790 {
1791 listitem_T *li;
1792
1793 free_fc = FALSE;
1794
1795 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001796 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001797 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001798 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001799
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001800 if (free_fc)
1801 free_funccal(fc);
1802 else
1803 {
1804 static int made_copy = 0;
1805
1806 // "fc" is still in use. This can happen when returning "a:000",
1807 // assigning "l:" to a global variable or defining a closure.
1808 // Link "fc" in the list for garbage collection later.
1809 fc->caller = previous_funccal;
1810 previous_funccal = fc;
1811
1812 if (want_garbage_collect)
1813 // If garbage collector is ready, clear count.
1814 made_copy = 0;
1815 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001816 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001817 // We have made a lot of copies, worth 4 Mbyte. This can happen
1818 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001819 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001820 // too much memory.
1821 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001822 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001823 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001824 }
1825}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001826
1827/*
1828 * There are two kinds of function names:
1829 * 1. ordinary names, function defined with :function or :def
1830 * 2. numbered functions and lambdas
1831 * For the first we only count the name stored in func_hashtab as a reference,
1832 * using function() does not count as a reference, because the function is
1833 * looked up by name.
1834 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001835 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001836func_name_refcount(char_u *name)
1837{
1838 return isdigit(*name) || *name == '<';
1839}
1840
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001841/*
1842 * Unreference "fc": decrement the reference count and free it when it
1843 * becomes zero. "fp" is detached from "fc".
1844 * When "force" is TRUE we are exiting.
1845 */
1846 static void
1847funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1848{
1849 funccall_T **pfc;
1850 int i;
1851
1852 if (fc == NULL)
1853 return;
1854
1855 if (--fc->fc_refcount <= 0 && (force || (
1856 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1857 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1858 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1859 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1860 {
1861 if (fc == *pfc)
1862 {
1863 *pfc = fc->caller;
1864 free_funccal_contents(fc);
1865 return;
1866 }
1867 }
1868 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1869 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1870 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1871}
1872
1873/*
1874 * Remove the function from the function hashtable. If the function was
1875 * deleted while it still has references this was already done.
1876 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1877 */
1878 static int
1879func_remove(ufunc_T *fp)
1880{
1881 hashitem_T *hi;
1882
1883 // Return if it was already virtually deleted.
1884 if (fp->uf_flags & FC_DEAD)
1885 return FALSE;
1886
1887 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1888 if (!HASHITEM_EMPTY(hi))
1889 {
1890 // When there is a def-function index do not actually remove the
1891 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001892 // Do remove it when it's a copy.
1893 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001894 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001895 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001896 return FALSE;
1897 }
1898 hash_remove(&func_hashtab, hi);
1899 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001900 return TRUE;
1901 }
1902 return FALSE;
1903}
1904
1905 static void
1906func_clear_items(ufunc_T *fp)
1907{
1908 ga_clear_strings(&(fp->uf_args));
1909 ga_clear_strings(&(fp->uf_def_args));
1910 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001911 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001912 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001913 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001914 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001915 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001916
1917 // Increment the refcount of this function to avoid it being freed
1918 // recursively when the partial is freed.
1919 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001920 partial_unref(fp->uf_partial);
1921 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001922 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001923
1924#ifdef FEAT_LUA
1925 if (fp->uf_cb_free != NULL)
1926 {
1927 fp->uf_cb_free(fp->uf_cb_state);
1928 fp->uf_cb_free = NULL;
1929 }
1930
1931 fp->uf_cb_state = NULL;
1932 fp->uf_cb = NULL;
1933#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001934#ifdef FEAT_PROFILE
1935 VIM_CLEAR(fp->uf_tml_count);
1936 VIM_CLEAR(fp->uf_tml_total);
1937 VIM_CLEAR(fp->uf_tml_self);
1938#endif
1939}
1940
1941/*
1942 * Free all things that a function contains. Does not free the function
1943 * itself, use func_free() for that.
1944 * When "force" is TRUE we are exiting.
1945 */
1946 static void
1947func_clear(ufunc_T *fp, int force)
1948{
1949 if (fp->uf_cleared)
1950 return;
1951 fp->uf_cleared = TRUE;
1952
1953 // clear this function
1954 func_clear_items(fp);
1955 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001956 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957}
1958
1959/*
1960 * Free a function and remove it from the list of functions. Does not free
1961 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001962 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001963 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001964 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001965 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001966func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001967{
1968 // Only remove it when not done already, otherwise we would remove a newer
1969 // version of the function with the same name.
1970 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1971 func_remove(fp);
1972
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001973 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001974 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001975 if (fp->uf_dfunc_idx > 0)
1976 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001977 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001978 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001979 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001980 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001981 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001982}
1983
1984/*
1985 * Free all things that a function contains and free the function itself.
1986 * When "force" is TRUE we are exiting.
1987 */
1988 static void
1989func_clear_free(ufunc_T *fp, int force)
1990{
1991 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001992 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1993 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001994 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001995 else
1996 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001997}
1998
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001999/*
2000 * Copy already defined function "lambda" to a new function with name "global".
2001 * This is for when a compiled function defines a global function.
2002 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002003 int
2004copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002005{
2006 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002007 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002008
2009 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002010 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002011 semsg(_(e_lambda_function_not_found_str), lambda);
2012 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002013 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002014
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002015 fp = find_func(global, TRUE, NULL);
2016 if (fp != NULL)
2017 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002018 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002019 semsg(_(e_funcexts), global);
2020 return FAIL;
2021 }
2022
2023 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2024 if (fp == NULL)
2025 return FAIL;
2026
2027 fp->uf_varargs = ufunc->uf_varargs;
2028 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2029 fp->uf_def_status = ufunc->uf_def_status;
2030 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2031 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2032 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2033 == FAIL
2034 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2035 goto failed;
2036
2037 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2038 : vim_strsave(ufunc->uf_name_exp);
2039 if (ufunc->uf_arg_types != NULL)
2040 {
2041 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2042 if (fp->uf_arg_types == NULL)
2043 goto failed;
2044 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2045 sizeof(type_T *) * fp->uf_args.ga_len);
2046 }
2047 if (ufunc->uf_def_arg_idx != NULL)
2048 {
2049 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
2050 if (fp->uf_def_arg_idx == NULL)
2051 goto failed;
2052 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
2053 sizeof(int) * fp->uf_def_args.ga_len + 1);
2054 }
2055 if (ufunc->uf_va_name != NULL)
2056 {
2057 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2058 if (fp->uf_va_name == NULL)
2059 goto failed;
2060 }
2061 fp->uf_ret_type = ufunc->uf_ret_type;
2062
2063 fp->uf_refcount = 1;
2064 STRCPY(fp->uf_name, global);
2065 hash_add(&func_hashtab, UF2HIKEY(fp));
2066
2067 // the referenced dfunc_T is now used one more time
2068 link_def_function(fp);
2069
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002070 // Create a partial to store the context of the function where it was
2071 // instantiated. Only needs to be done once. Do this on the original
2072 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002073 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2074 {
2075 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2076
2077 if (pt == NULL)
2078 goto failed;
2079 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002080 {
2081 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002082 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002083 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002084 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002085 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002086 }
2087
2088 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002089
2090failed:
2091 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002092 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002093}
2094
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002095static int funcdepth = 0;
2096
2097/*
2098 * Increment the function call depth count.
2099 * Return FAIL when going over 'maxfuncdepth'.
2100 * Otherwise return OK, must call funcdepth_decrement() later!
2101 */
2102 int
2103funcdepth_increment(void)
2104{
2105 if (funcdepth >= p_mfd)
2106 {
2107 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2108 return FAIL;
2109 }
2110 ++funcdepth;
2111 return OK;
2112}
2113
2114 void
2115funcdepth_decrement(void)
2116{
2117 --funcdepth;
2118}
2119
2120/*
2121 * Get the current function call depth.
2122 */
2123 int
2124funcdepth_get(void)
2125{
2126 return funcdepth;
2127}
2128
2129/*
2130 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002131 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002132 * times as funcdepth_increment().
2133 */
2134 void
2135funcdepth_restore(int depth)
2136{
2137 funcdepth = depth;
2138}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002139
2140/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141 * Call a user function.
2142 */
2143 static void
2144call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002145 ufunc_T *fp, // pointer to function
2146 int argcount, // nr of args
2147 typval_T *argvars, // arguments
2148 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002149 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002150 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002152 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002153 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002154 funccall_T *fc;
2155 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002156 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002157 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002158 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159 int i;
2160 int ai;
2161 int islambda = FALSE;
2162 char_u numbuf[NUMBUFLEN];
2163 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002164#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002165 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002166#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002167 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002168
Bram Moolenaarb2049902021-01-24 12:53:53 +01002169#ifdef FEAT_PROFILE
2170 CLEAR_FIELD(profile_info);
2171#endif
2172
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002173 // If depth of calling is getting too high, don't execute the function.
2174 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002175 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002176 rettv->v_type = VAR_NUMBER;
2177 rettv->vval.v_number = -1;
2178 return;
2179 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002180
Bram Moolenaare38eab22019-12-05 21:50:01 +01002181 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002182
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002183 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002184 if (fc == NULL)
2185 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002186 fc->caller = current_funccal;
2187 current_funccal = fc;
2188 fc->func = fp;
2189 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002190 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002191 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002192 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2193 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002194 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002195 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002196 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002197
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002198 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002199 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002200#ifdef FEAT_PROFILE
2201 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2202#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002203 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002204#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002205 if (do_profiling == PROF_YES)
2206 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002207#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002208 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002209 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002210#ifdef FEAT_PROFILE
2211 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002212 || (caller != NULL && caller->uf_profiling)))
2213 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002214#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002215 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002216 free_funccal(fc);
2217 return;
2218 }
2219
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002220 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2221 islambda = TRUE;
2222
2223 /*
2224 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2225 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2226 * each argument variable and saves a lot of time.
2227 */
2228 /*
2229 * Init l: variables.
2230 */
2231 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2232 if (selfdict != NULL)
2233 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002234 // Set l:self to "selfdict". Use "name" to avoid a warning from
2235 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002236 v = &fc->fixvar[fixvar_idx++].var;
2237 name = v->di_key;
2238 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002239 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002240 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2241 v->di_tv.v_type = VAR_DICT;
2242 v->di_tv.v_lock = 0;
2243 v->di_tv.vval.v_dict = selfdict;
2244 ++selfdict->dv_refcount;
2245 }
2246
2247 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002248 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002249 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002250 * Set a:000 to a list with room for the "..." arguments.
2251 */
2252 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002253 if ((fp->uf_flags & FC_NOARGS) == 0)
2254 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002255 (varnumber_T)(argcount >= fp->uf_args.ga_len
2256 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002257 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002258 if ((fp->uf_flags & FC_NOARGS) == 0)
2259 {
2260 // Use "name" to avoid a warning from some compiler that checks the
2261 // destination size.
2262 v = &fc->fixvar[fixvar_idx++].var;
2263 name = v->di_key;
2264 STRCPY(name, "000");
2265 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2266 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2267 v->di_tv.v_type = VAR_LIST;
2268 v->di_tv.v_lock = VAR_FIXED;
2269 v->di_tv.vval.v_list = &fc->l_varlist;
2270 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002271 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002272 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2273 fc->l_varlist.lv_lock = VAR_FIXED;
2274
2275 /*
2276 * Set a:firstline to "firstline" and a:lastline to "lastline".
2277 * Set a:name to named arguments.
2278 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002279 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002280 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002281 if ((fp->uf_flags & FC_NOARGS) == 0)
2282 {
2283 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002284 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002285 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002286 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002287 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002288 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002289 {
2290 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002291 typval_T def_rettv;
2292 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002293
2294 ai = i - fp->uf_args.ga_len;
2295 if (ai < 0)
2296 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002297 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002298 name = FUNCARG(fp, i);
2299 if (islambda)
2300 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002301
2302 // evaluate named argument default expression
2303 isdefault = ai + fp->uf_def_args.ga_len >= 0
2304 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2305 && argvars[i].vval.v_number == VVAL_NONE));
2306 if (isdefault)
2307 {
2308 char_u *default_expr = NULL;
2309 def_rettv.v_type = VAR_NUMBER;
2310 def_rettv.vval.v_number = -1;
2311
2312 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2313 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002314 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002315 {
2316 default_arg_err = 1;
2317 break;
2318 }
2319 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002320 }
2321 else
2322 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002323 if ((fp->uf_flags & FC_NOARGS) != 0)
2324 // Bail out if no a: arguments used (in lambda).
2325 break;
2326
Bram Moolenaare38eab22019-12-05 21:50:01 +01002327 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002328 sprintf((char *)numbuf, "%d", ai + 1);
2329 name = numbuf;
2330 }
2331 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2332 {
2333 v = &fc->fixvar[fixvar_idx++].var;
2334 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002335 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002336 }
2337 else
2338 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002339 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340 if (v == NULL)
2341 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002342 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002343 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002344
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002345 // Note: the values are copied directly to avoid alloc/free.
2346 // "argvars" must have VAR_FIXED for v_lock.
2347 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002348 v->di_tv.v_lock = VAR_FIXED;
2349
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002350 if (addlocal)
2351 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002352 // Named arguments should be accessed without the "a:" prefix in
2353 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002354 copy_tv(&v->di_tv, &v->di_tv);
2355 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002356 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002357 else
2358 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002359
2360 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2361 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002362 listitem_T *li = &fc->l_listitems[ai];
2363
2364 li->li_tv = argvars[i];
2365 li->li_tv.v_lock = VAR_FIXED;
2366 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002367 }
2368 }
2369
Bram Moolenaare38eab22019-12-05 21:50:01 +01002370 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002371 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002372
2373 if (fp->uf_flags & FC_SANDBOX)
2374 {
2375 using_sandbox = TRUE;
2376 ++sandbox;
2377 }
2378
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002379 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002380 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002381 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002383 ++no_wait_return;
2384 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002386 smsg(_("calling %s"), SOURCING_NAME);
2387 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002388 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002389 char_u buf[MSG_BUF_LEN];
2390 char_u numbuf2[NUMBUFLEN];
2391 char_u *tofree;
2392 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002394 msg_puts("(");
2395 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002396 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002397 if (i > 0)
2398 msg_puts(", ");
2399 if (argvars[i].v_type == VAR_NUMBER)
2400 msg_outnum((long)argvars[i].vval.v_number);
2401 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002402 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002403 // Do not want errors such as E724 here.
2404 ++emsg_off;
2405 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2406 --emsg_off;
2407 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002408 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002409 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002411 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2412 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002413 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002414 msg_puts((char *)s);
2415 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002416 }
2417 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002418 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002419 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002420 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002421 msg_puts("\n"); // don't overwrite this either
2422
2423 verbose_leave_scroll();
2424 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002425 }
2426#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002427 if (do_profiling == PROF_YES)
2428 profile_may_start_func(&profile_info, fp,
2429 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002430#endif
2431
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002432 save_current_sctx = current_sctx;
2433 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002434 save_did_emsg = did_emsg;
2435 did_emsg = FALSE;
2436
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002437 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2438 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002439 else if (islambda)
2440 {
2441 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2442
2443 // A Lambda always has the command "return {expr}". It is much faster
2444 // to evaluate {expr} directly.
2445 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002446 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002447 --ex_nesting_level;
2448 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002449 else
2450 // call do_cmdline() to execute the lines
2451 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002452 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2453
2454 --RedrawingDisabled;
2455
Bram Moolenaare38eab22019-12-05 21:50:01 +01002456 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002457 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2458 {
2459 clear_tv(rettv);
2460 rettv->v_type = VAR_NUMBER;
2461 rettv->vval.v_number = -1;
2462 }
2463
2464#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002465 if (do_profiling == PROF_YES)
2466 {
2467 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2468
2469 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2470 profile_may_end_func(&profile_info, fp, caller);
2471 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472#endif
2473
Bram Moolenaare38eab22019-12-05 21:50:01 +01002474 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002475 if (p_verbose >= 12)
2476 {
2477 ++no_wait_return;
2478 verbose_enter_scroll();
2479
2480 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002481 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002482 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002483 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002484 (long)fc->rettv->vval.v_number);
2485 else
2486 {
2487 char_u buf[MSG_BUF_LEN];
2488 char_u numbuf2[NUMBUFLEN];
2489 char_u *tofree;
2490 char_u *s;
2491
Bram Moolenaare38eab22019-12-05 21:50:01 +01002492 // The value may be very long. Skip the middle part, so that we
2493 // have some idea how it starts and ends. smsg() would always
2494 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002495 ++emsg_off;
2496 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2497 --emsg_off;
2498 if (s != NULL)
2499 {
2500 if (vim_strsize(s) > MSG_BUF_CLEN)
2501 {
2502 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2503 s = buf;
2504 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002505 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002506 vim_free(tofree);
2507 }
2508 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002509 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002510
2511 verbose_leave_scroll();
2512 --no_wait_return;
2513 }
2514
Bram Moolenaare31ee862020-01-07 20:59:34 +01002515 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002516 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002517 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518#ifdef FEAT_PROFILE
2519 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002520 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002522 if (using_sandbox)
2523 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002524
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002525 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002526 {
2527 ++no_wait_return;
2528 verbose_enter_scroll();
2529
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002530 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002531 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002532
2533 verbose_leave_scroll();
2534 --no_wait_return;
2535 }
2536
2537 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002538 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002539 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002540}
2541
2542/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002543 * Check the argument count for user function "fp".
2544 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2545 */
2546 int
2547check_user_func_argcount(ufunc_T *fp, int argcount)
2548{
2549 int regular_args = fp->uf_args.ga_len;
2550
2551 if (argcount < regular_args - fp->uf_def_args.ga_len)
2552 return FCERR_TOOFEW;
2553 else if (!has_varargs(fp) && argcount > regular_args)
2554 return FCERR_TOOMANY;
2555 return FCERR_UNKNOWN;
2556}
2557
2558/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002559 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002560 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002561 int
2562call_user_func_check(
2563 ufunc_T *fp,
2564 int argcount,
2565 typval_T *argvars,
2566 typval_T *rettv,
2567 funcexe_T *funcexe,
2568 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002569{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002570 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002571
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002572 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2573 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002574 error = check_user_func_argcount(fp, argcount);
2575 if (error != FCERR_UNKNOWN)
2576 return error;
2577 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002578 error = FCERR_DICT;
2579 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002580 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002581 int did_save_redo = FALSE;
2582 save_redo_T save_redo;
2583
2584 /*
2585 * Call the user function.
2586 * Save and restore search patterns, script variables and
2587 * redo buffer.
2588 */
2589 save_search_patterns();
2590 if (!ins_compl_active())
2591 {
2592 saveRedobuff(&save_redo);
2593 did_save_redo = TRUE;
2594 }
2595 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002596 call_user_func(fp, argcount, argvars, rettv, funcexe,
2597 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002598 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2599 // Function was unreferenced while being used, free it now.
2600 func_clear_free(fp, FALSE);
2601 if (did_save_redo)
2602 restoreRedobuff(&save_redo);
2603 restore_search_patterns();
2604 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002605 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002606 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002607}
2608
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002609static funccal_entry_T *funccal_stack = NULL;
2610
2611/*
2612 * Save the current function call pointer, and set it to NULL.
2613 * Used when executing autocommands and for ":source".
2614 */
2615 void
2616save_funccal(funccal_entry_T *entry)
2617{
2618 entry->top_funccal = current_funccal;
2619 entry->next = funccal_stack;
2620 funccal_stack = entry;
2621 current_funccal = NULL;
2622}
2623
2624 void
2625restore_funccal(void)
2626{
2627 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002628 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002629 else
2630 {
2631 current_funccal = funccal_stack->top_funccal;
2632 funccal_stack = funccal_stack->next;
2633 }
2634}
2635
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002636 funccall_T *
2637get_current_funccal(void)
2638{
2639 return current_funccal;
2640}
2641
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002642/*
2643 * Mark all functions of script "sid" as deleted.
2644 */
2645 void
2646delete_script_functions(int sid)
2647{
2648 hashitem_T *hi;
2649 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002650 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002651 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002652 size_t len;
2653
2654 buf[0] = K_SPECIAL;
2655 buf[1] = KS_EXTRA;
2656 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002657 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002658 len = STRLEN(buf);
2659
Bram Moolenaarce658352020-07-31 23:47:12 +02002660 while (todo > 0)
2661 {
2662 todo = func_hashtab.ht_used;
2663 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2664 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002665 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002666 fp = HI2UF(hi);
2667 if (STRNCMP(fp->uf_name, buf, len) == 0)
2668 {
2669 int changed = func_hashtab.ht_changed;
2670
2671 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002672
2673 if (fp->uf_calls > 0)
2674 {
2675 // Function is executing, don't free it but do remove
2676 // it from the hashtable.
2677 if (func_remove(fp))
2678 fp->uf_refcount--;
2679 }
2680 else
2681 {
2682 func_clear(fp, TRUE);
2683 // When clearing a function another function can be
2684 // cleared as a side effect. When that happens start
2685 // over.
2686 if (changed != func_hashtab.ht_changed)
2687 break;
2688 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002689 }
2690 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002691 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002692 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002693}
2694
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002695#if defined(EXITFREE) || defined(PROTO)
2696 void
2697free_all_functions(void)
2698{
2699 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002700 ufunc_T *fp;
2701 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002702 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002703 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704
Bram Moolenaare38eab22019-12-05 21:50:01 +01002705 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002706 while (current_funccal != NULL)
2707 {
2708 clear_tv(current_funccal->rettv);
2709 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002710 if (current_funccal == NULL && funccal_stack != NULL)
2711 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002712 }
2713
Bram Moolenaare38eab22019-12-05 21:50:01 +01002714 // First clear what the functions contain. Since this may lower the
2715 // reference count of a function, it may also free a function and change
2716 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002717 while (todo > 0)
2718 {
2719 todo = func_hashtab.ht_used;
2720 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2721 if (!HASHITEM_EMPTY(hi))
2722 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002723 // clear the def function index now
2724 fp = HI2UF(hi);
2725 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002726 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002727
Bram Moolenaare38eab22019-12-05 21:50:01 +01002728 // Only free functions that are not refcounted, those are
2729 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002730 if (func_name_refcount(fp->uf_name))
2731 ++skipped;
2732 else
2733 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002734 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002735 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002736 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002737 {
2738 skipped = 0;
2739 break;
2740 }
2741 }
2742 --todo;
2743 }
2744 }
2745
Bram Moolenaare38eab22019-12-05 21:50:01 +01002746 // Now actually free the functions. Need to start all over every time,
2747 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002748 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002749 while (func_hashtab.ht_used > skipped)
2750 {
2751 todo = func_hashtab.ht_used;
2752 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002753 if (!HASHITEM_EMPTY(hi))
2754 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002755 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002756 // Only free functions that are not refcounted, those are
2757 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002758 fp = HI2UF(hi);
2759 if (func_name_refcount(fp->uf_name))
2760 ++skipped;
2761 else
2762 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002763 if (func_free(fp, FALSE) == OK)
2764 {
2765 skipped = 0;
2766 break;
2767 }
2768 // did not actually free it
2769 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002770 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002772 }
2773 if (skipped == 0)
2774 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002775
2776 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777}
2778#endif
2779
2780/*
2781 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002782 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783 * "len" is the length of "name", or -1 for NUL terminated.
2784 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002785 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786builtin_function(char_u *name, int len)
2787{
2788 char_u *p;
2789
Bram Moolenaara26b9702020-04-18 19:53:28 +02002790 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002791 return FALSE;
2792 p = vim_strchr(name, AUTOLOAD_CHAR);
2793 return p == NULL || (len > 0 && p > name + len);
2794}
2795
2796 int
2797func_call(
2798 char_u *name,
2799 typval_T *args,
2800 partial_T *partial,
2801 dict_T *selfdict,
2802 typval_T *rettv)
2803{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002804 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 listitem_T *item;
2806 typval_T argv[MAX_FUNC_ARGS + 1];
2807 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002808 int r = 0;
2809
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002810 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002811 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 {
2813 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2814 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002815 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 break;
2817 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002818 // Make a copy of each argument. This is needed to be able to set
2819 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 copy_tv(&item->li_tv, &argv[argc++]);
2821 }
2822
2823 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002824 {
2825 funcexe_T funcexe;
2826
Bram Moolenaara80faa82020-04-12 19:37:17 +02002827 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002828 funcexe.firstline = curwin->w_cursor.lnum;
2829 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002830 funcexe.evaluate = TRUE;
2831 funcexe.partial = partial;
2832 funcexe.selfdict = selfdict;
2833 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2834 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835
Bram Moolenaare38eab22019-12-05 21:50:01 +01002836 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 while (argc > 0)
2838 clear_tv(&argv[--argc]);
2839
2840 return r;
2841}
2842
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002843static int callback_depth = 0;
2844
2845 int
2846get_callback_depth(void)
2847{
2848 return callback_depth;
2849}
2850
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002851/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002852 * Invoke call_func() with a callback.
2853 */
2854 int
2855call_callback(
2856 callback_T *callback,
2857 int len, // length of "name" or -1 to use strlen()
2858 typval_T *rettv, // return value goes here
2859 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002860 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002861 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002862{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002863 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002864 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002865
Bram Moolenaara80faa82020-04-12 19:37:17 +02002866 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002867 funcexe.evaluate = TRUE;
2868 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002869 ++callback_depth;
2870 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2871 --callback_depth;
2872 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002873}
2874
2875/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002876 * Give an error message for the result of a function.
2877 * Nothing if "error" is FCERR_NONE.
2878 */
2879 void
2880user_func_error(int error, char_u *name)
2881{
2882 switch (error)
2883 {
2884 case FCERR_UNKNOWN:
2885 emsg_funcname(e_unknownfunc, name);
2886 break;
2887 case FCERR_NOTMETHOD:
2888 emsg_funcname(
2889 N_("E276: Cannot use function as a method: %s"), name);
2890 break;
2891 case FCERR_DELETED:
2892 emsg_funcname(N_(e_func_deleted), name);
2893 break;
2894 case FCERR_TOOMANY:
2895 emsg_funcname((char *)e_toomanyarg, name);
2896 break;
2897 case FCERR_TOOFEW:
2898 emsg_funcname((char *)e_toofewarg, name);
2899 break;
2900 case FCERR_SCRIPT:
2901 emsg_funcname(
2902 N_("E120: Using <SID> not in a script context: %s"), name);
2903 break;
2904 case FCERR_DICT:
2905 emsg_funcname(
2906 N_("E725: Calling dict function without Dictionary: %s"),
2907 name);
2908 break;
2909 }
2910}
2911
2912/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002913 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002914 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915 * Return FAIL when the function can't be called, OK otherwise.
2916 * Also returns OK when an error was encountered while executing the function.
2917 */
2918 int
2919call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002920 char_u *funcname, // name of the function
2921 int len, // length of "name" or -1 to use strlen()
2922 typval_T *rettv, // return value goes here
2923 int argcount_in, // number of "argvars"
2924 typval_T *argvars_in, // vars for arguments, must have "argcount"
2925 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002926 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927{
2928 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002929 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002930 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002931 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002932 char_u fname_buf[FLEN_FIXED + 1];
2933 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002934 char_u *fname = NULL;
2935 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002936 int argcount = argcount_in;
2937 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002938 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002939 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2940 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002942 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002943 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002944
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002945 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2946 // even when call_func() returns FAIL.
2947 rettv->v_type = VAR_UNKNOWN;
2948
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002949 if (partial != NULL)
2950 fp = partial->pt_func;
2951 if (fp == NULL)
2952 {
2953 // Make a copy of the name, if it comes from a funcref variable it
2954 // could be changed or deleted in the called function.
2955 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2956 if (name == NULL)
2957 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002959 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2960 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002962 if (funcexe->doesrange != NULL)
2963 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002964
2965 if (partial != NULL)
2966 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002967 // When the function has a partial with a dict and there is a dict
2968 // argument, use the dict argument. That is backwards compatible.
2969 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002970 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002972 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002973 {
2974 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002975 {
2976 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2977 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002978 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002979 goto theend;
2980 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002981 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002982 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 for (i = 0; i < argcount_in; ++i)
2984 argv[i + argv_clear] = argvars_in[i];
2985 argvars = argv;
2986 argcount = partial->pt_argc + argcount_in;
2987 }
2988 }
2989
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002990 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2991 {
2992 // Check that the argument types are OK for the types of the funcref.
2993 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01002994 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002995 error = FCERR_OTHER;
2996 }
2997
Bram Moolenaaref140542019-12-31 21:27:13 +01002998 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002999 {
3000 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003001 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002
Bram Moolenaar333894b2020-08-01 18:53:07 +02003003 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003004 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003005 {
3006 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003008 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003009
Bram Moolenaare38eab22019-12-05 21:50:01 +01003010 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003011 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003012 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003014 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003015 {
3016 /*
3017 * User defined function.
3018 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003019 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003020 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021
Bram Moolenaare38eab22019-12-05 21:50:01 +01003022 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 if (fp == NULL
3024 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003025 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 && !aborting())
3027 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003028 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003029 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003030 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003031 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003032 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3033 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003034 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003035 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003036 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003037 if (fp == NULL)
3038 {
3039 char_u *p = untrans_function_name(rfname);
3040
3041 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003042 // Don't do this if the name starts with "s:".
3043 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003044 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003045 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003046
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003047 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003048 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003049#ifdef FEAT_LUA
3050 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3051 {
3052 cfunc_T cb = fp->uf_cb;
3053
3054 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3055 }
3056#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003057 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003058 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003059 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003060 // postponed filling in the arguments, do it now
3061 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003062 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003063
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003064 if (funcexe->basetv != NULL)
3065 {
3066 // Method call: base->Method()
3067 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3068 argv[0] = *funcexe->basetv;
3069 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003070 argvars = argv;
3071 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003072 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003073
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003074 error = call_user_func_check(fp, argcount, argvars, rettv,
3075 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003076 }
3077 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003078 else if (funcexe->basetv != NULL)
3079 {
3080 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003081 * expr->method(): Find the method name in the table, call its
3082 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003083 */
3084 error = call_internal_method(fname, argcount, argvars, rettv,
3085 funcexe->basetv);
3086 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003087 else
3088 {
3089 /*
3090 * Find the function name in the table, call its implementation.
3091 */
3092 error = call_internal_func(fname, argcount, argvars, rettv);
3093 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003094
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003095 /*
3096 * The function call (or "FuncUndefined" autocommand sequence) might
3097 * have been aborted by an error, an interrupt, or an explicitly thrown
3098 * exception that has not been caught so far. This situation can be
3099 * tested for by calling aborting(). For an error in an internal
3100 * function or for the "E132" error in call_user_func(), however, the
3101 * throw point at which the "force_abort" flag (temporarily reset by
3102 * emsg()) is normally updated has not been reached yet. We need to
3103 * update that flag first to make aborting() reliable.
3104 */
3105 update_force_abort();
3106 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003107 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 ret = OK;
3109
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003110theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003111 /*
3112 * Report an error unless the argument evaluation or function call has been
3113 * cancelled due to an aborting error, an interrupt, or an exception.
3114 */
3115 if (!aborting())
3116 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003117 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118 }
3119
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003120 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003122 clear_tv(&argv[--argv_clear + argv_base]);
3123
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003124 vim_free(tofree);
3125 vim_free(name);
3126
3127 return ret;
3128}
3129
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003130 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003131printable_func_name(ufunc_T *fp)
3132{
3133 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3134}
3135
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003136/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003137 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003138 */
3139 static void
3140list_func_head(ufunc_T *fp, int indent)
3141{
3142 int j;
3143
3144 msg_start();
3145 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003146 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003147 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003148 msg_puts("def ");
3149 else
3150 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003151 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003152 msg_putchar('(');
3153 for (j = 0; j < fp->uf_args.ga_len; ++j)
3154 {
3155 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003156 msg_puts(", ");
3157 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003158 if (fp->uf_arg_types != NULL)
3159 {
3160 char *tofree;
3161
3162 msg_puts(": ");
3163 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3164 vim_free(tofree);
3165 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003166 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3167 {
3168 msg_puts(" = ");
3169 msg_puts(((char **)(fp->uf_def_args.ga_data))
3170 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3171 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003172 }
3173 if (fp->uf_varargs)
3174 {
3175 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003176 msg_puts(", ");
3177 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003179 if (fp->uf_va_name != NULL)
3180 {
3181 if (j)
3182 msg_puts(", ");
3183 msg_puts("...");
3184 msg_puts((char *)fp->uf_va_name);
3185 if (fp->uf_va_type)
3186 {
3187 char *tofree;
3188
3189 msg_puts(": ");
3190 msg_puts(type_name(fp->uf_va_type, &tofree));
3191 vim_free(tofree);
3192 }
3193 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003194 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003195
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003196 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003197 {
3198 if (fp->uf_ret_type != &t_void)
3199 {
3200 char *tofree;
3201
3202 msg_puts(": ");
3203 msg_puts(type_name(fp->uf_ret_type, &tofree));
3204 vim_free(tofree);
3205 }
3206 }
3207 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003208 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003209 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003210 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003211 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003212 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003213 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003214 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215 msg_clr_eos();
3216 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003217 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218}
3219
3220/*
3221 * Get a function name, translating "<SID>" and "<SNR>".
3222 * Also handles a Funcref in a List or Dictionary.
3223 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003224 * Set "*is_global" to TRUE when the function must be global, unless
3225 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226 * flags:
3227 * TFN_INT: internal function name OK
3228 * TFN_QUIET: be quiet
3229 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003230 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231 * Advances "pp" to just after the function name (if no error).
3232 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003233 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003234trans_function_name(
3235 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003236 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003237 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003238 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003239 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003240 partial_T **partial, // return: partial of a FuncRef
3241 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003242{
3243 char_u *name = NULL;
3244 char_u *start;
3245 char_u *end;
3246 int lead;
3247 char_u sid_buf[20];
3248 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003249 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003252 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253
3254 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003255 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256 start = *pp;
3257
Bram Moolenaare38eab22019-12-05 21:50:01 +01003258 // Check for hard coded <SNR>: already translated function ID (from a user
3259 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003260 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3261 && (*pp)[2] == (int)KE_SNR)
3262 {
3263 *pp += 3;
3264 len = get_id_len(pp) + 3;
3265 return vim_strnsave(start, len);
3266 }
3267
Bram Moolenaare38eab22019-12-05 21:50:01 +01003268 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3269 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270 lead = eval_fname_script(start);
3271 if (lead > 2)
3272 start += lead;
3273
Bram Moolenaare38eab22019-12-05 21:50:01 +01003274 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003275 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276 lead > 2 ? 0 : FNE_CHECK_START);
3277 if (end == start)
3278 {
3279 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003280 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 goto theend;
3282 }
3283 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3284 {
3285 /*
3286 * Report an invalid expression in braces, unless the expression
3287 * evaluation has been cancelled due to an aborting error, an
3288 * interrupt, or an exception.
3289 */
3290 if (!aborting())
3291 {
3292 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003293 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 }
3295 else
3296 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3297 goto theend;
3298 }
3299
3300 if (lv.ll_tv != NULL)
3301 {
3302 if (fdp != NULL)
3303 {
3304 fdp->fd_dict = lv.ll_dict;
3305 fdp->fd_newkey = lv.ll_newkey;
3306 lv.ll_newkey = NULL;
3307 fdp->fd_di = lv.ll_di;
3308 }
3309 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3310 {
3311 name = vim_strsave(lv.ll_tv->vval.v_string);
3312 *pp = end;
3313 }
3314 else if (lv.ll_tv->v_type == VAR_PARTIAL
3315 && lv.ll_tv->vval.v_partial != NULL)
3316 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003317 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003318 *pp = end;
3319 if (partial != NULL)
3320 *partial = lv.ll_tv->vval.v_partial;
3321 }
3322 else
3323 {
3324 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3325 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003326 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327 else
3328 *pp = end;
3329 name = NULL;
3330 }
3331 goto theend;
3332 }
3333
3334 if (lv.ll_name == NULL)
3335 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003336 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003337 *pp = end;
3338 goto theend;
3339 }
3340
Bram Moolenaare38eab22019-12-05 21:50:01 +01003341 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 if (lv.ll_exp_name != NULL)
3343 {
3344 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003345 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 flags & TFN_NO_AUTOLOAD);
3347 if (name == lv.ll_exp_name)
3348 name = NULL;
3349 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003350 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 {
3352 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003353 name = deref_func_name(*pp, &len, partial, type,
3354 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355 if (name == *pp)
3356 name = NULL;
3357 }
3358 if (name != NULL)
3359 {
3360 name = vim_strsave(name);
3361 *pp = end;
3362 if (STRNCMP(name, "<SNR>", 5) == 0)
3363 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003364 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003365 name[0] = K_SPECIAL;
3366 name[1] = KS_EXTRA;
3367 name[2] = (int)KE_SNR;
3368 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3369 }
3370 goto theend;
3371 }
3372
3373 if (lv.ll_exp_name != NULL)
3374 {
3375 len = (int)STRLEN(lv.ll_exp_name);
3376 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3377 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3378 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003379 // When there was "s:" already or the name expanded to get a
3380 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003381 lv.ll_name += 2;
3382 len -= 2;
3383 lead = 2;
3384 }
3385 }
3386 else
3387 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003388 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003389 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003390 {
3391 if (is_global != NULL && lv.ll_name[0] == 'g')
3392 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003393 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003394 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003395 len = (int)(end - lv.ll_name);
3396 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003397 if (len <= 0)
3398 {
3399 if (!skip)
3400 emsg(_(e_function_name));
3401 goto theend;
3402 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003403
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003404 // In Vim9 script a user function is script-local by default, unless it
3405 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003406 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003407 if (vim9script)
3408 {
3409 char_u *p;
3410
3411 // SomeScript#func() is a global function.
3412 for (p = start; *p != NUL && *p != '('; ++p)
3413 if (*p == AUTOLOAD_CHAR)
3414 vim9script = FALSE;
3415 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003416
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003417 /*
3418 * Copy the function name to allocated memory.
3419 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3420 * Accept <SNR>123_name() outside a script.
3421 */
3422 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003423 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003424 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003425 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003426 if (!vim9script)
3427 lead = 3;
3428 if (vim9script || (lv.ll_exp_name != NULL
3429 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003430 || eval_fname_sid(*pp))
3431 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003432 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003433 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003434 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003435 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003436 goto theend;
3437 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003438 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003439 if (vim9script)
3440 extra = 3 + (int)STRLEN(sid_buf);
3441 else
3442 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 }
3444 }
3445 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3446 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003447 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003448 start);
3449 goto theend;
3450 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003451 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 {
3453 char_u *cp = vim_strchr(lv.ll_name, ':');
3454
3455 if (cp != NULL && cp < end)
3456 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003457 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003458 goto theend;
3459 }
3460 }
3461
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 if (name != NULL)
3464 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003465 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 {
3467 name[0] = K_SPECIAL;
3468 name[1] = KS_EXTRA;
3469 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 STRCPY(name + 3, sid_buf);
3472 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003473 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3474 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003475 }
3476 *pp = end;
3477
3478theend:
3479 clear_lval(&lv);
3480 return name;
3481}
3482
3483/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003484 * Assuming "name" is the result of trans_function_name() and it was prefixed
3485 * to use the script-local name, return the unmodified name (points into
3486 * "name"). Otherwise return NULL.
3487 * This can be used to first search for a script-local function and fall back
3488 * to the global function if not found.
3489 */
3490 char_u *
3491untrans_function_name(char_u *name)
3492{
3493 char_u *p;
3494
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003495 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003496 {
3497 p = vim_strchr(name, '_');
3498 if (p != NULL)
3499 return p + 1;
3500 }
3501 return NULL;
3502}
3503
3504/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003505 * List functions. When "regmatch" is NULL all of then.
3506 * Otherwise functions matching "regmatch".
3507 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003508 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003509list_functions(regmatch_T *regmatch)
3510{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003511 int changed = func_hashtab.ht_changed;
3512 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003513 hashitem_T *hi;
3514
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003515 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003516 {
3517 if (!HASHITEM_EMPTY(hi))
3518 {
3519 ufunc_T *fp = HI2UF(hi);
3520
3521 --todo;
3522 if ((fp->uf_flags & FC_DEAD) == 0
3523 && (regmatch == NULL
3524 ? !message_filtered(fp->uf_name)
3525 && !func_name_refcount(fp->uf_name)
3526 : !isdigit(*fp->uf_name)
3527 && vim_regexec(regmatch, fp->uf_name, 0)))
3528 {
3529 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003530 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003531 {
3532 emsg(_("E454: function list was modified"));
3533 return;
3534 }
3535 }
3536 }
3537 }
3538}
3539
3540/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003541 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003542 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3543 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003544 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003546 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003547define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003548{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003549 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003550 int j;
3551 int c;
3552 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003553 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003554 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 char_u *p;
3556 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003557 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003558 char_u *line_arg = NULL;
3559 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003560 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003561 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003562 garray_T newlines;
3563 int varargs = FALSE;
3564 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003565 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003566 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003567 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 dictitem_T *v;
3569 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003570 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003571 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003572 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003573 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003574 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003575 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576
3577 /*
3578 * ":function" without argument: list functions.
3579 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003580 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 {
3582 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003583 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003585 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003586 }
3587
3588 /*
3589 * ":function /pat": list functions matching pattern.
3590 */
3591 if (*eap->arg == '/')
3592 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003593 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003594 if (!eap->skip)
3595 {
3596 regmatch_T regmatch;
3597
3598 c = *p;
3599 *p = NUL;
3600 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3601 *p = c;
3602 if (regmatch.regprog != NULL)
3603 {
3604 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003605 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003606 vim_regfree(regmatch.regprog);
3607 }
3608 }
3609 if (*p == '/')
3610 ++p;
3611 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003612 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003613 }
3614
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003615 ga_init(&newargs);
3616 ga_init(&argtypes);
3617 ga_init(&default_args);
3618
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 /*
3620 * Get the function name. There are these situations:
3621 * func normal function name
3622 * "name" == func, "fudi.fd_dict" == NULL
3623 * dict.func new dictionary entry
3624 * "name" == NULL, "fudi.fd_dict" set,
3625 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3626 * dict.func existing dict entry with a Funcref
3627 * "name" == func, "fudi.fd_dict" set,
3628 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3629 * dict.func existing dict entry that's not a Funcref
3630 * "name" == NULL, "fudi.fd_dict" set,
3631 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3632 * s:func script-local function name
3633 * g:func global function name, same as "func"
3634 */
3635 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003636 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003637 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003638 // nested function, argument is (args).
3639 paren = TRUE;
3640 CLEAR_FIELD(fudi);
3641 }
3642 else
3643 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003644 if (STRNCMP(p, "<lambda>", 8) == 0)
3645 {
3646 p += 8;
3647 (void)getdigits(&p);
3648 name = vim_strnsave(eap->arg, p - eap->arg);
3649 CLEAR_FIELD(fudi);
3650 }
3651 else
3652 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003653 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003654 paren = (vim_strchr(p, '(') != NULL);
3655 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003656 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003657 /*
3658 * Return on an invalid expression in braces, unless the expression
3659 * evaluation has been cancelled due to an aborting error, an
3660 * interrupt, or an exception.
3661 */
3662 if (!aborting())
3663 {
3664 if (!eap->skip && fudi.fd_newkey != NULL)
3665 semsg(_(e_dictkey), fudi.fd_newkey);
3666 vim_free(fudi.fd_newkey);
3667 return NULL;
3668 }
3669 else
3670 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 }
3673
Bram Moolenaare38eab22019-12-05 21:50:01 +01003674 // An error in a function call during evaluation of an expression in magic
3675 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 saved_did_emsg = did_emsg;
3677 did_emsg = FALSE;
3678
3679 /*
3680 * ":function func" with only function name: list function.
3681 */
3682 if (!paren)
3683 {
3684 if (!ends_excmd(*skipwhite(p)))
3685 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003686 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003687 goto ret_free;
3688 }
3689 eap->nextcmd = check_nextcmd(p);
3690 if (eap->nextcmd != NULL)
3691 *p = NUL;
3692 if (!eap->skip && !got_int)
3693 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003694 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003695 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3696 {
3697 char_u *up = untrans_function_name(name);
3698
3699 // With Vim9 script the name was made script-local, if not
3700 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003701 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003702 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003703 }
3704
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705 if (fp != NULL)
3706 {
3707 list_func_head(fp, TRUE);
3708 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3709 {
3710 if (FUNCLINE(fp, j) == NULL)
3711 continue;
3712 msg_putchar('\n');
3713 msg_outnum((long)(j + 1));
3714 if (j < 9)
3715 msg_putchar(' ');
3716 if (j < 99)
3717 msg_putchar(' ');
3718 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003719 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003720 ui_breakcheck();
3721 }
3722 if (!got_int)
3723 {
3724 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003725 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003726 msg_puts(" enddef");
3727 else
3728 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003729 }
3730 }
3731 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003732 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 }
3734 goto ret_free;
3735 }
3736
3737 /*
3738 * ":function name(arg1, arg2)" Define function.
3739 */
3740 p = skipwhite(p);
3741 if (*p != '(')
3742 {
3743 if (!eap->skip)
3744 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003745 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003746 goto ret_free;
3747 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003748 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749 if (vim_strchr(p, '(') != NULL)
3750 p = vim_strchr(p, '(');
3751 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003752
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003753 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3754 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003755 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003756 goto ret_free;
3757 }
3758
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003759 // In Vim9 script only global functions can be redefined.
3760 if (vim9script && eap->forceit && !is_global)
3761 {
3762 emsg(_(e_nobang));
3763 goto ret_free;
3764 }
3765
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003766 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003767
Bram Moolenaar04b12692020-05-04 23:24:44 +02003768 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003770 // Check the name of the function. Unless it's a dictionary function
3771 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003772 if (name != NULL)
3773 arg = name;
3774 else
3775 arg = fudi.fd_newkey;
3776 if (arg != NULL && (fudi.fd_di == NULL
3777 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3778 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3779 {
3780 if (*arg == K_SPECIAL)
3781 j = 3;
3782 else
3783 j = 0;
3784 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3785 : eval_isnamec(arg[j])))
3786 ++j;
3787 if (arg[j] != NUL)
3788 emsg_funcname((char *)e_invarg2, arg);
3789 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003790 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003791 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003792 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793 }
3794
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003795 // This may get more lines and make the pointers into the first line
3796 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003797 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003798 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003799 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003800 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003801 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003803 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003805 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003807 // find the return type: :def Func(): type
3808 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003811 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003812 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003813 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003814 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003815 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003816 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003817 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003818 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003819 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003820 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003821 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003822 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003824 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003826 else
3827 // find extra arguments "range", "dict", "abort" and "closure"
3828 for (;;)
3829 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003830 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003831 p = skipwhite(p);
3832 if (STRNCMP(p, "range", 5) == 0)
3833 {
3834 flags |= FC_RANGE;
3835 p += 5;
3836 }
3837 else if (STRNCMP(p, "dict", 4) == 0)
3838 {
3839 flags |= FC_DICT;
3840 p += 4;
3841 }
3842 else if (STRNCMP(p, "abort", 5) == 0)
3843 {
3844 flags |= FC_ABORT;
3845 p += 5;
3846 }
3847 else if (STRNCMP(p, "closure", 7) == 0)
3848 {
3849 flags |= FC_CLOSURE;
3850 p += 7;
3851 if (current_funccal == NULL)
3852 {
3853 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3854 name == NULL ? (char_u *)"" : name);
3855 goto erret;
3856 }
3857 }
3858 else
3859 break;
3860 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861
Bram Moolenaare38eab22019-12-05 21:50:01 +01003862 // When there is a line break use what follows for the function body.
3863 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003864 if (*p == '\n')
3865 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003866 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003867 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3868 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003869 && !(VIM_ISWHITE(*whitep) && *p == '#'
3870 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003871 && !eap->skip
3872 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003873 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874
3875 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003876 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3877 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878 */
3879 if (KeyTyped)
3880 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003881 // Check if the function already exists, don't let the user type the
3882 // whole function before telling him it doesn't work! For a script we
3883 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003884 if (!eap->skip && !eap->forceit)
3885 {
3886 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003887 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003888 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003889 emsg_funcname(e_funcexts, name);
3890 }
3891
3892 if (!eap->skip && did_emsg)
3893 goto erret;
3894
Bram Moolenaare38eab22019-12-05 21:50:01 +01003895 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003896 cmdline_row = msg_row;
3897 }
3898
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003899 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003900 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003901
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003902 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003903 goto erret;
3904
3905 /*
3906 * If there are no errors, add the function
3907 */
3908 if (fudi.fd_dict == NULL)
3909 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003910 hashtab_T *ht;
3911
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003912 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003913 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3914 {
3915 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3916 name);
3917 goto erret;
3918 }
3919
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003920 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003921 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003922 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003923 char_u *uname = untrans_function_name(name);
3924
3925 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3926 }
3927
3928 if (fp != NULL || import != NULL)
3929 {
3930 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003931
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003932 // Function can be replaced with "function!" and when sourcing the
3933 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003934 // A name that is used by an import can not be overruled.
3935 if (import != NULL
3936 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003937 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003938 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003940 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003941 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003942 else
3943 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003944 goto erret;
3945 }
3946 if (fp->uf_calls > 0)
3947 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003948 emsg_funcname(
3949 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003950 name);
3951 goto erret;
3952 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003953 if (fp->uf_refcount > 1)
3954 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003955 // This function is referenced somewhere, don't redefine it but
3956 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003957 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003958 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003959 fp = NULL;
3960 overwrite = TRUE;
3961 }
3962 else
3963 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003964 char_u *exp_name = fp->uf_name_exp;
3965
3966 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003967 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003968 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003969 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003970 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003971 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003972#ifdef FEAT_PROFILE
3973 fp->uf_profiling = FALSE;
3974 fp->uf_prof_initialized = FALSE;
3975#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003976 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003977 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003978 }
3979 }
3980 else
3981 {
3982 char numbuf[20];
3983
3984 fp = NULL;
3985 if (fudi.fd_newkey == NULL && !eap->forceit)
3986 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003987 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003988 goto erret;
3989 }
3990 if (fudi.fd_di == NULL)
3991 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003992 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003993 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003994 goto erret;
3995 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003996 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003997 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 goto erret;
3999
Bram Moolenaare38eab22019-12-05 21:50:01 +01004000 // Give the function a sequential number. Can only be used with a
4001 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004002 vim_free(name);
4003 sprintf(numbuf, "%d", ++func_nr);
4004 name = vim_strsave((char_u *)numbuf);
4005 if (name == NULL)
4006 goto erret;
4007 }
4008
4009 if (fp == NULL)
4010 {
4011 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4012 {
4013 int slen, plen;
4014 char_u *scriptname;
4015
Bram Moolenaare38eab22019-12-05 21:50:01 +01004016 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004018 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019 {
4020 scriptname = autoload_name(name);
4021 if (scriptname != NULL)
4022 {
4023 p = vim_strchr(scriptname, '/');
4024 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004025 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004026 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004027 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004028 j = OK;
4029 vim_free(scriptname);
4030 }
4031 }
4032 if (j == FAIL)
4033 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004034 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035 goto erret;
4036 }
4037 }
4038
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004039 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 if (fp == NULL)
4041 goto erret;
4042
4043 if (fudi.fd_dict != NULL)
4044 {
4045 if (fudi.fd_di == NULL)
4046 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004047 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004048 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4049 if (fudi.fd_di == NULL)
4050 {
4051 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004052 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 goto erret;
4054 }
4055 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4056 {
4057 vim_free(fudi.fd_di);
4058 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004059 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 goto erret;
4061 }
4062 }
4063 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004064 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065 clear_tv(&fudi.fd_di->di_tv);
4066 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004068
Bram Moolenaare38eab22019-12-05 21:50:01 +01004069 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 flags |= FC_DICT;
4071 }
4072
Bram Moolenaare38eab22019-12-05 21:50:01 +01004073 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004074 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004075 if (overwrite)
4076 {
4077 hi = hash_find(&func_hashtab, name);
4078 hi->hi_key = UF2HIKEY(fp);
4079 }
4080 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 {
4082 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004083 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 goto erret;
4085 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004086 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004087 }
4088 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004089 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004090 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004091 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004092
4093 if (eap->cmdidx == CMD_def)
4094 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004095 int lnum_save = SOURCING_LNUM;
4096 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004097
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004098 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004099
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004100 // error messages are for the first function line
4101 SOURCING_LNUM = sourcing_lnum_top;
4102
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004103 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004104 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004105 int count = cstack->cs_idx + 1;
4106 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004107
4108 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004109 // a block that is visible now but not when the function is called
4110 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004111 fp->uf_block_ids = ALLOC_MULT(int, count);
4112 if (fp->uf_block_ids != NULL)
4113 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004114 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004115 sizeof(int) * count);
4116 fp->uf_block_depth = count;
4117 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004118
4119 // Set flag in each block to indicate a function was defined. This
4120 // is used to keep the variable when leaving the block, see
4121 // hide_script_var().
4122 for (i = 0; i <= cstack->cs_idx; ++i)
4123 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004124 }
4125
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004126 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004127 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004128 SOURCING_LNUM = lnum_save;
4129 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004130 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004131 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132
4133 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004134 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004136 SOURCING_LNUM = lnum_save;
4137 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004138 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004139 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004141 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004142 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004143
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004144 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004145 if ((flags & FC_CLOSURE) != 0)
4146 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004147 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004148 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004149 }
4150 else
4151 fp->uf_scoped = NULL;
4152
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004153#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004154 if (prof_def_func())
4155 func_do_profile(fp);
4156#endif
4157 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004158 if (sandbox)
4159 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004160 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004161 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004162 fp->uf_flags = flags;
4163 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004164 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004165 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004166 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004167 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004168 if (is_export)
4169 {
4170 fp->uf_flags |= FC_EXPORT;
4171 // let ex_export() know the export worked.
4172 is_export = FALSE;
4173 }
4174
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004175 if (eap->cmdidx == CMD_def)
4176 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004177 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4178 // :func does not use Vim9 script syntax, even in a Vim9 script file
4179 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004180
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004181 goto ret_free;
4182
4183erret:
4184 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004185 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004186 if (fp != NULL)
4187 {
4188 ga_init(&fp->uf_args);
4189 ga_init(&fp->uf_def_args);
4190 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004191errret_2:
4192 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004193 if (fp != NULL)
4194 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004196 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004197 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004198 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004199 if (name != name_arg)
4200 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004201 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004202 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004203
4204 return fp;
4205}
4206
4207/*
4208 * ":function"
4209 */
4210 void
4211ex_function(exarg_T *eap)
4212{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004213 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004214}
4215
4216/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004217 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004218 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004219 */
4220 void
4221ex_defcompile(exarg_T *eap UNUSED)
4222{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004223 long todo = (long)func_hashtab.ht_used;
4224 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004225 hashitem_T *hi;
4226 ufunc_T *ufunc;
4227
4228 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4229 {
4230 if (!HASHITEM_EMPTY(hi))
4231 {
4232 --todo;
4233 ufunc = HI2UF(hi);
4234 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004235 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4236 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004237 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004238 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004239
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004240 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004241 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004242 // a function has been added or removed, need to start over
4243 todo = (long)func_hashtab.ht_used;
4244 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004245 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004246 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004247 }
4248 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004249 }
4250 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004251}
4252
4253/*
4254 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4255 * Return 2 if "p" starts with "s:".
4256 * Return 0 otherwise.
4257 */
4258 int
4259eval_fname_script(char_u *p)
4260{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004261 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4262 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004263 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4264 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4265 return 5;
4266 if (p[0] == 's' && p[1] == ':')
4267 return 2;
4268 return 0;
4269}
4270
4271 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004272translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273{
4274 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004275 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004276 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004277}
4278
4279/*
4280 * Return TRUE when "ufunc" has old-style "..." varargs
4281 * or named varargs "...name: type".
4282 */
4283 int
4284has_varargs(ufunc_T *ufunc)
4285{
4286 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004287}
4288
4289/*
4290 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004291 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 */
4293 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004294function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004295{
4296 char_u *nm = name;
4297 char_u *p;
4298 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004299 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004300 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004302 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4303 if (no_deref)
4304 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004305 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 nm = skipwhite(nm);
4307
Bram Moolenaare38eab22019-12-05 21:50:01 +01004308 // Only accept "funcname", "funcname ", "funcname (..." and
4309 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004311 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312 vim_free(p);
4313 return n;
4314}
4315
Bram Moolenaar113e1072019-01-20 15:30:40 +01004316#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 char_u *
4318get_expanded_name(char_u *name, int check)
4319{
4320 char_u *nm = name;
4321 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004322 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004324 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004325 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004326
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004327 if (p != NULL && *nm == NUL
4328 && (!check || translated_function_exists(p, is_global)))
4329 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004330
4331 vim_free(p);
4332 return NULL;
4333}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004334#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004335
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004336/*
4337 * Function given to ExpandGeneric() to obtain the list of user defined
4338 * function names.
4339 */
4340 char_u *
4341get_user_func_name(expand_T *xp, int idx)
4342{
4343 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004344 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004345 static hashitem_T *hi;
4346 ufunc_T *fp;
4347
4348 if (idx == 0)
4349 {
4350 done = 0;
4351 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004352 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004354 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 {
4356 if (done++ > 0)
4357 ++hi;
4358 while (HASHITEM_EMPTY(hi))
4359 ++hi;
4360 fp = HI2UF(hi);
4361
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004362 // don't show dead, dict and lambda functions
4363 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004364 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004365 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366
4367 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004368 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004369
4370 cat_func_name(IObuff, fp);
4371 if (xp->xp_context != EXPAND_USER_FUNC)
4372 {
4373 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004374 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375 STRCAT(IObuff, ")");
4376 }
4377 return IObuff;
4378 }
4379 return NULL;
4380}
4381
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004382/*
4383 * ":delfunction {name}"
4384 */
4385 void
4386ex_delfunction(exarg_T *eap)
4387{
4388 ufunc_T *fp = NULL;
4389 char_u *p;
4390 char_u *name;
4391 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004392 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393
4394 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004395 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4396 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004397 vim_free(fudi.fd_newkey);
4398 if (name == NULL)
4399 {
4400 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004401 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 return;
4403 }
4404 if (!ends_excmd(*skipwhite(p)))
4405 {
4406 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004407 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004408 return;
4409 }
4410 eap->nextcmd = check_nextcmd(p);
4411 if (eap->nextcmd != NULL)
4412 *p = NUL;
4413
4414 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004415 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 vim_free(name);
4417
4418 if (!eap->skip)
4419 {
4420 if (fp == NULL)
4421 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004422 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004423 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 return;
4425 }
4426 if (fp->uf_calls > 0)
4427 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004428 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004429 return;
4430 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004431 if (fp->uf_flags & FC_VIM9)
4432 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004433 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004434 return;
4435 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436
4437 if (fudi.fd_dict != NULL)
4438 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004439 // Delete the dict item that refers to the function, it will
4440 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004441 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4442 }
4443 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004444 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 // A normal function (not a numbered function or lambda) has a
4446 // refcount of 1 for the entry in the hashtable. When deleting
4447 // it and the refcount is more than one, it should be kept.
4448 // A numbered function and lambda should be kept if the refcount is
4449 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004450 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004451 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004452 // Function is still referenced somewhere. Don't free it but
4453 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004454 if (func_remove(fp))
4455 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004456 }
4457 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004458 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004459 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004460 }
4461}
4462
4463/*
4464 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004465 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 */
4467 void
4468func_unref(char_u *name)
4469{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004470 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004471
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004472 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004474 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004475 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004477#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004478 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004479#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004480 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004481 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004482 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004483}
4484
4485/*
4486 * Unreference a Function: decrement the reference count and free it when it
4487 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004488 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004489 */
4490 void
4491func_ptr_unref(ufunc_T *fp)
4492{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004493 if (fp != NULL && (--fp->uf_refcount <= 0
4494 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4495 && fp->uf_partial->pt_refcount <= 1
4496 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004497 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004498 // Only delete it when it's not being used. Otherwise it's done
4499 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004500 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004501 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004502 }
4503}
4504
4505/*
4506 * Count a reference to a Function.
4507 */
4508 void
4509func_ref(char_u *name)
4510{
4511 ufunc_T *fp;
4512
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004513 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004515 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004516 if (fp != NULL)
4517 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004518 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004519 // Only give an error for a numbered function.
4520 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004521 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004522}
4523
4524/*
4525 * Count a reference to a Function.
4526 */
4527 void
4528func_ptr_ref(ufunc_T *fp)
4529{
4530 if (fp != NULL)
4531 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532}
4533
4534/*
4535 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4536 * referenced from anywhere that is in use.
4537 */
4538 static int
4539can_free_funccal(funccall_T *fc, int copyID)
4540{
4541 return (fc->l_varlist.lv_copyID != copyID
4542 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004543 && fc->l_avars.dv_copyID != copyID
4544 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545}
4546
4547/*
4548 * ":return [expr]"
4549 */
4550 void
4551ex_return(exarg_T *eap)
4552{
4553 char_u *arg = eap->arg;
4554 typval_T rettv;
4555 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004556 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557
4558 if (current_funccal == NULL)
4559 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004560 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004561 return;
4562 }
4563
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004564 CLEAR_FIELD(evalarg);
4565 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4566
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004567 if (eap->skip)
4568 ++emsg_skip;
4569
4570 eap->nextcmd = NULL;
4571 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004572 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 {
4574 if (!eap->skip)
4575 returning = do_return(eap, FALSE, TRUE, &rettv);
4576 else
4577 clear_tv(&rettv);
4578 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004579 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580 else if (!eap->skip)
4581 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004582 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004583 update_force_abort();
4584
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004585 /*
4586 * Return unless the expression evaluation has been cancelled due to an
4587 * aborting error, an interrupt, or an exception.
4588 */
4589 if (!aborting())
4590 returning = do_return(eap, FALSE, TRUE, NULL);
4591 }
4592
Bram Moolenaare38eab22019-12-05 21:50:01 +01004593 // When skipping or the return gets pending, advance to the next command
4594 // in this line (!returning). Otherwise, ignore the rest of the line.
4595 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 if (returning)
4597 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004598 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 eap->nextcmd = check_nextcmd(arg);
4600
4601 if (eap->skip)
4602 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004603 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004604}
4605
4606/*
4607 * ":1,25call func(arg1, arg2)" function call.
4608 */
4609 void
4610ex_call(exarg_T *eap)
4611{
4612 char_u *arg = eap->arg;
4613 char_u *startarg;
4614 char_u *name;
4615 char_u *tofree;
4616 int len;
4617 typval_T rettv;
4618 linenr_T lnum;
4619 int doesrange;
4620 int failed = FALSE;
4621 funcdict_T fudi;
4622 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004623 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004624 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004625
Bram Moolenaare6b53242020-07-01 17:28:33 +02004626 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004627 if (eap->skip)
4628 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004629 // trans_function_name() doesn't work well when skipping, use eval0()
4630 // instead to skip to any following command, e.g. for:
4631 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004632 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004633 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 clear_tv(&rettv);
4635 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004636 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637 return;
4638 }
4639
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004640 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4641 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 if (fudi.fd_newkey != NULL)
4643 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004644 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004645 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004646 vim_free(fudi.fd_newkey);
4647 }
4648 if (tofree == NULL)
4649 return;
4650
Bram Moolenaare38eab22019-12-05 21:50:01 +01004651 // Increase refcount on dictionary, it could get deleted when evaluating
4652 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004653 if (fudi.fd_dict != NULL)
4654 ++fudi.fd_dict->dv_refcount;
4655
Bram Moolenaare38eab22019-12-05 21:50:01 +01004656 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4657 // contents. For VAR_PARTIAL get its partial, unless we already have one
4658 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004660 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4661 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662
Bram Moolenaare38eab22019-12-05 21:50:01 +01004663 // Skip white space to allow ":call func ()". Not good, but required for
4664 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004666 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004667
4668 if (*startarg != '(')
4669 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004670 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004671 goto end;
4672 }
4673
4674 /*
4675 * When skipping, evaluate the function once, to find the end of the
4676 * arguments.
4677 * When the function takes a range, this is discovered after the first
4678 * call, and the loop is broken.
4679 */
4680 if (eap->skip)
4681 {
4682 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004683 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 }
4685 else
4686 lnum = eap->line1;
4687 for ( ; lnum <= eap->line2; ++lnum)
4688 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004689 funcexe_T funcexe;
4690
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004691 if (!eap->skip && eap->addr_count > 0)
4692 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004693 if (lnum > curbuf->b_ml.ml_line_count)
4694 {
4695 // If the function deleted lines or switched to another buffer
4696 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004697 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004698 break;
4699 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004700 curwin->w_cursor.lnum = lnum;
4701 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004703 }
4704 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004705
Bram Moolenaara80faa82020-04-12 19:37:17 +02004706 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004707 funcexe.firstline = eap->line1;
4708 funcexe.lastline = eap->line2;
4709 funcexe.doesrange = &doesrange;
4710 funcexe.evaluate = !eap->skip;
4711 funcexe.partial = partial;
4712 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004713 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004714 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 {
4716 failed = TRUE;
4717 break;
4718 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004719 if (has_watchexpr())
4720 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004721
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004722 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004723 if (handle_subscript(&arg, &rettv,
4724 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004725 {
4726 failed = TRUE;
4727 break;
4728 }
4729
4730 clear_tv(&rettv);
4731 if (doesrange || eap->skip)
4732 break;
4733
Bram Moolenaare38eab22019-12-05 21:50:01 +01004734 // Stop when immediately aborting on error, or when an interrupt
4735 // occurred or an exception was thrown but not caught.
4736 // get_func_tv() returned OK, so that the check for trailing
4737 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 if (aborting())
4739 break;
4740 }
4741 if (eap->skip)
4742 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004743 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744
Bram Moolenaare51bb172020-02-16 19:42:23 +01004745 // When inside :try we need to check for following "| catch".
4746 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004748 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004749 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004750 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004752 if (!failed)
4753 {
4754 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004755 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004756 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004757 }
4758 else
4759 eap->nextcmd = check_nextcmd(arg);
4760 }
4761
4762end:
4763 dict_unref(fudi.fd_dict);
4764 vim_free(tofree);
4765}
4766
4767/*
4768 * Return from a function. Possibly makes the return pending. Also called
4769 * for a pending return at the ":endtry" or after returning from an extra
4770 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4771 * when called due to a ":return" command. "rettv" may point to a typval_T
4772 * with the return rettv. Returns TRUE when the return can be carried out,
4773 * FALSE when the return gets pending.
4774 */
4775 int
4776do_return(
4777 exarg_T *eap,
4778 int reanimate,
4779 int is_cmd,
4780 void *rettv)
4781{
4782 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004783 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784
4785 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004786 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004787 current_funccal->returned = FALSE;
4788
4789 /*
4790 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4791 * not in its finally clause (which then is to be executed next) is found.
4792 * In this case, make the ":return" pending for execution at the ":endtry".
4793 * Otherwise, return normally.
4794 */
4795 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4796 if (idx >= 0)
4797 {
4798 cstack->cs_pending[idx] = CSTP_RETURN;
4799
4800 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004801 // A pending return again gets pending. "rettv" points to an
4802 // allocated variable with the rettv of the original ":return"'s
4803 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004804 cstack->cs_rettv[idx] = rettv;
4805 else
4806 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004807 // When undoing a return in order to make it pending, get the stored
4808 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004809 if (reanimate)
4810 rettv = current_funccal->rettv;
4811
4812 if (rettv != NULL)
4813 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004814 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004815 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4816 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4817 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004818 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 }
4820 else
4821 cstack->cs_rettv[idx] = NULL;
4822
4823 if (reanimate)
4824 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004825 // The pending return value could be overwritten by a ":return"
4826 // without argument in a finally clause; reset the default
4827 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828 current_funccal->rettv->v_type = VAR_NUMBER;
4829 current_funccal->rettv->vval.v_number = 0;
4830 }
4831 }
4832 report_make_pending(CSTP_RETURN, rettv);
4833 }
4834 else
4835 {
4836 current_funccal->returned = TRUE;
4837
Bram Moolenaare38eab22019-12-05 21:50:01 +01004838 // If the return is carried out now, store the return value. For
4839 // a return immediately after reanimation, the value is already
4840 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841 if (!reanimate && rettv != NULL)
4842 {
4843 clear_tv(current_funccal->rettv);
4844 *current_funccal->rettv = *(typval_T *)rettv;
4845 if (!is_cmd)
4846 vim_free(rettv);
4847 }
4848 }
4849
4850 return idx < 0;
4851}
4852
4853/*
4854 * Free the variable with a pending return value.
4855 */
4856 void
4857discard_pending_return(void *rettv)
4858{
4859 free_tv((typval_T *)rettv);
4860}
4861
4862/*
4863 * Generate a return command for producing the value of "rettv". The result
4864 * is an allocated string. Used by report_pending() for verbose messages.
4865 */
4866 char_u *
4867get_return_cmd(void *rettv)
4868{
4869 char_u *s = NULL;
4870 char_u *tofree = NULL;
4871 char_u numbuf[NUMBUFLEN];
4872
4873 if (rettv != NULL)
4874 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4875 if (s == NULL)
4876 s = (char_u *)"";
4877
4878 STRCPY(IObuff, ":return ");
4879 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4880 if (STRLEN(s) + 8 >= IOSIZE)
4881 STRCPY(IObuff + IOSIZE - 4, "...");
4882 vim_free(tofree);
4883 return vim_strsave(IObuff);
4884}
4885
4886/*
4887 * Get next function line.
4888 * Called by do_cmdline() to get the next line.
4889 * Returns allocated string, or NULL for end of function.
4890 */
4891 char_u *
4892get_func_line(
4893 int c UNUSED,
4894 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004895 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004896 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004897{
4898 funccall_T *fcp = (funccall_T *)cookie;
4899 ufunc_T *fp = fcp->func;
4900 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004901 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902
Bram Moolenaare38eab22019-12-05 21:50:01 +01004903 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004904 if (fcp->dbg_tick != debug_tick)
4905 {
4906 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004907 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 fcp->dbg_tick = debug_tick;
4909 }
4910#ifdef FEAT_PROFILE
4911 if (do_profiling == PROF_YES)
4912 func_line_end(cookie);
4913#endif
4914
4915 gap = &fp->uf_lines;
4916 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4917 || fcp->returned)
4918 retval = NULL;
4919 else
4920 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004921 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004922 while (fcp->linenr < gap->ga_len
4923 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4924 ++fcp->linenr;
4925 if (fcp->linenr >= gap->ga_len)
4926 retval = NULL;
4927 else
4928 {
4929 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004930 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931#ifdef FEAT_PROFILE
4932 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004933 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004934#endif
4935 }
4936 }
4937
Bram Moolenaare38eab22019-12-05 21:50:01 +01004938 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004939 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004940 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004941 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004942 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004943 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004944 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004945 fcp->dbg_tick = debug_tick;
4946 }
4947
4948 return retval;
4949}
4950
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004951/*
4952 * Return TRUE if the currently active function should be ended, because a
4953 * return was encountered or an error occurred. Used inside a ":while".
4954 */
4955 int
4956func_has_ended(void *cookie)
4957{
4958 funccall_T *fcp = (funccall_T *)cookie;
4959
Bram Moolenaare38eab22019-12-05 21:50:01 +01004960 // Ignore the "abort" flag if the abortion behavior has been changed due to
4961 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004962 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4963 || fcp->returned);
4964}
4965
4966/*
4967 * return TRUE if cookie indicates a function which "abort"s on errors.
4968 */
4969 int
4970func_has_abort(
4971 void *cookie)
4972{
4973 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4974}
4975
4976
4977/*
4978 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4979 * Don't do this when "Func" is already a partial that was bound
4980 * explicitly (pt_auto is FALSE).
4981 * Changes "rettv" in-place.
4982 * Returns the updated "selfdict_in".
4983 */
4984 dict_T *
4985make_partial(dict_T *selfdict_in, typval_T *rettv)
4986{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004987 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004988 char_u *tofree = NULL;
4989 ufunc_T *fp;
4990 char_u fname_buf[FLEN_FIXED + 1];
4991 int error;
4992 dict_T *selfdict = selfdict_in;
4993
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004994 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4995 fp = rettv->vval.v_partial->pt_func;
4996 else
4997 {
4998 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4999 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005000 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005001 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005002 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005003 vim_free(tofree);
5004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005005
5006 if (fp != NULL && (fp->uf_flags & FC_DICT))
5007 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005008 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005009
5010 if (pt != NULL)
5011 {
5012 pt->pt_refcount = 1;
5013 pt->pt_dict = selfdict;
5014 pt->pt_auto = TRUE;
5015 selfdict = NULL;
5016 if (rettv->v_type == VAR_FUNC)
5017 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005018 // Just a function: Take over the function name and use
5019 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020 pt->pt_name = rettv->vval.v_string;
5021 }
5022 else
5023 {
5024 partial_T *ret_pt = rettv->vval.v_partial;
5025 int i;
5026
Bram Moolenaare38eab22019-12-05 21:50:01 +01005027 // Partial: copy the function name, use selfdict and copy
5028 // args. Can't take over name or args, the partial might
5029 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005030 if (ret_pt->pt_name != NULL)
5031 {
5032 pt->pt_name = vim_strsave(ret_pt->pt_name);
5033 func_ref(pt->pt_name);
5034 }
5035 else
5036 {
5037 pt->pt_func = ret_pt->pt_func;
5038 func_ptr_ref(pt->pt_func);
5039 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005040 if (ret_pt->pt_argc > 0)
5041 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005042 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005043 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005044 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005045 pt->pt_argc = 0;
5046 else
5047 {
5048 pt->pt_argc = ret_pt->pt_argc;
5049 for (i = 0; i < pt->pt_argc; i++)
5050 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5051 }
5052 }
5053 partial_unref(ret_pt);
5054 }
5055 rettv->v_type = VAR_PARTIAL;
5056 rettv->vval.v_partial = pt;
5057 }
5058 }
5059 return selfdict;
5060}
5061
5062/*
5063 * Return the name of the executed function.
5064 */
5065 char_u *
5066func_name(void *cookie)
5067{
5068 return ((funccall_T *)cookie)->func->uf_name;
5069}
5070
5071/*
5072 * Return the address holding the next breakpoint line for a funccall cookie.
5073 */
5074 linenr_T *
5075func_breakpoint(void *cookie)
5076{
5077 return &((funccall_T *)cookie)->breakpoint;
5078}
5079
5080/*
5081 * Return the address holding the debug tick for a funccall cookie.
5082 */
5083 int *
5084func_dbg_tick(void *cookie)
5085{
5086 return &((funccall_T *)cookie)->dbg_tick;
5087}
5088
5089/*
5090 * Return the nesting level for a funccall cookie.
5091 */
5092 int
5093func_level(void *cookie)
5094{
5095 return ((funccall_T *)cookie)->level;
5096}
5097
5098/*
5099 * Return TRUE when a function was ended by a ":return" command.
5100 */
5101 int
5102current_func_returned(void)
5103{
5104 return current_funccal->returned;
5105}
5106
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005107 int
5108free_unref_funccal(int copyID, int testing)
5109{
5110 int did_free = FALSE;
5111 int did_free_funccal = FALSE;
5112 funccall_T *fc, **pfc;
5113
5114 for (pfc = &previous_funccal; *pfc != NULL; )
5115 {
5116 if (can_free_funccal(*pfc, copyID))
5117 {
5118 fc = *pfc;
5119 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005120 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005121 did_free = TRUE;
5122 did_free_funccal = TRUE;
5123 }
5124 else
5125 pfc = &(*pfc)->caller;
5126 }
5127 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005128 // When a funccal was freed some more items might be garbage
5129 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 (void)garbage_collect(testing);
5131
5132 return did_free;
5133}
5134
5135/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005136 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005137 */
5138 static funccall_T *
5139get_funccal(void)
5140{
5141 int i;
5142 funccall_T *funccal;
5143 funccall_T *temp_funccal;
5144
5145 funccal = current_funccal;
5146 if (debug_backtrace_level > 0)
5147 {
5148 for (i = 0; i < debug_backtrace_level; i++)
5149 {
5150 temp_funccal = funccal->caller;
5151 if (temp_funccal)
5152 funccal = temp_funccal;
5153 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005154 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155 debug_backtrace_level = i;
5156 }
5157 }
5158 return funccal;
5159}
5160
5161/*
5162 * Return the hashtable used for local variables in the current funccal.
5163 * Return NULL if there is no current funccal.
5164 */
5165 hashtab_T *
5166get_funccal_local_ht()
5167{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005168 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169 return NULL;
5170 return &get_funccal()->l_vars.dv_hashtab;
5171}
5172
5173/*
5174 * Return the l: scope variable.
5175 * Return NULL if there is no current funccal.
5176 */
5177 dictitem_T *
5178get_funccal_local_var()
5179{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005180 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181 return NULL;
5182 return &get_funccal()->l_vars_var;
5183}
5184
5185/*
5186 * Return the hashtable used for argument in the current funccal.
5187 * Return NULL if there is no current funccal.
5188 */
5189 hashtab_T *
5190get_funccal_args_ht()
5191{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005192 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005193 return NULL;
5194 return &get_funccal()->l_avars.dv_hashtab;
5195}
5196
5197/*
5198 * Return the a: scope variable.
5199 * Return NULL if there is no current funccal.
5200 */
5201 dictitem_T *
5202get_funccal_args_var()
5203{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005204 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005205 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005206 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207}
5208
5209/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005210 * List function variables, if there is a function.
5211 */
5212 void
5213list_func_vars(int *first)
5214{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005215 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005217 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218}
5219
5220/*
5221 * If "ht" is the hashtable for local variables in the current funccal, return
5222 * the dict that contains it.
5223 * Otherwise return NULL.
5224 */
5225 dict_T *
5226get_current_funccal_dict(hashtab_T *ht)
5227{
5228 if (current_funccal != NULL
5229 && ht == &current_funccal->l_vars.dv_hashtab)
5230 return &current_funccal->l_vars;
5231 return NULL;
5232}
5233
5234/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005235 * Search hashitem in parent scope.
5236 */
5237 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005238find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005239{
5240 funccall_T *old_current_funccal = current_funccal;
5241 hashtab_T *ht;
5242 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005243 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005244
5245 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5246 return NULL;
5247
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005248 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005249 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005250 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005251 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005252 ht = find_var_ht(name, &varname);
5253 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005254 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005255 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005256 if (!HASHITEM_EMPTY(hi))
5257 {
5258 *pht = ht;
5259 break;
5260 }
5261 }
5262 if (current_funccal == current_funccal->func->uf_scoped)
5263 break;
5264 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005265 }
5266 current_funccal = old_current_funccal;
5267
5268 return hi;
5269}
5270
5271/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005272 * Search variable in parent scope.
5273 */
5274 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005275find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005276{
5277 dictitem_T *v = NULL;
5278 funccall_T *old_current_funccal = current_funccal;
5279 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005280 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005281
5282 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5283 return NULL;
5284
Bram Moolenaare38eab22019-12-05 21:50:01 +01005285 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005286 current_funccal = current_funccal->func->uf_scoped;
5287 while (current_funccal)
5288 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005289 ht = find_var_ht(name, &varname);
5290 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005291 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005292 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005293 if (v != NULL)
5294 break;
5295 }
5296 if (current_funccal == current_funccal->func->uf_scoped)
5297 break;
5298 current_funccal = current_funccal->func->uf_scoped;
5299 }
5300 current_funccal = old_current_funccal;
5301
5302 return v;
5303}
5304
5305/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005306 * Set "copyID + 1" in previous_funccal and callers.
5307 */
5308 int
5309set_ref_in_previous_funccal(int copyID)
5310{
5311 int abort = FALSE;
5312 funccall_T *fc;
5313
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005314 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005315 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005316 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005317 abort = abort
5318 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5319 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005320 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321 }
5322 return abort;
5323}
5324
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005325 static int
5326set_ref_in_funccal(funccall_T *fc, int copyID)
5327{
5328 int abort = FALSE;
5329
5330 if (fc->fc_copyID != copyID)
5331 {
5332 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005333 abort = abort
5334 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5335 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005336 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005337 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005338 }
5339 return abort;
5340}
5341
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342/*
5343 * Set "copyID" in all local vars and arguments in the call stack.
5344 */
5345 int
5346set_ref_in_call_stack(int copyID)
5347{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005348 int abort = FALSE;
5349 funccall_T *fc;
5350 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005352 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005353 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005354
5355 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005356 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5357 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005358 abort = abort || set_ref_in_funccal(fc, copyID);
5359
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005360 return abort;
5361}
5362
5363/*
5364 * Set "copyID" in all functions available by name.
5365 */
5366 int
5367set_ref_in_functions(int copyID)
5368{
5369 int todo;
5370 hashitem_T *hi = NULL;
5371 int abort = FALSE;
5372 ufunc_T *fp;
5373
5374 todo = (int)func_hashtab.ht_used;
5375 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005377 if (!HASHITEM_EMPTY(hi))
5378 {
5379 --todo;
5380 fp = HI2UF(hi);
5381 if (!func_name_refcount(fp->uf_name))
5382 abort = abort || set_ref_in_func(NULL, fp, copyID);
5383 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005384 }
5385 return abort;
5386}
5387
5388/*
5389 * Set "copyID" in all function arguments.
5390 */
5391 int
5392set_ref_in_func_args(int copyID)
5393{
5394 int i;
5395 int abort = FALSE;
5396
5397 for (i = 0; i < funcargs.ga_len; ++i)
5398 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5399 copyID, NULL, NULL);
5400 return abort;
5401}
5402
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005403/*
5404 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005405 * Returns TRUE if setting references failed somehow.
5406 */
5407 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005408set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005409{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005410 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005411 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005412 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005413 char_u fname_buf[FLEN_FIXED + 1];
5414 char_u *tofree = NULL;
5415 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005416 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005417
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005418 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005419 return FALSE;
5420
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005421 if (fp_in == NULL)
5422 {
5423 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005424 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005425 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005426 if (fp != NULL)
5427 {
5428 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005429 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005430 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005431
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005432 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005433 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005434}
5435
Bram Moolenaare38eab22019-12-05 21:50:01 +01005436#endif // FEAT_EVAL