blob: c9c7bc791165e691901ad1b25c02c5936db7ec2a [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
32static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33static char *e_funcdict = N_("E717: Dictionary entry already exists");
34static char *e_funcref = N_("E718: Funcref required");
35static char *e_nofunc = N_("E130: Unknown function: %s");
36
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020037static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020038
39 void
40func_init()
41{
42 hash_init(&func_hashtab);
43}
44
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020045/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020046 * Return the function hash table
47 */
48 hashtab_T *
49func_tbl_get(void)
50{
51 return &func_hashtab;
52}
53
54/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020055 * Get one function argument.
56 * If "argtypes" is not NULL also get the type: "arg: type".
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010057 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010058 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010069 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010070{
Bram Moolenaar6e949782020-04-13 17:21:00 +020071 char_u *p = arg;
72 char_u *arg_copy = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010073
74 while (ASCII_ISALNUM(*p) || *p == '_')
75 ++p;
76 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020077 || (argtypes == NULL
78 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
79 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010080 {
81 if (!skip)
82 semsg(_("E125: Illegal argument: %s"), arg);
83 return arg;
84 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010085
Bram Moolenaar057e84a2021-02-28 16:55:11 +010086 // Vim9 script: cannot use script var name for argument. In function: also
87 // check local vars and arguments.
88 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
89 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010090 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010091
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010092 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
93 return arg;
94 if (newargs != NULL)
95 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 int c;
97 int i;
98
99 c = *p;
100 *p = NUL;
101 arg_copy = vim_strsave(arg);
102 if (arg_copy == NULL)
103 {
104 *p = c;
105 return arg;
106 }
107
108 // Check for duplicate argument name.
109 for (i = 0; i < newargs->ga_len; ++i)
110 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
111 {
112 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
113 vim_free(arg_copy);
114 return arg;
115 }
116 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
117 newargs->ga_len++;
118
119 *p = c;
120 }
121
122 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100123 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100124 {
125 char_u *type = NULL;
126
Bram Moolenaar6e949782020-04-13 17:21:00 +0200127 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
128 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200129 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200130 arg_copy == NULL ? arg : arg_copy);
131 p = skipwhite(p);
132 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100133 if (*p == ':')
134 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200135 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100136 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200137 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100138 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200139 return arg;
140 }
141 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200142 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100143 if (!skip)
144 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100146 else if (*skipwhite(p) != '=' && !types_optional)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200147 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200148 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200149 arg_copy == NULL ? arg : arg_copy);
150 return arg;
151 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100152 if (!skip)
153 {
154 if (type == NULL && types_optional)
155 // lambda arguments default to "any" type
156 type = vim_strsave((char_u *)"any");
157 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
158 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100159 }
160
161 return p;
162}
163
164/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200165 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100166 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100167 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200168 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100169 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200170get_function_args(
171 char_u **argp,
172 char_u endchar,
173 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100174 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100175 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100176 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200177 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200178 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200179 int skip,
180 exarg_T *eap,
181 char_u **line_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200182{
183 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100184 char_u *arg;
185 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200186 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200187 int any_default = FALSE;
188 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100189 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200190
191 if (newargs != NULL)
192 ga_init2(newargs, (int)sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100193 if (argtypes != NULL)
194 ga_init2(argtypes, (int)sizeof(char_u *), 3);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200195 if (default_args != NULL)
196 ga_init2(default_args, (int)sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200197
198 if (varargs != NULL)
199 *varargs = FALSE;
200
201 /*
202 * Isolate the arguments: "arg1, arg2, ...)"
203 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100204 arg = skipwhite(*argp);
205 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206 while (*p != endchar)
207 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200208 while (eap != NULL && eap->getline != NULL
209 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200210 {
211 char_u *theline;
212
213 // End of the line, get the next one.
214 theline = eap->getline(':', eap->cookie, 0, TRUE);
215 if (theline == NULL)
216 break;
217 vim_free(*line_to_free);
218 *line_to_free = theline;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200219 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200220 p = skipwhite(theline);
221 }
222
223 if (mustend && *p != endchar)
224 {
225 if (!skip)
226 semsg(_(e_invarg2), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100227 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200228 }
229 if (*p == endchar)
230 break;
231
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200232 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
233 {
234 if (varargs != NULL)
235 *varargs = TRUE;
236 p += 3;
237 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100238
239 if (argtypes != NULL)
240 {
241 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200242 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100243 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100244 if (!skip)
245 emsg(_(e_missing_name_after_dots));
246 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100247 }
248
249 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100250 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100251 evalarg, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100252 if (p == arg)
253 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100254 if (*skipwhite(p) == '=')
255 {
256 emsg(_(e_cannot_use_default_for_variable_arguments));
257 break;
258 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100259 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200260 }
261 else
262 {
263 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100264 p = one_function_arg(p, newargs, argtypes, types_optional,
265 evalarg, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100266 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200267 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200268
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200269 if (*skipwhite(p) == '=' && default_args != NULL)
270 {
271 typval_T rettv;
272
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100273 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200274 any_default = TRUE;
275 p = skipwhite(p) + 1;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200276 whitep = p;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200277 p = skipwhite(p);
278 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200279 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200280 {
281 if (ga_grow(default_args, 1) == FAIL)
282 goto err_ret;
283
284 // trim trailing whitespace
285 while (p > expr && VIM_ISWHITE(p[-1]))
286 p--;
287 c = *p;
288 *p = NUL;
289 expr = vim_strsave(expr);
290 if (expr == NULL)
291 {
292 *p = c;
293 goto err_ret;
294 }
295 ((char_u **)(default_args->ga_data))
296 [default_args->ga_len] = expr;
297 default_args->ga_len++;
298 *p = c;
299 }
300 else
301 mustend = TRUE;
302 }
303 else if (any_default)
304 {
305 emsg(_("E989: Non-default argument follows default argument"));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200306 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200307 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200308 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200309 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200310 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200311 // Don't give this error when skipping, it makes the "->" not
312 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100313 // Allow missing space after comma in legacy functions.
314 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200315 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
316 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100317 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200318 goto err_ret;
319 }
320 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200321 else
322 mustend = TRUE;
323 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200324 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200325 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200326 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200327
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200328 if (*p != endchar)
329 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100330 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200331
332 *argp = p;
333 return OK;
334
335err_ret:
336 if (newargs != NULL)
337 ga_clear_strings(newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200338 if (default_args != NULL)
339 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200340 return FAIL;
341}
342
343/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100344 * Parse the argument types, filling "fp->uf_arg_types".
345 * Return OK or FAIL.
346 */
347 static int
348parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
349{
350 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
351 if (argtypes->ga_len > 0)
352 {
353 // When "varargs" is set the last name/type goes into uf_va_name
354 // and uf_va_type.
355 int len = argtypes->ga_len - (varargs ? 1 : 0);
356
357 if (len > 0)
358 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
359 if (fp->uf_arg_types != NULL)
360 {
361 int i;
362 type_T *type;
363
364 for (i = 0; i < len; ++ i)
365 {
366 char_u *p = ((char_u **)argtypes->ga_data)[i];
367
368 if (p == NULL)
369 // will get the type from the default value
370 type = &t_unknown;
371 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100372 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100373 if (type == NULL)
374 return FAIL;
375 fp->uf_arg_types[i] = type;
376 }
377 }
378 if (varargs)
379 {
380 char_u *p;
381
382 // Move the last argument "...name: type" to uf_va_name and
383 // uf_va_type.
384 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
385 [fp->uf_args.ga_len - 1];
386 --fp->uf_args.ga_len;
387 p = ((char_u **)argtypes->ga_data)[len];
388 if (p == NULL)
389 // todo: get type from default value
390 fp->uf_va_type = &t_any;
391 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100392 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100393 if (fp->uf_va_type == NULL)
394 return FAIL;
395 }
396 }
397 return OK;
398}
399
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100400 static int
401parse_return_type(ufunc_T *fp, char_u *ret_type)
402{
403 if (ret_type == NULL)
404 fp->uf_ret_type = &t_void;
405 else
406 {
407 char_u *p = ret_type;
408
409 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
410 if (fp->uf_ret_type == NULL)
411 {
412 fp->uf_ret_type = &t_void;
413 return FAIL;
414 }
415 }
416 return OK;
417}
418
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100419/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200420 * Register function "fp" as using "current_funccal" as its scope.
421 */
422 static int
423register_closure(ufunc_T *fp)
424{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200425 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100426 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200427 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200428 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200429 fp->uf_scoped = current_funccal;
430 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200431
Bram Moolenaar58016442016-07-31 18:30:22 +0200432 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
433 return FAIL;
434 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
435 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200436 return OK;
437}
438
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100439 static void
440set_ufunc_name(ufunc_T *fp, char_u *name)
441{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100442 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
443 // actually extends beyond the struct.
444 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100445
446 if (name[0] == K_SPECIAL)
447 {
448 fp->uf_name_exp = alloc(STRLEN(name) + 3);
449 if (fp->uf_name_exp != NULL)
450 {
451 STRCPY(fp->uf_name_exp, "<SNR>");
452 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
453 }
454 }
455}
456
Bram Moolenaar58016442016-07-31 18:30:22 +0200457/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200458 * Get a name for a lambda. Returned in static memory.
459 */
460 char_u *
461get_lambda_name(void)
462{
463 static char_u name[30];
464 static int lambda_no = 0;
465
466 sprintf((char*)name, "<lambda>%d", ++lambda_no);
467 return name;
468}
469
Bram Moolenaar801ab062020-06-25 19:27:56 +0200470#if defined(FEAT_LUA) || defined(PROTO)
471/*
472 * Registers a native C callback which can be called from Vim script.
473 * Returns the name of the Vim script function.
474 */
475 char_u *
476register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
477{
478 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200479 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200480
481 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
482 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200483 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200484
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200485 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200486 fp->uf_refcount = 1;
487 fp->uf_varargs = TRUE;
488 fp->uf_flags = FC_CFUNC;
489 fp->uf_calls = 0;
490 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200491 fp->uf_cb = cb;
492 fp->uf_cb_free = cb_free;
493 fp->uf_cb_state = state;
494
495 set_ufunc_name(fp, name);
496 hash_add(&func_hashtab, UF2HIKEY(fp));
497
498 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200499}
500#endif
501
Bram Moolenaar04b12692020-05-04 23:24:44 +0200502/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100503 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100504 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100505 * If "white_error" is not NULL check for correct use of white space and set
506 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100507 * Return NULL if no valid arrow found.
508 */
509 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100510skip_arrow(
511 char_u *start,
512 int equal_arrow,
513 char_u **ret_type,
514 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100515{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100516 char_u *s = start;
517 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100518
519 if (equal_arrow)
520 {
521 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100522 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100523 if (white_error != NULL && !VIM_ISWHITE(s[1]))
524 {
525 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100526 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100527 return NULL;
528 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100529 s = skipwhite(s + 1);
530 *ret_type = s;
531 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100532 if (s == *ret_type)
533 {
534 emsg(_(e_missing_return_type));
535 return NULL;
536 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100537 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100538 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100539 s = skipwhite(s);
540 if (*s != '=')
541 return NULL;
542 ++s;
543 }
544 if (*s != '>')
545 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100546 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
547 || !IS_WHITE_OR_NUL(s[1])))
548 {
549 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100550 semsg(_(e_white_space_required_before_and_after_str_at_str),
551 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100552 return NULL;
553 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100554 return skipwhite(s + 1);
555}
556
557/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100558 * Check if "*cmd" points to a function command and if so advance "*cmd" and
559 * return TRUE.
560 * Otherwise return FALSE;
561 * Do not consider "function(" to be a command.
562 */
563 static int
564is_function_cmd(char_u **cmd)
565{
566 char_u *p = *cmd;
567
568 if (checkforcmd(&p, "function", 2))
569 {
570 if (*p == '(')
571 return FALSE;
572 *cmd = p;
573 return TRUE;
574 }
575 return FALSE;
576}
577
578/*
579 * Read the body of a function, put every line in "newlines".
580 * "newlines" must already have been initialized.
581 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
582 */
583 static int
584get_function_body(
585 exarg_T *eap,
586 garray_T *newlines,
587 char_u *line_arg_in,
588 char_u **line_to_free)
589{
590 linenr_T sourcing_lnum_top = SOURCING_LNUM;
591 linenr_T sourcing_lnum_off;
592 int saved_wait_return = need_wait_return;
593 char_u *line_arg = line_arg_in;
594 int vim9_function = eap->cmdidx == CMD_def
595 || eap->cmdidx == CMD_block;
596#define MAX_FUNC_NESTING 50
597 char nesting_def[MAX_FUNC_NESTING];
598 int nesting = 0;
599 getline_opt_T getline_options;
600 int indent = 2;
601 char_u *skip_until = NULL;
602 int ret = FAIL;
603 int is_heredoc = FALSE;
604 char_u *heredoc_trimmed = NULL;
605
606 // Detect having skipped over comment lines to find the return
607 // type. Add NULL lines to keep the line count correct.
608 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
609 if (SOURCING_LNUM < sourcing_lnum_off)
610 {
611 sourcing_lnum_off -= SOURCING_LNUM;
612 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
613 goto theend;
614 while (sourcing_lnum_off-- > 0)
615 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
616 }
617
618 nesting_def[nesting] = vim9_function;
619 getline_options = vim9_function
620 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
621 for (;;)
622 {
623 char_u *theline;
624 char_u *p;
625 char_u *arg;
626
627 if (KeyTyped)
628 {
629 msg_scroll = TRUE;
630 saved_wait_return = FALSE;
631 }
632 need_wait_return = FALSE;
633
634 if (line_arg != NULL)
635 {
636 // Use eap->arg, split up in parts by line breaks.
637 theline = line_arg;
638 p = vim_strchr(theline, '\n');
639 if (p == NULL)
640 line_arg += STRLEN(line_arg);
641 else
642 {
643 *p = NUL;
644 line_arg = p + 1;
645 }
646 }
647 else
648 {
649 vim_free(*line_to_free);
650 if (eap->getline == NULL)
651 theline = getcmdline(':', 0L, indent, getline_options);
652 else
653 theline = eap->getline(':', eap->cookie, indent,
654 getline_options);
655 *line_to_free = theline;
656 }
657 if (KeyTyped)
658 lines_left = Rows - 1;
659 if (theline == NULL)
660 {
661 // Use the start of the function for the line number.
662 SOURCING_LNUM = sourcing_lnum_top;
663 if (skip_until != NULL)
664 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
665 else if (eap->cmdidx == CMD_def)
666 emsg(_(e_missing_enddef));
667 else if (eap->cmdidx == CMD_block)
668 emsg(_(e_missing_end_block));
669 else
670 emsg(_("E126: Missing :endfunction"));
671 goto theend;
672 }
673
674 // Detect line continuation: SOURCING_LNUM increased more than one.
675 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
676 if (SOURCING_LNUM < sourcing_lnum_off)
677 sourcing_lnum_off -= SOURCING_LNUM;
678 else
679 sourcing_lnum_off = 0;
680
681 if (skip_until != NULL)
682 {
683 // Don't check for ":endfunc"/":enddef" between
684 // * ":append" and "."
685 // * ":python <<EOF" and "EOF"
686 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
687 if (heredoc_trimmed == NULL
688 || (is_heredoc && skipwhite(theline) == theline)
689 || STRNCMP(theline, heredoc_trimmed,
690 STRLEN(heredoc_trimmed)) == 0)
691 {
692 if (heredoc_trimmed == NULL)
693 p = theline;
694 else if (is_heredoc)
695 p = skipwhite(theline) == theline
696 ? theline : theline + STRLEN(heredoc_trimmed);
697 else
698 p = theline + STRLEN(heredoc_trimmed);
699 if (STRCMP(p, skip_until) == 0)
700 {
701 VIM_CLEAR(skip_until);
702 VIM_CLEAR(heredoc_trimmed);
703 getline_options = vim9_function
704 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
705 is_heredoc = FALSE;
706 }
707 }
708 }
709 else
710 {
711 int c;
712
713 // skip ':' and blanks
714 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
715 ;
716
717 // Check for "endfunction", "enddef" or "}".
718 // When a ":" follows it must be a dict key; "enddef: value,"
719 if ((nesting == 0 && eap->cmdidx == CMD_block)
720 ? *p == '}'
721 : (checkforcmd(&p, nesting_def[nesting]
722 ? "enddef" : "endfunction", 4)
723 && *p != ':'))
724 {
725 if (nesting-- == 0)
726 {
727 char_u *nextcmd = NULL;
728
729 if (*p == '|' || *p == '}')
730 nextcmd = p + 1;
731 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
732 nextcmd = line_arg;
733 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
734 && p_verbose > 0
735 && eap->cmdidx != CMD_block)
736 give_warning2(eap->cmdidx == CMD_def
737 ? (char_u *)_("W1001: Text found after :enddef: %s")
738 : (char_u *)_("W22: Text found after :endfunction: %s"),
739 p, TRUE);
740 if (nextcmd != NULL)
741 {
742 // Another command follows. If the line came from "eap"
743 // we can simply point into it, otherwise we need to
744 // change "eap->cmdlinep".
745 eap->nextcmd = nextcmd;
746 if (*line_to_free != NULL)
747 {
748 vim_free(*eap->cmdlinep);
749 *eap->cmdlinep = *line_to_free;
750 *line_to_free = NULL;
751 }
752 }
753 break;
754 }
755 }
756
757 // Check for mismatched "endfunc" or "enddef".
758 // We don't check for "def" inside "func" thus we also can't check
759 // for "enddef".
760 // We continue to find the end of the function, although we might
761 // not find it.
762 else if (nesting_def[nesting])
763 {
764 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
765 emsg(_(e_mismatched_endfunction));
766 }
767 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
768 emsg(_(e_mismatched_enddef));
769
770 // Increase indent inside "if", "while", "for" and "try", decrease
771 // at "end".
772 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
773 indent -= 2;
774 else if (STRNCMP(p, "if", 2) == 0
775 || STRNCMP(p, "wh", 2) == 0
776 || STRNCMP(p, "for", 3) == 0
777 || STRNCMP(p, "try", 3) == 0)
778 indent += 2;
779
780 // Check for defining a function inside this function.
781 // Only recognize "def" inside "def", not inside "function",
782 // For backwards compatibility, see Test_function_python().
783 c = *p;
784 if (is_function_cmd(&p)
785 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
786 {
787 if (*p == '!')
788 p = skipwhite(p + 1);
789 p += eval_fname_script(p);
790 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
791 NULL, NULL));
792 if (*skipwhite(p) == '(')
793 {
794 if (nesting == MAX_FUNC_NESTING - 1)
795 emsg(_(e_function_nesting_too_deep));
796 else
797 {
798 ++nesting;
799 nesting_def[nesting] = (c == 'd');
800 indent += 2;
801 }
802 }
803 }
804
805 // Check for ":append", ":change", ":insert". Not for :def.
806 p = skip_range(p, FALSE, NULL);
807 if (!vim9_function
808 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
809 || (p[0] == 'c'
810 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
811 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
812 && (STRNCMP(&p[3], "nge", 3) != 0
813 || !ASCII_ISALPHA(p[6])))))))
814 || (p[0] == 'i'
815 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
816 && (!ASCII_ISALPHA(p[2])
817 || (p[2] == 's'
818 && (!ASCII_ISALPHA(p[3])
819 || p[3] == 'e'))))))))
820 skip_until = vim_strsave((char_u *)".");
821
822 // Check for ":python <<EOF", ":tcl <<EOF", etc.
823 arg = skipwhite(skiptowhite(p));
824 if (arg[0] == '<' && arg[1] =='<'
825 && ((p[0] == 'p' && p[1] == 'y'
826 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
827 || ((p[2] == '3' || p[2] == 'x')
828 && !ASCII_ISALPHA(p[3]))))
829 || (p[0] == 'p' && p[1] == 'e'
830 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
831 || (p[0] == 't' && p[1] == 'c'
832 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
833 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
834 && !ASCII_ISALPHA(p[3]))
835 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
836 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
837 || (p[0] == 'm' && p[1] == 'z'
838 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
839 ))
840 {
841 // ":python <<" continues until a dot, like ":append"
842 p = skipwhite(arg + 2);
843 if (STRNCMP(p, "trim", 4) == 0)
844 {
845 // Ignore leading white space.
846 p = skipwhite(p + 4);
847 heredoc_trimmed = vim_strnsave(theline,
848 skipwhite(theline) - theline);
849 }
850 if (*p == NUL)
851 skip_until = vim_strsave((char_u *)".");
852 else
853 skip_until = vim_strnsave(p, skiptowhite(p) - p);
854 getline_options = GETLINE_NONE;
855 is_heredoc = TRUE;
856 }
857
858 // Check for ":cmd v =<< [trim] EOF"
859 // and ":cmd [a, b] =<< [trim] EOF"
860 // and "lines =<< [trim] EOF" for Vim9
861 // Where "cmd" can be "let", "var", "final" or "const".
862 arg = skipwhite(skiptowhite(p));
863 if (*arg == '[')
864 arg = vim_strchr(arg, ']');
865 if (arg != NULL)
866 {
867 int found = (eap->cmdidx == CMD_def && arg[0] == '='
868 && arg[1] == '<' && arg[2] =='<');
869
870 if (!found)
871 // skip over the argument after "cmd"
872 arg = skipwhite(skiptowhite(arg));
873 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
874 && (checkforcmd(&p, "let", 2)
875 || checkforcmd(&p, "var", 3)
876 || checkforcmd(&p, "final", 5)
877 || checkforcmd(&p, "const", 5))))
878 {
879 p = skipwhite(arg + 3);
880 if (STRNCMP(p, "trim", 4) == 0)
881 {
882 // Ignore leading white space.
883 p = skipwhite(p + 4);
884 heredoc_trimmed = vim_strnsave(theline,
885 skipwhite(theline) - theline);
886 }
887 skip_until = vim_strnsave(p, skiptowhite(p) - p);
888 getline_options = GETLINE_NONE;
889 is_heredoc = TRUE;
890 }
891 }
892 }
893
894 // Add the line to the function.
895 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
896 goto theend;
897
898 // Copy the line to newly allocated memory. get_one_sourceline()
899 // allocates 250 bytes per line, this saves 80% on average. The cost
900 // is an extra alloc/free.
901 p = vim_strsave(theline);
902 if (p == NULL)
903 goto theend;
904 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
905
906 // Add NULL lines for continuation lines, so that the line count is
907 // equal to the index in the growarray.
908 while (sourcing_lnum_off-- > 0)
909 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
910
911 // Check for end of eap->arg.
912 if (line_arg != NULL && *line_arg == NUL)
913 line_arg = NULL;
914 }
915
916 // Don't define the function when skipping commands or when an error was
917 // detected.
918 if (!eap->skip && !did_emsg)
919 ret = OK;
920
921theend:
922 vim_free(skip_until);
923 vim_free(heredoc_trimmed);
924 need_wait_return |= saved_wait_return;
925 return ret;
926}
927
928/*
929 * Handle the body of a lambda. *arg points to the "{", process statements
930 * until the matching "}".
931 * When successful "rettv" is set to a funcref.
932 */
933 static int
934lambda_function_body(
935 char_u **arg,
936 typval_T *rettv,
937 evalarg_T *evalarg,
938 garray_T *newargs,
939 garray_T *argtypes,
940 int varargs,
941 garray_T *default_args,
942 char_u *ret_type)
943{
944 int evaluate = evalarg != NULL
945 && (evalarg->eval_flags & EVAL_EVALUATE);
946 ufunc_T *ufunc;
947 exarg_T eap;
948 garray_T newlines;
949 char_u *cmdline = NULL;
950 int ret = FAIL;
951 char_u *line_to_free = NULL;
952 partial_T *pt;
953 char_u *name;
954 int lnum_save = -1;
955 linenr_T sourcing_lnum_top = SOURCING_LNUM;
956
Bram Moolenaare98f60a2021-03-22 18:22:30 +0100957 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
958 {
959 semsg(_(e_trailing_arg), *arg + 1);
960 return FAIL;
961 }
962
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100963 CLEAR_FIELD(eap);
964 eap.cmdidx = CMD_block;
965 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100966 eap.cmdlinep = &cmdline;
967 eap.skip = !evaluate;
968 if (evalarg->eval_cctx != NULL)
969 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
970 else
971 {
972 eap.getline = evalarg->eval_getline;
973 eap.cookie = evalarg->eval_cookie;
974 }
975
976 ga_init2(&newlines, (int)sizeof(char_u *), 10);
977 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100978 {
979 vim_free(cmdline);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100980 goto erret;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100981 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100982 if (cmdline != NULL)
983 {
984 // Something comes after the "}".
985 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +0100986
987 // "arg" points into cmdline, need to keep the line and free it later.
988 vim_free(evalarg->eval_tofree_cmdline);
989 evalarg->eval_tofree_cmdline = cmdline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100990 }
991 else
992 *arg = (char_u *)"";
993
994 name = get_lambda_name();
995 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
996 if (ufunc == NULL)
997 goto erret;
998 set_ufunc_name(ufunc, name);
999 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
1000 {
1001 vim_free(ufunc);
1002 goto erret;
1003 }
1004 ufunc->uf_refcount = 1;
1005 ufunc->uf_args = *newargs;
1006 newargs->ga_data = NULL;
1007 ufunc->uf_def_args = *default_args;
1008 default_args->ga_data = NULL;
1009 ufunc->uf_func_type = &t_func_any;
1010
1011 // error messages are for the first function line
1012 lnum_save = SOURCING_LNUM;
1013 SOURCING_LNUM = sourcing_lnum_top;
1014
1015 // parse argument types
1016 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1017 {
1018 SOURCING_LNUM = lnum_save;
1019 goto erret;
1020 }
1021
1022 // parse the return type, if any
1023 if (parse_return_type(ufunc, ret_type) == FAIL)
1024 goto erret;
1025
1026 pt = ALLOC_CLEAR_ONE(partial_T);
1027 if (pt == NULL)
1028 goto erret;
1029 pt->pt_func = ufunc;
1030 pt->pt_refcount = 1;
1031
1032 ufunc->uf_lines = newlines;
1033 newlines.ga_data = NULL;
1034 if (sandbox)
1035 ufunc->uf_flags |= FC_SANDBOX;
1036 if (!ASCII_ISUPPER(*ufunc->uf_name))
1037 ufunc->uf_flags |= FC_VIM9;
1038 ufunc->uf_script_ctx = current_sctx;
1039 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1040 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1041 set_function_type(ufunc);
1042
1043 rettv->vval.v_partial = pt;
1044 rettv->v_type = VAR_PARTIAL;
1045 ret = OK;
1046
1047erret:
1048 if (lnum_save >= 0)
1049 SOURCING_LNUM = lnum_save;
1050 vim_free(line_to_free);
1051 ga_clear_strings(&newlines);
1052 ga_clear_strings(newargs);
1053 ga_clear_strings(default_args);
1054 return ret;
1055}
1056
1057/*
1058 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001059 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001060 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001061 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1062 */
1063 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001064get_lambda_tv(
1065 char_u **arg,
1066 typval_T *rettv,
1067 int types_optional,
1068 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001069{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001070 int evaluate = evalarg != NULL
1071 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001072 garray_T newargs;
1073 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001074 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001075 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001076 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001077 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001078 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001079 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001080 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001081 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001082 char_u *s;
1083 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001084 int *old_eval_lavars = eval_lavars_used;
1085 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001086 char_u *tofree1 = NULL;
1087 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001088 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001089 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001090 int called_emsg_start = called_emsg;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001091
1092 if (equal_arrow && !in_vim9script())
1093 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001094
1095 ga_init(&newargs);
1096 ga_init(&newlines);
1097
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001098 // First, check if this is really a lambda expression. "->" or "=>" must
1099 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001100 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001101 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001102 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001103 NULL, NULL, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001104 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001105 {
1106 if (types_optional)
1107 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001108 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001109 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001110
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001111 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001112 if (evaluate)
1113 pnewargs = &newargs;
1114 else
1115 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001116 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001117 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001118 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001119 &varargs, &default_args,
1120 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001121 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001122 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaare462f522020-12-27 14:43:30 +01001123 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001124 {
1125 if (types_optional)
1126 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001127 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001128 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001129 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001130 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001131
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001132 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1133 if (ret_type != NULL)
1134 {
1135 ret_type = vim_strsave(ret_type);
1136 tofree2 = ret_type;
1137 }
1138
Bram Moolenaare38eab22019-12-05 21:50:01 +01001139 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001140 if (evaluate)
1141 eval_lavars_used = &eval_lavars;
1142
Bram Moolenaar65c44152020-12-24 15:14:01 +01001143 *arg = skipwhite_and_linebreak(*arg, evalarg);
1144
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001145 // Recognize "{" as the start of a function body.
1146 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001147 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001148 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1149 types_optional ? &argtypes : NULL, varargs,
1150 &default_args, ret_type) == FAIL)
1151 goto errret;
1152 goto theend;
1153 }
1154 if (default_args.ga_len > 0)
1155 {
1156 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001157 goto errret;
1158 }
1159
Bram Moolenaare38eab22019-12-05 21:50:01 +01001160 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001161 start = *arg;
1162 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001163 if (ret == FAIL)
1164 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001165 if (evalarg != NULL)
1166 {
1167 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001168 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001169 evalarg->eval_tofree = NULL;
1170 }
1171
Bram Moolenaar65c44152020-12-24 15:14:01 +01001172 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001173 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001174 *arg = skipwhite_and_linebreak(*arg, evalarg);
1175 if (**arg != '}')
1176 {
1177 semsg(_("E451: Expected }: %s"), *arg);
1178 goto errret;
1179 }
1180 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001181 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001182
1183 if (evaluate)
1184 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001185 int len;
1186 int flags = 0;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001187 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001188 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001189
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001190 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001191 if (fp == NULL)
1192 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001193 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001194 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001195 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001196 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001197
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001198 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1199 if (ga_grow(&newlines, 1) == FAIL)
1200 goto errret;
1201
Bram Moolenaare38eab22019-12-05 21:50:01 +01001202 // Add "return " before the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001203 len = 7 + (int)(end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001204 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001205 if (p == NULL)
1206 goto errret;
1207 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1208 STRCPY(p, "return ");
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001209 vim_strncpy(p + 7, start, end - start);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001210 if (strstr((char *)p + 7, "a:") == NULL)
1211 // No a: variables are used for sure.
1212 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001213
1214 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001215 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001216 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001217 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001218 if (types_optional)
1219 {
1220 if (parse_argument_types(fp, &argtypes, FALSE) == FAIL)
1221 goto errret;
1222 if (ret_type != NULL)
1223 {
1224 fp->uf_ret_type = parse_type(&ret_type,
1225 &fp->uf_type_list, TRUE);
1226 if (fp->uf_ret_type == NULL)
1227 goto errret;
1228 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001229 else
Bram Moolenaar328eac22021-01-07 19:23:08 +01001230 fp->uf_ret_type = &t_any;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001231 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001232
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001233 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001234 if (current_funccal != NULL && eval_lavars)
1235 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001236 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001237 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001238 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001239 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001240
1241#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001242 if (prof_def_func())
1243 func_do_profile(fp);
1244#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001245 if (sandbox)
1246 flags |= FC_SANDBOX;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001247 // can be called with more args than uf_args.ga_len
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001248 fp->uf_varargs = TRUE;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001249 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001250 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001251 fp->uf_script_ctx = current_sctx;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001252 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001253
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001254 pt->pt_func = fp;
1255 pt->pt_refcount = 1;
1256 rettv->vval.v_partial = pt;
1257 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001258
1259 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001260 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001261
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001262theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001263 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001264 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001265 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001266 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001267 vim_free(tofree1);
1268 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001269 if (types_optional)
1270 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001271 return OK;
1272
1273errret:
1274 ga_clear_strings(&newargs);
1275 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001276 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001277 if (types_optional)
1278 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001279 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001280 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001281 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001282 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001283 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001284 vim_free(tofree1);
1285 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001286 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001287 return FAIL;
1288}
1289
1290/*
1291 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1292 * name it contains, otherwise return "name".
1293 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1294 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001295 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1296 * type of the variable.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001297 */
1298 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001299deref_func_name(
1300 char_u *name,
1301 int *lenp,
1302 partial_T **partialp,
1303 type_T **type,
1304 int no_autoload)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001305{
1306 dictitem_T *v;
1307 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001308 char_u *s = NULL;
1309 hashtab_T *ht;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001310
1311 if (partialp != NULL)
1312 *partialp = NULL;
1313
1314 cc = name[*lenp];
1315 name[*lenp] = NUL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001316 v = find_var(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001317 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001318 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001319 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001320 if (v->di_tv.v_type == VAR_FUNC)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001321 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001322 if (v->di_tv.vval.v_string == NULL)
1323 {
1324 *lenp = 0;
1325 return (char_u *)""; // just in case
1326 }
1327 s = v->di_tv.vval.v_string;
1328 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001329 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001330
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001331 if (v->di_tv.v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001332 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001333 partial_T *pt = v->di_tv.vval.v_partial;
1334
1335 if (pt == NULL)
1336 {
1337 *lenp = 0;
1338 return (char_u *)""; // just in case
1339 }
1340 if (partialp != NULL)
1341 *partialp = pt;
1342 s = partial_name(pt);
1343 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001344 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001345
1346 if (s != NULL)
1347 {
1348 if (type != NULL && ht == get_script_local_ht())
1349 {
1350 svar_T *sv = find_typval_in_script(&v->di_tv);
1351
1352 if (sv != NULL)
1353 *type = sv->sv_type;
1354 }
1355 return s;
1356 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001357 }
1358
1359 return name;
1360}
1361
1362/*
1363 * Give an error message with a function name. Handle <SNR> things.
1364 * "ermsg" is to be passed without translation, use N_() instead of _().
1365 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001366 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367emsg_funcname(char *ermsg, char_u *name)
1368{
1369 char_u *p;
1370
1371 if (*name == K_SPECIAL)
1372 p = concat_str((char_u *)"<SNR>", name + 3);
1373 else
1374 p = name;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001375 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001376 if (p != name)
1377 vim_free(p);
1378}
1379
1380/*
1381 * Allocate a variable for the result of a function.
1382 * Return OK or FAIL.
1383 */
1384 int
1385get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001386 char_u *name, // name of the function
1387 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001388 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001389 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001390 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001391 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001392{
1393 char_u *argp;
1394 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001395 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1396 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001397 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001398
1399 /*
1400 * Get the arguments.
1401 */
1402 argp = *arg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001403 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1404 : funcexe->partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001405 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001406 // skip the '(' or ',' and possibly line breaks
1407 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1408
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001409 if (*argp == ')' || *argp == ',' || *argp == NUL)
1410 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001411 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001412 {
1413 ret = FAIL;
1414 break;
1415 }
1416 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001417 // The comma should come right after the argument, but this wasn't
1418 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001419 if (vim9script)
1420 {
1421 if (*argp != ',' && *skipwhite(argp) == ',')
1422 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01001423 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001424 ret = FAIL;
1425 break;
1426 }
1427 }
1428 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001429 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001430 if (*argp != ',')
1431 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001432 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1433 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001434 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001435 ret = FAIL;
1436 break;
1437 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001438 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001439 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001440 if (*argp == ')')
1441 ++argp;
1442 else
1443 ret = FAIL;
1444
1445 if (ret == OK)
1446 {
1447 int i = 0;
1448
1449 if (get_vim_var_nr(VV_TESTING))
1450 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001451 // Prepare for calling test_garbagecollect_now(), need to know
1452 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001453 if (funcargs.ga_itemsize == 0)
1454 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1455 for (i = 0; i < argcount; ++i)
1456 if (ga_grow(&funcargs, 1) == OK)
1457 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1458 &argvars[i];
1459 }
1460
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001461 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001462
1463 funcargs.ga_len -= i;
1464 }
1465 else if (!aborting())
1466 {
1467 if (argcount == MAX_FUNC_ARGS)
1468 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1469 else
1470 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1471 }
1472
1473 while (--argcount >= 0)
1474 clear_tv(&argvars[argcount]);
1475
Bram Moolenaar8294d492020-08-10 22:40:56 +02001476 if (in_vim9script())
1477 *arg = argp;
1478 else
1479 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001480 return ret;
1481}
1482
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483/*
1484 * Return TRUE if "p" starts with "<SID>" or "s:".
1485 * Only works if eval_fname_script() returned non-zero for "p"!
1486 */
1487 static int
1488eval_fname_sid(char_u *p)
1489{
1490 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1491}
1492
1493/*
1494 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1495 * Change <SNR>123_name() to K_SNR 123_name().
1496 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1497 * (slow).
1498 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001499 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001500fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1501{
1502 int llen;
1503 char_u *fname;
1504 int i;
1505
1506 llen = eval_fname_script(name);
1507 if (llen > 0)
1508 {
1509 fname_buf[0] = K_SPECIAL;
1510 fname_buf[1] = KS_EXTRA;
1511 fname_buf[2] = (int)KE_SNR;
1512 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001513 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001514 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001515 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001516 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001517 else
1518 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001519 sprintf((char *)fname_buf + 3, "%ld_",
1520 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001521 i = (int)STRLEN(fname_buf);
1522 }
1523 }
1524 if (i + STRLEN(name + llen) < FLEN_FIXED)
1525 {
1526 STRCPY(fname_buf + i, name + llen);
1527 fname = fname_buf;
1528 }
1529 else
1530 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001531 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001532 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001533 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534 else
1535 {
1536 *tofree = fname;
1537 mch_memmove(fname, fname_buf, (size_t)i);
1538 STRCPY(fname + i, name + llen);
1539 }
1540 }
1541 }
1542 else
1543 fname = name;
1544 return fname;
1545}
1546
1547/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001548 * Find a function "name" in script "sid".
1549 */
1550 static ufunc_T *
1551find_func_with_sid(char_u *name, int sid)
1552{
1553 hashitem_T *hi;
1554 char_u buffer[200];
1555
1556 buffer[0] = K_SPECIAL;
1557 buffer[1] = KS_EXTRA;
1558 buffer[2] = (int)KE_SNR;
1559 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1560 (long)sid, name);
1561 hi = hash_find(&func_hashtab, buffer);
1562 if (!HASHITEM_EMPTY(hi))
1563 return HI2UF(hi);
1564
1565 return NULL;
1566}
1567
1568/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001569 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001570 * When "is_global" is true don't find script-local or imported functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001571 * Return NULL for unknown function.
1572 */
Bram Moolenaarce658352020-07-31 23:47:12 +02001573 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001574find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575{
1576 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001577 ufunc_T *func;
1578 imported_T *imported;
1579
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001580 if (!is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001581 {
Bram Moolenaar333894b2020-08-01 18:53:07 +02001582 char_u *after_script = NULL;
Bram Moolenaarefa94442020-08-08 22:16:00 +02001583 long sid = 0;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001584 int find_script_local = in_vim9script()
1585 && eval_isnamec1(*name) && name[1] != ':';
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001586
Bram Moolenaar95006e32020-08-29 17:47:08 +02001587 if (find_script_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001588 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001589 // Find script-local function before global one.
1590 func = find_func_with_sid(name, current_sctx.sc_sid);
1591 if (func != NULL)
1592 return func;
1593 }
1594
Bram Moolenaarefa94442020-08-08 22:16:00 +02001595 if (name[0] == K_SPECIAL
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001596 && name[1] == KS_EXTRA
1597 && name[2] == KE_SNR)
1598 {
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001599 // Caller changes s: to <SNR>99_name.
1600
1601 after_script = name + 3;
1602 sid = getdigits(&after_script);
Bram Moolenaarefa94442020-08-08 22:16:00 +02001603 if (*after_script == '_')
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001604 ++after_script;
1605 else
1606 after_script = NULL;
1607 }
Bram Moolenaar95006e32020-08-29 17:47:08 +02001608 if (find_script_local || after_script != NULL)
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001609 {
1610 // Find imported function before global one.
Bram Moolenaarefa94442020-08-08 22:16:00 +02001611 if (after_script != NULL && sid != current_sctx.sc_sid)
1612 imported = find_imported_in_script(after_script, 0, sid);
1613 else
1614 imported = find_imported(after_script == NULL
1615 ? name : after_script, 0, cctx);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02001616 if (imported != NULL && imported->imp_funcname != NULL)
1617 {
1618 hi = hash_find(&func_hashtab, imported->imp_funcname);
1619 if (!HASHITEM_EMPTY(hi))
1620 return HI2UF(hi);
1621 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001622 }
1623 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001624
Bram Moolenaara26b9702020-04-18 19:53:28 +02001625 hi = hash_find(&func_hashtab,
1626 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627 if (!HASHITEM_EMPTY(hi))
1628 return HI2UF(hi);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001629
1630 return NULL;
1631}
1632
1633/*
1634 * Find a function by name, return pointer to it in ufuncs.
1635 * "cctx" is passed in a :def function to find imported functions.
1636 * Return NULL for unknown or dead function.
1637 */
1638 ufunc_T *
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001639find_func(char_u *name, int is_global, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001640{
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02001641 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001642
1643 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1644 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001645 return NULL;
1646}
1647
1648/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02001649 * Return TRUE if "ufunc" is a global function.
1650 */
1651 int
1652func_is_global(ufunc_T *ufunc)
1653{
1654 return ufunc->uf_name[0] != K_SPECIAL;
1655}
1656
1657/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001658 * Copy the function name of "fp" to buffer "buf".
1659 * "buf" must be able to hold the function name plus three bytes.
1660 * Takes care of script-local function names.
1661 */
1662 static void
1663cat_func_name(char_u *buf, ufunc_T *fp)
1664{
Bram Moolenaar0f769812020-09-12 18:32:34 +02001665 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001666 {
1667 STRCPY(buf, "<SNR>");
1668 STRCAT(buf, fp->uf_name + 3);
1669 }
1670 else
1671 STRCPY(buf, fp->uf_name);
1672}
1673
1674/*
1675 * Add a number variable "name" to dict "dp" with value "nr".
1676 */
1677 static void
1678add_nr_var(
1679 dict_T *dp,
1680 dictitem_T *v,
1681 char *name,
1682 varnumber_T nr)
1683{
1684 STRCPY(v->di_key, name);
1685 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1686 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1687 v->di_tv.v_type = VAR_NUMBER;
1688 v->di_tv.v_lock = VAR_FIXED;
1689 v->di_tv.vval.v_number = nr;
1690}
1691
1692/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001693 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001694 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001695 static void
1696free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001698 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001699
1700 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1701 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001702 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001703
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001704 // When garbage collecting a funccall_T may be freed before the
1705 // function that references it, clear its uf_scoped field.
1706 // The function may have been redefined and point to another
1707 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02001708 if (fp != NULL && fp->uf_scoped == fc)
1709 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001710 }
Bram Moolenaar58016442016-07-31 18:30:22 +02001711 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001712
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001713 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001714 vim_free(fc);
1715}
1716
1717/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001718 * Free "fc" and what it contains.
1719 * Can be called only when "fc" is kept beyond the period of it called,
1720 * i.e. after cleanup_function_call(fc).
1721 */
1722 static void
1723free_funccal_contents(funccall_T *fc)
1724{
1725 listitem_T *li;
1726
1727 // Free all l: variables.
1728 vars_clear(&fc->l_vars.dv_hashtab);
1729
1730 // Free all a: variables.
1731 vars_clear(&fc->l_avars.dv_hashtab);
1732
1733 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001734 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001735 clear_tv(&li->li_tv);
1736
1737 free_funccal(fc);
1738}
1739
1740/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02001741 * Handle the last part of returning from a function: free the local hashtable.
1742 * Unless it is still in use by a closure.
1743 */
1744 static void
1745cleanup_function_call(funccall_T *fc)
1746{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001747 int may_free_fc = fc->fc_refcount <= 0;
1748 int free_fc = TRUE;
1749
Bram Moolenaar6914c642017-04-01 21:21:30 +02001750 current_funccal = fc->caller;
1751
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001752 // Free all l: variables if not referred.
1753 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
1754 vars_clear(&fc->l_vars.dv_hashtab);
1755 else
1756 free_fc = FALSE;
1757
1758 // If the a:000 list and the l: and a: dicts are not referenced and
1759 // there is no closure using it, we can free the funccall_T and what's
1760 // in it.
1761 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
1762 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001763 else
1764 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001765 int todo;
1766 hashitem_T *hi;
1767 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001768
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001769 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02001770
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001771 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02001772 todo = (int)fc->l_avars.dv_hashtab.ht_used;
1773 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
1774 {
1775 if (!HASHITEM_EMPTY(hi))
1776 {
1777 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001778 di = HI2DI(hi);
1779 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02001780 }
1781 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001782 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001783
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001784 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
1785 fc->l_varlist.lv_first = NULL;
1786 else
1787 {
1788 listitem_T *li;
1789
1790 free_fc = FALSE;
1791
1792 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001793 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02001794 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001795 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001796
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001797 if (free_fc)
1798 free_funccal(fc);
1799 else
1800 {
1801 static int made_copy = 0;
1802
1803 // "fc" is still in use. This can happen when returning "a:000",
1804 // assigning "l:" to a global variable or defining a closure.
1805 // Link "fc" in the list for garbage collection later.
1806 fc->caller = previous_funccal;
1807 previous_funccal = fc;
1808
1809 if (want_garbage_collect)
1810 // If garbage collector is ready, clear count.
1811 made_copy = 0;
1812 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001813 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01001814 // We have made a lot of copies, worth 4 Mbyte. This can happen
1815 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001816 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001817 // too much memory.
1818 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01001819 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01001820 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02001821 }
1822}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001823
1824/*
1825 * There are two kinds of function names:
1826 * 1. ordinary names, function defined with :function or :def
1827 * 2. numbered functions and lambdas
1828 * For the first we only count the name stored in func_hashtab as a reference,
1829 * using function() does not count as a reference, because the function is
1830 * looked up by name.
1831 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001832 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001833func_name_refcount(char_u *name)
1834{
1835 return isdigit(*name) || *name == '<';
1836}
1837
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001838/*
1839 * Unreference "fc": decrement the reference count and free it when it
1840 * becomes zero. "fp" is detached from "fc".
1841 * When "force" is TRUE we are exiting.
1842 */
1843 static void
1844funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
1845{
1846 funccall_T **pfc;
1847 int i;
1848
1849 if (fc == NULL)
1850 return;
1851
1852 if (--fc->fc_refcount <= 0 && (force || (
1853 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
1854 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
1855 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
1856 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
1857 {
1858 if (fc == *pfc)
1859 {
1860 *pfc = fc->caller;
1861 free_funccal_contents(fc);
1862 return;
1863 }
1864 }
1865 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
1866 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
1867 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
1868}
1869
1870/*
1871 * Remove the function from the function hashtable. If the function was
1872 * deleted while it still has references this was already done.
1873 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
1874 */
1875 static int
1876func_remove(ufunc_T *fp)
1877{
1878 hashitem_T *hi;
1879
1880 // Return if it was already virtually deleted.
1881 if (fp->uf_flags & FC_DEAD)
1882 return FALSE;
1883
1884 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
1885 if (!HASHITEM_EMPTY(hi))
1886 {
1887 // When there is a def-function index do not actually remove the
1888 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001889 // Do remove it when it's a copy.
1890 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01001891 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001892 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01001893 return FALSE;
1894 }
1895 hash_remove(&func_hashtab, hi);
1896 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001897 return TRUE;
1898 }
1899 return FALSE;
1900}
1901
1902 static void
1903func_clear_items(ufunc_T *fp)
1904{
1905 ga_clear_strings(&(fp->uf_args));
1906 ga_clear_strings(&(fp->uf_def_args));
1907 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001908 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001909 VIM_CLEAR(fp->uf_def_arg_idx);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001910 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01001911 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02001912 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001913
1914 // Increment the refcount of this function to avoid it being freed
1915 // recursively when the partial is freed.
1916 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01001917 partial_unref(fp->uf_partial);
1918 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001919 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02001920
1921#ifdef FEAT_LUA
1922 if (fp->uf_cb_free != NULL)
1923 {
1924 fp->uf_cb_free(fp->uf_cb_state);
1925 fp->uf_cb_free = NULL;
1926 }
1927
1928 fp->uf_cb_state = NULL;
1929 fp->uf_cb = NULL;
1930#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001931#ifdef FEAT_PROFILE
1932 VIM_CLEAR(fp->uf_tml_count);
1933 VIM_CLEAR(fp->uf_tml_total);
1934 VIM_CLEAR(fp->uf_tml_self);
1935#endif
1936}
1937
1938/*
1939 * Free all things that a function contains. Does not free the function
1940 * itself, use func_free() for that.
1941 * When "force" is TRUE we are exiting.
1942 */
1943 static void
1944func_clear(ufunc_T *fp, int force)
1945{
1946 if (fp->uf_cleared)
1947 return;
1948 fp->uf_cleared = TRUE;
1949
1950 // clear this function
1951 func_clear_items(fp);
1952 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001953 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954}
1955
1956/*
1957 * Free a function and remove it from the list of functions. Does not free
1958 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001959 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02001960 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001961 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02001962 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001963func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001964{
1965 // Only remove it when not done already, otherwise we would remove a newer
1966 // version of the function with the same name.
1967 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
1968 func_remove(fp);
1969
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001970 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001971 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001972 if (fp->uf_dfunc_idx > 0)
1973 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001974 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001975 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02001976 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02001977 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02001978 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001979}
1980
1981/*
1982 * Free all things that a function contains and free the function itself.
1983 * When "force" is TRUE we are exiting.
1984 */
1985 static void
1986func_clear_free(ufunc_T *fp, int force)
1987{
1988 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02001989 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
1990 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001991 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02001992 else
1993 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001994}
1995
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001996/*
1997 * Copy already defined function "lambda" to a new function with name "global".
1998 * This is for when a compiled function defines a global function.
1999 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002000 int
2001copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002002{
2003 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002004 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002005
2006 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002007 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002008 semsg(_(e_lambda_function_not_found_str), lambda);
2009 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002010 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002011
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002012 fp = find_func(global, TRUE, NULL);
2013 if (fp != NULL)
2014 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002015 // TODO: handle ! to overwrite
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002016 semsg(_(e_funcexts), global);
2017 return FAIL;
2018 }
2019
2020 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2021 if (fp == NULL)
2022 return FAIL;
2023
2024 fp->uf_varargs = ufunc->uf_varargs;
2025 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2026 fp->uf_def_status = ufunc->uf_def_status;
2027 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2028 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2029 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2030 == FAIL
2031 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2032 goto failed;
2033
2034 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2035 : vim_strsave(ufunc->uf_name_exp);
2036 if (ufunc->uf_arg_types != NULL)
2037 {
2038 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2039 if (fp->uf_arg_types == NULL)
2040 goto failed;
2041 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2042 sizeof(type_T *) * fp->uf_args.ga_len);
2043 }
2044 if (ufunc->uf_def_arg_idx != NULL)
2045 {
2046 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1);
2047 if (fp->uf_def_arg_idx == NULL)
2048 goto failed;
2049 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx,
2050 sizeof(int) * fp->uf_def_args.ga_len + 1);
2051 }
2052 if (ufunc->uf_va_name != NULL)
2053 {
2054 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2055 if (fp->uf_va_name == NULL)
2056 goto failed;
2057 }
2058 fp->uf_ret_type = ufunc->uf_ret_type;
2059
2060 fp->uf_refcount = 1;
2061 STRCPY(fp->uf_name, global);
2062 hash_add(&func_hashtab, UF2HIKEY(fp));
2063
2064 // the referenced dfunc_T is now used one more time
2065 link_def_function(fp);
2066
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002067 // Create a partial to store the context of the function where it was
2068 // instantiated. Only needs to be done once. Do this on the original
2069 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002070 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2071 {
2072 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2073
2074 if (pt == NULL)
2075 goto failed;
2076 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002077 {
2078 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002079 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002080 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002081 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002082 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002083 }
2084
2085 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002086
2087failed:
2088 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002089 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002090}
2091
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002092static int funcdepth = 0;
2093
2094/*
2095 * Increment the function call depth count.
2096 * Return FAIL when going over 'maxfuncdepth'.
2097 * Otherwise return OK, must call funcdepth_decrement() later!
2098 */
2099 int
2100funcdepth_increment(void)
2101{
2102 if (funcdepth >= p_mfd)
2103 {
2104 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2105 return FAIL;
2106 }
2107 ++funcdepth;
2108 return OK;
2109}
2110
2111 void
2112funcdepth_decrement(void)
2113{
2114 --funcdepth;
2115}
2116
2117/*
2118 * Get the current function call depth.
2119 */
2120 int
2121funcdepth_get(void)
2122{
2123 return funcdepth;
2124}
2125
2126/*
2127 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002128 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002129 * times as funcdepth_increment().
2130 */
2131 void
2132funcdepth_restore(int depth)
2133{
2134 funcdepth = depth;
2135}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002136
2137/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002138 * Call a user function.
2139 */
2140 static void
2141call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002142 ufunc_T *fp, // pointer to function
2143 int argcount, // nr of args
2144 typval_T *argvars, // arguments
2145 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002146 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002147 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002148{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002149 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002150 int using_sandbox = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002151 funccall_T *fc;
2152 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002153 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002154 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002155 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156 int i;
2157 int ai;
2158 int islambda = FALSE;
2159 char_u numbuf[NUMBUFLEN];
2160 char_u *name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002161#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002162 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002163#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002164 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002165
Bram Moolenaarb2049902021-01-24 12:53:53 +01002166#ifdef FEAT_PROFILE
2167 CLEAR_FIELD(profile_info);
2168#endif
2169
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002170 // If depth of calling is getting too high, don't execute the function.
2171 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002172 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002173 rettv->v_type = VAR_NUMBER;
2174 rettv->vval.v_number = -1;
2175 return;
2176 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002177
Bram Moolenaare38eab22019-12-05 21:50:01 +01002178 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002179
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002180 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002181 if (fc == NULL)
2182 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002183 fc->caller = current_funccal;
2184 current_funccal = fc;
2185 fc->func = fp;
2186 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002187 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002188 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002189 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2190 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002191 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002192 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002193 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002194
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002195 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002196 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002197#ifdef FEAT_PROFILE
2198 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2199#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002200 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002201#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002202 if (do_profiling == PROF_YES)
2203 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002204#endif
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002205 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002206 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002207#ifdef FEAT_PROFILE
2208 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002209 || (caller != NULL && caller->uf_profiling)))
2210 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002211#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002212 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002213 free_funccal(fc);
2214 return;
2215 }
2216
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002217 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2218 islambda = TRUE;
2219
2220 /*
2221 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2222 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2223 * each argument variable and saves a lot of time.
2224 */
2225 /*
2226 * Init l: variables.
2227 */
2228 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2229 if (selfdict != NULL)
2230 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002231 // Set l:self to "selfdict". Use "name" to avoid a warning from
2232 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002233 v = &fc->fixvar[fixvar_idx++].var;
2234 name = v->di_key;
2235 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002236 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002237 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2238 v->di_tv.v_type = VAR_DICT;
2239 v->di_tv.v_lock = 0;
2240 v->di_tv.vval.v_dict = selfdict;
2241 ++selfdict->dv_refcount;
2242 }
2243
2244 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002245 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002246 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002247 * Set a:000 to a list with room for the "..." arguments.
2248 */
2249 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002250 if ((fp->uf_flags & FC_NOARGS) == 0)
2251 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002252 (varnumber_T)(argcount >= fp->uf_args.ga_len
2253 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002254 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002255 if ((fp->uf_flags & FC_NOARGS) == 0)
2256 {
2257 // Use "name" to avoid a warning from some compiler that checks the
2258 // destination size.
2259 v = &fc->fixvar[fixvar_idx++].var;
2260 name = v->di_key;
2261 STRCPY(name, "000");
2262 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2263 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2264 v->di_tv.v_type = VAR_LIST;
2265 v->di_tv.v_lock = VAR_FIXED;
2266 v->di_tv.vval.v_list = &fc->l_varlist;
2267 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002268 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002269 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2270 fc->l_varlist.lv_lock = VAR_FIXED;
2271
2272 /*
2273 * Set a:firstline to "firstline" and a:lastline to "lastline".
2274 * Set a:name to named arguments.
2275 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002276 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002277 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002278 if ((fp->uf_flags & FC_NOARGS) == 0)
2279 {
2280 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002281 (varnumber_T)funcexe->firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002282 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002283 (varnumber_T)funcexe->lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002284 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002285 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002286 {
2287 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002288 typval_T def_rettv;
2289 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002290
2291 ai = i - fp->uf_args.ga_len;
2292 if (ai < 0)
2293 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002294 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002295 name = FUNCARG(fp, i);
2296 if (islambda)
2297 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002298
2299 // evaluate named argument default expression
2300 isdefault = ai + fp->uf_def_args.ga_len >= 0
2301 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2302 && argvars[i].vval.v_number == VVAL_NONE));
2303 if (isdefault)
2304 {
2305 char_u *default_expr = NULL;
2306 def_rettv.v_type = VAR_NUMBER;
2307 def_rettv.vval.v_number = -1;
2308
2309 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2310 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002311 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002312 {
2313 default_arg_err = 1;
2314 break;
2315 }
2316 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002317 }
2318 else
2319 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002320 if ((fp->uf_flags & FC_NOARGS) != 0)
2321 // Bail out if no a: arguments used (in lambda).
2322 break;
2323
Bram Moolenaare38eab22019-12-05 21:50:01 +01002324 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002325 sprintf((char *)numbuf, "%d", ai + 1);
2326 name = numbuf;
2327 }
2328 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2329 {
2330 v = &fc->fixvar[fixvar_idx++].var;
2331 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002332 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002333 }
2334 else
2335 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002336 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002337 if (v == NULL)
2338 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002339 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002340 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002341
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002342 // Note: the values are copied directly to avoid alloc/free.
2343 // "argvars" must have VAR_FIXED for v_lock.
2344 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002345 v->di_tv.v_lock = VAR_FIXED;
2346
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002347 if (addlocal)
2348 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002349 // Named arguments should be accessed without the "a:" prefix in
2350 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002351 copy_tv(&v->di_tv, &v->di_tv);
2352 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002353 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002354 else
2355 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002356
2357 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2358 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002359 listitem_T *li = &fc->l_listitems[ai];
2360
2361 li->li_tv = argvars[i];
2362 li->li_tv.v_lock = VAR_FIXED;
2363 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002364 }
2365 }
2366
Bram Moolenaare38eab22019-12-05 21:50:01 +01002367 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002368 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002369
2370 if (fp->uf_flags & FC_SANDBOX)
2371 {
2372 using_sandbox = TRUE;
2373 ++sandbox;
2374 }
2375
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002376 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002377 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002378 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002379 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002380 ++no_wait_return;
2381 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002382
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002383 smsg(_("calling %s"), SOURCING_NAME);
2384 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002385 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002386 char_u buf[MSG_BUF_LEN];
2387 char_u numbuf2[NUMBUFLEN];
2388 char_u *tofree;
2389 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002390
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002391 msg_puts("(");
2392 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002393 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002394 if (i > 0)
2395 msg_puts(", ");
2396 if (argvars[i].v_type == VAR_NUMBER)
2397 msg_outnum((long)argvars[i].vval.v_number);
2398 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002399 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002400 // Do not want errors such as E724 here.
2401 ++emsg_off;
2402 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2403 --emsg_off;
2404 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002405 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002406 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002407 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002408 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2409 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002410 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002411 msg_puts((char *)s);
2412 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002413 }
2414 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002415 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002416 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002417 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002418 msg_puts("\n"); // don't overwrite this either
2419
2420 verbose_leave_scroll();
2421 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002422 }
2423#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002424 if (do_profiling == PROF_YES)
2425 profile_may_start_func(&profile_info, fp,
2426 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002427#endif
2428
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002429 save_current_sctx = current_sctx;
2430 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002431 save_did_emsg = did_emsg;
2432 did_emsg = FALSE;
2433
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002434 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2435 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002436 else if (islambda)
2437 {
2438 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2439
2440 // A Lambda always has the command "return {expr}". It is much faster
2441 // to evaluate {expr} directly.
2442 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002443 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002444 --ex_nesting_level;
2445 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002446 else
2447 // call do_cmdline() to execute the lines
2448 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002449 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2450
2451 --RedrawingDisabled;
2452
Bram Moolenaare38eab22019-12-05 21:50:01 +01002453 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002454 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2455 {
2456 clear_tv(rettv);
2457 rettv->v_type = VAR_NUMBER;
2458 rettv->vval.v_number = -1;
2459 }
2460
2461#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002462 if (do_profiling == PROF_YES)
2463 {
2464 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2465
2466 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2467 profile_may_end_func(&profile_info, fp, caller);
2468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002469#endif
2470
Bram Moolenaare38eab22019-12-05 21:50:01 +01002471 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002472 if (p_verbose >= 12)
2473 {
2474 ++no_wait_return;
2475 verbose_enter_scroll();
2476
2477 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002478 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002479 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002480 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002481 (long)fc->rettv->vval.v_number);
2482 else
2483 {
2484 char_u buf[MSG_BUF_LEN];
2485 char_u numbuf2[NUMBUFLEN];
2486 char_u *tofree;
2487 char_u *s;
2488
Bram Moolenaare38eab22019-12-05 21:50:01 +01002489 // The value may be very long. Skip the middle part, so that we
2490 // have some idea how it starts and ends. smsg() would always
2491 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002492 ++emsg_off;
2493 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2494 --emsg_off;
2495 if (s != NULL)
2496 {
2497 if (vim_strsize(s) > MSG_BUF_CLEN)
2498 {
2499 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2500 s = buf;
2501 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002502 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002503 vim_free(tofree);
2504 }
2505 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002506 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002507
2508 verbose_leave_scroll();
2509 --no_wait_return;
2510 }
2511
Bram Moolenaare31ee862020-01-07 20:59:34 +01002512 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002513 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002514 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002515#ifdef FEAT_PROFILE
2516 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002517 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002518#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002519 if (using_sandbox)
2520 --sandbox;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002521
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002522 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002523 {
2524 ++no_wait_return;
2525 verbose_enter_scroll();
2526
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002527 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002528 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002529
2530 verbose_leave_scroll();
2531 --no_wait_return;
2532 }
2533
2534 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002535 funcdepth_decrement();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002536 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002537}
2538
2539/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002540 * Check the argument count for user function "fp".
2541 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2542 */
2543 int
2544check_user_func_argcount(ufunc_T *fp, int argcount)
2545{
2546 int regular_args = fp->uf_args.ga_len;
2547
2548 if (argcount < regular_args - fp->uf_def_args.ga_len)
2549 return FCERR_TOOFEW;
2550 else if (!has_varargs(fp) && argcount > regular_args)
2551 return FCERR_TOOMANY;
2552 return FCERR_UNKNOWN;
2553}
2554
2555/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002556 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002557 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002558 int
2559call_user_func_check(
2560 ufunc_T *fp,
2561 int argcount,
2562 typval_T *argvars,
2563 typval_T *rettv,
2564 funcexe_T *funcexe,
2565 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002566{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002567 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002568
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002569 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2570 *funcexe->doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01002571 error = check_user_func_argcount(fp, argcount);
2572 if (error != FCERR_UNKNOWN)
2573 return error;
2574 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002575 error = FCERR_DICT;
2576 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002577 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002578 int did_save_redo = FALSE;
2579 save_redo_T save_redo;
2580
2581 /*
2582 * Call the user function.
2583 * Save and restore search patterns, script variables and
2584 * redo buffer.
2585 */
2586 save_search_patterns();
2587 if (!ins_compl_active())
2588 {
2589 saveRedobuff(&save_redo);
2590 did_save_redo = TRUE;
2591 }
2592 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002593 call_user_func(fp, argcount, argvars, rettv, funcexe,
2594 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2596 // Function was unreferenced while being used, free it now.
2597 func_clear_free(fp, FALSE);
2598 if (did_save_redo)
2599 restoreRedobuff(&save_redo);
2600 restore_search_patterns();
2601 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02002602 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002603 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002604}
2605
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002606static funccal_entry_T *funccal_stack = NULL;
2607
2608/*
2609 * Save the current function call pointer, and set it to NULL.
2610 * Used when executing autocommands and for ":source".
2611 */
2612 void
2613save_funccal(funccal_entry_T *entry)
2614{
2615 entry->top_funccal = current_funccal;
2616 entry->next = funccal_stack;
2617 funccal_stack = entry;
2618 current_funccal = NULL;
2619}
2620
2621 void
2622restore_funccal(void)
2623{
2624 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002625 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002626 else
2627 {
2628 current_funccal = funccal_stack->top_funccal;
2629 funccal_stack = funccal_stack->next;
2630 }
2631}
2632
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02002633 funccall_T *
2634get_current_funccal(void)
2635{
2636 return current_funccal;
2637}
2638
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002639/*
2640 * Mark all functions of script "sid" as deleted.
2641 */
2642 void
2643delete_script_functions(int sid)
2644{
2645 hashitem_T *hi;
2646 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02002647 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002648 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002649 size_t len;
2650
2651 buf[0] = K_SPECIAL;
2652 buf[1] = KS_EXTRA;
2653 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02002654 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002655 len = STRLEN(buf);
2656
Bram Moolenaarce658352020-07-31 23:47:12 +02002657 while (todo > 0)
2658 {
2659 todo = func_hashtab.ht_used;
2660 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2661 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002662 {
Bram Moolenaarce658352020-07-31 23:47:12 +02002663 fp = HI2UF(hi);
2664 if (STRNCMP(fp->uf_name, buf, len) == 0)
2665 {
2666 int changed = func_hashtab.ht_changed;
2667
2668 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002669
2670 if (fp->uf_calls > 0)
2671 {
2672 // Function is executing, don't free it but do remove
2673 // it from the hashtable.
2674 if (func_remove(fp))
2675 fp->uf_refcount--;
2676 }
2677 else
2678 {
2679 func_clear(fp, TRUE);
2680 // When clearing a function another function can be
2681 // cleared as a side effect. When that happens start
2682 // over.
2683 if (changed != func_hashtab.ht_changed)
2684 break;
2685 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002686 }
2687 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002688 }
Bram Moolenaarce658352020-07-31 23:47:12 +02002689 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02002690}
2691
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002692#if defined(EXITFREE) || defined(PROTO)
2693 void
2694free_all_functions(void)
2695{
2696 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002697 ufunc_T *fp;
2698 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002699 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002700 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002701
Bram Moolenaare38eab22019-12-05 21:50:01 +01002702 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002703 while (current_funccal != NULL)
2704 {
2705 clear_tv(current_funccal->rettv);
2706 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02002707 if (current_funccal == NULL && funccal_stack != NULL)
2708 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02002709 }
2710
Bram Moolenaare38eab22019-12-05 21:50:01 +01002711 // First clear what the functions contain. Since this may lower the
2712 // reference count of a function, it may also free a function and change
2713 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002714 while (todo > 0)
2715 {
2716 todo = func_hashtab.ht_used;
2717 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2718 if (!HASHITEM_EMPTY(hi))
2719 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002720 // clear the def function index now
2721 fp = HI2UF(hi);
2722 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002723 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002724
Bram Moolenaare38eab22019-12-05 21:50:01 +01002725 // Only free functions that are not refcounted, those are
2726 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002727 if (func_name_refcount(fp->uf_name))
2728 ++skipped;
2729 else
2730 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002731 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002732 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02002733 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002734 {
2735 skipped = 0;
2736 break;
2737 }
2738 }
2739 --todo;
2740 }
2741 }
2742
Bram Moolenaare38eab22019-12-05 21:50:01 +01002743 // Now actually free the functions. Need to start all over every time,
2744 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01002745 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002746 while (func_hashtab.ht_used > skipped)
2747 {
2748 todo = func_hashtab.ht_used;
2749 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002750 if (!HASHITEM_EMPTY(hi))
2751 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02002752 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002753 // Only free functions that are not refcounted, those are
2754 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02002755 fp = HI2UF(hi);
2756 if (func_name_refcount(fp->uf_name))
2757 ++skipped;
2758 else
2759 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02002760 if (func_free(fp, FALSE) == OK)
2761 {
2762 skipped = 0;
2763 break;
2764 }
2765 // did not actually free it
2766 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02002767 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002768 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02002769 }
2770 if (skipped == 0)
2771 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002772
2773 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774}
2775#endif
2776
2777/*
2778 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaara26b9702020-04-18 19:53:28 +02002779 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 * "len" is the length of "name", or -1 for NUL terminated.
2781 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002782 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002783builtin_function(char_u *name, int len)
2784{
2785 char_u *p;
2786
Bram Moolenaara26b9702020-04-18 19:53:28 +02002787 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002788 return FALSE;
2789 p = vim_strchr(name, AUTOLOAD_CHAR);
2790 return p == NULL || (len > 0 && p > name + len);
2791}
2792
2793 int
2794func_call(
2795 char_u *name,
2796 typval_T *args,
2797 partial_T *partial,
2798 dict_T *selfdict,
2799 typval_T *rettv)
2800{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01002801 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 listitem_T *item;
2803 typval_T argv[MAX_FUNC_ARGS + 1];
2804 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805 int r = 0;
2806
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02002807 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02002808 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 {
2810 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
2811 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002812 emsg(_("E699: Too many arguments"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 break;
2814 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002815 // Make a copy of each argument. This is needed to be able to set
2816 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 copy_tv(&item->li_tv, &argv[argc++]);
2818 }
2819
2820 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002821 {
2822 funcexe_T funcexe;
2823
Bram Moolenaara80faa82020-04-12 19:37:17 +02002824 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002825 funcexe.firstline = curwin->w_cursor.lnum;
2826 funcexe.lastline = curwin->w_cursor.lnum;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002827 funcexe.evaluate = TRUE;
2828 funcexe.partial = partial;
2829 funcexe.selfdict = selfdict;
2830 r = call_func(name, -1, rettv, argc, argv, &funcexe);
2831 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832
Bram Moolenaare38eab22019-12-05 21:50:01 +01002833 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 while (argc > 0)
2835 clear_tv(&argv[--argc]);
2836
2837 return r;
2838}
2839
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002840static int callback_depth = 0;
2841
2842 int
2843get_callback_depth(void)
2844{
2845 return callback_depth;
2846}
2847
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002849 * Invoke call_func() with a callback.
2850 */
2851 int
2852call_callback(
2853 callback_T *callback,
2854 int len, // length of "name" or -1 to use strlen()
2855 typval_T *rettv, // return value goes here
2856 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002857 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002858 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002859{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002860 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002861 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002862
Bram Moolenaara80faa82020-04-12 19:37:17 +02002863 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002864 funcexe.evaluate = TRUE;
2865 funcexe.partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002866 ++callback_depth;
2867 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
2868 --callback_depth;
2869 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02002870}
2871
2872/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002873 * Give an error message for the result of a function.
2874 * Nothing if "error" is FCERR_NONE.
2875 */
2876 void
2877user_func_error(int error, char_u *name)
2878{
2879 switch (error)
2880 {
2881 case FCERR_UNKNOWN:
2882 emsg_funcname(e_unknownfunc, name);
2883 break;
2884 case FCERR_NOTMETHOD:
2885 emsg_funcname(
2886 N_("E276: Cannot use function as a method: %s"), name);
2887 break;
2888 case FCERR_DELETED:
2889 emsg_funcname(N_(e_func_deleted), name);
2890 break;
2891 case FCERR_TOOMANY:
2892 emsg_funcname((char *)e_toomanyarg, name);
2893 break;
2894 case FCERR_TOOFEW:
2895 emsg_funcname((char *)e_toofewarg, name);
2896 break;
2897 case FCERR_SCRIPT:
2898 emsg_funcname(
2899 N_("E120: Using <SID> not in a script context: %s"), name);
2900 break;
2901 case FCERR_DICT:
2902 emsg_funcname(
2903 N_("E725: Calling dict function without Dictionary: %s"),
2904 name);
2905 break;
2906 }
2907}
2908
2909/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002910 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002911 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912 * Return FAIL when the function can't be called, OK otherwise.
2913 * Also returns OK when an error was encountered while executing the function.
2914 */
2915 int
2916call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02002917 char_u *funcname, // name of the function
2918 int len, // length of "name" or -1 to use strlen()
2919 typval_T *rettv, // return value goes here
2920 int argcount_in, // number of "argvars"
2921 typval_T *argvars_in, // vars for arguments, must have "argcount"
2922 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002923 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924{
2925 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01002926 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002928 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002929 char_u fname_buf[FLEN_FIXED + 1];
2930 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002931 char_u *fname = NULL;
2932 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002933 int argcount = argcount_in;
2934 typval_T *argvars = argvars_in;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002935 dict_T *selfdict = funcexe->selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02002936 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
2937 // "funcexe->basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002938 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02002939 int argv_base = 0;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002940 partial_T *partial = funcexe->partial;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02002942 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
2943 // even when call_func() returns FAIL.
2944 rettv->v_type = VAR_UNKNOWN;
2945
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002946 if (partial != NULL)
2947 fp = partial->pt_func;
2948 if (fp == NULL)
2949 {
2950 // Make a copy of the name, if it comes from a funcref variable it
2951 // could be changed or deleted in the called function.
2952 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
2953 if (name == NULL)
2954 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002956 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
2957 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002958
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002959 if (funcexe->doesrange != NULL)
2960 *funcexe->doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002961
2962 if (partial != NULL)
2963 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002964 // When the function has a partial with a dict and there is a dict
2965 // argument, use the dict argument. That is backwards compatible.
2966 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02002967 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01002969 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970 {
2971 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002972 {
2973 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
2974 {
Bram Moolenaaref140542019-12-31 21:27:13 +01002975 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002976 goto theend;
2977 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01002979 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980 for (i = 0; i < argcount_in; ++i)
2981 argv[i + argv_clear] = argvars_in[i];
2982 argvars = argv;
2983 argcount = partial->pt_argc + argcount_in;
2984 }
2985 }
2986
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002987 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
2988 {
2989 // Check that the argument types are OK for the types of the funcref.
2990 if (check_argument_types(funcexe->check_type, argvars, argcount,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01002991 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01002992 error = FCERR_OTHER;
2993 }
2994
Bram Moolenaaref140542019-12-31 21:27:13 +01002995 if (error == FCERR_NONE && funcexe->evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002996 {
2997 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02002998 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002999
Bram Moolenaar333894b2020-08-01 18:53:07 +02003000 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003001 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003002 {
3003 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003005 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006
Bram Moolenaare38eab22019-12-05 21:50:01 +01003007 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003009 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003010
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003011 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003012 {
3013 /*
3014 * User defined function.
3015 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003016 if (fp == NULL)
Bram Moolenaar333894b2020-08-01 18:53:07 +02003017 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018
Bram Moolenaare38eab22019-12-05 21:50:01 +01003019 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020 if (fp == NULL
3021 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003022 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023 && !aborting())
3024 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003025 // executed an autocommand, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003026 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003028 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003029 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3030 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003031 // loaded a package, search for the function again
Bram Moolenaar333894b2020-08-01 18:53:07 +02003032 fp = find_func(rfname, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003034 if (fp == NULL)
3035 {
3036 char_u *p = untrans_function_name(rfname);
3037
3038 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003039 // Don't do this if the name starts with "s:".
3040 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaar333894b2020-08-01 18:53:07 +02003041 fp = find_func(p, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003042 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003044 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003045 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003046#ifdef FEAT_LUA
3047 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3048 {
3049 cfunc_T cb = fp->uf_cb;
3050
3051 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3052 }
3053#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003054 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003055 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003056 if (funcexe->argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003057 // postponed filling in the arguments, do it now
3058 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003059 fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003060
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003061 if (funcexe->basetv != NULL)
3062 {
3063 // Method call: base->Method()
3064 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3065 argv[0] = *funcexe->basetv;
3066 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003067 argvars = argv;
3068 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003069 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003070
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071 error = call_user_func_check(fp, argcount, argvars, rettv,
3072 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003073 }
3074 }
Bram Moolenaarac92e252019-08-03 21:58:38 +02003075 else if (funcexe->basetv != NULL)
3076 {
3077 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003078 * expr->method(): Find the method name in the table, call its
3079 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003080 */
3081 error = call_internal_method(fname, argcount, argvars, rettv,
3082 funcexe->basetv);
3083 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003084 else
3085 {
3086 /*
3087 * Find the function name in the table, call its implementation.
3088 */
3089 error = call_internal_func(fname, argcount, argvars, rettv);
3090 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003091
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003092 /*
3093 * The function call (or "FuncUndefined" autocommand sequence) might
3094 * have been aborted by an error, an interrupt, or an explicitly thrown
3095 * exception that has not been caught so far. This situation can be
3096 * tested for by calling aborting(). For an error in an internal
3097 * function or for the "E132" error in call_user_func(), however, the
3098 * throw point at which the "force_abort" flag (temporarily reset by
3099 * emsg()) is normally updated has not been reached yet. We need to
3100 * update that flag first to make aborting() reliable.
3101 */
3102 update_force_abort();
3103 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003104 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003105 ret = OK;
3106
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003107theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003108 /*
3109 * Report an error unless the argument evaluation or function call has been
3110 * cancelled due to an aborting error, an interrupt, or an exception.
3111 */
3112 if (!aborting())
3113 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003114 user_func_error(error, (name != NULL) ? name : funcname);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003115 }
3116
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003117 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003118 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003119 clear_tv(&argv[--argv_clear + argv_base]);
3120
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003121 vim_free(tofree);
3122 vim_free(name);
3123
3124 return ret;
3125}
3126
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003127 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003128printable_func_name(ufunc_T *fp)
3129{
3130 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3131}
3132
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003133/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003134 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003135 */
3136 static void
3137list_func_head(ufunc_T *fp, int indent)
3138{
3139 int j;
3140
3141 msg_start();
3142 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003143 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003144 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003145 msg_puts("def ");
3146 else
3147 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003148 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003149 msg_putchar('(');
3150 for (j = 0; j < fp->uf_args.ga_len; ++j)
3151 {
3152 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003153 msg_puts(", ");
3154 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003155 if (fp->uf_arg_types != NULL)
3156 {
3157 char *tofree;
3158
3159 msg_puts(": ");
3160 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3161 vim_free(tofree);
3162 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003163 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3164 {
3165 msg_puts(" = ");
3166 msg_puts(((char **)(fp->uf_def_args.ga_data))
3167 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3168 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003169 }
3170 if (fp->uf_varargs)
3171 {
3172 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003173 msg_puts(", ");
3174 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003175 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003176 if (fp->uf_va_name != NULL)
3177 {
3178 if (j)
3179 msg_puts(", ");
3180 msg_puts("...");
3181 msg_puts((char *)fp->uf_va_name);
3182 if (fp->uf_va_type)
3183 {
3184 char *tofree;
3185
3186 msg_puts(": ");
3187 msg_puts(type_name(fp->uf_va_type, &tofree));
3188 vim_free(tofree);
3189 }
3190 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003191 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003192
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003193 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003194 {
3195 if (fp->uf_ret_type != &t_void)
3196 {
3197 char *tofree;
3198
3199 msg_puts(": ");
3200 msg_puts(type_name(fp->uf_ret_type, &tofree));
3201 vim_free(tofree);
3202 }
3203 }
3204 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003205 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003206 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003207 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003208 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003209 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003210 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003211 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003212 msg_clr_eos();
3213 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003214 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003215}
3216
3217/*
3218 * Get a function name, translating "<SID>" and "<SNR>".
3219 * Also handles a Funcref in a List or Dictionary.
3220 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003221 * Set "*is_global" to TRUE when the function must be global, unless
3222 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223 * flags:
3224 * TFN_INT: internal function name OK
3225 * TFN_QUIET: be quiet
3226 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003227 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228 * Advances "pp" to just after the function name (if no error).
3229 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003230 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003231trans_function_name(
3232 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003233 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003234 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003236 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003237 partial_T **partial, // return: partial of a FuncRef
3238 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003239{
3240 char_u *name = NULL;
3241 char_u *start;
3242 char_u *end;
3243 int lead;
3244 char_u sid_buf[20];
3245 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003246 int extra = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003247 lval_T lv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 int vim9script;
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003249 static char *e_function_name = N_("E129: Function name required");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003250
3251 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003252 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003253 start = *pp;
3254
Bram Moolenaare38eab22019-12-05 21:50:01 +01003255 // Check for hard coded <SNR>: already translated function ID (from a user
3256 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003257 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3258 && (*pp)[2] == (int)KE_SNR)
3259 {
3260 *pp += 3;
3261 len = get_id_len(pp) + 3;
3262 return vim_strnsave(start, len);
3263 }
3264
Bram Moolenaare38eab22019-12-05 21:50:01 +01003265 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3266 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 lead = eval_fname_script(start);
3268 if (lead > 2)
3269 start += lead;
3270
Bram Moolenaare38eab22019-12-05 21:50:01 +01003271 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003272 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273 lead > 2 ? 0 : FNE_CHECK_START);
3274 if (end == start)
3275 {
3276 if (!skip)
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003277 emsg(_(e_function_name));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003278 goto theend;
3279 }
3280 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3281 {
3282 /*
3283 * Report an invalid expression in braces, unless the expression
3284 * evaluation has been cancelled due to an aborting error, an
3285 * interrupt, or an exception.
3286 */
3287 if (!aborting())
3288 {
3289 if (end != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003290 semsg(_(e_invarg2), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003291 }
3292 else
3293 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3294 goto theend;
3295 }
3296
3297 if (lv.ll_tv != NULL)
3298 {
3299 if (fdp != NULL)
3300 {
3301 fdp->fd_dict = lv.ll_dict;
3302 fdp->fd_newkey = lv.ll_newkey;
3303 lv.ll_newkey = NULL;
3304 fdp->fd_di = lv.ll_di;
3305 }
3306 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3307 {
3308 name = vim_strsave(lv.ll_tv->vval.v_string);
3309 *pp = end;
3310 }
3311 else if (lv.ll_tv->v_type == VAR_PARTIAL
3312 && lv.ll_tv->vval.v_partial != NULL)
3313 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003314 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 *pp = end;
3316 if (partial != NULL)
3317 *partial = lv.ll_tv->vval.v_partial;
3318 }
3319 else
3320 {
3321 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3322 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003323 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003324 else
3325 *pp = end;
3326 name = NULL;
3327 }
3328 goto theend;
3329 }
3330
3331 if (lv.ll_name == NULL)
3332 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003333 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003334 *pp = end;
3335 goto theend;
3336 }
3337
Bram Moolenaare38eab22019-12-05 21:50:01 +01003338 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 if (lv.ll_exp_name != NULL)
3340 {
3341 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003342 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343 flags & TFN_NO_AUTOLOAD);
3344 if (name == lv.ll_exp_name)
3345 name = NULL;
3346 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003347 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 {
3349 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003350 name = deref_func_name(*pp, &len, partial, type,
3351 flags & TFN_NO_AUTOLOAD);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 if (name == *pp)
3353 name = NULL;
3354 }
3355 if (name != NULL)
3356 {
3357 name = vim_strsave(name);
3358 *pp = end;
3359 if (STRNCMP(name, "<SNR>", 5) == 0)
3360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003361 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003362 name[0] = K_SPECIAL;
3363 name[1] = KS_EXTRA;
3364 name[2] = (int)KE_SNR;
3365 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3366 }
3367 goto theend;
3368 }
3369
3370 if (lv.ll_exp_name != NULL)
3371 {
3372 len = (int)STRLEN(lv.ll_exp_name);
3373 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3374 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3375 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003376 // When there was "s:" already or the name expanded to get a
3377 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003378 lv.ll_name += 2;
3379 len -= 2;
3380 lead = 2;
3381 }
3382 }
3383 else
3384 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003385 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003387 {
3388 if (is_global != NULL && lv.ll_name[0] == 'g')
3389 *is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003390 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003391 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003392 len = (int)(end - lv.ll_name);
3393 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003394 if (len <= 0)
3395 {
3396 if (!skip)
3397 emsg(_(e_function_name));
3398 goto theend;
3399 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003400
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003401 // In Vim9 script a user function is script-local by default, unless it
3402 // starts with a lower case character: dict.func().
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003403 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003404 if (vim9script)
3405 {
3406 char_u *p;
3407
3408 // SomeScript#func() is a global function.
3409 for (p = start; *p != NUL && *p != '('; ++p)
3410 if (*p == AUTOLOAD_CHAR)
3411 vim9script = FALSE;
3412 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003413
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003414 /*
3415 * Copy the function name to allocated memory.
3416 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3417 * Accept <SNR>123_name() outside a script.
3418 */
3419 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003420 lead = 0; // do nothing
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003421 else if (lead > 0 || vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003422 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003423 if (!vim9script)
3424 lead = 3;
3425 if (vim9script || (lv.ll_exp_name != NULL
3426 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003427 || eval_fname_sid(*pp))
3428 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003429 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003430 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003431 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003432 emsg(_(e_usingsid));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003433 goto theend;
3434 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003435 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003436 if (vim9script)
3437 extra = 3 + (int)STRLEN(sid_buf);
3438 else
3439 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003440 }
3441 }
3442 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len))
3443 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003444 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 start);
3446 goto theend;
3447 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003448 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003449 {
3450 char_u *cp = vim_strchr(lv.ll_name, ':');
3451
3452 if (cp != NULL && cp < end)
3453 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003454 semsg(_("E884: Function name cannot contain a colon: %s"), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003455 goto theend;
3456 }
3457 }
3458
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 if (name != NULL)
3461 {
Bram Moolenaar9a5e5a32020-01-28 23:09:23 +01003462 if (!skip && (lead > 0 || vim9script))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003463 {
3464 name[0] = K_SPECIAL;
3465 name[1] = KS_EXTRA;
3466 name[2] = (int)KE_SNR;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003467 if (vim9script || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003468 STRCPY(name + 3, sid_buf);
3469 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3471 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003472 }
3473 *pp = end;
3474
3475theend:
3476 clear_lval(&lv);
3477 return name;
3478}
3479
3480/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02003481 * Assuming "name" is the result of trans_function_name() and it was prefixed
3482 * to use the script-local name, return the unmodified name (points into
3483 * "name"). Otherwise return NULL.
3484 * This can be used to first search for a script-local function and fall back
3485 * to the global function if not found.
3486 */
3487 char_u *
3488untrans_function_name(char_u *name)
3489{
3490 char_u *p;
3491
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003492 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02003493 {
3494 p = vim_strchr(name, '_');
3495 if (p != NULL)
3496 return p + 1;
3497 }
3498 return NULL;
3499}
3500
3501/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003502 * List functions. When "regmatch" is NULL all of then.
3503 * Otherwise functions matching "regmatch".
3504 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01003505 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003506list_functions(regmatch_T *regmatch)
3507{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003508 int changed = func_hashtab.ht_changed;
3509 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003510 hashitem_T *hi;
3511
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003512 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003513 {
3514 if (!HASHITEM_EMPTY(hi))
3515 {
3516 ufunc_T *fp = HI2UF(hi);
3517
3518 --todo;
3519 if ((fp->uf_flags & FC_DEAD) == 0
3520 && (regmatch == NULL
3521 ? !message_filtered(fp->uf_name)
3522 && !func_name_refcount(fp->uf_name)
3523 : !isdigit(*fp->uf_name)
3524 && vim_regexec(regmatch, fp->uf_name, 0)))
3525 {
3526 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003527 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003528 {
3529 emsg(_("E454: function list was modified"));
3530 return;
3531 }
3532 }
3533 }
3534 }
3535}
3536
3537/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02003538 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02003539 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3540 * the function name.
Bram Moolenaar04b12692020-05-04 23:24:44 +02003541 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02003543 ufunc_T *
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02003544define_function(exarg_T *eap, char_u *name_arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545{
Bram Moolenaar53564f72017-06-24 14:48:11 +02003546 char_u *line_to_free = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003547 int j;
3548 int c;
3549 int saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003550 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003551 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 char_u *p;
3553 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003554 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 char_u *line_arg = NULL;
3556 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003557 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003558 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559 garray_T newlines;
3560 int varargs = FALSE;
3561 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003562 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003563 ufunc_T *fp = NULL;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003564 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565 dictitem_T *v;
3566 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003567 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003569 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003570 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003571 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02003572 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003573
3574 /*
3575 * ":function" without argument: list functions.
3576 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02003577 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578 {
3579 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003580 list_functions(NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003581 eap->nextcmd = check_nextcmd(eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003582 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 }
3584
3585 /*
3586 * ":function /pat": list functions matching pattern.
3587 */
3588 if (*eap->arg == '/')
3589 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003590 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591 if (!eap->skip)
3592 {
3593 regmatch_T regmatch;
3594
3595 c = *p;
3596 *p = NUL;
3597 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3598 *p = c;
3599 if (regmatch.regprog != NULL)
3600 {
3601 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02003602 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603 vim_regfree(regmatch.regprog);
3604 }
3605 }
3606 if (*p == '/')
3607 ++p;
3608 eap->nextcmd = check_nextcmd(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003609 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003610 }
3611
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003612 ga_init(&newargs);
3613 ga_init(&argtypes);
3614 ga_init(&default_args);
3615
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 /*
3617 * Get the function name. There are these situations:
3618 * func normal function name
3619 * "name" == func, "fudi.fd_dict" == NULL
3620 * dict.func new dictionary entry
3621 * "name" == NULL, "fudi.fd_dict" set,
3622 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3623 * dict.func existing dict entry with a Funcref
3624 * "name" == func, "fudi.fd_dict" set,
3625 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3626 * dict.func existing dict entry that's not a Funcref
3627 * "name" == NULL, "fudi.fd_dict" set,
3628 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3629 * s:func script-local function name
3630 * g:func global function name, same as "func"
3631 */
3632 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02003633 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003635 // nested function, argument is (args).
3636 paren = TRUE;
3637 CLEAR_FIELD(fudi);
3638 }
3639 else
3640 {
Bram Moolenaarb6571982021-01-08 22:24:19 +01003641 if (STRNCMP(p, "<lambda>", 8) == 0)
3642 {
3643 p += 8;
3644 (void)getdigits(&p);
3645 name = vim_strnsave(eap->arg, p - eap->arg);
3646 CLEAR_FIELD(fudi);
3647 }
3648 else
3649 name = trans_function_name(&p, &is_global, eap->skip,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003650 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003651 paren = (vim_strchr(p, '(') != NULL);
3652 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003653 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02003654 /*
3655 * Return on an invalid expression in braces, unless the expression
3656 * evaluation has been cancelled due to an aborting error, an
3657 * interrupt, or an exception.
3658 */
3659 if (!aborting())
3660 {
3661 if (!eap->skip && fudi.fd_newkey != NULL)
3662 semsg(_(e_dictkey), fudi.fd_newkey);
3663 vim_free(fudi.fd_newkey);
3664 return NULL;
3665 }
3666 else
3667 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003669 }
3670
Bram Moolenaare38eab22019-12-05 21:50:01 +01003671 // An error in a function call during evaluation of an expression in magic
3672 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003673 saved_did_emsg = did_emsg;
3674 did_emsg = FALSE;
3675
3676 /*
3677 * ":function func" with only function name: list function.
3678 */
3679 if (!paren)
3680 {
3681 if (!ends_excmd(*skipwhite(p)))
3682 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003683 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 goto ret_free;
3685 }
3686 eap->nextcmd = check_nextcmd(p);
3687 if (eap->nextcmd != NULL)
3688 *p = NUL;
3689 if (!eap->skip && !got_int)
3690 {
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003691 fp = find_func(name, is_global, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003692 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
3693 {
3694 char_u *up = untrans_function_name(name);
3695
3696 // With Vim9 script the name was made script-local, if not
3697 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02003698 if (up != NULL)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003699 fp = find_func(up, FALSE, NULL);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003700 }
3701
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702 if (fp != NULL)
3703 {
3704 list_func_head(fp, TRUE);
3705 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
3706 {
3707 if (FUNCLINE(fp, j) == NULL)
3708 continue;
3709 msg_putchar('\n');
3710 msg_outnum((long)(j + 1));
3711 if (j < 9)
3712 msg_putchar(' ');
3713 if (j < 99)
3714 msg_putchar(' ');
3715 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003716 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003717 ui_breakcheck();
3718 }
3719 if (!got_int)
3720 {
3721 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003722 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003723 msg_puts(" enddef");
3724 else
3725 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 }
3727 }
3728 else
Bram Moolenaara26b9702020-04-18 19:53:28 +02003729 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003730 }
3731 goto ret_free;
3732 }
3733
3734 /*
3735 * ":function name(arg1, arg2)" Define function.
3736 */
3737 p = skipwhite(p);
3738 if (*p != '(')
3739 {
3740 if (!eap->skip)
3741 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003742 semsg(_("E124: Missing '(': %s"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003743 goto ret_free;
3744 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003745 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003746 if (vim_strchr(p, '(') != NULL)
3747 p = vim_strchr(p, '(');
3748 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003749
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003750 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
3751 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01003752 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01003753 goto ret_free;
3754 }
3755
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02003756 // In Vim9 script only global functions can be redefined.
3757 if (vim9script && eap->forceit && !is_global)
3758 {
3759 emsg(_(e_nobang));
3760 goto ret_free;
3761 }
3762
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003763 ga_init2(&newlines, (int)sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764
Bram Moolenaar04b12692020-05-04 23:24:44 +02003765 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003767 // Check the name of the function. Unless it's a dictionary function
3768 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003769 if (name != NULL)
3770 arg = name;
3771 else
3772 arg = fudi.fd_newkey;
3773 if (arg != NULL && (fudi.fd_di == NULL
3774 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
3775 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
3776 {
3777 if (*arg == K_SPECIAL)
3778 j = 3;
3779 else
3780 j = 0;
3781 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
3782 : eval_isnamec(arg[j])))
3783 ++j;
3784 if (arg[j] != NUL)
3785 emsg_funcname((char *)e_invarg2, arg);
3786 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003787 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003789 emsg(_("E862: Cannot use g: here"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 }
3791
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003792 // This may get more lines and make the pointers into the first line
3793 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01003794 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003795 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01003796 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01003797 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003798 eap, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003799 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01003800 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003802 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003803 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003804 // find the return type: :def Func(): type
3805 if (*p == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003807 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02003808 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003809 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003810 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003811 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01003812 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003813 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003814 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003815 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003816 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003817 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02003818 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02003819 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02003821 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003823 else
3824 // find extra arguments "range", "dict", "abort" and "closure"
3825 for (;;)
3826 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01003827 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003828 p = skipwhite(p);
3829 if (STRNCMP(p, "range", 5) == 0)
3830 {
3831 flags |= FC_RANGE;
3832 p += 5;
3833 }
3834 else if (STRNCMP(p, "dict", 4) == 0)
3835 {
3836 flags |= FC_DICT;
3837 p += 4;
3838 }
3839 else if (STRNCMP(p, "abort", 5) == 0)
3840 {
3841 flags |= FC_ABORT;
3842 p += 5;
3843 }
3844 else if (STRNCMP(p, "closure", 7) == 0)
3845 {
3846 flags |= FC_CLOSURE;
3847 p += 7;
3848 if (current_funccal == NULL)
3849 {
3850 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
3851 name == NULL ? (char_u *)"" : name);
3852 goto erret;
3853 }
3854 }
3855 else
3856 break;
3857 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858
Bram Moolenaare38eab22019-12-05 21:50:01 +01003859 // When there is a line break use what follows for the function body.
3860 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003861 if (*p == '\n')
3862 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02003863 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02003864 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
3865 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01003866 && !(VIM_ISWHITE(*whitep) && *p == '#'
3867 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02003868 && !eap->skip
3869 && !did_emsg)
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02003870 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871
3872 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003873 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
3874 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003875 */
3876 if (KeyTyped)
3877 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003878 // Check if the function already exists, don't let the user type the
3879 // whole function before telling him it doesn't work! For a script we
3880 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003881 if (!eap->skip && !eap->forceit)
3882 {
3883 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003884 emsg(_(e_funcdict));
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003885 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003886 emsg_funcname(e_funcexts, name);
3887 }
3888
3889 if (!eap->skip && did_emsg)
3890 goto erret;
3891
Bram Moolenaare38eab22019-12-05 21:50:01 +01003892 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003893 cmdline_row = msg_row;
3894 }
3895
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003896 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003897 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02003898
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003899 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003900 goto erret;
3901
3902 /*
3903 * If there are no errors, add the function
3904 */
3905 if (fudi.fd_dict == NULL)
3906 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003907 hashtab_T *ht;
3908
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003909 v = find_var(name, &ht, TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003910 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
3911 {
3912 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
3913 name);
3914 goto erret;
3915 }
3916
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003917 fp = find_func_even_dead(name, is_global, NULL);
Bram Moolenaareef21022020-08-01 22:16:43 +02003918 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003920 char_u *uname = untrans_function_name(name);
3921
3922 import = find_imported(uname == NULL ? name : uname, 0, NULL);
3923 }
3924
3925 if (fp != NULL || import != NULL)
3926 {
3927 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003928
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003929 // Function can be replaced with "function!" and when sourcing the
3930 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02003931 // A name that is used by an import can not be overruled.
3932 if (import != NULL
3933 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003934 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02003935 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 {
Bram Moolenaareef21022020-08-01 22:16:43 +02003937 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02003938 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02003939 else
3940 emsg_funcname(e_funcexts, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 goto erret;
3942 }
3943 if (fp->uf_calls > 0)
3944 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01003945 emsg_funcname(
3946 N_("E127: Cannot redefine function %s: It is in use"),
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003947 name);
3948 goto erret;
3949 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003950 if (fp->uf_refcount > 1)
3951 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003952 // This function is referenced somewhere, don't redefine it but
3953 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003954 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003955 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003956 fp = NULL;
3957 overwrite = TRUE;
3958 }
3959 else
3960 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003961 char_u *exp_name = fp->uf_name_exp;
3962
3963 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01003964 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003965 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003966 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01003967 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003968 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02003969#ifdef FEAT_PROFILE
3970 fp->uf_profiling = FALSE;
3971 fp->uf_prof_initialized = FALSE;
3972#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003973 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003974 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003975 }
3976 }
3977 else
3978 {
3979 char numbuf[20];
3980
3981 fp = NULL;
3982 if (fudi.fd_newkey == NULL && !eap->forceit)
3983 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003984 emsg(_(e_funcdict));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 goto erret;
3986 }
3987 if (fudi.fd_di == NULL)
3988 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003989 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02003990 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991 goto erret;
3992 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003993 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02003994 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003995 goto erret;
3996
Bram Moolenaare38eab22019-12-05 21:50:01 +01003997 // Give the function a sequential number. Can only be used with a
3998 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003999 vim_free(name);
4000 sprintf(numbuf, "%d", ++func_nr);
4001 name = vim_strsave((char_u *)numbuf);
4002 if (name == NULL)
4003 goto erret;
4004 }
4005
4006 if (fp == NULL)
4007 {
4008 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4009 {
4010 int slen, plen;
4011 char_u *scriptname;
4012
Bram Moolenaare38eab22019-12-05 21:50:01 +01004013 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004015 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004016 {
4017 scriptname = autoload_name(name);
4018 if (scriptname != NULL)
4019 {
4020 p = vim_strchr(scriptname, '/');
4021 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004022 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004024 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 j = OK;
4026 vim_free(scriptname);
4027 }
4028 }
4029 if (j == FAIL)
4030 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004031 semsg(_("E746: Function name does not match script file name: %s"), name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 goto erret;
4033 }
4034 }
4035
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004036 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 if (fp == NULL)
4038 goto erret;
4039
4040 if (fudi.fd_dict != NULL)
4041 {
4042 if (fudi.fd_di == NULL)
4043 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004044 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4046 if (fudi.fd_di == NULL)
4047 {
4048 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004049 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004050 goto erret;
4051 }
4052 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4053 {
4054 vim_free(fudi.fd_di);
4055 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004056 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 goto erret;
4058 }
4059 }
4060 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004061 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 clear_tv(&fudi.fd_di->di_tv);
4063 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004064 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004065
Bram Moolenaare38eab22019-12-05 21:50:01 +01004066 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004067 flags |= FC_DICT;
4068 }
4069
Bram Moolenaare38eab22019-12-05 21:50:01 +01004070 // insert the new function in the function list
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004071 set_ufunc_name(fp, name);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004072 if (overwrite)
4073 {
4074 hi = hash_find(&func_hashtab, name);
4075 hi->hi_key = UF2HIKEY(fp);
4076 }
4077 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004078 {
4079 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004080 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004081 goto erret;
4082 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004083 fp->uf_refcount = 1;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004084 }
4085 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004086 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004087 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004088 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004089
4090 if (eap->cmdidx == CMD_def)
4091 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004092 int lnum_save = SOURCING_LNUM;
4093 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004094
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004095 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004096
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004097 // error messages are for the first function line
4098 SOURCING_LNUM = sourcing_lnum_top;
4099
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004100 if (cstack != NULL && cstack->cs_idx >= 0)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004101 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004102 int count = cstack->cs_idx + 1;
4103 int i;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004104
4105 // The block context may be needed for script variables declared in
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004106 // a block that is visible now but not when the function is called
4107 // later.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004108 fp->uf_block_ids = ALLOC_MULT(int, count);
4109 if (fp->uf_block_ids != NULL)
4110 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004111 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004112 sizeof(int) * count);
4113 fp->uf_block_depth = count;
4114 }
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004115
4116 // Set flag in each block to indicate a function was defined. This
4117 // is used to keep the variable when leaving the block, see
4118 // hide_script_var().
4119 for (i = 0; i <= cstack->cs_idx; ++i)
4120 cstack->cs_flags[i] |= CSF_FUNC_DEF;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004121 }
4122
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004123 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004124 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004125 SOURCING_LNUM = lnum_save;
4126 goto errret_2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004127 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004128 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004129
4130 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004131 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004132 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004133 SOURCING_LNUM = lnum_save;
4134 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004136 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004137 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004138 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004139 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004141 fp->uf_lines = newlines;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004142 if ((flags & FC_CLOSURE) != 0)
4143 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004144 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004145 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004146 }
4147 else
4148 fp->uf_scoped = NULL;
4149
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004150#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004151 if (prof_def_func())
4152 func_do_profile(fp);
4153#endif
4154 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004155 if (sandbox)
4156 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004157 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004158 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004159 fp->uf_flags = flags;
4160 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004161 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004162 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004163 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004164 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004165 if (is_export)
4166 {
4167 fp->uf_flags |= FC_EXPORT;
4168 // let ex_export() know the export worked.
4169 is_export = FALSE;
4170 }
4171
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004172 if (eap->cmdidx == CMD_def)
4173 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004174 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4175 // :func does not use Vim9 script syntax, even in a Vim9 script file
4176 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004177
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004178 goto ret_free;
4179
4180erret:
4181 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004182 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004183 if (fp != NULL)
4184 {
4185 ga_init(&fp->uf_args);
4186 ga_init(&fp->uf_def_args);
4187 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004188errret_2:
4189 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004190 if (fp != NULL)
4191 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004192ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004193 ga_clear_strings(&argtypes);
Bram Moolenaar53564f72017-06-24 14:48:11 +02004194 vim_free(line_to_free);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004196 if (name != name_arg)
4197 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004198 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004199 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004200
4201 return fp;
4202}
4203
4204/*
4205 * ":function"
4206 */
4207 void
4208ex_function(exarg_T *eap)
4209{
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004210 (void)define_function(eap, NULL);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004211}
4212
4213/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004214 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarb2049902021-01-24 12:53:53 +01004215 * be compiled. Except dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02004216 */
4217 void
4218ex_defcompile(exarg_T *eap UNUSED)
4219{
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004220 long todo = (long)func_hashtab.ht_used;
4221 int changed = func_hashtab.ht_changed;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004222 hashitem_T *hi;
4223 ufunc_T *ufunc;
4224
4225 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4226 {
4227 if (!HASHITEM_EMPTY(hi))
4228 {
4229 --todo;
4230 ufunc = HI2UF(hi);
4231 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
Bram Moolenaar96f8f492020-09-09 17:08:51 +02004232 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4233 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004234 {
Bram Moolenaardc167462021-02-20 20:26:16 +01004235 (void)compile_def_function(ufunc, FALSE, FALSE, NULL);
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004236
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004237 if (func_hashtab.ht_changed != changed)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004238 {
Bram Moolenaar7ce85be2020-07-14 15:01:05 +02004239 // a function has been added or removed, need to start over
4240 todo = (long)func_hashtab.ht_used;
4241 changed = func_hashtab.ht_changed;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004242 hi = func_hashtab.ht_array;
Bram Moolenaar285b1892020-05-26 11:37:26 +02004243 --hi;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02004244 }
4245 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004246 }
4247 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248}
4249
4250/*
4251 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4252 * Return 2 if "p" starts with "s:".
4253 * Return 0 otherwise.
4254 */
4255 int
4256eval_fname_script(char_u *p)
4257{
Bram Moolenaare38eab22019-12-05 21:50:01 +01004258 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4259 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4261 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4262 return 5;
4263 if (p[0] == 's' && p[1] == ':')
4264 return 2;
4265 return 0;
4266}
4267
4268 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004269translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004270{
4271 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02004272 return has_internal_func(name);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004273 return find_func(name, is_global, NULL) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004274}
4275
4276/*
4277 * Return TRUE when "ufunc" has old-style "..." varargs
4278 * or named varargs "...name: type".
4279 */
4280 int
4281has_varargs(ufunc_T *ufunc)
4282{
4283 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284}
4285
4286/*
4287 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004288 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 */
4290 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004291function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292{
4293 char_u *nm = name;
4294 char_u *p;
4295 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004296 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004297 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004299 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4300 if (no_deref)
4301 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004302 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 nm = skipwhite(nm);
4304
Bram Moolenaare38eab22019-12-05 21:50:01 +01004305 // Only accept "funcname", "funcname ", "funcname (..." and
4306 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004308 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 vim_free(p);
4310 return n;
4311}
4312
Bram Moolenaar113e1072019-01-20 15:30:40 +01004313#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 char_u *
4315get_expanded_name(char_u *name, int check)
4316{
4317 char_u *nm = name;
4318 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004319 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004320
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004321 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004322 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004323
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004324 if (p != NULL && *nm == NUL
4325 && (!check || translated_function_exists(p, is_global)))
4326 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327
4328 vim_free(p);
4329 return NULL;
4330}
Bram Moolenaar113e1072019-01-20 15:30:40 +01004331#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004333/*
4334 * Function given to ExpandGeneric() to obtain the list of user defined
4335 * function names.
4336 */
4337 char_u *
4338get_user_func_name(expand_T *xp, int idx)
4339{
4340 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004341 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342 static hashitem_T *hi;
4343 ufunc_T *fp;
4344
4345 if (idx == 0)
4346 {
4347 done = 0;
4348 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004349 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004350 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004351 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 {
4353 if (done++ > 0)
4354 ++hi;
4355 while (HASHITEM_EMPTY(hi))
4356 ++hi;
4357 fp = HI2UF(hi);
4358
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004359 // don't show dead, dict and lambda functions
4360 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02004361 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004362 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004363
4364 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004365 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004366
4367 cat_func_name(IObuff, fp);
4368 if (xp->xp_context != EXPAND_USER_FUNC)
4369 {
4370 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004371 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004372 STRCAT(IObuff, ")");
4373 }
4374 return IObuff;
4375 }
4376 return NULL;
4377}
4378
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004379/*
4380 * ":delfunction {name}"
4381 */
4382 void
4383ex_delfunction(exarg_T *eap)
4384{
4385 ufunc_T *fp = NULL;
4386 char_u *p;
4387 char_u *name;
4388 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004389 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390
4391 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004392 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4393 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004394 vim_free(fudi.fd_newkey);
4395 if (name == NULL)
4396 {
4397 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004398 emsg(_(e_funcref));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004399 return;
4400 }
4401 if (!ends_excmd(*skipwhite(p)))
4402 {
4403 vim_free(name);
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004404 semsg(_(e_trailing_arg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004405 return;
4406 }
4407 eap->nextcmd = check_nextcmd(p);
4408 if (eap->nextcmd != NULL)
4409 *p = NUL;
4410
4411 if (!eap->skip)
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004412 fp = find_func(name, is_global, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 vim_free(name);
4414
4415 if (!eap->skip)
4416 {
4417 if (fp == NULL)
4418 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02004419 if (!eap->forceit)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004420 semsg(_(e_nofunc), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004421 return;
4422 }
4423 if (fp->uf_calls > 0)
4424 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004425 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004426 return;
4427 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004428 if (fp->uf_flags & FC_VIM9)
4429 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004430 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004431 return;
4432 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004433
4434 if (fudi.fd_dict != NULL)
4435 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004436 // Delete the dict item that refers to the function, it will
4437 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004438 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4439 }
4440 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004441 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004442 // A normal function (not a numbered function or lambda) has a
4443 // refcount of 1 for the entry in the hashtable. When deleting
4444 // it and the refcount is more than one, it should be kept.
4445 // A numbered function and lambda should be kept if the refcount is
4446 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004447 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004448 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004449 // Function is still referenced somewhere. Don't free it but
4450 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004451 if (func_remove(fp))
4452 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004453 }
4454 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004455 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004456 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 }
4458}
4459
4460/*
4461 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004462 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004463 */
4464 void
4465func_unref(char_u *name)
4466{
Bram Moolenaar97baee82016-07-26 20:46:08 +02004467 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004468
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004469 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004471 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004472 if (fp == NULL && isdigit(*name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004473 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004474#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004475 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004476#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01004477 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004479 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004480}
4481
4482/*
4483 * Unreference a Function: decrement the reference count and free it when it
4484 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004485 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004486 */
4487 void
4488func_ptr_unref(ufunc_T *fp)
4489{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01004490 if (fp != NULL && (--fp->uf_refcount <= 0
4491 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4492 && fp->uf_partial->pt_refcount <= 1
4493 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02004494 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004495 // Only delete it when it's not being used. Otherwise it's done
4496 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02004497 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01004498 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004499 }
4500}
4501
4502/*
4503 * Count a reference to a Function.
4504 */
4505 void
4506func_ref(char_u *name)
4507{
4508 ufunc_T *fp;
4509
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004510 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 return;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004512 fp = find_func(name, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004513 if (fp != NULL)
4514 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004515 else if (isdigit(*name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01004516 // Only give an error for a numbered function.
4517 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01004518 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004519}
4520
4521/*
4522 * Count a reference to a Function.
4523 */
4524 void
4525func_ptr_ref(ufunc_T *fp)
4526{
4527 if (fp != NULL)
4528 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004529}
4530
4531/*
4532 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4533 * referenced from anywhere that is in use.
4534 */
4535 static int
4536can_free_funccal(funccall_T *fc, int copyID)
4537{
4538 return (fc->l_varlist.lv_copyID != copyID
4539 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02004540 && fc->l_avars.dv_copyID != copyID
4541 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004542}
4543
4544/*
4545 * ":return [expr]"
4546 */
4547 void
4548ex_return(exarg_T *eap)
4549{
4550 char_u *arg = eap->arg;
4551 typval_T rettv;
4552 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004553 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554
4555 if (current_funccal == NULL)
4556 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004557 emsg(_("E133: :return not inside a function"));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004558 return;
4559 }
4560
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02004561 CLEAR_FIELD(evalarg);
4562 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4563
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564 if (eap->skip)
4565 ++emsg_skip;
4566
4567 eap->nextcmd = NULL;
4568 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02004569 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570 {
4571 if (!eap->skip)
4572 returning = do_return(eap, FALSE, TRUE, &rettv);
4573 else
4574 clear_tv(&rettv);
4575 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004576 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 else if (!eap->skip)
4578 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004579 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01004580 update_force_abort();
4581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 /*
4583 * Return unless the expression evaluation has been cancelled due to an
4584 * aborting error, an interrupt, or an exception.
4585 */
4586 if (!aborting())
4587 returning = do_return(eap, FALSE, TRUE, NULL);
4588 }
4589
Bram Moolenaare38eab22019-12-05 21:50:01 +01004590 // When skipping or the return gets pending, advance to the next command
4591 // in this line (!returning). Otherwise, ignore the rest of the line.
4592 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 if (returning)
4594 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004595 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 eap->nextcmd = check_nextcmd(arg);
4597
4598 if (eap->skip)
4599 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02004600 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004601}
4602
4603/*
4604 * ":1,25call func(arg1, arg2)" function call.
4605 */
4606 void
4607ex_call(exarg_T *eap)
4608{
4609 char_u *arg = eap->arg;
4610 char_u *startarg;
4611 char_u *name;
4612 char_u *tofree;
4613 int len;
4614 typval_T rettv;
4615 linenr_T lnum;
4616 int doesrange;
4617 int failed = FALSE;
4618 funcdict_T fudi;
4619 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004620 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004621 type_T *type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622
Bram Moolenaare6b53242020-07-01 17:28:33 +02004623 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004624 if (eap->skip)
4625 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004626 // trans_function_name() doesn't work well when skipping, use eval0()
4627 // instead to skip to any following command, e.g. for:
4628 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004630 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004631 clear_tv(&rettv);
4632 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004633 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004634 return;
4635 }
4636
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004637 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4638 &fudi, &partial, in_vim9script() ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 if (fudi.fd_newkey != NULL)
4640 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004641 // Still need to give an error message for missing key.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004642 semsg(_(e_dictkey), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004643 vim_free(fudi.fd_newkey);
4644 }
4645 if (tofree == NULL)
4646 return;
4647
Bram Moolenaare38eab22019-12-05 21:50:01 +01004648 // Increase refcount on dictionary, it could get deleted when evaluating
4649 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004650 if (fudi.fd_dict != NULL)
4651 ++fudi.fd_dict->dv_refcount;
4652
Bram Moolenaare38eab22019-12-05 21:50:01 +01004653 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4654 // contents. For VAR_PARTIAL get its partial, unless we already have one
4655 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004656 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004657 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4658 in_vim9script() && type == NULL ? &type : NULL, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004659
Bram Moolenaare38eab22019-12-05 21:50:01 +01004660 // Skip white space to allow ":call func ()". Not good, but required for
4661 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004662 startarg = skipwhite(arg);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004663 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004664
4665 if (*startarg != '(')
4666 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004667 semsg(_(e_missing_paren), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668 goto end;
4669 }
4670
4671 /*
4672 * When skipping, evaluate the function once, to find the end of the
4673 * arguments.
4674 * When the function takes a range, this is discovered after the first
4675 * call, and the loop is broken.
4676 */
4677 if (eap->skip)
4678 {
4679 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004680 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 }
4682 else
4683 lnum = eap->line1;
4684 for ( ; lnum <= eap->line2; ++lnum)
4685 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004686 funcexe_T funcexe;
4687
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004688 if (!eap->skip && eap->addr_count > 0)
4689 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004690 if (lnum > curbuf->b_ml.ml_line_count)
4691 {
4692 // If the function deleted lines or switched to another buffer
4693 // the line number may become invalid.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004694 emsg(_(e_invrange));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01004695 break;
4696 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697 curwin->w_cursor.lnum = lnum;
4698 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004700 }
4701 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004702
Bram Moolenaara80faa82020-04-12 19:37:17 +02004703 CLEAR_FIELD(funcexe);
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02004704 funcexe.firstline = eap->line1;
4705 funcexe.lastline = eap->line2;
4706 funcexe.doesrange = &doesrange;
4707 funcexe.evaluate = !eap->skip;
4708 funcexe.partial = partial;
4709 funcexe.selfdict = fudi.fd_dict;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004710 funcexe.check_type = type;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004711 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004712 {
4713 failed = TRUE;
4714 break;
4715 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01004716 if (has_watchexpr())
4717 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004718
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02004719 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaare40fbc22020-06-27 18:06:45 +02004720 if (handle_subscript(&arg, &rettv,
4721 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722 {
4723 failed = TRUE;
4724 break;
4725 }
4726
4727 clear_tv(&rettv);
4728 if (doesrange || eap->skip)
4729 break;
4730
Bram Moolenaare38eab22019-12-05 21:50:01 +01004731 // Stop when immediately aborting on error, or when an interrupt
4732 // occurred or an exception was thrown but not caught.
4733 // get_func_tv() returned OK, so that the check for trailing
4734 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 if (aborting())
4736 break;
4737 }
4738 if (eap->skip)
4739 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02004740 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004741
Bram Moolenaare51bb172020-02-16 19:42:23 +01004742 // When inside :try we need to check for following "| catch".
4743 if (!failed || eap->cstack->cs_trylevel > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004745 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02004746 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004747 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004748 {
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004749 if (!failed)
4750 {
4751 emsg_severe = TRUE;
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02004752 semsg(_(e_trailing_arg), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01004753 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 }
4755 else
4756 eap->nextcmd = check_nextcmd(arg);
4757 }
4758
4759end:
4760 dict_unref(fudi.fd_dict);
4761 vim_free(tofree);
4762}
4763
4764/*
4765 * Return from a function. Possibly makes the return pending. Also called
4766 * for a pending return at the ":endtry" or after returning from an extra
4767 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
4768 * when called due to a ":return" command. "rettv" may point to a typval_T
4769 * with the return rettv. Returns TRUE when the return can be carried out,
4770 * FALSE when the return gets pending.
4771 */
4772 int
4773do_return(
4774 exarg_T *eap,
4775 int reanimate,
4776 int is_cmd,
4777 void *rettv)
4778{
4779 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01004780 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781
4782 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004783 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004784 current_funccal->returned = FALSE;
4785
4786 /*
4787 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4788 * not in its finally clause (which then is to be executed next) is found.
4789 * In this case, make the ":return" pending for execution at the ":endtry".
4790 * Otherwise, return normally.
4791 */
4792 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4793 if (idx >= 0)
4794 {
4795 cstack->cs_pending[idx] = CSTP_RETURN;
4796
4797 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004798 // A pending return again gets pending. "rettv" points to an
4799 // allocated variable with the rettv of the original ":return"'s
4800 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004801 cstack->cs_rettv[idx] = rettv;
4802 else
4803 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004804 // When undoing a return in order to make it pending, get the stored
4805 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004806 if (reanimate)
4807 rettv = current_funccal->rettv;
4808
4809 if (rettv != NULL)
4810 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004811 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
4813 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
4814 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004815 emsg(_(e_outofmem));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004816 }
4817 else
4818 cstack->cs_rettv[idx] = NULL;
4819
4820 if (reanimate)
4821 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004822 // The pending return value could be overwritten by a ":return"
4823 // without argument in a finally clause; reset the default
4824 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004825 current_funccal->rettv->v_type = VAR_NUMBER;
4826 current_funccal->rettv->vval.v_number = 0;
4827 }
4828 }
4829 report_make_pending(CSTP_RETURN, rettv);
4830 }
4831 else
4832 {
4833 current_funccal->returned = TRUE;
4834
Bram Moolenaare38eab22019-12-05 21:50:01 +01004835 // If the return is carried out now, store the return value. For
4836 // a return immediately after reanimation, the value is already
4837 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 if (!reanimate && rettv != NULL)
4839 {
4840 clear_tv(current_funccal->rettv);
4841 *current_funccal->rettv = *(typval_T *)rettv;
4842 if (!is_cmd)
4843 vim_free(rettv);
4844 }
4845 }
4846
4847 return idx < 0;
4848}
4849
4850/*
4851 * Free the variable with a pending return value.
4852 */
4853 void
4854discard_pending_return(void *rettv)
4855{
4856 free_tv((typval_T *)rettv);
4857}
4858
4859/*
4860 * Generate a return command for producing the value of "rettv". The result
4861 * is an allocated string. Used by report_pending() for verbose messages.
4862 */
4863 char_u *
4864get_return_cmd(void *rettv)
4865{
4866 char_u *s = NULL;
4867 char_u *tofree = NULL;
4868 char_u numbuf[NUMBUFLEN];
4869
4870 if (rettv != NULL)
4871 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
4872 if (s == NULL)
4873 s = (char_u *)"";
4874
4875 STRCPY(IObuff, ":return ");
4876 STRNCPY(IObuff + 8, s, IOSIZE - 8);
4877 if (STRLEN(s) + 8 >= IOSIZE)
4878 STRCPY(IObuff + IOSIZE - 4, "...");
4879 vim_free(tofree);
4880 return vim_strsave(IObuff);
4881}
4882
4883/*
4884 * Get next function line.
4885 * Called by do_cmdline() to get the next line.
4886 * Returns allocated string, or NULL for end of function.
4887 */
4888 char_u *
4889get_func_line(
4890 int c UNUSED,
4891 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02004892 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02004893 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004894{
4895 funccall_T *fcp = (funccall_T *)cookie;
4896 ufunc_T *fp = fcp->func;
4897 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004898 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004899
Bram Moolenaare38eab22019-12-05 21:50:01 +01004900 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004901 if (fcp->dbg_tick != debug_tick)
4902 {
4903 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004904 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 fcp->dbg_tick = debug_tick;
4906 }
4907#ifdef FEAT_PROFILE
4908 if (do_profiling == PROF_YES)
4909 func_line_end(cookie);
4910#endif
4911
4912 gap = &fp->uf_lines;
4913 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4914 || fcp->returned)
4915 retval = NULL;
4916 else
4917 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004918 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004919 while (fcp->linenr < gap->ga_len
4920 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
4921 ++fcp->linenr;
4922 if (fcp->linenr >= gap->ga_len)
4923 retval = NULL;
4924 else
4925 {
4926 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004927 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004928#ifdef FEAT_PROFILE
4929 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004930 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931#endif
4932 }
4933 }
4934
Bram Moolenaare38eab22019-12-05 21:50:01 +01004935 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004936 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004938 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004939 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004940 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004941 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004942 fcp->dbg_tick = debug_tick;
4943 }
4944
4945 return retval;
4946}
4947
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004948/*
4949 * Return TRUE if the currently active function should be ended, because a
4950 * return was encountered or an error occurred. Used inside a ":while".
4951 */
4952 int
4953func_has_ended(void *cookie)
4954{
4955 funccall_T *fcp = (funccall_T *)cookie;
4956
Bram Moolenaare38eab22019-12-05 21:50:01 +01004957 // Ignore the "abort" flag if the abortion behavior has been changed due to
4958 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004959 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
4960 || fcp->returned);
4961}
4962
4963/*
4964 * return TRUE if cookie indicates a function which "abort"s on errors.
4965 */
4966 int
4967func_has_abort(
4968 void *cookie)
4969{
4970 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
4971}
4972
4973
4974/*
4975 * Turn "dict.Func" into a partial for "Func" bound to "dict".
4976 * Don't do this when "Func" is already a partial that was bound
4977 * explicitly (pt_auto is FALSE).
4978 * Changes "rettv" in-place.
4979 * Returns the updated "selfdict_in".
4980 */
4981 dict_T *
4982make_partial(dict_T *selfdict_in, typval_T *rettv)
4983{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004984 char_u *fname;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 char_u *tofree = NULL;
4986 ufunc_T *fp;
4987 char_u fname_buf[FLEN_FIXED + 1];
4988 int error;
4989 dict_T *selfdict = selfdict_in;
4990
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004991 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
4992 fp = rettv->vval.v_partial->pt_func;
4993 else
4994 {
4995 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
4996 : rettv->vval.v_partial->pt_name;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004997 // Translate "s:func" to the stored function name.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004998 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004999 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005000 vim_free(tofree);
5001 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005002
5003 if (fp != NULL && (fp->uf_flags & FC_DICT))
5004 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005005 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005006
5007 if (pt != NULL)
5008 {
5009 pt->pt_refcount = 1;
5010 pt->pt_dict = selfdict;
5011 pt->pt_auto = TRUE;
5012 selfdict = NULL;
5013 if (rettv->v_type == VAR_FUNC)
5014 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005015 // Just a function: Take over the function name and use
5016 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005017 pt->pt_name = rettv->vval.v_string;
5018 }
5019 else
5020 {
5021 partial_T *ret_pt = rettv->vval.v_partial;
5022 int i;
5023
Bram Moolenaare38eab22019-12-05 21:50:01 +01005024 // Partial: copy the function name, use selfdict and copy
5025 // args. Can't take over name or args, the partial might
5026 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005027 if (ret_pt->pt_name != NULL)
5028 {
5029 pt->pt_name = vim_strsave(ret_pt->pt_name);
5030 func_ref(pt->pt_name);
5031 }
5032 else
5033 {
5034 pt->pt_func = ret_pt->pt_func;
5035 func_ptr_ref(pt->pt_func);
5036 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005037 if (ret_pt->pt_argc > 0)
5038 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005039 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005040 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005041 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005042 pt->pt_argc = 0;
5043 else
5044 {
5045 pt->pt_argc = ret_pt->pt_argc;
5046 for (i = 0; i < pt->pt_argc; i++)
5047 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5048 }
5049 }
5050 partial_unref(ret_pt);
5051 }
5052 rettv->v_type = VAR_PARTIAL;
5053 rettv->vval.v_partial = pt;
5054 }
5055 }
5056 return selfdict;
5057}
5058
5059/*
5060 * Return the name of the executed function.
5061 */
5062 char_u *
5063func_name(void *cookie)
5064{
5065 return ((funccall_T *)cookie)->func->uf_name;
5066}
5067
5068/*
5069 * Return the address holding the next breakpoint line for a funccall cookie.
5070 */
5071 linenr_T *
5072func_breakpoint(void *cookie)
5073{
5074 return &((funccall_T *)cookie)->breakpoint;
5075}
5076
5077/*
5078 * Return the address holding the debug tick for a funccall cookie.
5079 */
5080 int *
5081func_dbg_tick(void *cookie)
5082{
5083 return &((funccall_T *)cookie)->dbg_tick;
5084}
5085
5086/*
5087 * Return the nesting level for a funccall cookie.
5088 */
5089 int
5090func_level(void *cookie)
5091{
5092 return ((funccall_T *)cookie)->level;
5093}
5094
5095/*
5096 * Return TRUE when a function was ended by a ":return" command.
5097 */
5098 int
5099current_func_returned(void)
5100{
5101 return current_funccal->returned;
5102}
5103
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005104 int
5105free_unref_funccal(int copyID, int testing)
5106{
5107 int did_free = FALSE;
5108 int did_free_funccal = FALSE;
5109 funccall_T *fc, **pfc;
5110
5111 for (pfc = &previous_funccal; *pfc != NULL; )
5112 {
5113 if (can_free_funccal(*pfc, copyID))
5114 {
5115 fc = *pfc;
5116 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01005117 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005118 did_free = TRUE;
5119 did_free_funccal = TRUE;
5120 }
5121 else
5122 pfc = &(*pfc)->caller;
5123 }
5124 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005125 // When a funccal was freed some more items might be garbage
5126 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005127 (void)garbage_collect(testing);
5128
5129 return did_free;
5130}
5131
5132/*
Bram Moolenaarba209902016-08-24 22:06:38 +02005133 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005134 */
5135 static funccall_T *
5136get_funccal(void)
5137{
5138 int i;
5139 funccall_T *funccal;
5140 funccall_T *temp_funccal;
5141
5142 funccal = current_funccal;
5143 if (debug_backtrace_level > 0)
5144 {
5145 for (i = 0; i < debug_backtrace_level; i++)
5146 {
5147 temp_funccal = funccal->caller;
5148 if (temp_funccal)
5149 funccal = temp_funccal;
5150 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005151 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005152 debug_backtrace_level = i;
5153 }
5154 }
5155 return funccal;
5156}
5157
5158/*
5159 * Return the hashtable used for local variables in the current funccal.
5160 * Return NULL if there is no current funccal.
5161 */
5162 hashtab_T *
5163get_funccal_local_ht()
5164{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005165 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005166 return NULL;
5167 return &get_funccal()->l_vars.dv_hashtab;
5168}
5169
5170/*
5171 * Return the l: scope variable.
5172 * Return NULL if there is no current funccal.
5173 */
5174 dictitem_T *
5175get_funccal_local_var()
5176{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005177 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005178 return NULL;
5179 return &get_funccal()->l_vars_var;
5180}
5181
5182/*
5183 * Return the hashtable used for argument in the current funccal.
5184 * Return NULL if there is no current funccal.
5185 */
5186 hashtab_T *
5187get_funccal_args_ht()
5188{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005189 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005190 return NULL;
5191 return &get_funccal()->l_avars.dv_hashtab;
5192}
5193
5194/*
5195 * Return the a: scope variable.
5196 * Return NULL if there is no current funccal.
5197 */
5198 dictitem_T *
5199get_funccal_args_var()
5200{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005201 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005202 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01005203 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005204}
5205
5206/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207 * List function variables, if there is a function.
5208 */
5209 void
5210list_func_vars(int *first)
5211{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005212 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005213 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01005214 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005215}
5216
5217/*
5218 * If "ht" is the hashtable for local variables in the current funccal, return
5219 * the dict that contains it.
5220 * Otherwise return NULL.
5221 */
5222 dict_T *
5223get_current_funccal_dict(hashtab_T *ht)
5224{
5225 if (current_funccal != NULL
5226 && ht == &current_funccal->l_vars.dv_hashtab)
5227 return &current_funccal->l_vars;
5228 return NULL;
5229}
5230
5231/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005232 * Search hashitem in parent scope.
5233 */
5234 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005235find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005236{
5237 funccall_T *old_current_funccal = current_funccal;
5238 hashtab_T *ht;
5239 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005240 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005241
5242 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5243 return NULL;
5244
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02005245 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005246 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02005247 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005248 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005249 ht = find_var_ht(name, &varname);
5250 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02005251 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005252 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02005253 if (!HASHITEM_EMPTY(hi))
5254 {
5255 *pht = ht;
5256 break;
5257 }
5258 }
5259 if (current_funccal == current_funccal->func->uf_scoped)
5260 break;
5261 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005262 }
5263 current_funccal = old_current_funccal;
5264
5265 return hi;
5266}
5267
5268/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005269 * Search variable in parent scope.
5270 */
5271 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005272find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005273{
5274 dictitem_T *v = NULL;
5275 funccall_T *old_current_funccal = current_funccal;
5276 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005277 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005278
5279 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5280 return NULL;
5281
Bram Moolenaare38eab22019-12-05 21:50:01 +01005282 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005283 current_funccal = current_funccal->func->uf_scoped;
5284 while (current_funccal)
5285 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005286 ht = find_var_ht(name, &varname);
5287 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005288 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02005289 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005290 if (v != NULL)
5291 break;
5292 }
5293 if (current_funccal == current_funccal->func->uf_scoped)
5294 break;
5295 current_funccal = current_funccal->func->uf_scoped;
5296 }
5297 current_funccal = old_current_funccal;
5298
5299 return v;
5300}
5301
5302/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303 * Set "copyID + 1" in previous_funccal and callers.
5304 */
5305 int
5306set_ref_in_previous_funccal(int copyID)
5307{
5308 int abort = FALSE;
5309 funccall_T *fc;
5310
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005311 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005313 fc->fc_copyID = copyID + 1;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005314 abort = abort
5315 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5316 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005317 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005318 }
5319 return abort;
5320}
5321
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005322 static int
5323set_ref_in_funccal(funccall_T *fc, int copyID)
5324{
5325 int abort = FALSE;
5326
5327 if (fc->fc_copyID != copyID)
5328 {
5329 fc->fc_copyID = copyID;
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005330 abort = abort
5331 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5332 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
Bram Moolenaar7be3ab22019-06-23 01:46:15 +02005333 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02005334 || set_ref_in_func(NULL, fc->func, copyID);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005335 }
5336 return abort;
5337}
5338
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339/*
5340 * Set "copyID" in all local vars and arguments in the call stack.
5341 */
5342 int
5343set_ref_in_call_stack(int copyID)
5344{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005345 int abort = FALSE;
5346 funccall_T *fc;
5347 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005349 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005350 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005351
5352 // Also go through the funccal_stack.
Bram Moolenaar75a1a942019-06-20 03:45:36 +02005353 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next)
5354 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller)
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02005355 abort = abort || set_ref_in_funccal(fc, copyID);
5356
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005357 return abort;
5358}
5359
5360/*
5361 * Set "copyID" in all functions available by name.
5362 */
5363 int
5364set_ref_in_functions(int copyID)
5365{
5366 int todo;
5367 hashitem_T *hi = NULL;
5368 int abort = FALSE;
5369 ufunc_T *fp;
5370
5371 todo = (int)func_hashtab.ht_used;
5372 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005373 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005374 if (!HASHITEM_EMPTY(hi))
5375 {
5376 --todo;
5377 fp = HI2UF(hi);
5378 if (!func_name_refcount(fp->uf_name))
5379 abort = abort || set_ref_in_func(NULL, fp, copyID);
5380 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005381 }
5382 return abort;
5383}
5384
5385/*
5386 * Set "copyID" in all function arguments.
5387 */
5388 int
5389set_ref_in_func_args(int copyID)
5390{
5391 int i;
5392 int abort = FALSE;
5393
5394 for (i = 0; i < funcargs.ga_len; ++i)
5395 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5396 copyID, NULL, NULL);
5397 return abort;
5398}
5399
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005400/*
5401 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005402 * Returns TRUE if setting references failed somehow.
5403 */
5404 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005405set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005406{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005407 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005408 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01005409 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005410 char_u fname_buf[FLEN_FIXED + 1];
5411 char_u *tofree = NULL;
5412 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005413 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005414
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005415 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005416 return FALSE;
5417
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005418 if (fp_in == NULL)
5419 {
5420 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005421 fp = find_func(fname, FALSE, NULL);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005422 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005423 if (fp != NULL)
5424 {
5425 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005426 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005427 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02005428
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005429 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02005430 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005431}
5432
Bram Moolenaare38eab22019-12-05 21:50:01 +01005433#endif // FEAT_EVAL